" - error_string += _("{0}: Failed to attach new recurring document. To enable attaching document in the auto repeat notification email, enable {1} in Print Settings").format( - frappe.bold(_('Note')), - frappe.bold(_('Allow Print for Draft')) - ) - attachments = '[]' + error_string += _( + "{0}: Failed to attach new recurring document. To enable attaching document in the auto repeat notification email, enable {1} in Print Settings" + ).format(frappe.bold(_("Note")), frappe.bold(_("Allow Print for Draft"))) + attachments = "[]" if error_string: message = error_string elif not self.message: message = _("Please find attached {0}: {1}").format(new_doc.doctype, new_doc.name) elif "{" in self.message: - message = frappe.render_template(self.message, {'doc': new_doc}) + message = frappe.render_template(self.message, {"doc": new_doc}) - recipients = self.recipients.split('\n') + recipients = self.recipients.split("\n") - make(doctype=new_doc.doctype, name=new_doc.name, recipients=recipients, - subject=subject, content=message, attachments=attachments, send_email=1) + make( + doctype=new_doc.doctype, + name=new_doc.name, + recipients=recipients, + subject=subject, + content=message, + attachments=attachments, + send_email=1, + ) @frappe.whitelist() def fetch_linked_contacts(self): if self.reference_doctype and self.reference_document: - res = get_contacts_linking_to(self.reference_doctype, self.reference_document, fields=['email_id']) - res += get_contacts_linked_from(self.reference_doctype, self.reference_document, fields=['email_id']) + res = get_contacts_linking_to( + self.reference_doctype, self.reference_document, fields=["email_id"] + ) + res += get_contacts_linked_from( + self.reference_doctype, self.reference_document, fields=["email_id"] + ) email_ids = {d.email_id for d in res} if not email_ids: - frappe.msgprint(_('No contacts linked to document'), alert=True) + frappe.msgprint(_("No contacts linked to document"), alert=True) else: - self.recipients = ', '.join(email_ids) + self.recipients = ", ".join(email_ids) def disable_auto_repeat(self): - frappe.db.set_value('Auto Repeat', self.name, 'disabled', 1) + frappe.db.set_value("Auto Repeat", self.name, "disabled", 1) def notify_error_to_user(self, error_log): recipients = list(get_system_managers(only_name=True)) @@ -356,20 +411,17 @@ class AutoRepeat(Document): subject = _("Auto Repeat Document Creation Failed") form_link = frappe.utils.get_link_to_form(self.reference_doctype, self.reference_document) - auto_repeat_failed_for = _('Auto Repeat failed for {0}').format(form_link) + auto_repeat_failed_for = _("Auto Repeat failed for {0}").format(form_link) - error_log_link = frappe.utils.get_link_to_form('Error Log', error_log.name) - error_log_message = _('Check the Error Log for more information: {0}').format(error_log_link) + error_log_link = frappe.utils.get_link_to_form("Error Log", error_log.name) + error_log_message = _("Check the Error Log for more information: {0}").format(error_log_link) frappe.sendmail( recipients=recipients, subject=subject, template="auto_repeat_fail", - args={ - 'auto_repeat_failed_for': auto_repeat_failed_for, - 'error_log_message': error_log_message - }, - header=[subject, 'red'] + args={"auto_repeat_failed_for": auto_repeat_failed_for, "error_log_message": error_log_message}, + header=[subject, "red"], ) @@ -382,18 +434,18 @@ def get_next_date(dt, mcount, day=None): def get_next_weekday(current_schedule_day, weekdays): days = list(week_map.keys()) if current_schedule_day > 0: - days = days[(current_schedule_day + 1):] + days[:current_schedule_day] + days = days[(current_schedule_day + 1) :] + days[:current_schedule_day] else: - days = days[(current_schedule_day + 1):] + days = days[(current_schedule_day + 1) :] for entry in days: if entry in weekdays: return entry -#called through hooks +# called through hooks def make_auto_repeat_entry(): - enqueued_method = 'frappe.automation.doctype.auto_repeat.auto_repeat.create_repeated_entries' + enqueued_method = "frappe.automation.doctype.auto_repeat.auto_repeat.create_repeated_entries" jobs = get_jobs() if not jobs or enqueued_method not in jobs[frappe.local.site]: @@ -404,7 +456,7 @@ def make_auto_repeat_entry(): def create_repeated_entries(data): for d in data: - doc = frappe.get_doc('Auto Repeat', d.name) + doc = frappe.get_doc("Auto Repeat", d.name) current_date = getdate(today()) schedule_date = getdate(doc.next_schedule_date) @@ -413,33 +465,32 @@ def create_repeated_entries(data): doc.create_documents() schedule_date = doc.get_next_schedule_date(schedule_date=schedule_date) if schedule_date and not doc.disabled: - frappe.db.set_value('Auto Repeat', doc.name, 'next_schedule_date', schedule_date) + frappe.db.set_value("Auto Repeat", doc.name, "next_schedule_date", schedule_date) def get_auto_repeat_entries(date=None): if not date: date = getdate(today()) - return frappe.db.get_all('Auto Repeat', filters=[ - ['next_schedule_date', '<=', date], - ['status', '=', 'Active'] - ]) + return frappe.db.get_all( + "Auto Repeat", filters=[["next_schedule_date", "<=", date], ["status", "=", "Active"]] + ) -#called through hooks +# called through hooks def set_auto_repeat_as_completed(): - auto_repeat = frappe.get_all("Auto Repeat", filters = {'status': ['!=', 'Disabled']}) + auto_repeat = frappe.get_all("Auto Repeat", filters={"status": ["!=", "Disabled"]}) for entry in auto_repeat: doc = frappe.get_doc("Auto Repeat", entry.name) if doc.is_completed(): - doc.status = 'Completed' + doc.status = "Completed" doc.save() @frappe.whitelist() -def make_auto_repeat(doctype, docname, frequency = 'Daily', start_date = None, end_date = None): +def make_auto_repeat(doctype, docname, frequency="Daily", start_date=None, end_date=None): if not start_date: start_date = getdate(today()) - doc = frappe.new_doc('Auto Repeat') + doc = frappe.new_doc("Auto Repeat") doc.reference_doctype = doctype doc.reference_document = docname doc.frequency = frequency @@ -449,24 +500,34 @@ def make_auto_repeat(doctype, docname, frequency = 'Daily', start_date = None, e doc.save() return doc + # method for reference_doctype filter @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_auto_repeat_doctypes(doctype, txt, searchfield, start, page_len, filters): - res = frappe.db.get_all('Property Setter', { - 'property': 'allow_auto_repeat', - 'value': '1', - }, ['doc_type']) + res = frappe.db.get_all( + "Property Setter", + { + "property": "allow_auto_repeat", + "value": "1", + }, + ["doc_type"], + ) docs = [r.doc_type for r in res] - res = frappe.db.get_all('DocType', { - 'allow_auto_repeat': 1, - }, ['name']) + res = frappe.db.get_all( + "DocType", + { + "allow_auto_repeat": 1, + }, + ["name"], + ) docs += [r.name for r in res] docs = set(list(docs)) return [[d] for d in docs] + @frappe.whitelist() def update_reference(docname, reference): result = "" @@ -478,13 +539,14 @@ def update_reference(docname, reference): raise e return result + @frappe.whitelist() def generate_message_preview(reference_dt, reference_doc, message=None, subject=None): frappe.has_permission("Auto Repeat", "write", throw=True) doc = frappe.get_doc(reference_dt, reference_doc) subject_preview = _("Please add a subject to your email") - msg_preview = frappe.render_template(message, {'doc': doc}) + msg_preview = frappe.render_template(message, {"doc": doc}) if subject: - subject_preview = frappe.render_template(subject, {'doc': doc}) + subject_preview = frappe.render_template(subject, {"doc": doc}) - return {'message': msg_preview, 'subject': subject_preview} + return {"message": msg_preview, "subject": subject_preview} diff --git a/frappe/automation/doctype/auto_repeat/test_auto_repeat.py b/frappe/automation/doctype/auto_repeat/test_auto_repeat.py index 30a0310a92..e1db7ca6d1 100644 --- a/frappe/automation/doctype/auto_repeat/test_auto_repeat.py +++ b/frappe/automation/doctype/auto_repeat/test_auto_repeat.py @@ -4,24 +4,40 @@ import unittest import frappe +from frappe.automation.doctype.auto_repeat.auto_repeat import ( + create_repeated_entries, + get_auto_repeat_entries, + week_map, +) from frappe.custom.doctype.custom_field.custom_field import create_custom_field -from frappe.automation.doctype.auto_repeat.auto_repeat import get_auto_repeat_entries, create_repeated_entries, week_map -from frappe.utils import today, add_days, getdate, add_months +from frappe.utils import add_days, add_months, getdate, today + def add_custom_fields(): df = dict( - fieldname='auto_repeat', label='Auto Repeat', fieldtype='Link', insert_after='sender', - options='Auto Repeat', hidden=1, print_hide=1, read_only=1) - create_custom_field('ToDo', df) + fieldname="auto_repeat", + label="Auto Repeat", + fieldtype="Link", + insert_after="sender", + options="Auto Repeat", + hidden=1, + print_hide=1, + read_only=1, + ) + create_custom_field("ToDo", df) + class TestAutoRepeat(unittest.TestCase): def setUp(self): - if not frappe.db.sql("SELECT `fieldname` FROM `tabCustom Field` WHERE `fieldname`='auto_repeat' and `dt`=%s", "Todo"): + if not frappe.db.sql( + "SELECT `fieldname` FROM `tabCustom Field` WHERE `fieldname`='auto_repeat' and `dt`=%s", "Todo" + ): add_custom_fields() def test_daily_auto_repeat(self): todo = frappe.get_doc( - dict(doctype='ToDo', description='test recurring todo', assigned_by='Administrator')).insert() + dict(doctype="ToDo", description="test recurring todo", assigned_by="Administrator") + ).insert() doc = make_auto_repeat(reference_document=todo.name) self.assertEqual(doc.next_schedule_date, today()) @@ -32,19 +48,25 @@ class TestAutoRepeat(unittest.TestCase): todo = frappe.get_doc(doc.reference_doctype, doc.reference_document) self.assertEqual(todo.auto_repeat, doc.name) - new_todo = frappe.db.get_value('ToDo', - {'auto_repeat': doc.name, 'name': ('!=', todo.name)}, 'name') + new_todo = frappe.db.get_value( + "ToDo", {"auto_repeat": doc.name, "name": ("!=", todo.name)}, "name" + ) - new_todo = frappe.get_doc('ToDo', new_todo) + new_todo = frappe.get_doc("ToDo", new_todo) - self.assertEqual(todo.get('description'), new_todo.get('description')) + self.assertEqual(todo.get("description"), new_todo.get("description")) def test_weekly_auto_repeat(self): todo = frappe.get_doc( - dict(doctype='ToDo', description='test weekly todo', assigned_by='Administrator')).insert() + dict(doctype="ToDo", description="test weekly todo", assigned_by="Administrator") + ).insert() - doc = make_auto_repeat(reference_doctype='ToDo', - frequency='Weekly', reference_document=todo.name, start_date=add_days(today(), -7)) + doc = make_auto_repeat( + reference_doctype="ToDo", + frequency="Weekly", + reference_document=todo.name, + start_date=add_days(today(), -7), + ) self.assertEqual(doc.next_schedule_date, today()) data = get_auto_repeat_entries(getdate(today())) @@ -54,25 +76,29 @@ class TestAutoRepeat(unittest.TestCase): todo = frappe.get_doc(doc.reference_doctype, doc.reference_document) self.assertEqual(todo.auto_repeat, doc.name) - new_todo = frappe.db.get_value('ToDo', - {'auto_repeat': doc.name, 'name': ('!=', todo.name)}, 'name') + new_todo = frappe.db.get_value( + "ToDo", {"auto_repeat": doc.name, "name": ("!=", todo.name)}, "name" + ) - new_todo = frappe.get_doc('ToDo', new_todo) + new_todo = frappe.get_doc("ToDo", new_todo) - self.assertEqual(todo.get('description'), new_todo.get('description')) + self.assertEqual(todo.get("description"), new_todo.get("description")) def test_weekly_auto_repeat_with_weekdays(self): todo = frappe.get_doc( - dict(doctype='ToDo', description='test auto repeat with weekdays', assigned_by='Administrator')).insert() + dict(doctype="ToDo", description="test auto repeat with weekdays", assigned_by="Administrator") + ).insert() weekdays = list(week_map.keys()) current_weekday = getdate().weekday() - days = [ - {'day': weekdays[current_weekday]}, - {'day': weekdays[(current_weekday + 2) % 7]} - ] - doc = make_auto_repeat(reference_doctype='ToDo', - frequency='Weekly', reference_document=todo.name, start_date=add_days(today(), -7), days=days) + days = [{"day": weekdays[current_weekday]}, {"day": weekdays[(current_weekday + 2) % 7]}] + doc = make_auto_repeat( + reference_doctype="ToDo", + frequency="Weekly", + reference_document=todo.name, + start_date=add_days(today(), -7), + days=days, + ) self.assertEqual(doc.next_schedule_date, today()) data = get_auto_repeat_entries(getdate(today())) @@ -90,136 +116,173 @@ class TestAutoRepeat(unittest.TestCase): end_date = add_months(start_date, 12) todo = frappe.get_doc( - dict(doctype='ToDo', description='test recurring todo', assigned_by='Administrator')).insert() + dict(doctype="ToDo", description="test recurring todo", assigned_by="Administrator") + ).insert() - self.monthly_auto_repeat('ToDo', todo.name, start_date, end_date) - #test without end_date - todo = frappe.get_doc(dict(doctype='ToDo', description='test recurring todo without end_date', assigned_by='Administrator')).insert() - self.monthly_auto_repeat('ToDo', todo.name, start_date) + self.monthly_auto_repeat("ToDo", todo.name, start_date, end_date) + # test without end_date + todo = frappe.get_doc( + dict( + doctype="ToDo", description="test recurring todo without end_date", assigned_by="Administrator" + ) + ).insert() + self.monthly_auto_repeat("ToDo", todo.name, start_date) - def monthly_auto_repeat(self, doctype, docname, start_date, end_date = None): + def monthly_auto_repeat(self, doctype, docname, start_date, end_date=None): def get_months(start, end): diff = (12 * end.year + end.month) - (12 * start.year + start.month) return diff + 1 doc = make_auto_repeat( - reference_doctype=doctype, frequency='Monthly', reference_document=docname, start_date=start_date, - end_date=end_date) + reference_doctype=doctype, + frequency="Monthly", + reference_document=docname, + start_date=start_date, + end_date=end_date, + ) doc.disable_auto_repeat() data = get_auto_repeat_entries(getdate(today())) create_repeated_entries(data) - docnames = frappe.get_all(doc.reference_doctype, {'auto_repeat': doc.name}) + docnames = frappe.get_all(doc.reference_doctype, {"auto_repeat": doc.name}) self.assertEqual(len(docnames), 1) - doc = frappe.get_doc('Auto Repeat', doc.name) - doc.db_set('disabled', 0) + doc = frappe.get_doc("Auto Repeat", doc.name) + doc.db_set("disabled", 0) months = get_months(getdate(start_date), getdate(today())) data = get_auto_repeat_entries(getdate(today())) create_repeated_entries(data) - docnames = frappe.get_all(doc.reference_doctype, {'auto_repeat': doc.name}) + docnames = frappe.get_all(doc.reference_doctype, {"auto_repeat": doc.name}) self.assertEqual(len(docnames), months) def test_notification_is_attached(self): todo = frappe.get_doc( - dict(doctype='ToDo', description='Test recurring notification attachment', assigned_by='Administrator')).insert() + dict( + doctype="ToDo", + description="Test recurring notification attachment", + assigned_by="Administrator", + ) + ).insert() - doc = make_auto_repeat(reference_document=todo.name, notify=1, recipients="test@domain.com", subject="New ToDo", - message="A new ToDo has just been created for you") + doc = make_auto_repeat( + reference_document=todo.name, + notify=1, + recipients="test@domain.com", + subject="New ToDo", + message="A new ToDo has just been created for you", + ) data = get_auto_repeat_entries(getdate(today())) create_repeated_entries(data) frappe.db.commit() - new_todo = frappe.db.get_value('ToDo', - {'auto_repeat': doc.name, 'name': ('!=', todo.name)}, 'name') + new_todo = frappe.db.get_value( + "ToDo", {"auto_repeat": doc.name, "name": ("!=", todo.name)}, "name" + ) - linked_comm = frappe.db.exists("Communication", dict(reference_doctype="ToDo", reference_name=new_todo)) + linked_comm = frappe.db.exists( + "Communication", dict(reference_doctype="ToDo", reference_name=new_todo) + ) self.assertTrue(linked_comm) def test_next_schedule_date(self): current_date = getdate(today()) todo = frappe.get_doc( - dict(doctype='ToDo', description='test next schedule date for monthly', assigned_by='Administrator')).insert() - doc = make_auto_repeat(frequency='Monthly', reference_document=todo.name, start_date=add_months(today(), -2)) + dict( + doctype="ToDo", description="test next schedule date for monthly", assigned_by="Administrator" + ) + ).insert() + doc = make_auto_repeat( + frequency="Monthly", reference_document=todo.name, start_date=add_months(today(), -2) + ) # next_schedule_date is set as on or after current date # it should not be a previous month's date self.assertTrue((doc.next_schedule_date >= current_date)) todo = frappe.get_doc( - dict(doctype='ToDo', description='test next schedule date for daily', assigned_by='Administrator')).insert() - doc = make_auto_repeat(frequency='Daily', reference_document=todo.name, start_date=add_days(today(), -2)) + dict( + doctype="ToDo", description="test next schedule date for daily", assigned_by="Administrator" + ) + ).insert() + doc = make_auto_repeat( + frequency="Daily", reference_document=todo.name, start_date=add_days(today(), -2) + ) self.assertEqual(getdate(doc.next_schedule_date), current_date) def test_submit_on_creation(self): - doctype = 'Test Submittable DocType' + doctype = "Test Submittable DocType" create_submittable_doctype(doctype) current_date = getdate() - submittable_doc = frappe.get_doc(dict(doctype=doctype, test='test submit on creation')).insert() + submittable_doc = frappe.get_doc(dict(doctype=doctype, test="test submit on creation")).insert() submittable_doc.submit() - doc = make_auto_repeat(frequency='Daily', reference_doctype=doctype, reference_document=submittable_doc.name, - start_date=add_days(current_date, -1), submit_on_creation=1) + doc = make_auto_repeat( + frequency="Daily", + reference_doctype=doctype, + reference_document=submittable_doc.name, + start_date=add_days(current_date, -1), + submit_on_creation=1, + ) data = get_auto_repeat_entries(current_date) create_repeated_entries(data) - docnames = frappe.db.get_all(doc.reference_doctype, - filters={'auto_repeat': doc.name}, - fields=['docstatus'], - limit=1 + docnames = frappe.db.get_all( + doc.reference_doctype, filters={"auto_repeat": doc.name}, fields=["docstatus"], limit=1 ) self.assertEqual(docnames[0].docstatus, 1) def make_auto_repeat(**args): args = frappe._dict(args) - doc = frappe.get_doc({ - 'doctype': 'Auto Repeat', - 'reference_doctype': args.reference_doctype or 'ToDo', - 'reference_document': args.reference_document or frappe.db.get_value('ToDo', 'name'), - 'submit_on_creation': args.submit_on_creation or 0, - 'frequency': args.frequency or 'Daily', - 'start_date': args.start_date or add_days(today(), -1), - 'end_date': args.end_date or "", - 'notify_by_email': args.notify or 0, - 'recipients': args.recipients or "", - 'subject': args.subject or "", - 'message': args.message or "", - 'repeat_on_days': args.days or [] - }).insert(ignore_permissions=True) + doc = frappe.get_doc( + { + "doctype": "Auto Repeat", + "reference_doctype": args.reference_doctype or "ToDo", + "reference_document": args.reference_document or frappe.db.get_value("ToDo", "name"), + "submit_on_creation": args.submit_on_creation or 0, + "frequency": args.frequency or "Daily", + "start_date": args.start_date or add_days(today(), -1), + "end_date": args.end_date or "", + "notify_by_email": args.notify or 0, + "recipients": args.recipients or "", + "subject": args.subject or "", + "message": args.message or "", + "repeat_on_days": args.days or [], + } + ).insert(ignore_permissions=True) return doc def create_submittable_doctype(doctype, submit_perms=1): - if frappe.db.exists('DocType', doctype): + if frappe.db.exists("DocType", doctype): return else: - doc = frappe.get_doc({ - 'doctype': 'DocType', - '__newname': doctype, - 'module': 'Custom', - 'custom': 1, - 'is_submittable': 1, - 'fields': [{ - 'fieldname': 'test', - 'label': 'Test', - 'fieldtype': 'Data' - }], - 'permissions': [{ - 'role': 'System Manager', - 'read': 1, - 'write': 1, - 'create': 1, - 'delete': 1, - 'submit': submit_perms, - 'cancel': submit_perms, - 'amend': submit_perms - }] - }).insert() + doc = frappe.get_doc( + { + "doctype": "DocType", + "__newname": doctype, + "module": "Custom", + "custom": 1, + "is_submittable": 1, + "fields": [{"fieldname": "test", "label": "Test", "fieldtype": "Data"}], + "permissions": [ + { + "role": "System Manager", + "read": 1, + "write": 1, + "create": 1, + "delete": 1, + "submit": submit_perms, + "cancel": submit_perms, + "amend": submit_perms, + } + ], + } + ).insert() doc.allow_auto_repeat = 1 - doc.save() \ No newline at end of file + doc.save() diff --git a/frappe/automation/doctype/auto_repeat_day/auto_repeat_day.py b/frappe/automation/doctype/auto_repeat_day/auto_repeat_day.py index 54fc0d14e9..95d75bf9da 100644 --- a/frappe/automation/doctype/auto_repeat_day/auto_repeat_day.py +++ b/frappe/automation/doctype/auto_repeat_day/auto_repeat_day.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class AutoRepeatDay(Document): pass diff --git a/frappe/automation/doctype/milestone/milestone.py b/frappe/automation/doctype/milestone/milestone.py index eff65571fd..4059a2eb73 100644 --- a/frappe/automation/doctype/milestone/milestone.py +++ b/frappe/automation/doctype/milestone/milestone.py @@ -5,8 +5,10 @@ import frappe from frappe.model.document import Document + class Milestone(Document): pass + def on_doctype_update(): frappe.db.add_index("Milestone", ["reference_type", "reference_name"]) diff --git a/frappe/automation/doctype/milestone/test_milestone.py b/frappe/automation/doctype/milestone/test_milestone.py index f8fb910072..1824220497 100644 --- a/frappe/automation/doctype/milestone/test_milestone.py +++ b/frappe/automation/doctype/milestone/test_milestone.py @@ -1,8 +1,9 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE -#import frappe +# import frappe import unittest + class TestMilestone(unittest.TestCase): pass diff --git a/frappe/automation/doctype/milestone_tracker/milestone_tracker.py b/frappe/automation/doctype/milestone_tracker/milestone_tracker.py index 042e7b0391..16b2fe9204 100644 --- a/frappe/automation/doctype/milestone_tracker/milestone_tracker.py +++ b/frappe/automation/doctype/milestone_tracker/milestone_tracker.py @@ -3,43 +3,50 @@ # License: MIT. See LICENSE import frappe -from frappe.model.document import Document import frappe.cache_manager from frappe.model import log_types +from frappe.model.document import Document + class MilestoneTracker(Document): def on_update(self): - frappe.cache_manager.clear_doctype_map('Milestone Tracker', self.document_type) + frappe.cache_manager.clear_doctype_map("Milestone Tracker", self.document_type) def on_trash(self): - frappe.cache_manager.clear_doctype_map('Milestone Tracker', self.document_type) + frappe.cache_manager.clear_doctype_map("Milestone Tracker", self.document_type) def apply(self, doc): before_save = doc.get_doc_before_save() from_value = before_save and before_save.get(self.track_field) or None if from_value != doc.get(self.track_field): - frappe.get_doc(dict( - doctype = 'Milestone', - reference_type = doc.doctype, - reference_name = doc.name, - track_field = self.track_field, - from_value = from_value, - value = doc.get(self.track_field), - milestone_tracker = self.name, - )).insert(ignore_permissions=True) + frappe.get_doc( + dict( + doctype="Milestone", + reference_type=doc.doctype, + reference_name=doc.name, + track_field=self.track_field, + from_value=from_value, + value=doc.get(self.track_field), + milestone_tracker=self.name, + ) + ).insert(ignore_permissions=True) + def evaluate_milestone(doc, event): - if (frappe.flags.in_install + if ( + frappe.flags.in_install or frappe.flags.in_migrate or frappe.flags.in_setup_wizard - or doc.doctype in log_types): + or doc.doctype in log_types + ): return # track milestones related to this doctype for d in get_milestone_trackers(doc.doctype): - frappe.get_doc('Milestone Tracker', d.get('name')).apply(doc) + frappe.get_doc("Milestone Tracker", d.get("name")).apply(doc) -def get_milestone_trackers(doctype): - return frappe.cache_manager.get_doctype_map('Milestone Tracker', doctype, - dict(document_type = doctype, disabled=0)) +def get_milestone_trackers(doctype): + return frappe.cache_manager.get_doctype_map( + "Milestone Tracker", doctype, dict(document_type=doctype, disabled=0) + ) diff --git a/frappe/automation/doctype/milestone_tracker/test_milestone_tracker.py b/frappe/automation/doctype/milestone_tracker/test_milestone_tracker.py index f4d5f00d83..4e53072348 100644 --- a/frappe/automation/doctype/milestone_tracker/test_milestone_tracker.py +++ b/frappe/automation/doctype/milestone_tracker/test_milestone_tracker.py @@ -1,48 +1,48 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE +import unittest + import frappe import frappe.cache_manager -import unittest + class TestMilestoneTracker(unittest.TestCase): def test_milestone(self): frappe.db.delete("Milestone Tracker") - frappe.cache().delete_key('milestone_tracker_map') + frappe.cache().delete_key("milestone_tracker_map") - milestone_tracker = frappe.get_doc(dict( - doctype = 'Milestone Tracker', - document_type = 'ToDo', - track_field = 'status' - )).insert() + milestone_tracker = frappe.get_doc( + dict(doctype="Milestone Tracker", document_type="ToDo", track_field="status") + ).insert() - todo = frappe.get_doc(dict( - doctype = 'ToDo', - description = 'test milestone', - status = 'Open' - )).insert() + todo = frappe.get_doc(dict(doctype="ToDo", description="test milestone", status="Open")).insert() - milestones = frappe.get_all('Milestone', - fields = ['track_field', 'value', 'milestone_tracker'], - filters = dict(reference_type = todo.doctype, reference_name=todo.name)) + milestones = frappe.get_all( + "Milestone", + fields=["track_field", "value", "milestone_tracker"], + filters=dict(reference_type=todo.doctype, reference_name=todo.name), + ) self.assertEqual(len(milestones), 1) - self.assertEqual(milestones[0].track_field, 'status') - self.assertEqual(milestones[0].value, 'Open') + self.assertEqual(milestones[0].track_field, "status") + self.assertEqual(milestones[0].value, "Open") - todo.status = 'Closed' + todo.status = "Closed" todo.save() - milestones = frappe.get_all('Milestone', - fields = ['track_field', 'value', 'milestone_tracker'], - filters = dict(reference_type = todo.doctype, reference_name=todo.name), - order_by = 'modified desc') + milestones = frappe.get_all( + "Milestone", + fields=["track_field", "value", "milestone_tracker"], + filters=dict(reference_type=todo.doctype, reference_name=todo.name), + order_by="modified desc", + ) self.assertEqual(len(milestones), 2) - self.assertEqual(milestones[0].track_field, 'status') - self.assertEqual(milestones[0].value, 'Closed') + self.assertEqual(milestones[0].track_field, "status") + self.assertEqual(milestones[0].value, "Closed") # cleanup frappe.db.delete("Milestone") - milestone_tracker.delete() \ No newline at end of file + milestone_tracker.delete() diff --git a/frappe/boot.py b/frappe/boot.py index b5008f778a..1b8e471e00 100644 --- a/frappe/boot.py +++ b/frappe/boot.py @@ -7,17 +7,23 @@ bootstrap client session import frappe import frappe.defaults import frappe.desk.desk_page +from frappe.core.doctype.navbar_settings.navbar_settings import get_app_logo, get_navbar_settings from frappe.desk.doctype.route_history.route_history import frequently_visited_links from frappe.desk.form.load import get_meta_bundle -from frappe.utils.change_log import get_versions -from frappe.translate import get_lang_dict from frappe.email.inbox import get_email_accounts -from frappe.social.doctype.energy_point_settings.energy_point_settings import is_energy_point_enabled -from frappe.website.doctype.web_page_view.web_page_view import is_tracking_enabled -from frappe.social.doctype.energy_point_log.energy_point_log import get_energy_points from frappe.model.base_document import get_controller -from frappe.core.doctype.navbar_settings.navbar_settings import get_navbar_settings, get_app_logo -from frappe.utils import get_time_zone, add_user_info +from frappe.query_builder import DocType +from frappe.query_builder.functions import Count +from frappe.query_builder.terms import subqry +from frappe.social.doctype.energy_point_log.energy_point_log import get_energy_points +from frappe.social.doctype.energy_point_settings.energy_point_settings import ( + is_energy_point_enabled, +) +from frappe.translate import get_lang_dict +from frappe.utils import add_user_info, get_time_zone +from frappe.utils.change_log import get_versions +from frappe.website.doctype.web_page_view.web_page_view import is_tracking_enabled + def get_bootinfo(): """build and return boot info""" @@ -34,9 +40,9 @@ def get_bootinfo(): bootinfo.sysdefaults = frappe.defaults.get_defaults() bootinfo.server_date = frappe.utils.nowdate() - if frappe.session['user'] != 'Guest': + if frappe.session["user"] != "Guest": bootinfo.user_info = get_user_info() - bootinfo.sid = frappe.session['sid'] + bootinfo.sid = frappe.session["sid"] bootinfo.modules = {} bootinfo.module_list = [] @@ -47,8 +53,10 @@ def get_bootinfo(): add_layouts(bootinfo) bootinfo.module_app = frappe.local.module_app - bootinfo.single_types = [d.name for d in frappe.get_all('DocType', {'issingle': 1})] - bootinfo.nested_set_doctypes = [d.parent for d in frappe.get_all('DocField', {'fieldname': 'lft'}, ['parent'])] + bootinfo.single_types = [d.name for d in frappe.get_all("DocType", {"issingle": 1})] + bootinfo.nested_set_doctypes = [ + d.parent for d in frappe.get_all("DocField", {"fieldname": "lft"}, ["parent"]) + ] add_home_page(bootinfo, doclist) bootinfo.page_info = get_allowed_pages() load_translations(bootinfo) @@ -62,8 +70,8 @@ def get_bootinfo(): set_time_zone(bootinfo) # ipinfo - if frappe.session.data.get('ipinfo'): - bootinfo.ipinfo = frappe.session['data']['ipinfo'] + if frappe.session.data.get("ipinfo"): + bootinfo.ipinfo = frappe.session["data"]["ipinfo"] # add docs bootinfo.docs = doclist @@ -73,7 +81,7 @@ def get_bootinfo(): if bootinfo.lang: bootinfo.lang = str(bootinfo.lang) - bootinfo.versions = {k: v['version'] for k, v in get_versions().items()} + bootinfo.versions = {k: v["version"] for k, v in get_versions().items()} bootinfo.error_report_email = frappe.conf.error_report_email bootinfo.calendars = sorted(frappe.get_hooks("calendars")) @@ -93,120 +101,144 @@ def get_bootinfo(): return bootinfo + def get_letter_heads(): letter_heads = {} - for letter_head in frappe.get_all("Letter Head", fields = ["name", "content", "footer"]): - letter_heads.setdefault(letter_head.name, - {'header': letter_head.content, 'footer': letter_head.footer}) + for letter_head in frappe.get_all("Letter Head", fields=["name", "content", "footer"]): + letter_heads.setdefault( + letter_head.name, {"header": letter_head.content, "footer": letter_head.footer} + ) return letter_heads + def load_conf_settings(bootinfo): from frappe import conf - bootinfo.max_file_size = conf.get('max_file_size') or 10485760 - for key in ('developer_mode', 'socketio_port', 'file_watcher_port'): - if key in conf: bootinfo[key] = conf.get(key) + + bootinfo.max_file_size = conf.get("max_file_size") or 10485760 + for key in ("developer_mode", "socketio_port", "file_watcher_port"): + if key in conf: + bootinfo[key] = conf.get(key) + def load_desktop_data(bootinfo): from frappe.desk.desktop import get_workspace_sidebar_items - bootinfo.allowed_workspaces = get_workspace_sidebar_items().get('pages') + + bootinfo.allowed_workspaces = get_workspace_sidebar_items().get("pages") bootinfo.module_page_map = get_controller("Workspace").get_module_page_map() bootinfo.dashboards = frappe.get_all("Dashboard") + def get_allowed_pages(cache=False): - return get_user_pages_or_reports('Page', cache=cache) + return get_user_pages_or_reports("Page", cache=cache) + def get_allowed_reports(cache=False): - return get_user_pages_or_reports('Report', cache=cache) + return get_user_pages_or_reports("Report", cache=cache) + def get_user_pages_or_reports(parent, cache=False): _cache = frappe.cache() if cache: - has_role = _cache.get_value('has_role:' + parent, user=frappe.session.user) + has_role = _cache.get_value("has_role:" + parent, user=frappe.session.user) if has_role: return has_role roles = frappe.get_roles() has_role = {} - column = get_column(parent) + + page = DocType("Page") + report = DocType("Report") + + if parent == "Report": + columns = (report.name.as_("title"), report.ref_doctype, report.report_type) + else: + columns = (page.title.as_("title"),) + + customRole = DocType("Custom Role") + hasRole = DocType("Has Role") + parentTable = DocType(parent) # get pages or reports set on custom role - pages_with_custom_roles = frappe.db.sql(""" - select - `tabCustom Role`.{field} as name, - `tabCustom Role`.modified, - `tabCustom Role`.ref_doctype, - {column} - from `tabCustom Role`, `tabHas Role`, `tab{parent}` - where - `tabHas Role`.parent = `tabCustom Role`.name - and `tab{parent}`.name = `tabCustom Role`.{field} - and `tabCustom Role`.{field} is not null - and `tabHas Role`.role in ({roles}) - """.format(field=parent.lower(), parent=parent, column=column, - roles = ', '.join(['%s']*len(roles))), roles, as_dict=1) + pages_with_custom_roles = ( + frappe.qb.from_(customRole) + .from_(hasRole) + .from_(parentTable) + .select( + customRole[parent.lower()].as_("name"), customRole.modified, customRole.ref_doctype, *columns + ) + .where( + (hasRole.parent == customRole.name) + & (parentTable.name == customRole[parent.lower()]) + & (customRole[parent.lower()].isnotnull()) + & (hasRole.role.isin(roles)) + ) + ).run(as_dict=True) for p in pages_with_custom_roles: - has_role[p.name] = {"modified":p.modified, "title": p.title, "ref_doctype": p.ref_doctype} - - pages_with_standard_roles = frappe.db.sql(""" - select distinct - `tab{parent}`.name as name, - `tab{parent}`.modified, - {column} - from `tabHas Role`, `tab{parent}` - where - `tabHas Role`.role in ({roles}) - and `tabHas Role`.parent = `tab{parent}`.name - and `tab{parent}`.`name` not in ( - select `tabCustom Role`.{field} from `tabCustom Role` - where `tabCustom Role`.{field} is not null) - {condition} - """.format(parent=parent, column=column, roles = ', '.join(['%s']*len(roles)), - field=parent.lower(), condition="and `tabReport`.disabled=0" if parent == "Report" else ""), - roles, as_dict=True) + has_role[p.name] = {"modified": p.modified, "title": p.title, "ref_doctype": p.ref_doctype} + + subq = ( + frappe.qb.from_(customRole) + .select(customRole[parent.lower()]) + .where(customRole[parent.lower()].isnotnull()) + ) + + pages_with_standard_roles = ( + frappe.qb.from_(hasRole) + .from_(parentTable) + .select(parentTable.name.as_("name"), parentTable.modified, *columns) + .where( + (hasRole.role.isin(roles)) + & (hasRole.parent == parentTable.name) + & (parentTable.name.notin(subq)) + ) + .distinct() + ) + + if parent == "Report": + pages_with_standard_roles = pages_with_standard_roles.where(report.disabled == 0) + + pages_with_standard_roles = pages_with_standard_roles.run(as_dict=True) for p in pages_with_standard_roles: if p.name not in has_role: - has_role[p.name] = {"modified":p.modified, "title": p.title} + has_role[p.name] = {"modified": p.modified, "title": p.title} if parent == "Report": - has_role[p.name].update({'ref_doctype': p.ref_doctype}) + has_role[p.name].update({"ref_doctype": p.ref_doctype}) + + no_of_roles = ( + frappe.qb.from_(hasRole).select(Count("*")).where(hasRole.parent == parentTable.name) + ) # pages with no role are allowed - if parent =="Page": - pages_with_no_roles = frappe.db.sql(""" - select - `tab{parent}`.name, `tab{parent}`.modified, {column} - from `tab{parent}` - where - (select count(*) from `tabHas Role` - where `tabHas Role`.parent=`tab{parent}`.`name`) = 0 - """.format(parent=parent, column=column), as_dict=1) + if parent == "Page": + + pages_with_no_roles = ( + frappe.qb.from_(parentTable) + .select(parentTable.name, parentTable.modified, *columns) + .where(subqry(no_of_roles) == 0) + ).run(as_dict=True) for p in pages_with_no_roles: if p.name not in has_role: has_role[p.name] = {"modified": p.modified, "title": p.title} elif parent == "Report": - reports = frappe.get_all("Report", + reports = frappe.get_all( + "Report", fields=["name", "report_type"], filters={"name": ("in", has_role.keys())}, - ignore_ifnull=True + ignore_ifnull=True, ) for report in reports: has_role[report.name]["report_type"] = report.report_type # Expire every six hours - _cache.set_value('has_role:' + parent, has_role, frappe.session.user, 21600) + _cache.set_value("has_role:" + parent, has_role, frappe.session.user, 21600) return has_role -def get_column(doctype): - column = "`tabPage`.title as title" - if doctype == "Report": - column = "`tabReport`.`name` as title, `tabReport`.ref_doctype, `tabReport`.report_type" - - return column def load_translations(bootinfo): messages = frappe.get_lang_dict("boot") @@ -218,27 +250,30 @@ def load_translations(bootinfo): messages[name] = frappe._(name) # only untranslated - messages = {k: v for k, v in messages.items() if k!=v} + messages = {k: v for k, v in messages.items() if k != v} bootinfo["__messages"] = messages + def get_user_info(): # get info for current user user_info = frappe._dict() add_user_info(frappe.session.user, user_info) - if frappe.session.user == 'Administrator' and user_info.Administrator.email: + if frappe.session.user == "Administrator" and user_info.Administrator.email: user_info[user_info.Administrator.email] = user_info.Administrator return user_info + def get_user(bootinfo): """get user info""" bootinfo.user = frappe.get_user().load_user() + def add_home_page(bootinfo, docs): """load home page""" - if frappe.session.user=="Guest": + if frappe.session.user == "Guest": return home_page = frappe.db.get_default("desktop:home_page") @@ -248,44 +283,65 @@ def add_home_page(bootinfo, docs): try: page = frappe.desk.desk_page.get(home_page) docs.append(page) - bootinfo['home_page'] = page.name + bootinfo["home_page"] = page.name except (frappe.DoesNotExistError, frappe.PermissionError): if frappe.message_log: frappe.message_log.pop() - bootinfo['home_page'] = 'Workspaces' + bootinfo["home_page"] = "Workspaces" + def add_timezone_info(bootinfo): system = bootinfo.sysdefaults.get("time_zone") import frappe.utils.momentjs - bootinfo.timezone_info = {"zones":{}, "rules":{}, "links":{}} + + bootinfo.timezone_info = {"zones": {}, "rules": {}, "links": {}} frappe.utils.momentjs.update(system, bootinfo.timezone_info) + def load_print(bootinfo, doclist): print_settings = frappe.db.get_singles_dict("Print Settings") print_settings.doctype = ":Print Settings" doclist.append(print_settings) load_print_css(bootinfo, print_settings) + def load_print_css(bootinfo, print_settings): import frappe.www.printview - bootinfo.print_css = frappe.www.printview.get_print_style(print_settings.print_style or "Redesign", for_legacy=True) + + bootinfo.print_css = frappe.www.printview.get_print_style( + print_settings.print_style or "Redesign", for_legacy=True + ) + def get_unseen_notes(): - return frappe.db.sql('''select `name`, title, content, notify_on_every_login from `tabNote` where notify_on_login=1 - and expire_notification_on > %s and %s not in - (select user from `tabNote Seen By` nsb - where nsb.parent=`tabNote`.name)''', (frappe.utils.now(), frappe.session.user), as_dict=True) + note = DocType("Note") + nsb = DocType("Note Seen By").as_("nsb") + + return ( + frappe.qb.from_(note) + .select(note.name, note.title, note.content, note.notify_on_every_login) + .where( + (note.notify_on_every_login == 1) + & (note.expire_notification_on > frappe.utils.now()) + & ( + subqry(frappe.qb.from_(nsb).select(nsb.user).where(nsb.parent == note.name)).notin( + [frappe.session.user] + ) + ) + ) + ).run(as_dict=1) + def get_success_action(): return frappe.get_all("Success Action", fields=["*"]) + def get_link_preview_doctypes(): from frappe.utils import cint - link_preview_doctypes = [d.name for d in frappe.db.get_all('DocType', {'show_preview_popup': 1})] - customizations = frappe.get_all("Property Setter", - fields=['doc_type', 'value'], - filters={'property': 'show_preview_popup'} + link_preview_doctypes = [d.name for d in frappe.db.get_all("DocType", {"show_preview_popup": 1})] + customizations = frappe.get_all( + "Property Setter", fields=["doc_type", "value"], filters={"property": "show_preview_popup"} ) for custom in customizations: @@ -296,22 +352,23 @@ def get_link_preview_doctypes(): return link_preview_doctypes + def get_additional_filters_from_hooks(): filter_config = frappe._dict() - filter_hooks = frappe.get_hooks('filters_config') + filter_hooks = frappe.get_hooks("filters_config") for hook in filter_hooks: filter_config.update(frappe.get_attr(hook)()) return filter_config + def add_layouts(bootinfo): # add routes for readable doctypes - bootinfo.doctype_layouts = frappe.get_all('DocType Layout', ['name', 'route', 'document_type']) + bootinfo.doctype_layouts = frappe.get_all("DocType Layout", ["name", "route", "document_type"]) + def get_desk_settings(): - role_list = frappe.get_all('Role', fields=['*'], filters=dict( - name=['in', frappe.get_roles()] - )) + role_list = frappe.get_all("Role", fields=["*"], filters=dict(name=["in", frappe.get_roles()])) desk_settings = {} from frappe.core.doctype.role.role import desk_properties @@ -322,8 +379,10 @@ def get_desk_settings(): return desk_settings + def get_notification_settings(): - return frappe.get_cached_doc('Notification Settings', frappe.session.user) + return frappe.get_cached_doc("Notification Settings", frappe.session.user) + @frappe.whitelist() def get_link_title_doctypes(): @@ -335,8 +394,10 @@ def get_link_title_doctypes(): ) return [d.name for d in dts + custom_dts if d] + def set_time_zone(bootinfo): bootinfo.time_zone = { "system": get_time_zone(), - "user": bootinfo.get("user_info", {}).get(frappe.session.user, {}).get("time_zone", None) or get_time_zone() + "user": bootinfo.get("user_info", {}).get(frappe.session.user, {}).get("time_zone", None) + or get_time_zone(), } diff --git a/frappe/build.py b/frappe/build.py index 7a06ee3a22..e20ee0d698 100644 --- a/frappe/build.py +++ b/frappe/build.py @@ -1,8 +1,8 @@ # Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import os -import shutil import re +import shutil import subprocess from distutils.spawn import find_executable from subprocess import getoutput @@ -25,6 +25,7 @@ sites_path = os.path.abspath(os.getcwd()) class AssetsNotDownloadedError(Exception): pass + class AssetsDontExistError(HTTPError): pass @@ -43,7 +44,7 @@ def download_file(url, prefix): def build_missing_files(): - '''Check which files dont exist yet from the assets.json and run build for those files''' + """Check which files dont exist yet from the assets.json and run build for those files""" missing_assets = [] current_asset_files = [] @@ -60,7 +61,7 @@ def build_missing_files(): assets_json = frappe.parse_json(assets_json) for bundle_file, output_file in assets_json.items(): - if not output_file.startswith('/assets/frappe'): + if not output_file.startswith("/assets/frappe"): continue if os.path.basename(output_file) not in current_asset_files: @@ -78,8 +79,7 @@ def build_missing_files(): def get_assets_link(frappe_head) -> str: tag = getoutput( r"cd ../apps/frappe && git show-ref --tags -d | grep %s | sed -e 's,.*" - r" refs/tags/,,' -e 's/\^{}//'" - % frappe_head + r" refs/tags/,,' -e 's/\^{}//'" % frappe_head ) if tag: @@ -111,6 +111,7 @@ def fetch_assets(url, frappe_head): def setup_assets(assets_archive): import tarfile + directories_created = set() click.secho("\nExtracting assets...\n", fg="yellow") @@ -221,7 +222,16 @@ def setup(): assets_path = os.path.join(frappe.local.sites_path, "assets") -def bundle(mode, apps=None, hard_link=False, make_copy=False, restore=False, verbose=False, skip_frappe=False, files=None): +def bundle( + mode, + apps=None, + hard_link=False, + make_copy=False, + restore=False, + verbose=False, + skip_frappe=False, + files=None, +): """concat / minify js files""" setup() make_asset_dirs(hard_link=hard_link) @@ -236,7 +246,7 @@ def bundle(mode, apps=None, hard_link=False, make_copy=False, restore=False, ver command += " --skip_frappe" if files: - command += " --files {files}".format(files=','.join(files)) + command += " --files {files}".format(files=",".join(files)) command += " --run-build-command" @@ -253,9 +263,7 @@ def watch(apps=None): if apps: command += " --apps {apps}".format(apps=apps) - live_reload = frappe.utils.cint( - os.environ.get("LIVE_RELOAD", frappe.conf.live_reload) - ) + live_reload = frappe.utils.cint(os.environ.get("LIVE_RELOAD", frappe.conf.live_reload)) if live_reload: command += " --live-reload" @@ -266,8 +274,8 @@ def watch(apps=None): def check_node_executable(): - node_version = Version(subprocess.getoutput('node -v')[1:]) - warn = '⚠️ ' + node_version = Version(subprocess.getoutput("node -v")[1:]) + warn = "⚠️ " if node_version.major < 14: click.echo(f"{warn} Please update your node version to 14") if not find_executable("yarn"): @@ -276,9 +284,7 @@ def check_node_executable(): def get_node_env(): - node_env = { - "NODE_OPTIONS": f"--max_old_space_size={get_safe_max_old_space_size()}" - } + node_env = {"NODE_OPTIONS": f"--max_old_space_size={get_safe_max_old_space_size()}"} return node_env @@ -345,8 +351,7 @@ def clear_broken_symlinks(): def unstrip(message: str) -> str: - """Pads input string on the right side until the last available column in the terminal - """ + """Pads input string on the right side until the last available column in the terminal""" _len = len(message) try: max_str = os.get_terminal_size().columns @@ -367,7 +372,9 @@ def make_asset_dirs(hard_link=False): symlinks = generate_assets_map() for source, target in symlinks.items(): - start_message = unstrip(f"{'Copying assets from' if hard_link else 'Linking'} {source} to {target}") + start_message = unstrip( + f"{'Copying assets from' if hard_link else 'Linking'} {source} to {target}" + ) fail_message = unstrip(f"Cannot {'copy' if hard_link else 'link'} {source} to {target}") # Used '\r' instead of '\x1b[1K\r' to print entire lines in smaller terminal sizes @@ -404,10 +411,11 @@ def scrub_html_template(content): # strip comments content = re.sub(r"()", "", content) - return content.replace("'", "\'") + return content.replace("'", "'") def html_to_js_template(path, content): """returns HTML template content as Javascript code, adding it to `frappe.templates`""" return """frappe.templates["{key}"] = '{content}';\n""".format( - key=path.rsplit("/", 1)[-1][:-5], content=scrub_html_template(content)) + key=path.rsplit("/", 1)[-1][:-5], content=scrub_html_template(content) + ) diff --git a/frappe/cache_manager.py b/frappe/cache_manager.py index 94a845639b..b15f8f2234 100644 --- a/frappe/cache_manager.py +++ b/frappe/cache_manager.py @@ -1,33 +1,75 @@ # Copyright (c) 2018, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, json +import json + +import frappe +from frappe.desk.notifications import clear_notifications, delete_notification_count_for from frappe.model.document import Document -from frappe.desk.notifications import (delete_notification_count_for, - clear_notifications) common_default_keys = ["__default", "__global"] -doctype_map_keys = ('energy_point_rule_map', 'assignment_rule_map', - 'milestone_tracker_map', 'event_consumer_document_type_map') - -bench_cache_keys = ('assets_json',) - -global_cache_keys = ("app_hooks", "installed_apps", 'all_apps', - "app_modules", "module_app", "system_settings", - 'scheduler_events', 'time_zone', 'webhooks', 'active_domains', - 'active_modules', 'assignment_rule', 'server_script_map', 'wkhtmltopdf_version', - 'domain_restricted_doctypes', 'domain_restricted_pages', 'information_schema:counts', - 'sitemap_routes', 'db_tables', 'server_script_autocompletion_items') + doctype_map_keys - -user_cache_keys = ("bootinfo", "user_recent", "roles", "user_doc", "lang", - "defaults", "user_permissions", "home_page", "linked_with", - "desktop_icons", 'portal_menu_items', 'user_perm_can_read', - "has_role:Page", "has_role:Report", "desk_sidebar_items") +doctype_map_keys = ( + "energy_point_rule_map", + "assignment_rule_map", + "milestone_tracker_map", + "event_consumer_document_type_map", +) + +bench_cache_keys = ("assets_json",) + +global_cache_keys = ( + "app_hooks", + "installed_apps", + "all_apps", + "app_modules", + "module_app", + "system_settings", + "scheduler_events", + "time_zone", + "webhooks", + "active_domains", + "active_modules", + "assignment_rule", + "server_script_map", + "wkhtmltopdf_version", + "domain_restricted_doctypes", + "domain_restricted_pages", + "information_schema:counts", + "sitemap_routes", + "db_tables", + "server_script_autocompletion_items", +) + doctype_map_keys + +user_cache_keys = ( + "bootinfo", + "user_recent", + "roles", + "user_doc", + "lang", + "defaults", + "user_permissions", + "home_page", + "linked_with", + "desktop_icons", + "portal_menu_items", + "user_perm_can_read", + "has_role:Page", + "has_role:Report", + "desk_sidebar_items", +) + +doctype_cache_keys = ( + "meta", + "form_meta", + "table_columns", + "last_modified", + "linked_doctypes", + "notifications", + "workflow", + "data_import_column_header_map", +) + doctype_map_keys -doctype_cache_keys = ("meta", "form_meta", "table_columns", "last_modified", - "linked_doctypes", 'notifications', 'workflow' , - 'data_import_column_header_map') + doctype_map_keys def clear_user_cache(user=None): cache = frappe.cache() @@ -47,11 +89,13 @@ def clear_user_cache(user=None): clear_defaults_cache() clear_global_cache() + def clear_domain_cache(user=None): cache = frappe.cache() - domain_cache_keys = ('domain_restricted_doctypes', 'domain_restricted_pages') + domain_cache_keys = ("domain_restricted_doctypes", "domain_restricted_pages") cache.delete_value(domain_cache_keys) + def clear_global_cache(): from frappe.website.utils import clear_website_cache @@ -61,21 +105,23 @@ def clear_global_cache(): frappe.cache().delete_value(bench_cache_keys) frappe.setup_module_map() + def clear_defaults_cache(user=None): if user: - for p in ([user] + common_default_keys): + for p in [user] + common_default_keys: frappe.cache().hdel("defaults", p) - elif frappe.flags.in_install!="frappe": + elif frappe.flags.in_install != "frappe": frappe.cache().delete_key("defaults") + def clear_doctype_cache(doctype=None): clear_controller_cache(doctype) cache = frappe.cache() - if getattr(frappe.local, 'meta_cache') and (doctype in frappe.local.meta_cache): + if getattr(frappe.local, "meta_cache") and (doctype in frappe.local.meta_cache): del frappe.local.meta_cache[doctype] - for key in ('is_table', 'doctype_modules', 'document_cache'): + for key in ("is_table", "doctype_modules", "document_cache"): cache.delete_value(key) frappe.local.document_cache = {} @@ -89,8 +135,9 @@ def clear_doctype_cache(doctype=None): # clear all parent doctypes - for dt in frappe.db.get_all('DocField', 'parent', - dict(fieldtype=['in', frappe.model.table_fields], options=doctype)): + for dt in frappe.db.get_all( + "DocField", "parent", dict(fieldtype=["in", frappe.model.table_fields], options=doctype) + ): clear_single(dt.parent) # clear all notifications @@ -101,6 +148,7 @@ def clear_doctype_cache(doctype=None): for name in doctype_cache_keys: cache.delete_value(name) + def clear_controller_cache(doctype=None): if not doctype: del frappe.controllers @@ -110,9 +158,10 @@ def clear_controller_cache(doctype=None): for site_controllers in frappe.controllers.values(): site_controllers.pop(doctype, None) + def get_doctype_map(doctype, name, filters=None, order_by=None): cache = frappe.cache() - cache_key = frappe.scrub(doctype) + '_map' + cache_key = frappe.scrub(doctype) + "_map" doctype_map = cache.hget(cache_key, name) if doctype_map is not None: @@ -121,7 +170,7 @@ def get_doctype_map(doctype, name, filters=None, order_by=None): else: # non cached, build cache try: - items = frappe.get_all(doctype, filters=filters, order_by = order_by) + items = frappe.get_all(doctype, filters=filters, order_by=order_by) cache.hset(cache_key, name, json.dumps(items)) except frappe.db.TableMissingError: # executed from inside patch, ignore @@ -129,15 +178,19 @@ def get_doctype_map(doctype, name, filters=None, order_by=None): return items + def clear_doctype_map(doctype, name): - frappe.cache().hdel(frappe.scrub(doctype) + '_map', name) + frappe.cache().hdel(frappe.scrub(doctype) + "_map", name) + def build_table_count_cache(): - if (frappe.flags.in_patch + if ( + frappe.flags.in_patch or frappe.flags.in_install or frappe.flags.in_migrate or frappe.flags.in_import - or frappe.flags.in_setup_wizard): + or frappe.flags.in_setup_wizard + ): return _cache = frappe.cache() @@ -145,39 +198,45 @@ def build_table_count_cache(): table_rows = frappe.qb.Field("table_rows").as_("count") information_schema = frappe.qb.Schema("information_schema") - data = ( - frappe.qb.from_(information_schema.tables).select(table_name, table_rows) - ).run(as_dict=True) - counts = {d.get('name').replace('tab', '', 1): d.get('count', None) for d in data} + data = (frappe.qb.from_(information_schema.tables).select(table_name, table_rows)).run( + as_dict=True + ) + counts = {d.get("name").replace("tab", "", 1): d.get("count", None) for d in data} _cache.set_value("information_schema:counts", counts) return counts + def build_domain_restriced_doctype_cache(*args, **kwargs): - if (frappe.flags.in_patch + if ( + frappe.flags.in_patch or frappe.flags.in_install or frappe.flags.in_migrate or frappe.flags.in_import - or frappe.flags.in_setup_wizard): + or frappe.flags.in_setup_wizard + ): return _cache = frappe.cache() active_domains = frappe.get_active_domains() - doctypes = frappe.get_all("DocType", filters={'restrict_to_domain': ('IN', active_domains)}) + doctypes = frappe.get_all("DocType", filters={"restrict_to_domain": ("IN", active_domains)}) doctypes = [doc.name for doc in doctypes] _cache.set_value("domain_restricted_doctypes", doctypes) return doctypes + def build_domain_restriced_page_cache(*args, **kwargs): - if (frappe.flags.in_patch + if ( + frappe.flags.in_patch or frappe.flags.in_install or frappe.flags.in_migrate or frappe.flags.in_import - or frappe.flags.in_setup_wizard): + or frappe.flags.in_setup_wizard + ): return _cache = frappe.cache() active_domains = frappe.get_active_domains() - pages = frappe.get_all("Page", filters={'restrict_to_domain': ('IN', active_domains)}) + pages = frappe.get_all("Page", filters={"restrict_to_domain": ("IN", active_domains)}) pages = [page.name for page in pages] _cache.set_value("domain_restricted_pages", pages) diff --git a/frappe/client.py b/frappe/client.py index 1898994afe..e970a64802 100644 --- a/frappe/client.py +++ b/frappe/client.py @@ -1,32 +1,44 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json +import os + import frappe -from frappe import _ import frappe.model import frappe.utils -import json, os -from frappe.utils import get_safe_filters +from frappe import _ from frappe.desk.reportview import validate_args from frappe.model.db_query import check_parent_permission +from frappe.utils import get_safe_filters - -''' +""" Handle RESTful requests that are mapped to the `/api/resource` route. Requests via FrappeClient are also handled here. -''' +""" + @frappe.whitelist() -def get_list(doctype, fields=None, filters=None, order_by=None, - limit_start=None, limit_page_length=20, parent=None, debug=False, as_dict=True, or_filters=None): - '''Returns a list of records by filters, fields, ordering and limit +def get_list( + doctype, + fields=None, + filters=None, + order_by=None, + limit_start=None, + limit_page_length=20, + parent=None, + debug=False, + as_dict=True, + or_filters=None, +): + """Returns a list of records by filters, fields, ordering and limit :param doctype: DocType of the data to be queried :param fields: fields to be returned. Default is `name` :param filters: filter list by this dict :param order_by: Order by this fieldname :param limit_start: Start at this index - :param limit_page_length: Number of records to be returned (default 20)''' + :param limit_page_length: Number of records to be returned (default 20)""" if frappe.is_table(doctype): check_parent_permission(parent, doctype) @@ -40,23 +52,25 @@ def get_list(doctype, fields=None, filters=None, order_by=None, limit_start=limit_start, limit_page_length=limit_page_length, debug=debug, - as_list=not as_dict + as_list=not as_dict, ) validate_args(args) return frappe.get_list(**args) + @frappe.whitelist() def get_count(doctype, filters=None, debug=False, cache=False): return frappe.db.count(doctype, get_safe_filters(filters), debug, cache) + @frappe.whitelist() def get(doctype, name=None, filters=None, parent=None): - '''Returns a document by name or filters + """Returns a document by name or filters :param doctype: DocType of the document to be returned :param name: return document of this `name` - :param filters: If name is not set, filter by these values and return the first match''' + :param filters: If name is not set, filter by these values and return the first match""" if frappe.is_table(doctype): check_parent_permission(parent, doctype) @@ -71,13 +85,14 @@ def get(doctype, name=None, filters=None, parent=None): return frappe.get_doc(doctype, name).as_dict() + @frappe.whitelist() def get_value(doctype, fieldname, filters=None, as_dict=True, debug=False, parent=None): - '''Returns a value form a document + """Returns a value form a document :param doctype: DocType to be queried :param fieldname: Field to be returned (default `name`) - :param filters: dict or string for identifying the record''' + :param filters: dict or string for identifying the record""" if frappe.is_table(doctype): check_parent_permission(parent, doctype) @@ -102,7 +117,15 @@ def get_value(doctype, fieldname, filters=None, as_dict=True, debug=False, paren if frappe.get_meta(doctype).issingle: value = frappe.db.get_values_from_single(fields, filters, doctype, as_dict=as_dict, debug=debug) else: - value = get_list(doctype, filters=filters, fields=fields, debug=debug, limit_page_length=1, parent=parent, as_dict=as_dict) + value = get_list( + doctype, + filters=filters, + fields=fields, + debug=debug, + limit_page_length=1, + parent=parent, + as_dict=as_dict, + ) if as_dict: return value[0] if value else {} @@ -112,6 +135,7 @@ def get_value(doctype, fieldname, filters=None, as_dict=True, debug=False, paren return value[0] if len(fields) > 1 else value[0][0] + @frappe.whitelist() def get_single_value(doctype, field): if not frappe.has_permission(doctype): @@ -119,14 +143,15 @@ def get_single_value(doctype, field): value = frappe.db.get_single_value(doctype, field) return value -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def set_value(doctype, name, fieldname, value=None): - '''Set a value using get_doc, group of values + """Set a value using get_doc, group of values :param doctype: DocType of the document :param name: name of the document :param fieldname: fieldname string or JSON / dict with key value pair - :param value: value if fieldname is JSON / dict''' + :param value: value if fieldname is JSON / dict""" if fieldname in (frappe.model.default_fields + frappe.model.child_table_fields): frappe.throw(_("Cannot edit standard fields")) @@ -137,7 +162,7 @@ def set_value(doctype, name, fieldname, value=None): try: values = json.loads(fieldname) except ValueError: - values = {fieldname: ''} + values = {fieldname: ""} else: values = {fieldname: value} @@ -155,11 +180,12 @@ def set_value(doctype, name, fieldname, value=None): return doc.as_dict() -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def insert(doc=None): - '''Insert a document + """Insert a document - :param doc: JSON or dict object to be inserted''' + :param doc: JSON or dict object to be inserted""" if isinstance(doc, str): doc = json.loads(doc) @@ -173,18 +199,19 @@ def insert(doc=None): doc = frappe.get_doc(doc).insert() return doc.as_dict() -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def insert_many(docs=None): - '''Insert multiple documents + """Insert multiple documents - :param docs: JSON or list of dict objects to be inserted in one request''' + :param docs: JSON or list of dict objects to be inserted in one request""" if isinstance(docs, str): docs = json.loads(docs) out = [] if len(docs) > 200: - frappe.throw(_('Only 200 inserts allowed in one request')) + frappe.throw(_("Only 200 inserts allowed in one request")) for doc in docs: if doc.get("parenttype"): @@ -199,11 +226,12 @@ def insert_many(docs=None): return out -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def save(doc): - '''Update (save) an existing document + """Update (save) an existing document - :param doc: JSON or dict object with the properties of the document to be updated''' + :param doc: JSON or dict object with the properties of the document to be updated""" if isinstance(doc, str): doc = json.loads(doc) @@ -212,21 +240,23 @@ def save(doc): return doc.as_dict() -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def rename_doc(doctype, old_name, new_name, merge=False): - '''Rename document + """Rename document :param doctype: DocType of the document to be renamed :param old_name: Current `name` of the document to be renamed - :param new_name: New `name` to be set''' + :param new_name: New `name` to be set""" new_name = frappe.rename_doc(doctype, old_name, new_name, merge=merge) return new_name -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def submit(doc): - '''Submit a document + """Submit a document - :param doc: JSON or dict object to be submitted remotely''' + :param doc: JSON or dict object to be submitted remotely""" if isinstance(doc, str): doc = json.loads(doc) @@ -235,52 +265,57 @@ def submit(doc): return doc.as_dict() -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def cancel(doctype, name): - '''Cancel a document + """Cancel a document :param doctype: DocType of the document to be cancelled - :param name: name of the document to be cancelled''' + :param name: name of the document to be cancelled""" wrapper = frappe.get_doc(doctype, name) wrapper.cancel() return wrapper.as_dict() -@frappe.whitelist(methods=['DELETE', 'POST']) + +@frappe.whitelist(methods=["DELETE", "POST"]) def delete(doctype, name): - '''Delete a remote document + """Delete a remote document :param doctype: DocType of the document to be deleted - :param name: name of the document to be deleted''' + :param name: name of the document to be deleted""" frappe.delete_doc(doctype, name, ignore_missing=False) -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def set_default(key, value, parent=None): """set a user default value""" frappe.db.set_default(key, value, parent or frappe.session.user) frappe.clear_cache(user=frappe.session.user) + @frappe.whitelist() def get_default(key, parent=None): """set a user default value""" return frappe.db.get_default(key, parent) -@frappe.whitelist(methods=['POST', 'PUT']) +@frappe.whitelist(methods=["POST", "PUT"]) def make_width_property_setter(doc): - '''Set width Property Setter + """Set width Property Setter - :param doc: Property Setter document with `width` property''' + :param doc: Property Setter document with `width` property""" if isinstance(doc, str): doc = json.loads(doc) - if doc["doctype"]=="Property Setter" and doc["property"]=="width": - frappe.get_doc(doc).insert(ignore_permissions = True) + if doc["doctype"] == "Property Setter" and doc["property"] == "width": + frappe.get_doc(doc).insert(ignore_permissions=True) -@frappe.whitelist(methods=['POST', 'PUT']) + +@frappe.whitelist(methods=["POST", "PUT"]) def bulk_update(docs): - '''Bulk update documents + """Bulk update documents - :param docs: JSON list of documents to be updated remotely. Each document must have `docname` property''' + :param docs: JSON list of documents to be updated remotely. Each document must have `docname` property""" docs = json.loads(docs) failed_docs = [] for doc in docs: @@ -290,41 +325,40 @@ def bulk_update(docs): existing_doc.update(doc) existing_doc.save() except Exception: - failed_docs.append({ - 'doc': doc, - 'exc': frappe.utils.get_traceback() - }) + failed_docs.append({"doc": doc, "exc": frappe.utils.get_traceback()}) + + return {"failed_docs": failed_docs} - return {'failed_docs': failed_docs} @frappe.whitelist() def has_permission(doctype, docname, perm_type="read"): - '''Returns a JSON with data whether the document has the requested permission + """Returns a JSON with data whether the document has the requested permission :param doctype: DocType of the document to be checked :param docname: `name` of the document to be checked - :param perm_type: one of `read`, `write`, `create`, `submit`, `cancel`, `report`. Default is `read`''' + :param perm_type: one of `read`, `write`, `create`, `submit`, `cancel`, `report`. Default is `read`""" # perm_type can be one of read, write, create, submit, cancel, report return {"has_permission": frappe.has_permission(doctype, perm_type.lower(), docname)} + @frappe.whitelist() def get_password(doctype, name, fieldname): - '''Return a password type property. Only applicable for System Managers + """Return a password type property. Only applicable for System Managers :param doctype: DocType of the document that holds the password :param name: `name` of the document that holds the password :param fieldname: `fieldname` of the password property - ''' + """ frappe.only_for("System Manager") return frappe.get_doc(doctype, name).get_password(fieldname) @frappe.whitelist() def get_js(items): - '''Load JS code files. Will also append translations + """Load JS code files. Will also append translations and extend `frappe._messages` - :param items: JSON list of paths of the js files to be loaded.''' + :param items: JSON list of paths of the js files to be loaded.""" items = json.loads(items) out = [] for src in items: @@ -346,14 +380,25 @@ def get_js(items): return out + @frappe.whitelist(allow_guest=True) def get_time_zone(): - '''Returns default time zone''' + """Returns default time zone""" return {"time_zone": frappe.defaults.get_defaults().get("time_zone")} -@frappe.whitelist(methods=['POST', 'PUT']) -def attach_file(filename=None, filedata=None, doctype=None, docname=None, folder=None, decode_base64=False, is_private=None, docfield=None): - '''Attach a file to Document (POST) + +@frappe.whitelist(methods=["POST", "PUT"]) +def attach_file( + filename=None, + filedata=None, + doctype=None, + docname=None, + folder=None, + decode_base64=False, + is_private=None, + docfield=None, +): + """Attach a file to Document (POST) :param filename: filename e.g. test-file.txt :param filedata: base64 encode filedata which must be urlencoded @@ -362,7 +407,7 @@ def attach_file(filename=None, filedata=None, doctype=None, docname=None, folder :param folder: Folder to add File into :param decode_base64: decode filedata from base64 encode, default is False :param is_private: Attach file as private file (1 or 0) - :param docfield: file to attach to (optional)''' + :param docfield: file to attach to (optional)""" request_method = frappe.local.request.environ.get("REQUEST_METHOD") @@ -374,16 +419,19 @@ def attach_file(filename=None, filedata=None, doctype=None, docname=None, folder if not doc.has_permission(): frappe.throw(_("Not permitted"), frappe.PermissionError) - _file = frappe.get_doc({ - "doctype": "File", - "file_name": filename, - "attached_to_doctype": doctype, - "attached_to_name": docname, - "attached_to_field": docfield, - "folder": folder, - "is_private": is_private, - "content": filedata, - "decode": decode_base64}) + _file = frappe.get_doc( + { + "doctype": "File", + "file_name": filename, + "attached_to_doctype": doctype, + "attached_to_name": docname, + "attached_to_field": docfield, + "folder": folder, + "is_private": is_private, + "content": filedata, + "decode": decode_base64, + } + ) _file.save() if docfield and doctype: @@ -392,22 +440,23 @@ def attach_file(filename=None, filedata=None, doctype=None, docname=None, folder return _file.as_dict() + @frappe.whitelist() def get_hooks(hook, app_name=None): return frappe.get_hooks(hook, app_name) + @frappe.whitelist() def is_document_amended(doctype, docname): if frappe.permissions.has_permission(doctype): try: - return frappe.db.exists(doctype, { - 'amended_from': docname - }) + return frappe.db.exists(doctype, {"amended_from": docname}) except frappe.db.InternalError: pass return False + @frappe.whitelist() def validate_link(doctype: str, docname: str, fields=None): if not isinstance(doctype, str): @@ -417,13 +466,11 @@ def validate_link(doctype: str, docname: str, fields=None): frappe.throw(_("Document Name must be a string")) if doctype != "DocType" and not ( - frappe.has_permission(doctype, "select") - or frappe.has_permission(doctype, "read") + frappe.has_permission(doctype, "select") or frappe.has_permission(doctype, "read") ): frappe.throw( - _("You do not have Read or Select Permissions for {}") - .format(frappe.bold(doctype)), - frappe.PermissionError + _("You do not have Read or Select Permissions for {}").format(frappe.bold(doctype)), + frappe.PermissionError, ) values = frappe._dict() @@ -438,14 +485,11 @@ def validate_link(doctype: str, docname: str, fields=None): except frappe.PermissionError: frappe.clear_last_message() frappe.msgprint( - _("You need {0} permission to fetch values from {1} {2}") - .format( - frappe.bold(_("Read")), - frappe.bold(doctype), - frappe.bold(docname) + _("You need {0} permission to fetch values from {1} {2}").format( + frappe.bold(_("Read")), frappe.bold(doctype), frappe.bold(docname) ), title=_("Cannot Fetch Values"), - indicator="orange" + indicator="orange", ) return values diff --git a/frappe/commands/__init__.py b/frappe/commands/__init__.py index 82a71ce7b4..f61b3b9d34 100644 --- a/frappe/commands/__init__.py +++ b/frappe/commands/__init__.py @@ -1,23 +1,26 @@ # Copyright (c) 2015, Web Notes Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import sys -import click import cProfile import pstats -import frappe -import frappe.utils -import subprocess # nosec +import subprocess # nosec +import sys from functools import wraps from io import StringIO from os import environ +import click + +import frappe +import frappe.utils + click.disable_unicode_literals_warning = True + def pass_context(f): @wraps(f) def _func(ctx, *args, **kwargs): - profile = ctx.obj['profile'] + profile = ctx.obj["profile"] if profile: pr = cProfile.Profile() pr.enable() @@ -25,18 +28,17 @@ def pass_context(f): try: ret = f(frappe._dict(ctx.obj), *args, **kwargs) except frappe.exceptions.SiteNotSpecifiedError as e: - click.secho(str(e), fg='yellow') + click.secho(str(e), fg="yellow") sys.exit(1) except frappe.exceptions.IncorrectSitePath: site = ctx.obj.get("sites", "")[0] - click.secho(f'Site {site} does not exist!', fg='yellow') + click.secho(f"Site {site} does not exist!", fg="yellow") sys.exit(1) if profile: pr.disable() s = StringIO() - ps = pstats.Stats(pr, stream=s)\ - .sort_stats('cumtime', 'tottime', 'ncalls') + ps = pstats.Stats(pr, stream=s).sort_stats("cumtime", "tottime", "ncalls") ps.print_stats() # print the top-100 @@ -47,6 +49,7 @@ def pass_context(f): return click.pass_context(_func) + def get_site(context, raise_err=True): try: site = context.sites[0] @@ -56,17 +59,19 @@ def get_site(context, raise_err=True): raise frappe.SiteNotSpecifiedError return None + def popen(command, *args, **kwargs): - output = kwargs.get('output', True) - cwd = kwargs.get('cwd') - shell = kwargs.get('shell', True) - raise_err = kwargs.get('raise_err') - env = kwargs.get('env') + output = kwargs.get("output", True) + cwd = kwargs.get("cwd") + shell = kwargs.get("shell", True) + raise_err = kwargs.get("raise_err") + env = kwargs.get("env") if env: env = dict(environ, **env) def set_low_prio(): import psutil + if psutil.LINUX: psutil.Process().nice(19) psutil.Process().ionice(psutil.IOPRIO_CLASS_IDLE) @@ -77,13 +82,14 @@ def popen(command, *args, **kwargs): psutil.Process().nice(19) # ionice not supported - proc = subprocess.Popen(command, + proc = subprocess.Popen( + command, stdout=None if output else subprocess.PIPE, stderr=None if output else subprocess.PIPE, shell=shell, cwd=cwd, preexec_fn=set_low_prio, - env=env + env=env, ) return_ = proc.wait() @@ -93,26 +99,22 @@ def popen(command, *args, **kwargs): return return_ + def call_command(cmd, context): return click.Context(cmd, obj=context).forward(cmd) + def get_commands(): # prevent circular imports + from .redis_utils import commands as redis_commands from .scheduler import commands as scheduler_commands from .site import commands as site_commands from .translate import commands as translate_commands from .utils import commands as utils_commands - from .redis_utils import commands as redis_commands - clickable_link = ( - "\x1b]8;;https://frappeframework.com/docs\afrappeframework.com\x1b]8;;\a" - ) + clickable_link = "\x1b]8;;https://frappeframework.com/docs\afrappeframework.com\x1b]8;;\a" all_commands = ( - scheduler_commands - + site_commands - + translate_commands - + utils_commands - + redis_commands + scheduler_commands + site_commands + translate_commands + utils_commands + redis_commands ) for command in all_commands: diff --git a/frappe/commands/redis_utils.py b/frappe/commands/redis_utils.py index 3556050782..1c3292b7fa 100644 --- a/frappe/commands/redis_utils.py +++ b/frappe/commands/redis_utils.py @@ -3,51 +3,71 @@ import os import click import frappe -from frappe.utils.redis_queue import RedisQueue from frappe.installer import update_site_config +from frappe.utils.redis_queue import RedisQueue -@click.command('create-rq-users') -@click.option('--set-admin-password', is_flag=True, default=False, help='Set new Redis admin(default user) password') -@click.option('--use-rq-auth', is_flag=True, default=False, help='Enable Redis authentication for sites') + +@click.command("create-rq-users") +@click.option( + "--set-admin-password", + is_flag=True, + default=False, + help="Set new Redis admin(default user) password", +) +@click.option( + "--use-rq-auth", is_flag=True, default=False, help="Enable Redis authentication for sites" +) def create_rq_users(set_admin_password=False, use_rq_auth=False): """Create Redis Queue users and add to acl and app configs. acl config file will be used by redis server while starting the server and app config is used by app while connecting to redis server. """ - acl_file_path = os.path.abspath('../config/redis_queue.acl') + acl_file_path = os.path.abspath("../config/redis_queue.acl") with frappe.init_site(): - acl_list, user_credentials = RedisQueue.gen_acl_list( - set_admin_password=set_admin_password) + acl_list, user_credentials = RedisQueue.gen_acl_list(set_admin_password=set_admin_password) - with open(acl_file_path, 'w') as f: - f.writelines([acl+'\n' for acl in acl_list]) + with open(acl_file_path, "w") as f: + f.writelines([acl + "\n" for acl in acl_list]) sites_path = os.getcwd() - common_site_config_path = os.path.join(sites_path, 'common_site_config.json') - update_site_config("rq_username", user_credentials['bench'][0], validate=False, - site_config_path=common_site_config_path) - update_site_config("rq_password", user_credentials['bench'][1], validate=False, - site_config_path=common_site_config_path) - update_site_config("use_rq_auth", use_rq_auth, validate=False, - site_config_path=common_site_config_path) - - click.secho('* ACL and site configs are updated with new user credentials. ' - 'Please restart Redis Queue server to enable namespaces.', - fg='green') + common_site_config_path = os.path.join(sites_path, "common_site_config.json") + update_site_config( + "rq_username", + user_credentials["bench"][0], + validate=False, + site_config_path=common_site_config_path, + ) + update_site_config( + "rq_password", + user_credentials["bench"][1], + validate=False, + site_config_path=common_site_config_path, + ) + update_site_config( + "use_rq_auth", use_rq_auth, validate=False, site_config_path=common_site_config_path + ) + + click.secho( + "* ACL and site configs are updated with new user credentials. " + "Please restart Redis Queue server to enable namespaces.", + fg="green", + ) if set_admin_password: - env_key = 'RQ_ADMIN_PASWORD' - click.secho('* Redis admin password is successfully set up. ' - 'Include below line in .bashrc file for system to use', - fg='green') + env_key = "RQ_ADMIN_PASWORD" + click.secho( + "* Redis admin password is successfully set up. " + "Include below line in .bashrc file for system to use", + fg="green", + ) click.secho(f"`export {env_key}={user_credentials['default'][1]}`") - click.secho('NOTE: Please save the admin password as you ' - 'can not access redis server without the password', - fg='yellow') + click.secho( + "NOTE: Please save the admin password as you " + "can not access redis server without the password", + fg="yellow", + ) -commands = [ - create_rq_users -] +commands = [create_rq_users] diff --git a/frappe/commands/scheduler.py b/frappe/commands/scheduler.py index f82473fd55..ed6a0dea57 100755 --- a/frappe/commands/scheduler.py +++ b/frappe/commands/scheduler.py @@ -1,15 +1,20 @@ -import click import sys + +import click + import frappe -from frappe.utils import cint -from frappe.commands import pass_context, get_site +from frappe.commands import get_site, pass_context from frappe.exceptions import SiteNotSpecifiedError +from frappe.utils import cint + def _is_scheduler_enabled(): enable_scheduler = False try: frappe.connect() - enable_scheduler = cint(frappe.db.get_single_value("System Settings", "enable_scheduler")) and True or False + enable_scheduler = ( + cint(frappe.db.get_single_value("System Settings", "enable_scheduler")) and True or False + ) except: pass finally: @@ -44,11 +49,12 @@ def trigger_scheduler_event(context, event): sys.exit(exit_code) -@click.command('enable-scheduler') +@click.command("enable-scheduler") @pass_context def enable_scheduler(context): "Enable scheduler" import frappe.utils.scheduler + for site in context.sites: try: frappe.init(site=site) @@ -61,11 +67,13 @@ def enable_scheduler(context): if not context.sites: raise SiteNotSpecifiedError -@click.command('disable-scheduler') + +@click.command("disable-scheduler") @pass_context def disable_scheduler(context): "Disable scheduler" import frappe.utils.scheduler + for site in context.sites: try: frappe.init(site=site) @@ -79,13 +87,13 @@ def disable_scheduler(context): raise SiteNotSpecifiedError -@click.command('scheduler') -@click.option('--site', help='site name') -@click.argument('state', type=click.Choice(['pause', 'resume', 'disable', 'enable'])) +@click.command("scheduler") +@click.option("--site", help="site name") +@click.argument("state", type=click.Choice(["pause", "resume", "disable", "enable"])) @pass_context def scheduler(context, state, site=None): - from frappe.installer import update_site_config import frappe.utils.scheduler + from frappe.installer import update_site_config if not site: site = get_site(context) @@ -93,58 +101,64 @@ def scheduler(context, state, site=None): try: frappe.init(site=site) - if state == 'pause': - update_site_config('pause_scheduler', 1) - elif state == 'resume': - update_site_config('pause_scheduler', 0) - elif state == 'disable': + if state == "pause": + update_site_config("pause_scheduler", 1) + elif state == "resume": + update_site_config("pause_scheduler", 0) + elif state == "disable": frappe.connect() frappe.utils.scheduler.disable_scheduler() frappe.db.commit() - elif state == 'enable': + elif state == "enable": frappe.connect() frappe.utils.scheduler.enable_scheduler() frappe.db.commit() - print('Scheduler {0}d for site {1}'.format(state, site)) + print("Scheduler {0}d for site {1}".format(state, site)) finally: frappe.destroy() -@click.command('set-maintenance-mode') -@click.option('--site', help='site name') -@click.argument('state', type=click.Choice(['on', 'off'])) +@click.command("set-maintenance-mode") +@click.option("--site", help="site name") +@click.argument("state", type=click.Choice(["on", "off"])) @pass_context def set_maintenance_mode(context, state, site=None): from frappe.installer import update_site_config + if not site: site = get_site(context) try: frappe.init(site=site) - update_site_config('maintenance_mode', 1 if (state == 'on') else 0) + update_site_config("maintenance_mode", 1 if (state == "on") else 0) finally: frappe.destroy() -@click.command('doctor') #Passing context always gets a site and if there is no use site it breaks -@click.option('--site', help='site name') +@click.command( + "doctor" +) # Passing context always gets a site and if there is no use site it breaks +@click.option("--site", help="site name") @pass_context def doctor(context, site=None): "Get diagnostic info about background workers" from frappe.utils.doctor import doctor as _doctor + if not site: site = get_site(context, raise_err=False) return _doctor(site=site) -@click.command('show-pending-jobs') -@click.option('--site', help='site name') + +@click.command("show-pending-jobs") +@click.option("--site", help="site name") @pass_context def show_pending_jobs(context, site=None): "Get diagnostic info about background jobs" from frappe.utils.doctor import pending_jobs as _pending_jobs + if not site: site = get_site(context) @@ -153,35 +167,45 @@ def show_pending_jobs(context, site=None): return pending_jobs -@click.command('purge-jobs') -@click.option('--site', help='site name') -@click.option('--queue', default=None, help='one of "low", "default", "high') -@click.option('--event', default=None, help='one of "all", "weekly", "monthly", "hourly", "daily", "weekly_long", "daily_long"') + +@click.command("purge-jobs") +@click.option("--site", help="site name") +@click.option("--queue", default=None, help='one of "low", "default", "high') +@click.option( + "--event", + default=None, + help='one of "all", "weekly", "monthly", "hourly", "daily", "weekly_long", "daily_long"', +) def purge_jobs(site=None, queue=None, event=None): "Purge any pending periodic tasks, if event option is not given, it will purge everything for the site" from frappe.utils.doctor import purge_pending_jobs - frappe.init(site or '') + + frappe.init(site or "") count = purge_pending_jobs(event=event, site=site, queue=queue) print("Purged {} jobs".format(count)) -@click.command('schedule') + +@click.command("schedule") def start_scheduler(): from frappe.utils.scheduler import start_scheduler + start_scheduler() -@click.command('worker') -@click.option('--queue', type=str) -@click.option('--quiet', is_flag = True, default = False, help = 'Hide Log Outputs') -@click.option('-u', '--rq-username', default=None, help='Redis ACL user') -@click.option('-p', '--rq-password', default=None, help='Redis ACL user password') -def start_worker(queue, quiet = False, rq_username=None, rq_password=None): - """Site is used to find redis credentals. - """ + +@click.command("worker") +@click.option("--queue", type=str) +@click.option("--quiet", is_flag=True, default=False, help="Hide Log Outputs") +@click.option("-u", "--rq-username", default=None, help="Redis ACL user") +@click.option("-p", "--rq-password", default=None, help="Redis ACL user password") +def start_worker(queue, quiet=False, rq_username=None, rq_password=None): + """Site is used to find redis credentals.""" from frappe.utils.background_jobs import start_worker - start_worker(queue, quiet = quiet, rq_username=rq_username, rq_password=rq_password) -@click.command('ready-for-migration') -@click.option('--site', help='site name') + start_worker(queue, quiet=quiet, rq_username=rq_username, rq_password=rq_password) + + +@click.command("ready-for-migration") +@click.option("--site", help="site name") @pass_context def ready_for_migration(context, site=None): from frappe.utils.doctor import get_pending_jobs @@ -194,16 +218,17 @@ def ready_for_migration(context, site=None): pending_jobs = get_pending_jobs(site=site) if pending_jobs: - print('NOT READY for migration: site {0} has pending background jobs'.format(site)) + print("NOT READY for migration: site {0} has pending background jobs".format(site)) sys.exit(1) else: - print('READY for migration: site {0} does not have any background jobs'.format(site)) + print("READY for migration: site {0} does not have any background jobs".format(site)) return 0 finally: frappe.destroy() + commands = [ disable_scheduler, doctor, diff --git a/frappe/commands/site.py b/frappe/commands/site.py index 6bee442054..fa9ab4be59 100644 --- a/frappe/commands/site.py +++ b/frappe/commands/site.py @@ -12,56 +12,128 @@ from frappe.commands import get_site, pass_context from frappe.exceptions import SiteNotSpecifiedError -@click.command('new-site') -@click.argument('site') -@click.option('--db-name', help='Database name') -@click.option('--db-password', help='Database password') -@click.option('--db-type', default='mariadb', type=click.Choice(['mariadb', 'postgres']), help='Optional "postgres" or "mariadb". Default is "mariadb"') -@click.option('--db-host', help='Database Host') -@click.option('--db-port', type=int, help='Database Port') -@click.option('--db-root-username', '--mariadb-root-username', help='Root username for MariaDB or PostgreSQL, Default is "root"') -@click.option('--db-root-password', '--mariadb-root-password', help='Root password for MariaDB or PostgreSQL') -@click.option('--no-mariadb-socket', is_flag=True, default=False, help='Set MariaDB host to % and use TCP/IP Socket instead of using the UNIX Socket') -@click.option('--admin-password', help='Administrator password for new site', default=None) -@click.option('--verbose', is_flag=True, default=False, help='Verbose') -@click.option('--force', help='Force restore if site/database already exists', is_flag=True, default=False) -@click.option('--source_sql', help='Initiate database with a SQL file') -@click.option('--install-app', multiple=True, help='Install app after installation') -@click.option('--set-default', is_flag=True, default=False, help='Set the new site as default site') -def new_site(site, db_root_username=None, db_root_password=None, admin_password=None, - verbose=False, install_apps=None, source_sql=None, force=None, no_mariadb_socket=False, - install_app=None, db_name=None, db_password=None, db_type=None, db_host=None, db_port=None, - set_default=False): +@click.command("new-site") +@click.argument("site") +@click.option("--db-name", help="Database name") +@click.option("--db-password", help="Database password") +@click.option( + "--db-type", + default="mariadb", + type=click.Choice(["mariadb", "postgres"]), + help='Optional "postgres" or "mariadb". Default is "mariadb"', +) +@click.option("--db-host", help="Database Host") +@click.option("--db-port", type=int, help="Database Port") +@click.option( + "--db-root-username", + "--mariadb-root-username", + help='Root username for MariaDB or PostgreSQL, Default is "root"', +) +@click.option( + "--db-root-password", "--mariadb-root-password", help="Root password for MariaDB or PostgreSQL" +) +@click.option( + "--no-mariadb-socket", + is_flag=True, + default=False, + help="Set MariaDB host to % and use TCP/IP Socket instead of using the UNIX Socket", +) +@click.option("--admin-password", help="Administrator password for new site", default=None) +@click.option("--verbose", is_flag=True, default=False, help="Verbose") +@click.option( + "--force", help="Force restore if site/database already exists", is_flag=True, default=False +) +@click.option("--source_sql", help="Initiate database with a SQL file") +@click.option("--install-app", multiple=True, help="Install app after installation") +@click.option( + "--set-default", is_flag=True, default=False, help="Set the new site as default site" +) +def new_site( + site, + db_root_username=None, + db_root_password=None, + admin_password=None, + verbose=False, + install_apps=None, + source_sql=None, + force=None, + no_mariadb_socket=False, + install_app=None, + db_name=None, + db_password=None, + db_type=None, + db_host=None, + db_port=None, + set_default=False, +): "Create a new site" from frappe.installer import _new_site frappe.init(site=site, new_site=True) - _new_site(db_name, site, db_root_username=db_root_username, - db_root_password=db_root_password, admin_password=admin_password, - verbose=verbose, install_apps=install_app, source_sql=source_sql, force=force, - no_mariadb_socket=no_mariadb_socket, db_password=db_password, db_type=db_type, db_host=db_host, - db_port=db_port, new_site=True) + _new_site( + db_name, + site, + db_root_username=db_root_username, + db_root_password=db_root_password, + admin_password=admin_password, + verbose=verbose, + install_apps=install_app, + source_sql=source_sql, + force=force, + no_mariadb_socket=no_mariadb_socket, + db_password=db_password, + db_type=db_type, + db_host=db_host, + db_port=db_port, + new_site=True, + ) if set_default: use(site) -@click.command('restore') -@click.argument('sql-file-path') -@click.option('--db-root-username', '--mariadb-root-username', help='Root username for MariaDB or PostgreSQL, Default is "root"') -@click.option('--db-root-password', '--mariadb-root-password', help='Root password for MariaDB or PostgreSQL') -@click.option('--db-name', help='Database name for site in case it is a new one') -@click.option('--admin-password', help='Administrator password for new site') -@click.option('--install-app', multiple=True, help='Install app after installation') -@click.option('--with-public-files', help='Restores the public files of the site, given path to its tar file') -@click.option('--with-private-files', help='Restores the private files of the site, given path to its tar file') -@click.option('--force', is_flag=True, default=False, help='Ignore the validations and downgrade warnings. This action is not recommended') -@click.option('--encryption-key', help='Backup encryption key') +@click.command("restore") +@click.argument("sql-file-path") +@click.option( + "--db-root-username", + "--mariadb-root-username", + help='Root username for MariaDB or PostgreSQL, Default is "root"', +) +@click.option( + "--db-root-password", "--mariadb-root-password", help="Root password for MariaDB or PostgreSQL" +) +@click.option("--db-name", help="Database name for site in case it is a new one") +@click.option("--admin-password", help="Administrator password for new site") +@click.option("--install-app", multiple=True, help="Install app after installation") +@click.option( + "--with-public-files", help="Restores the public files of the site, given path to its tar file" +) +@click.option( + "--with-private-files", help="Restores the private files of the site, given path to its tar file" +) +@click.option( + "--force", + is_flag=True, + default=False, + help="Ignore the validations and downgrade warnings. This action is not recommended", +) +@click.option("--encryption-key", help="Backup encryption key") @pass_context -def restore(context, sql_file_path, encryption_key=None, db_root_username=None, db_root_password=None, - db_name=None, verbose=None, install_app=None, admin_password=None, force=None, with_public_files=None, - with_private_files=None): +def restore( + context, + sql_file_path, + encryption_key=None, + db_root_username=None, + db_root_password=None, + db_name=None, + verbose=None, + install_app=None, + admin_password=None, + force=None, + with_public_files=None, + with_private_files=None, +): "Restore site database from an sql file" from frappe.installer import ( _new_site, @@ -72,6 +144,7 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, validate_database_sql, ) from frappe.utils.backups import Backup + if not os.path.exists(sql_file_path): print("Invalid path", sql_file_path) sys.exit(1) @@ -87,11 +160,10 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, if is_partial(decompressed_file_name): click.secho( "Partial Backup file detected. You cannot use a partial file to restore a Frappe site.", - fg="red" + fg="red", ) click.secho( - "Use `bench partial-restore` to restore a partial backup to an existing site.", - fg="yellow" + "Use `bench partial-restore` to restore a partial backup to an existing site.", fg="yellow" ) _backup.decryption_rollback() sys.exit(1) @@ -99,26 +171,17 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, except UnicodeDecodeError: _backup.decryption_rollback() if encryption_key: - click.secho( - "Encrypted backup file detected. Decrypting using provided key.", - fg="yellow" - ) + click.secho("Encrypted backup file detected. Decrypting using provided key.", fg="yellow") _backup.backup_decryption(encryption_key) else: - click.secho( - "Encrypted backup file detected. Decrypting using site config.", - fg="yellow" - ) + click.secho("Encrypted backup file detected. Decrypting using site config.", fg="yellow") encryption_key = frappe.get_site_config().encryption_key _backup.backup_decryption(encryption_key) # Rollback on unsuccessful decryrption if not os.path.exists(sql_file_path): - click.secho( - "Decryption failed. Please provide a valid key and try again.", - fg="red" - ) + click.secho("Decryption failed. Please provide a valid key and try again.", fg="red") _backup.decryption_rollback() sys.exit(1) @@ -128,17 +191,14 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, if is_partial(decompressed_file_name): click.secho( "Partial Backup file detected. You cannot use a partial file to restore a Frappe site.", - fg="red" + fg="red", ) click.secho( - "Use `bench partial-restore` to restore a partial backup to an existing site.", - fg="yellow" + "Use `bench partial-restore` to restore a partial backup to an existing site.", fg="yellow" ) _backup.decryption_rollback() sys.exit(1) - - validate_database_sql(decompressed_file_name, _raise=not force) # dont allow downgrading to older versions of frappe without force @@ -149,13 +209,19 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, ) click.confirm(warn_message, abort=True) - - try: - _new_site(frappe.conf.db_name, site, db_root_username=db_root_username, - db_root_password=db_root_password, admin_password=admin_password, - verbose=context.verbose, install_apps=install_app, source_sql=decompressed_file_name, - force=True, db_type=frappe.conf.db_type) + _new_site( + frappe.conf.db_name, + site, + db_root_username=db_root_username, + db_root_password=db_root_password, + admin_password=admin_password, + verbose=context.verbose, + install_apps=install_app, + source_sql=decompressed_file_name, + force=True, + db_type=frappe.conf.db_type, + ) except Exception as err: print(err.args[1]) @@ -181,7 +247,6 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, os.remove(public) _backup.decryption_rollback() - if with_private_files: # Decrypt data if there is a Key if encryption_key: @@ -196,17 +261,17 @@ def restore(context, sql_file_path, encryption_key=None, db_root_username=None, _backup.decryption_rollback() success_message = "Site {0} has been restored{1}".format( - site, - " with files" if (with_public_files or with_private_files) else "" + site, " with files" if (with_public_files or with_private_files) else "" ) click.secho(success_message, fg="green") -@click.command('partial-restore') -@click.argument('sql-file-path') + +@click.command("partial-restore") +@click.argument("sql-file-path") @click.option("--verbose", "-v", is_flag=True) -@click.option('--encryption-key', help='Backup encryption key') +@click.option("--encryption-key", help="Backup encryption key") @pass_context -def partial_restore(context, sql_file_path, verbose, encryption_key=None): +def partial_restore(context, sql_file_path, verbose, encryption_key=None): from frappe.installer import extract_sql_from_archive, partial_restore from frappe.utils.backups import Backup @@ -228,40 +293,29 @@ def partial_restore(context, sql_file_path, verbose, encryption_key=None): with open(decompressed_file_name) as f: header = " ".join(f.readline() for _ in range(5)) - #Check for full backup file + # Check for full backup file if "Partial Backup" not in header: click.secho( - "Full backup file detected.Use `bench restore` to restore a Frappe Site.", - fg="red" + "Full backup file detected.Use `bench restore` to restore a Frappe Site.", fg="red" ) _backup.decryption_rollback() sys.exit(1) - except UnicodeDecodeError: _backup.decryption_rollback() if encryption_key: - click.secho( - "Encrypted backup file detected. Decrypting using provided key.", - fg="yellow" - ) + click.secho("Encrypted backup file detected. Decrypting using provided key.", fg="yellow") key = encryption_key else: - click.secho( - "Encrypted backup file detected. Decrypting using site config.", - fg="yellow" - ) + click.secho("Encrypted backup file detected. Decrypting using site config.", fg="yellow") key = frappe.get_site_config().encryption_key _backup.backup_decryption(key) # Rollback on unsuccessful decryrption if not os.path.exists(sql_file_path): - click.secho( - "Decryption failed. Please provide a valid key and try again.", - fg="red" - ) + click.secho("Decryption failed. Please provide a valid key and try again.", fg="red") _backup.decryption_rollback() sys.exit(1) @@ -270,16 +324,14 @@ def partial_restore(context, sql_file_path, verbose, encryption_key=None): with open(decompressed_file_name) as f: header = " ".join(f.readline() for _ in range(5)) - #Check for Full backup file. + # Check for Full backup file. if "Partial Backup" not in header: click.secho( - "Full Backup file detected.Use `bench restore` to restore a Frappe Site.", - fg="red" + "Full Backup file detected.Use `bench restore` to restore a Frappe Site.", fg="red" ) _backup.decryption_rollback() sys.exit(1) - partial_restore(sql_file_path, verbose) # Removing temporarily created file @@ -290,22 +342,33 @@ def partial_restore(context, sql_file_path, verbose, encryption_key=None): frappe.destroy() -@click.command('reinstall') -@click.option('--admin-password', help='Administrator Password for reinstalled site') -@click.option('--db-root-username', '--mariadb-root-username', help='Root username for MariaDB or PostgreSQL, Default is "root"') -@click.option('--db-root-password', '--mariadb-root-password', help='Root password for MariaDB or PostgreSQL') -@click.option('--yes', is_flag=True, default=False, help='Pass --yes to skip confirmation') +@click.command("reinstall") +@click.option("--admin-password", help="Administrator Password for reinstalled site") +@click.option( + "--db-root-username", + "--mariadb-root-username", + help='Root username for MariaDB or PostgreSQL, Default is "root"', +) +@click.option( + "--db-root-password", "--mariadb-root-password", help="Root password for MariaDB or PostgreSQL" +) +@click.option("--yes", is_flag=True, default=False, help="Pass --yes to skip confirmation") @pass_context -def reinstall(context, admin_password=None, db_root_username=None, db_root_password=None, yes=False): +def reinstall( + context, admin_password=None, db_root_username=None, db_root_password=None, yes=False +): "Reinstall site ie. wipe all data and start over" site = get_site(context) _reinstall(site, admin_password, db_root_username, db_root_password, yes, verbose=context.verbose) -def _reinstall(site, admin_password=None, db_root_username=None, db_root_password=None, yes=False, verbose=False): + +def _reinstall( + site, admin_password=None, db_root_username=None, db_root_password=None, yes=False, verbose=False +): from frappe.installer import _new_site if not yes: - click.confirm('This will wipe your database. Are you sure you want to reinstall?', abort=True) + click.confirm("This will wipe your database. Are you sure you want to reinstall?", abort=True) try: frappe.init(site=site) frappe.connect() @@ -320,16 +383,26 @@ def _reinstall(site, admin_password=None, db_root_username=None, db_root_passwor frappe.destroy() frappe.init(site=site) - _new_site(frappe.conf.db_name, site, verbose=verbose, force=True, reinstall=True, install_apps=installed, - db_root_username=db_root_username, db_root_password=db_root_password, - admin_password=admin_password) + _new_site( + frappe.conf.db_name, + site, + verbose=verbose, + force=True, + reinstall=True, + install_apps=installed, + db_root_username=db_root_username, + db_root_password=db_root_password, + admin_password=admin_password, + ) -@click.command('install-app') -@click.argument('apps', nargs=-1) + +@click.command("install-app") +@click.argument("apps", nargs=-1) @pass_context def install_app(context, apps): "Install a new app to site, supports multiple apps" from frappe.installer import install_app as _install_app + exit_code = 0 if not context.sites: @@ -374,21 +447,15 @@ def list_apps(context, format): for site in context.sites: frappe.init(site=site) frappe.connect() - site_title = ( - click.style(f"{site}", fg="green") if len(context.sites) > 1 else "" - ) + site_title = click.style(f"{site}", fg="green") if len(context.sites) > 1 else "" apps = frappe.get_single("Installed Applications").installed_applications if apps: - name_len, ver_len = [ - max([len(x.get(y)) for x in apps]) - for y in ["app_name", "app_version"] - ] + name_len, ver_len = [max([len(x.get(y)) for x in apps]) for y in ["app_name", "app_version"]] template = "{{0:{0}}} {{1:{1}}} {{2}}".format(name_len, ver_len) installed_applications = [ - template.format(app.app_name, app.app_version, app.git_branch) - for app in apps + template.format(app.app_name, app.app_version, app.git_branch) for app in apps ] applications_summary = "\n".join(installed_applications) summary = f"{site_title}\n{applications_summary}\n" @@ -410,29 +477,31 @@ def list_apps(context, format): if format == "json": click.echo(frappe.as_json(summary_dict)) -@click.command('add-system-manager') -@click.argument('email') -@click.option('--first-name') -@click.option('--last-name') -@click.option('--password') -@click.option('--send-welcome-email', default=False, is_flag=True) + +@click.command("add-system-manager") +@click.argument("email") +@click.option("--first-name") +@click.option("--last-name") +@click.option("--password") +@click.option("--send-welcome-email", default=False, is_flag=True) @pass_context def add_system_manager(context, email, first_name, last_name, send_welcome_email, password): "Add a new system manager to a site" import frappe.utils.user + for site in context.sites: frappe.connect(site=site) try: - frappe.utils.user.add_system_manager(email, first_name, last_name, - send_welcome_email, password) + frappe.utils.user.add_system_manager(email, first_name, last_name, send_welcome_email, password) frappe.db.commit() finally: frappe.destroy() if not context.sites: raise SiteNotSpecifiedError -@click.command('disable-user') -@click.argument('email') + +@click.command("disable-user") +@click.argument("email") @pass_context def disable_user(context, email): site = get_site(context) @@ -443,9 +512,10 @@ def disable_user(context, email): user.save(ignore_permissions=True) frappe.db.commit() -@click.command('migrate') -@click.option('--skip-failing', is_flag=True, help="Skip patches that fail to run") -@click.option('--skip-search-index', is_flag=True, help="Skip search indexing for web documents") + +@click.command("migrate") +@click.option("--skip-failing", is_flag=True, help="Skip patches that fail to run") +@click.option("--skip-search-index", is_flag=True, help="Skip search indexing for web documents") @pass_context def migrate(context, skip_failing=False, skip_search_index=False): "Run patches, sync schema and rebuild files/translations" @@ -463,12 +533,14 @@ def migrate(context, skip_failing=False, skip_search_index=False): if not context.sites: raise SiteNotSpecifiedError -@click.command('migrate-to') -@click.argument('frappe_provider') + +@click.command("migrate-to") +@click.argument("frappe_provider") @pass_context def migrate_to(context, frappe_provider): "Migrates site to the specified provider" from frappe.integrations.frappe_providers import migrate_to + for site in context.sites: frappe.init(site=site) frappe.connect() @@ -477,13 +549,15 @@ def migrate_to(context, frappe_provider): if not context.sites: raise SiteNotSpecifiedError -@click.command('run-patch') -@click.argument('module') -@click.option('--force', is_flag=True) + +@click.command("run-patch") +@click.argument("module") +@click.option("--force", is_flag=True) @pass_context def run_patch(context, module, force): "Run a particular patch" import frappe.modules.patch_handler + for site in context.sites: frappe.init(site=site) try: @@ -494,10 +568,11 @@ def run_patch(context, module, force): if not context.sites: raise SiteNotSpecifiedError -@click.command('reload-doc') -@click.argument('module') -@click.argument('doctype') -@click.argument('docname') + +@click.command("reload-doc") +@click.argument("module") +@click.argument("doctype") +@click.argument("docname") @pass_context def reload_doc(context, module, doctype, docname): "Reload schema for a DocType" @@ -512,8 +587,9 @@ def reload_doc(context, module, doctype, docname): if not context.sites: raise SiteNotSpecifiedError -@click.command('reload-doctype') -@click.argument('doctype') + +@click.command("reload-doctype") +@click.argument("doctype") @pass_context def reload_doctype(context, doctype): "Reload schema for a DocType" @@ -528,22 +604,25 @@ def reload_doctype(context, doctype): if not context.sites: raise SiteNotSpecifiedError -@click.command('add-to-hosts') + +@click.command("add-to-hosts") @pass_context def add_to_hosts(context): "Add site to hosts" for site in context.sites: - frappe.commands.popen('echo 127.0.0.1\t{0} | sudo tee -a /etc/hosts'.format(site)) + frappe.commands.popen("echo 127.0.0.1\t{0} | sudo tee -a /etc/hosts".format(site)) if not context.sites: raise SiteNotSpecifiedError -@click.command('use') -@click.argument('site') -def _use(site, sites_path='.'): + +@click.command("use") +@click.argument("site") +def _use(site, sites_path="."): "Set a default site" use(site, sites_path=sites_path) -def use(site, sites_path='.'): + +def use(site, sites_path="."): if os.path.exists(os.path.join(sites_path, site)): with open(os.path.join(sites_path, "currentsite.txt"), "w") as sitefile: sitefile.write(site) @@ -551,25 +630,55 @@ def use(site, sites_path='.'): else: print("Site {} does not exist".format(site)) -@click.command('backup') -@click.option('--with-files', default=False, is_flag=True, help="Take backup with files") -@click.option('--include', '--only', '-i', default="", type=str, help="Specify the DocTypes to backup seperated by commas") -@click.option('--exclude', '-e', default="", type=str, help="Specify the DocTypes to not backup seperated by commas") -@click.option('--backup-path', default=None, help="Set path for saving all the files in this operation") -@click.option('--backup-path-db', default=None, help="Set path for saving database file") -@click.option('--backup-path-files', default=None, help="Set path for saving public file") -@click.option('--backup-path-private-files', default=None, help="Set path for saving private file") -@click.option('--backup-path-conf', default=None, help="Set path for saving config file") -@click.option('--ignore-backup-conf', default=False, is_flag=True, help="Ignore excludes/includes set in config") -@click.option('--verbose', default=False, is_flag=True, help="Add verbosity") -@click.option('--compress', default=False, is_flag=True, help="Compress private and public files") + +@click.command("backup") +@click.option("--with-files", default=False, is_flag=True, help="Take backup with files") +@click.option( + "--include", + "--only", + "-i", + default="", + type=str, + help="Specify the DocTypes to backup seperated by commas", +) +@click.option( + "--exclude", + "-e", + default="", + type=str, + help="Specify the DocTypes to not backup seperated by commas", +) +@click.option( + "--backup-path", default=None, help="Set path for saving all the files in this operation" +) +@click.option("--backup-path-db", default=None, help="Set path for saving database file") +@click.option("--backup-path-files", default=None, help="Set path for saving public file") +@click.option("--backup-path-private-files", default=None, help="Set path for saving private file") +@click.option("--backup-path-conf", default=None, help="Set path for saving config file") +@click.option( + "--ignore-backup-conf", default=False, is_flag=True, help="Ignore excludes/includes set in config" +) +@click.option("--verbose", default=False, is_flag=True, help="Add verbosity") +@click.option("--compress", default=False, is_flag=True, help="Compress private and public files") @pass_context -def backup(context, with_files=False, backup_path=None, backup_path_db=None, backup_path_files=None, - backup_path_private_files=None, backup_path_conf=None, ignore_backup_conf=False, verbose=False, - compress=False, include="", exclude=""): +def backup( + context, + with_files=False, + backup_path=None, + backup_path_db=None, + backup_path_files=None, + backup_path_private_files=None, + backup_path_conf=None, + ignore_backup_conf=False, + verbose=False, + compress=False, + include="", + exclude="", +): "Backup" from frappe.utils.backups import scheduled_backup + verbose = verbose or context.verbose exit_code = 0 @@ -589,12 +698,12 @@ def backup(context, with_files=False, backup_path=None, backup_path_db=None, bac exclude_doctypes=exclude, compress=compress, verbose=verbose, - force=True + force=True, ) except Exception: click.secho( "Backup failed for Site {0}. Database or site_config.json may be corrupted".format(site), - fg="red" + fg="red", ) if verbose: print(frappe.get_traceback()) @@ -602,14 +711,15 @@ def backup(context, with_files=False, backup_path=None, backup_path_db=None, bac continue if frappe.get_system_settings("encrypt_backup") and frappe.get_site_config().encryption_key: click.secho( - "Backup encryption is turned on. Please note the backup encryption key.", - fg="yellow" + "Backup encryption is turned on. Please note the backup encryption key.", fg="yellow" ) odb.print_summary() click.secho( - "Backup for Site {0} has been successfully completed{1}".format(site, " with files" if with_files else ""), - fg="green" + "Backup for Site {0} has been successfully completed{1}".format( + site, " with files" if with_files else "" + ), + fg="green", ) frappe.destroy() @@ -619,12 +729,13 @@ def backup(context, with_files=False, backup_path=None, backup_path_db=None, bac sys.exit(exit_code) -@click.command('remove-from-installed-apps') -@click.argument('app') +@click.command("remove-from-installed-apps") +@click.argument("app") @pass_context def remove_from_installed_apps(context, app): "Remove app from site's installed-apps list" from frappe.installer import remove_from_installed_apps + for site in context.sites: try: frappe.init(site=site) @@ -635,16 +746,26 @@ def remove_from_installed_apps(context, app): if not context.sites: raise SiteNotSpecifiedError -@click.command('uninstall-app') -@click.argument('app') -@click.option('--yes', '-y', help='To bypass confirmation prompt for uninstalling the app', is_flag=True, default=False) -@click.option('--dry-run', help='List all doctypes that will be deleted', is_flag=True, default=False) -@click.option('--no-backup', help='Do not backup the site', is_flag=True, default=False) -@click.option('--force', help='Force remove app from site', is_flag=True, default=False) + +@click.command("uninstall-app") +@click.argument("app") +@click.option( + "--yes", + "-y", + help="To bypass confirmation prompt for uninstalling the app", + is_flag=True, + default=False, +) +@click.option( + "--dry-run", help="List all doctypes that will be deleted", is_flag=True, default=False +) +@click.option("--no-backup", help="Do not backup the site", is_flag=True, default=False) +@click.option("--force", help="Force remove app from site", is_flag=True, default=False) @pass_context def uninstall(context, app, dry_run, yes, no_backup, force): "Remove app and linked modules from site" from frappe.installer import remove_app + for site in context.sites: try: frappe.init(site=site) @@ -656,18 +777,44 @@ def uninstall(context, app, dry_run, yes, no_backup, force): raise SiteNotSpecifiedError -@click.command('drop-site') -@click.argument('site') -@click.option('--db-root-username', '--mariadb-root-username', '--root-login', help='Root username for MariaDB or PostgreSQL, Default is "root"') -@click.option('--db-root-password', '--mariadb-root-password', '--root-password', help='Root password for MariaDB or PostgreSQL') -@click.option('--archived-sites-path') -@click.option('--no-backup', is_flag=True, default=False) -@click.option('--force', help='Force drop-site even if an error is encountered', is_flag=True, default=False) -def drop_site(site, db_root_username='root', db_root_password=None, archived_sites_path=None, force=False, no_backup=False): +@click.command("drop-site") +@click.argument("site") +@click.option( + "--db-root-username", + "--mariadb-root-username", + "--root-login", + help='Root username for MariaDB or PostgreSQL, Default is "root"', +) +@click.option( + "--db-root-password", + "--mariadb-root-password", + "--root-password", + help="Root password for MariaDB or PostgreSQL", +) +@click.option("--archived-sites-path") +@click.option("--no-backup", is_flag=True, default=False) +@click.option( + "--force", help="Force drop-site even if an error is encountered", is_flag=True, default=False +) +def drop_site( + site, + db_root_username="root", + db_root_password=None, + archived_sites_path=None, + force=False, + no_backup=False, +): _drop_site(site, db_root_username, db_root_password, archived_sites_path, force, no_backup) -def _drop_site(site, db_root_username=None, db_root_password=None, archived_sites_path=None, force=False, no_backup=False): +def _drop_site( + site, + db_root_username=None, + db_root_password=None, + archived_sites_path=None, + force=False, + no_backup=False, +): "Remove site from database and filesystem" from frappe.database import drop_user_and_database from frappe.utils.backups import scheduled_backup @@ -689,7 +836,7 @@ def _drop_site(site, db_root_username=None, db_root_password=None, archived_site "Error: The operation has stopped because backup of {0}'s database failed.".format(site), "Reason: {0}\n".format(str(err)), "Fix the issue and try again.", - "Hint: Use 'bench drop-site {0} --force' to force the removal of {0}".format(site) + "Hint: Use 'bench drop-site {0} --force' to force the removal of {0}".format(site), ] click.echo("\n".join(messages)) sys.exit(1) @@ -697,7 +844,9 @@ def _drop_site(site, db_root_username=None, db_root_password=None, archived_site click.secho("Dropping site database and user", fg="green") drop_user_and_database(frappe.conf.db_name, db_root_username, db_root_password) - archived_sites_path = archived_sites_path or os.path.join(frappe.get_app_path('frappe'), '..', '..', '..', 'archived', 'sites') + archived_sites_path = archived_sites_path or os.path.join( + frappe.get_app_path("frappe"), "..", "..", "..", "archived", "sites" + ) os.makedirs(archived_sites_path, exist_ok=True) @@ -725,10 +874,12 @@ def move(dest_dir, site): return final_new_path -@click.command('set-password') -@click.argument('user') -@click.argument('password', required=False) -@click.option('--logout-all-sessions', help='Log out from all sessions', is_flag=True, default=False) +@click.command("set-password") +@click.argument("user") +@click.argument("password", required=False) +@click.option( + "--logout-all-sessions", help="Log out from all sessions", is_flag=True, default=False +) @pass_context def set_password(context, user, password=None, logout_all_sessions=False): "Set password for a user on a site" @@ -739,9 +890,11 @@ def set_password(context, user, password=None, logout_all_sessions=False): set_user_password(site, user, password, logout_all_sessions) -@click.command('set-admin-password') -@click.argument('admin-password', required=False) -@click.option('--logout-all-sessions', help='Log out from all sessions', is_flag=True, default=False) +@click.command("set-admin-password") +@click.argument("admin-password", required=False) +@click.option( + "--logout-all-sessions", help="Log out from all sessions", is_flag=True, default=False +) @pass_context def set_admin_password(context, admin_password=None, logout_all_sessions=False): "Set Administrator password for a site" @@ -775,8 +928,8 @@ def set_user_password(site, user, password, logout_all_sessions=False): frappe.destroy() -@click.command('set-last-active-for-user') -@click.option('--user', help="Setup last active date for user") +@click.command("set-last-active-for-user") +@click.option("--user", help="Setup last active date for user") @pass_context def set_last_active_for_user(context, user=None): "Set users last active date to current datetime" @@ -798,36 +951,45 @@ def set_last_active_for_user(context, user=None): frappe.db.commit() -@click.command('publish-realtime') -@click.argument('event') -@click.option('--message') -@click.option('--room') -@click.option('--user') -@click.option('--doctype') -@click.option('--docname') -@click.option('--after-commit') +@click.command("publish-realtime") +@click.argument("event") +@click.option("--message") +@click.option("--room") +@click.option("--user") +@click.option("--doctype") +@click.option("--docname") +@click.option("--after-commit") @pass_context def publish_realtime(context, event, message, room, user, doctype, docname, after_commit): "Publish realtime event from bench" from frappe import publish_realtime + for site in context.sites: try: frappe.init(site=site) frappe.connect() - publish_realtime(event, message=message, room=room, user=user, doctype=doctype, docname=docname, - after_commit=after_commit) + publish_realtime( + event, + message=message, + room=room, + user=user, + doctype=doctype, + docname=docname, + after_commit=after_commit, + ) frappe.db.commit() finally: frappe.destroy() if not context.sites: raise SiteNotSpecifiedError -@click.command('browse') -@click.argument('site', required=False) -@click.option('--user', required=False, help='Login as user') + +@click.command("browse") +@click.argument("site", required=False) +@click.option("--user", required=False, help="Login as user") @pass_context def browse(context, site, user=None): - '''Opens the site on web browser''' + """Opens the site on web browser""" from frappe.auth import CookieManager, LoginManager site = get_site(context, raise_err=False) or site @@ -842,29 +1004,30 @@ def browse(context, site, user=None): frappe.init(site=site) frappe.connect() - sid = '' + sid = "" if user: if frappe.conf.developer_mode or user == "Administrator": frappe.utils.set_request(path="/") frappe.local.cookie_manager = CookieManager() frappe.local.login_manager = LoginManager() frappe.local.login_manager.login_as(user) - sid = f'/app?sid={frappe.session.sid}' + sid = f"/app?sid={frappe.session.sid}" else: click.echo("Please enable developer mode to login as a user") - url = f'{frappe.utils.get_site_url(site)}{sid}' + url = f"{frappe.utils.get_site_url(site)}{sid}" if user == "Administrator": - click.echo(f'Login URL: {url}') + click.echo(f"Login URL: {url}") click.launch(url) -@click.command('start-recording') +@click.command("start-recording") @pass_context def start_recording(context): import frappe.recorder + for site in context.sites: frappe.init(site=site) frappe.set_user("Administrator") @@ -873,10 +1036,11 @@ def start_recording(context): raise SiteNotSpecifiedError -@click.command('stop-recording') +@click.command("stop-recording") @pass_context def stop_recording(context): import frappe.recorder + for site in context.sites: frappe.init(site=site) frappe.set_user("Administrator") @@ -884,8 +1048,11 @@ def stop_recording(context): if not context.sites: raise SiteNotSpecifiedError -@click.command('ngrok') -@click.option('--bind-tls', is_flag=True, default=False, help='Returns a reference to the https tunnel.') + +@click.command("ngrok") +@click.option( + "--bind-tls", is_flag=True, default=False, help="Returns a reference to the https tunnel." +) @pass_context def start_ngrok(context, bind_tls): from pyngrok import ngrok @@ -895,8 +1062,8 @@ def start_ngrok(context, bind_tls): port = frappe.conf.http_port or frappe.conf.webserver_port tunnel = ngrok.connect(addr=str(port), host_header=site, bind_tls=bind_tls) - print(f'Public URL: {tunnel.public_url}') - print('Inspect logs at http://localhost:4040') + print(f"Public URL: {tunnel.public_url}") + print("Inspect logs at http://localhost:4040") ngrok_process = ngrok.get_ngrok_process() try: @@ -907,15 +1074,17 @@ def start_ngrok(context, bind_tls): frappe.destroy() ngrok.kill() -@click.command('build-search-index') + +@click.command("build-search-index") @pass_context def build_search_index(context): from frappe.search.website_search import build_index_for_all_routes + site = get_site(context) if not site: raise SiteNotSpecifiedError - print('Building search index for {}'.format(site)) + print("Building search index for {}".format(site)) frappe.init(site=site) frappe.connect() try: @@ -923,10 +1092,13 @@ def build_search_index(context): finally: frappe.destroy() -@click.command('trim-database') -@click.option('--dry-run', is_flag=True, default=False, help='Show what would be deleted') -@click.option('--format', '-f', default='text', type=click.Choice(['json', 'text']), help='Output format') -@click.option('--no-backup', is_flag=True, default=False, help='Do not backup the site') + +@click.command("trim-database") +@click.option("--dry-run", is_flag=True, default=False, help="Show what would be deleted") +@click.option( + "--format", "-f", default="text", type=click.Choice(["json", "text"]), help="Output format" +) +@click.option("--no-backup", is_flag=True, default=False, help="Do not backup the site") @pass_context def trim_database(context, dry_run, format, no_backup): if not context.sites: @@ -945,11 +1117,12 @@ def trim_database(context, dry_run, format, no_backup): information_schema = frappe.qb.Schema("information_schema") table_name = frappe.qb.Field("table_name").as_("name") - queried_result = frappe.qb.from_( - information_schema.tables - ).select(table_name).where( - information_schema.tables.table_schema == frappe.conf.db_name - ).run() + queried_result = ( + frappe.qb.from_(information_schema.tables) + .select(table_name) + .where(information_schema.tables.table_schema == frappe.conf.db_name) + .run() + ) database_tables = [x[0] for x in queried_result] doctype_tables = frappe.get_all("DocType", pluck="name") @@ -988,6 +1161,7 @@ def trim_database(context, dry_run, format, no_backup): if format == "json": import json + print(json.dumps(ALL_DATA, indent=1)) @@ -996,7 +1170,13 @@ def get_standard_tables(): tables = [] sql_file = os.path.join( - "..", "apps", "frappe", "frappe", "database", frappe.conf.db_type, f'framework_{frappe.conf.db_type}.sql' + "..", + "apps", + "frappe", + "frappe", + "database", + frappe.conf.db_type, + f"framework_{frappe.conf.db_type}.sql", ) content = open(sql_file).read().splitlines() @@ -1007,10 +1187,13 @@ def get_standard_tables(): return tables -@click.command('trim-tables') -@click.option('--dry-run', is_flag=True, default=False, help='Show what would be deleted') -@click.option('--format', '-f', default='table', type=click.Choice(['json', 'table']), help='Output format') -@click.option('--no-backup', is_flag=True, default=False, help='Do not backup the site') + +@click.command("trim-tables") +@click.option("--dry-run", is_flag=True, default=False, help="Show what would be deleted") +@click.option( + "--format", "-f", default="table", type=click.Choice(["json", "table"]), help="Output format" +) +@click.option("--no-backup", is_flag=True, default=False, help="Do not backup the site") @pass_context def trim_tables(context, dry_run, format, no_backup): if not context.sites: @@ -1029,21 +1212,24 @@ def trim_tables(context, dry_run, format, no_backup): odb.print_summary() try: - trimmed_data = trim_tables(dry_run=dry_run, quiet=format == 'json') + trimmed_data = trim_tables(dry_run=dry_run, quiet=format == "json") - if format == 'table' and not dry_run: - click.secho(f"The following data have been removed from {frappe.local.site}", fg='green') + if format == "table" and not dry_run: + click.secho(f"The following data have been removed from {frappe.local.site}", fg="green") handle_data(trimmed_data, format=format) finally: frappe.destroy() -def handle_data(data: dict, format='json'): - if format == 'json': + +def handle_data(data: dict, format="json"): + if format == "json": import json + print(json.dumps({frappe.local.site: data}, indent=1, sort_keys=True)) else: from frappe.utils.commands import render_table + data = [["DocType", "Fields"]] + [[table, ", ".join(columns)] for table, columns in data.items()] render_table(data) diff --git a/frappe/commands/translate.py b/frappe/commands/translate.py index 68d210eaaa..0b14e03002 100644 --- a/frappe/commands/translate.py +++ b/frappe/commands/translate.py @@ -1,13 +1,16 @@ import click -from frappe.commands import pass_context, get_site + +from frappe.commands import get_site, pass_context from frappe.exceptions import SiteNotSpecifiedError + # translation -@click.command('build-message-files') +@click.command("build-message-files") @pass_context def build_message_files(context): "Build message files for translation" import frappe.translate + for site in context.sites: try: frappe.init(site=site) @@ -18,32 +21,41 @@ def build_message_files(context): if not context.sites: raise SiteNotSpecifiedError -@click.command('new-language') #, help="Create lang-code.csv for given app") + +@click.command("new-language") # , help="Create lang-code.csv for given app") @pass_context -@click.argument('lang_code') #, help="Language code eg. en") -@click.argument('app') #, help="App name eg. frappe") +@click.argument("lang_code") # , help="Language code eg. en") +@click.argument("app") # , help="App name eg. frappe") def new_language(context, lang_code, app): """Create lang-code.csv for given app""" import frappe.translate - if not context['sites']: - raise Exception('--site is required') + if not context["sites"]: + raise Exception("--site is required") # init site - frappe.connect(site=context['sites'][0]) + frappe.connect(site=context["sites"][0]) frappe.translate.write_translations_file(app, lang_code) - print("File created at ./apps/{app}/{app}/translations/{lang_code}.csv".format(app=app, lang_code=lang_code)) - print("You will need to add the language in frappe/geo/languages.json, if you haven't done it already.") + print( + "File created at ./apps/{app}/{app}/translations/{lang_code}.csv".format( + app=app, lang_code=lang_code + ) + ) + print( + "You will need to add the language in frappe/geo/languages.json, if you haven't done it already." + ) + -@click.command('get-untranslated') -@click.argument('lang') -@click.argument('untranslated_file') -@click.option('--all', default=False, is_flag=True, help='Get all message strings') +@click.command("get-untranslated") +@click.argument("lang") +@click.argument("untranslated_file") +@click.option("--all", default=False, is_flag=True, help="Get all message strings") @pass_context def get_untranslated(context, lang, untranslated_file, all=None): "Get untranslated strings for language" import frappe.translate + site = get_site(context) try: frappe.init(site=site) @@ -52,14 +64,16 @@ def get_untranslated(context, lang, untranslated_file, all=None): finally: frappe.destroy() -@click.command('update-translations') -@click.argument('lang') -@click.argument('untranslated_file') -@click.argument('translated-file') + +@click.command("update-translations") +@click.argument("lang") +@click.argument("untranslated_file") +@click.argument("translated-file") @pass_context def update_translations(context, lang, untranslated_file, translated_file): "Update translated strings" import frappe.translate + site = get_site(context) try: frappe.init(site=site) @@ -68,13 +82,15 @@ def update_translations(context, lang, untranslated_file, translated_file): finally: frappe.destroy() -@click.command('import-translations') -@click.argument('lang') -@click.argument('path') + +@click.command("import-translations") +@click.argument("lang") +@click.argument("path") @pass_context def import_translations(context, lang, path): "Update translated strings" import frappe.translate + site = get_site(context) try: frappe.init(site=site) @@ -83,6 +99,7 @@ def import_translations(context, lang, path): finally: frappe.destroy() + commands = [ build_message_files, get_untranslated, diff --git a/frappe/commands/utils.py b/frappe/commands/utils.py index c0bb44efab..2e27b8d6fe 100644 --- a/frappe/commands/utils.py +++ b/frappe/commands/utils.py @@ -8,9 +8,9 @@ import click import frappe from frappe.commands import get_site, pass_context -from frappe.exceptions import SiteNotSpecifiedError -from frappe.utils import update_progress_bar, cint from frappe.coverage import CodeCoverage +from frappe.exceptions import SiteNotSpecifiedError +from frappe.utils import cint, update_progress_bar DATA_IMPORT_DEPRECATION = ( "[DEPRECATED] The `import-csv` command used 'Data Import Legacy' which has been deprecated.\n" @@ -18,25 +18,49 @@ DATA_IMPORT_DEPRECATION = ( ) -@click.command('build') -@click.option('--app', help='Build assets for app') -@click.option('--apps', help='Build assets for specific apps') -@click.option('--hard-link', is_flag=True, default=False, help='Copy the files instead of symlinking') -@click.option('--make-copy', is_flag=True, default=False, help='[DEPRECATED] Copy the files instead of symlinking') -@click.option('--restore', is_flag=True, default=False, help='[DEPRECATED] Copy the files instead of symlinking with force') -@click.option('--production', is_flag=True, default=False, help='Build assets in production mode') -@click.option('--verbose', is_flag=True, default=False, help='Verbose') -@click.option('--force', is_flag=True, default=False, help='Force build assets instead of downloading available') -def build(app=None, apps=None, hard_link=False, make_copy=False, restore=False, production=False, verbose=False, force=False): +@click.command("build") +@click.option("--app", help="Build assets for app") +@click.option("--apps", help="Build assets for specific apps") +@click.option( + "--hard-link", is_flag=True, default=False, help="Copy the files instead of symlinking" +) +@click.option( + "--make-copy", + is_flag=True, + default=False, + help="[DEPRECATED] Copy the files instead of symlinking", +) +@click.option( + "--restore", + is_flag=True, + default=False, + help="[DEPRECATED] Copy the files instead of symlinking with force", +) +@click.option("--production", is_flag=True, default=False, help="Build assets in production mode") +@click.option("--verbose", is_flag=True, default=False, help="Verbose") +@click.option( + "--force", is_flag=True, default=False, help="Force build assets instead of downloading available" +) +def build( + app=None, + apps=None, + hard_link=False, + make_copy=False, + restore=False, + production=False, + verbose=False, + force=False, +): "Compile JS and CSS source files" from frappe.build import bundle, download_frappe_assets - frappe.init('') + + frappe.init("") if not apps and app: apps = app # dont try downloading assets if force used, app specified or running via CI - if not (force or apps or os.environ.get('CI')): + if not (force or apps or os.environ.get("CI")): # skip building frappe if assets exist remotely skip_frappe = download_frappe_assets(verbose=verbose) else: @@ -58,23 +82,24 @@ def build(app=None, apps=None, hard_link=False, make_copy=False, restore=False, bundle(mode, apps=apps, hard_link=hard_link, verbose=verbose, skip_frappe=skip_frappe) - -@click.command('watch') -@click.option('--apps', help='Watch assets for specific apps') +@click.command("watch") +@click.option("--apps", help="Watch assets for specific apps") def watch(apps=None): "Watch and compile JS and CSS files as and when they change" from frappe.build import watch - frappe.init('') + + frappe.init("") watch(apps) -@click.command('clear-cache') +@click.command("clear-cache") @pass_context def clear_cache(context): "Clear cache, doctype cache and defaults" import frappe.sessions - from frappe.website.utils import clear_website_cache from frappe.desk.notifications import clear_notifications + from frappe.website.utils import clear_website_cache + for site in context.sites: try: frappe.connect(site) @@ -86,11 +111,13 @@ def clear_cache(context): if not context.sites: raise SiteNotSpecifiedError -@click.command('clear-website-cache') + +@click.command("clear-website-cache") @pass_context def clear_website_cache(context): "Clear website cache" from frappe.website.utils import clear_website_cache + for site in context.sites: try: frappe.init(site=site) @@ -101,12 +128,14 @@ def clear_website_cache(context): if not context.sites: raise SiteNotSpecifiedError -@click.command('destroy-all-sessions') -@click.option('--reason') + +@click.command("destroy-all-sessions") +@click.option("--reason") @pass_context def destroy_all_sessions(context, reason=None): "Clear sessions of all users (logs them out)" import frappe.sessions + for site in context.sites: try: frappe.init(site=site) @@ -118,7 +147,8 @@ def destroy_all_sessions(context, reason=None): if not context.sites: raise SiteNotSpecifiedError -@click.command('show-config') + +@click.command("show-config") @click.option("--format", "-f", type=click.Choice(["text", "json"]), default="text") @pass_context def show_config(context, format): @@ -157,7 +187,7 @@ def show_config(context, format): if format == "text": data = transform_config(configuration) - data.insert(0, ['Config','Value']) + data.insert(0, ["Config", "Value"]) render_table(data) if format == "json": @@ -169,29 +199,33 @@ def show_config(context, format): click.echo(frappe.as_json(sites_config)) -@click.command('reset-perms') +@click.command("reset-perms") @pass_context def reset_perms(context): "Reset permissions for all doctypes" from frappe.permissions import reset_perms + for site in context.sites: try: frappe.init(site=site) frappe.connect() - for d in frappe.db.sql_list("""select name from `tabDocType` - where istable=0 and custom=0"""): - frappe.clear_cache(doctype=d) - reset_perms(d) + for d in frappe.db.sql_list( + """select name from `tabDocType` + where istable=0 and custom=0""" + ): + frappe.clear_cache(doctype=d) + reset_perms(d) finally: frappe.destroy() if not context.sites: raise SiteNotSpecifiedError -@click.command('execute') -@click.argument('method') -@click.option('--args') -@click.option('--kwargs') -@click.option('--profile', is_flag=True, default=False) + +@click.command("execute") +@click.argument("method") +@click.option("--args") +@click.option("--kwargs") +@click.option("--profile", is_flag=True, default=False) @pass_context def execute(context, method, args=None, kwargs=None, profile=False): "Execute a function" @@ -216,13 +250,16 @@ def execute(context, method, args=None, kwargs=None, profile=False): if profile: import cProfile + pr = cProfile.Profile() pr.enable() try: ret = frappe.get_attr(method)(*args, **kwargs) except Exception: - ret = frappe.safe_eval(method + "(*args, **kwargs)", eval_globals=globals(), eval_locals=locals()) + ret = frappe.safe_eval( + method + "(*args, **kwargs)", eval_globals=globals(), eval_locals=locals() + ) if profile: import pstats @@ -230,7 +267,7 @@ def execute(context, method, args=None, kwargs=None, profile=False): pr.disable() s = StringIO() - pstats.Stats(pr, stream=s).sort_stats('cumulative').print_stats(.5) + pstats.Stats(pr, stream=s).sort_stats("cumulative").print_stats(0.5) print(s.getvalue()) if frappe.db: @@ -239,14 +276,15 @@ def execute(context, method, args=None, kwargs=None, profile=False): frappe.destroy() if ret: from frappe.utils.response import json_handler + print(json.dumps(ret, default=json_handler)) if not context.sites: raise SiteNotSpecifiedError -@click.command('add-to-email-queue') -@click.argument('email-path') +@click.command("add-to-email-queue") +@click.argument("email-path") @pass_context def add_to_email_queue(context, email_path): "Add an email to the Email Queue" @@ -258,18 +296,19 @@ def add_to_email_queue(context, email_path): for email in os.listdir(email_path): with open(os.path.join(email_path, email)) as email_data: kwargs = json.load(email_data) - kwargs['delayed'] = True + kwargs["delayed"] = True frappe.sendmail(**kwargs) frappe.db.commit() -@click.command('export-doc') -@click.argument('doctype') -@click.argument('docname') +@click.command("export-doc") +@click.argument("doctype") +@click.argument("docname") @pass_context def export_doc(context, doctype, docname): "Export a single document to csv" import frappe.modules + for site in context.sites: try: frappe.init(site=site) @@ -280,14 +319,16 @@ def export_doc(context, doctype, docname): if not context.sites: raise SiteNotSpecifiedError -@click.command('export-json') -@click.argument('doctype') -@click.argument('path') -@click.option('--name', help='Export only one document') + +@click.command("export-json") +@click.argument("doctype") +@click.argument("path") +@click.option("--name", help="Export only one document") @pass_context def export_json(context, doctype, path, name=None): "Export doclist as json to the given path, use '-' as name for Singles." from frappe.core.doctype.data_import.data_import import export_json + for site in context.sites: try: frappe.init(site=site) @@ -298,13 +339,15 @@ def export_json(context, doctype, path, name=None): if not context.sites: raise SiteNotSpecifiedError -@click.command('export-csv') -@click.argument('doctype') -@click.argument('path') + +@click.command("export-csv") +@click.argument("doctype") +@click.argument("path") @pass_context def export_csv(context, doctype, path): "Export data import template with data for DocType" from frappe.core.doctype.data_import.data_import import export_csv + for site in context.sites: try: frappe.init(site=site) @@ -315,12 +358,14 @@ def export_csv(context, doctype, path): if not context.sites: raise SiteNotSpecifiedError -@click.command('export-fixtures') -@click.option('--app', default=None, help='Export fixtures of a specific app') + +@click.command("export-fixtures") +@click.option("--app", default=None, help="Export fixtures of a specific app") @pass_context def export_fixtures(context, app=None): "Export fixtures" from frappe.utils.fixtures import export_fixtures + for site in context.sites: try: frappe.init(site=site) @@ -331,17 +376,18 @@ def export_fixtures(context, app=None): if not context.sites: raise SiteNotSpecifiedError -@click.command('import-doc') -@click.argument('path') + +@click.command("import-doc") +@click.argument("path") @pass_context def import_doc(context, path, force=False): "Import (insert/update) doclist. If the argument is a directory, all files ending with .json are imported" from frappe.core.doctype.data_import.data_import import import_doc if not os.path.exists(path): - path = os.path.join('..', path) + path = os.path.join("..", path) if not os.path.exists(path): - print('Invalid path {0}'.format(path)) + print("Invalid path {0}".format(path)) sys.exit(1) for site in context.sites: @@ -355,28 +401,57 @@ def import_doc(context, path, force=False): raise SiteNotSpecifiedError -@click.command('import-csv', help=DATA_IMPORT_DEPRECATION) -@click.argument('path') -@click.option('--only-insert', default=False, is_flag=True, help='Do not overwrite existing records') -@click.option('--submit-after-import', default=False, is_flag=True, help='Submit document after importing it') -@click.option('--ignore-encoding-errors', default=False, is_flag=True, help='Ignore encoding errors while coverting to unicode') -@click.option('--no-email', default=True, is_flag=True, help='Send email if applicable') +@click.command("import-csv", help=DATA_IMPORT_DEPRECATION) +@click.argument("path") +@click.option( + "--only-insert", default=False, is_flag=True, help="Do not overwrite existing records" +) +@click.option( + "--submit-after-import", default=False, is_flag=True, help="Submit document after importing it" +) +@click.option( + "--ignore-encoding-errors", + default=False, + is_flag=True, + help="Ignore encoding errors while coverting to unicode", +) +@click.option("--no-email", default=True, is_flag=True, help="Send email if applicable") @pass_context -def import_csv(context, path, only_insert=False, submit_after_import=False, ignore_encoding_errors=False, no_email=True): +def import_csv( + context, + path, + only_insert=False, + submit_after_import=False, + ignore_encoding_errors=False, + no_email=True, +): click.secho(DATA_IMPORT_DEPRECATION, fg="yellow") sys.exit(1) -@click.command('data-import') -@click.option('--file', 'file_path', type=click.Path(), required=True, help="Path to import file (.csv, .xlsx)") -@click.option('--doctype', type=str, required=True) -@click.option('--type', 'import_type', type=click.Choice(['Insert', 'Update'], case_sensitive=False), default='Insert', help="Insert New Records or Update Existing Records") -@click.option('--submit-after-import', default=False, is_flag=True, help='Submit document after importing it') -@click.option('--mute-emails', default=True, is_flag=True, help='Mute emails during import') +@click.command("data-import") +@click.option( + "--file", "file_path", type=click.Path(), required=True, help="Path to import file (.csv, .xlsx)" +) +@click.option("--doctype", type=str, required=True) +@click.option( + "--type", + "import_type", + type=click.Choice(["Insert", "Update"], case_sensitive=False), + default="Insert", + help="Insert New Records or Update Existing Records", +) +@click.option( + "--submit-after-import", default=False, is_flag=True, help="Submit document after importing it" +) +@click.option("--mute-emails", default=True, is_flag=True, help="Mute emails during import") @pass_context -def data_import(context, file_path, doctype, import_type=None, submit_after_import=False, mute_emails=True): +def data_import( + context, file_path, doctype, import_type=None, submit_after_import=False, mute_emails=True +): "Import documents in bulk from CSV or XLSX using data import" from frappe.core.doctype.data_import.data_import import import_file + site = get_site(context) frappe.init(site=site) @@ -385,9 +460,9 @@ def data_import(context, file_path, doctype, import_type=None, submit_after_impo frappe.destroy() -@click.command('bulk-rename') -@click.argument('doctype') -@click.argument('path') +@click.command("bulk-rename") +@click.argument("doctype") +@click.argument("path") @pass_context def bulk_rename(context, doctype, path): "Rename multiple records via CSV file" @@ -396,22 +471,22 @@ def bulk_rename(context, doctype, path): site = get_site(context) - with open(path, 'r') as csvfile: + with open(path, "r") as csvfile: rows = read_csv_content(csvfile.read()) frappe.init(site=site) frappe.connect() - bulk_rename(doctype, rows, via_console = True) + bulk_rename(doctype, rows, via_console=True) frappe.destroy() -@click.command('db-console') +@click.command("db-console") @pass_context def database(context): """ - Enter into the Database console for given site. + Enter into the Database console for given site. """ site = get_site(context) if not site: @@ -423,69 +498,79 @@ def database(context): _psql() -@click.command('mariadb') +@click.command("mariadb") @pass_context def mariadb(context): """ - Enter into mariadb console for a given site. + Enter into mariadb console for a given site. """ - site = get_site(context) + site = get_site(context) if not site: raise SiteNotSpecifiedError frappe.init(site=site) _mariadb() -@click.command('postgres') +@click.command("postgres") @pass_context def postgres(context): """ - Enter into postgres console for a given site. + Enter into postgres console for a given site. """ - site = get_site(context) + site = get_site(context) frappe.init(site=site) _psql() def _mariadb(): - mysql = find_executable('mysql') - os.execv(mysql, [ + mysql = find_executable("mysql") + os.execv( mysql, - '-u', frappe.conf.db_name, - '-p'+frappe.conf.db_password, - frappe.conf.db_name, - '-h', frappe.conf.db_host or "localhost", - '--pager=less -SFX', - '--safe-updates', - "-A"]) + [ + mysql, + "-u", + frappe.conf.db_name, + "-p" + frappe.conf.db_password, + frappe.conf.db_name, + "-h", + frappe.conf.db_host or "localhost", + "--pager=less -SFX", + "--safe-updates", + "-A", + ], + ) def _psql(): - psql = find_executable('psql') - subprocess.run([ psql, '-d', frappe.conf.db_name]) + psql = find_executable("psql") + subprocess.run([psql, "-d", frappe.conf.db_name]) -@click.command('jupyter') +@click.command("jupyter") @pass_context def jupyter(context): - installed_packages = (r.split('==')[0] for r in subprocess.check_output([sys.executable, '-m', 'pip', 'freeze'], encoding='utf8')) + installed_packages = ( + r.split("==")[0] + for r in subprocess.check_output([sys.executable, "-m", "pip", "freeze"], encoding="utf8") + ) - if 'jupyter' not in installed_packages: - subprocess.check_output([sys.executable, '-m', 'pip', 'install', 'jupyter']) + if "jupyter" not in installed_packages: + subprocess.check_output([sys.executable, "-m", "pip", "install", "jupyter"]) site = get_site(context) frappe.init(site=site) - jupyter_notebooks_path = os.path.abspath(frappe.get_site_path('jupyter_notebooks')) - sites_path = os.path.abspath(frappe.get_site_path('..')) + jupyter_notebooks_path = os.path.abspath(frappe.get_site_path("jupyter_notebooks")) + sites_path = os.path.abspath(frappe.get_site_path("..")) try: os.stat(jupyter_notebooks_path) except OSError: - print('Creating folder to keep jupyter notebooks at {}'.format(jupyter_notebooks_path)) + print("Creating folder to keep jupyter notebooks at {}".format(jupyter_notebooks_path)) os.mkdir(jupyter_notebooks_path) - bin_path = os.path.abspath('../env/bin') - print(''' + bin_path = os.path.abspath("../env/bin") + print( + """ Starting Jupyter notebook Run the following in your first cell to connect notebook to frappe ``` @@ -495,12 +580,18 @@ frappe.connect() frappe.local.lang = frappe.db.get_default('lang') frappe.db.connect() ``` - '''.format(site=site, sites_path=sites_path)) - os.execv('{0}/jupyter'.format(bin_path), [ - '{0}/jupyter'.format(bin_path), - 'notebook', - jupyter_notebooks_path, - ]) + """.format( + site=site, sites_path=sites_path + ) + ) + os.execv( + "{0}/jupyter".format(bin_path), + [ + "{0}/jupyter".format(bin_path), + "notebook", + jupyter_notebooks_path, + ], + ) def _console_cleanup(): @@ -509,12 +600,8 @@ def _console_cleanup(): frappe.destroy() -@click.command('console') -@click.option( - '--autoreload', - is_flag=True, - help="Reload changes to code automatically" -) +@click.command("console") +@click.option("--autoreload", is_flag=True, help="Reload changes to code automatically") @pass_context def console(context, autoreload=False): "Start ipython console for a site" @@ -523,9 +610,10 @@ def console(context, autoreload=False): frappe.connect() frappe.local.lang = frappe.db.get_default("lang") - from IPython.terminal.embed import InteractiveShellEmbed from atexit import register + from IPython.terminal.embed import InteractiveShellEmbed + register(_console_cleanup) terminal = InteractiveShellEmbed() @@ -552,11 +640,27 @@ def console(context, autoreload=False): terminal() -@click.command('transform-database', help="Change tables' internal settings changing engine and row formats") -@click.option('--table', required=True, help="Comma separated name of tables to convert. To convert all tables, pass 'all'") -@click.option('--engine', default=None, type=click.Choice(["InnoDB", "MyISAM"]), help="Choice of storage engine for said table(s)") -@click.option('--row_format', default=None, type=click.Choice(["DYNAMIC", "COMPACT", "REDUNDANT", "COMPRESSED"]), help="Set ROW_FORMAT parameter for said table(s)") -@click.option('--failfast', is_flag=True, default=False, help="Exit on first failure occurred") +@click.command( + "transform-database", help="Change tables' internal settings changing engine and row formats" +) +@click.option( + "--table", + required=True, + help="Comma separated name of tables to convert. To convert all tables, pass 'all'", +) +@click.option( + "--engine", + default=None, + type=click.Choice(["InnoDB", "MyISAM"]), + help="Choice of storage engine for said table(s)", +) +@click.option( + "--row_format", + default=None, + type=click.Choice(["DYNAMIC", "COMPACT", "REDUNDANT", "COMPRESSED"]), + help="Set ROW_FORMAT parameter for said table(s)", +) +@click.option("--failfast", is_flag=True, default=False, help="Exit on first failure occurred") @pass_context def transform_database(context, table, engine, row_format, failfast): "Transform site database through given parameters" @@ -578,12 +682,15 @@ def transform_database(context, table, engine, row_format, failfast): if table == "all": information_schema = frappe.qb.Schema("information_schema") - queried_tables = frappe.qb.from_( - information_schema.tables - ).select("table_name").where( - (information_schema.tables.row_format != row_format) - & (information_schema.tables.table_schema == frappe.conf.db_name) - ).run() + queried_tables = ( + frappe.qb.from_(information_schema.tables) + .select("table_name") + .where( + (information_schema.tables.row_format != row_format) + & (information_schema.tables.table_schema == frappe.conf.db_name) + ) + .run() + ) tables = [x[0] for x in queried_tables] else: tables = [x.strip() for x in table.split(",")] @@ -620,37 +727,58 @@ def transform_database(context, table, engine, row_format, failfast): frappe.destroy() -@click.command('run-tests') -@click.option('--app', help="For App") -@click.option('--doctype', help="For DocType") -@click.option('--case', help="Select particular TestCase") -@click.option('--doctype-list-path', help="Path to .txt file for list of doctypes. Example erpnext/tests/server/agriculture.txt") -@click.option('--test', multiple=True, help="Specific test") -@click.option('--ui-tests', is_flag=True, default=False, help="Run UI Tests") -@click.option('--module', help="Run tests in a module") -@click.option('--profile', is_flag=True, default=False) -@click.option('--coverage', is_flag=True, default=False) -@click.option('--skip-test-records', is_flag=True, default=False, help="Don't create test records") -@click.option('--skip-before-tests', is_flag=True, default=False, help="Don't run before tests hook") -@click.option('--junit-xml-output', help="Destination file path for junit xml report") -@click.option('--failfast', is_flag=True, default=False, help="Stop the test run on the first error or failure") +@click.command("run-tests") +@click.option("--app", help="For App") +@click.option("--doctype", help="For DocType") +@click.option("--case", help="Select particular TestCase") +@click.option( + "--doctype-list-path", + help="Path to .txt file for list of doctypes. Example erpnext/tests/server/agriculture.txt", +) +@click.option("--test", multiple=True, help="Specific test") +@click.option("--ui-tests", is_flag=True, default=False, help="Run UI Tests") +@click.option("--module", help="Run tests in a module") +@click.option("--profile", is_flag=True, default=False) +@click.option("--coverage", is_flag=True, default=False) +@click.option("--skip-test-records", is_flag=True, default=False, help="Don't create test records") +@click.option( + "--skip-before-tests", is_flag=True, default=False, help="Don't run before tests hook" +) +@click.option("--junit-xml-output", help="Destination file path for junit xml report") +@click.option( + "--failfast", is_flag=True, default=False, help="Stop the test run on the first error or failure" +) @pass_context -def run_tests(context, app=None, module=None, doctype=None, test=(), profile=False, - coverage=False, junit_xml_output=False, ui_tests = False, doctype_list_path=None, - skip_test_records=False, skip_before_tests=False, failfast=False, case=None): +def run_tests( + context, + app=None, + module=None, + doctype=None, + test=(), + profile=False, + coverage=False, + junit_xml_output=False, + ui_tests=False, + doctype_list_path=None, + skip_test_records=False, + skip_before_tests=False, + failfast=False, + case=None, +): with CodeCoverage(coverage, app): import frappe import frappe.test_runner + tests = test site = get_site(context) allow_tests = frappe.get_conf(site).allow_tests - if not (allow_tests or os.environ.get('CI')): - click.secho('Testing is disabled for the site!', bold=True) - click.secho('You can enable tests by entering following command:') - click.secho('bench --site {0} set-config allow_tests true'.format(site), fg='green') + if not (allow_tests or os.environ.get("CI")): + click.secho("Testing is disabled for the site!", bold=True) + click.secho("You can enable tests by entering following command:") + click.secho("bench --site {0} set-config allow_tests true".format(site), fg="green") return frappe.init(site=site) @@ -658,51 +786,70 @@ def run_tests(context, app=None, module=None, doctype=None, test=(), profile=Fal frappe.flags.skip_before_tests = skip_before_tests frappe.flags.skip_test_records = skip_test_records - ret = frappe.test_runner.main(app, module, doctype, context.verbose, tests=tests, - force=context.force, profile=profile, junit_xml_output=junit_xml_output, - ui_tests=ui_tests, doctype_list_path=doctype_list_path, failfast=failfast, case=case) + ret = frappe.test_runner.main( + app, + module, + doctype, + context.verbose, + tests=tests, + force=context.force, + profile=profile, + junit_xml_output=junit_xml_output, + ui_tests=ui_tests, + doctype_list_path=doctype_list_path, + failfast=failfast, + case=case, + ) if len(ret.failures) == 0 and len(ret.errors) == 0: ret = 0 - if os.environ.get('CI'): + if os.environ.get("CI"): sys.exit(ret) -@click.command('run-parallel-tests') -@click.option('--app', help="For App", default='frappe') -@click.option('--build-number', help="Build number", default=1) -@click.option('--total-builds', help="Total number of builds", default=1) -@click.option('--with-coverage', is_flag=True, help="Build coverage file") -@click.option('--use-orchestrator', is_flag=True, help="Use orchestrator to run parallel tests") + +@click.command("run-parallel-tests") +@click.option("--app", help="For App", default="frappe") +@click.option("--build-number", help="Build number", default=1) +@click.option("--total-builds", help="Total number of builds", default=1) +@click.option("--with-coverage", is_flag=True, help="Build coverage file") +@click.option("--use-orchestrator", is_flag=True, help="Use orchestrator to run parallel tests") @pass_context -def run_parallel_tests(context, app, build_number, total_builds, with_coverage=False, use_orchestrator=False): +def run_parallel_tests( + context, app, build_number, total_builds, with_coverage=False, use_orchestrator=False +): with CodeCoverage(with_coverage, app): site = get_site(context) if use_orchestrator: from frappe.parallel_test_runner import ParallelTestWithOrchestrator + ParallelTestWithOrchestrator(app, site=site) else: from frappe.parallel_test_runner import ParallelTestRunner + ParallelTestRunner(app, site=site, build_number=build_number, total_builds=total_builds) -@click.command('run-ui-tests') -@click.argument('app') -@click.option('--headless', is_flag=True, help="Run UI Test in headless mode") -@click.option('--parallel', is_flag=True, help="Run UI Test in parallel mode") -@click.option('--with-coverage', is_flag=True, help="Generate coverage report") -@click.option('--ci-build-id') + +@click.command("run-ui-tests") +@click.argument("app") +@click.option("--headless", is_flag=True, help="Run UI Test in headless mode") +@click.option("--parallel", is_flag=True, help="Run UI Test in parallel mode") +@click.option("--with-coverage", is_flag=True, help="Generate coverage report") +@click.option("--ci-build-id") @pass_context -def run_ui_tests(context, app, headless=False, parallel=True, with_coverage=False, ci_build_id=None): +def run_ui_tests( + context, app, headless=False, parallel=True, with_coverage=False, ci_build_id=None +): "Run UI tests" site = get_site(context) - app_base_path = os.path.abspath(os.path.join(frappe.get_app_path(app), '..')) + app_base_path = os.path.abspath(os.path.join(frappe.get_app_path(app), "..")) site_url = frappe.utils.get_site_url(site) admin_password = frappe.get_conf(site).admin_password # override baseUrl using env variable - site_env = f'CYPRESS_baseUrl={site_url}' - password_env = f'CYPRESS_adminPassword={admin_password}' if admin_password else '' - coverage_env = f'CYPRESS_coverage={str(with_coverage).lower()}' + site_env = f"CYPRESS_baseUrl={site_url}" + password_env = f"CYPRESS_adminPassword={admin_password}" if admin_password else "" + coverage_env = f"CYPRESS_coverage={str(with_coverage).lower()}" os.chdir(app_base_path) @@ -722,30 +869,41 @@ def run_ui_tests(context, app, headless=False, parallel=True, with_coverage=Fals ): # install cypress click.secho("Installing Cypress...", fg="yellow") - frappe.commands.popen("yarn add cypress@^6 cypress-file-upload@^5 @testing-library/cypress@^8 @cypress/code-coverage@^3 --no-lockfile") + frappe.commands.popen( + "yarn add cypress@^6 cypress-file-upload@^5 @testing-library/cypress@^8 @cypress/code-coverage@^3 --no-lockfile" + ) # run for headless mode - run_or_open = 'run --browser chrome --record' if headless else 'open' - formatted_command = f'{site_env} {password_env} {coverage_env} {cypress_path} {run_or_open}' + run_or_open = "run --browser chrome --record" if headless else "open" + formatted_command = f"{site_env} {password_env} {coverage_env} {cypress_path} {run_or_open}" if parallel: - formatted_command += ' --parallel' + formatted_command += " --parallel" if ci_build_id: - formatted_command += f' --ci-build-id {ci_build_id}' + formatted_command += f" --ci-build-id {ci_build_id}" click.secho("Running Cypress...", fg="yellow") frappe.commands.popen(formatted_command, cwd=app_base_path, raise_err=True) -@click.command('serve') -@click.option('--port', default=8000) -@click.option('--profile', is_flag=True, default=False) -@click.option('--noreload', "no_reload", is_flag=True, default=False) -@click.option('--nothreading', "no_threading", is_flag=True, default=False) -@click.option('--with-coverage', is_flag=True, default=False) +@click.command("serve") +@click.option("--port", default=8000) +@click.option("--profile", is_flag=True, default=False) +@click.option("--noreload", "no_reload", is_flag=True, default=False) +@click.option("--nothreading", "no_threading", is_flag=True, default=False) +@click.option("--with-coverage", is_flag=True, default=False) @pass_context -def serve(context, port=None, profile=False, no_reload=False, no_threading=False, sites_path='.', site=None, with_coverage=False): +def serve( + context, + port=None, + profile=False, + no_reload=False, + no_threading=False, + sites_path=".", + site=None, + with_coverage=False, +): "Start development web server" import frappe.app @@ -753,22 +911,30 @@ def serve(context, port=None, profile=False, no_reload=False, no_threading=False site = None else: site = context.sites[0] - with CodeCoverage(with_coverage, 'frappe'): + with CodeCoverage(with_coverage, "frappe"): if with_coverage: # unable to track coverage with threading enabled no_threading = True no_reload = True - frappe.app.serve(port=port, profile=profile, no_reload=no_reload, no_threading=no_threading, site=site, sites_path='.') + frappe.app.serve( + port=port, + profile=profile, + no_reload=no_reload, + no_threading=no_threading, + site=site, + sites_path=".", + ) -@click.command('request') -@click.option('--args', help='arguments like `?cmd=test&key=value` or `/api/request/method?..`') -@click.option('--path', help='path to request JSON') +@click.command("request") +@click.option("--args", help="arguments like `?cmd=test&key=value` or `/api/request/method?..`") +@click.option("--path", help="path to request JSON") @pass_context def request(context, args=None, path=None): "Run a request as an admin" - import frappe.handler import frappe.api + import frappe.handler + for site in context.sites: try: frappe.init(site=site) @@ -782,7 +948,7 @@ def request(context, args=None, path=None): if args.startswith("/api/method"): frappe.local.form_dict.cmd = args.split("?")[0].split("/")[-1] elif path: - with open(os.path.join('..', path), 'r') as f: + with open(os.path.join("..", path), "r") as f: args = json.loads(f.read()) frappe.local.form_dict = frappe._dict(args) @@ -795,22 +961,28 @@ def request(context, args=None, path=None): if not context.sites: raise SiteNotSpecifiedError -@click.command('make-app') -@click.argument('destination') -@click.argument('app_name') -@click.option('--no-git', is_flag=True, default=False, help='Do not initialize git repository for the app') + +@click.command("make-app") +@click.argument("destination") +@click.argument("app_name") +@click.option( + "--no-git", is_flag=True, default=False, help="Do not initialize git repository for the app" +) def make_app(destination, app_name, no_git=False): "Creates a boilerplate app" from frappe.utils.boilerplate import make_boilerplate + make_boilerplate(destination, app_name, no_git=no_git) -@click.command('set-config') -@click.argument('key') -@click.argument('value') -@click.option('-g', '--global', 'global_', is_flag=True, default=False, help='Set value in bench config') -@click.option('-p', '--parse', is_flag=True, default=False, help='Evaluate as Python Object') -@click.option('--as-dict', is_flag=True, default=False, help='Legacy: Evaluate as Python Object') +@click.command("set-config") +@click.argument("key") +@click.argument("value") +@click.option( + "-g", "--global", "global_", is_flag=True, default=False, help="Set value in bench config" +) +@click.option("-p", "--parse", is_flag=True, default=False, help="Evaluate as Python Object") +@click.option("--as-dict", is_flag=True, default=False, help="Legacy: Evaluate as Python Object") @pass_context def set_config(context, key, value, global_=False, parse=False, as_dict=False): "Insert/Update a value in site_config.json" @@ -818,16 +990,20 @@ def set_config(context, key, value, global_=False, parse=False, as_dict=False): if as_dict: from frappe.utils.commands import warn - warn("--as-dict will be deprecated in v14. Use --parse instead", category=PendingDeprecationWarning) + + warn( + "--as-dict will be deprecated in v14. Use --parse instead", category=PendingDeprecationWarning + ) parse = as_dict if parse: import ast + value = ast.literal_eval(value) if global_: sites_path = os.getcwd() - common_site_config_path = os.path.join(sites_path, 'common_site_config.json') + common_site_config_path = os.path.join(sites_path, "common_site_config.json") update_site_config(key, value, validate=False, site_config_path=common_site_config_path) else: for site in context.sites: @@ -837,13 +1013,20 @@ def set_config(context, key, value, global_=False, parse=False, as_dict=False): @click.command("version") -@click.option("-f", "--format", "output", - type=click.Choice(["plain", "table", "json", "legacy"]), help="Output format", default="legacy") +@click.option( + "-f", + "--format", + "output", + type=click.Choice(["plain", "table", "json", "legacy"]), + help="Output format", + default="legacy", +) def get_version(output): """Show the versions of all the installed apps.""" from git import Repo - from frappe.utils.commands import render_table + from frappe.utils.change_log import get_app_branch + from frappe.utils.commands import render_table frappe.init("") data = [] @@ -862,32 +1045,33 @@ def get_version(output): data.append(app_info) { - "legacy": lambda: [ - click.echo(f"{app_info.app} {app_info.version}") - for app_info in data - ], + "legacy": lambda: [click.echo(f"{app_info.app} {app_info.version}") for app_info in data], "plain": lambda: [ click.echo(f"{app_info.app} {app_info.version} {app_info.branch} ({app_info.commit})") for app_info in data ], "table": lambda: render_table( - [["App", "Version", "Branch", "Commit"]] + - [ - [app_info.app, app_info.version, app_info.branch, app_info.commit] - for app_info in data - ] + [["App", "Version", "Branch", "Commit"]] + + [[app_info.app, app_info.version, app_info.branch, app_info.commit] for app_info in data] ), "json": lambda: click.echo(json.dumps(data, indent=4)), }[output]() -@click.command('rebuild-global-search') -@click.option('--static-pages', is_flag=True, default=False, help='Rebuild global search for static pages') +@click.command("rebuild-global-search") +@click.option( + "--static-pages", is_flag=True, default=False, help="Rebuild global search for static pages" +) @pass_context def rebuild_global_search(context, static_pages=False): - '''Setup help table in the current site (called after migrate)''' - from frappe.utils.global_search import (get_doctypes_with_global_search, rebuild_for_doctype, - get_routes_to_index, add_route_to_global_search, sync_global_search) + """Setup help table in the current site (called after migrate)""" + from frappe.utils.global_search import ( + add_route_to_global_search, + get_doctypes_with_global_search, + get_routes_to_index, + rebuild_for_doctype, + sync_global_search, + ) for site in context.sites: try: @@ -899,13 +1083,13 @@ def rebuild_global_search(context, static_pages=False): for i, route in enumerate(routes): add_route_to_global_search(route) frappe.local.request = None - update_progress_bar('Rebuilding Global Search', i, len(routes)) + update_progress_bar("Rebuilding Global Search", i, len(routes)) sync_global_search() else: doctypes = get_doctypes_with_global_search() for i, doctype in enumerate(doctypes): rebuild_for_doctype(doctype) - update_progress_bar('Rebuilding Global Search', i, len(doctypes)) + update_progress_bar("Rebuilding Global Search", i, len(doctypes)) finally: frappe.destroy() @@ -945,5 +1129,5 @@ commands = [ bulk_rename, add_to_email_queue, rebuild_global_search, - run_parallel_tests + run_parallel_tests, ] diff --git a/frappe/config/__init__.py b/frappe/config/__init__.py index aa441b7d71..ebd75cd70a 100644 --- a/frappe/config/__init__.py +++ b/frappe/config/__init__.py @@ -1,14 +1,20 @@ import frappe from frappe import _ -from frappe.desk.moduleview import (get_data, get_onboard_items, config_exists, get_module_link_items_from_list) +from frappe.desk.moduleview import ( + config_exists, + get_data, + get_module_link_items_from_list, + get_onboard_items, +) + def get_modules_from_all_apps_for_user(user=None): if not user: user = frappe.session.user all_modules = get_modules_from_all_apps() - global_blocked_modules = frappe.get_doc('User', 'Administrator').get_blocked_modules() - user_blocked_modules = frappe.get_doc('User', user).get_blocked_modules() + global_blocked_modules = frappe.get_doc("User", "Administrator").get_blocked_modules() + user_blocked_modules = frappe.get_doc("User", user).get_blocked_modules() blocked_modules = global_blocked_modules + user_blocked_modules allowed_modules_list = [m for m in all_modules if m.get("module_name") not in blocked_modules] @@ -22,31 +28,31 @@ def get_modules_from_all_apps_for_user(user=None): module["onboard_present"] = 1 # Set defaults links - module["links"] = get_onboard_items(module["app"], frappe.scrub(module_name))[:5] + module["links"] = get_onboard_items(module["app"], frappe.scrub(module_name))[:5] return allowed_modules_list + def get_modules_from_all_apps(): modules_list = [] for app in frappe.get_installed_apps(): modules_list += get_modules_from_app(app) return modules_list + def get_modules_from_app(app): - return frappe.get_all('Module Def', - filters={'app_name': app}, - fields=['module_name', 'app_name as app'] + return frappe.get_all( + "Module Def", filters={"app_name": app}, fields=["module_name", "app_name as app"] ) + def get_all_empty_tables_by_module(): table_rows = frappe.qb.Field("table_rows") table_name = frappe.qb.Field("table_name") information_schema = frappe.qb.Schema("information_schema") empty_tables = ( - frappe.qb.from_(information_schema.tables) - .select(table_name) - .where(table_rows == 0) + frappe.qb.from_(information_schema.tables).select(table_name).where(table_rows == 0) ).run() empty_tables = {r[0] for r in empty_tables} @@ -62,8 +68,10 @@ def get_all_empty_tables_by_module(): empty_tables_by_module[module] = [doctype] return empty_tables_by_module + def is_domain(module): return module.get("category") == "Domains" + def is_module(module): - return module.get("type") == "module" \ No newline at end of file + return module.get("type") == "module" diff --git a/frappe/contacts/address_and_contact.py b/frappe/contacts/address_and_contact.py index 7824568a43..1eb9f1cf33 100644 --- a/frappe/contacts/address_and_contact.py +++ b/frappe/contacts/address_and_contact.py @@ -1,12 +1,13 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe - -from frappe import _ import functools import re +import frappe +from frappe import _ + + def load_address_and_contact(doc, key=None): """Loads address list and contact list in `__onload`""" from frappe.contacts.doctype.address.address import get_address_display, get_condensed_address @@ -18,15 +19,18 @@ def load_address_and_contact(doc, key=None): ] address_list = frappe.get_list("Address", filters=filters, fields=["*"]) - address_list = [a.update({"display": get_address_display(a)}) - for a in address_list] + address_list = [a.update({"display": get_address_display(a)}) for a in address_list] - address_list = sorted(address_list, - key = functools.cmp_to_key(lambda a, b: - (int(a.is_primary_address - b.is_primary_address)) or - (1 if a.modified - b.modified else 0)), reverse=True) + address_list = sorted( + address_list, + key=functools.cmp_to_key( + lambda a, b: (int(a.is_primary_address - b.is_primary_address)) + or (1 if a.modified - b.modified else 0) + ), + reverse=True, + ) - doc.set_onload('addr_list', address_list) + doc.set_onload("addr_list", address_list) contact_list = [] filters = [ @@ -37,29 +41,38 @@ def load_address_and_contact(doc, key=None): contact_list = frappe.get_list("Contact", filters=filters, fields=["*"]) for contact in contact_list: - contact["email_ids"] = frappe.get_all("Contact Email", filters={ - "parenttype": "Contact", - "parent": contact.name, - "is_primary": 0 - }, fields=["email_id"]) - - contact["phone_nos"] = frappe.get_all("Contact Phone", filters={ + contact["email_ids"] = frappe.get_all( + "Contact Email", + filters={"parenttype": "Contact", "parent": contact.name, "is_primary": 0}, + fields=["email_id"], + ) + + contact["phone_nos"] = frappe.get_all( + "Contact Phone", + filters={ "parenttype": "Contact", "parent": contact.name, "is_primary_phone": 0, - "is_primary_mobile_no": 0 - }, fields=["phone"]) + "is_primary_mobile_no": 0, + }, + fields=["phone"], + ) if contact.address: address = frappe.get_doc("Address", contact.address) contact["address"] = get_condensed_address(address) - contact_list = sorted(contact_list, - key = functools.cmp_to_key(lambda a, b: - (int(a.is_primary_contact - b.is_primary_contact)) or - (1 if a.modified - b.modified else 0)), reverse=True) + contact_list = sorted( + contact_list, + key=functools.cmp_to_key( + lambda a, b: (int(a.is_primary_contact - b.is_primary_contact)) + or (1 if a.modified - b.modified else 0) + ), + reverse=True, + ) + + doc.set_onload("contact_list", contact_list) - doc.set_onload('contact_list', contact_list) def has_permission(doc, ptype, user): links = get_permitted_and_not_permitted_links(doc.doctype) @@ -69,7 +82,7 @@ def has_permission(doc, ptype, user): # True if any one is True or all are empty names = [] - for df in (links.get("permitted_links") + links.get("not_permitted_links")): + for df in links.get("permitted_links") + links.get("not_permitted_links"): doctype = df.options name = doc.get(df.fieldname) names.append(name) @@ -81,12 +94,15 @@ def has_permission(doc, ptype, user): return True return False + def get_permission_query_conditions_for_contact(user): return get_permission_query_conditions("Contact") + def get_permission_query_conditions_for_address(user): return get_permission_query_conditions("Address") + def get_permission_query_conditions(doctype): links = get_permitted_and_not_permitted_links(doctype) @@ -100,7 +116,9 @@ def get_permission_query_conditions(doctype): # when everything is not permitted for df in links.get("not_permitted_links"): # like ifnull(customer, '')='' and ifnull(supplier, '')='' - conditions.append("ifnull(`tab{doctype}`.`{fieldname}`, '')=''".format(doctype=doctype, fieldname=df.fieldname)) + conditions.append( + "ifnull(`tab{doctype}`.`{fieldname}`, '')=''".format(doctype=doctype, fieldname=df.fieldname) + ) return "( " + " and ".join(conditions) + " )" @@ -109,10 +127,13 @@ def get_permission_query_conditions(doctype): for df in links.get("permitted_links"): # like ifnull(customer, '')!='' or ifnull(supplier, '')!='' - conditions.append("ifnull(`tab{doctype}`.`{fieldname}`, '')!=''".format(doctype=doctype, fieldname=df.fieldname)) + conditions.append( + "ifnull(`tab{doctype}`.`{fieldname}`, '')!=''".format(doctype=doctype, fieldname=df.fieldname) + ) return "( " + " or ".join(conditions) + " )" + def get_permitted_and_not_permitted_links(doctype): permitted_links = [] not_permitted_links = [] @@ -129,40 +150,40 @@ def get_permitted_and_not_permitted_links(doctype): else: not_permitted_links.append(df) - return { - "permitted_links": permitted_links, - "not_permitted_links": not_permitted_links - } + return {"permitted_links": permitted_links, "not_permitted_links": not_permitted_links} + def delete_contact_and_address(doctype, docname): - for parenttype in ('Contact', 'Address'): - items = frappe.db.sql_list("""select parent from `tabDynamic Link` + for parenttype in ("Contact", "Address"): + items = frappe.db.sql_list( + """select parent from `tabDynamic Link` where parenttype=%s and link_doctype=%s and link_name=%s""", - (parenttype, doctype, docname)) + (parenttype, doctype, docname), + ) for name in items: doc = frappe.get_doc(parenttype, name) - if len(doc.links)==1: + if len(doc.links) == 1: doc.delete() + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def filter_dynamic_link_doctypes(doctype, txt, searchfield, start, page_len, filters): - if not txt: txt = "" + if not txt: + txt = "" - doctypes = frappe.db.get_all("DocField", filters=filters, fields=["parent"], - distinct=True, as_list=True) + doctypes = frappe.db.get_all( + "DocField", filters=filters, fields=["parent"], distinct=True, as_list=True + ) - doctypes = tuple(d for d in doctypes if re.search(txt+".*", _(d[0]), re.IGNORECASE)) + doctypes = tuple(d for d in doctypes if re.search(txt + ".*", _(d[0]), re.IGNORECASE)) - filters.update({ - "dt": ("not in", [d[0] for d in doctypes]) - }) + filters.update({"dt": ("not in", [d[0] for d in doctypes])}) - _doctypes = frappe.db.get_all("Custom Field", filters=filters, fields=["dt"], - as_list=True) + _doctypes = frappe.db.get_all("Custom Field", filters=filters, fields=["dt"], as_list=True) - _doctypes = tuple([d for d in _doctypes if re.search(txt+".*", _(d[0]), re.IGNORECASE)]) + _doctypes = tuple([d for d in _doctypes if re.search(txt + ".*", _(d[0]), re.IGNORECASE)]) all_doctypes = [d[0] for d in doctypes + _doctypes] allowed_doctypes = frappe.permissions.get_doctypes_with_read() @@ -172,6 +193,7 @@ def filter_dynamic_link_doctypes(doctype, txt, searchfield, start, page_len, fil return valid_doctypes + def set_link_title(doc): if not doc.links: return diff --git a/frappe/contacts/doctype/address/address.py b/frappe/contacts/doctype/address/address.py index 5d0ed18d5f..d9ba31d474 100644 --- a/frappe/contacts/doctype/address/address.py +++ b/frappe/contacts/doctype/address/address.py @@ -2,16 +2,15 @@ # Copyright (c) 2015, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe - -from frappe import throw, _ -from frappe.utils import cstr +from jinja2 import TemplateSyntaxError +import frappe +from frappe import _, throw +from frappe.contacts.address_and_contact import set_link_title +from frappe.core.doctype.dynamic_link.dynamic_link import deduplicate_dynamic_links from frappe.model.document import Document -from jinja2 import TemplateSyntaxError from frappe.model.naming import make_autoname -from frappe.core.doctype.dynamic_link.dynamic_link import deduplicate_dynamic_links -from frappe.contacts.address_and_contact import set_link_title +from frappe.utils import cstr class Address(Document): @@ -24,10 +23,11 @@ class Address(Document): self.address_title = self.links[0].link_name if self.address_title: - self.name = (cstr(self.address_title).strip() + "-" + cstr(_(self.address_type)).strip()) + self.name = cstr(self.address_title).strip() + "-" + cstr(_(self.address_type)).strip() if frappe.db.exists("Address", self.name): - self.name = make_autoname(cstr(self.address_title).strip() + "-" + - cstr(self.address_type).strip() + "-.#") + self.name = make_autoname( + cstr(self.address_title).strip() + "-" + cstr(self.address_type).strip() + "-.#" + ) else: throw(_("Address Title is mandatory.")) @@ -42,15 +42,15 @@ class Address(Document): if not self.links: contact_name = frappe.db.get_value("Contact", {"email_id": self.owner}) if contact_name: - contact = frappe.get_cached_doc('Contact', contact_name) + contact = frappe.get_cached_doc("Contact", contact_name) for link in contact.links: - self.append('links', dict(link_doctype=link.link_doctype, link_name=link.link_name)) + self.append("links", dict(link_doctype=link.link_doctype, link_name=link.link_name)) return True return False def validate_preferred_address(self): - preferred_fields = ['is_primary_address', 'is_shipping_address'] + preferred_fields = ["is_primary_address", "is_shipping_address"] for field in preferred_fields: if self.get(field): @@ -76,9 +76,11 @@ class Address(Document): return False -def get_preferred_address(doctype, name, preferred_key='is_primary_address'): - if preferred_key in ['is_shipping_address', 'is_primary_address']: - address = frappe.db.sql(""" SELECT + +def get_preferred_address(doctype, name, preferred_key="is_primary_address"): + if preferred_key in ["is_shipping_address", "is_primary_address"]: + address = frappe.db.sql( + """ SELECT addr.name FROM `tabAddress` addr, `tabDynamic Link` dl @@ -86,27 +88,37 @@ def get_preferred_address(doctype, name, preferred_key='is_primary_address'): dl.parent = addr.name and dl.link_doctype = %s and dl.link_name = %s and ifnull(addr.disabled, 0) = 0 and %s = %s - """ % ('%s', '%s', preferred_key, '%s'), (doctype, name, 1), as_dict=1) + """ + % ("%s", "%s", preferred_key, "%s"), + (doctype, name, 1), + as_dict=1, + ) if address: return address[0].name return + @frappe.whitelist() -def get_default_address(doctype, name, sort_key='is_primary_address'): - '''Returns default Address name for the given doctype, name''' - if sort_key not in ['is_shipping_address', 'is_primary_address']: +def get_default_address(doctype, name, sort_key="is_primary_address"): + """Returns default Address name for the given doctype, name""" + if sort_key not in ["is_shipping_address", "is_primary_address"]: return None - out = frappe.db.sql(""" SELECT + out = frappe.db.sql( + """ SELECT addr.name, addr.%s FROM `tabAddress` addr, `tabDynamic Link` dl WHERE dl.parent = addr.name and dl.link_doctype = %s and dl.link_name = %s and ifnull(addr.disabled, 0) = 0 - """ %(sort_key, '%s', '%s'), (doctype, name), as_dict=True) + """ + % (sort_key, "%s", "%s"), + (doctype, name), + as_dict=True, + ) if out: for contact in out: @@ -150,84 +162,96 @@ def get_territory_from_address(address): return territory + def get_list_context(context=None): return { "title": _("Addresses"), "get_list": get_address_list, "row_template": "templates/includes/address_row.html", - 'no_breadcrumbs': True, + "no_breadcrumbs": True, } -def get_address_list(doctype, txt, filters, limit_start, limit_page_length = 20, order_by = None): + +def get_address_list(doctype, txt, filters, limit_start, limit_page_length=20, order_by=None): from frappe.www.list import get_list + user = frappe.session.user ignore_permissions = True - if not filters: filters = [] + if not filters: + filters = [] filters.append(("Address", "owner", "=", user)) - return get_list(doctype, txt, filters, limit_start, limit_page_length, ignore_permissions=ignore_permissions) + return get_list( + doctype, txt, filters, limit_start, limit_page_length, ignore_permissions=ignore_permissions + ) + def has_website_permission(doc, ptype, user, verbose=False): """Returns true if there is a related lead or contact related to this document""" contact_name = frappe.db.get_value("Contact", {"email_id": frappe.session.user}) if contact_name: - contact = frappe.get_doc('Contact', contact_name) + contact = frappe.get_doc("Contact", contact_name) return contact.has_common_link(doc) return False + def get_address_templates(address): - result = frappe.db.get_value("Address Template", \ - {"country": address.get("country")}, ["name", "template"]) + result = frappe.db.get_value( + "Address Template", {"country": address.get("country")}, ["name", "template"] + ) if not result: - result = frappe.db.get_value("Address Template", \ - {"is_default": 1}, ["name", "template"]) + result = frappe.db.get_value("Address Template", {"is_default": 1}, ["name", "template"]) if not result: - frappe.throw(_("No default Address Template found. Please create a new one from Setup > Printing and Branding > Address Template.")) + frappe.throw( + _( + "No default Address Template found. Please create a new one from Setup > Printing and Branding > Address Template." + ) + ) else: return result + def get_company_address(company): ret = frappe._dict() - ret.company_address = get_default_address('Company', company) + ret.company_address = get_default_address("Company", company) ret.company_address_display = get_address_display(ret.company_address) return ret + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def address_query(doctype, txt, searchfield, start, page_len, filters): from frappe.desk.reportview import get_match_cond - link_doctype = filters.pop('link_doctype') - link_name = filters.pop('link_name') + link_doctype = filters.pop("link_doctype") + link_name = filters.pop("link_name") condition = "" meta = frappe.get_meta("Address") for fieldname, value in filters.items(): if meta.get_field(fieldname) or fieldname in frappe.db.DEFAULT_COLUMNS: - condition += " and {field}={value}".format( - field=fieldname, - value=frappe.db.escape(value)) + condition += " and {field}={value}".format(field=fieldname, value=frappe.db.escape(value)) searchfields = meta.get_search_fields() - if searchfield and (meta.get_field(searchfield)\ - or searchfield in frappe.db.DEFAULT_COLUMNS): + if searchfield and (meta.get_field(searchfield) or searchfield in frappe.db.DEFAULT_COLUMNS): searchfields.append(searchfield) - search_condition = '' + search_condition = "" for field in searchfields: - if search_condition == '': - search_condition += '`tabAddress`.`{field}` like %(txt)s'.format(field=field) + if search_condition == "": + search_condition += "`tabAddress`.`{field}` like %(txt)s".format(field=field) else: - search_condition += ' or `tabAddress`.`{field}` like %(txt)s'.format(field=field) + search_condition += " or `tabAddress`.`{field}` like %(txt)s".format(field=field) - return frappe.db.sql("""select + return frappe.db.sql( + """select `tabAddress`.name, `tabAddress`.city, `tabAddress`.country from `tabAddress`, `tabDynamic Link` @@ -245,19 +269,24 @@ def address_query(doctype, txt, searchfield, start, page_len, filters): limit %(start)s, %(page_len)s """.format( mcond=get_match_cond(doctype), key=searchfield, - search_condition = search_condition, - condition=condition or ""), { - 'txt': '%' + txt + '%', - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len, - 'link_name': link_name, - 'link_doctype': link_doctype - }) + search_condition=search_condition, + condition=condition or "", + ), + { + "txt": "%" + txt + "%", + "_txt": txt.replace("%", ""), + "start": start, + "page_len": page_len, + "link_name": link_name, + "link_doctype": link_doctype, + }, + ) + def get_condensed_address(doc): fields = ["address_title", "address_line1", "address_line2", "city", "county", "state", "country"] return ", ".join(doc.get(d) for d in fields if doc.get(d)) + def update_preferred_address(address, field): - frappe.db.set_value('Address', address, field, 0) + frappe.db.set_value("Address", address, field, 0) diff --git a/frappe/contacts/doctype/address/test_address.py b/frappe/contacts/doctype/address/test_address.py index dd6cd1ca83..4a6e6e53f7 100644 --- a/frappe/contacts/doctype/address/test_address.py +++ b/frappe/contacts/doctype/address/test_address.py @@ -1,31 +1,32 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest + +import frappe from frappe.contacts.doctype.address.address import get_address_display + class TestAddress(unittest.TestCase): def test_template_works(self): - if not frappe.db.exists('Address Template', 'India'): - frappe.get_doc({ - "doctype": "Address Template", - "country": 'India', - "is_default": 1 - }).insert() + if not frappe.db.exists("Address Template", "India"): + frappe.get_doc({"doctype": "Address Template", "country": "India", "is_default": 1}).insert() - if not frappe.db.exists('Address', '_Test Address-Office'): - frappe.get_doc({ - "address_line1": "_Test Address Line 1", - "address_title": "_Test Address", - "address_type": "Office", - "city": "_Test City", - "state": "Test State", - "country": "India", - "doctype": "Address", - "is_primary_address": 1, - "phone": "+91 0000000000" - }).insert() + if not frappe.db.exists("Address", "_Test Address-Office"): + frappe.get_doc( + { + "address_line1": "_Test Address Line 1", + "address_title": "_Test Address", + "address_type": "Office", + "city": "_Test City", + "state": "Test State", + "country": "India", + "doctype": "Address", + "is_primary_address": 1, + "phone": "+91 0000000000", + } + ).insert() address = frappe.get_list("Address")[0].name display = get_address_display(frappe.get_doc("Address", address).as_dict()) - self.assertTrue(display) \ No newline at end of file + self.assertTrue(display) diff --git a/frappe/contacts/doctype/address_template/address_template.py b/frappe/contacts/doctype/address_template/address_template.py index 005f414303..85e9a986ef 100644 --- a/frappe/contacts/doctype/address_template/address_template.py +++ b/frappe/contacts/doctype/address_template/address_template.py @@ -3,21 +3,24 @@ # License: MIT. See LICENSE import frappe +from frappe import _ from frappe.model.document import Document from frappe.utils import cint from frappe.utils.jinja import validate_template -from frappe import _ + class AddressTemplate(Document): def validate(self): if not self.template: self.template = get_default_address_template() - self.defaults = frappe.db.get_values("Address Template", {"is_default":1, "name":("!=", self.name)}) + self.defaults = frappe.db.get_values( + "Address Template", {"is_default": 1, "name": ("!=", self.name)} + ) if not self.is_default: if not self.defaults: self.is_default = 1 - if cint(frappe.db.get_single_value('System Settings', 'setup_complete')): + if cint(frappe.db.get_single_value("System Settings", "setup_complete")): frappe.msgprint(_("Setting this Address Template as default as there is no other default")) validate_template(self.template) @@ -31,14 +34,23 @@ class AddressTemplate(Document): if self.is_default: frappe.throw(_("Default Address Template cannot be deleted")) + @frappe.whitelist() def get_default_address_template(): - '''Get default address template (translated)''' - return '''{{ address_line1 }}
{% if address_line2 %}{{ address_line2 }}
{% endif -%}\ + """Get default address template (translated)""" + return ( + """{{ address_line1 }}
{% if address_line2 %}{{ address_line2 }}
{% endif -%}\ {{ city }}
{% if state %}{{ state }}
{% endif -%} {% if pincode %}{{ pincode }}
{% endif -%} {{ country }}
-{% if phone %}'''+_('Phone')+''': {{ phone }}
{% endif -%} -{% if fax %}'''+_('Fax')+''': {{ fax }}
{% endif -%} -{% if email_id %}'''+_('Email')+''': {{ email_id }}
{% endif -%}''' +{% if phone %}""" + + _("Phone") + + """: {{ phone }}
{% endif -%} +{% if fax %}""" + + _("Fax") + + """: {{ fax }}
{% endif -%} +{% if email_id %}""" + + _("Email") + + """: {{ email_id }}
{% endif -%}""" + ) diff --git a/frappe/contacts/doctype/address_template/test_address_template.py b/frappe/contacts/doctype/address_template/test_address_template.py index b86623b548..699de5ada0 100644 --- a/frappe/contacts/doctype/address_template/test_address_template.py +++ b/frappe/contacts/doctype/address_template/test_address_template.py @@ -1,7 +1,10 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest + +import frappe + class TestAddressTemplate(unittest.TestCase): def setUp(self): @@ -27,17 +30,12 @@ class TestAddressTemplate(unittest.TestCase): def make_default_address_template(self): template = """{{ address_line1 }}
{% if address_line2 %}{{ address_line2 }}
{% endif -%}{{ city }}
{% if state %}{{ state }}
{% endif -%}{% if pincode %}{{ pincode }}
{% endif -%}{{ country }}
{% if phone %}Phone: {{ phone }}
{% endif -%}{% if fax %}Fax: {{ fax }}
{% endif -%}{% if email_id %}Email: {{ email_id }}
{% endif -%}""" - if not frappe.db.exists('Address Template', 'India'): - frappe.get_doc({ - "doctype": "Address Template", - "country": 'India', - "is_default": 1, - "template": template - }).insert() - - if not frappe.db.exists('Address Template', 'Brazil'): - frappe.get_doc({ - "doctype": "Address Template", - "country": 'Brazil', - "template": template - }).insert() \ No newline at end of file + if not frappe.db.exists("Address Template", "India"): + frappe.get_doc( + {"doctype": "Address Template", "country": "India", "is_default": 1, "template": template} + ).insert() + + if not frappe.db.exists("Address Template", "Brazil"): + frappe.get_doc( + {"doctype": "Address Template", "country": "Brazil", "template": template} + ).insert() diff --git a/frappe/contacts/doctype/contact/contact.py b/frappe/contacts/doctype/contact/contact.py index 9152655b85..4036cda853 100644 --- a/frappe/contacts/doctype/contact/contact.py +++ b/frappe/contacts/doctype/contact/contact.py @@ -1,26 +1,27 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import frappe -from frappe.utils import cstr, has_gravatar from frappe import _ -from frappe.model.document import Document +from frappe.contacts.address_and_contact import set_link_title from frappe.core.doctype.dynamic_link.dynamic_link import deduplicate_dynamic_links +from frappe.model.document import Document from frappe.model.naming import append_number_if_name_exists -from frappe.contacts.address_and_contact import set_link_title +from frappe.utils import cstr, has_gravatar class Contact(Document): def autoname(self): # concat first and last name - self.name = " ".join(filter(None, - [cstr(self.get(f)).strip() for f in ["first_name", "last_name"]])) + self.name = " ".join( + filter(None, [cstr(self.get(f)).strip() for f in ["first_name", "last_name"]]) + ) if frappe.db.exists("Contact", self.name): - self.name = append_number_if_name_exists('Contact', self.name) + self.name = append_number_if_name_exists("Contact", self.name) # concat party name if reqd for link in self.links: - self.name = self.name + '-' + link.link_name.strip() + self.name = self.name + "-" + link.link_name.strip() break def validate(self): @@ -45,7 +46,7 @@ class Contact(Document): self.user = frappe.db.get_value("User", {"email": self.email_id}) def get_link_for(self, link_doctype): - '''Return the link name, if exists for the given link DocType''' + """Return the link name, if exists for the given link DocType""" for link in self.links: if link.link_doctype == link_doctype: return link.link_name @@ -65,21 +66,21 @@ class Contact(Document): def add_email(self, email_id, is_primary=0, autosave=False): if not frappe.db.exists("Contact Email", {"email_id": email_id, "parent": self.name}): - self.append("email_ids", { - "email_id": email_id, - "is_primary": is_primary - }) + self.append("email_ids", {"email_id": email_id, "is_primary": is_primary}) if autosave: self.save(ignore_permissions=True) def add_phone(self, phone, is_primary_phone=0, is_primary_mobile_no=0, autosave=False): if not frappe.db.exists("Contact Phone", {"phone": phone, "parent": self.name}): - self.append("phone_nos", { - "phone": phone, - "is_primary_phone": is_primary_phone, - "is_primary_mobile_no": is_primary_mobile_no - }) + self.append( + "phone_nos", + { + "phone": phone, + "is_primary_phone": is_primary_phone, + "is_primary_mobile_no": is_primary_mobile_no, + }, + ) if autosave: self.save(ignore_permissions=True) @@ -113,7 +114,9 @@ class Contact(Document): is_primary = [phone.phone for phone in self.phone_nos if phone.get(field_name)] if len(is_primary) > 1: - frappe.throw(_("Only one {0} can be set as primary.").format(frappe.bold(frappe.unscrub(fieldname)))) + frappe.throw( + _("Only one {0} can be set as primary.").format(frappe.bold(frappe.unscrub(fieldname))) + ) primary_number_exists = False for d in self.phone_nos: @@ -125,9 +128,11 @@ class Contact(Document): if not primary_number_exists: setattr(self, fieldname, "") + def get_default_contact(doctype, name): - '''Returns default contact for the given doctype, name''' - out = frappe.db.sql('''select parent, + """Returns default contact for the given doctype, name""" + out = frappe.db.sql( + '''select parent, IFNULL((select is_primary_contact from tabContact c where c.name = dl.parent), 0) as is_primary_contact from @@ -135,7 +140,10 @@ def get_default_contact(doctype, name): where dl.link_doctype=%s and dl.link_name=%s and - dl.parenttype = "Contact"''', (doctype, name), as_dict=True) + dl.parenttype = "Contact"''', + (doctype, name), + as_dict=True, + ) if out: for contact in out: @@ -145,6 +153,7 @@ def get_default_contact(doctype, name): else: return None + @frappe.whitelist() def invite_user(contact): contact = frappe.get_doc("Contact", contact) @@ -153,34 +162,39 @@ def invite_user(contact): frappe.throw(_("Please set Email Address")) if contact.has_permission("write"): - user = frappe.get_doc({ - "doctype": "User", - "first_name": contact.first_name, - "last_name": contact.last_name, - "email": contact.email_id, - "user_type": "Website User", - "send_welcome_email": 1 - }).insert(ignore_permissions = True) + user = frappe.get_doc( + { + "doctype": "User", + "first_name": contact.first_name, + "last_name": contact.last_name, + "email": contact.email_id, + "user_type": "Website User", + "send_welcome_email": 1, + } + ).insert(ignore_permissions=True) return user.name + @frappe.whitelist() def get_contact_details(contact): contact = frappe.get_doc("Contact", contact) out = { "contact_person": contact.get("name"), - "contact_display": " ".join(filter(None, - [contact.get("salutation"), contact.get("first_name"), contact.get("last_name")])), + "contact_display": " ".join( + filter(None, [contact.get("salutation"), contact.get("first_name"), contact.get("last_name")]) + ), "contact_email": contact.get("email_id"), "contact_mobile": contact.get("mobile_no"), "contact_phone": contact.get("phone"), "contact_designation": contact.get("designation"), - "contact_department": contact.get("department") + "contact_department": contact.get("department"), } return out + def update_contact(doc, method): - '''Update contact when user is updated, if contact is found. Called via hooks''' + """Update contact when user is updated, if contact is found. Called via hooks""" contact_name = frappe.db.get_value("Contact", {"email_id": doc.name}) if contact_name: contact = frappe.get_doc("Contact", contact_name) @@ -190,19 +204,23 @@ def update_contact(doc, method): contact.flags.ignore_mandatory = True contact.save(ignore_permissions=True) + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def contact_query(doctype, txt, searchfield, start, page_len, filters): from frappe.desk.reportview import get_match_cond - if not frappe.get_meta("Contact").get_field(searchfield)\ - and searchfield not in frappe.db.DEFAULT_COLUMNS: + if ( + not frappe.get_meta("Contact").get_field(searchfield) + and searchfield not in frappe.db.DEFAULT_COLUMNS + ): return [] - link_doctype = filters.pop('link_doctype') - link_name = filters.pop('link_name') + link_doctype = filters.pop("link_doctype") + link_name = filters.pop("link_name") - return frappe.db.sql("""select + return frappe.db.sql( + """select `tabContact`.name, `tabContact`.first_name, `tabContact`.last_name from `tabContact`, `tabDynamic Link` @@ -216,68 +234,90 @@ def contact_query(doctype, txt, searchfield, start, page_len, filters): order by if(locate(%(_txt)s, `tabContact`.name), locate(%(_txt)s, `tabContact`.name), 99999), `tabContact`.idx desc, `tabContact`.name - limit %(start)s, %(page_len)s """.format(mcond=get_match_cond(doctype), key=searchfield), { - 'txt': '%' + txt + '%', - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len, - 'link_name': link_name, - 'link_doctype': link_doctype - }) + limit %(start)s, %(page_len)s """.format( + mcond=get_match_cond(doctype), key=searchfield + ), + { + "txt": "%" + txt + "%", + "_txt": txt.replace("%", ""), + "start": start, + "page_len": page_len, + "link_name": link_name, + "link_doctype": link_doctype, + }, + ) + @frappe.whitelist() def address_query(links): import json - links = [{"link_doctype": d.get("link_doctype"), "link_name": d.get("link_name")} for d in json.loads(links)] + links = [ + {"link_doctype": d.get("link_doctype"), "link_name": d.get("link_name")} + for d in json.loads(links) + ] result = [] for link in links: - if not frappe.has_permission(doctype=link.get("link_doctype"), ptype="read", doc=link.get("link_name")): + if not frappe.has_permission( + doctype=link.get("link_doctype"), ptype="read", doc=link.get("link_name") + ): continue - res = frappe.db.sql(""" + res = frappe.db.sql( + """ SELECT `tabAddress`.name FROM `tabAddress`, `tabDynamic Link` WHERE `tabDynamic Link`.parenttype='Address' AND `tabDynamic Link`.parent=`tabAddress`.name AND `tabDynamic Link`.link_doctype = %(link_doctype)s AND `tabDynamic Link`.link_name = %(link_name)s - """, { - "link_doctype": link.get("link_doctype"), - "link_name": link.get("link_name"), - }, as_dict=True) + """, + { + "link_doctype": link.get("link_doctype"), + "link_name": link.get("link_name"), + }, + as_dict=True, + ) result.extend([l.name for l in res]) return result + def get_contact_with_phone_number(number): - if not number: return + if not number: + return - contacts = frappe.get_all('Contact Phone', filters=[ - ['phone', 'like', '%{0}'.format(number)] - ], fields=["parent"], limit=1) + contacts = frappe.get_all( + "Contact Phone", filters=[["phone", "like", "%{0}".format(number)]], fields=["parent"], limit=1 + ) return contacts[0].parent if contacts else None + def get_contact_name(email_id): - contact = frappe.get_all("Contact Email", filters={"email_id": email_id}, fields=["parent"], limit=1) + contact = frappe.get_all( + "Contact Email", filters={"email_id": email_id}, fields=["parent"], limit=1 + ) return contact[0].parent if contact else None + def get_contacts_linking_to(doctype, docname, fields=None): """Return a list of contacts containing a link to the given document.""" - return frappe.get_list('Contact', fields=fields, filters=[ - ['Dynamic Link', 'link_doctype', '=', doctype], - ['Dynamic Link', 'link_name', '=', docname] - ]) + return frappe.get_list( + "Contact", + fields=fields, + filters=[ + ["Dynamic Link", "link_doctype", "=", doctype], + ["Dynamic Link", "link_name", "=", docname], + ], + ) + def get_contacts_linked_from(doctype, docname, fields=None): """Return a list of contacts that are contained in (linked from) the given document.""" - link_fields = frappe.get_meta(doctype).get('fields', { - 'fieldtype': 'Link', - 'options': 'Contact' - }) + link_fields = frappe.get_meta(doctype).get("fields", {"fieldtype": "Link", "options": "Contact"}) if not link_fields: return [] @@ -285,6 +325,4 @@ def get_contacts_linked_from(doctype, docname, fields=None): if not contact_names: return [] - return frappe.get_list('Contact', fields=fields, filters={ - 'name': ('in', contact_names) - }) + return frappe.get_list("Contact", fields=fields, filters={"name": ("in", contact_names)}) diff --git a/frappe/contacts/doctype/contact/test_contact.py b/frappe/contacts/doctype/contact/test_contact.py index 1170ba843a..7ca47476e8 100644 --- a/frappe/contacts/doctype/contact/test_contact.py +++ b/frappe/contacts/doctype/contact/test_contact.py @@ -1,13 +1,14 @@ # -*- coding: utf-8 -*- # Copyright (c) 2017, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest -test_dependencies = ['Contact', 'Salutation'] +import frappe -class TestContact(unittest.TestCase): +test_dependencies = ["Contact", "Salutation"] + +class TestContact(unittest.TestCase): def test_check_default_email(self): emails = [ {"email": "test1@example.com", "is_primary": 0}, @@ -32,13 +33,11 @@ class TestContact(unittest.TestCase): self.assertEqual(contact.phone, "+91 0000000002") self.assertEqual(contact.mobile_no, "+91 0000000003") + def create_contact(name, salutation, emails=None, phones=None, save=True): - doc = frappe.get_doc({ - "doctype": "Contact", - "first_name": name, - "status": "Open", - "salutation": salutation - }) + doc = frappe.get_doc( + {"doctype": "Contact", "first_name": name, "status": "Open", "salutation": salutation} + ) if emails: for d in emails: diff --git a/frappe/contacts/doctype/contact_email/contact_email.py b/frappe/contacts/doctype/contact_email/contact_email.py index 58d37376b8..ed794ac06c 100644 --- a/frappe/contacts/doctype/contact_email/contact_email.py +++ b/frappe/contacts/doctype/contact_email/contact_email.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class ContactEmail(Document): pass diff --git a/frappe/contacts/doctype/contact_phone/contact_phone.py b/frappe/contacts/doctype/contact_phone/contact_phone.py index ed7d3b9911..2a842c9c9e 100644 --- a/frappe/contacts/doctype/contact_phone/contact_phone.py +++ b/frappe/contacts/doctype/contact_phone/contact_phone.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class ContactPhone(Document): pass diff --git a/frappe/contacts/doctype/gender/gender.py b/frappe/contacts/doctype/gender/gender.py index b4efcb64b9..8e9951eaf9 100644 --- a/frappe/contacts/doctype/gender/gender.py +++ b/frappe/contacts/doctype/gender/gender.py @@ -4,5 +4,6 @@ from frappe.model.document import Document + class Gender(Document): pass diff --git a/frappe/contacts/doctype/gender/test_gender.py b/frappe/contacts/doctype/gender/test_gender.py index 8549cc2130..6b795749ee 100644 --- a/frappe/contacts/doctype/gender/test_gender.py +++ b/frappe/contacts/doctype/gender/test_gender.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestGender(unittest.TestCase): pass diff --git a/frappe/contacts/doctype/salutation/salutation.py b/frappe/contacts/doctype/salutation/salutation.py index 380af6de28..57fb2d6abc 100644 --- a/frappe/contacts/doctype/salutation/salutation.py +++ b/frappe/contacts/doctype/salutation/salutation.py @@ -4,5 +4,6 @@ from frappe.model.document import Document + class Salutation(Document): pass diff --git a/frappe/contacts/doctype/salutation/test_salutation.py b/frappe/contacts/doctype/salutation/test_salutation.py index 59333fb61e..5149ced3dd 100644 --- a/frappe/contacts/doctype/salutation/test_salutation.py +++ b/frappe/contacts/doctype/salutation/test_salutation.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestSalutation(unittest.TestCase): pass diff --git a/frappe/contacts/report/addresses_and_contacts/addresses_and_contacts.py b/frappe/contacts/report/addresses_and_contacts/addresses_and_contacts.py index 671e1c6bc8..9848e81b63 100644 --- a/frappe/contacts/report/addresses_and_contacts/addresses_and_contacts.py +++ b/frappe/contacts/report/addresses_and_contacts/addresses_and_contacts.py @@ -4,17 +4,37 @@ import frappe from frappe import _ field_map = { - "Contact": ["first_name", "last_name", "address", "phone", "mobile_no", "email_id", "is_primary_contact"], - "Address": ["address_line1", "address_line2", "city", "state", "pincode", "country", "is_primary_address"] + "Contact": [ + "first_name", + "last_name", + "address", + "phone", + "mobile_no", + "email_id", + "is_primary_contact", + ], + "Address": [ + "address_line1", + "address_line2", + "city", + "state", + "pincode", + "country", + "is_primary_address", + ], } + def execute(filters=None): columns, data = get_columns(filters), get_data(filters) return columns, data + def get_columns(filters): return [ - "{reference_doctype}:Link/{reference_doctype}".format(reference_doctype=filters.get("reference_doctype")), + "{reference_doctype}:Link/{reference_doctype}".format( + reference_doctype=filters.get("reference_doctype") + ), "Address Line 1", "Address Line 2", "City", @@ -27,9 +47,10 @@ def get_columns(filters): "Address", "Phone", "Email Id", - "Is Primary Contact:Check" + "Is Primary Contact:Check", ] + def get_data(filters): data = [] reference_doctype = filters.get("reference_doctype") @@ -37,6 +58,7 @@ def get_data(filters): return get_reference_addresses_and_contact(reference_doctype, reference_name) + def get_reference_addresses_and_contact(reference_doctype, reference_name): data = [] filters = None @@ -48,16 +70,22 @@ def get_reference_addresses_and_contact(reference_doctype, reference_name): if reference_name: filters = {"name": reference_name} - reference_list = [d[0] for d in frappe.get_list(reference_doctype, filters=filters, fields=["name"], as_list=True)] + reference_list = [ + d[0] for d in frappe.get_list(reference_doctype, filters=filters, fields=["name"], as_list=True) + ] for d in reference_list: reference_details.setdefault(d, frappe._dict()) - reference_details = get_reference_details(reference_doctype, "Address", reference_list, reference_details) - reference_details = get_reference_details(reference_doctype, "Contact", reference_list, reference_details) + reference_details = get_reference_details( + reference_doctype, "Address", reference_list, reference_details + ) + reference_details = get_reference_details( + reference_doctype, "Contact", reference_list, reference_details + ) for reference_name, details in reference_details.items(): addresses = details.get("address", []) - contacts = details.get("contact", []) + contacts = details.get("contact", []) if not any([addresses, contacts]): result = [reference_name] result.extend(add_blank_columns_for("Address")) @@ -78,10 +106,11 @@ def get_reference_addresses_and_contact(reference_doctype, reference_name): return data + def get_reference_details(reference_doctype, doctype, reference_list, reference_details): - filters = [ + filters = [ ["Dynamic Link", "link_doctype", "=", reference_doctype], - ["Dynamic Link", "link_name", "in", reference_list] + ["Dynamic Link", "link_name", "in", reference_list], ] fields = ["`tabDynamic Link`.link_name"] + field_map.get(doctype, []) @@ -97,5 +126,6 @@ def get_reference_details(reference_doctype, doctype, reference_list, reference_ reference_details[reference_list[0]][frappe.scrub(doctype)] = temp_records return reference_details + def add_blank_columns_for(doctype): return ["" for field in field_map.get(doctype, [])] diff --git a/frappe/contacts/report/addresses_and_contacts/test_addresses_and_contacts.py b/frappe/contacts/report/addresses_and_contacts/test_addresses_and_contacts.py index f539722175..2ad8bfaba3 100644 --- a/frappe/contacts/report/addresses_and_contacts/test_addresses_and_contacts.py +++ b/frappe/contacts/report/addresses_and_contacts/test_addresses_and_contacts.py @@ -1,95 +1,87 @@ +import unittest import frappe import frappe.defaults -import unittest - from frappe.contacts.report.addresses_and_contacts.addresses_and_contacts import get_data + def get_custom_linked_doctype(): - if bool(frappe.get_all("DocType", filters={'name':'Test Custom Doctype'})): + if bool(frappe.get_all("DocType", filters={"name": "Test Custom Doctype"})): return - doc = frappe.get_doc({ - "doctype": "DocType", - "module": "Core", - "custom": 1, - "fields": [{ - "label": "Test Field", - "fieldname": "test_field", - "fieldtype": "Data" - }, - { - "label": "Contact HTML", - "fieldname": "contact_html", - "fieldtype": "HTML" - }, + doc = frappe.get_doc( { - "label": "Address HTML", - "fieldname": "address_html", - "fieldtype": "HTML" - }], - "permissions": [{ - "role": "System Manager", - "read": 1 - }], - "name": "Test Custom Doctype", - }) + "doctype": "DocType", + "module": "Core", + "custom": 1, + "fields": [ + {"label": "Test Field", "fieldname": "test_field", "fieldtype": "Data"}, + {"label": "Contact HTML", "fieldname": "contact_html", "fieldtype": "HTML"}, + {"label": "Address HTML", "fieldname": "address_html", "fieldtype": "HTML"}, + ], + "permissions": [{"role": "System Manager", "read": 1}], + "name": "Test Custom Doctype", + } + ) doc.insert() + def get_custom_doc_for_address_and_contacts(): get_custom_linked_doctype() - linked_doc = frappe.get_doc({ - "doctype": "Test Custom Doctype", - "test_field": "Hello", - }).insert() + linked_doc = frappe.get_doc( + { + "doctype": "Test Custom Doctype", + "test_field": "Hello", + } + ).insert() return linked_doc + def create_linked_address(link_list): if frappe.flags.test_address_created: return - address = frappe.get_doc({ - "doctype": "Address", - "address_title": "_Test Address", - "address_type": "Billing", - "address_line1": "test address line 1", - "address_line2": "test address line 2", - "city": "Milan", - "country": "Italy" - }) + address = frappe.get_doc( + { + "doctype": "Address", + "address_title": "_Test Address", + "address_type": "Billing", + "address_line1": "test address line 1", + "address_line2": "test address line 2", + "city": "Milan", + "country": "Italy", + } + ) for name in link_list: - address.append("links",{ - 'link_doctype': 'Test Custom Doctype', - 'link_name': name - }) + address.append("links", {"link_doctype": "Test Custom Doctype", "link_name": name}) address.insert() frappe.flags.test_address_created = True return address.name + def create_linked_contact(link_list, address): if frappe.flags.test_contact_created: return - contact = frappe.get_doc({ - "doctype": "Contact", - "salutation": "Mr", - "first_name": "_Test First Name", - "last_name": "_Test Last Name", - "is_primary_contact": 1, - "address": address, - "status": "Open" - }) + contact = frappe.get_doc( + { + "doctype": "Contact", + "salutation": "Mr", + "first_name": "_Test First Name", + "last_name": "_Test Last Name", + "is_primary_contact": 1, + "address": address, + "status": "Open", + } + ) contact.add_email("test_contact@example.com", is_primary=True) contact.add_phone("+91 0000000000", is_primary_phone=True) for name in link_list: - contact.append("links",{ - 'link_doctype': 'Test Custom Doctype', - 'link_name': name - }) + contact.append("links", {"link_doctype": "Test Custom Doctype", "link_name": name}) contact.insert(ignore_permissions=True) frappe.flags.test_contact_created = True @@ -103,7 +95,23 @@ class TestAddressesAndContacts(unittest.TestCase): create_linked_contact(links_list, d) report_data = get_data({"reference_doctype": "Test Custom Doctype"}) for idx, link in enumerate(links_list): - test_item = [link, 'test address line 1', 'test address line 2', 'Milan', None, None, 'Italy', 0, '_Test First Name', '_Test Last Name', '_Test Address-Billing', '+91 0000000000', '', 'test_contact@example.com', 1] + test_item = [ + link, + "test address line 1", + "test address line 2", + "Milan", + None, + None, + "Italy", + 0, + "_Test First Name", + "_Test Last Name", + "_Test Address-Billing", + "+91 0000000000", + "", + "test_contact@example.com", + 1, + ] self.assertListEqual(test_item, report_data[idx]) def tearDown(self): diff --git a/frappe/core/doctype/__init__.py b/frappe/core/doctype/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/core/doctype/__init__.py +++ b/frappe/core/doctype/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/core/doctype/access_log/access_log.py b/frappe/core/doctype/access_log/access_log.py index db2e64e868..b7a6d77206 100644 --- a/frappe/core/doctype/access_log/access_log.py +++ b/frappe/core/doctype/access_log/access_log.py @@ -1,9 +1,10 @@ # Copyright (c) 2021, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe -from frappe.utils import cstr from tenacity import retry, retry_if_exception_type, stop_after_attempt + +import frappe from frappe.model.document import Document +from frappe.utils import cstr class AccessLog(Document): @@ -22,14 +23,19 @@ def make_access_log( columns=None, ): _make_access_log( - doctype, document, method, file_type, report_name, filters, page, columns, + doctype, + document, + method, + file_type, + report_name, + filters, + page, + columns, ) @frappe.write_only() -@retry( - stop=stop_after_attempt(3), retry=retry_if_exception_type(frappe.DuplicateEntryError) -) +@retry(stop=stop_after_attempt(3), retry=retry_if_exception_type(frappe.DuplicateEntryError)) def _make_access_log( doctype=None, document=None, @@ -43,18 +49,20 @@ def _make_access_log( user = frappe.session.user in_request = frappe.request and frappe.request.method == "GET" - frappe.get_doc({ - "doctype": "Access Log", - "user": user, - "export_from": doctype, - "reference_document": document, - "file_type": file_type, - "report_name": report_name, - "page": page, - "method": method, - "filters": cstr(filters) or None, - "columns": columns, - }).db_insert() + frappe.get_doc( + { + "doctype": "Access Log", + "user": user, + "export_from": doctype, + "reference_document": document, + "file_type": file_type, + "report_name": report_name, + "page": page, + "method": method, + "filters": cstr(filters) or None, + "columns": columns, + } + ).db_insert() # `frappe.db.commit` added because insert doesnt `commit` when called in GET requests like `printview` # dont commit in test mode. It must be tempting to put this block along with the in_request in the diff --git a/frappe/core/doctype/access_log/test_access_log.py b/frappe/core/doctype/access_log/test_access_log.py index 42878d0eb4..983e3cb5e4 100644 --- a/frappe/core/doctype/access_log/test_access_log.py +++ b/frappe/core/doctype/access_log/test_access_log.py @@ -2,20 +2,21 @@ # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE -# imports - standard imports -import unittest import base64 import os +# imports - standard imports +import unittest + +# imports - third party imports +import requests + # imports - module imports import frappe from frappe.core.doctype.access_log.access_log import make_access_log -from frappe.utils import cstr, get_site_url from frappe.core.doctype.data_import.data_import import export_csv from frappe.core.doctype.user.user import generate_keys - -# imports - third party imports -import requests +from frappe.utils import cstr, get_site_url class TestAccessLog(unittest.TestCase): @@ -23,8 +24,9 @@ class TestAccessLog(unittest.TestCase): # generate keys for current user to send requests for the following tests generate_keys(frappe.session.user) frappe.db.commit() - generated_secret = frappe.utils.password.get_decrypted_password("User", - frappe.session.user, fieldname='api_secret') + generated_secret = frappe.utils.password.get_decrypted_password( + "User", frappe.session.user, fieldname="api_secret" + ) api_key = frappe.db.get_value("User", "Administrator", "api_key") self.header = {"Authorization": "token {}:{}".format(api_key, generated_secret)} @@ -101,54 +103,55 @@ class TestAccessLog(unittest.TestCase): "party": [], "group_by": "Group by Voucher (Consolidated)", "cost_center": [], - "project": [] + "project": [], } - self.test_doctype = 'File' - self.test_document = 'Test Document' - self.test_report_name = 'General Ledger' - self.test_file_type = 'CSV' - self.test_method = 'Test Method' - self.file_name = frappe.utils.random_string(10) + '.txt' + self.test_doctype = "File" + self.test_document = "Test Document" + self.test_report_name = "General Ledger" + self.test_file_type = "CSV" + self.test_method = "Test Method" + self.file_name = frappe.utils.random_string(10) + ".txt" self.test_content = frappe.utils.random_string(1024) - def test_make_full_access_log(self): self.maxDiff = None # test if all fields maintain data: html page and filters are converted? - make_access_log(doctype=self.test_doctype, + make_access_log( + doctype=self.test_doctype, document=self.test_document, report_name=self.test_report_name, page=self.test_html_template, file_type=self.test_file_type, method=self.test_method, - filters=self.test_filters) + filters=self.test_filters, + ) - last_doc = frappe.get_last_doc('Access Log') + last_doc = frappe.get_last_doc("Access Log") self.assertEqual(last_doc.filters, cstr(self.test_filters)) self.assertEqual(self.test_doctype, last_doc.export_from) self.assertEqual(self.test_document, last_doc.reference_document) - def test_make_export_log(self): # export data and delete temp file generated on disk export_csv(self.test_doctype, self.file_name) os.remove(self.file_name) # test if the exported data is logged - last_doc = frappe.get_last_doc('Access Log') + last_doc = frappe.get_last_doc("Access Log") self.assertEqual(self.test_doctype, last_doc.export_from) - def test_private_file_download(self): # create new private file - new_private_file = frappe.get_doc({ - 'doctype': self.test_doctype, - 'file_name': self.file_name, - 'content': base64.b64encode(self.test_content.encode('utf-8')), - 'is_private': 1, - }) + new_private_file = frappe.get_doc( + { + "doctype": self.test_doctype, + "file_name": self.file_name, + "content": base64.b64encode(self.test_content.encode("utf-8")), + "is_private": 1, + } + ) new_private_file.insert() # access the created file @@ -156,7 +159,7 @@ class TestAccessLog(unittest.TestCase): try: request = requests.post(private_file_link, headers=self.header) - last_doc = frappe.get_last_doc('Access Log') + last_doc = frappe.get_last_doc("Access Log") if request.ok: # check for the access log of downloaded file @@ -169,6 +172,5 @@ class TestAccessLog(unittest.TestCase): # cleanup new_private_file.delete() - def tearDown(self): pass diff --git a/frappe/core/doctype/activity_log/activity_log.py b/frappe/core/doctype/activity_log/activity_log.py index 70d4ca3ffe..84c908d0ae 100644 --- a/frappe/core/doctype/activity_log/activity_log.py +++ b/frappe/core/doctype/activity_log/activity_log.py @@ -26,20 +26,25 @@ class ActivityLog(Document): if self.reference_doctype and self.reference_name: self.status = "Linked" + def on_doctype_update(): """Add indexes in `tabActivity Log`""" frappe.db.add_index("Activity Log", ["reference_doctype", "reference_name"]) frappe.db.add_index("Activity Log", ["timeline_doctype", "timeline_name"]) frappe.db.add_index("Activity Log", ["link_doctype", "link_name"]) + def add_authentication_log(subject, user, operation="Login", status="Success"): - frappe.get_doc({ - "doctype": "Activity Log", - "user": user, - "status": status, - "subject": subject, - "operation": operation, - }).insert(ignore_permissions=True, ignore_links=True) + frappe.get_doc( + { + "doctype": "Activity Log", + "user": user, + "status": status, + "subject": subject, + "operation": operation, + } + ).insert(ignore_permissions=True, ignore_links=True) + def clear_activity_logs(days=None): """clear 90 day old authentication logs or configured in log settings""" @@ -47,6 +52,4 @@ def clear_activity_logs(days=None): if not days: days = 90 doctype = DocType("Activity Log") - frappe.db.delete(doctype, filters=( - doctype.creation < (Now() - Interval(days=days)) - )) + frappe.db.delete(doctype, filters=(doctype.creation < (Now() - Interval(days=days)))) diff --git a/frappe/core/doctype/activity_log/feed.py b/frappe/core/doctype/activity_log/feed.py index 358272ac63..3e29154242 100644 --- a/frappe/core/doctype/activity_log/feed.py +++ b/frappe/core/doctype/activity_log/feed.py @@ -3,15 +3,16 @@ import frappe import frappe.permissions -from frappe.utils import get_fullname from frappe import _ from frappe.core.doctype.activity_log.activity_log import add_authentication_log +from frappe.utils import get_fullname + def update_feed(doc, method=None): if frappe.flags.in_patch or frappe.flags.in_install or frappe.flags.in_import: return - if doc._action!="save" or doc.flags.ignore_feed: + if doc._action != "save" or doc.flags.ignore_feed: return if doc.doctype == "Activity Log" or doc.meta.issingle: @@ -29,65 +30,75 @@ def update_feed(doc, method=None): name = feed.name or doc.name # delete earlier feed - frappe.db.delete("Activity Log", { - "reference_doctype": doctype, - "reference_name": name, - "link_doctype": feed.link_doctype - }) - - frappe.get_doc({ - "doctype": "Activity Log", - "reference_doctype": doctype, - "reference_name": name, - "subject": feed.subject, - "full_name": get_fullname(doc.owner), - "reference_owner": frappe.db.get_value(doctype, name, "owner"), - "link_doctype": feed.link_doctype, - "link_name": feed.link_name - }).insert(ignore_permissions=True) + frappe.db.delete( + "Activity Log", + {"reference_doctype": doctype, "reference_name": name, "link_doctype": feed.link_doctype}, + ) + + frappe.get_doc( + { + "doctype": "Activity Log", + "reference_doctype": doctype, + "reference_name": name, + "subject": feed.subject, + "full_name": get_fullname(doc.owner), + "reference_owner": frappe.db.get_value(doctype, name, "owner"), + "link_doctype": feed.link_doctype, + "link_name": feed.link_name, + } + ).insert(ignore_permissions=True) + def login_feed(login_manager): if login_manager.user != "Guest": subject = _("{0} logged in").format(get_fullname(login_manager.user)) add_authentication_log(subject, login_manager.user) + def logout_feed(user, reason): if user and user != "Guest": subject = _("{0} logged out: {1}").format(get_fullname(user), frappe.bold(reason)) add_authentication_log(subject, user, operation="Logout") -def get_feed_match_conditions(user=None, doctype='Comment'): - if not user: user = frappe.session.user - conditions = ['`tab{doctype}`.owner={user} or `tab{doctype}`.reference_owner={user}'.format( - user = frappe.db.escape(user), - doctype = doctype - )] +def get_feed_match_conditions(user=None, doctype="Comment"): + if not user: + user = frappe.session.user + + conditions = [ + "`tab{doctype}`.owner={user} or `tab{doctype}`.reference_owner={user}".format( + user=frappe.db.escape(user), doctype=doctype + ) + ] user_permissions = frappe.permissions.get_user_permissions(user) can_read = frappe.get_user().get_can_read() - can_read_doctypes = ["'{}'".format(dt) for dt in - list(set(can_read) - set(list(user_permissions)))] + can_read_doctypes = [ + "'{}'".format(dt) for dt in list(set(can_read) - set(list(user_permissions))) + ] if can_read_doctypes: - conditions += ["""(`tab{doctype}`.reference_doctype is null + conditions += [ + """(`tab{doctype}`.reference_doctype is null or `tab{doctype}`.reference_doctype = '' or `tab{doctype}`.reference_doctype in ({values}))""".format( - doctype = doctype, - values =", ".join(can_read_doctypes) - )] + doctype=doctype, values=", ".join(can_read_doctypes) + ) + ] if user_permissions: can_read_docs = [] for dt, obj in user_permissions.items(): for n in obj: - can_read_docs.append('{}|{}'.format(frappe.db.escape(dt), frappe.db.escape(n.get('doc', '')))) + can_read_docs.append("{}|{}".format(frappe.db.escape(dt), frappe.db.escape(n.get("doc", "")))) if can_read_docs: - conditions.append("concat_ws('|', `tab{doctype}`.reference_doctype, `tab{doctype}`.reference_name) in ({values})".format( - doctype = doctype, - values = ", ".join(can_read_docs))) + conditions.append( + "concat_ws('|', `tab{doctype}`.reference_doctype, `tab{doctype}`.reference_name) in ({values})".format( + doctype=doctype, values=", ".join(can_read_docs) + ) + ) - return "(" + " or ".join(conditions) + ")" + return "(" + " or ".join(conditions) + ")" diff --git a/frappe/core/doctype/activity_log/test_activity_log.py b/frappe/core/doctype/activity_log/test_activity_log.py index 87d3538cc7..f5f94dc44b 100644 --- a/frappe/core/doctype/activity_log/test_activity_log.py +++ b/frappe/core/doctype/activity_log/test_activity_log.py @@ -1,77 +1,74 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe -import unittest import time -from frappe.auth import LoginManager, CookieManager +import unittest + +import frappe +from frappe.auth import CookieManager, LoginManager + class TestActivityLog(unittest.TestCase): def test_activity_log(self): # test user login log - frappe.local.form_dict = frappe._dict({ - 'cmd': 'login', - 'sid': 'Guest', - 'pwd': 'admin', - 'usr': 'Administrator' - }) + frappe.local.form_dict = frappe._dict( + {"cmd": "login", "sid": "Guest", "pwd": "admin", "usr": "Administrator"} + ) frappe.local.cookie_manager = CookieManager() frappe.local.login_manager = LoginManager() auth_log = self.get_auth_log() - self.assertEqual(auth_log.status, 'Success') + self.assertEqual(auth_log.status, "Success") # test user logout log frappe.local.login_manager.logout() - auth_log = self.get_auth_log(operation='Logout') - self.assertEqual(auth_log.status, 'Success') + auth_log = self.get_auth_log(operation="Logout") + self.assertEqual(auth_log.status, "Success") # test invalid login - frappe.form_dict.update({ 'pwd': 'password' }) + frappe.form_dict.update({"pwd": "password"}) self.assertRaises(frappe.AuthenticationError, LoginManager) auth_log = self.get_auth_log() - self.assertEqual(auth_log.status, 'Failed') + self.assertEqual(auth_log.status, "Failed") frappe.local.form_dict = frappe._dict() - def get_auth_log(self, operation='Login'): - names = frappe.db.get_all('Activity Log', filters={ - 'user': 'Administrator', - 'operation': operation, - }, order_by='`creation` DESC') + def get_auth_log(self, operation="Login"): + names = frappe.db.get_all( + "Activity Log", + filters={ + "user": "Administrator", + "operation": operation, + }, + order_by="`creation` DESC", + ) name = names[0] - auth_log = frappe.get_doc('Activity Log', name) + auth_log = frappe.get_doc("Activity Log", name) return auth_log def test_brute_security(self): - update_system_settings({ - 'allow_consecutive_login_attempts': 3, - 'allow_login_after_fail': 5 - }) - - frappe.local.form_dict = frappe._dict({ - 'cmd': 'login', - 'sid': 'Guest', - 'pwd': 'admin', - 'usr': 'Administrator' - }) + update_system_settings({"allow_consecutive_login_attempts": 3, "allow_login_after_fail": 5}) + + frappe.local.form_dict = frappe._dict( + {"cmd": "login", "sid": "Guest", "pwd": "admin", "usr": "Administrator"} + ) frappe.local.cookie_manager = CookieManager() frappe.local.login_manager = LoginManager() auth_log = self.get_auth_log() - self.assertEqual(auth_log.status, 'Success') + self.assertEqual(auth_log.status, "Success") # test user logout log frappe.local.login_manager.logout() - auth_log = self.get_auth_log(operation='Logout') - self.assertEqual(auth_log.status, 'Success') + auth_log = self.get_auth_log(operation="Logout") + self.assertEqual(auth_log.status, "Success") # test invalid login - frappe.form_dict.update({ 'pwd': 'password' }) + frappe.form_dict.update({"pwd": "password"}) self.assertRaises(frappe.AuthenticationError, LoginManager) self.assertRaises(frappe.AuthenticationError, LoginManager) self.assertRaises(frappe.AuthenticationError, LoginManager) @@ -85,8 +82,9 @@ class TestActivityLog(unittest.TestCase): frappe.local.form_dict = frappe._dict() + def update_system_settings(args): - doc = frappe.get_doc('System Settings') + doc = frappe.get_doc("System Settings") doc.update(args) doc.flags.ignore_mandatory = 1 doc.save() diff --git a/frappe/core/doctype/block_module/block_module.py b/frappe/core/doctype/block_module/block_module.py index cc6c222a04..3158e3e6a5 100644 --- a/frappe/core/doctype/block_module/block_module.py +++ b/frappe/core/doctype/block_module/block_module.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class BlockModule(Document): pass diff --git a/frappe/core/doctype/comment/comment.py b/frappe/core/doctype/comment/comment.py index e28d350d04..1456f1ec93 100644 --- a/frappe/core/doctype/comment/comment.py +++ b/frappe/core/doctype/comment/comment.py @@ -1,22 +1,27 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ -import json -from frappe.model.document import Document from frappe.core.doctype.user.user import extract_mentions -from frappe.desk.doctype.notification_log.notification_log import enqueue_create_notification,\ - get_title, get_title_html -from frappe.utils import get_fullname -from frappe.website.utils import clear_cache from frappe.database.schema import add_column +from frappe.desk.doctype.notification_log.notification_log import ( + enqueue_create_notification, + get_title, + get_title_html, +) from frappe.exceptions import ImplicitCommitError +from frappe.model.document import Document +from frappe.utils import get_fullname +from frappe.website.utils import clear_cache + class Comment(Document): def after_insert(self): self.notify_mentions() - self.notify_change('add') + self.notify_change("add") def validate(self): if not self.comment_email: @@ -26,34 +31,35 @@ class Comment(Document): def on_update(self): update_comment_in_doc(self) if self.is_new(): - self.notify_change('update') + self.notify_change("update") def on_trash(self): self.remove_comment_from_cache() - self.notify_change('delete') + self.notify_change("delete") def notify_change(self, action): key_map = { - 'Like': 'like_logs', - 'Assigned': 'assignment_logs', - 'Assignment Completed': 'assignment_logs', - 'Comment': 'comments', - 'Attachment': 'attachment_logs', - 'Attachment Removed': 'attachment_logs', + "Like": "like_logs", + "Assigned": "assignment_logs", + "Assignment Completed": "assignment_logs", + "Comment": "comments", + "Attachment": "attachment_logs", + "Attachment Removed": "attachment_logs", } key = key_map.get(self.comment_type) - if not key: return + if not key: + return - frappe.publish_realtime('update_docinfo_for_{}_{}'.format(self.reference_doctype, self.reference_name), { - 'doc': self.as_dict(), - 'key': key, - 'action': action - }, after_commit=True) + frappe.publish_realtime( + "update_docinfo_for_{}_{}".format(self.reference_doctype, self.reference_name), + {"doc": self.as_dict(), "key": key, "action": action}, + after_commit=True, + ) def remove_comment_from_cache(self): _comments = get_comments_from_parent(self) for c in _comments: - if c.get("name")==self.name: + if c.get("name") == self.name: _comments.remove(c) update_comments_in_parent(self.reference_doctype, self.reference_name, _comments) @@ -68,19 +74,26 @@ class Comment(Document): sender_fullname = get_fullname(frappe.session.user) title = get_title(self.reference_doctype, self.reference_name) - recipients = [frappe.db.get_value("User", {"enabled": 1, "name": name, "user_type": "System User", "allowed_in_mentions": 1}, "email") - for name in mentions] + recipients = [ + frappe.db.get_value( + "User", + {"enabled": 1, "name": name, "user_type": "System User", "allowed_in_mentions": 1}, + "email", + ) + for name in mentions + ] - notification_message = _('''{0} mentioned you in a comment in {1} {2}''')\ - .format(frappe.bold(sender_fullname), frappe.bold(self.reference_doctype), get_title_html(title)) + notification_message = _("""{0} mentioned you in a comment in {1} {2}""").format( + frappe.bold(sender_fullname), frappe.bold(self.reference_doctype), get_title_html(title) + ) notification_doc = { - 'type': 'Mention', - 'document_type': self.reference_doctype, - 'document_name': self.reference_name, - 'subject': notification_message, - 'from_user': frappe.session.user, - 'email_content': self.content + "type": "Mention", + "document_type": self.reference_doctype, + "document_name": self.reference_name, + "subject": notification_message, + "from_user": frappe.session.user, + "email_content": self.content, } enqueue_create_notification(recipients, notification_doc) @@ -99,45 +112,46 @@ def update_comment_in_doc(doc): `_comments` format - { - "comment": [String], - "by": [user], - "name": [Comment Document name] - }""" + { + "comment": [String], + "by": [user], + "name": [Comment Document name] + }""" # only comments get updates, not likes, assignments etc. - if doc.doctype == 'Comment' and doc.comment_type != 'Comment': + if doc.doctype == "Comment" and doc.comment_type != "Comment": return def get_truncated(content): - return (content[:97] + '...') if len(content) > 100 else content + return (content[:97] + "...") if len(content) > 100 else content if doc.reference_doctype and doc.reference_name and doc.content: _comments = get_comments_from_parent(doc) updated = False for c in _comments: - if c.get("name")==doc.name: + if c.get("name") == doc.name: c["comment"] = get_truncated(doc.content) updated = True if not updated: - _comments.append({ - "comment": get_truncated(doc.content), - - # "comment_email" for Comment and "sender" for Communication - "by": getattr(doc, 'comment_email', None) or getattr(doc, 'sender', None) or doc.owner, - "name": doc.name - }) + _comments.append( + { + "comment": get_truncated(doc.content), + # "comment_email" for Comment and "sender" for Communication + "by": getattr(doc, "comment_email", None) or getattr(doc, "sender", None) or doc.owner, + "name": doc.name, + } + ) update_comments_in_parent(doc.reference_doctype, doc.reference_name, _comments) def get_comments_from_parent(doc): - ''' + """ get the list of comments cached in the document record in the column `_comments` - ''' + """ try: _comments = frappe.db.get_value(doc.reference_doctype, doc.reference_name, "_comments") or "[]" @@ -153,23 +167,32 @@ def get_comments_from_parent(doc): except ValueError: return [] + def update_comments_in_parent(reference_doctype, reference_name, _comments): """Updates `_comments` property in parent Document with given dict. :param _comments: Dict of comments.""" - if not reference_doctype or not reference_name or frappe.db.get_value("DocType", reference_doctype, "issingle") or frappe.db.get_value("DocType", reference_doctype, "is_virtual"): + if ( + not reference_doctype + or not reference_name + or frappe.db.get_value("DocType", reference_doctype, "issingle") + or frappe.db.get_value("DocType", reference_doctype, "is_virtual") + ): return try: # use sql, so that we do not mess with the timestamp - frappe.db.sql("""update `tab{0}` set `_comments`=%s where name=%s""".format(reference_doctype), # nosec - (json.dumps(_comments[-100:]), reference_name)) + frappe.db.sql( + """update `tab{0}` set `_comments`=%s where name=%s""".format(reference_doctype), # nosec + (json.dumps(_comments[-100:]), reference_name), + ) except Exception as e: - if frappe.db.is_column_missing(e) and getattr(frappe.local, 'request', None): + if frappe.db.is_column_missing(e) and getattr(frappe.local, "request", None): # missing column and in request, add column and update after commit - frappe.local._comments = (getattr(frappe.local, "_comments", []) - + [(reference_doctype, reference_name, _comments)]) + frappe.local._comments = getattr(frappe.local, "_comments", []) + [ + (reference_doctype, reference_name, _comments) + ] elif frappe.db.is_data_too_long(e): raise frappe.DataTooLongException @@ -183,6 +206,7 @@ def update_comments_in_parent(reference_doctype, reference_name, _comments): if getattr(reference_doc, "route", None): clear_cache(reference_doc.route) + def update_comments_in_parent_after_request(): """update _comments in parent if _comments column is missing""" if hasattr(frappe.local, "_comments"): diff --git a/frappe/core/doctype/comment/test_comment.py b/frappe/core/doctype/comment/test_comment.py index 33672a7dea..3072f8b5b9 100644 --- a/frappe/core/doctype/comment/test_comment.py +++ b/frappe/core/doctype/comment/test_comment.py @@ -1,9 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe, json +import json import unittest +import frappe + + class TestComment(unittest.TestCase): def tearDown(self): frappe.form_dict.comment = None @@ -15,75 +18,88 @@ class TestComment(unittest.TestCase): frappe.local.request_ip = None def test_comment_creation(self): - test_doc = frappe.get_doc(dict(doctype = 'ToDo', description = 'test')) + test_doc = frappe.get_doc(dict(doctype="ToDo", description="test")) test_doc.insert() - comment = test_doc.add_comment('Comment', 'test comment') + comment = test_doc.add_comment("Comment", "test comment") test_doc.reload() # check if updated in _comments cache - comments = json.loads(test_doc.get('_comments')) - self.assertEqual(comments[0].get('name'), comment.name) - self.assertEqual(comments[0].get('comment'), comment.content) + comments = json.loads(test_doc.get("_comments")) + self.assertEqual(comments[0].get("name"), comment.name) + self.assertEqual(comments[0].get("comment"), comment.content) # check document creation - comment_1 = frappe.get_all('Comment', fields = ['*'], filters = dict( - reference_doctype = test_doc.doctype, - reference_name = test_doc.name - ))[0] + comment_1 = frappe.get_all( + "Comment", + fields=["*"], + filters=dict(reference_doctype=test_doc.doctype, reference_name=test_doc.name), + )[0] - self.assertEqual(comment_1.content, 'test comment') + self.assertEqual(comment_1.content, "test comment") # test via blog def test_public_comment(self): from frappe.website.doctype.blog_post.test_blog_post import make_test_blog + test_blog = make_test_blog() frappe.db.delete("Comment", {"reference_doctype": "Blog Post"}) from frappe.templates.includes.comments.comments import add_comment - frappe.form_dict.comment = 'Good comment with 10 chars' - frappe.form_dict.comment_email = 'test@test.com' - frappe.form_dict.comment_by = 'Good Tester' - frappe.form_dict.reference_doctype = 'Blog Post' + frappe.form_dict.comment = "Good comment with 10 chars" + frappe.form_dict.comment_email = "test@test.com" + frappe.form_dict.comment_by = "Good Tester" + frappe.form_dict.reference_doctype = "Blog Post" frappe.form_dict.reference_name = test_blog.name frappe.form_dict.route = test_blog.route - frappe.local.request_ip = '127.0.0.1' + frappe.local.request_ip = "127.0.0.1" add_comment() - self.assertEqual(frappe.get_all('Comment', fields = ['*'], filters = dict( - reference_doctype = test_blog.doctype, - reference_name = test_blog.name - ))[0].published, 1) + self.assertEqual( + frappe.get_all( + "Comment", + fields=["*"], + filters=dict(reference_doctype=test_blog.doctype, reference_name=test_blog.name), + )[0].published, + 1, + ) frappe.db.delete("Comment", {"reference_doctype": "Blog Post"}) - frappe.form_dict.comment = 'pleez vizits my site http://mysite.com' - frappe.form_dict.comment_by = 'bad commentor' + frappe.form_dict.comment = "pleez vizits my site http://mysite.com" + frappe.form_dict.comment_by = "bad commentor" add_comment() - self.assertEqual(len(frappe.get_all('Comment', fields = ['*'], filters = dict( - reference_doctype = test_blog.doctype, - reference_name = test_blog.name - ))), 0) + self.assertEqual( + len( + frappe.get_all( + "Comment", + fields=["*"], + filters=dict(reference_doctype=test_blog.doctype, reference_name=test_blog.name), + ) + ), + 0, + ) # test for filtering html and css injection elements frappe.db.delete("Comment", {"reference_doctype": "Blog Post"}) - frappe.form_dict.comment = 'Comment' - frappe.form_dict.comment_by = 'hacker' + frappe.form_dict.comment = "Comment" + frappe.form_dict.comment_by = "hacker" add_comment() - self.assertEqual(frappe.get_all('Comment', fields = ['content'], filters = dict( - reference_doctype = test_blog.doctype, - reference_name = test_blog.name - ))[0]['content'], 'Comment') + self.assertEqual( + frappe.get_all( + "Comment", + fields=["content"], + filters=dict(reference_doctype=test_blog.doctype, reference_name=test_blog.name), + )[0]["content"], + "Comment", + ) test_blog.delete() - - - diff --git a/frappe/core/doctype/communication/__init__.py b/frappe/core/doctype/communication/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/core/doctype/communication/__init__.py +++ b/frappe/core/doctype/communication/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/core/doctype/communication/communication.py b/frappe/core/doctype/communication/communication.py index 38fb0fd757..409c4c0956 100644 --- a/frappe/core/doctype/communication/communication.py +++ b/frappe/core/doctype/communication/communication.py @@ -2,49 +2,67 @@ # License: MIT. See LICENSE from collections import Counter +from email.utils import getaddresses from typing import List +from urllib.parse import unquote + +from parse import compile + import frappe from frappe import _ -from frappe.model.document import Document -from frappe.utils import validate_email_address, strip_html, cstr, time_diff_in_seconds +from frappe.automation.doctype.assignment_rule.assignment_rule import ( + apply as apply_assignment_rule, +) +from frappe.contacts.doctype.contact.contact import get_contact_name +from frappe.core.doctype.comment.comment import update_comment_in_doc from frappe.core.doctype.communication.email import validate_email from frappe.core.doctype.communication.mixins import CommunicationEmailMixin from frappe.core.utils import get_parent_doc -from frappe.utils import parse_addr, split_emails -from frappe.core.doctype.comment.comment import update_comment_in_doc -from email.utils import getaddresses -from urllib.parse import unquote +from frappe.model.document import Document +from frappe.utils import ( + cstr, + parse_addr, + split_emails, + strip_html, + time_diff_in_seconds, + validate_email_address, +) from frappe.utils.user import is_system_user -from frappe.contacts.doctype.contact.contact import get_contact_name -from frappe.automation.doctype.assignment_rule.assignment_rule import apply as apply_assignment_rule -from parse import compile exclude_from_linked_with = True + class Communication(Document, CommunicationEmailMixin): - """Communication represents an external communication like Email. - """ + """Communication represents an external communication like Email.""" + no_feed_on_delete = True - DOCTYPE = 'Communication' + DOCTYPE = "Communication" def onload(self): """create email flag queue""" - if self.communication_type == "Communication" and self.communication_medium == "Email" \ - and self.sent_or_received == "Received" and self.uid and self.uid != -1: - - email_flag_queue = frappe.db.get_value("Email Flag Queue", { - "communication": self.name, - "is_completed": 0}) + if ( + self.communication_type == "Communication" + and self.communication_medium == "Email" + and self.sent_or_received == "Received" + and self.uid + and self.uid != -1 + ): + + email_flag_queue = frappe.db.get_value( + "Email Flag Queue", {"communication": self.name, "is_completed": 0} + ) if email_flag_queue: return - frappe.get_doc({ - "doctype": "Email Flag Queue", - "action": "Read", - "communication": self.name, - "uid": self.uid, - "email_account": self.email_account - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Flag Queue", + "action": "Read", + "communication": self.name, + "uid": self.uid, + "email_account": self.email_account, + } + ).insert(ignore_permissions=True) frappe.db.commit() def validate(self): @@ -74,25 +92,33 @@ class Communication(Document, CommunicationEmailMixin): def validate_reference(self): if self.reference_doctype and self.reference_name: if not self.reference_owner: - self.reference_owner = frappe.db.get_value(self.reference_doctype, self.reference_name, "owner") + self.reference_owner = frappe.db.get_value( + self.reference_doctype, self.reference_name, "owner" + ) # prevent communication against a child table if frappe.get_meta(self.reference_doctype).istable: - frappe.throw(_("Cannot create a {0} against a child document: {1}") - .format(_(self.communication_type), _(self.reference_doctype))) + frappe.throw( + _("Cannot create a {0} against a child document: {1}").format( + _(self.communication_type), _(self.reference_doctype) + ) + ) # Prevent circular linking of Communication DocTypes if self.reference_doctype == "Communication": circular_linking = False doc = get_parent_doc(self) while doc.reference_doctype == "Communication": - if get_parent_doc(doc).name==self.name: + if get_parent_doc(doc).name == self.name: circular_linking = True break doc = get_parent_doc(doc) if circular_linking: - frappe.throw(_("Please make sure the Reference Communication Docs are not circularly linked."), frappe.CircularLinkingError) + frappe.throw( + _("Please make sure the Reference Communication Docs are not circularly linked."), + frappe.CircularLinkingError, + ) def after_insert(self): if not (self.reference_doctype and self.reference_name): @@ -102,21 +128,21 @@ class Communication(Document, CommunicationEmailMixin): frappe.db.set_value("Communication", self.reference_name, "status", "Replied") if self.communication_type == "Communication": - self.notify_change('add') + self.notify_change("add") elif self.communication_type in ("Chat", "Notification"): if self.reference_name == frappe.session.user: message = self.as_dict() - message['broadcast'] = True - frappe.publish_realtime('new_message', message, after_commit=True) + message["broadcast"] = True + frappe.publish_realtime("new_message", message, after_commit=True) else: # reference_name contains the user who is addressed in the messages' page comment - frappe.publish_realtime('new_message', self.as_dict(), - user=self.reference_name, after_commit=True) + frappe.publish_realtime( + "new_message", self.as_dict(), user=self.reference_name, after_commit=True + ) def set_signature_in_email_content(self): - """Set sender's User.email_signature or default outgoing's EmailAccount.signature to the email - """ + """Set sender's User.email_signature or default outgoing's EmailAccount.signature to the email""" if not self.content: return @@ -128,11 +154,15 @@ class Communication(Document, CommunicationEmailMixin): email_body = email_body[0] - user_email_signature = frappe.db.get_value( - "User", - self.sender, - "email_signature", - ) if self.sender else None + user_email_signature = ( + frappe.db.get_value( + "User", + self.sender, + "email_signature", + ) + if self.sender + else None + ) signature = user_email_signature or frappe.db.get_value( "Email Account", @@ -157,19 +187,19 @@ class Communication(Document, CommunicationEmailMixin): # comments count for the list view update_comment_in_doc(self) - if self.comment_type != 'Updated': + if self.comment_type != "Updated": update_parent_document_on_communication(self) def on_trash(self): if self.communication_type == "Communication": - self.notify_change('delete') + self.notify_change("delete") @property def sender_mailid(self): return parse_addr(self.sender)[1] if self.sender else "" @staticmethod - def _get_emails_list(emails=None, exclude_displayname = False): + def _get_emails_list(emails=None, exclude_displayname=False): """Returns list of emails from given email string. * Removes duplicate mailids @@ -180,35 +210,32 @@ class Communication(Document, CommunicationEmailMixin): return [email.lower() for email in set([parse_addr(email)[1] for email in emails]) if email] return [email.lower() for email in set(emails) if email] - def to_list(self, exclude_displayname = True): - """Returns to list. - """ + def to_list(self, exclude_displayname=True): + """Returns to list.""" return self._get_emails_list(self.recipients, exclude_displayname=exclude_displayname) - def cc_list(self, exclude_displayname = True): - """Returns cc list. - """ + def cc_list(self, exclude_displayname=True): + """Returns cc list.""" return self._get_emails_list(self.cc, exclude_displayname=exclude_displayname) - def bcc_list(self, exclude_displayname = True): - """Returns bcc list. - """ + def bcc_list(self, exclude_displayname=True): + """Returns bcc list.""" return self._get_emails_list(self.bcc, exclude_displayname=exclude_displayname) def get_attachments(self): attachments = frappe.get_all( "File", fields=["name", "file_name", "file_url", "is_private"], - filters = {"attached_to_name": self.name, "attached_to_doctype": self.DOCTYPE} + filters={"attached_to_name": self.name, "attached_to_doctype": self.DOCTYPE}, ) return attachments def notify_change(self, action): - frappe.publish_realtime('update_docinfo_for_{}_{}'.format(self.reference_doctype, self.reference_name), { - 'doc': self.as_dict(), - 'key': 'communications', - 'action': action - }, after_commit=True) + frappe.publish_realtime( + "update_docinfo_for_{}_{}".format(self.reference_doctype, self.reference_name), + {"doc": self.as_dict(), "key": "communications", "action": action}, + after_commit=True, + ) def set_status(self): if not self.is_new(): @@ -216,15 +243,19 @@ class Communication(Document, CommunicationEmailMixin): if self.reference_doctype and self.reference_name: self.status = "Linked" - elif self.communication_type=="Communication": + elif self.communication_type == "Communication": self.status = "Open" else: self.status = "Closed" # set email status to spam - email_rule = frappe.db.get_value("Email Rule", { "email_id": self.sender, "is_spam":1 }) - if self.communication_type == "Communication" and self.communication_medium == "Email" \ - and self.sent_or_received == "Sent" and email_rule: + email_rule = frappe.db.get_value("Email Rule", {"email_id": self.sender, "is_spam": 1}) + if ( + self.communication_type == "Communication" + and self.communication_medium == "Email" + and self.sent_or_received == "Sent" + and email_rule + ): self.email_status = "Spam" @@ -254,7 +285,7 @@ class Communication(Document, CommunicationEmailMixin): self.sender_full_name = self.sender self.sender = None else: - if self.sent_or_received=='Sent': + if self.sent_or_received == "Sent": validate_email_address(self.sender, throw=True) sender_name, sender_email = parse_addr(self.sender) if sender_name == sender_email: @@ -264,40 +295,41 @@ class Communication(Document, CommunicationEmailMixin): self.sender_full_name = sender_name if not self.sender_full_name: - self.sender_full_name = frappe.db.get_value('User', self.sender, 'full_name') + self.sender_full_name = frappe.db.get_value("User", self.sender, "full_name") if not self.sender_full_name: - first_name, last_name = frappe.db.get_value('Contact', - filters={'email_id': sender_email}, - fieldname=['first_name', 'last_name'] + first_name, last_name = frappe.db.get_value( + "Contact", filters={"email_id": sender_email}, fieldname=["first_name", "last_name"] ) or [None, None] - self.sender_full_name = (first_name or '') + (last_name or '') + self.sender_full_name = (first_name or "") + (last_name or "") if not self.sender_full_name: self.sender_full_name = sender_email def set_delivery_status(self, commit=False): - '''Look into the status of Email Queue linked to this Communication and set the Delivery Status of this Communication''' + """Look into the status of Email Queue linked to this Communication and set the Delivery Status of this Communication""" delivery_status = None - status_counts = Counter(frappe.get_all("Email Queue", pluck="status", filters={"communication": self.name})) + status_counts = Counter( + frappe.get_all("Email Queue", pluck="status", filters={"communication": self.name}) + ) if self.sent_or_received == "Received": return - if status_counts.get('Not Sent') or status_counts.get('Sending'): - delivery_status = 'Sending' + if status_counts.get("Not Sent") or status_counts.get("Sending"): + delivery_status = "Sending" - elif status_counts.get('Error'): - delivery_status = 'Error' + elif status_counts.get("Error"): + delivery_status = "Error" - elif status_counts.get('Expired'): - delivery_status = 'Expired' + elif status_counts.get("Expired"): + delivery_status = "Expired" - elif status_counts.get('Sent'): - delivery_status = 'Sent' + elif status_counts.get("Sent"): + delivery_status = "Sent" if delivery_status: - self.db_set('delivery_status', delivery_status) - self.notify_change('update') + self.db_set("delivery_status", delivery_status) + self.notify_change("update") # for list views and forms self.notify_update() @@ -311,13 +343,17 @@ class Communication(Document, CommunicationEmailMixin): # Timeline Links def set_timeline_links(self): contacts = [] - create_contact_enabled = self.email_account and frappe.db.get_value("Email Account", self.email_account, "create_contact") - contacts = get_contacts([self.sender, self.recipients, self.cc, self.bcc], auto_create_contact=create_contact_enabled) + create_contact_enabled = self.email_account and frappe.db.get_value( + "Email Account", self.email_account, "create_contact" + ) + contacts = get_contacts( + [self.sender, self.recipients, self.cc, self.bcc], auto_create_contact=create_contact_enabled + ) for contact_name in contacts: - self.add_link('Contact', contact_name) + self.add_link("Contact", contact_name) - #link contact's dynamic links to communication + # link contact's dynamic links to communication add_contact_links_to_communication(self, contact_name) def deduplicate_timeline_links(self): @@ -332,17 +368,12 @@ class Communication(Document, CommunicationEmailMixin): duplicate = True if duplicate: - del self.timeline_links[:] # make it python 2 compatible as list.clear() is python 3 only + del self.timeline_links[:] # make it python 2 compatible as list.clear() is python 3 only for l in links: self.add_link(link_doctype=l[0], link_name=l[1]) def add_link(self, link_doctype, link_name, autosave=False): - self.append("timeline_links", - { - "link_doctype": link_doctype, - "link_name": link_name - } - ) + self.append("timeline_links", {"link_doctype": link_doctype, "link_name": link_name}) if autosave: self.save(ignore_permissions=True) @@ -358,13 +389,15 @@ class Communication(Document, CommunicationEmailMixin): if autosave: self.save(ignore_permissions=ignore_permissions) + def on_doctype_update(): """Add indexes in `tabCommunication`""" frappe.db.add_index("Communication", ["reference_doctype", "reference_name"]) frappe.db.add_index("Communication", ["status", "communication_type"]) + def has_permission(doc, ptype, user): - if ptype=="read": + if ptype == "read": if doc.reference_doctype == "Communication" and doc.reference_name == doc.name: return @@ -372,24 +405,28 @@ def has_permission(doc, ptype, user): if frappe.has_permission(doc.reference_doctype, ptype="read", doc=doc.reference_name): return True + def get_permission_query_conditions_for_communication(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user roles = frappe.get_roles(user) if "Super Email User" in roles or "System Manager" in roles: return None else: - accounts = frappe.get_all("User Email", filters={ "parent": user }, - fields=["email_account"], - distinct=True, order_by="idx") + accounts = frappe.get_all( + "User Email", filters={"parent": user}, fields=["email_account"], distinct=True, order_by="idx" + ) if not accounts: return """`tabCommunication`.communication_medium!='Email'""" - email_accounts = [ '"%s"'%account.get("email_account") for account in accounts ] - return """`tabCommunication`.email_account in ({email_accounts})"""\ - .format(email_accounts=','.join(email_accounts)) + email_accounts = ['"%s"' % account.get("email_account") for account in accounts] + return """`tabCommunication`.email_account in ({email_accounts})""".format( + email_accounts=",".join(email_accounts) + ) + def get_contacts(email_strings: List[str], auto_create_contact=False) -> List[str]: email_addrs = get_emails(email_strings) @@ -403,12 +440,12 @@ def get_contacts(email_strings: List[str], auto_create_contact=False) -> List[st first_name = frappe.unscrub(email_parts[0]) try: - contact_name = '{0}-{1}'.format(first_name, email_parts[1]) if first_name == 'Contact' else first_name - contact = frappe.get_doc({ - "doctype": "Contact", - "first_name": contact_name, - "name": contact_name - }) + contact_name = ( + "{0}-{1}".format(first_name, email_parts[1]) if first_name == "Contact" else first_name + ) + contact = frappe.get_doc( + {"doctype": "Contact", "first_name": contact_name, "name": contact_name} + ) contact.add_email(email_id=email, is_primary=True) contact.insert(ignore_permissions=True) contact_name = contact.name @@ -421,6 +458,7 @@ def get_contacts(email_strings: List[str], auto_create_contact=False) -> List[st return contacts + def get_emails(email_strings: List[str]) -> List[str]: email_addrs = [] @@ -432,22 +470,25 @@ def get_emails(email_strings: List[str]) -> List[str]: return email_addrs + def add_contact_links_to_communication(communication, contact_name): - contact_links = frappe.get_all("Dynamic Link", filters={ - "parenttype": "Contact", - "parent": contact_name - }, fields=["link_doctype", "link_name"]) + contact_links = frappe.get_all( + "Dynamic Link", + filters={"parenttype": "Contact", "parent": contact_name}, + fields=["link_doctype", "link_name"], + ) if contact_links: for contact_link in contact_links: communication.add_link(contact_link.link_doctype, contact_link.link_name) + def parse_email(communication, email_strings): """ - Parse email to add timeline links. - When automatic email linking is enabled, an email from email_strings can contain - a doctype and docname ie in the format `admin+doctype+docname@example.com`, - the email is parsed and doctype and docname is extracted and timeline link is added. + Parse email to add timeline links. + When automatic email linking is enabled, an email from email_strings can contain + a doctype and docname ie in the format `admin+doctype+docname@example.com`, + the email is parsed and doctype and docname is extracted and timeline link is added. """ if not frappe.get_all("Email Account", filters={"enable_automatic_linking": 1}): return @@ -469,10 +510,11 @@ def parse_email(communication, email_strings): if doctype and docname and frappe.db.exists(doctype, docname): communication.add_link(doctype, docname) + def get_email_without_link(email): """ - returns email address without doctype links - returns admin@example.com for email admin+doctype+docname@example.com + returns email address without doctype links + returns admin@example.com for email admin+doctype+docname@example.com """ if not frappe.get_all("Email Account", filters={"enable_automatic_linking": 1}): return email @@ -486,6 +528,7 @@ def get_email_without_link(email): return "{0}@{1}".format(email_id, email_host) + def update_parent_document_on_communication(doc): """Update mins_to_first_communication of parent document based on who is replying.""" @@ -516,6 +559,7 @@ def update_parent_document_on_communication(doc): parent.run_method("notify_communication", doc) parent.notify_update() + def update_first_response_time(parent, communication): if parent.meta.has_field("first_response_time") and not parent.get("first_response_time"): if is_system_user(communication.sender): @@ -526,25 +570,29 @@ def update_first_response_time(parent, communication): first_response_time = round(time_diff_in_seconds(first_responded_on, parent.creation), 2) parent.db_set("first_response_time", first_response_time) + def set_avg_response_time(parent, communication): if parent.meta.has_field("avg_response_time") and communication.sent_or_received == "Sent": # avg response time for all the responses - communications = frappe.get_list("Communication", filters={ - "reference_doctype": parent.doctype, - "reference_name": parent.name - }, + communications = frappe.get_list( + "Communication", + filters={"reference_doctype": parent.doctype, "reference_name": parent.name}, fields=["sent_or_received", "name", "creation"], - order_by="creation" + order_by="creation", ) if len(communications): response_times = [] for i in range(len(communications)): - if communications[i].sent_or_received == "Sent" and communications[i-1].sent_or_received == "Received": - response_time = round(time_diff_in_seconds(communications[i].creation, communications[i-1].creation), 2) + if ( + communications[i].sent_or_received == "Sent" + and communications[i - 1].sent_or_received == "Received" + ): + response_time = round( + time_diff_in_seconds(communications[i].creation, communications[i - 1].creation), 2 + ) if response_time > 0: response_times.append(response_time) if response_times: avg_response_time = sum(response_times) / len(response_times) parent.db_set("avg_response_time", avg_response_time) - diff --git a/frappe/core/doctype/communication/email.py b/frappe/core/doctype/communication/email.py index b51749ccb7..5737572194 100755 --- a/frappe/core/doctype/communication/email.py +++ b/frappe/core/doctype/communication/email.py @@ -8,17 +8,25 @@ import frappe import frappe.email.smtp from frappe import _ from frappe.email.email_body import get_message_id -from frappe.utils import (cint, get_datetime, get_formatted_email, - list_to_str, split_emails, validate_email_address) +from frappe.utils import ( + cint, + get_datetime, + get_formatted_email, + list_to_str, + split_emails, + validate_email_address, +) if TYPE_CHECKING: from frappe.core.doctype.communication.communication import Communication -OUTGOING_EMAIL_ACCOUNT_MISSING = _(""" +OUTGOING_EMAIL_ACCOUNT_MISSING = _( + """ Unable to send mail because of a missing email account. Please setup default Email Account from Setup > Email > Email Account -""") +""" +) @frappe.whitelist() @@ -64,16 +72,15 @@ def make( """ if kwargs: from frappe.utils.commands import warn + warn( f"Options {kwargs} used in frappe.core.doctype.communication.email.make " "are deprecated or unsupported", - category=DeprecationWarning + category=DeprecationWarning, ) if doctype and name and not frappe.has_permission(doctype=doctype, ptype="email", doc=name): - raise frappe.PermissionError( - f"You are not allowed to send emails related to: {doctype} {name}" - ) + raise frappe.PermissionError(f"You are not allowed to send emails related to: {doctype} {name}") return _make( doctype=doctype, @@ -123,33 +130,34 @@ def _make( communication_type=None, add_signature=True, ) -> Dict[str, str]: - """Internal method to make a new communication that ignores Permission checks. - """ + """Internal method to make a new communication that ignores Permission checks.""" sender = sender or get_formatted_email(frappe.session.user) recipients = list_to_str(recipients) if isinstance(recipients, list) else recipients cc = list_to_str(cc) if isinstance(cc, list) else cc bcc = list_to_str(bcc) if isinstance(bcc, list) else bcc - comm: "Communication" = frappe.get_doc({ - "doctype":"Communication", - "subject": subject, - "content": content, - "sender": sender, - "sender_full_name":sender_full_name, - "recipients": recipients, - "cc": cc or None, - "bcc": bcc or None, - "communication_medium": communication_medium, - "sent_or_received": sent_or_received, - "reference_doctype": doctype, - "reference_name": name, - "email_template": email_template, - "message_id":get_message_id().strip(" <>"), - "read_receipt":read_receipt, - "has_attachment": 1 if attachments else 0, - "communication_type": communication_type, - }) + comm: "Communication" = frappe.get_doc( + { + "doctype": "Communication", + "subject": subject, + "content": content, + "sender": sender, + "sender_full_name": sender_full_name, + "recipients": recipients, + "cc": cc or None, + "bcc": bcc or None, + "communication_medium": communication_medium, + "sent_or_received": sent_or_received, + "reference_doctype": doctype, + "reference_name": name, + "email_template": email_template, + "message_id": get_message_id().strip(" <>"), + "read_receipt": read_receipt, + "has_attachment": 1 if attachments else 0, + "communication_type": communication_type, + } + ) comm.flags.skip_add_signature = not add_signature comm.insert(ignore_permissions=True) @@ -161,9 +169,7 @@ def _make( if cint(send_email): if not comm.get_outgoing_email_account(): - frappe.throw( - msg=OUTGOING_EMAIL_ACCOUNT_MISSING, exc=frappe.OutgoingEmailError - ) + frappe.throw(msg=OUTGOING_EMAIL_ACCOUNT_MISSING, exc=frappe.OutgoingEmailError) comm.send_email( print_html=print_html, @@ -179,7 +185,10 @@ def _make( def validate_email(doc: "Communication") -> None: """Validate Email Addresses of Recipients and CC""" - if not (doc.communication_type=="Communication" and doc.communication_medium == "Email") or doc.flags.in_receive: + if ( + not (doc.communication_type == "Communication" and doc.communication_medium == "Email") + or doc.flags.in_receive + ): return # validate recipients @@ -193,36 +202,45 @@ def validate_email(doc: "Communication") -> None: for email in split_emails(doc.bcc): validate_email_address(email, throw=True) + def set_incoming_outgoing_accounts(doc): from frappe.email.doctype.email_account.email_account import EmailAccount + incoming_email_account = EmailAccount.find_incoming( - match_by_email=doc.sender, match_by_doctype=doc.reference_doctype) + match_by_email=doc.sender, match_by_doctype=doc.reference_doctype + ) doc.incoming_email_account = incoming_email_account.email_id if incoming_email_account else None doc.outgoing_email_account = EmailAccount.find_outgoing( - match_by_email=doc.sender, match_by_doctype=doc.reference_doctype) + match_by_email=doc.sender, match_by_doctype=doc.reference_doctype + ) if doc.sent_or_received == "Sent": doc.db_set("email_account", doc.outgoing_email_account.name) + def add_attachments(name, attachments): - '''Add attachments to the given Communication''' + """Add attachments to the given Communication""" # loop through attachments for a in attachments: if isinstance(a, str): - attach = frappe.db.get_value("File", {"name":a}, - ["file_name", "file_url", "is_private"], as_dict=1) + attach = frappe.db.get_value( + "File", {"name": a}, ["file_name", "file_url", "is_private"], as_dict=1 + ) # save attachments to new doc - _file = frappe.get_doc({ - "doctype": "File", - "file_url": attach.file_url, - "attached_to_doctype": "Communication", - "attached_to_name": name, - "folder": "Home/Attachments", - "is_private": attach.is_private - }) + _file = frappe.get_doc( + { + "doctype": "File", + "file_url": attach.file_url, + "attached_to_doctype": "Communication", + "attached_to_name": name, + "folder": "Home/Attachments", + "is_private": attach.is_private, + } + ) _file.save(ignore_permissions=True) + @frappe.whitelist(allow_guest=True, methods=("GET",)) def mark_email_as_seen(name: str = None): try: @@ -233,33 +251,31 @@ def mark_email_as_seen(name: str = None): frappe.log_error(frappe.get_traceback()) finally: - frappe.response.update({ - "type": "binary", - "filename": "imaginary_pixel.png", - "filecontent": ( - b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00" - b"\x00\x01\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\r" - b"IDATx\x9cc\xf8\xff\xff?\x03\x00\x08\xfc\x02\xfe\xa7\x9a\xa0" - b"\xa0\x00\x00\x00\x00IEND\xaeB`\x82" - ) - }) + frappe.response.update( + { + "type": "binary", + "filename": "imaginary_pixel.png", + "filecontent": ( + b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00" + b"\x00\x01\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\r" + b"IDATx\x9cc\xf8\xff\xff?\x03\x00\x08\xfc\x02\xfe\xa7\x9a\xa0" + b"\xa0\x00\x00\x00\x00IEND\xaeB`\x82" + ), + } + ) + def update_communication_as_read(name): if not name or not isinstance(name, str): return - communication = frappe.db.get_value( - "Communication", - name, - "read_by_recipient", - as_dict=True - ) + communication = frappe.db.get_value("Communication", name, "read_by_recipient", as_dict=True) if not communication or communication.read_by_recipient: return - frappe.db.set_value("Communication", name, { - "read_by_recipient": 1, - "delivery_status": "Read", - "read_by_recipient_on": get_datetime() - }) + frappe.db.set_value( + "Communication", + name, + {"read_by_recipient": 1, "delivery_status": "Read", "read_by_recipient_on": get_datetime()}, + ) diff --git a/frappe/core/doctype/communication/mixins.py b/frappe/core/doctype/communication/mixins.py index dd9f58342e..68abba3c13 100644 --- a/frappe/core/doctype/communication/mixins.py +++ b/frappe/core/doctype/communication/mixins.py @@ -1,33 +1,34 @@ from typing import List + import frappe from frappe import _ from frappe.core.utils import get_parent_doc -from frappe.utils import parse_addr, get_formatted_email, get_url -from frappe.email.doctype.email_account.email_account import EmailAccount from frappe.desk.doctype.todo.todo import ToDo +from frappe.email.doctype.email_account.email_account import EmailAccount +from frappe.utils import get_formatted_email, get_url, parse_addr + class CommunicationEmailMixin: - """Mixin class to handle communication mails. - """ + """Mixin class to handle communication mails.""" + def is_email_communication(self): - return self.communication_type=="Communication" and self.communication_medium == "Email" + return self.communication_type == "Communication" and self.communication_medium == "Email" def get_owner(self): - """Get owner of the communication docs parent. - """ + """Get owner of the communication docs parent.""" parent_doc = get_parent_doc(self) return parent_doc.owner if parent_doc else None def get_all_email_addresses(self, exclude_displayname=False): - """Get all Email addresses mentioned in the doc along with display name. - """ - return self.to_list(exclude_displayname=exclude_displayname) + \ - self.cc_list(exclude_displayname=exclude_displayname) + \ - self.bcc_list(exclude_displayname=exclude_displayname) + """Get all Email addresses mentioned in the doc along with display name.""" + return ( + self.to_list(exclude_displayname=exclude_displayname) + + self.cc_list(exclude_displayname=exclude_displayname) + + self.bcc_list(exclude_displayname=exclude_displayname) + ) def get_email_with_displayname(self, email_address): - """Returns email address after adding displayname. - """ + """Returns email address after adding displayname.""" display_name, email = parse_addr(email_address) if display_name and display_name != email: return email_address @@ -37,26 +38,24 @@ class CommunicationEmailMixin: return email_map.get(email, email) def mail_recipients(self, is_inbound_mail_communcation=False): - """Build to(recipient) list to send an email. - """ + """Build to(recipient) list to send an email.""" # Incase of inbound mail, recipients already received the mail, no need to send again. if is_inbound_mail_communcation: return [] - if hasattr(self, '_final_recipients'): + if hasattr(self, "_final_recipients"): return self._final_recipients to = self.to_list() - self._final_recipients = list(filter(lambda id: id != 'Administrator', to)) + self._final_recipients = list(filter(lambda id: id != "Administrator", to)) return self._final_recipients def get_mail_recipients_with_displayname(self, is_inbound_mail_communcation=False): - """Build to(recipient) list to send an email including displayname in email. - """ + """Build to(recipient) list to send an email including displayname in email.""" to_list = self.mail_recipients(is_inbound_mail_communcation=is_inbound_mail_communcation) return [self.get_email_with_displayname(email) for email in to_list] - def mail_cc(self, is_inbound_mail_communcation=False, include_sender = False): + def mail_cc(self, is_inbound_mail_communcation=False, include_sender=False): """Build cc list to send an email. * if email copy is requested by sender, then add sender to CC. @@ -67,7 +66,7 @@ class CommunicationEmailMixin: * FixMe: Removed adding TODO owners to cc list. Check if that is needed. """ - if hasattr(self, '_final_cc'): + if hasattr(self, "_final_cc"): return self._final_cc cc = self.cc_list() @@ -88,11 +87,13 @@ class CommunicationEmailMixin: if is_inbound_mail_communcation: cc = cc - set(self.cc_list() + self.to_list()) - self._final_cc = list(filter(lambda id: id != 'Administrator', cc)) + self._final_cc = list(filter(lambda id: id != "Administrator", cc)) return self._final_cc - def get_mail_cc_with_displayname(self, is_inbound_mail_communcation=False, include_sender = False): - cc_list = self.mail_cc(is_inbound_mail_communcation=is_inbound_mail_communcation, include_sender = include_sender) + def get_mail_cc_with_displayname(self, is_inbound_mail_communcation=False, include_sender=False): + cc_list = self.mail_cc( + is_inbound_mail_communcation=is_inbound_mail_communcation, include_sender=include_sender + ) return [self.get_email_with_displayname(email) for email in cc_list] def mail_bcc(self, is_inbound_mail_communcation=False): @@ -102,7 +103,7 @@ class CommunicationEmailMixin: * User must be enabled in the system * remove_administrator_from_email_list """ - if hasattr(self, '_final_bcc'): + if hasattr(self, "_final_bcc"): return self._final_bcc bcc = set(self.bcc_list()) @@ -116,7 +117,7 @@ class CommunicationEmailMixin: if is_inbound_mail_communcation: bcc = bcc - set(self.bcc_list() + self.to_list()) - self._final_bcc = list(filter(lambda id: id != 'Administrator', bcc)) + self._final_bcc = list(filter(lambda id: id != "Administrator", bcc)) return self._final_bcc def get_mail_bcc_with_displayname(self, is_inbound_mail_communcation=False): @@ -145,22 +146,23 @@ class CommunicationEmailMixin: def get_attach_link(self, print_format): """Returns public link for the attachment via `templates/emails/print_link.html`.""" - return frappe.get_template("templates/emails/print_link.html").render({ - "url": get_url(), - "doctype": self.reference_doctype, - "name": self.reference_name, - "print_format": print_format, - "key": get_parent_doc(self).get_signature() - }) + return frappe.get_template("templates/emails/print_link.html").render( + { + "url": get_url(), + "doctype": self.reference_doctype, + "name": self.reference_name, + "print_format": print_format, + "key": get_parent_doc(self).get_signature(), + } + ) def get_outgoing_email_account(self): - if not hasattr(self, '_outgoing_email_account'): + if not hasattr(self, "_outgoing_email_account"): if self.email_account: self._outgoing_email_account = EmailAccount.find(self.email_account) else: self._outgoing_email_account = EmailAccount.find_outgoing( - match_by_email=self.sender_mailid, - match_by_doctype=self.reference_doctype + match_by_email=self.sender_mailid, match_by_doctype=self.reference_doctype ) if self.sent_or_received == "Sent" and self._outgoing_email_account: @@ -169,10 +171,9 @@ class CommunicationEmailMixin: return self._outgoing_email_account def get_incoming_email_account(self): - if not hasattr(self, '_incoming_email_account'): + if not hasattr(self, "_incoming_email_account"): self._incoming_email_account = EmailAccount.find_incoming( - match_by_email=self.sender_mailid, - match_by_doctype=self.reference_doctype + match_by_email=self.sender_mailid, match_by_doctype=self.reference_doctype ) return self._incoming_email_account @@ -180,12 +181,17 @@ class CommunicationEmailMixin: final_attachments = [] if print_format or print_html: - d = {'print_format': print_format, 'html': print_html, 'print_format_attachment': 1, - 'doctype': self.reference_doctype, 'name': self.reference_name} + d = { + "print_format": print_format, + "html": print_html, + "print_format_attachment": 1, + "doctype": self.reference_doctype, + "name": self.reference_name, + } final_attachments.append(d) for a in self.get_attachments() or []: - final_attachments.append({"fid": a['name']}) + final_attachments.append({"fid": a["name"]}) return final_attachments @@ -193,48 +199,57 @@ class CommunicationEmailMixin: email_account = self.get_outgoing_email_account() if email_account and email_account.send_unsubscribe_message: return _("Leave this conversation") - return '' + return "" def exclude_emails_list(self, is_inbound_mail_communcation=False, include_sender=False) -> List: - """List of mail id's excluded while sending mail. - """ + """List of mail id's excluded while sending mail.""" all_ids = self.get_all_email_addresses(exclude_displayname=True) final_ids = ( self.mail_recipients(is_inbound_mail_communcation=is_inbound_mail_communcation) + self.mail_bcc(is_inbound_mail_communcation=is_inbound_mail_communcation) - + self.mail_cc(is_inbound_mail_communcation=is_inbound_mail_communcation, include_sender=include_sender) + + self.mail_cc( + is_inbound_mail_communcation=is_inbound_mail_communcation, include_sender=include_sender + ) ) return list(set(all_ids) - set(final_ids)) def get_assignees(self): - """Get owners of the reference document. - """ - filters = {'status': 'Open', 'reference_name': self.reference_name, - 'reference_type': self.reference_doctype} + """Get owners of the reference document.""" + filters = { + "status": "Open", + "reference_name": self.reference_name, + "reference_type": self.reference_doctype, + } return ToDo.get_owners(filters) @staticmethod def filter_thread_notification_disbled_users(emails): - """Filter users based on notifications for email threads setting is disabled. - """ + """Filter users based on notifications for email threads setting is disabled.""" if not emails: return [] - return frappe.get_all("User", pluck="email", filters={"email": ["in", emails], "thread_notify": 0}) + return frappe.get_all( + "User", pluck="email", filters={"email": ["in", emails], "thread_notify": 0} + ) @staticmethod def filter_disabled_users(emails): - """ - """ + """ """ if not emails: return [] return frappe.get_all("User", pluck="email", filters={"email": ["in", emails], "enabled": 0}) - def sendmail_input_dict(self, print_html=None, print_format=None, - send_me_a_copy=None, print_letterhead=None, is_inbound_mail_communcation=None): + def sendmail_input_dict( + self, + print_html=None, + print_format=None, + send_me_a_copy=None, + print_letterhead=None, + is_inbound_mail_communcation=None, + ): outgoing_email_account = self.get_outgoing_email_account() if not outgoing_email_account: @@ -244,8 +259,7 @@ class CommunicationEmailMixin: is_inbound_mail_communcation=is_inbound_mail_communcation ) cc = self.get_mail_cc_with_displayname( - is_inbound_mail_communcation=is_inbound_mail_communcation, - include_sender = send_me_a_copy + is_inbound_mail_communcation=is_inbound_mail_communcation, include_sender=send_me_a_copy ) bcc = self.get_mail_bcc_with_displayname( is_inbound_mail_communcation=is_inbound_mail_communcation @@ -273,18 +287,24 @@ class CommunicationEmailMixin: "delayed": True, "communication": self.name, "read_receipt": self.read_receipt, - "is_notification": (self.sent_or_received =="Received" and True) or False, - "print_letterhead": print_letterhead + "is_notification": (self.sent_or_received == "Received" and True) or False, + "print_letterhead": print_letterhead, } - def send_email(self, print_html=None, print_format=None, - send_me_a_copy=None, print_letterhead=None, is_inbound_mail_communcation=None): + def send_email( + self, + print_html=None, + print_format=None, + send_me_a_copy=None, + print_letterhead=None, + is_inbound_mail_communcation=None, + ): input_dict = self.sendmail_input_dict( print_html=print_html, print_format=print_format, send_me_a_copy=send_me_a_copy, print_letterhead=print_letterhead, - is_inbound_mail_communcation=is_inbound_mail_communcation + is_inbound_mail_communcation=is_inbound_mail_communcation, ) if input_dict: diff --git a/frappe/core/doctype/communication/test_communication.py b/frappe/core/doctype/communication/test_communication.py index 8012d8facf..a338295374 100644 --- a/frappe/core/doctype/communication/test_communication.py +++ b/frappe/core/doctype/communication/test_communication.py @@ -7,20 +7,30 @@ import frappe from frappe.core.doctype.communication.communication import get_emails from frappe.email.doctype.email_queue.email_queue import EmailQueue -test_records = frappe.get_test_records('Communication') +test_records = frappe.get_test_records("Communication") -class TestCommunication(unittest.TestCase): +class TestCommunication(unittest.TestCase): def test_email(self): - valid_email_list = ["Full Name
" * 2 + _("Only Options allowed for Data field are:") + "
" + text_str = ( + _("{0} is an invalid Data field.").format(df_str) + + "
" * 2 + + _("Only Options allowed for Data field are:") + + "
" + ) df_options_str = "
- " + "
- ".join(_(x) for x in data_field_options) + "
'
- }).insert()
+ todo = frappe.get_doc(
+ {
+ "doctype": "ToDo",
+ "description": 'Test ',
+ }
+ ).insert()
self.assertTrue(frappe.db.exists("File", {"attached_to_name": todo.name}))
self.assertIn('
', todo.description)
- self.assertListEqual(get_attached_images('ToDo', [todo.name])[todo.name], ['/files/pix.png'])
+ self.assertListEqual(get_attached_images("ToDo", [todo.name])[todo.name], ["/files/pix.png"])
# without filename in data URI
- todo = frappe.get_doc({
- "doctype": "ToDo",
- "description": 'Test 
'
- }).insert()
+ todo = frappe.get_doc(
+ {
+ "doctype": "ToDo",
+ "description": 'Test ',
+ }
+ ).insert()
filename = frappe.db.exists("File", {"attached_to_name": todo.name})
self.assertIn(f'
Testing comment,
@@ -191,9 +210,9 @@ class TestUser(unittest.TestCase):
please check
- '''
+ """
self.assertEqual(extract_mentions(comment)[0], "test.comment@example.com")
- comment = '''
+ comment = """
Testing comment for
@@ -205,24 +224,22 @@ class TestUser(unittest.TestCase):
please check
- '''
+ """
self.assertEqual(extract_mentions(comment)[0], "test_user@example.com")
self.assertEqual(extract_mentions(comment)[1], "test.again@example1.com")
frappe.delete_doc("User Group", "Team")
- doc = frappe.get_doc({
- 'doctype': 'User Group',
- 'name': 'Team',
- 'user_group_members': [{
- 'user': 'test@example.com'
- }, {
- 'user': 'test1@example.com'
- }]
- })
+ doc = frappe.get_doc(
+ {
+ "doctype": "User Group",
+ "name": "Team",
+ "user_group_members": [{"user": "test@example.com"}, {"user": "test1@example.com"}],
+ }
+ )
doc.insert()
- comment = '''
+ comment = """
Testing comment for
@@ -233,8 +250,8 @@ class TestUser(unittest.TestCase):
please check
- '''
- self.assertListEqual(extract_mentions(comment), ['test@example.com', 'test1@example.com'])
+ """
+ self.assertListEqual(extract_mentions(comment), ["test@example.com", "test1@example.com"])
def test_rate_limiting_for_reset_password(self):
# Allow only one reset request for a day
@@ -242,7 +259,7 @@ class TestUser(unittest.TestCase):
frappe.db.commit()
url = get_url()
- data={'cmd': 'frappe.core.doctype.user.user.reset_password', 'user': 'test@test.com'}
+ data = {"cmd": "frappe.core.doctype.user.user.reset_password", "user": "test@test.com"}
# Clear rate limit tracker to start fresh
key = f"rl:{data['cmd']}:{data['user']}"
@@ -257,56 +274,73 @@ class TestUser(unittest.TestCase):
def test_user_rename(self):
old_name = "test_user_rename@example.com"
new_name = "test_user_rename_new@example.com"
- user = frappe.get_doc({
- "doctype": "User",
- "email": old_name,
- "enabled": 1,
- "first_name": "_Test",
- "new_password": "Eastern_43A1W",
- "roles": [
- {
- "doctype": "Has Role",
- "parentfield": "roles",
- "role": "System Manager"
- }]
- }).insert(ignore_permissions=True, ignore_if_duplicate=True)
-
- frappe.rename_doc('User', user.name, new_name)
+ user = frappe.get_doc(
+ {
+ "doctype": "User",
+ "email": old_name,
+ "enabled": 1,
+ "first_name": "_Test",
+ "new_password": "Eastern_43A1W",
+ "roles": [{"doctype": "Has Role", "parentfield": "roles", "role": "System Manager"}],
+ }
+ ).insert(ignore_permissions=True, ignore_if_duplicate=True)
+
+ frappe.rename_doc("User", user.name, new_name)
self.assertTrue(frappe.db.exists("Notification Settings", new_name))
frappe.delete_doc("User", new_name)
def test_signup(self):
import frappe.website.utils
- random_user = frappe.mock('email')
- random_user_name = frappe.mock('name')
+
+ random_user = frappe.mock("email")
+ random_user_name = frappe.mock("name")
# disabled signup
with patch.object(user_module, "is_signup_disabled", return_value=True):
- self.assertRaisesRegex(frappe.exceptions.ValidationError, "Sign Up is disabled",
- sign_up, random_user, random_user_name, "/signup")
+ self.assertRaisesRegex(
+ frappe.exceptions.ValidationError,
+ "Sign Up is disabled",
+ sign_up,
+ random_user,
+ random_user_name,
+ "/signup",
+ )
- self.assertTupleEqual(sign_up(random_user, random_user_name, "/welcome"), (1, "Please check your email for verification"))
- self.assertEqual(frappe.cache().hget('redirect_after_login', random_user), "/welcome")
+ self.assertTupleEqual(
+ sign_up(random_user, random_user_name, "/welcome"),
+ (1, "Please check your email for verification"),
+ )
+ self.assertEqual(frappe.cache().hget("redirect_after_login", random_user), "/welcome")
# re-register
- self.assertTupleEqual(sign_up(random_user, random_user_name, "/welcome"), (0, "Already Registered"))
+ self.assertTupleEqual(
+ sign_up(random_user, random_user_name, "/welcome"), (0, "Already Registered")
+ )
# disabled user
user = frappe.get_doc("User", random_user)
user.enabled = 0
user.save()
- self.assertTupleEqual(sign_up(random_user, random_user_name, "/welcome"), (0, "Registered but disabled"))
+ self.assertTupleEqual(
+ sign_up(random_user, random_user_name, "/welcome"), (0, "Registered but disabled")
+ )
# throttle user creation
with patch.object(user_module.frappe.db, "get_creation_count", return_value=301):
- self.assertRaisesRegex(frappe.exceptions.ValidationError, "Throttled",
- sign_up, frappe.mock('email'), random_user_name, "/signup")
-
+ self.assertRaisesRegex(
+ frappe.exceptions.ValidationError,
+ "Throttled",
+ sign_up,
+ frappe.mock("email"),
+ random_user_name,
+ "/signup",
+ )
def test_reset_password(self):
from frappe.auth import CookieManager, LoginManager
from frappe.utils import set_request
+
old_password = "Eastern_43A1W"
new_password = "easy_password"
@@ -318,7 +352,10 @@ class TestUser(unittest.TestCase):
test_user = frappe.get_doc("User", "testpassword@example.com")
test_user.reset_password()
self.assertEqual(update_password(new_password, key=test_user.reset_password_key), "/app")
- self.assertEqual(update_password(new_password, key="wrong_key"), "The Link specified has either been used before or Invalid")
+ self.assertEqual(
+ update_password(new_password, key="wrong_key"),
+ "The Link specified has either been used before or Invalid",
+ )
# password verification should fail with old password
self.assertRaises(frappe.exceptions.AuthenticationError, verify_password, old_password)
@@ -327,19 +364,26 @@ class TestUser(unittest.TestCase):
# reset password
update_password(old_password, old_password=new_password)
- self.assertRaisesRegex(frappe.exceptions.ValidationError, "Invalid key type", update_password, "test", 1, ['like', '%'])
+ self.assertRaisesRegex(
+ frappe.exceptions.ValidationError, "Invalid key type", update_password, "test", 1, ["like", "%"]
+ )
password_strength_response = {
- "feedback": {
- "password_policy_validation_passed": False,
- "suggestions": ["Fix password"]
- }
+ "feedback": {"password_policy_validation_passed": False, "suggestions": ["Fix password"]}
}
# password strength failure test
- with patch.object(user_module, "test_password_strength", return_value=password_strength_response):
- self.assertRaisesRegex(frappe.exceptions.ValidationError, "Fix password", update_password, new_password, 0, test_user.reset_password_key)
-
+ with patch.object(
+ user_module, "test_password_strength", return_value=password_strength_response
+ ):
+ self.assertRaisesRegex(
+ frappe.exceptions.ValidationError,
+ "Fix password",
+ update_password,
+ new_password,
+ 0,
+ test_user.reset_password_key,
+ )
# test redirect URL for website users
frappe.set_user("test2@example.com")
@@ -348,7 +392,7 @@ class TestUser(unittest.TestCase):
update_password(old_password, old_password=new_password)
# test API endpoint
- with patch.object(user_module.frappe, 'sendmail') as sendmail:
+ with patch.object(user_module.frappe, "sendmail") as sendmail:
frappe.clear_messages()
test_user = frappe.get_doc("User", "test2@example.com")
self.assertEqual(reset_password(user="test2@example.com"), None)
@@ -357,7 +401,7 @@ class TestUser(unittest.TestCase):
update_password(old_password, old_password=new_password)
self.assertEqual(
json.loads(frappe.message_log[0]).get("message"),
- "Password reset instructions have been sent to your email"
+ "Password reset instructions have been sent to your email",
)
sendmail.assert_called_once()
@@ -370,11 +414,14 @@ class TestUser(unittest.TestCase):
def test_user_onload_modules(self):
from frappe.config import get_modules_from_all_apps
from frappe.desk.form.load import getdoc
+
frappe.response.docs = []
getdoc("User", "Administrator")
doc = frappe.response.docs[0]
- self.assertListEqual(doc.get("__onload").get('all_modules', []),
- [m.get("module_name") for m in get_modules_from_all_apps()])
+ self.assertListEqual(
+ doc.get("__onload").get("all_modules", []),
+ [m.get("module_name") for m in get_modules_from_all_apps()],
+ )
def delete_contact(user):
diff --git a/frappe/core/doctype/user/user.py b/frappe/core/doctype/user/user.py
index 1ad977547c..c90cbf1fce 100644
--- a/frappe/core/doctype/user/user.py
+++ b/frappe/core/doctype/user/user.py
@@ -1,32 +1,46 @@
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
from bs4 import BeautifulSoup
+
import frappe
-import frappe.share
import frappe.defaults
import frappe.permissions
-from frappe.model.document import Document
-from frappe.utils import (cint, flt, has_gravatar, escape_html, format_datetime,
- now_datetime, get_formatted_email, today, get_time_zone)
-from frappe import throw, msgprint, _
-from frappe.utils.password import update_password as _update_password, check_password, get_password_reset_limit
+import frappe.share
+from frappe import _, msgprint, throw
+from frappe.core.doctype.user_type.user_type import user_linked_with_permission_on_doctype
+from frappe.desk.doctype.notification_settings.notification_settings import (
+ create_notification_settings,
+ toggle_notifications,
+)
from frappe.desk.notifications import clear_notifications
-from frappe.desk.doctype.notification_settings.notification_settings import create_notification_settings, toggle_notifications
+from frappe.model.document import Document
+from frappe.query_builder import DocType
+from frappe.rate_limiter import rate_limit
+from frappe.utils import (
+ cint,
+ escape_html,
+ flt,
+ format_datetime,
+ get_formatted_email,
+ get_time_zone,
+ has_gravatar,
+ now_datetime,
+ today,
+)
+from frappe.utils.password import check_password, get_password_reset_limit
+from frappe.utils.password import update_password as _update_password
from frappe.utils.user import get_system_managers
from frappe.website.utils import is_signup_disabled
-from frappe.rate_limiter import rate_limit
-from frappe.core.doctype.user_type.user_type import user_linked_with_permission_on_doctype
-from frappe.query_builder import DocType
-
STANDARD_USERS = frappe.STANDARD_USERS
+
class User(Document):
__new_password = None
def __setup__(self):
# because it is handled separately
- self.flags.ignore_save_passwords = ['new_password']
+ self.flags.ignore_save_passwords = ["new_password"]
def autoname(self):
"""set name as Email Address"""
@@ -38,8 +52,8 @@ class User(Document):
def onload(self):
from frappe.config import get_modules_from_all_apps
- self.set_onload('all_modules',
- [m.get("module_name") for m in get_modules_from_all_apps()])
+
+ self.set_onload("all_modules", [m.get("module_name") for m in get_modules_from_all_apps()])
def before_insert(self):
self.flags.in_insert = True
@@ -47,8 +61,8 @@ class User(Document):
def after_insert(self):
create_notification_settings(self.name)
- frappe.cache().delete_key('users_for_mentions')
- frappe.cache().delete_key('enabled_users')
+ frappe.cache().delete_key("users_for_mentions")
+ frappe.cache().delete_key("enabled_users")
def validate(self):
# clear new password
@@ -79,23 +93,23 @@ class User(Document):
if self.language == "Loading...":
self.language = None
- if (self.name not in ["Administrator", "Guest"]) and (not self.get_social_login_userid("frappe")):
+ if (self.name not in ["Administrator", "Guest"]) and (
+ not self.get_social_login_userid("frappe")
+ ):
self.set_social_login_userid("frappe", frappe.generate_hash(length=39))
def validate_roles(self):
if self.role_profile_name:
- role_profile = frappe.get_doc('Role Profile', self.role_profile_name)
- self.set('roles', [])
+ role_profile = frappe.get_doc("Role Profile", self.role_profile_name)
+ self.set("roles", [])
self.append_roles(*[role.role for role in role_profile.roles])
def validate_allowed_modules(self):
if self.module_profile:
- module_profile = frappe.get_doc('Module Profile', self.module_profile)
- self.set('block_modules', [])
- for d in module_profile.get('block_modules'):
- self.append('block_modules', {
- 'module': d.module
- })
+ module_profile = frappe.get_doc("Module Profile", self.module_profile)
+ self.set("block_modules", [])
+ for d in module_profile.get("block_modules"):
+ self.append("block_modules", {"module": d.module})
def validate_user_image(self):
if self.user_image and len(self.user_image) > 2000:
@@ -106,26 +120,23 @@ class User(Document):
self.share_with_self()
clear_notifications(user=self.name)
frappe.clear_cache(user=self.name)
- now=frappe.flags.in_test or frappe.flags.in_install
+ now = frappe.flags.in_test or frappe.flags.in_install
self.send_password_notification(self.__new_password)
frappe.enqueue(
- 'frappe.core.doctype.user.user.create_contact',
- user=self,
- ignore_mandatory=True,
- now=now
+ "frappe.core.doctype.user.user.create_contact", user=self, ignore_mandatory=True, now=now
)
- if self.name not in ('Administrator', 'Guest') and not self.user_image:
- frappe.enqueue('frappe.core.doctype.user.user.update_gravatar', name=self.name, now=now)
+ if self.name not in ("Administrator", "Guest") and not self.user_image:
+ frappe.enqueue("frappe.core.doctype.user.user.update_gravatar", name=self.name, now=now)
# Set user selected timezone
if self.time_zone:
frappe.defaults.set_default("time_zone", self.time_zone, self.name)
- if self.has_value_changed('allow_in_mentions') or self.has_value_changed('user_type'):
- frappe.cache().delete_key('users_for_mentions')
+ if self.has_value_changed("allow_in_mentions") or self.has_value_changed("user_type"):
+ frappe.cache().delete_key("users_for_mentions")
- if self.has_value_changed('enabled'):
- frappe.cache().delete_key('enabled_users')
+ if self.has_value_changed("enabled"):
+ frappe.cache().delete_key("enabled_users")
def has_website_permission(self, ptype, user, verbose=False):
"""Returns true if current user is the session user"""
@@ -151,65 +162,60 @@ class User(Document):
def add_system_manager_role(self):
# if adding system manager, do nothing
- if not cint(self.enabled) or ("System Manager" in [user_role.role for user_role in
- self.get("roles")]):
+ if not cint(self.enabled) or (
+ "System Manager" in [user_role.role for user_role in self.get("roles")]
+ ):
return
- if (self.name not in STANDARD_USERS and self.user_type == "System User" and not self.get_other_system_managers()
- and cint(frappe.db.get_single_value('System Settings', 'setup_complete'))):
+ if (
+ self.name not in STANDARD_USERS
+ and self.user_type == "System User"
+ and not self.get_other_system_managers()
+ and cint(frappe.db.get_single_value("System Settings", "setup_complete"))
+ ):
msgprint(_("Adding System Manager to this User as there must be atleast one System Manager"))
- self.append("roles", {
- "doctype": "Has Role",
- "role": "System Manager"
- })
+ self.append("roles", {"doctype": "Has Role", "role": "System Manager"})
- if self.name == 'Administrator':
+ if self.name == "Administrator":
# Administrator should always have System Manager Role
- self.extend("roles", [
- {
- "doctype": "Has Role",
- "role": "System Manager"
- },
- {
- "doctype": "Has Role",
- "role": "Administrator"
- }
- ])
+ self.extend(
+ "roles",
+ [
+ {"doctype": "Has Role", "role": "System Manager"},
+ {"doctype": "Has Role", "role": "Administrator"},
+ ],
+ )
def email_new_password(self, new_password=None):
if new_password and not self.flags.in_insert:
_update_password(user=self.name, pwd=new_password, logout_all_sessions=self.logout_all_sessions)
def set_system_user(self):
- '''For the standard users like admin and guest, the user type is fixed.'''
- user_type_mapper = {
- 'Administrator': 'System User',
- 'Guest': 'Website User'
- }
+ """For the standard users like admin and guest, the user type is fixed."""
+ user_type_mapper = {"Administrator": "System User", "Guest": "Website User"}
- if self.user_type and not frappe.get_cached_value('User Type', self.user_type, 'is_standard'):
+ if self.user_type and not frappe.get_cached_value("User Type", self.user_type, "is_standard"):
if user_type_mapper.get(self.name):
self.user_type = user_type_mapper.get(self.name)
else:
self.set_roles_and_modules_based_on_user_type()
else:
- '''Set as System User if any of the given roles has desk_access'''
- self.user_type = 'System User' if self.has_desk_access() else 'Website User'
+ """Set as System User if any of the given roles has desk_access"""
+ self.user_type = "System User" if self.has_desk_access() else "Website User"
def set_roles_and_modules_based_on_user_type(self):
- user_type_doc = frappe.get_cached_doc('User Type', self.user_type)
+ user_type_doc = frappe.get_cached_doc("User Type", self.user_type)
if user_type_doc.role:
self.roles = []
# Check whether User has linked with the 'Apply User Permission On' doctype or not
if user_linked_with_permission_on_doctype(user_type_doc, self.name):
- self.append('roles', {
- 'role': user_type_doc.role
- })
+ self.append("roles", {"role": user_type_doc.role})
- frappe.msgprint(_('Role has been set as per the user type {0}')
- .format(self.user_type), alert=True)
+ frappe.msgprint(
+ _("Role has been set as per the user type {0}").format(self.user_type), alert=True
+ )
user_type_doc.update_modules_in_user(self)
@@ -219,20 +225,24 @@ class User(Document):
return False
role_table = DocType("Role")
- return frappe.db.count(role_table, ((role_table.desk_access == 1) & (role_table.name.isin([d.role for d in self.roles]))))
+ return frappe.db.count(
+ role_table,
+ ((role_table.desk_access == 1) & (role_table.name.isin([d.role for d in self.roles]))),
+ )
def share_with_self(self):
- frappe.share.add(self.doctype, self.name, self.name, write=1, share=1,
- flags={"ignore_share_permission": True})
+ frappe.share.add(
+ self.doctype, self.name, self.name, write=1, share=1, flags={"ignore_share_permission": True}
+ )
def validate_share(self, docshare):
pass
# if docshare.user == self.name:
- # if self.user_type=="System User":
- # if docshare.share != 1:
- # frappe.throw(_("Sorry! User should have complete access to their own record."))
- # else:
- # frappe.throw(_("Sorry! Sharing with Website User is prohibited."))
+ # if self.user_type=="System User":
+ # if docshare.share != 1:
+ # frappe.throw(_("Sorry! User should have complete access to their own record."))
+ # else:
+ # frappe.throw(_("Sorry! Sharing with Website User is prohibited."))
def send_password_notification(self, new_password):
try:
@@ -240,13 +250,14 @@ class User(Document):
if self.name not in STANDARD_USERS:
if new_password:
# new password given, no email required
- _update_password(user=self.name, pwd=new_password,
- logout_all_sessions=self.logout_all_sessions)
+ _update_password(
+ user=self.name, pwd=new_password, logout_all_sessions=self.logout_all_sessions
+ )
if not self.flags.no_welcome_mail and cint(self.send_welcome_email):
self.send_welcome_mail_to_user()
self.flags.email_sent = 1
- if frappe.session.user != 'Guest':
+ if frappe.session.user != "Guest":
msgprint(_("Welcome email sent"))
return
else:
@@ -261,14 +272,14 @@ class User(Document):
pass
def reset_password(self, send_email=False, password_expired=False):
- from frappe.utils import random_string, get_url
+ from frappe.utils import get_url, random_string
key = random_string(32)
self.db_set("reset_password_key", key)
url = "/update-password?key=" + key
if password_expired:
- url = "/update-password?key=" + key + '&password_expired=true'
+ url = "/update-password?key=" + key + "&password_expired=true"
link = get_url(url)
if send_email:
@@ -283,7 +294,7 @@ class User(Document):
frappe.qb.from_(user_doctype)
.from_(user_role_doctype)
.select(user_doctype.name)
- .where(user_role_doctype.role == 'System Manager')
+ .where(user_role_doctype.role == "System Manager")
.where(user_doctype.docstatus < 2)
.where(user_doctype.enabled == 1)
.where(user_role_doctype.parent == user_doctype.name)
@@ -294,57 +305,68 @@ class User(Document):
def get_fullname(self):
"""get first_name space last_name"""
- return (self.first_name or '') + \
- (self.first_name and " " or '') + (self.last_name or '')
+ return (self.first_name or "") + (self.first_name and " " or "") + (self.last_name or "")
def password_reset_mail(self, link):
- self.send_login_mail(_("Password Reset"),
- "password_reset", {"link": link}, now=True)
+ self.send_login_mail(_("Password Reset"), "password_reset", {"link": link}, now=True)
def send_welcome_mail_to_user(self):
from frappe.utils import get_url
+
link = self.reset_password()
subject = None
method = frappe.get_hooks("welcome_email")
if method:
subject = frappe.get_attr(method[-1])()
if not subject:
- site_name = frappe.db.get_default('site_name') or frappe.get_conf().get("site_name")
+ site_name = frappe.db.get_default("site_name") or frappe.get_conf().get("site_name")
if site_name:
subject = _("Welcome to {0}").format(site_name)
else:
subject = _("Complete Registration")
- self.send_login_mail(subject, "new_user",
- dict(
- link=link,
- site_url=get_url(),
- ))
+ self.send_login_mail(
+ subject,
+ "new_user",
+ dict(
+ link=link,
+ site_url=get_url(),
+ ),
+ )
def send_login_mail(self, subject, template, add_args, now=None):
"""send mail with login details"""
- from frappe.utils.user import get_user_fullname
from frappe.utils import get_url
+ from frappe.utils.user import get_user_fullname
- created_by = get_user_fullname(frappe.session['user'])
+ created_by = get_user_fullname(frappe.session["user"])
if created_by == "Guest":
created_by = "Administrator"
args = {
- 'first_name': self.first_name or self.last_name or "user",
- 'user': self.name,
- 'title': subject,
- 'login_url': get_url(),
- 'created_by': created_by
+ "first_name": self.first_name or self.last_name or "user",
+ "user": self.name,
+ "title": subject,
+ "login_url": get_url(),
+ "created_by": created_by,
}
args.update(add_args)
- sender = frappe.session.user not in STANDARD_USERS and get_formatted_email(frappe.session.user) or None
+ sender = (
+ frappe.session.user not in STANDARD_USERS and get_formatted_email(frappe.session.user) or None
+ )
- frappe.sendmail(recipients=self.email, sender=sender, subject=subject,
- template=template, args=args, header=[subject, "green"],
- delayed=(not now) if now is not None else self.flags.delay_emails, retry=3)
+ frappe.sendmail(
+ recipients=self.email,
+ sender=sender,
+ subject=subject,
+ template=template,
+ args=args,
+ header=[subject, "green"],
+ delayed=(not now) if now is not None else self.flags.delay_emails,
+ retry=3,
+ )
def a_system_manager_should_exist(self):
if not self.get_other_system_managers():
@@ -389,18 +411,15 @@ class User(Document):
)
# unlink contact
table = DocType("Contact")
- frappe.qb.update(table).where(
- table.user == self.name
- ).set(table.user, None).run()
+ frappe.qb.update(table).where(table.user == self.name).set(table.user, None).run()
# delete notification settings
frappe.delete_doc("Notification Settings", self.name, ignore_permissions=True)
- if self.get('allow_in_mentions'):
- frappe.cache().delete_key('users_for_mentions')
-
- frappe.cache().delete_key('enabled_users')
+ if self.get("allow_in_mentions"):
+ frappe.cache().delete_key("users_for_mentions")
+ frappe.cache().delete_key("enabled_users")
def before_rename(self, old_name, new_name, merge=False):
frappe.clear_cache(user=old_name)
@@ -415,6 +434,7 @@ class User(Document):
def validate_email_type(self, email):
from frappe.utils import validate_email_address
+
validate_email_address(email.strip(), True)
def after_rename(self, old_name, new_name, merge=False):
@@ -423,13 +443,16 @@ class User(Document):
desc = frappe.db.get_table_columns_description(tab)
has_fields = []
for d in desc:
- if d.get('name') in ['owner', 'modified_by']:
- has_fields.append(d.get('name'))
+ if d.get("name") in ["owner", "modified_by"]:
+ has_fields.append(d.get("name"))
for field in has_fields:
- frappe.db.sql("""UPDATE `%s`
+ frappe.db.sql(
+ """UPDATE `%s`
SET `%s` = %s
- WHERE `%s` = %s""" %
- (tab, field, '%s', field, '%s'), (new_name, old_name))
+ WHERE `%s` = %s"""
+ % (tab, field, "%s", field, "%s"),
+ (new_name, old_name),
+ )
if frappe.db.exists("Notification Settings", old_name):
frappe.rename_doc("Notification Settings", old_name, new_name, force=True, show_alert=False)
@@ -463,10 +486,10 @@ class User(Document):
self.set("roles", list(set(d for d in self.get("roles") if d.role == "Guest")))
def remove_disabled_roles(self):
- disabled_roles = [d.name for d in frappe.get_all("Role", filters={"disabled":1})]
- for role in list(self.get('roles')):
+ disabled_roles = [d.name for d in frappe.get_all("Role", filters={"disabled": 1})]
+ for role in list(self.get("roles")):
if role.role in disabled_roles:
- self.get('roles').remove(role)
+ self.get("roles").remove(role)
def ensure_unique_roles(self):
exists = []
@@ -487,23 +510,23 @@ class User(Document):
self.username = self.username.strip(" @")
if self.username_exists():
- if self.user_type == 'System User':
+ if self.user_type == "System User":
frappe.msgprint(_("Username {0} already exists").format(self.username))
self.suggest_username()
self.username = ""
def password_strength_test(self):
- """ test password strength """
+ """test password strength"""
if self.flags.ignore_password_policy:
return
if self.__new_password:
user_data = (self.first_name, self.middle_name, self.last_name, self.email, self.birth_date)
- result = test_password_strength(self.__new_password, '', None, user_data)
+ result = test_password_strength(self.__new_password, "", None, user_data)
feedback = result.get("feedback", None)
- if feedback and not feedback.get('password_policy_validation_passed', False):
+ if feedback and not feedback.get("password_policy_validation_passed", False):
handle_password_test_fail(result)
def suggest_username(self):
@@ -518,7 +541,9 @@ class User(Document):
if not username:
# @firstname_last_name
- username = _check_suggestion(frappe.scrub("{0} {1}".format(self.first_name, self.last_name or "")))
+ username = _check_suggestion(
+ frappe.scrub("{0} {1}".format(self.first_name, self.last_name or ""))
+ )
if username:
frappe.msgprint(_("Suggested Username: {0}").format(username))
@@ -526,16 +551,18 @@ class User(Document):
return username
def username_exists(self, username=None):
- return frappe.db.get_value("User", {"username": username or self.username, "name": ("!=", self.name)})
+ return frappe.db.get_value(
+ "User", {"username": username or self.username, "name": ("!=", self.name)}
+ )
def get_blocked_modules(self):
"""Returns list of modules blocked for that user"""
return [d.module for d in self.block_modules] if self.block_modules else []
def validate_user_email_inbox(self):
- """ check if same email account added in User Emails twice """
+ """check if same email account added in User Emails twice"""
- email_accounts = [ user_email.email_account for user_email in self.user_emails ]
+ email_accounts = [user_email.email_account for user_email in self.user_emails]
if len(email_accounts) != len(set(email_accounts)):
frappe.throw(_("Email Account added multiple times"))
@@ -548,10 +575,7 @@ class User(Document):
return None
def set_social_login_userid(self, provider, userid, username=None):
- social_logins = {
- "provider": provider,
- "userid": userid
- }
+ social_logins = {"provider": provider, "userid": userid}
if username:
social_logins["username"] = username
@@ -574,8 +598,12 @@ class User(Document):
3. If allow_login_using_user_name is set, you can use username while finding the user.
"""
- login_with_mobile = cint(frappe.db.get_value("System Settings", "System Settings", "allow_login_using_mobile_number"))
- login_with_username = cint(frappe.db.get_value("System Settings", "System Settings", "allow_login_using_user_name"))
+ login_with_mobile = cint(
+ frappe.db.get_value("System Settings", "System Settings", "allow_login_using_mobile_number")
+ )
+ login_with_username = cint(
+ frappe.db.get_value("System Settings", "System Settings", "allow_login_using_user_name")
+ )
or_filters = [{"name": user_name}]
if login_with_mobile:
@@ -583,17 +611,17 @@ class User(Document):
if login_with_username:
or_filters.append({"username": user_name})
- users = frappe.db.get_all('User', fields=['name', 'enabled'], or_filters=or_filters, limit=1)
+ users = frappe.db.get_all("User", fields=["name", "enabled"], or_filters=or_filters, limit=1)
if not users:
return
user = users[0]
- user['is_authenticated'] = True
+ user["is_authenticated"] = True
if validate_password:
try:
- check_password(user['name'], password, delete_tracker_cache=False)
+ check_password(user["name"], password, delete_tracker_cache=False)
except frappe.AuthenticationError:
- user['is_authenticated'] = False
+ user["is_authenticated"] = False
return user
@@ -601,68 +629,74 @@ class User(Document):
if not self.time_zone:
self.time_zone = get_time_zone()
+
@frappe.whitelist()
def get_timezones():
import pytz
- return {
- "timezones": pytz.all_timezones
- }
+
+ return {"timezones": pytz.all_timezones}
+
@frappe.whitelist()
def get_all_roles(arg=None):
"""return all roles"""
active_domains = frappe.get_active_domains()
- roles = frappe.get_all("Role", filters={
- "name": ("not in", "Administrator,Guest,All"),
- "disabled": 0
- }, or_filters={
- "ifnull(restrict_to_domain, '')": "",
- "restrict_to_domain": ("in", active_domains)
- }, order_by="name")
+ roles = frappe.get_all(
+ "Role",
+ filters={"name": ("not in", "Administrator,Guest,All"), "disabled": 0},
+ or_filters={"ifnull(restrict_to_domain, '')": "", "restrict_to_domain": ("in", active_domains)},
+ order_by="name",
+ )
+
+ return [role.get("name") for role in roles]
- return [ role.get("name") for role in roles ]
@frappe.whitelist()
def get_roles(arg=None):
"""get roles for a user"""
- return frappe.get_roles(frappe.form_dict['uid'])
+ return frappe.get_roles(frappe.form_dict["uid"])
+
@frappe.whitelist()
def get_perm_info(role):
"""get permission info"""
from frappe.permissions import get_all_perms
+
return get_all_perms(role)
+
@frappe.whitelist(allow_guest=True)
def update_password(new_password, logout_all_sessions=0, key=None, old_password=None):
- #validate key to avoid key input like ['like', '%'], '', ['in', ['']]
+ # validate key to avoid key input like ['like', '%'], '', ['in', ['']]
if key and not isinstance(key, str):
- frappe.throw(_('Invalid key type'))
+ frappe.throw(_("Invalid key type"))
result = test_password_strength(new_password, key, old_password)
feedback = result.get("feedback", None)
- if feedback and not feedback.get('password_policy_validation_passed', False):
+ if feedback and not feedback.get("password_policy_validation_passed", False):
handle_password_test_fail(result)
res = _get_user_for_update_password(key, old_password)
- if res.get('message'):
+ if res.get("message"):
frappe.local.response.http_status_code = 410
- return res['message']
+ return res["message"]
else:
- user = res['user']
+ user = res["user"]
- logout_all_sessions = cint(logout_all_sessions) or frappe.db.get_single_value("System Settings", "logout_on_password_reset")
+ logout_all_sessions = cint(logout_all_sessions) or frappe.db.get_single_value(
+ "System Settings", "logout_on_password_reset"
+ )
_update_password(user, new_password, logout_all_sessions=cint(logout_all_sessions))
user_doc, redirect_url = reset_user_data(user)
# get redirect url from cache
- redirect_to = frappe.cache().hget('redirect_after_login', user)
+ redirect_to = frappe.cache().hget("redirect_after_login", user)
if redirect_to:
redirect_url = redirect_to
- frappe.cache().hdel('redirect_after_login', user)
+ frappe.cache().hdel("redirect_after_login", user)
frappe.local.login_manager.login_as(user)
@@ -674,12 +708,17 @@ def update_password(new_password, logout_all_sessions=0, key=None, old_password=
else:
return redirect_url if redirect_url else "/"
+
@frappe.whitelist(allow_guest=True)
def test_password_strength(new_password, key=None, old_password=None, user_data=None):
from frappe.utils.password_strength import test_password_strength as _test_password_strength
- password_policy = frappe.db.get_value("System Settings", None,
- ["enable_password_policy", "minimum_password_score"], as_dict=True) or {}
+ password_policy = (
+ frappe.db.get_value(
+ "System Settings", None, ["enable_password_policy", "minimum_password_score"], as_dict=True
+ )
+ or {}
+ )
enable_password_policy = cint(password_policy.get("enable_password_policy", 0))
minimum_password_score = cint(password_policy.get("minimum_password_score", 0))
@@ -688,41 +727,54 @@ def test_password_strength(new_password, key=None, old_password=None, user_data=
return {}
if not user_data:
- user_data = frappe.db.get_value('User', frappe.session.user,
- ['first_name', 'middle_name', 'last_name', 'email', 'birth_date'])
+ user_data = frappe.db.get_value(
+ "User", frappe.session.user, ["first_name", "middle_name", "last_name", "email", "birth_date"]
+ )
if new_password:
result = _test_password_strength(new_password, user_inputs=user_data)
password_policy_validation_passed = False
# score should be greater than 0 and minimum_password_score
- if result.get('score') and result.get('score') >= minimum_password_score:
+ if result.get("score") and result.get("score") >= minimum_password_score:
password_policy_validation_passed = True
- result['feedback']['password_policy_validation_passed'] = password_policy_validation_passed
+ result["feedback"]["password_policy_validation_passed"] = password_policy_validation_passed
return result
-#for login
+
+# for login
@frappe.whitelist()
def has_email_account(email):
return frappe.get_list("Email Account", filters={"email_id": email})
+
@frappe.whitelist(allow_guest=False)
def get_email_awaiting(user):
- waiting = frappe.get_all("User Email", fields=["email_account", "email_id"], filters={"awaiting_password": 1, "parent": user})
+ waiting = frappe.get_all(
+ "User Email",
+ fields=["email_account", "email_id"],
+ filters={"awaiting_password": 1, "parent": user},
+ )
if waiting:
return waiting
else:
user_email_table = DocType("User Email")
- frappe.qb.update(user_email_table).set(user_email_table.user_email_table, 0).where(user_email_table.parent == user).run()
+ frappe.qb.update(user_email_table).set(user_email_table.user_email_table, 0).where(
+ user_email_table.parent == user
+ ).run()
return False
+
def ask_pass_update():
# update the sys defaults as to awaiting users
from frappe.utils import set_default
- password_list = frappe.get_all("User Email", filters={"awaiting_password": True}, pluck="parent", distinct=True)
- set_default("email_user_password", u','.join(password_list))
+ password_list = frappe.get_all(
+ "User Email", filters={"awaiting_password": True}, pluck="parent", distinct=True
+ )
+ set_default("email_user_password", ",".join(password_list))
+
def _get_user_for_update_password(key, old_password):
# verify old password
@@ -740,19 +792,22 @@ def _get_user_for_update_password(key, old_password):
return result
+
def reset_user_data(user):
user_doc = frappe.get_doc("User", user)
redirect_url = user_doc.redirect_url
- user_doc.reset_password_key = ''
- user_doc.redirect_url = ''
+ user_doc.reset_password_key = ""
+ user_doc.redirect_url = ""
user_doc.save(ignore_permissions=True)
return user_doc, redirect_url
+
@frappe.whitelist()
def verify_password(password):
frappe.local.login_manager.check_password(frappe.session.user, password)
+
@frappe.whitelist(allow_guest=True)
def sign_up(email, full_name, redirect_to):
if is_signup_disabled():
@@ -765,20 +820,27 @@ def sign_up(email, full_name, redirect_to):
else:
return 0, _("Registered but disabled")
else:
- if frappe.db.get_creation_count('User', 60) > 300:
- frappe.respond_as_web_page(_('Temporarily Disabled'),
- _('Too many users signed up recently, so the registration is disabled. Please try back in an hour'),
- http_status_code=429)
+ if frappe.db.get_creation_count("User", 60) > 300:
+ frappe.respond_as_web_page(
+ _("Temporarily Disabled"),
+ _(
+ "Too many users signed up recently, so the registration is disabled. Please try back in an hour"
+ ),
+ http_status_code=429,
+ )
from frappe.utils import random_string
- user = frappe.get_doc({
- "doctype":"User",
- "email": email,
- "first_name": escape_html(full_name),
- "enabled": 1,
- "new_password": random_string(10),
- "user_type": "Website User"
- })
+
+ user = frappe.get_doc(
+ {
+ "doctype": "User",
+ "email": email,
+ "first_name": escape_html(full_name),
+ "enabled": 1,
+ "new_password": random_string(10),
+ "user_type": "Website User",
+ }
+ )
user.flags.ignore_permissions = True
user.flags.ignore_password_policy = True
user.insert()
@@ -789,49 +851,53 @@ def sign_up(email, full_name, redirect_to):
user.add_roles(default_role)
if redirect_to:
- frappe.cache().hset('redirect_after_login', user.name, redirect_to)
+ frappe.cache().hset("redirect_after_login", user.name, redirect_to)
if user.flags.email_sent:
return 1, _("Please check your email for verification")
else:
return 2, _("Please ask your administrator to verify your sign-up")
+
@frappe.whitelist(allow_guest=True)
-@rate_limit(limit=get_password_reset_limit, seconds = 24*60*60, methods=['POST'])
+@rate_limit(limit=get_password_reset_limit, seconds=24 * 60 * 60, methods=["POST"])
def reset_password(user):
- if user=="Administrator":
- return 'not allowed'
+ if user == "Administrator":
+ return "not allowed"
try:
user = frappe.get_doc("User", user)
if not user.enabled:
- return 'disabled'
+ return "disabled"
user.validate_reset_password()
user.reset_password(send_email=True)
return frappe.msgprint(
msg=_("Password reset instructions have been sent to your email"),
- title=_("Password Email Sent")
+ title=_("Password Email Sent"),
)
except frappe.DoesNotExistError:
- frappe.local.response['http_status_code'] = 400
+ frappe.local.response["http_status_code"] = 400
frappe.clear_messages()
- return 'not found'
+ return "not found"
+
@frappe.whitelist()
@frappe.validate_and_sanitize_search_inputs
def user_query(doctype, txt, searchfield, start, page_len, filters):
- from frappe.desk.reportview import get_match_cond, get_filters_cond
- conditions=[]
+ from frappe.desk.reportview import get_filters_cond, get_match_cond
+
+ conditions = []
user_type_condition = "and user_type != 'Website User'"
- if filters and filters.get('ignore_user_type'):
- user_type_condition = ''
- filters.pop('ignore_user_type')
+ if filters and filters.get("ignore_user_type"):
+ user_type_condition = ""
+ filters.pop("ignore_user_type")
txt = "%{}%".format(txt)
- return frappe.db.sql("""SELECT `name`, CONCAT_WS(' ', first_name, middle_name, last_name)
+ return frappe.db.sql(
+ """SELECT `name`, CONCAT_WS(' ', first_name, middle_name, last_name)
FROM `tabUser`
WHERE `enabled`=1
{user_type_condition}
@@ -847,22 +913,31 @@ def user_query(doctype, txt, searchfield, start, page_len, filters):
NAME asc
LIMIT %(page_len)s OFFSET %(start)s
""".format(
- user_type_condition = user_type_condition,
+ user_type_condition=user_type_condition,
standard_users=", ".join(frappe.db.escape(u) for u in STANDARD_USERS),
key=searchfield,
fcond=get_filters_cond(doctype, filters, conditions),
- mcond=get_match_cond(doctype)
+ mcond=get_match_cond(doctype),
),
- dict(start=start, page_len=page_len, txt=txt)
+ dict(start=start, page_len=page_len, txt=txt),
)
+
def get_total_users():
"""Returns total no. of system users"""
- return flt(frappe.db.sql('''SELECT SUM(`simultaneous_sessions`)
+ return flt(
+ frappe.db.sql(
+ """SELECT SUM(`simultaneous_sessions`)
FROM `tabUser`
WHERE `enabled` = 1
AND `user_type` = 'System User'
- AND `name` NOT IN ({})'''.format(", ".join(["%s"]*len(STANDARD_USERS))), STANDARD_USERS)[0][0])
+ AND `name` NOT IN ({})""".format(
+ ", ".join(["%s"] * len(STANDARD_USERS))
+ ),
+ STANDARD_USERS,
+ )[0][0]
+ )
+
def get_system_users(exclude_users=None, limit=None):
if not exclude_users:
@@ -870,126 +945,160 @@ def get_system_users(exclude_users=None, limit=None):
elif not isinstance(exclude_users, (list, tuple)):
exclude_users = [exclude_users]
- limit_cond = ''
+ limit_cond = ""
if limit:
- limit_cond = 'limit {0}'.format(limit)
+ limit_cond = "limit {0}".format(limit)
exclude_users += list(STANDARD_USERS)
- system_users = frappe.db.sql_list("""select name from `tabUser`
+ system_users = frappe.db.sql_list(
+ """select name from `tabUser`
where enabled=1 and user_type != 'Website User'
- and name not in ({}) {}""".format(", ".join(["%s"]*len(exclude_users)), limit_cond),
- exclude_users)
+ and name not in ({}) {}""".format(
+ ", ".join(["%s"] * len(exclude_users)), limit_cond
+ ),
+ exclude_users,
+ )
return system_users
+
def get_active_users():
"""Returns No. of system users who logged in, in the last 3 days"""
- return frappe.db.sql("""select count(*) from `tabUser`
+ return frappe.db.sql(
+ """select count(*) from `tabUser`
where enabled = 1 and user_type != 'Website User'
and name not in ({})
- and hour(timediff(now(), last_active)) < 72""".format(", ".join(["%s"]*len(STANDARD_USERS))), STANDARD_USERS)[0][0]
+ and hour(timediff(now(), last_active)) < 72""".format(
+ ", ".join(["%s"] * len(STANDARD_USERS))
+ ),
+ STANDARD_USERS,
+ )[0][0]
+
def get_website_users():
"""Returns total no. of website users"""
return frappe.db.count("User", filters={"enabled": True, "user_type": "Website User"})
+
def get_active_website_users():
"""Returns No. of website users who logged in, in the last 3 days"""
- return frappe.db.sql("""select count(*) from `tabUser`
+ return frappe.db.sql(
+ """select count(*) from `tabUser`
where enabled = 1 and user_type = 'Website User'
- and hour(timediff(now(), last_active)) < 72""")[0][0]
+ and hour(timediff(now(), last_active)) < 72"""
+ )[0][0]
+
def get_permission_query_conditions(user):
- if user=="Administrator":
+ if user == "Administrator":
return ""
else:
return """(`tabUser`.name not in ({standard_users}))""".format(
- standard_users = ", ".join(frappe.db.escape(user) for user in STANDARD_USERS))
+ standard_users=", ".join(frappe.db.escape(user) for user in STANDARD_USERS)
+ )
+
def has_permission(doc, user):
if (user != "Administrator") and (doc.name in STANDARD_USERS):
# dont allow non Administrator user to view / edit Administrator user
return False
+
def notify_admin_access_to_system_manager(login_manager=None):
- if (login_manager
+ if (
+ login_manager
and login_manager.user == "Administrator"
- and frappe.local.conf.notify_admin_access_to_system_manager):
+ and frappe.local.conf.notify_admin_access_to_system_manager
+ ):
site = '{0}'.format(frappe.local.request.host_url)
- date_and_time = '{0}'.format(format_datetime(now_datetime(), format_string="medium"))
+ date_and_time = "{0}".format(format_datetime(now_datetime(), format_string="medium"))
ip_address = frappe.local.request_ip
- access_message = _('Administrator accessed {0} on {1} via IP Address {2}.').format(
- site, date_and_time, ip_address)
+ access_message = _("Administrator accessed {0} on {1} via IP Address {2}.").format(
+ site, date_and_time, ip_address
+ )
frappe.sendmail(
recipients=get_system_managers(),
subject=_("Administrator Logged In"),
template="administrator_logged_in",
- args={'access_message': access_message},
- header=['Access Notification', 'orange']
+ args={"access_message": access_message},
+ header=["Access Notification", "orange"],
)
+
def extract_mentions(txt):
"""Find all instances of @mentions in the html."""
- soup = BeautifulSoup(txt, 'html.parser')
+ soup = BeautifulSoup(txt, "html.parser")
emails = []
- for mention in soup.find_all(class_='mention'):
- if mention.get('data-is-group') == 'true':
+ for mention in soup.find_all(class_="mention"):
+ if mention.get("data-is-group") == "true":
try:
- user_group = frappe.get_cached_doc('User Group', mention['data-id'])
+ user_group = frappe.get_cached_doc("User Group", mention["data-id"])
emails += [d.user for d in user_group.user_group_members]
except frappe.DoesNotExistError:
pass
continue
- email = mention['data-id']
+ email = mention["data-id"]
emails.append(email)
return emails
+
def handle_password_test_fail(result):
- suggestions = result['feedback']['suggestions'][0] if result['feedback']['suggestions'] else ''
- warning = result['feedback']['warning'] if 'warning' in result['feedback'] else ''
- suggestions += "" + _("Hint: Include symbols, numbers and capital letters in the password") + '
' - frappe.throw(' '.join([_('Invalid Password:'), warning, suggestions])) + suggestions = result["feedback"]["suggestions"][0] if result["feedback"]["suggestions"] else "" + warning = result["feedback"]["warning"] if "warning" in result["feedback"] else "" + suggestions += ( + "
" + _("Hint: Include symbols, numbers and capital letters in the password") + "
" + ) + frappe.throw(" ".join([_("Invalid Password:"), warning, suggestions])) + def update_gravatar(name): gravatar = has_gravatar(name) if gravatar: - frappe.db.set_value('User', name, 'user_image', gravatar) + frappe.db.set_value("User", name, "user_image", gravatar) + def throttle_user_creation(): if frappe.flags.in_import: return - if frappe.db.get_creation_count('User', 60) > frappe.local.conf.get("throttle_user_limit", 60): - frappe.throw(_('Throttled')) + if frappe.db.get_creation_count("User", 60) > frappe.local.conf.get("throttle_user_limit", 60): + frappe.throw(_("Throttled")) + @frappe.whitelist() def get_role_profile(role_profile): - roles = frappe.get_doc('Role Profile', {'role_profile': role_profile}) + roles = frappe.get_doc("Role Profile", {"role_profile": role_profile}) return roles.roles + @frappe.whitelist() def get_module_profile(module_profile): - module_profile = frappe.get_doc('Module Profile', {'module_profile_name': module_profile}) - return module_profile.get('block_modules') + module_profile = frappe.get_doc("Module Profile", {"module_profile_name": module_profile}) + return module_profile.get("block_modules") + def create_contact(user, ignore_links=False, ignore_mandatory=False): from frappe.contacts.doctype.contact.contact import get_contact_name - if user.name in ["Administrator", "Guest"]: return + + if user.name in ["Administrator", "Guest"]: + return contact_name = get_contact_name(user.email) if not contact_name: - contact = frappe.get_doc({ - "doctype": "Contact", - "first_name": user.first_name, - "last_name": user.last_name, - "user": user.name, - "gender": user.gender, - }) + contact = frappe.get_doc( + { + "doctype": "Contact", + "first_name": user.first_name, + "last_name": user.last_name, + "user": user.name, + "gender": user.gender, + } + ) if user.email: contact.add_email(user.email, is_primary=True) @@ -999,7 +1108,9 @@ def create_contact(user, ignore_links=False, ignore_mandatory=False): if user.mobile_no: contact.add_phone(user.mobile_no, is_primary_mobile_no=True) - contact.insert(ignore_permissions=True, ignore_links=ignore_links, ignore_mandatory=ignore_mandatory) + contact.insert( + ignore_permissions=True, ignore_links=ignore_links, ignore_mandatory=ignore_mandatory + ) else: contact = frappe.get_doc("Contact", contact_name) contact.first_name = user.first_name @@ -1013,21 +1124,24 @@ def create_contact(user, ignore_links=False, ignore_mandatory=False): user.phone, is_primary_phone=not any( new_contact.is_primary_phone == 1 for new_contact in contact.phone_nos - ) + ), ) # Add mobile number if mobile does not exists in contact - if user.mobile_no and not any(new_contact.phone == user.mobile_no for new_contact in contact.phone_nos): + if user.mobile_no and not any( + new_contact.phone == user.mobile_no for new_contact in contact.phone_nos + ): # Set primary mobile if there is no primary mobile number contact.add_phone( user.mobile_no, is_primary_mobile_no=not any( new_contact.is_primary_mobile_no == 1 for new_contact in contact.phone_nos - ) + ), ) contact.save(ignore_permissions=True) + @frappe.whitelist() def generate_keys(user): """ @@ -1053,6 +1167,7 @@ def switch_theme(theme): if theme in ["Dark", "Light", "Automatic"]: frappe.db.set_value("User", frappe.session.user, "desk_theme", theme) + def get_enabled_users(): def _get_enabled_users(): enabled_users = frappe.get_all("User", filters={"enabled": "1"}, pluck="name") diff --git a/frappe/core/doctype/user_document_type/user_document_type.py b/frappe/core/doctype/user_document_type/user_document_type.py index a14d735e6a..1e7eab4bd4 100644 --- a/frappe/core/doctype/user_document_type/user_document_type.py +++ b/frappe/core/doctype/user_document_type/user_document_type.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class UserDocumentType(Document): pass diff --git a/frappe/core/doctype/user_email/user_email.py b/frappe/core/doctype/user_email/user_email.py index daad083577..4e125f5308 100644 --- a/frappe/core/doctype/user_email/user_email.py +++ b/frappe/core/doctype/user_email/user_email.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class UserEmail(Document): pass diff --git a/frappe/core/doctype/user_group/test_user_group.py b/frappe/core/doctype/user_group/test_user_group.py index b5d642ae9c..546d4fd54c 100644 --- a/frappe/core/doctype/user_group/test_user_group.py +++ b/frappe/core/doctype/user_group/test_user_group.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestUserGroup(unittest.TestCase): pass diff --git a/frappe/core/doctype/user_group/user_group.py b/frappe/core/doctype/user_group/user_group.py index 05ff71e353..a59117426f 100644 --- a/frappe/core/doctype/user_group/user_group.py +++ b/frappe/core/doctype/user_group/user_group.py @@ -2,13 +2,15 @@ # Copyright (c) 2021, Frappe Technologies and contributors # License: MIT. See LICENSE +import frappe + # import frappe from frappe.model.document import Document -import frappe + class UserGroup(Document): def after_insert(self): - frappe.cache().delete_key('user_groups') + frappe.cache().delete_key("user_groups") def on_trash(self): - frappe.cache().delete_key('user_groups') + frappe.cache().delete_key("user_groups") diff --git a/frappe/core/doctype/user_group_member/test_user_group_member.py b/frappe/core/doctype/user_group_member/test_user_group_member.py index 6d4650a3d0..f1bdc41cff 100644 --- a/frappe/core/doctype/user_group_member/test_user_group_member.py +++ b/frappe/core/doctype/user_group_member/test_user_group_member.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestUserGroupMember(unittest.TestCase): pass diff --git a/frappe/core/doctype/user_group_member/user_group_member.py b/frappe/core/doctype/user_group_member/user_group_member.py index 69718d8d91..6b948d797f 100644 --- a/frappe/core/doctype/user_group_member/user_group_member.py +++ b/frappe/core/doctype/user_group_member/user_group_member.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class UserGroupMember(Document): pass diff --git a/frappe/core/doctype/user_permission/test_user_permission.py b/frappe/core/doctype/user_permission/test_user_permission.py index d4a9d68fd5..b963da2f49 100644 --- a/frappe/core/doctype/user_permission/test_user_permission.py +++ b/frappe/core/doctype/user_permission/test_user_permission.py @@ -1,12 +1,16 @@ # Copyright (c) 2021, Frappe Technologies and Contributors # See LICENSE -from frappe.core.doctype.user_permission.user_permission import add_user_permissions, remove_applicable -from frappe.permissions import has_user_permission +import unittest + +import frappe from frappe.core.doctype.doctype.test_doctype import new_doctype +from frappe.core.doctype.user_permission.user_permission import ( + add_user_permissions, + remove_applicable, +) +from frappe.permissions import has_user_permission from frappe.website.doctype.blog_post.test_blog_post import make_test_blog -import frappe -import unittest class TestUserPermission(unittest.TestCase): def setUp(self): @@ -15,64 +19,62 @@ class TestUserPermission(unittest.TestCase): "test_user_perm1@example.com", "nested_doc_user@example.com", ) - frappe.db.delete("User Permission", { - "user": ("in", test_users) - }) + frappe.db.delete("User Permission", {"user": ("in", test_users)}) frappe.delete_doc_if_exists("DocType", "Person") frappe.db.sql_ddl("DROP TABLE IF EXISTS `tabPerson`") frappe.delete_doc_if_exists("DocType", "Doc A") frappe.db.sql_ddl("DROP TABLE IF EXISTS `tabDoc A`") def test_default_user_permission_validation(self): - user = create_user('test_default_permission@example.com') - param = get_params(user, 'User', user.name, is_default=1) + user = create_user("test_default_permission@example.com") + param = get_params(user, "User", user.name, is_default=1) add_user_permissions(param) - #create a duplicate entry with default - perm_user = create_user('test_user_perm@example.com') - param = get_params(user, 'User', perm_user.name, is_default=1) + # create a duplicate entry with default + perm_user = create_user("test_user_perm@example.com") + param = get_params(user, "User", perm_user.name, is_default=1) self.assertRaises(frappe.ValidationError, add_user_permissions, param) def test_default_user_permission_corectness(self): - user = create_user('test_default_corectness_permission_1@example.com') - param = get_params(user, 'User', user.name, is_default=1, hide_descendants= 1) + user = create_user("test_default_corectness_permission_1@example.com") + param = get_params(user, "User", user.name, is_default=1, hide_descendants=1) add_user_permissions(param) - #create a duplicate entry with default - perm_user = create_user('test_default_corectness2@example.com') + # create a duplicate entry with default + perm_user = create_user("test_default_corectness2@example.com") test_blog = make_test_blog() - param = get_params(perm_user, 'Blog Post', test_blog.name, is_default=1, hide_descendants= 1) + param = get_params(perm_user, "Blog Post", test_blog.name, is_default=1, hide_descendants=1) add_user_permissions(param) - frappe.db.delete('User Permission', filters={'for_value': test_blog.name}) - frappe.delete_doc('Blog Post', test_blog.name) + frappe.db.delete("User Permission", filters={"for_value": test_blog.name}) + frappe.delete_doc("Blog Post", test_blog.name) def test_default_user_permission(self): - frappe.set_user('Administrator') - user = create_user('test_user_perm1@example.com', 'Website Manager') - for category in ['general', 'public']: - if not frappe.db.exists('Blog Category', category): - frappe.get_doc({'doctype': 'Blog Category', 'title': category}).insert() + frappe.set_user("Administrator") + user = create_user("test_user_perm1@example.com", "Website Manager") + for category in ["general", "public"]: + if not frappe.db.exists("Blog Category", category): + frappe.get_doc({"doctype": "Blog Category", "title": category}).insert() - param = get_params(user, 'Blog Category', 'general', is_default=1) + param = get_params(user, "Blog Category", "general", is_default=1) add_user_permissions(param) - param = get_params(user, 'Blog Category', 'public') + param = get_params(user, "Blog Category", "public") add_user_permissions(param) - frappe.set_user('test_user_perm1@example.com') + frappe.set_user("test_user_perm1@example.com") doc = frappe.new_doc("Blog Post") - self.assertEqual(doc.blog_category, 'general') - frappe.set_user('Administrator') + self.assertEqual(doc.blog_category, "general") + frappe.set_user("Administrator") def test_apply_to_all(self): - ''' Create User permission for User having access to all applicable Doctypes''' - user = create_user('test_bulk_creation_update@example.com') - param = get_params(user, 'User', user.name) + """Create User permission for User having access to all applicable Doctypes""" + user = create_user("test_bulk_creation_update@example.com") + param = get_params(user, "User", user.name) is_created = add_user_permissions(param) self.assertEqual(is_created, 1) def test_for_apply_to_all_on_update_from_apply_all(self): - user = create_user('test_bulk_creation_update@example.com') - param = get_params(user, 'User', user.name) + user = create_user("test_bulk_creation_update@example.com") + param = get_params(user, "User", user.name) # Initially create User Permission document with apply_to_all checked is_created = add_user_permissions(param) @@ -84,12 +86,12 @@ class TestUserPermission(unittest.TestCase): self.assertEqual(is_created, 0) def test_for_applicable_on_update_from_apply_to_all(self): - ''' Update User Permission from all to some applicable Doctypes''' - user = create_user('test_bulk_creation_update@example.com') - param = get_params(user,'User', user.name, applicable = ["Comment", "Contact"]) + """Update User Permission from all to some applicable Doctypes""" + user = create_user("test_bulk_creation_update@example.com") + param = get_params(user, "User", user.name, applicable=["Comment", "Contact"]) # Initially create User Permission document with apply_to_all checked - is_created = add_user_permissions(get_params(user, 'User', user.name)) + is_created = add_user_permissions(get_params(user, "User", user.name)) self.assertEqual(is_created, 1) @@ -97,8 +99,12 @@ class TestUserPermission(unittest.TestCase): frappe.db.commit() removed_apply_to_all = frappe.db.exists("User Permission", get_exists_param(user)) - is_created_applicable_first = frappe.db.exists("User Permission", get_exists_param(user, applicable = "Comment")) - is_created_applicable_second = frappe.db.exists("User Permission", get_exists_param(user, applicable = "Contact")) + is_created_applicable_first = frappe.db.exists( + "User Permission", get_exists_param(user, applicable="Comment") + ) + is_created_applicable_second = frappe.db.exists( + "User Permission", get_exists_param(user, applicable="Contact") + ) # Check that apply_to_all is removed self.assertIsNone(removed_apply_to_all) @@ -109,19 +115,25 @@ class TestUserPermission(unittest.TestCase): self.assertEqual(is_created, 1) def test_for_apply_to_all_on_update_from_applicable(self): - ''' Update User Permission from some to all applicable Doctypes''' - user = create_user('test_bulk_creation_update@example.com') - param = get_params(user, 'User', user.name) + """Update User Permission from some to all applicable Doctypes""" + user = create_user("test_bulk_creation_update@example.com") + param = get_params(user, "User", user.name) # create User permissions that with applicable - is_created = add_user_permissions(get_params(user, 'User', user.name, applicable = ["Comment", "Contact"])) + is_created = add_user_permissions( + get_params(user, "User", user.name, applicable=["Comment", "Contact"]) + ) self.assertEqual(is_created, 1) is_created = add_user_permissions(param) is_created_apply_to_all = frappe.db.exists("User Permission", get_exists_param(user)) - removed_applicable_first = frappe.db.exists("User Permission", get_exists_param(user, applicable = "Comment")) - removed_applicable_second = frappe.db.exists("User Permission", get_exists_param(user, applicable = "Contact")) + removed_applicable_first = frappe.db.exists( + "User Permission", get_exists_param(user, applicable="Comment") + ) + removed_applicable_second = frappe.db.exists( + "User Permission", get_exists_param(user, applicable="Contact") + ) # To check that a User permission with apply_to_all exists self.assertIsNotNone(is_created_apply_to_all) @@ -137,14 +149,11 @@ class TestUserPermission(unittest.TestCase): user = create_user("nested_doc_user@example.com", "Blogger") if not frappe.db.exists("DocType", "Person"): - doc = new_doctype("Person", - fields=[ - { - "label": "Person Name", - "fieldname": "person_name", - "fieldtype": "Data" - } - ], unique=0) + doc = new_doctype( + "Person", + fields=[{"label": "Person Name", "fieldname": "person_name", "fieldtype": "Data"}], + unique=0, + ) doc.is_tree = 1 doc.insert() @@ -153,7 +162,12 @@ class TestUserPermission(unittest.TestCase): ).insert() child_record = frappe.get_doc( - {"doctype": "Person", "person_name": "Child", "is_group": 0, "parent_person": parent_record.name} + { + "doctype": "Person", + "person_name": "Child", + "is_group": 0, + "parent_person": parent_record.name, + } ).insert() add_user_permissions(get_params(user, "Person", parent_record.name)) @@ -162,7 +176,9 @@ class TestUserPermission(unittest.TestCase): self.assertTrue(has_user_permission(frappe.get_doc("Person", parent_record.name), user.name)) self.assertTrue(has_user_permission(frappe.get_doc("Person", child_record.name), user.name)) - frappe.db.set_value("User Permission", {"allow": "Person", "for_value": parent_record.name}, "hide_descendants", 1) + frappe.db.set_value( + "User Permission", {"allow": "Person", "for_value": parent_record.name}, "hide_descendants", 1 + ) frappe.cache().delete_value("user_permissions") # check if adding perm on a group record with hide_descendants enabled, @@ -172,21 +188,24 @@ class TestUserPermission(unittest.TestCase): def test_user_perm_on_new_doc_with_field_default(self): """Test User Perm impact on frappe.new_doc. with *field* default value""" - frappe.set_user('Administrator') + frappe.set_user("Administrator") user = create_user("new_doc_test@example.com", "Blogger") # make a doctype "Doc A" with 'doctype' link field and default value ToDo if not frappe.db.exists("DocType", "Doc A"): - doc = new_doctype("Doc A", + doc = new_doctype( + "Doc A", fields=[ { "label": "DocType", "fieldname": "doc", "fieldtype": "Link", "options": "DocType", - "default": "ToDo" + "default": "ToDo", } - ], unique=0) + ], + unique=0, + ) doc.insert() # make User Perm on DocType 'ToDo' in Assignment Rule (unrelated doctype) @@ -199,20 +218,23 @@ class TestUserPermission(unittest.TestCase): # it should not have impact on Doc A self.assertEqual(new_doc.doc, "ToDo") - frappe.set_user('Administrator') + frappe.set_user("Administrator") remove_applicable(["Assignment Rule"], "new_doc_test@example.com", "DocType", "ToDo") def test_user_perm_on_new_doc_with_user_default(self): """Test User Perm impact on frappe.new_doc. with *user* default value""" - from frappe.core.doctype.session_default_settings.session_default_settings import (clear_session_defaults, - set_session_default_values) + from frappe.core.doctype.session_default_settings.session_default_settings import ( + clear_session_defaults, + set_session_default_values, + ) - frappe.set_user('Administrator') + frappe.set_user("Administrator") user = create_user("user_default_test@example.com", "Blogger") # make a doctype "Doc A" with 'doctype' link field if not frappe.db.exists("DocType", "Doc A"): - doc = new_doctype("Doc A", + doc = new_doctype( + "Doc A", fields=[ { "label": "DocType", @@ -220,15 +242,15 @@ class TestUserPermission(unittest.TestCase): "fieldtype": "Link", "options": "DocType", } - ], unique=0) + ], + unique=0, + ) doc.insert() # create a 'DocType' session default field if not frappe.db.exists("Session Default", {"ref_doctype": "DocType"}): - settings = frappe.get_single('Session Default Settings') - settings.append("session_defaults", { - "ref_doctype": "DocType" - }) + settings = frappe.get_single("Session Default Settings") + settings.append("session_defaults", {"ref_doctype": "DocType"}) settings.save() # make User Perm on DocType 'ToDo' in Assignment Rule (unrelated doctype) @@ -244,43 +266,46 @@ class TestUserPermission(unittest.TestCase): # it should not have impact on Doc A self.assertEqual(new_doc.doc, "ToDo") - frappe.set_user('Administrator') + frappe.set_user("Administrator") clear_session_defaults() remove_applicable(["Assignment Rule"], "user_default_test@example.com", "DocType", "ToDo") + def create_user(email, *roles): - ''' create user with role system manager ''' - if frappe.db.exists('User', email): - return frappe.get_doc('User', email) + """create user with role system manager""" + if frappe.db.exists("User", email): + return frappe.get_doc("User", email) - user = frappe.new_doc('User') + user = frappe.new_doc("User") user.email = email user.first_name = email.split("@")[0] if not roles: - roles = ('System Manager',) + roles = ("System Manager",) user.add_roles(*roles) return user + def get_params(user, doctype, docname, is_default=0, hide_descendants=0, applicable=None): - ''' Return param to insert ''' + """Return param to insert""" param = { "user": user.name, - "doctype":doctype, - "docname":docname, + "doctype": doctype, + "docname": docname, "is_default": is_default, "apply_to_all_doctypes": 1, "applicable_doctypes": [], - "hide_descendants": hide_descendants + "hide_descendants": hide_descendants, } if applicable: param.update({"apply_to_all_doctypes": 0}) param.update({"applicable_doctypes": applicable}) return param -def get_exists_param(user, applicable = None): - ''' param to check existing Document ''' + +def get_exists_param(user, applicable=None): + """param to check existing Document""" param = { "user": user.name, "allow": "User", diff --git a/frappe/core/doctype/user_permission/user_permission.py b/frappe/core/doctype/user_permission/user_permission.py index fb658481b2..e43a288744 100644 --- a/frappe/core/doctype/user_permission/user_permission.py +++ b/frappe/core/doctype/user_permission/user_permission.py @@ -1,13 +1,16 @@ # Copyright (c) 2021, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe, json -from frappe.model.document import Document -from frappe.permissions import (get_valid_perms, update_permission_property) +import json + +import frappe from frappe import _ -from frappe.utils import cstr from frappe.core.utils import find from frappe.desk.form.linked_with import get_linked_doctypes +from frappe.model.document import Document +from frappe.permissions import get_valid_perms, update_permission_property +from frappe.utils import cstr + class UserPermission(Document): def validate(self): @@ -15,50 +18,55 @@ class UserPermission(Document): self.validate_default_permission() def on_update(self): - frappe.cache().hdel('user_permissions', self.user) - frappe.publish_realtime('update_user_permissions') + frappe.cache().hdel("user_permissions", self.user) + frappe.publish_realtime("update_user_permissions") - def on_trash(self): # pylint: disable=no-self-use - frappe.cache().hdel('user_permissions', self.user) - frappe.publish_realtime('update_user_permissions') + def on_trash(self): # pylint: disable=no-self-use + frappe.cache().hdel("user_permissions", self.user) + frappe.publish_realtime("update_user_permissions") def validate_user_permission(self): - ''' checks for duplicate user permission records''' - - duplicate_exists = frappe.db.get_all(self.doctype, filters={ - 'allow': self.allow, - 'for_value': self.for_value, - 'user': self.user, - 'applicable_for': cstr(self.applicable_for), - 'apply_to_all_doctypes': self.apply_to_all_doctypes, - 'name': ['!=', self.name] - }, limit=1) + """checks for duplicate user permission records""" + + duplicate_exists = frappe.db.get_all( + self.doctype, + filters={ + "allow": self.allow, + "for_value": self.for_value, + "user": self.user, + "applicable_for": cstr(self.applicable_for), + "apply_to_all_doctypes": self.apply_to_all_doctypes, + "name": ["!=", self.name], + }, + limit=1, + ) if duplicate_exists: frappe.throw(_("User permission already exists"), frappe.DuplicateEntryError) def validate_default_permission(self): - ''' validate user permission overlap for default value of a particular doctype ''' + """validate user permission overlap for default value of a particular doctype""" overlap_exists = [] if self.is_default: - overlap_exists = frappe.get_all(self.doctype, filters={ - 'allow': self.allow, - 'user': self.user, - 'is_default': 1, - 'name': ['!=', self.name] - }, or_filters={ - 'applicable_for': cstr(self.applicable_for), - 'apply_to_all_doctypes': 1, - }, limit=1) + overlap_exists = frappe.get_all( + self.doctype, + filters={"allow": self.allow, "user": self.user, "is_default": 1, "name": ["!=", self.name]}, + or_filters={ + "applicable_for": cstr(self.applicable_for), + "apply_to_all_doctypes": 1, + }, + limit=1, + ) if overlap_exists: ref_link = frappe.get_desk_link(self.doctype, overlap_exists[0].name) frappe.throw(_("{0} has already assigned default value for {1}.").format(ref_link, self.allow)) + @frappe.whitelist() def get_user_permissions(user=None): - '''Get all users permissions for the user as a dict of doctype''' + """Get all users permissions for the user as a dict of doctype""" # if this is called from client-side, # user can access only his/her user permissions - if frappe.request and frappe.local.form_dict.cmd == 'get_user_permissions': + if frappe.request and frappe.local.form_dict.cmd == "get_user_permissions": user = frappe.session.user if not user: @@ -81,16 +89,18 @@ def get_user_permissions(user=None): if not out.get(perm.allow): out[perm.allow] = [] - out[perm.allow].append(frappe._dict({ - 'doc': doc_name, - 'applicable_for': perm.get('applicable_for'), - 'is_default': is_default - })) + out[perm.allow].append( + frappe._dict( + {"doc": doc_name, "applicable_for": perm.get("applicable_for"), "is_default": is_default} + ) + ) try: - for perm in frappe.get_all('User Permission', - fields=['allow', 'for_value', 'applicable_for', 'is_default', 'hide_descendants'], - filters=dict(user=user)): + for perm in frappe.get_all( + "User Permission", + fields=["allow", "for_value", "applicable_for", "is_default", "hide_descendants"], + filters=dict(user=user), + ): meta = frappe.get_meta(perm.allow) add_doc_to_perm(perm, perm.for_value, perm.is_default) @@ -109,14 +119,20 @@ def get_user_permissions(user=None): return out + def user_permission_exists(user, allow, for_value, applicable_for=None): - '''Checks if similar user permission already exists''' + """Checks if similar user permission already exists""" user_permissions = get_user_permissions(user).get(allow, []) - if not user_permissions: return None - has_same_user_permission = find(user_permissions, lambda perm:perm["doc"] == for_value and perm.get('applicable_for') == applicable_for) + if not user_permissions: + return None + has_same_user_permission = find( + user_permissions, + lambda perm: perm["doc"] == for_value and perm.get("applicable_for") == applicable_for, + ) return has_same_user_permission + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_applicable_for_doctype_list(doctype, txt, searchfield, start, page_len, filters): @@ -142,34 +158,44 @@ def get_applicable_for_doctype_list(doctype, txt, searchfield, start, page_len, return return_list + def get_permitted_documents(doctype): - ''' Returns permitted documents from the given doctype for the session user ''' + """Returns permitted documents from the given doctype for the session user""" # sort permissions in a way to make the first permission in the list to be default - user_perm_list = sorted(get_user_permissions().get(doctype, []), key=lambda x: x.get('is_default'), reverse=True) + user_perm_list = sorted( + get_user_permissions().get(doctype, []), key=lambda x: x.get("is_default"), reverse=True + ) + + return [d.get("doc") for d in user_perm_list if d.get("doc")] - return [d.get('doc') for d in user_perm_list \ - if d.get('doc')] @frappe.whitelist() def check_applicable_doc_perm(user, doctype, docname): - frappe.only_for('System Manager') + frappe.only_for("System Manager") applicable = [] - doc_exists = frappe.get_all('User Permission', - fields=['name'], - filters={"user": user, + doc_exists = frappe.get_all( + "User Permission", + fields=["name"], + filters={ + "user": user, "allow": doctype, "for_value": docname, - "apply_to_all_doctypes":1, - }, limit=1) + "apply_to_all_doctypes": 1, + }, + limit=1, + ) if doc_exists: applicable = get_linked_doctypes(doctype).keys() else: - data = frappe.get_all('User Permission', - fields=['applicable_for'], - filters={"user": user, + data = frappe.get_all( + "User Permission", + fields=["applicable_for"], + filters={ + "user": user, "allow": doctype, - "for_value":docname, - }) + "for_value": docname, + }, + ) for permission in data: applicable.append(permission.applicable_for) return applicable @@ -181,46 +207,74 @@ def clear_user_permissions(user, for_doctype): total = frappe.db.count("User Permission", {"user": user, "allow": for_doctype}) if total: - frappe.db.delete("User Permission", { - "allow": for_doctype, - "user": user, - }) + frappe.db.delete( + "User Permission", + { + "allow": for_doctype, + "user": user, + }, + ) frappe.clear_cache() return total + @frappe.whitelist() def add_user_permissions(data): - ''' Add and update the user permissions ''' - frappe.only_for('System Manager') + """Add and update the user permissions""" + frappe.only_for("System Manager") if isinstance(data, str): data = json.loads(data) data = frappe._dict(data) # get all doctypes on whom this permission is applied perm_applied_docs = check_applicable_doc_perm(data.user, data.doctype, data.docname) - exists = frappe.db.exists("User Permission", { - "user": data.user, - "allow": data.doctype, - "for_value": data.docname, - "apply_to_all_doctypes": 1 - }) + exists = frappe.db.exists( + "User Permission", + { + "user": data.user, + "allow": data.doctype, + "for_value": data.docname, + "apply_to_all_doctypes": 1, + }, + ) if data.apply_to_all_doctypes == 1 and not exists: remove_applicable(perm_applied_docs, data.user, data.doctype, data.docname) - insert_user_perm(data.user, data.doctype, data.docname, data.is_default, data.hide_descendants, apply_to_all=1) + insert_user_perm( + data.user, data.doctype, data.docname, data.is_default, data.hide_descendants, apply_to_all=1 + ) return 1 elif len(data.applicable_doctypes) > 0 and data.apply_to_all_doctypes != 1: remove_apply_to_all(data.user, data.doctype, data.docname) - update_applicable(perm_applied_docs, data.applicable_doctypes, data.user, data.doctype, data.docname) - for applicable in data.applicable_doctypes : + update_applicable( + perm_applied_docs, data.applicable_doctypes, data.user, data.doctype, data.docname + ) + for applicable in data.applicable_doctypes: if applicable not in perm_applied_docs: - insert_user_perm(data.user, data.doctype, data.docname, data.is_default, data.hide_descendants, applicable=applicable) + insert_user_perm( + data.user, + data.doctype, + data.docname, + data.is_default, + data.hide_descendants, + applicable=applicable, + ) elif exists: - insert_user_perm(data.user, data.doctype, data.docname, data.is_default, data.hide_descendants, applicable=applicable) + insert_user_perm( + data.user, + data.doctype, + data.docname, + data.is_default, + data.hide_descendants, + applicable=applicable, + ) return 1 return 0 -def insert_user_perm(user, doctype, docname, is_default=0, hide_descendants=0, apply_to_all=None, applicable=None): + +def insert_user_perm( + user, doctype, docname, is_default=0, hide_descendants=0, apply_to_all=None, applicable=None +): user_perm = frappe.new_doc("User Permission") user_perm.user = user user_perm.allow = doctype @@ -234,29 +288,41 @@ def insert_user_perm(user, doctype, docname, is_default=0, hide_descendants=0, a user_perm.apply_to_all_doctypes = 1 user_perm.insert() + def remove_applicable(perm_applied_docs, user, doctype, docname): for applicable_for in perm_applied_docs: - frappe.db.delete("User Permission", { - "applicable_for": applicable_for, + frappe.db.delete( + "User Permission", + { + "applicable_for": applicable_for, + "for_value": docname, + "allow": doctype, + "user": user, + }, + ) + + +def remove_apply_to_all(user, doctype, docname): + frappe.db.delete( + "User Permission", + { + "apply_to_all_doctypes": 1, "for_value": docname, "allow": doctype, "user": user, - }) + }, + ) -def remove_apply_to_all(user, doctype, docname): - frappe.db.delete("User Permission", { - "apply_to_all_doctypes": 1, - "for_value": docname, - "allow": doctype, - "user": user, - }) def update_applicable(already_applied, to_apply, user, doctype, docname): for applied in already_applied: if applied not in to_apply: - frappe.db.delete("User Permission", { - "applicable_for": applied, - "for_value": docname, - "allow": doctype, - "user": user, - }) + frappe.db.delete( + "User Permission", + { + "applicable_for": applied, + "for_value": docname, + "allow": doctype, + "user": user, + }, + ) diff --git a/frappe/core/doctype/user_select_document_type/user_select_document_type.py b/frappe/core/doctype/user_select_document_type/user_select_document_type.py index 18a21931e5..07b8123a13 100644 --- a/frappe/core/doctype/user_select_document_type/user_select_document_type.py +++ b/frappe/core/doctype/user_select_document_type/user_select_document_type.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class UserSelectDocumentType(Document): pass diff --git a/frappe/core/doctype/user_social_login/user_social_login.py b/frappe/core/doctype/user_social_login/user_social_login.py index 80c0c89383..d12b5823d1 100644 --- a/frappe/core/doctype/user_social_login/user_social_login.py +++ b/frappe/core/doctype/user_social_login/user_social_login.py @@ -4,5 +4,6 @@ from frappe.model.document import Document + class UserSocialLogin(Document): pass diff --git a/frappe/core/doctype/user_type/test_user_type.py b/frappe/core/doctype/user_type/test_user_type.py index 6807f8fc9e..53999ed3df 100644 --- a/frappe/core/doctype/user_type/test_user_type.py +++ b/frappe/core/doctype/user_type/test_user_type.py @@ -1,22 +1,25 @@ # -*- coding: utf-8 -*- # Copyright (c) 2021, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe from frappe.installer import update_site_config + class TestUserType(unittest.TestCase): def setUp(self): create_role() def test_add_select_perm_doctypes(self): - user_type = create_user_type('Test User Type') + user_type = create_user_type("Test User Type") # select perms added for all link fields - doc = frappe.get_meta('Contact') + doc = frappe.get_meta("Contact") link_fields = doc.get_link_fields() - select_doctypes = frappe.get_all('User Select Document Type', {'parent': user_type.name}, pluck='document_type') + select_doctypes = frappe.get_all( + "User Select Document Type", {"parent": user_type.name}, pluck="document_type" + ) for entry in link_fields: self.assertTrue(entry.options in select_doctypes) @@ -35,34 +38,29 @@ class TestUserType(unittest.TestCase): def create_user_type(user_type): - if frappe.db.exists('User Type', user_type): - frappe.delete_doc('User Type', user_type) + if frappe.db.exists("User Type", user_type): + frappe.delete_doc("User Type", user_type) user_type_limit = {frappe.scrub(user_type): 1} - update_site_config('user_type_doctype_limit', user_type_limit) - - doc = frappe.get_doc({ - 'doctype': 'User Type', - 'name': user_type, - 'role': '_Test User Type', - 'user_id_field': 'user', - 'apply_user_permission_on': 'User' - }) - - doc.append('user_doctypes', { - 'document_type': 'Contact', - 'read': 1, - 'write': 1 - }) + update_site_config("user_type_doctype_limit", user_type_limit) + + doc = frappe.get_doc( + { + "doctype": "User Type", + "name": user_type, + "role": "_Test User Type", + "user_id_field": "user", + "apply_user_permission_on": "User", + } + ) + + doc.append("user_doctypes", {"document_type": "Contact", "read": 1, "write": 1}) return doc.insert() def create_role(): - if not frappe.db.exists('Role', '_Test User Type'): - frappe.get_doc({ - 'doctype': 'Role', - 'role_name': '_Test User Type', - 'desk_access': 1, - 'is_custom': 1 - }).insert() \ No newline at end of file + if not frappe.db.exists("Role", "_Test User Type"): + frappe.get_doc( + {"doctype": "Role", "role_name": "_Test User Type", "desk_access": 1, "is_custom": 1} + ).insert() diff --git a/frappe/core/doctype/user_type/user_type.py b/frappe/core/doctype/user_type/user_type.py index c0dfd2e597..7efb66f569 100644 --- a/frappe/core/doctype/user_type/user_type.py +++ b/frappe/core/doctype/user_type/user_type.py @@ -4,10 +4,11 @@ import frappe from frappe import _ -from frappe.utils import get_link_to_form from frappe.config import get_modules_from_app -from frappe.permissions import add_permission, add_user_permission from frappe.model.document import Document +from frappe.permissions import add_permission, add_user_permission +from frappe.utils import get_link_to_form + class UserType(Document): def validate(self): @@ -29,14 +30,14 @@ class UserType(Document): def on_trash(self): if self.is_standard: - frappe.throw(_('Standard user type {0} can not be deleted.') - .format(frappe.bold(self.name))) + frappe.throw(_("Standard user type {0} can not be deleted.").format(frappe.bold(self.name))) def set_modules(self): if not self.user_doctypes: return - modules = frappe.get_all("DocType", + modules = frappe.get_all( + "DocType", filters={"name": ("in", [d.document_type for d in self.user_doctypes])}, distinct=True, pluck="module", @@ -47,64 +48,77 @@ class UserType(Document): self.append("user_type_modules", {"module": module}) def validate_document_type_limit(self): - limit = frappe.conf.get('user_type_doctype_limit', {}).get(frappe.scrub(self.name)) + limit = frappe.conf.get("user_type_doctype_limit", {}).get(frappe.scrub(self.name)) - if not limit and frappe.session.user != 'Administrator': - frappe.throw(_('User does not have permission to create the new {0}') - .format(frappe.bold(_('User Type'))), title=_('Permission Error')) + if not limit and frappe.session.user != "Administrator": + frappe.throw( + _("User does not have permission to create the new {0}").format(frappe.bold(_("User Type"))), + title=_("Permission Error"), + ) if not limit: - frappe.throw(_('The limit has not set for the user type {0} in the site config file.') - .format(frappe.bold(self.name)), title=_('Set Limit')) + frappe.throw( + _("The limit has not set for the user type {0} in the site config file.").format( + frappe.bold(self.name) + ), + title=_("Set Limit"), + ) if self.user_doctypes and len(self.user_doctypes) > limit: - frappe.throw(_('The total number of user document types limit has been crossed.'), - title=_('User Document Types Limit Exceeded')) + frappe.throw( + _("The total number of user document types limit has been crossed."), + title=_("User Document Types Limit Exceeded"), + ) custom_doctypes = [row.document_type for row in self.user_doctypes if row.is_custom] if custom_doctypes and len(custom_doctypes) > 3: - frappe.throw(_('You can only set the 3 custom doctypes in the Document Types table.'), - title=_('Custom Document Types Limit Exceeded')) + frappe.throw( + _("You can only set the 3 custom doctypes in the Document Types table."), + title=_("Custom Document Types Limit Exceeded"), + ) def validate_role(self): if not self.role: - frappe.throw(_("The field {0} is mandatory") - .format(frappe.bold(_('Role')))) + frappe.throw(_("The field {0} is mandatory").format(frappe.bold(_("Role")))) - if not frappe.db.get_value('Role', self.role, 'is_custom'): - frappe.throw(_("The role {0} should be a custom role.") - .format(frappe.bold(get_link_to_form('Role', self.role)))) + if not frappe.db.get_value("Role", self.role, "is_custom"): + frappe.throw( + _("The role {0} should be a custom role.").format( + frappe.bold(get_link_to_form("Role", self.role)) + ) + ) def update_users(self): - for row in frappe.get_all('User', filters = {'user_type': self.name}): - user = frappe.get_cached_doc('User', row.name) + for row in frappe.get_all("User", filters={"user_type": self.name}): + user = frappe.get_cached_doc("User", row.name) self.update_roles_in_user(user) self.update_modules_in_user(user) user.update_children() def update_roles_in_user(self, user): - user.set('roles', []) - user.append('roles', { - 'role': self.role - }) + user.set("roles", []) + user.append("roles", {"role": self.role}) def update_modules_in_user(self, user): - block_modules = frappe.get_all('Module Def', fields = ['name as module'], - filters={'name': ['not in', [d.module for d in self.user_type_modules]]}) + block_modules = frappe.get_all( + "Module Def", + fields=["name as module"], + filters={"name": ["not in", [d.module for d in self.user_type_modules]]}, + ) if block_modules: - user.set('block_modules', block_modules) + user.set("block_modules", block_modules) def add_role_permissions_for_user_doctypes(self): - perms = ['read', 'write', 'create', 'submit', 'cancel', 'amend', 'delete'] + perms = ["read", "write", "create", "submit", "cancel", "amend", "delete"] for row in self.user_doctypes: docperm = add_role_permissions(row.document_type, self.role) - values = {perm:row.get(perm) or 0 for perm in perms} - for perm in ['print', 'email', 'share']: + values = {perm: row.get(perm) or 0 for perm in perms} + for perm in ["print", "email", "share"]: values[perm] = 1 - frappe.db.set_value('Custom DocPerm', docperm, values) + frappe.db.set_value("Custom DocPerm", docperm, values) def add_select_perm_doctypes(self): if frappe.flags.ignore_select_perm: @@ -127,9 +141,7 @@ class UserType(Document): if select_doctypes: select_doctypes = set(select_doctypes) for select_doctype in select_doctypes: - self.append('select_doctypes', { - 'document_type': select_doctype - }) + self.append("select_doctypes", {"document_type": select_doctype}) def prepare_select_perm_doctypes(self, doc, user_doctypes, select_doctypes): for field in doc.get_link_fields(): @@ -137,108 +149,149 @@ class UserType(Document): select_doctypes.append(field.options) def add_role_permissions_for_select_doctypes(self): - for doctype in ['select_doctypes', 'custom_select_doctypes']: + for doctype in ["select_doctypes", "custom_select_doctypes"]: for row in self.get(doctype): docperm = add_role_permissions(row.document_type, self.role) - frappe.db.set_value('Custom DocPerm', docperm, - {'select': 1, 'read': 0, 'create': 0, 'write': 0}) + frappe.db.set_value( + "Custom DocPerm", docperm, {"select": 1, "read": 0, "create": 0, "write": 0} + ) def add_role_permissions_for_file(self): - docperm = add_role_permissions('File', self.role) - frappe.db.set_value('Custom DocPerm', docperm, - {'read': 1, 'create': 1, 'write': 1}) + docperm = add_role_permissions("File", self.role) + frappe.db.set_value("Custom DocPerm", docperm, {"read": 1, "create": 1, "write": 1}) def remove_permission_for_deleted_doctypes(self): doctypes = [d.document_type for d in self.user_doctypes] # Do not remove the doc permission for the file doctype - doctypes.append('File') + doctypes.append("File") - for doctype in ['select_doctypes', 'custom_select_doctypes']: + for doctype in ["select_doctypes", "custom_select_doctypes"]: for dt in self.get(doctype): doctypes.append(dt.document_type) - for perm in frappe.get_all('Custom DocPerm', - filters = {'role': self.role, 'parent': ['not in', doctypes]}): - frappe.delete_doc('Custom DocPerm', perm.name) + for perm in frappe.get_all( + "Custom DocPerm", filters={"role": self.role, "parent": ["not in", doctypes]} + ): + frappe.delete_doc("Custom DocPerm", perm.name) + def add_role_permissions(doctype, role): - name = frappe.get_value('Custom DocPerm', dict(parent=doctype, - role=role, permlevel=0)) + name = frappe.get_value("Custom DocPerm", dict(parent=doctype, role=role, permlevel=0)) if not name: name = add_permission(doctype, role, 0) return name + def get_non_standard_user_type_details(): - user_types = frappe.get_all('User Type', - fields=['apply_user_permission_on', 'name', 'user_id_field'], - filters={'is_standard': 0}) + user_types = frappe.get_all( + "User Type", + fields=["apply_user_permission_on", "name", "user_id_field"], + filters={"is_standard": 0}, + ) if user_types: user_type_details = {d.name: [d.apply_user_permission_on, d.user_id_field] for d in user_types} - frappe.cache().set_value('non_standard_user_types', user_type_details) + frappe.cache().set_value("non_standard_user_types", user_type_details) return user_type_details + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_user_linked_doctypes(doctype, txt, searchfield, start, page_len, filters): - modules = [d.get('module_name') for d in get_modules_from_app('frappe')] - - filters = [['DocField', 'options', '=', 'User'], ['DocType', 'is_submittable', '=', 0], - ['DocType', 'issingle', '=', 0], ['DocType', 'module', 'not in', modules], - ['DocType', 'read_only', '=', 0], ['DocType', 'name', 'like', '%{0}%'.format(txt)]] - - doctypes = frappe.get_all('DocType', fields = ['`tabDocType`.`name`'], filters=filters, - order_by='`tabDocType`.`idx` desc', limit_start=start, limit_page_length=page_len, as_list=1) - - custom_dt_filters = [['Custom Field', 'dt', 'like', '%{0}%'.format(txt)], - ['Custom Field', 'options', '=', 'User'], ['Custom Field', 'fieldtype', '=', 'Link']] - - custom_doctypes = frappe.get_all('Custom Field', fields = ['dt as name'], - filters= custom_dt_filters, as_list=1) + modules = [d.get("module_name") for d in get_modules_from_app("frappe")] + + filters = [ + ["DocField", "options", "=", "User"], + ["DocType", "is_submittable", "=", 0], + ["DocType", "issingle", "=", 0], + ["DocType", "module", "not in", modules], + ["DocType", "read_only", "=", 0], + ["DocType", "name", "like", "%{0}%".format(txt)], + ] + + doctypes = frappe.get_all( + "DocType", + fields=["`tabDocType`.`name`"], + filters=filters, + order_by="`tabDocType`.`idx` desc", + limit_start=start, + limit_page_length=page_len, + as_list=1, + ) + + custom_dt_filters = [ + ["Custom Field", "dt", "like", "%{0}%".format(txt)], + ["Custom Field", "options", "=", "User"], + ["Custom Field", "fieldtype", "=", "Link"], + ] + + custom_doctypes = frappe.get_all( + "Custom Field", fields=["dt as name"], filters=custom_dt_filters, as_list=1 + ) return doctypes + custom_doctypes + @frappe.whitelist() def get_user_id(parent): - data = frappe.get_all('DocField', fields = ['label', 'fieldname as value'], - filters= {'options': 'User', 'fieldtype': 'Link', 'parent': parent}) or [] - - data.extend(frappe.get_all('Custom Field', fields = ['label', 'fieldname as value'], - filters= {'options': 'User', 'fieldtype': 'Link', 'dt': parent})) + data = ( + frappe.get_all( + "DocField", + fields=["label", "fieldname as value"], + filters={"options": "User", "fieldtype": "Link", "parent": parent}, + ) + or [] + ) + + data.extend( + frappe.get_all( + "Custom Field", + fields=["label", "fieldname as value"], + filters={"options": "User", "fieldtype": "Link", "dt": parent}, + ) + ) return data + def user_linked_with_permission_on_doctype(doc, user): if not doc.apply_user_permission_on: return True if not doc.user_id_field: - frappe.throw(_('User Id Field is mandatory in the user type {0}') - .format(frappe.bold(doc.name))) + frappe.throw(_("User Id Field is mandatory in the user type {0}").format(frappe.bold(doc.name))) - if frappe.db.get_value(doc.apply_user_permission_on, - {doc.user_id_field: user}, 'name'): + if frappe.db.get_value(doc.apply_user_permission_on, {doc.user_id_field: user}, "name"): return True else: label = frappe.get_meta(doc.apply_user_permission_on).get_field(doc.user_id_field).label - frappe.msgprint(_("To set the role {0} in the user {1}, kindly set the {2} field as {3} in one of the {4} record.") - .format(frappe.bold(doc.role), frappe.bold(user), frappe.bold(label), - frappe.bold(user), frappe.bold(doc.apply_user_permission_on))) + frappe.msgprint( + _( + "To set the role {0} in the user {1}, kindly set the {2} field as {3} in one of the {4} record." + ).format( + frappe.bold(doc.role), + frappe.bold(user), + frappe.bold(label), + frappe.bold(user), + frappe.bold(doc.apply_user_permission_on), + ) + ) return False + def apply_permissions_for_non_standard_user_type(doc, method=None): - '''Create user permission for the non standard user type''' - if not frappe.db.table_exists('User Type'): + """Create user permission for the non standard user type""" + if not frappe.db.table_exists("User Type"): return - user_types = frappe.cache().get_value('non_standard_user_types') + user_types = frappe.cache().get_value("non_standard_user_types") if not user_types: user_types = get_non_standard_user_type_details() @@ -247,23 +300,28 @@ def apply_permissions_for_non_standard_user_type(doc, method=None): return for user_type, data in user_types.items(): - if (not doc.get(data[1]) or doc.doctype != data[0]): + if not doc.get(data[1]) or doc.doctype != data[0]: continue - if frappe.get_cached_value('User', doc.get(data[1]), 'user_type') != user_type: + if frappe.get_cached_value("User", doc.get(data[1]), "user_type") != user_type: return - if (doc.get(data[1]) and (not doc._doc_before_save or doc.get(data[1]) != doc._doc_before_save.get(data[1]) - or not frappe.db.get_value('User Permission', - {'user': doc.get(data[1]), 'allow': data[0], 'for_value': doc.name}, 'name'))): + if doc.get(data[1]) and ( + not doc._doc_before_save + or doc.get(data[1]) != doc._doc_before_save.get(data[1]) + or not frappe.db.get_value( + "User Permission", {"user": doc.get(data[1]), "allow": data[0], "for_value": doc.name}, "name" + ) + ): - perm_data = frappe.db.get_value('User Permission', - {'allow': doc.doctype, 'for_value': doc.name}, ['name', 'user']) + perm_data = frappe.db.get_value( + "User Permission", {"allow": doc.doctype, "for_value": doc.name}, ["name", "user"] + ) if not perm_data: - user_doc = frappe.get_cached_doc('User', doc.get(data[1])) + user_doc = frappe.get_cached_doc("User", doc.get(data[1])) user_doc.set_roles_and_modules_based_on_user_type() user_doc.update_children() add_user_permission(doc.doctype, doc.name, doc.get(data[1])) else: - frappe.db.set_value('User Permission', perm_data[0], 'user', doc.get(data[1])) + frappe.db.set_value("User Permission", perm_data[0], "user", doc.get(data[1])) diff --git a/frappe/core/doctype/user_type/user_type_dashboard.py b/frappe/core/doctype/user_type/user_type_dashboard.py index 6cdd2f82a5..65217cb66b 100644 --- a/frappe/core/doctype/user_type/user_type_dashboard.py +++ b/frappe/core/doctype/user_type/user_type_dashboard.py @@ -1,13 +1,5 @@ - from frappe import _ + def get_data(): - return { - 'fieldname': 'user_type', - 'transactions': [ - { - 'label': _('Reference'), - 'items': ['User'] - } - ] - } \ No newline at end of file + return {"fieldname": "user_type", "transactions": [{"label": _("Reference"), "items": ["User"]}]} diff --git a/frappe/core/doctype/user_type_module/user_type_module.py b/frappe/core/doctype/user_type_module/user_type_module.py index d25479f869..83662bfcaf 100644 --- a/frappe/core/doctype/user_type_module/user_type_module.py +++ b/frappe/core/doctype/user_type_module/user_type_module.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class UserTypeModule(Document): pass diff --git a/frappe/core/doctype/version/test_version.py b/frappe/core/doctype/version/test_version.py index 608dc9f0ab..c35430b17b 100644 --- a/frappe/core/doctype/version/test_version.py +++ b/frappe/core/doctype/version/test_version.py @@ -1,39 +1,45 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import copy +import unittest + import frappe -import unittest, copy -from frappe.test_runner import make_test_objects from frappe.core.doctype.version.version import get_diff +from frappe.test_runner import make_test_objects + class TestVersion(unittest.TestCase): def test_get_diff(self): - frappe.set_user('Administrator') - test_records = make_test_objects('Event', reset = True) + frappe.set_user("Administrator") + test_records = make_test_objects("Event", reset=True) old_doc = frappe.get_doc("Event", test_records[0]) new_doc = copy.deepcopy(old_doc) old_doc.color = None - new_doc.color = '#fafafa' + new_doc.color = "#fafafa" - diff = get_diff(old_doc, new_doc)['changed'] + diff = get_diff(old_doc, new_doc)["changed"] - self.assertEqual(get_fieldnames(diff)[0], 'color') + self.assertEqual(get_fieldnames(diff)[0], "color") self.assertTrue(get_old_values(diff)[0] is None) - self.assertEqual(get_new_values(diff)[0], '#fafafa') + self.assertEqual(get_new_values(diff)[0], "#fafafa") new_doc.starts_on = "2017-07-20" - diff = get_diff(old_doc, new_doc)['changed'] + diff = get_diff(old_doc, new_doc)["changed"] + + self.assertEqual(get_fieldnames(diff)[1], "starts_on") + self.assertEqual(get_old_values(diff)[1], "01-01-2014 00:00:00") + self.assertEqual(get_new_values(diff)[1], "07-20-2017 00:00:00") - self.assertEqual(get_fieldnames(diff)[1], 'starts_on') - self.assertEqual(get_old_values(diff)[1], '01-01-2014 00:00:00') - self.assertEqual(get_new_values(diff)[1], '07-20-2017 00:00:00') def get_fieldnames(change_array): return [d[0] for d in change_array] + def get_old_values(change_array): return [d[1] for d in change_array] + def get_new_values(change_array): return [d[2] for d in change_array] diff --git a/frappe/core/doctype/version/version.py b/frappe/core/doctype/version/version.py index fcb558650a..540f8c7a02 100644 --- a/frappe/core/doctype/version/version.py +++ b/frappe/core/doctype/version/version.py @@ -1,14 +1,16 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, json +import json -from frappe.model.document import Document +import frappe from frappe.model import no_value_fields, table_fields +from frappe.model.document import Document + class Version(Document): def set_diff(self, old, new): - '''Set the data property with the diff of the docs if present''' + """Set the data property with the diff of the docs if present""" diff = get_diff(old, new) if diff: self.ref_doctype = new.doctype @@ -21,9 +23,9 @@ class Version(Document): def for_insert(self, doc): updater_reference = doc.flags.updater_reference data = { - 'creation': doc.creation, - 'updater_reference': updater_reference, - 'created_by': doc.owner + "creation": doc.creation, + "updater_reference": updater_reference, + "created_by": doc.owner, } self.ref_doctype = doc.doctype self.docname = doc.name @@ -34,20 +36,20 @@ class Version(Document): def get_diff(old, new, for_child=False): - '''Get diff between 2 document objects + """Get diff between 2 document objects If there is a change, then returns a dict like: - { - "changed" : [[fieldname1, old, new], [fieldname2, old, new]], - "added" : [[table_fieldname1, {dict}], ], - "removed" : [[table_fieldname1, {dict}], ], - "row_changed": [[table_fieldname1, row_name1, row_index, - [[child_fieldname1, old, new], - [child_fieldname2, old, new]], ] - ], + { + "changed" : [[fieldname1, old, new], [fieldname2, old, new]], + "added" : [[table_fieldname1, {dict}], ], + "removed" : [[table_fieldname1, {dict}], ], + "row_changed": [[table_fieldname1, row_name1, row_index, + [[child_fieldname1, old, new], + [child_fieldname2, old, new]], ] + ], - }''' + }""" if not new: return None @@ -57,8 +59,14 @@ def get_diff(old, new, for_child=False): data_import = new.flags.via_data_import updater_reference = new.flags.updater_reference - out = frappe._dict(changed = [], added = [], removed = [], - row_changed = [], data_import=data_import, updater_reference=updater_reference) + out = frappe._dict( + changed=[], + added=[], + removed=[], + row_changed=[], + data_import=data_import, + updater_reference=updater_reference, + ) for df in new.meta.fields: if df.fieldtype in no_value_fields and df.fieldtype not in table_fields: @@ -88,7 +96,7 @@ def get_diff(old, new, for_child=False): if not d.name in new_row_by_name: out.removed.append([df.fieldname, d.as_dict()]) - elif (old_value != new_value): + elif old_value != new_value: if df.fieldtype not in blacklisted_fields: old_value = old.get_formatted(df.fieldname) if old_value else old_value new_value = new.get_formatted(df.fieldname) if new_value else new_value @@ -98,7 +106,7 @@ def get_diff(old, new, for_child=False): # docstatus if not for_child and old.docstatus != new.docstatus: - out.changed.append(['docstatus', old.docstatus, new.docstatus]) + out.changed.append(["docstatus", old.docstatus, new.docstatus]) if any((out.changed, out.added, out.removed, out.row_changed)): return out @@ -106,5 +114,6 @@ def get_diff(old, new, for_child=False): else: return None + def on_doctype_update(): frappe.db.add_index("Version", ["ref_doctype", "docname"]) diff --git a/frappe/core/doctype/view_log/test_view_log.py b/frappe/core/doctype/view_log/test_view_log.py index efa9538fbf..04a17cc526 100644 --- a/frappe/core/doctype/view_log/test_view_log.py +++ b/frappe/core/doctype/view_log/test_view_log.py @@ -1,35 +1,36 @@ # -*- coding: utf-8 -*- # Copyright (c) 2018, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + + class TestViewLog(unittest.TestCase): def tearDown(self): - frappe.set_user('Administrator') + frappe.set_user("Administrator") def test_if_user_is_added(self): - ev = frappe.get_doc({ - 'doctype': 'Event', - 'subject': 'test event for view logs', - 'starts_on': '2018-06-04 14:11:00', - 'event_type': 'Public' - }).insert() + ev = frappe.get_doc( + { + "doctype": "Event", + "subject": "test event for view logs", + "starts_on": "2018-06-04 14:11:00", + "event_type": "Public", + } + ).insert() - frappe.set_user('test@example.com') + frappe.set_user("test@example.com") from frappe.desk.form.load import getdoc # load the form - getdoc('Event', ev.name) + getdoc("Event", ev.name) a = frappe.get_value( doctype="View Log", - filters={ - "reference_doctype": "Event", - "reference_name": ev.name - }, - fieldname=['viewed_by'] + filters={"reference_doctype": "Event", "reference_name": ev.name}, + fieldname=["viewed_by"], ) - self.assertEqual('test@example.com', a) - self.assertNotEqual('test1@example.com', a) \ No newline at end of file + self.assertEqual("test@example.com", a) + self.assertNotEqual("test1@example.com", a) diff --git a/frappe/core/doctype/view_log/view_log.py b/frappe/core/doctype/view_log/view_log.py index fbbd6e1154..4a3ba0e83c 100644 --- a/frappe/core/doctype/view_log/view_log.py +++ b/frappe/core/doctype/view_log/view_log.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class ViewLog(Document): pass diff --git a/frappe/core/notifications.py b/frappe/core/notifications.py index 5f41f217f0..a10f8ec5ae 100644 --- a/frappe/core/notifications.py +++ b/frappe/core/notifications.py @@ -14,28 +14,35 @@ def get_notification_config(): "ToDo": "frappe.core.notifications.get_things_todo", "Event": "frappe.core.notifications.get_todays_events", "Error Snapshot": {"seen": 0, "parent_error_snapshot": None}, - "Workflow Action": {"status": 'Open'} + "Workflow Action": {"status": "Open"}, }, } + def get_things_todo(as_list=False): """Returns a count of incomplete todos""" - data = frappe.get_list("ToDo", + data = frappe.get_list( + "ToDo", fields=["name", "description"] if as_list else "count(*)", filters=[["ToDo", "status", "=", "Open"]], - or_filters=[["ToDo", "allocated_to", "=", frappe.session.user], - ["ToDo", "assigned_by", "=", frappe.session.user]], - as_list=True) + or_filters=[ + ["ToDo", "allocated_to", "=", frappe.session.user], + ["ToDo", "assigned_by", "=", frappe.session.user], + ], + as_list=True, + ) if as_list: return data else: return data[0][0] + def get_todays_events(as_list=False): """Returns a count of todays events in calendar""" from frappe.desk.doctype.event.event import get_events from frappe.utils import nowdate + today = nowdate() events = get_events(today, today) return events if as_list else len(events) diff --git a/frappe/core/page/__init__.py b/frappe/core/page/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/core/page/__init__.py +++ b/frappe/core/page/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/core/page/background_jobs/background_jobs.py b/frappe/core/page/background_jobs/background_jobs.py index 960444c349..d3f5e3d32f 100644 --- a/frappe/core/page/background_jobs/background_jobs.py +++ b/frappe/core/page/background_jobs/background_jobs.py @@ -15,59 +15,49 @@ from frappe.utils.scheduler import is_scheduler_inactive if TYPE_CHECKING: from rq.job import Job -JOB_COLORS = { - 'queued': 'orange', - 'failed': 'red', - 'started': 'blue', - 'finished': 'green' -} +JOB_COLORS = {"queued": "orange", "failed": "red", "started": "blue", "finished": "green"} @frappe.whitelist() def get_info(view=None, queue_timeout=None, job_status=None) -> List[Dict]: jobs = [] - def add_job(job: 'Job', name: str) -> None: + def add_job(job: "Job", name: str) -> None: if job_status != "all" and job.get_status() != job_status: return - if queue_timeout != "all" and not name.endswith(f':{queue_timeout}'): + if queue_timeout != "all" and not name.endswith(f":{queue_timeout}"): return - if job.kwargs.get('site') == frappe.local.site: + if job.kwargs.get("site") == frappe.local.site: job_info = { - 'job_name': job.kwargs.get('kwargs', {}).get('playbook_method') - or job.kwargs.get('kwargs', {}).get('job_type') - or str(job.kwargs.get('job_name')), - 'status': job.get_status(), - 'queue': name, - 'creation': convert_utc_to_user_timezone(job.created_at), - 'color': JOB_COLORS[job.get_status()] + "job_name": job.kwargs.get("kwargs", {}).get("playbook_method") + or job.kwargs.get("kwargs", {}).get("job_type") + or str(job.kwargs.get("job_name")), + "status": job.get_status(), + "queue": name, + "creation": convert_utc_to_user_timezone(job.created_at), + "color": JOB_COLORS[job.get_status()], } if job.exc_info: - job_info['exc_info'] = job.exc_info + job_info["exc_info"] = job.exc_info jobs.append(job_info) - if view == 'Jobs': + if view == "Jobs": queues = get_queues() for queue in queues: for job in queue.jobs: add_job(job, queue.name) - elif view == 'Workers': + elif view == "Workers": workers = get_workers() for worker in workers: current_job = worker.get_current_job() - if current_job and current_job.kwargs.get('site') == frappe.local.site: + if current_job and current_job.kwargs.get("site") == frappe.local.site: add_job(current_job, job.origin) else: - jobs.append({ - 'queue': worker.name, - 'job_name': 'idle', - 'status': '', - 'creation': '' - }) + jobs.append({"queue": worker.name, "job_name": "idle", "status": "", "creation": ""}) return jobs @@ -85,5 +75,5 @@ def remove_failed_jobs(): @frappe.whitelist() def get_scheduler_status(): if is_scheduler_inactive(): - return {'status': 'inactive'} - return {'status': 'active'} + return {"status": "inactive"} + return {"status": "active"} diff --git a/frappe/core/page/permission_manager/__init__.py b/frappe/core/page/permission_manager/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/core/page/permission_manager/__init__.py +++ b/frappe/core/page/permission_manager/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/core/page/permission_manager/permission_manager.py b/frappe/core/page/permission_manager/permission_manager.py index 08642c599e..ad12e0fd4c 100644 --- a/frappe/core/page/permission_manager/permission_manager.py +++ b/frappe/core/page/permission_manager/permission_manager.py @@ -2,18 +2,27 @@ # License: MIT. See LICENSE import frappe -from frappe import _ import frappe.defaults +from frappe import _ +from frappe.core.doctype.doctype.doctype import ( + clear_permissions_cache, + validate_permissions_for_doctype, +) from frappe.modules.import_file import get_file_path, read_doc_from_file +from frappe.permissions import ( + add_permission, + get_all_perms, + get_linked_doctypes, + reset_perms, + setup_custom_perms, + update_permission_property, +) from frappe.translate import send_translations -from frappe.core.doctype.doctype.doctype import (clear_permissions_cache, - validate_permissions_for_doctype) -from frappe.permissions import (reset_perms, get_linked_doctypes, get_all_perms, - setup_custom_perms, add_permission, update_permission_property) from frappe.utils.user import get_users_with_role as _get_user_with_role not_allowed_in_permission_manager = ["DocType", "Patch Log", "Module Def", "Transaction Log"] + @frappe.whitelist() def get_roles_and_doctypes(): frappe.only_for("System Manager") @@ -21,38 +30,43 @@ def get_roles_and_doctypes(): active_domains = frappe.get_active_domains() - doctypes = frappe.get_all("DocType", filters={ - "istable": 0, - "name": ("not in", ",".join(not_allowed_in_permission_manager)), - }, or_filters={ - "ifnull(restrict_to_domain, '')": "", - "restrict_to_domain": ("in", active_domains) - }, fields=["name"]) - - restricted_roles = ['Administrator'] - if frappe.session.user != 'Administrator': - custom_user_type_roles = frappe.get_all('User Type', filters = {'is_standard': 0}, fields=['role']) + doctypes = frappe.get_all( + "DocType", + filters={ + "istable": 0, + "name": ("not in", ",".join(not_allowed_in_permission_manager)), + }, + or_filters={"ifnull(restrict_to_domain, '')": "", "restrict_to_domain": ("in", active_domains)}, + fields=["name"], + ) + + restricted_roles = ["Administrator"] + if frappe.session.user != "Administrator": + custom_user_type_roles = frappe.get_all("User Type", filters={"is_standard": 0}, fields=["role"]) for row in custom_user_type_roles: restricted_roles.append(row.role) - restricted_roles.append('All') + restricted_roles.append("All") - roles = frappe.get_all("Role", filters={ - "name": ("not in", restricted_roles), - "disabled": 0, - }, or_filters={ - "ifnull(restrict_to_domain, '')": "", - "restrict_to_domain": ("in", active_domains) - }, fields=["name"]) + roles = frappe.get_all( + "Role", + filters={ + "name": ("not in", restricted_roles), + "disabled": 0, + }, + or_filters={"ifnull(restrict_to_domain, '')": "", "restrict_to_domain": ("in", active_domains)}, + fields=["name"], + ) - doctypes_list = [ {"label":_(d.get("name")), "value":d.get("name")} for d in doctypes] - roles_list = [ {"label":_(d.get("name")), "value":d.get("name")} for d in roles] + doctypes_list = [{"label": _(d.get("name")), "value": d.get("name")} for d in doctypes] + roles_list = [{"label": _(d.get("name")), "value": d.get("name")} for d in roles] return { - "doctypes": sorted(doctypes_list, key=lambda d: d['label']), - "roles": sorted(roles_list, key=lambda d: d['label']) + "doctypes": sorted(doctypes_list, key=lambda d: d["label"]), + "roles": sorted(roles_list, key=lambda d: d["label"]), } + @frappe.whitelist() def get_permissions(doctype=None, role=None): frappe.only_for("System Manager") @@ -61,14 +75,14 @@ def get_permissions(doctype=None, role=None): if doctype: out = [p for p in out if p.parent == doctype] else: - filters=dict(parent = doctype) - if frappe.session.user != 'Administrator': - custom_roles = frappe.get_all('Role', filters={'is_custom': 1}) - filters['role'] = ['not in', [row.name for row in custom_roles]] + filters = dict(parent=doctype) + if frappe.session.user != "Administrator": + custom_roles = frappe.get_all("Role", filters={"is_custom": 1}) + filters["role"] = ["not in", [row.name for row in custom_roles]] - out = frappe.get_all('Custom DocPerm', fields='*', filters=filters, order_by="permlevel") + out = frappe.get_all("Custom DocPerm", fields="*", filters=filters, order_by="permlevel") if not out: - out = frappe.get_all('DocPerm', fields='*', filters=filters, order_by="permlevel") + out = frappe.get_all("DocPerm", fields="*", filters=filters, order_by="permlevel") linked_doctypes = {} for d in out: @@ -82,28 +96,31 @@ def get_permissions(doctype=None, role=None): return out + @frappe.whitelist() def add(parent, role, permlevel): frappe.only_for("System Manager") add_permission(parent, role, permlevel) + @frappe.whitelist() def update(doctype, role, permlevel, ptype, value=None): """Update role permission params Args: - doctype (str): Name of the DocType to update params for - role (str): Role to be updated for, eg "Website Manager". - permlevel (int): perm level the provided rule applies to - ptype (str): permission type, example "read", "delete", etc. - value (None, optional): value for ptype, None indicates False + doctype (str): Name of the DocType to update params for + role (str): Role to be updated for, eg "Website Manager". + permlevel (int): perm level the provided rule applies to + ptype (str): permission type, example "read", "delete", etc. + value (None, optional): value for ptype, None indicates False Returns: - str: Refresh flag is permission is updated successfully + str: Refresh flag is permission is updated successfully """ frappe.only_for("System Manager") out = update_permission_property(doctype, role, permlevel, ptype, value) - return 'refresh' if out else None + return "refresh" if out else None + @frappe.whitelist() def remove(doctype, role, permlevel): @@ -112,28 +129,31 @@ def remove(doctype, role, permlevel): frappe.db.delete("Custom DocPerm", {"parent": doctype, "role": role, "permlevel": permlevel}) - if not frappe.get_all('Custom DocPerm', {"parent": doctype}): - frappe.throw(_('There must be atleast one permission rule.'), title=_('Cannot Remove')) + if not frappe.get_all("Custom DocPerm", {"parent": doctype}): + frappe.throw(_("There must be atleast one permission rule."), title=_("Cannot Remove")) validate_permissions_for_doctype(doctype, for_remove=True, alert=True) + @frappe.whitelist() def reset(doctype): frappe.only_for("System Manager") reset_perms(doctype) clear_permissions_cache(doctype) + @frappe.whitelist() def get_users_with_role(role): frappe.only_for("System Manager") return _get_user_with_role(role) + @frappe.whitelist() def get_standard_permissions(doctype): frappe.only_for("System Manager") meta = frappe.get_meta(doctype) if meta.custom: - doc = frappe.get_doc('DocType', doctype) + doc = frappe.get_doc("DocType", doctype) return [p.as_dict() for p in doc.permissions] else: # also used to setup permissions via patch diff --git a/frappe/core/report/__init__.py b/frappe/core/report/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/core/report/__init__.py +++ b/frappe/core/report/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/core/report/permitted_documents_for_user/permitted_documents_for_user.py b/frappe/core/report/permitted_documents_for_user/permitted_documents_for_user.py index 535d354250..32d8bbe18f 100644 --- a/frappe/core/report/permitted_documents_for_user/permitted_documents_for_user.py +++ b/frappe/core/report/permitted_documents_for_user/permitted_documents_for_user.py @@ -2,21 +2,27 @@ # License: MIT. See LICENSE import frappe -from frappe import _, throw import frappe.utils.user -from frappe.permissions import check_admin_or_system_manager, rights +from frappe import _, throw from frappe.model import data_fieldtypes +from frappe.permissions import check_admin_or_system_manager, rights + def execute(filters=None): - user, doctype, show_permissions = filters.get("user"), filters.get("doctype"), filters.get("show_permissions") + user, doctype, show_permissions = ( + filters.get("user"), + filters.get("doctype"), + filters.get("show_permissions"), + ) - if not validate(user, doctype): return [], [] + if not validate(user, doctype): + return [], [] columns, fields = get_columns_and_fields(doctype) data = frappe.get_list(doctype, fields=fields, as_list=True, user=user) if show_permissions: - columns = columns + [frappe.unscrub(right) + ':Check:80' for right in rights] + columns = columns + [frappe.unscrub(right) + ":Check:80" for right in rights] data = list(data) for i, doc in enumerate(data): permission = frappe.permissions.get_doc_permissions(frappe.get_doc(doctype, doc[0]), user) @@ -24,29 +30,36 @@ def execute(filters=None): return columns, data + def validate(user, doctype): # check if current user is System Manager check_admin_or_system_manager() return user and doctype + def get_columns_and_fields(doctype): columns = ["Name:Link/{}:200".format(doctype)] fields = ["`name`"] for df in frappe.get_meta(doctype).fields: if df.in_list_view and df.fieldtype in data_fieldtypes: fields.append("`{0}`".format(df.fieldname)) - fieldtype = "Link/{}".format(df.options) if df.fieldtype=="Link" else df.fieldtype - columns.append("{label}:{fieldtype}:{width}".format(label=df.label, fieldtype=fieldtype, width=df.width or 100)) + fieldtype = "Link/{}".format(df.options) if df.fieldtype == "Link" else df.fieldtype + columns.append( + "{label}:{fieldtype}:{width}".format( + label=df.label, fieldtype=fieldtype, width=df.width or 100 + ) + ) return columns, fields + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def query_doctypes(doctype, txt, searchfield, start, page_len, filters): user = filters.get("user") user_perms = frappe.utils.user.UserPermissions(user) user_perms.build_permissions() - can_read = user_perms.can_read # Does not include child tables + can_read = user_perms.can_read # Does not include child tables single_doctypes = [d[0] for d in frappe.db.get_values("DocType", {"issingle": 1})] diff --git a/frappe/core/report/transaction_log_report/transaction_log_report.py b/frappe/core/report/transaction_log_report/transaction_log_report.py index e9c68cb0c7..51a01ffc57 100644 --- a/frappe/core/report/transaction_log_report/transaction_log_report.py +++ b/frappe/core/report/transaction_log_report/transaction_log_report.py @@ -1,16 +1,19 @@ # Copyright (c) 2021, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe import hashlib + +import frappe from frappe import _ from frappe.utils import format_datetime + def execute(filters=None): columns, data = get_columns(filters), get_data(filters) return columns, data + def get_data(filters=None): result = [] logs = frappe.get_all("Transaction Log", fields=["*"], order_by="creation desc") @@ -26,14 +29,35 @@ def get_data(filters=None): if not previous_hash: integrity = False else: - integrity = check_data_integrity(l.chaining_hash, l.transaction_hash, l.previous_hash, previous_hash[0][0]) + integrity = check_data_integrity( + l.chaining_hash, l.transaction_hash, l.previous_hash, previous_hash[0][0] + ) - result.append([_(str(integrity)), _(l.reference_doctype), l.document_name, l.owner, l.modified_by, format_datetime(l.timestamp, "YYYYMMDDHHmmss")]) + result.append( + [ + _(str(integrity)), + _(l.reference_doctype), + l.document_name, + l.owner, + l.modified_by, + format_datetime(l.timestamp, "YYYYMMDDHHmmss"), + ] + ) else: - result.append([_("First Transaction"), _(l.reference_doctype), l.document_name, l.owner, l.modified_by, format_datetime(l.timestamp, "YYYYMMDDHHmmss")]) + result.append( + [ + _("First Transaction"), + _(l.reference_doctype), + l.document_name, + l.owner, + l.modified_by, + format_datetime(l.timestamp, "YYYYMMDDHHmmss"), + ] + ) return result + def check_data_integrity(chaining_hash, transaction_hash, registered_previous_hash, previous_hash): if registered_previous_hash != previous_hash: return False @@ -45,6 +69,7 @@ def check_data_integrity(chaining_hash, transaction_hash, registered_previous_ha else: return True + def calculate_chain(transaction_hash, previous_hash): sha = hashlib.sha256() sha.update(str(transaction_hash) + str(previous_hash)) @@ -57,37 +82,17 @@ def get_columns(filters=None): "label": _("Chain Integrity"), "fieldname": "chain_integrity", "fieldtype": "Data", - "width": 150 + "width": 150, }, { "label": _("Reference Doctype"), "fieldname": "reference_doctype", "fieldtype": "Data", - "width": 150 - }, - { - "label": _("Reference Name"), - "fieldname": "reference_name", - "fieldtype": "Data", - "width": 150 - }, - { - "label": _("Owner"), - "fieldname": "owner", - "fieldtype": "Data", - "width": 100 + "width": 150, }, - { - "label": _("Modified By"), - "fieldname": "modified_by", - "fieldtype": "Data", - "width": 100 - }, - { - "label": _("Timestamp"), - "fieldname": "timestamp", - "fieldtype": "Data", - "width": 100 - } + {"label": _("Reference Name"), "fieldname": "reference_name", "fieldtype": "Data", "width": 150}, + {"label": _("Owner"), "fieldname": "owner", "fieldtype": "Data", "width": 100}, + {"label": _("Modified By"), "fieldname": "modified_by", "fieldtype": "Data", "width": 100}, + {"label": _("Timestamp"), "fieldname": "timestamp", "fieldtype": "Data", "width": 100}, ] return columns diff --git a/frappe/core/utils.py b/frappe/core/utils.py index d4690cae89..8581f30f89 100644 --- a/frappe/core/utils.py +++ b/frappe/core/utils.py @@ -13,6 +13,7 @@ def get_parent_doc(doc): doc.parent_doc = None return doc.parent_doc + def set_timeline_doc(doc): """Set timeline_doctype and timeline_name""" parent_doc = get_parent_doc(doc) @@ -33,47 +34,50 @@ def set_timeline_doc(doc): else: return + def find(list_of_dict, match_function): - '''Returns a dict in a list of dicts on matching the conditions - provided in match function + """Returns a dict in a list of dicts on matching the conditions + provided in match function Usage: - list_of_dict = [{'name': 'Suraj'}, {'name': 'Aditya'}] + list_of_dict = [{'name': 'Suraj'}, {'name': 'Aditya'}] - required_dict = find(list_of_dict, lambda d: d['name'] == 'Aditya') - ''' + required_dict = find(list_of_dict, lambda d: d['name'] == 'Aditya') + """ for entry in list_of_dict: if match_function(entry): return entry return None + def find_all(list_of_dict, match_function): - '''Returns all matching dicts in a list of dicts. - Uses matching function to filter out the dicts + """Returns all matching dicts in a list of dicts. + Uses matching function to filter out the dicts Usage: - colored_shapes = [ - {'color': 'red', 'shape': 'square'}, - {'color': 'red', 'shape': 'circle'}, - {'color': 'blue', 'shape': 'triangle'} - ] - - red_shapes = find_all(colored_shapes, lambda d: d['color'] == 'red') - ''' + colored_shapes = [ + {'color': 'red', 'shape': 'square'}, + {'color': 'red', 'shape': 'circle'}, + {'color': 'blue', 'shape': 'triangle'} + ] + + red_shapes = find_all(colored_shapes, lambda d: d['color'] == 'red') + """ found = [] for entry in list_of_dict: if match_function(entry): found.append(entry) return found + def ljust_list(_list, length, fill_word=None): """ Similar to ljust but for list. Usage: - $ ljust_list([1, 2, 3], 5) - > [1, 2, 3, None, None] + $ ljust_list([1, 2, 3], 5) + > [1, 2, 3, None, None] """ # make a copy to avoid mutation of passed list _list = list(_list) diff --git a/frappe/core/web_form/edit_profile/edit_profile.py b/frappe/core/web_form/edit_profile/edit_profile.py index e1ada61927..80b7b87352 100644 --- a/frappe/core/web_form/edit_profile/edit_profile.py +++ b/frappe/core/web_form/edit_profile/edit_profile.py @@ -1,5 +1,6 @@ import frappe + def get_context(context): # do your magic here pass diff --git a/frappe/coverage.py b/frappe/coverage.py index 5f89800deb..ffa3576818 100644 --- a/frappe/coverage.py +++ b/frappe/coverage.py @@ -10,18 +10,18 @@ STANDARD_INCLUSIONS = ["*.py"] STANDARD_EXCLUSIONS = [ - '*.js', - '*.xml', - '*.pyc', - '*.css', - '*.less', - '*.scss', - '*.vue', - '*.html', - '*/test_*', - '*/node_modules/*', - '*/doctype/*/*_dashboard.py', - '*/patches/*', + "*.js", + "*.xml", + "*.pyc", + "*.css", + "*.less", + "*.scss", + "*.vue", + "*.html", + "*/test_*", + "*/node_modules/*", + "*/doctype/*/*_dashboard.py", + "*/patches/*", ] FRAPPE_EXCLUSIONS = [ @@ -35,22 +35,25 @@ FRAPPE_EXCLUSIONS = [ "*/patches/*", ] -class CodeCoverage(): + +class CodeCoverage: def __init__(self, with_coverage, app): self.with_coverage = with_coverage - self.app = app or 'frappe' + self.app = app or "frappe" def __enter__(self): if self.with_coverage: import os + from coverage import Coverage + from frappe.utils import get_bench_path # Generate coverage report only for app that is being tested - source_path = os.path.join(get_bench_path(), 'apps', self.app) + source_path = os.path.join(get_bench_path(), "apps", self.app) omit = STANDARD_EXCLUSIONS[:] - if self.app == 'frappe': + if self.app == "frappe": omit.extend(FRAPPE_EXCLUSIONS) self.coverage = Coverage(source=[source_path], omit=omit, include=STANDARD_INCLUSIONS) @@ -60,4 +63,4 @@ class CodeCoverage(): if self.with_coverage: self.coverage.stop() self.coverage.save() - self.coverage.xml_report() \ No newline at end of file + self.coverage.xml_report() diff --git a/frappe/custom/doctype/client_script/__init__.py b/frappe/custom/doctype/client_script/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/custom/doctype/client_script/__init__.py +++ b/frappe/custom/doctype/client_script/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/custom/doctype/client_script/client_script.py b/frappe/custom/doctype/client_script/client_script.py index fd6bc9accd..3039e0a4a5 100644 --- a/frappe/custom/doctype/client_script/client_script.py +++ b/frappe/custom/doctype/client_script/client_script.py @@ -1,7 +1,6 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE import frappe - from frappe import _ from frappe.model.document import Document @@ -14,9 +13,7 @@ class ClientScript(Document): if not self.is_new(): return - exists = frappe.db.exists( - "Client Script", {"dt": self.dt, "view": self.view} - ) + exists = frappe.db.exists("Client Script", {"dt": self.dt, "view": self.view}) if exists: frappe.throw( _("Client Script for {0} {1} already exists").format(frappe.bold(self.dt), self.view), diff --git a/frappe/custom/doctype/client_script/test_client_script.py b/frappe/custom/doctype/client_script/test_client_script.py index 4887956001..2538fdf515 100644 --- a/frappe/custom/doctype/client_script/test_client_script.py +++ b/frappe/custom/doctype/client_script/test_client_script.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Client Script') + class TestClientScript(unittest.TestCase): pass diff --git a/frappe/custom/doctype/custom_field/__init__.py b/frappe/custom/doctype/custom_field/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/custom/doctype/custom_field/__init__.py +++ b/frappe/custom/doctype/custom_field/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/custom/doctype/custom_field/custom_field.py b/frappe/custom/doctype/custom_field/custom_field.py index fdd7bf3134..10ee4a503f 100644 --- a/frappe/custom/doctype/custom_field/custom_field.py +++ b/frappe/custom/doctype/custom_field/custom_field.py @@ -1,14 +1,16 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import json -from frappe.utils import cstr + +import frappe from frappe import _ -from frappe.model.document import Document -from frappe.model.docfield import supports_translation from frappe.model import core_doctypes_list +from frappe.model.docfield import supports_translation +from frappe.model.document import Document from frappe.query_builder.functions import IfNull +from frappe.utils import cstr + class CustomField(Document): def autoname(self): @@ -25,8 +27,9 @@ class CustomField(Document): frappe.throw(_("Label is mandatory")) # remove special characters from fieldname - self.fieldname = "".join(filter(lambda x: x.isdigit() or x.isalpha() or '_', - cstr(label).replace(' ','_'))) + self.fieldname = "".join( + filter(lambda x: x.isdigit() or x.isalpha() or "_", cstr(label).replace(" ", "_")) + ) # fieldnames should be lowercase self.fieldname = self.fieldname.lower() @@ -36,8 +39,8 @@ class CustomField(Document): def validate(self): # these imports have been added to avoid cyclical import, should fix in future - from frappe.custom.doctype.customize_form.customize_form import CustomizeForm from frappe.core.doctype.doctype.doctype import check_fieldname_conflicts + from frappe.custom.doctype.customize_form.customize_form import CustomizeForm # don't always get meta to improve performance # setting idx is just an improvement, not a requirement @@ -47,8 +50,9 @@ class CustomField(Document): if self.is_new() and self.fieldname in fieldnames: frappe.throw( - _("A field with the name {0} already exists in {1}") - .format(frappe.bold(self.fieldname), self.dt) + _("A field with the name {0} already exists in {1}").format( + frappe.bold(self.fieldname), self.dt + ) ) if self.insert_after == "append": @@ -64,14 +68,13 @@ class CustomField(Document): and not CustomizeForm.allow_fieldtype_change(old_fieldtype, self.fieldtype) ): frappe.throw( - _("Fieldtype cannot be changed from {0} to {1}") - .format(old_fieldtype, self.fieldtype) + _("Fieldtype cannot be changed from {0} to {1}").format(old_fieldtype, self.fieldtype) ) if not self.fieldname: frappe.throw(_("Fieldname not set for Custom Field")) - if self.get('translatable', 0) and not supports_translation(self.fieldtype): + if self.get("translatable", 0) and not supports_translation(self.fieldtype): self.translatable = 0 check_fieldname_conflicts(self) @@ -83,33 +86,39 @@ class CustomField(Document): if not self.flags.ignore_validate: # validate field from frappe.core.doctype.doctype.doctype import validate_fields_for_doctype + validate_fields_for_doctype(self.dt) # update the schema - if not frappe.db.get_value('DocType', self.dt, 'issingle') and not frappe.flags.in_setup_wizard: + if not frappe.db.get_value("DocType", self.dt, "issingle") and not frappe.flags.in_setup_wizard: frappe.db.updatedb(self.dt) def on_trash(self): - #check if Admin owned field - if self.owner == 'Administrator' and frappe.session.user != 'Administrator': - frappe.throw(_("Custom Field {0} is created by the Administrator and can only be deleted through the Administrator account.").format( - frappe.bold(self.label))) + # check if Admin owned field + if self.owner == "Administrator" and frappe.session.user != "Administrator": + frappe.throw( + _( + "Custom Field {0} is created by the Administrator and can only be deleted through the Administrator account." + ).format(frappe.bold(self.label)) + ) # delete property setter entries - frappe.db.delete("Property Setter", { - "doc_type": self.dt, - "field_name": self.fieldname - }) + frappe.db.delete("Property Setter", {"doc_type": self.dt, "field_name": self.fieldname}) frappe.clear_cache(doctype=self.dt) def validate_insert_after(self, meta): if not meta.get_field(self.insert_after): - frappe.throw(_("Insert After field '{0}' mentioned in Custom Field '{1}', with label '{2}', does not exist") - .format(self.insert_after, self.name, self.label), frappe.DoesNotExistError) + frappe.throw( + _( + "Insert After field '{0}' mentioned in Custom Field '{1}', with label '{2}', does not exist" + ).format(self.insert_after, self.name, self.label), + frappe.DoesNotExistError, + ) if self.fieldname == self.insert_after: frappe.throw(_("Insert After cannot be set as {0}").format(meta.get_label(self.insert_after))) + @frappe.whitelist() def get_fields_label(doctype=None): meta = frappe.get_meta(doctype) @@ -120,36 +129,44 @@ def get_fields_label(doctype=None): if meta.custom: return frappe.msgprint(_("Custom Fields can only be added to a standard DocType.")) - return [{"value": df.fieldname or "", "label": _(df.label or "")} - for df in frappe.get_meta(doctype).get("fields")] + return [ + {"value": df.fieldname or "", "label": _(df.label or "")} + for df in frappe.get_meta(doctype).get("fields") + ] + def create_custom_field_if_values_exist(doctype, df): df = frappe._dict(df) - if df.fieldname in frappe.db.get_table_columns(doctype) and \ - frappe.db.count(dt=doctype, filters=IfNull(df.fieldname, "") != ""): + if df.fieldname in frappe.db.get_table_columns(doctype) and frappe.db.count( + dt=doctype, filters=IfNull(df.fieldname, "") != "" + ): create_custom_field(doctype, df) + def create_custom_field(doctype, df, ignore_validate=False, is_system_generated=True): df = frappe._dict(df) if not df.fieldname and df.label: df.fieldname = frappe.scrub(df.label) if not frappe.db.get_value("Custom Field", {"dt": doctype, "fieldname": df.fieldname}): - custom_field = frappe.get_doc({ - "doctype":"Custom Field", - "dt": doctype, - "permlevel": 0, - "fieldtype": 'Data', - "hidden": 0, - "is_system_generated": is_system_generated - }) + custom_field = frappe.get_doc( + { + "doctype": "Custom Field", + "dt": doctype, + "permlevel": 0, + "fieldtype": "Data", + "hidden": 0, + "is_system_generated": is_system_generated, + } + ) custom_field.update(df) custom_field.flags.ignore_validate = ignore_validate custom_field.insert() -def create_custom_fields(custom_fields, ignore_validate = False, update=True): - '''Add / update multiple custom fields - :param custom_fields: example `{'Sales Invoice': [dict(fieldname='test')]}`''' +def create_custom_fields(custom_fields, ignore_validate=False, update=True): + """Add / update multiple custom fields + + :param custom_fields: example `{'Sales Invoice': [dict(fieldname='test')]}`""" if not ignore_validate and frappe.flags.in_setup_wizard: ignore_validate = True @@ -182,7 +199,6 @@ def create_custom_fields(custom_fields, ignore_validate = False, update=True): frappe.db.updatedb(doctype) - @frappe.whitelist() def add_custom_field(doctype, df): df = json.loads(df) diff --git a/frappe/custom/doctype/custom_field/test_custom_field.py b/frappe/custom/doctype/custom_field/test_custom_field.py index ad3cf27eea..519ea7f2b4 100644 --- a/frappe/custom/doctype/custom_field/test_custom_field.py +++ b/frappe/custom/doctype/custom_field/test_custom_field.py @@ -3,9 +3,10 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + test_records = frappe.get_test_records("Custom Field") @@ -36,12 +37,6 @@ class TestCustomField(unittest.TestCase): frappe.db.commit() - self.assertTrue( - frappe.db.exists("Custom Field", "Address-_test_custom_field_1") - ) - self.assertTrue( - frappe.db.exists("Custom Field", "Address-_test_custom_field_2") - ) - self.assertTrue( - frappe.db.exists("Custom Field", "Contact-_test_custom_field_2") - ) + self.assertTrue(frappe.db.exists("Custom Field", "Address-_test_custom_field_1")) + self.assertTrue(frappe.db.exists("Custom Field", "Address-_test_custom_field_2")) + self.assertTrue(frappe.db.exists("Custom Field", "Contact-_test_custom_field_2")) diff --git a/frappe/custom/doctype/customize_form/__init__.py b/frappe/custom/doctype/customize_form/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/custom/doctype/customize_form/__init__.py +++ b/frappe/custom/doctype/customize_form/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/custom/doctype/customize_form/customize_form.py b/frappe/custom/doctype/customize_form/customize_form.py index 5ec5cae121..b4ccb21167 100644 --- a/frappe/custom/doctype/customize_form/customize_form.py +++ b/frappe/custom/doctype/customize_form/customize_form.py @@ -6,17 +6,21 @@ Thus providing a better UI from user perspective """ import json + import frappe import frappe.translate from frappe import _ -from frappe.utils import cint -from frappe.model.document import Document -from frappe.model import no_value_fields, core_doctypes_list -from frappe.core.doctype.doctype.doctype import validate_fields_for_doctype, check_email_append_to +from frappe.core.doctype.doctype.doctype import ( + check_email_append_to, + validate_fields_for_doctype, + validate_series, +) from frappe.custom.doctype.custom_field.custom_field import create_custom_field from frappe.custom.doctype.property_setter.property_setter import delete_property_setter +from frappe.model import core_doctypes_list, no_value_fields from frappe.model.docfield import supports_translation -from frappe.core.doctype.doctype.doctype import validate_series +from frappe.model.document import Document +from frappe.utils import cint class CustomizeForm(Document): @@ -39,16 +43,16 @@ class CustomizeForm(Document): # load custom translation translation = self.get_name_translation() - self.label = translation.translated_text if translation else '' + self.label = translation.translated_text if translation else "" self.create_auto_repeat_custom_field_if_required(meta) # NOTE doc (self) is sent to clientside by run_method def validate_doctype(self, meta): - ''' + """ Check if the doctype is allowed to be customized. - ''' + """ if self.doc_type in core_doctypes_list: frappe.throw(_("Core DocTypes cannot be customized.")) @@ -59,9 +63,9 @@ class CustomizeForm(Document): frappe.throw(_("Only standard DocTypes are allowed to be customized from Customize Form.")) def load_properties(self, meta): - ''' + """ Load the customize object (this) with the metadata properties - ''' + """ # doctype properties for prop in doctype_properties: self.set(prop, meta.get(prop)) @@ -71,20 +75,20 @@ class CustomizeForm(Document): "fieldname": d.fieldname, "is_custom_field": d.get("is_custom_field"), "is_system_generated": d.get("is_system_generated"), - "name": d.name + "name": d.name, } for prop in docfield_properties: new_d[prop] = d.get(prop) self.append("fields", new_d) - for fieldname in ('links', 'actions', 'states'): + for fieldname in ("links", "actions", "states"): for d in meta.get(fieldname): self.append(fieldname, d) def create_auto_repeat_custom_field_if_required(self, meta): - ''' + """ Create auto repeat custom field if it's not already present - ''' + """ if self.allow_auto_repeat: all_fields = [df.fieldname for df in meta.fields] @@ -92,45 +96,51 @@ class CustomizeForm(Document): return insert_after = self.fields[len(self.fields) - 1].fieldname - create_custom_field(self.doc_type, dict( - fieldname='auto_repeat', - label='Auto Repeat', - fieldtype='Link', - options='Auto Repeat', - insert_after=insert_after, - read_only=1, no_copy=1, print_hide=1 - )) - + create_custom_field( + self.doc_type, + dict( + fieldname="auto_repeat", + label="Auto Repeat", + fieldtype="Link", + options="Auto Repeat", + insert_after=insert_after, + read_only=1, + no_copy=1, + print_hide=1, + ), + ) def get_name_translation(self): - '''Get translation object if exists of current doctype name in the default language''' - return frappe.get_value('Translation', { - 'source_text': self.doc_type, - 'language': frappe.local.lang or 'en' - }, ['name', 'translated_text'], as_dict=True) + """Get translation object if exists of current doctype name in the default language""" + return frappe.get_value( + "Translation", + {"source_text": self.doc_type, "language": frappe.local.lang or "en"}, + ["name", "translated_text"], + as_dict=True, + ) def set_name_translation(self): - '''Create, update custom translation for this doctype''' + """Create, update custom translation for this doctype""" current = self.get_name_translation() if not self.label: if current: # clear translation - frappe.delete_doc('Translation', current.name) + frappe.delete_doc("Translation", current.name) return if not current: frappe.get_doc( { - "doctype": 'Translation', + "doctype": "Translation", "source_text": self.doc_type, "translated_text": self.label, - "language_code": frappe.local.lang or 'en' + "language_code": frappe.local.lang or "en", } ).insert() return if self.label != current.translated_text: - frappe.db.set_value('Translation', current.name, 'translated_text', self.label) + frappe.db.set_value("Translation", current.name, "translated_text", self.label) frappe.translate.clear_cache() def clear_existing_doc(self): @@ -161,14 +171,15 @@ class CustomizeForm(Document): if self.flags.update_db: frappe.db.updatedb(self.doc_type) - if not hasattr(self, 'hide_success') or not self.hide_success: + if not hasattr(self, "hide_success") or not self.hide_success: frappe.msgprint(_("{0} updated").format(_(self.doc_type)), alert=True) frappe.clear_cache(doctype=self.doc_type) self.fetch_to_customize() if self.flags.rebuild_doctype_for_global_search: - frappe.enqueue('frappe.utils.global_search.rebuild_for_doctype', - now=True, doctype=self.doc_type) + frappe.enqueue( + "frappe.utils.global_search.rebuild_for_doctype", now=True, doctype=self.doc_type + ) def set_property_setters(self): meta = frappe.get_meta(self.doc_type) @@ -193,12 +204,11 @@ class CustomizeForm(Document): def set_property_setters_for_docfield(self, meta, df, meta_df): for prop, prop_type in docfield_properties.items(): - if prop != "idx" and (df.get(prop) or '') != (meta_df[0].get(prop) or ''): + if prop != "idx" and (df.get(prop) or "") != (meta_df[0].get(prop) or ""): if not self.allow_property_change(prop, meta_df, df): continue - self.make_property_setter(prop, df.get(prop), prop_type, - fieldname=df.fieldname) + self.make_property_setter(prop, df.get(prop), prop_type, fieldname=df.fieldname) def allow_property_change(self, prop, meta_df, df): if prop == "fieldtype": @@ -209,42 +219,61 @@ class CustomizeForm(Document): new_value_length = cint(df.get(prop)) if new_value_length and (old_value_length > new_value_length): - self.check_length_for_fieldtypes.append({'df': df, 'old_value': meta_df[0].get(prop)}) + self.check_length_for_fieldtypes.append({"df": df, "old_value": meta_df[0].get(prop)}) self.validate_fieldtype_length() else: self.flags.update_db = True elif prop == "allow_on_submit" and df.get(prop): - if not frappe.db.get_value("DocField", - {"parent": self.doc_type, "fieldname": df.fieldname}, "allow_on_submit"): - frappe.msgprint(_("Row {0}: Not allowed to enable Allow on Submit for standard fields")\ - .format(df.idx)) + if not frappe.db.get_value( + "DocField", {"parent": self.doc_type, "fieldname": df.fieldname}, "allow_on_submit" + ): + frappe.msgprint( + _("Row {0}: Not allowed to enable Allow on Submit for standard fields").format(df.idx) + ) return False - elif prop == "reqd" and \ - ((frappe.db.get_value("DocField", - {"parent":self.doc_type,"fieldname":df.fieldname}, "reqd") == 1) \ - and (df.get(prop) == 0)): - frappe.msgprint(_("Row {0}: Not allowed to disable Mandatory for standard fields")\ - .format(df.idx)) + elif prop == "reqd" and ( + ( + frappe.db.get_value("DocField", {"parent": self.doc_type, "fieldname": df.fieldname}, "reqd") + == 1 + ) + and (df.get(prop) == 0) + ): + frappe.msgprint( + _("Row {0}: Not allowed to disable Mandatory for standard fields").format(df.idx) + ) return False - elif prop == "in_list_view" and df.get(prop) \ - and df.fieldtype!="Attach Image" and df.fieldtype in no_value_fields: - frappe.msgprint(_("'In List View' not allowed for type {0} in row {1}") - .format(df.fieldtype, df.idx)) - return False + elif ( + prop == "in_list_view" + and df.get(prop) + and df.fieldtype != "Attach Image" + and df.fieldtype in no_value_fields + ): + frappe.msgprint( + _("'In List View' not allowed for type {0} in row {1}").format(df.fieldtype, df.idx) + ) + return False - elif prop == "precision" and cint(df.get("precision")) > 6 \ - and cint(df.get("precision")) > cint(meta_df[0].get("precision")): + elif ( + prop == "precision" + and cint(df.get("precision")) > 6 + and cint(df.get("precision")) > cint(meta_df[0].get("precision")) + ): self.flags.update_db = True elif prop == "unique": self.flags.update_db = True - elif (prop == "read_only" and cint(df.get("read_only"))==0 - and frappe.db.get_value("DocField", {"parent": self.doc_type, - "fieldname": df.fieldname}, "read_only")==1): + elif ( + prop == "read_only" + and cint(df.get("read_only")) == 0 + and frappe.db.get_value( + "DocField", {"parent": self.doc_type, "fieldname": df.fieldname}, "read_only" + ) + == 1 + ): # if docfield has read_only checked and user is trying to make it editable, don't allow it frappe.msgprint(_("You cannot unset 'Read Only' for field {0}").format(df.label)) return False @@ -253,25 +282,24 @@ class CustomizeForm(Document): frappe.msgprint(_("You can't set 'Options' for field {0}").format(df.label)) return False - elif prop == 'translatable' and not supports_translation(df.get('fieldtype')): + elif prop == "translatable" and not supports_translation(df.get("fieldtype")): frappe.msgprint(_("You can't set 'Translatable' for field {0}").format(df.label)) return False - elif (prop == 'in_global_search' and - df.in_global_search != meta_df[0].get("in_global_search")): + elif prop == "in_global_search" and df.in_global_search != meta_df[0].get("in_global_search"): self.flags.rebuild_doctype_for_global_search = True return True def set_property_setters_for_actions_and_links(self, meta): - ''' + """ Apply property setters or create custom records for DocType Action and DocType Link - ''' + """ for doctype, fieldname, field_map in ( - ('DocType Link', 'links', doctype_link_properties), - ('DocType Action', 'actions', doctype_action_properties), - ('DocType State', 'states', doctype_state_properties), - ): + ("DocType Link", "links", doctype_link_properties), + ("DocType Action", "actions", doctype_action_properties), + ("DocType State", "states", doctype_state_properties), + ): has_custom = False items = [] for i, d in enumerate(self.get(fieldname) or []): @@ -281,8 +309,7 @@ class CustomizeForm(Document): original = frappe.get_doc(doctype, d.name) for prop, prop_type in field_map.items(): if d.get(prop) != original.get(prop): - self.make_property_setter(prop, d.get(prop), prop_type, - apply_on=doctype, row_name=d.name) + self.make_property_setter(prop, d.get(prop), prop_type, apply_on=doctype, row_name=d.name) items.append(d.name) else: # custom - just insert/update @@ -296,34 +323,32 @@ class CustomizeForm(Document): self.clear_removed_items(doctype, items) def update_order_property_setter(self, has_custom, fieldname): - ''' + """ We need to maintain the order of the link/actions if the user has shuffled them. So we create a new property (ex `links_order`) to keep a list of items. - ''' - property_name = '{}_order'.format(fieldname) + """ + property_name = "{}_order".format(fieldname) if has_custom: # save the order of the actions and links - self.make_property_setter(property_name, - json.dumps([d.name for d in self.get(fieldname)]), 'Small Text') + self.make_property_setter( + property_name, json.dumps([d.name for d in self.get(fieldname)]), "Small Text" + ) else: - frappe.db.delete('Property Setter', dict(property=property_name, - doc_type=self.doc_type)) - + frappe.db.delete("Property Setter", dict(property=property_name, doc_type=self.doc_type)) def clear_removed_items(self, doctype, items): - ''' + """ Clear rows that do not appear in `items`. These have been removed by the user. - ''' + """ if items: - frappe.db.delete(doctype, dict(parent=self.doc_type, custom=1, - name=('not in', items))) + frappe.db.delete(doctype, dict(parent=self.doc_type, custom=1, name=("not in", items))) else: frappe.db.delete(doctype, dict(parent=self.doc_type, custom=1)) def update_custom_fields(self): for i, df in enumerate(self.get("fields")): if df.get("is_custom_field"): - if not frappe.db.exists('Custom Field', {'dt': self.doc_type, 'fieldname': df.fieldname}): + if not frappe.db.exists("Custom Field", {"dt": self.doc_type, "fieldname": df.fieldname}): self.add_custom_field(df, i) self.flags.update_db = True else: @@ -339,8 +364,8 @@ class CustomizeForm(Document): for prop in docfield_properties: d.set(prop, df.get(prop)) - if i!=0: - d.insert_after = self.fields[i-1].fieldname + if i != 0: + d.insert_after = self.fields[i - 1].fieldname d.idx = i d.insert() @@ -364,8 +389,8 @@ class CustomizeForm(Document): changed = True # check and update `insert_after` property - if i!=0: - insert_after = self.fields[i-1].fieldname + if i != 0: + insert_after = self.fields[i - 1].fieldname if custom_field.insert_after != insert_after: custom_field.insert_after = insert_after custom_field.idx = i @@ -374,46 +399,51 @@ class CustomizeForm(Document): if changed: custom_field.db_update() self.flags.update_db = True - #custom_field.save() + # custom_field.save() def delete_custom_fields(self): meta = frappe.get_meta(self.doc_type) - fields_to_remove = ( - {df.fieldname for df in meta.get("fields")} - {df.fieldname for df in self.get("fields")} - ) + fields_to_remove = {df.fieldname for df in meta.get("fields")} - { + df.fieldname for df in self.get("fields") + } for fieldname in fields_to_remove: df = meta.get("fields", {"fieldname": fieldname})[0] if df.get("is_custom_field"): frappe.delete_doc("Custom Field", df.name) - def make_property_setter(self, prop, value, property_type, fieldname=None, - apply_on=None, row_name = None): + def make_property_setter( + self, prop, value, property_type, fieldname=None, apply_on=None, row_name=None + ): delete_property_setter(self.doc_type, prop, fieldname, row_name) property_value = self.get_existing_property_value(prop, fieldname) - if property_value==value: + if property_value == value: return if not apply_on: apply_on = "DocField" if fieldname else "DocType" # create a new property setter - frappe.make_property_setter({ - "doctype": self.doc_type, - "doctype_or_field": apply_on, - "fieldname": fieldname, - "row_name": row_name, - "property": prop, - "value": value, - "property_type": property_type - }, is_system_generated=False) + frappe.make_property_setter( + { + "doctype": self.doc_type, + "doctype_or_field": apply_on, + "fieldname": fieldname, + "row_name": row_name, + "property": prop, + "value": value, + "property_type": property_type, + }, + is_system_generated=False, + ) def get_existing_property_value(self, property_name, fieldname=None): # check if there is any need to make property setter! if fieldname: - property_value = frappe.db.get_value("DocField", {"parent": self.doc_type, - "fieldname": fieldname}, property_name) + property_value = frappe.db.get_value( + "DocField", {"parent": self.doc_type, "fieldname": fieldname}, property_name + ) else: if frappe.db.has_column("DocType", property_name): property_value = frappe.db.get_value("DocType", self.doc_type, property_name) @@ -434,41 +464,47 @@ class CustomizeForm(Document): # Ignore fieldtype check validation if new field type has unspecified maxlength # Changes like DATA to TEXT, where new_value_lenth equals 0 will not be validated if new_value_length and (old_value_length > new_value_length): - self.check_length_for_fieldtypes.append({'df': df, 'old_value': old_value}) + self.check_length_for_fieldtypes.append({"df": df, "old_value": old_value}) self.validate_fieldtype_length() else: self.flags.update_db = True else: - frappe.throw(_("Fieldtype cannot be changed from {0} to {1} in row {2}").format(old_value, new_value, df.idx)) + frappe.throw( + _("Fieldtype cannot be changed from {0} to {1} in row {2}").format( + old_value, new_value, df.idx + ) + ) def validate_fieldtype_length(self): for field in self.check_length_for_fieldtypes: - df = field.get('df') + df = field.get("df") max_length = cint(frappe.db.type_map.get(df.fieldtype)[1]) fieldname = df.fieldname - docs = frappe.db.sql(''' + docs = frappe.db.sql( + """ SELECT name, {fieldname}, LENGTH({fieldname}) AS len FROM `tab{doctype}` WHERE LENGTH({fieldname}) > {max_length} - '''.format( - fieldname=fieldname, - doctype=self.doc_type, - max_length=max_length - ), as_dict=True) + """.format( + fieldname=fieldname, doctype=self.doc_type, max_length=max_length + ), + as_dict=True, + ) links = [] label = df.label for doc in docs: links.append(frappe.utils.get_link_to_form(self.doc_type, doc.name)) - links_str = ', '.join(links) + links_str = ", ".join(links) if docs: - frappe.throw(_('Value for field {0} is too long in {1}. Length should be lesser than {2} characters') - .format( - frappe.bold(label), - links_str, - frappe.bold(max_length) - ), title=_('Data Too Long'), is_minimizable=len(docs) > 1) + frappe.throw( + _( + "Value for field {0} is too long in {1}. Length should be lesser than {2} characters" + ).format(frappe.bold(label), links_str, frappe.bold(max_length)), + title=_("Data Too Long"), + is_minimizable=len(docs) > 1, + ) self.flags.update_db = True @@ -482,136 +518,139 @@ class CustomizeForm(Document): @classmethod def allow_fieldtype_change(self, old_type: str, new_type: str) -> bool: - """ allow type change, if both old_type and new_type are in same field group. + """allow type change, if both old_type and new_type are in same field group. field groups are defined in ALLOWED_FIELDTYPE_CHANGE variables. """ in_field_group = lambda group: (old_type in group) and (new_type in group) return any(map(in_field_group, ALLOWED_FIELDTYPE_CHANGE)) + def reset_customization(doctype): - setters = frappe.get_all("Property Setter", filters={ - 'doc_type': doctype, - 'field_name': ['!=', 'naming_series'], - 'property': ['!=', 'options'], - 'is_system_generated': False - }, pluck='name') + setters = frappe.get_all( + "Property Setter", + filters={ + "doc_type": doctype, + "field_name": ["!=", "naming_series"], + "property": ["!=", "options"], + "is_system_generated": False, + }, + pluck="name", + ) for setter in setters: frappe.delete_doc("Property Setter", setter) - custom_fields = frappe.get_all("Custom Field", filters={ - 'dt': doctype, - 'is_system_generated': False - }, pluck='name') + custom_fields = frappe.get_all( + "Custom Field", filters={"dt": doctype, "is_system_generated": False}, pluck="name" + ) for field in custom_fields: frappe.delete_doc("Custom Field", field) frappe.clear_cache(doctype=doctype) + doctype_properties = { - 'search_fields': 'Data', - 'title_field': 'Data', - 'image_field': 'Data', - 'sort_field': 'Data', - 'sort_order': 'Data', - 'default_print_format': 'Data', - 'allow_copy': 'Check', - 'istable': 'Check', - 'quick_entry': 'Check', - 'editable_grid': 'Check', - 'max_attachments': 'Int', - 'track_changes': 'Check', - 'track_views': 'Check', - 'allow_auto_repeat': 'Check', - 'allow_import': 'Check', - 'show_preview_popup': 'Check', - 'default_email_template': 'Data', - 'email_append_to': 'Check', - 'subject_field': 'Data', - 'sender_field': 'Data', - 'autoname': 'Data', - 'show_title_field_in_link': 'Check' + "search_fields": "Data", + "title_field": "Data", + "image_field": "Data", + "sort_field": "Data", + "sort_order": "Data", + "default_print_format": "Data", + "allow_copy": "Check", + "istable": "Check", + "quick_entry": "Check", + "editable_grid": "Check", + "max_attachments": "Int", + "track_changes": "Check", + "track_views": "Check", + "allow_auto_repeat": "Check", + "allow_import": "Check", + "show_preview_popup": "Check", + "default_email_template": "Data", + "email_append_to": "Check", + "subject_field": "Data", + "sender_field": "Data", + "autoname": "Data", + "show_title_field_in_link": "Check", } docfield_properties = { - 'idx': 'Int', - 'label': 'Data', - 'fieldtype': 'Select', - 'options': 'Text', - 'fetch_from': 'Small Text', - 'fetch_if_empty': 'Check', - 'show_dashboard': 'Check', - 'permlevel': 'Int', - 'width': 'Data', - 'print_width': 'Data', - 'non_negative': 'Check', - 'reqd': 'Check', - 'unique': 'Check', - 'ignore_user_permissions': 'Check', - 'in_list_view': 'Check', - 'in_standard_filter': 'Check', - 'in_global_search': 'Check', - 'in_preview': 'Check', - 'bold': 'Check', - 'no_copy': 'Check', - 'hidden': 'Check', - 'collapsible': 'Check', - 'collapsible_depends_on': 'Data', - 'print_hide': 'Check', - 'print_hide_if_no_value': 'Check', - 'report_hide': 'Check', - 'allow_on_submit': 'Check', - 'translatable': 'Check', - 'mandatory_depends_on': 'Data', - 'read_only_depends_on': 'Data', - 'depends_on': 'Data', - 'description': 'Text', - 'default': 'Text', - 'precision': 'Select', - 'read_only': 'Check', - 'length': 'Int', - 'columns': 'Int', - 'remember_last_selected_value': 'Check', - 'allow_bulk_edit': 'Check', - 'auto_repeat': 'Link', - 'allow_in_quick_entry': 'Check', - 'hide_border': 'Check', - 'hide_days': 'Check', - 'hide_seconds': 'Check', - 'is_virtual': 'Check', + "idx": "Int", + "label": "Data", + "fieldtype": "Select", + "options": "Text", + "fetch_from": "Small Text", + "fetch_if_empty": "Check", + "show_dashboard": "Check", + "permlevel": "Int", + "width": "Data", + "print_width": "Data", + "non_negative": "Check", + "reqd": "Check", + "unique": "Check", + "ignore_user_permissions": "Check", + "in_list_view": "Check", + "in_standard_filter": "Check", + "in_global_search": "Check", + "in_preview": "Check", + "bold": "Check", + "no_copy": "Check", + "hidden": "Check", + "collapsible": "Check", + "collapsible_depends_on": "Data", + "print_hide": "Check", + "print_hide_if_no_value": "Check", + "report_hide": "Check", + "allow_on_submit": "Check", + "translatable": "Check", + "mandatory_depends_on": "Data", + "read_only_depends_on": "Data", + "depends_on": "Data", + "description": "Text", + "default": "Text", + "precision": "Select", + "read_only": "Check", + "length": "Int", + "columns": "Int", + "remember_last_selected_value": "Check", + "allow_bulk_edit": "Check", + "auto_repeat": "Link", + "allow_in_quick_entry": "Check", + "hide_border": "Check", + "hide_days": "Check", + "hide_seconds": "Check", + "is_virtual": "Check", } doctype_link_properties = { - 'link_doctype': 'Link', - 'link_fieldname': 'Data', - 'group': 'Data', - 'hidden': 'Check' + "link_doctype": "Link", + "link_fieldname": "Data", + "group": "Data", + "hidden": "Check", } doctype_action_properties = { - 'label': 'Link', - 'action_type': 'Select', - 'action': 'Small Text', - 'group': 'Data', - 'hidden': 'Check' + "label": "Link", + "action_type": "Select", + "action": "Small Text", + "group": "Data", + "hidden": "Check", } -doctype_state_properties = { - 'title': 'Data', - 'color': 'Select' -} +doctype_state_properties = {"title": "Data", "color": "Select"} ALLOWED_FIELDTYPE_CHANGE = ( - ('Currency', 'Float', 'Percent'), - ('Small Text', 'Data'), - ('Text', 'Data'), - ('Text', 'Text Editor', 'Code', 'Signature', 'HTML Editor'), - ('Data', 'Select'), - ('Text', 'Small Text'), - ('Text', 'Data', 'Barcode'), - ('Code', 'Geolocation'), - ('Table', 'Table MultiSelect')) - -ALLOWED_OPTIONS_CHANGE = ('Read Only', 'HTML', 'Data') + ("Currency", "Float", "Percent"), + ("Small Text", "Data"), + ("Text", "Data"), + ("Text", "Text Editor", "Code", "Signature", "HTML Editor"), + ("Data", "Select"), + ("Text", "Small Text"), + ("Text", "Data", "Barcode"), + ("Code", "Geolocation"), + ("Table", "Table MultiSelect"), +) + +ALLOWED_OPTIONS_CHANGE = ("Read Only", "HTML", "Data") diff --git a/frappe/custom/doctype/customize_form/test_customize_form.py b/frappe/custom/doctype/customize_form/test_customize_form.py index 2cae69ca21..5a1f629beb 100644 --- a/frappe/custom/doctype/customize_form/test_customize_form.py +++ b/frappe/custom/doctype/customize_form/test_customize_form.py @@ -1,30 +1,37 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, unittest, json -from frappe.test_runner import make_test_records_for_doctype +import json +import unittest + +import frappe from frappe.core.doctype.doctype.doctype import InvalidFieldNameError from frappe.core.doctype.doctype.test_doctype import new_doctype +from frappe.test_runner import make_test_records_for_doctype test_dependencies = ["Custom Field", "Property Setter"] + + class TestCustomizeForm(unittest.TestCase): def insert_custom_field(self): frappe.delete_doc_if_exists("Custom Field", "Event-test_custom_field") - frappe.get_doc({ - "doctype": "Custom Field", - "dt": "Event", - "label": "Test Custom Field", - "description": "A Custom Field for Testing", - "fieldtype": "Select", - "in_list_view": 1, - "options": "\nCustom 1\nCustom 2\nCustom 3", - "default": "Custom 3", - "insert_after": frappe.get_meta('Event').fields[-1].fieldname - }).insert() + frappe.get_doc( + { + "doctype": "Custom Field", + "dt": "Event", + "label": "Test Custom Field", + "description": "A Custom Field for Testing", + "fieldtype": "Select", + "in_list_view": 1, + "options": "\nCustom 1\nCustom 2\nCustom 3", + "default": "Custom 3", + "insert_after": frappe.get_meta("Event").fields[-1].fieldname, + } + ).insert() def setUp(self): self.insert_custom_field() - frappe.db.delete('Property Setter', dict(doc_type='Event')) + frappe.db.delete("Property Setter", dict(doc_type="Event")) frappe.db.commit() frappe.clear_cache(doctype="Event") @@ -52,8 +59,7 @@ class TestCustomizeForm(unittest.TestCase): d = self.get_customize_form("Event") self.assertEqual(d.doc_type, "Event") - self.assertEqual(len(d.get("fields")), - len(frappe.get_doc("DocType", d.doc_type).fields) + 1) + self.assertEqual(len(d.get("fields")), len(frappe.get_doc("DocType", d.doc_type).fields) + 1) self.assertEqual(d.get("fields")[-1].fieldname, "test_custom_field") self.assertEqual(d.get("fields", {"fieldname": "event_type"})[0].in_list_view, 1) @@ -61,35 +67,65 @@ class TestCustomizeForm(unittest.TestCase): def test_save_customization_property(self): d = self.get_customize_form("Event") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Event", "property": "allow_copy"}, "value"), None) + self.assertEqual( + frappe.db.get_value( + "Property Setter", {"doc_type": "Event", "property": "allow_copy"}, "value" + ), + None, + ) d.allow_copy = 1 d.run_method("save_customization") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Event", "property": "allow_copy"}, "value"), '1') + self.assertEqual( + frappe.db.get_value( + "Property Setter", {"doc_type": "Event", "property": "allow_copy"}, "value" + ), + "1", + ) d.allow_copy = 0 d.run_method("save_customization") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Event", "property": "allow_copy"}, "value"), None) + self.assertEqual( + frappe.db.get_value( + "Property Setter", {"doc_type": "Event", "property": "allow_copy"}, "value" + ), + None, + ) def test_save_customization_field_property(self): d = self.get_customize_form("Event") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Event", "property": "reqd", "field_name": "repeat_this_event"}, "value"), None) + self.assertEqual( + frappe.db.get_value( + "Property Setter", + {"doc_type": "Event", "property": "reqd", "field_name": "repeat_this_event"}, + "value", + ), + None, + ) repeat_this_event_field = d.get("fields", {"fieldname": "repeat_this_event"})[0] repeat_this_event_field.reqd = 1 d.run_method("save_customization") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Event", "property": "reqd", "field_name": "repeat_this_event"}, "value"), '1') + self.assertEqual( + frappe.db.get_value( + "Property Setter", + {"doc_type": "Event", "property": "reqd", "field_name": "repeat_this_event"}, + "value", + ), + "1", + ) repeat_this_event_field = d.get("fields", {"fieldname": "repeat_this_event"})[0] repeat_this_event_field.reqd = 0 d.run_method("save_customization") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Event", "property": "reqd", "field_name": "repeat_this_event"}, "value"), None) + self.assertEqual( + frappe.db.get_value( + "Property Setter", + {"doc_type": "Event", "property": "reqd", "field_name": "repeat_this_event"}, + "value", + ), + None, + ) def test_save_customization_custom_field_property(self): d = self.get_customize_form("Event") @@ -109,26 +145,36 @@ class TestCustomizeForm(unittest.TestCase): self.assertEqual(frappe.db.get_value("Custom Field", "Event-test_custom_field", "reqd"), 0) self.assertEqual(frappe.db.get_value("Custom Field", "Event-test_custom_field", "no_copy"), 0) - def test_save_customization_new_field(self): d = self.get_customize_form("Event") last_fieldname = d.fields[-1].fieldname - d.append("fields", { - "label": "Test Add Custom Field Via Customize Form", - "fieldtype": "Data", - "is_custom_field": 1 - }) + d.append( + "fields", + { + "label": "Test Add Custom Field Via Customize Form", + "fieldtype": "Data", + "is_custom_field": 1, + }, + ) d.run_method("save_customization") - self.assertEqual(frappe.db.get_value("Custom Field", - "Event-test_add_custom_field_via_customize_form", "fieldtype"), "Data") - - self.assertEqual(frappe.db.get_value("Custom Field", - "Event-test_add_custom_field_via_customize_form", 'insert_after'), last_fieldname) + self.assertEqual( + frappe.db.get_value( + "Custom Field", "Event-test_add_custom_field_via_customize_form", "fieldtype" + ), + "Data", + ) + + self.assertEqual( + frappe.db.get_value( + "Custom Field", "Event-test_add_custom_field_via_customize_form", "insert_after" + ), + last_fieldname, + ) frappe.delete_doc("Custom Field", "Event-test_add_custom_field_via_customize_form") - self.assertEqual(frappe.db.get_value("Custom Field", - "Event-test_add_custom_field_via_customize_form"), None) - + self.assertEqual( + frappe.db.get_value("Custom Field", "Event-test_add_custom_field_via_customize_form"), None + ) def test_save_customization_remove_field(self): d = self.get_customize_form("Event") @@ -144,7 +190,7 @@ class TestCustomizeForm(unittest.TestCase): def test_reset_to_defaults(self): d = frappe.get_doc("Customize Form") d.doc_type = "Event" - d.run_method('reset_to_defaults') + d.run_method("reset_to_defaults") self.assertEqual(d.get("fields", {"fieldname": "repeat_this_event"})[0].in_list_view, 0) @@ -191,7 +237,7 @@ class TestCustomizeForm(unittest.TestCase): d.run_method("save_customization") def test_core_doctype_customization(self): - self.assertRaises(frappe.ValidationError, self.get_customize_form, 'User') + self.assertRaises(frappe.ValidationError, self.get_customize_form, "User") def test_save_customization_length_field_property(self): # Using Notification Log doctype as it doesn't have any other custom fields @@ -201,41 +247,49 @@ class TestCustomizeForm(unittest.TestCase): document_name.length = 255 d.run_method("save_customization") - self.assertEqual(frappe.db.get_value("Property Setter", - {"doc_type": "Notification Log", "property": "length", "field_name": "document_name"}, "value"), '255') + self.assertEqual( + frappe.db.get_value( + "Property Setter", + {"doc_type": "Notification Log", "property": "length", "field_name": "document_name"}, + "value", + ), + "255", + ) self.assertTrue(d.flags.update_db) - length = frappe.db.sql("""SELECT character_maximum_length + length = frappe.db.sql( + """SELECT character_maximum_length FROM information_schema.columns WHERE table_name = 'tabNotification Log' - AND column_name = 'document_name'""")[0][0] + AND column_name = 'document_name'""" + )[0][0] self.assertEqual(length, 255) def test_custom_link(self): try: # create a dummy doctype linked to Event - testdt_name = 'Test Link for Event' - testdt = new_doctype(testdt_name, fields=[ - dict(fieldtype='Link', fieldname='event', options='Event') - ]).insert() + testdt_name = "Test Link for Event" + testdt = new_doctype( + testdt_name, fields=[dict(fieldtype="Link", fieldname="event", options="Event")] + ).insert() - testdt_name1 = 'Test Link for Event 1' - testdt1 = new_doctype(testdt_name1, fields=[ - dict(fieldtype='Link', fieldname='event', options='Event') - ]).insert() + testdt_name1 = "Test Link for Event 1" + testdt1 = new_doctype( + testdt_name1, fields=[dict(fieldtype="Link", fieldname="event", options="Event")] + ).insert() # add a custom link d = self.get_customize_form("Event") - d.append('links', dict(link_doctype=testdt_name, link_fieldname='event', group='Tests')) - d.append('links', dict(link_doctype=testdt_name1, link_fieldname='event', group='Tests')) + d.append("links", dict(link_doctype=testdt_name, link_fieldname="event", group="Tests")) + d.append("links", dict(link_doctype=testdt_name1, link_fieldname="event", group="Tests")) d.run_method("save_customization") frappe.clear_cache() - event = frappe.get_meta('Event') + event = frappe.get_meta("Event") # check links exist self.assertTrue([d.name for d in event.links if d.link_doctype == testdt_name]) @@ -251,7 +305,7 @@ class TestCustomizeForm(unittest.TestCase): d.run_method("save_customization") frappe.clear_cache() - event = frappe.get_meta('Event') + event = frappe.get_meta("Event") self.assertFalse([d.name for d in (event.links or []) if d.link_doctype == testdt_name]) finally: testdt.delete() @@ -262,17 +316,26 @@ class TestCustomizeForm(unittest.TestCase): frappe.clear_cache() d = self.get_customize_form("User Group") - d.append('links', dict(link_doctype='User Group Member', parent_doctype='User Group', - link_fieldname='user', table_fieldname='user_group_members', group='Tests', custom=1)) + d.append( + "links", + dict( + link_doctype="User Group Member", + parent_doctype="User Group", + link_fieldname="user", + table_fieldname="user_group_members", + group="Tests", + custom=1, + ), + ) d.run_method("save_customization") frappe.clear_cache() - user_group = frappe.get_meta('User Group') + user_group = frappe.get_meta("User Group") # check links exist - self.assertTrue([d.name for d in user_group.links if d.link_doctype == 'User Group Member']) - self.assertTrue([d.name for d in user_group.links if d.parent_doctype == 'User Group']) + self.assertTrue([d.name for d in user_group.links if d.link_doctype == "User Group Member"]) + self.assertTrue([d.name for d in user_group.links if d.parent_doctype == "User Group"]) # remove the link d = self.get_customize_form("User Group") @@ -280,22 +343,24 @@ class TestCustomizeForm(unittest.TestCase): d.run_method("save_customization") frappe.clear_cache() - user_group = frappe.get_meta('Event') - self.assertFalse([d.name for d in (user_group.links or []) if d.link_doctype == 'User Group Member']) + user_group = frappe.get_meta("Event") + self.assertFalse( + [d.name for d in (user_group.links or []) if d.link_doctype == "User Group Member"] + ) def test_custom_action(self): - test_route = '/app/List/DocType' + test_route = "/app/List/DocType" # create a dummy action (route) d = self.get_customize_form("Event") - d.append('actions', dict(label='Test Action', action_type='Route', action=test_route)) + d.append("actions", dict(label="Test Action", action_type="Route", action=test_route)) d.run_method("save_customization") frappe.clear_cache() - event = frappe.get_meta('Event') + event = frappe.get_meta("Event") # check if added to meta - action = [d for d in event.actions if d.label=='Test Action'] + action = [d for d in event.actions if d.label == "Test Action"] self.assertEqual(len(action), 1) self.assertEqual(action[0].action, test_route) @@ -305,9 +370,9 @@ class TestCustomizeForm(unittest.TestCase): d.run_method("save_customization") frappe.clear_cache() - event = frappe.get_meta('Event') + event = frappe.get_meta("Event") - action = [d for d in event.actions if d.label=='Test Action'] + action = [d for d in event.actions if d.label == "Test Action"] self.assertEqual(len(action), 0) def test_custom_label(self): diff --git a/frappe/custom/doctype/customize_form_field/__init__.py b/frappe/custom/doctype/customize_form_field/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/custom/doctype/customize_form_field/__init__.py +++ b/frappe/custom/doctype/customize_form_field/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/custom/doctype/customize_form_field/customize_form_field.py b/frappe/custom/doctype/customize_form_field/customize_form_field.py index 67563cf048..0e030ce812 100644 --- a/frappe/custom/doctype/customize_form_field/customize_form_field.py +++ b/frappe/custom/doctype/customize_form_field/customize_form_field.py @@ -2,8 +2,8 @@ # License: MIT. See LICENSE import frappe - from frappe.model.document import Document + class CustomizeFormField(Document): - pass \ No newline at end of file + pass diff --git a/frappe/custom/doctype/doctype_layout/doctype_layout.py b/frappe/custom/doctype/doctype_layout/doctype_layout.py index fa285ddb62..f5d37d6f60 100644 --- a/frappe/custom/doctype/doctype_layout/doctype_layout.py +++ b/frappe/custom/doctype/doctype_layout/doctype_layout.py @@ -2,9 +2,9 @@ # Copyright (c) 2020, Frappe Technologies and contributors # License: MIT. See LICENSE +from frappe.desk.utils import slug from frappe.model.document import Document -from frappe.desk.utils import slug class DocTypeLayout(Document): def validate(self): diff --git a/frappe/custom/doctype/doctype_layout/patches/convert_web_forms_to_doctype_layout.py b/frappe/custom/doctype/doctype_layout/patches/convert_web_forms_to_doctype_layout.py index 4e44743b48..59cdfffb21 100644 --- a/frappe/custom/doctype/doctype_layout/patches/convert_web_forms_to_doctype_layout.py +++ b/frappe/custom/doctype/doctype_layout/patches/convert_web_forms_to_doctype_layout.py @@ -1,13 +1,18 @@ import frappe + def execute(): - for web_form_name in frappe.db.get_all('Web Form', pluck='name'): - web_form = frappe.get_doc('Web Form', web_form_name) - doctype_layout = frappe.get_doc(dict( - doctype = 'DocType Layout', - document_type = web_form.doc_type, - name = web_form.title, - route = web_form.route, - fields = [dict(fieldname = d.fieldname, label=d.label) for d in web_form.web_form_fields if d.fieldname] - )).insert() - print(doctype_layout.name) \ No newline at end of file + for web_form_name in frappe.db.get_all("Web Form", pluck="name"): + web_form = frappe.get_doc("Web Form", web_form_name) + doctype_layout = frappe.get_doc( + dict( + doctype="DocType Layout", + document_type=web_form.doc_type, + name=web_form.title, + route=web_form.route, + fields=[ + dict(fieldname=d.fieldname, label=d.label) for d in web_form.web_form_fields if d.fieldname + ], + ) + ).insert() + print(doctype_layout.name) diff --git a/frappe/custom/doctype/doctype_layout/test_doctype_layout.py b/frappe/custom/doctype/doctype_layout/test_doctype_layout.py index a63dd7ee16..1373b4a53a 100644 --- a/frappe/custom/doctype/doctype_layout/test_doctype_layout.py +++ b/frappe/custom/doctype/doctype_layout/test_doctype_layout.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestDocTypeLayout(unittest.TestCase): pass diff --git a/frappe/custom/doctype/doctype_layout_field/doctype_layout_field.py b/frappe/custom/doctype/doctype_layout_field/doctype_layout_field.py index 3f8487b659..66fc111d32 100644 --- a/frappe/custom/doctype/doctype_layout_field/doctype_layout_field.py +++ b/frappe/custom/doctype/doctype_layout_field/doctype_layout_field.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class DocTypeLayoutField(Document): pass diff --git a/frappe/custom/doctype/property_setter/__init__.py b/frappe/custom/doctype/property_setter/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/custom/doctype/property_setter/__init__.py +++ b/frappe/custom/doctype/property_setter/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/custom/doctype/property_setter/property_setter.py b/frappe/custom/doctype/property_setter/property_setter.py index a86cf5efd6..3034904381 100644 --- a/frappe/custom/doctype/property_setter/property_setter.py +++ b/frappe/custom/doctype/property_setter/property_setter.py @@ -3,17 +3,15 @@ import frappe from frappe import _ - from frappe.model.document import Document -not_allowed_fieldtype_change = ['naming_series'] +not_allowed_fieldtype_change = ["naming_series"] + class PropertySetter(Document): def autoname(self): - self.name = '{doctype}-{field}-{property}'.format( - doctype = self.doc_type, - field = self.field_name or self.row_name or 'main', - property = self.property + self.name = "{doctype}-{field}-{property}".format( + doctype=self.doc_type, field=self.field_name or self.row_name or "main", property=self.property ) def validate(self): @@ -21,16 +19,11 @@ class PropertySetter(Document): if self.is_new(): delete_property_setter(self.doc_type, self.property, self.field_name, self.row_name) - frappe.clear_cache(doctype = self.doc_type) + frappe.clear_cache(doctype=self.doc_type) def validate_fieldtype_change(self): - if ( - self.property == 'fieldtype' - and self.field_name in not_allowed_fieldtype_change - ): - frappe.throw( - _("Field type cannot be changed for {0}").format(self.field_name) - ) + if self.property == "fieldtype" and self.field_name in not_allowed_fieldtype_change: + frappe.throw(_("Field type cannot be changed for {0}").format(self.field_name)) def on_update(self): if frappe.flags.in_patch: @@ -38,21 +31,31 @@ class PropertySetter(Document): if not self.flags.ignore_validate and self.flags.validate_fields_for_doctype: from frappe.core.doctype.doctype.doctype import validate_fields_for_doctype + validate_fields_for_doctype(self.doc_type) -def make_property_setter(doctype, fieldname, property, value, property_type, for_doctype = False, - validate_fields_for_doctype=True): +def make_property_setter( + doctype, + fieldname, + property, + value, + property_type, + for_doctype=False, + validate_fields_for_doctype=True, +): # WARNING: Ignores Permissions - property_setter = frappe.get_doc({ - "doctype":"Property Setter", - "doctype_or_field": for_doctype and "DocType" or "DocField", - "doc_type": doctype, - "field_name": fieldname, - "property": property, - "value": value, - "property_type": property_type - }) + property_setter = frappe.get_doc( + { + "doctype": "Property Setter", + "doctype_or_field": for_doctype and "DocType" or "DocField", + "doc_type": doctype, + "field_name": fieldname, + "property": property, + "value": value, + "property_type": property_type, + } + ) property_setter.flags.ignore_permissions = True property_setter.flags.validate_fields_for_doctype = validate_fields_for_doctype property_setter.insert() @@ -63,8 +66,8 @@ def delete_property_setter(doc_type, property, field_name=None, row_name=None): """delete other property setters on this, if this is new""" filters = dict(doc_type=doc_type, property=property) if field_name: - filters['field_name'] = field_name + filters["field_name"] = field_name if row_name: filters["row_name"] = row_name - frappe.db.delete('Property Setter', filters) + frappe.db.delete("Property Setter", filters) diff --git a/frappe/custom/doctype/property_setter/test_property_setter.py b/frappe/custom/doctype/property_setter/test_property_setter.py index 1bbbe59a0f..5b877ab18c 100644 --- a/frappe/custom/doctype/property_setter/test_property_setter.py +++ b/frappe/custom/doctype/property_setter/test_property_setter.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Property Setter') + class TestPropertySetter(unittest.TestCase): pass diff --git a/frappe/custom/doctype/test_rename_new/test_rename_new.py b/frappe/custom/doctype/test_rename_new/test_rename_new.py index fc4ab97cfe..e79cb60bbe 100644 --- a/frappe/custom/doctype/test_rename_new/test_rename_new.py +++ b/frappe/custom/doctype/test_rename_new/test_rename_new.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class Testrenamenew(Document): pass diff --git a/frappe/custom/doctype/test_rename_new/test_test_rename_new.py b/frappe/custom/doctype/test_rename_new/test_test_rename_new.py index 03202669ed..513a9286a3 100644 --- a/frappe/custom/doctype/test_rename_new/test_test_rename_new.py +++ b/frappe/custom/doctype/test_rename_new/test_test_rename_new.py @@ -4,5 +4,6 @@ # import frappe import unittest + class Testrenamenew(unittest.TestCase): pass diff --git a/frappe/data_migration/doctype/data_migration_connector/connectors/base.py b/frappe/data_migration/doctype/data_migration_connector/connectors/base.py index 5eca7cfac5..7d2b320c59 100644 --- a/frappe/data_migration/doctype/data_migration_connector/connectors/base.py +++ b/frappe/data_migration/doctype/data_migration_connector/connectors/base.py @@ -1,6 +1,8 @@ from abc import ABCMeta, abstractmethod + from frappe.utils.password import get_decrypted_password + class BaseConnection(metaclass=ABCMeta): @abstractmethod def get(self, remote_objectname, fields=None, filters=None, start=0, page_length=10): @@ -19,4 +21,4 @@ class BaseConnection(metaclass=ABCMeta): pass def get_password(self): - return get_decrypted_password('Data Migration Connector', self.connector.name) \ No newline at end of file + return get_decrypted_password("Data Migration Connector", self.connector.name) diff --git a/frappe/data_migration/doctype/data_migration_connector/connectors/frappe_connection.py b/frappe/data_migration/doctype/data_migration_connector/connectors/frappe_connection.py index 473a15c2dc..8228529562 100644 --- a/frappe/data_migration/doctype/data_migration_connector/connectors/frappe_connection.py +++ b/frappe/data_migration/doctype/data_migration_connector/connectors/frappe_connection.py @@ -1,14 +1,16 @@ - import frappe from frappe.frappeclient import FrappeClient + from .base import BaseConnection + class FrappeConnection(BaseConnection): def __init__(self, connector): self.connector = connector - self.connection = FrappeClient(self.connector.hostname, - self.connector.username, self.get_password()) - self.name_field = 'name' + self.connection = FrappeClient( + self.connector.hostname, self.connector.username, self.get_password() + ) + self.name_field = "name" def insert(self, doctype, doc): doc = frappe._dict(doc) @@ -25,5 +27,6 @@ class FrappeConnection(BaseConnection): return self.connection.delete(doctype, migration_id) def get(self, doctype, fields='"*"', filters=None, start=0, page_length=20): - return self.connection.get_list(doctype, fields=fields, filters=filters, - limit_start=start, limit_page_length=page_length) + return self.connection.get_list( + doctype, fields=fields, filters=filters, limit_start=start, limit_page_length=page_length + ) diff --git a/frappe/data_migration/doctype/data_migration_connector/data_migration_connector.py b/frappe/data_migration/doctype/data_migration_connector/data_migration_connector.py index 2e4e4d45b3..9db7fc2445 100644 --- a/frappe/data_migration/doctype/data_migration_connector/data_migration_connector.py +++ b/frappe/data_migration/doctype/data_migration_connector/data_migration_connector.py @@ -2,23 +2,27 @@ # Copyright (c) 2017, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe, os -from frappe.model.document import Document +import os + +import frappe from frappe import _ +from frappe.model.document import Document from frappe.modules.export_file import create_init_py + from .connectors.base import BaseConnection from .connectors.frappe_connection import FrappeConnection + class DataMigrationConnector(Document): def validate(self): if not (self.python_module or self.connector_type): - frappe.throw(_('Enter python module or select connector type')) + frappe.throw(_("Enter python module or select connector type")) if self.python_module: try: get_connection_class(self.python_module) except: - frappe.throw(frappe._('Invalid module path')) + frappe.throw(frappe._("Invalid module path")) def get_connection(self): if self.python_module: @@ -29,37 +33,40 @@ class DataMigrationConnector(Document): return self.connection + @frappe.whitelist() def create_new_connection(module, connection_name): - if not frappe.conf.get('developer_mode'): - frappe.msgprint(_('Please enable developer mode to create new connection')) + if not frappe.conf.get("developer_mode"): + frappe.msgprint(_("Please enable developer mode to create new connection")) return # create folder module_path = frappe.get_module_path(module) - connectors_folder = os.path.join(module_path, 'connectors') + connectors_folder = os.path.join(module_path, "connectors") frappe.create_folder(connectors_folder) # create init py - create_init_py(module_path, 'connectors', '') + create_init_py(module_path, "connectors", "") - connection_class = connection_name.replace(' ', '') - file_name = frappe.scrub(connection_name) + '.py' - file_path = os.path.join(module_path, 'connectors', file_name) + connection_class = connection_name.replace(" ", "") + file_name = frappe.scrub(connection_name) + ".py" + file_path = os.path.join(module_path, "connectors", file_name) # create boilerplate file - with open(file_path, 'w') as f: + with open(file_path, "w") as f: f.write(connection_boilerplate.format(connection_class=connection_class)) # get python module string from file_path - app_name = frappe.db.get_value('Module Def', module, 'app_name') - python_module = os.path.relpath( - file_path, '../apps/{0}'.format(app_name)).replace(os.path.sep, '.')[:-3] + app_name = frappe.db.get_value("Module Def", module, "app_name") + python_module = os.path.relpath(file_path, "../apps/{0}".format(app_name)).replace( + os.path.sep, "." + )[:-3] return python_module + def get_connection_class(python_module): - filename = python_module.rsplit('.', 1)[-1] - classname = frappe.unscrub(filename).replace(' ', '') + filename = python_module.rsplit(".", 1)[-1] + classname = frappe.unscrub(filename).replace(" ", "") module = frappe.get_module(python_module) raise_error = False @@ -75,6 +82,7 @@ def get_connection_class(python_module): return _class + connection_boilerplate = """from frappe.data_migration.doctype.data_migration_connector.connectors.base import BaseConnection class {connection_class}(BaseConnection): diff --git a/frappe/data_migration/doctype/data_migration_connector/test_data_migration_connector.py b/frappe/data_migration/doctype/data_migration_connector/test_data_migration_connector.py index ffc96c8266..c4090796ab 100644 --- a/frappe/data_migration/doctype/data_migration_connector/test_data_migration_connector.py +++ b/frappe/data_migration/doctype/data_migration_connector/test_data_migration_connector.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestDataMigrationConnector(unittest.TestCase): pass diff --git a/frappe/data_migration/doctype/data_migration_mapping/data_migration_mapping.py b/frappe/data_migration/doctype/data_migration_mapping/data_migration_mapping.py index 46d33eaca9..49af65e99b 100644 --- a/frappe/data_migration/doctype/data_migration_mapping/data_migration_mapping.py +++ b/frappe/data_migration/doctype/data_migration_mapping/data_migration_mapping.py @@ -6,6 +6,7 @@ import frappe from frappe.model.document import Document from frappe.utils.safe_exec import get_safe_globals + class DataMigrationMapping(Document): def get_filters(self): if self.condition: @@ -14,25 +15,25 @@ class DataMigrationMapping(Document): def get_fields(self): fields = [] for f in self.fields: - if not (f.local_fieldname[0] in ('"', "'") or f.local_fieldname.startswith('eval:')): + if not (f.local_fieldname[0] in ('"', "'") or f.local_fieldname.startswith("eval:")): fields.append(f.local_fieldname) if frappe.db.has_column(self.local_doctype, self.migration_id_field): fields.append(self.migration_id_field) - if 'name' not in fields: - fields.append('name') + if "name" not in fields: + fields.append("name") return fields def get_mapped_record(self, doc): - '''Build a mapped record using information from the fields table''' + """Build a mapped record using information from the fields table""" mapped = frappe._dict() - key_fieldname = 'remote_fieldname' - value_fieldname = 'local_fieldname' + key_fieldname = "remote_fieldname" + value_fieldname = "local_fieldname" - if self.mapping_type == 'Pull': + if self.mapping_type == "Pull": key_fieldname, value_fieldname = value_fieldname, key_fieldname for field_map in self.fields: @@ -44,25 +45,28 @@ class DataMigrationMapping(Document): else: # child table mapping mapping_name = field_map.child_table_mapping - value = get_mapped_child_records(mapping_name, - doc.get(get_source_value(field_map, value_fieldname))) + value = get_mapped_child_records( + mapping_name, doc.get(get_source_value(field_map, value_fieldname)) + ) mapped[key] = value return mapped + def get_mapped_child_records(mapping_name, child_docs): mapped_child_docs = [] - mapping = frappe.get_doc('Data Migration Mapping', mapping_name) + mapping = frappe.get_doc("Data Migration Mapping", mapping_name) for child_doc in child_docs: mapped_child_docs.append(mapping.get_mapped_record(child_doc)) return mapped_child_docs + def get_value_from_fieldname(field_map, fieldname_field, doc): field_name = get_source_value(field_map, fieldname_field) - if field_name.startswith('eval:'): + if field_name.startswith("eval:"): value = frappe.safe_eval(field_name[5:], get_safe_globals()) elif field_name[0] in ('"', "'"): value = field_name[1:-1] @@ -70,8 +74,9 @@ def get_value_from_fieldname(field_map, fieldname_field, doc): value = get_source_value(doc, field_name) return value + def get_source_value(source, key): - '''Get value from source (object or dict) based on key''' + """Get value from source (object or dict) based on key""" if isinstance(source, dict): return source.get(key) else: diff --git a/frappe/data_migration/doctype/data_migration_mapping/test_data_migration_mapping.py b/frappe/data_migration/doctype/data_migration_mapping/test_data_migration_mapping.py index b1040aaa58..30d2a6bcfe 100644 --- a/frappe/data_migration/doctype/data_migration_mapping/test_data_migration_mapping.py +++ b/frappe/data_migration/doctype/data_migration_mapping/test_data_migration_mapping.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestDataMigrationMapping(unittest.TestCase): pass diff --git a/frappe/data_migration/doctype/data_migration_mapping_detail/data_migration_mapping_detail.py b/frappe/data_migration/doctype/data_migration_mapping_detail/data_migration_mapping_detail.py index ce46f60f67..abd6348a26 100644 --- a/frappe/data_migration/doctype/data_migration_mapping_detail/data_migration_mapping_detail.py +++ b/frappe/data_migration/doctype/data_migration_mapping_detail/data_migration_mapping_detail.py @@ -4,5 +4,6 @@ from frappe.model.document import Document + class DataMigrationMappingDetail(Document): pass diff --git a/frappe/data_migration/doctype/data_migration_plan/data_migration_plan.py b/frappe/data_migration/doctype/data_migration_plan/data_migration_plan.py index d13912b431..4118e8e7fe 100644 --- a/frappe/data_migration/doctype/data_migration_plan/data_migration_plan.py +++ b/frappe/data_migration/doctype/data_migration_plan/data_migration_plan.py @@ -2,10 +2,10 @@ # License: MIT. See LICENSE import frappe -from frappe.modules import get_module_path, scrub_dt_dn -from frappe.modules.export_file import export_to_files, create_init_py from frappe.custom.doctype.custom_field.custom_field import create_custom_field from frappe.model.document import Document +from frappe.modules import get_module_path, scrub_dt_dn +from frappe.modules.export_file import create_init_py, export_to_files def get_mapping_module(module, mapping_name): @@ -14,9 +14,7 @@ def get_mapping_module(module, mapping_name): module = frappe.scrub(module) try: - return frappe.get_module( - f"{app_name}.{module}.data_migration_mapping.{mapping_name}" - ) + return frappe.get_module(f"{app_name}.{module}.data_migration_mapping.{mapping_name}") except ImportError: return None @@ -29,52 +27,52 @@ class DataMigrationPlan(Document): if frappe.flags.in_import or frappe.flags.in_test: return - if frappe.local.conf.get('developer_mode'): - record_list =[['Data Migration Plan', self.name]] + if frappe.local.conf.get("developer_mode"): + record_list = [["Data Migration Plan", self.name]] for m in self.mappings: - record_list.append(['Data Migration Mapping', m.mapping]) + record_list.append(["Data Migration Mapping", m.mapping]) export_to_files(record_list=record_list, record_module=self.module) for m in self.mappings: - dt, dn = scrub_dt_dn('Data Migration Mapping', m.mapping) + dt, dn = scrub_dt_dn("Data Migration Mapping", m.mapping) create_init_py(get_module_path(self.module), dt, dn) def make_custom_fields_for_mappings(self): frappe.flags.ignore_in_install = True - label = self.name + ' ID' + label = self.name + " ID" fieldname = frappe.scrub(label) df = { - 'label': label, - 'fieldname': fieldname, - 'fieldtype': 'Data', - 'hidden': 1, - 'read_only': 1, - 'unique': 1, - 'no_copy': 1 + "label": label, + "fieldname": fieldname, + "fieldtype": "Data", + "hidden": 1, + "read_only": 1, + "unique": 1, + "no_copy": 1, } for m in self.mappings: - mapping = frappe.get_doc('Data Migration Mapping', m.mapping) + mapping = frappe.get_doc("Data Migration Mapping", m.mapping) create_custom_field(mapping.local_doctype, df) mapping.migration_id_field = fieldname mapping.save() # Create custom field in Deleted Document - create_custom_field('Deleted Document', df) + create_custom_field("Deleted Document", df) frappe.flags.ignore_in_install = False def pre_process_doc(self, mapping_name, doc): module = get_mapping_module(self.module, mapping_name) - if module and hasattr(module, 'pre_process'): + if module and hasattr(module, "pre_process"): return module.pre_process(doc) return doc def post_process_doc(self, mapping_name, local_doc=None, remote_doc=None): module = get_mapping_module(self.module, mapping_name) - if module and hasattr(module, 'post_process'): + if module and hasattr(module, "post_process"): return module.post_process(local_doc=local_doc, remote_doc=remote_doc) diff --git a/frappe/data_migration/doctype/data_migration_plan/test_data_migration_plan.py b/frappe/data_migration/doctype/data_migration_plan/test_data_migration_plan.py index 649f7db903..ef3bfa3a70 100644 --- a/frappe/data_migration/doctype/data_migration_plan/test_data_migration_plan.py +++ b/frappe/data_migration/doctype/data_migration_plan/test_data_migration_plan.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestDataMigrationPlan(unittest.TestCase): pass diff --git a/frappe/data_migration/doctype/data_migration_plan_mapping/data_migration_plan_mapping.py b/frappe/data_migration/doctype/data_migration_plan_mapping/data_migration_plan_mapping.py index 7939a68d97..0650f4b2c7 100644 --- a/frappe/data_migration/doctype/data_migration_plan_mapping/data_migration_plan_mapping.py +++ b/frappe/data_migration/doctype/data_migration_plan_mapping/data_migration_plan_mapping.py @@ -4,5 +4,6 @@ from frappe.model.document import Document + class DataMigrationPlanMapping(Document): pass diff --git a/frappe/data_migration/doctype/data_migration_run/data_migration_run.py b/frappe/data_migration/doctype/data_migration_run/data_migration_run.py index deb14baf27..c734cb105b 100644 --- a/frappe/data_migration/doctype/data_migration_run/data_migration_run.py +++ b/frappe/data_migration/doctype/data_migration_run/data_migration_run.py @@ -2,11 +2,17 @@ # Copyright (c) 2017, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe, json, math -from frappe.model.document import Document +import json +import math + +import frappe from frappe import _ +from frappe.data_migration.doctype.data_migration_mapping.data_migration_mapping import ( + get_source_value, +) +from frappe.model.document import Document from frappe.utils import cstr -from frappe.data_migration.doctype.data_migration_mapping.data_migration_mapping import get_source_value + class DataMigrationRun(Document): @frappe.whitelist() @@ -21,44 +27,47 @@ class DataMigrationRun(Document): next_mapping_name = self.get_next_mapping_name() if next_mapping_name: next_mapping = self.get_mapping(next_mapping_name) - self.db_set(dict( - current_mapping = next_mapping.name, - current_mapping_start = 0, - current_mapping_delete_start = 0, - current_mapping_action = 'Insert' - ), notify=True, commit=True) - frappe.enqueue_doc(self.doctype, self.name, 'run_current_mapping', now=frappe.flags.in_test) + self.db_set( + dict( + current_mapping=next_mapping.name, + current_mapping_start=0, + current_mapping_delete_start=0, + current_mapping_action="Insert", + ), + notify=True, + commit=True, + ) + frappe.enqueue_doc(self.doctype, self.name, "run_current_mapping", now=frappe.flags.in_test) else: self.complete() def enqueue_next_page(self): mapping = self.get_mapping(self.current_mapping) percent_complete = self.percent_complete + (100.0 / self.total_pages) - fields = dict( - percent_complete = percent_complete - ) - if self.current_mapping_action == 'Insert': + fields = dict(percent_complete=percent_complete) + if self.current_mapping_action == "Insert": start = self.current_mapping_start + mapping.page_length - fields['current_mapping_start'] = start - elif self.current_mapping_action == 'Delete': + fields["current_mapping_start"] = start + elif self.current_mapping_action == "Delete": delete_start = self.current_mapping_delete_start + mapping.page_length - fields['current_mapping_delete_start'] = delete_start + fields["current_mapping_delete_start"] = delete_start self.db_set(fields, notify=True, commit=True) - if(percent_complete < 100): - frappe.publish_realtime(self.trigger_name, - {"progress_percent": percent_complete}, user=frappe.session.user) + if percent_complete < 100: + frappe.publish_realtime( + self.trigger_name, {"progress_percent": percent_complete}, user=frappe.session.user + ) - frappe.enqueue_doc(self.doctype, self.name, 'run_current_mapping', now=frappe.flags.in_test) + frappe.enqueue_doc(self.doctype, self.name, "run_current_mapping", now=frappe.flags.in_test) def run_current_mapping(self): try: mapping = self.get_mapping(self.current_mapping) - if mapping.mapping_type == 'Push': + if mapping.mapping_type == "Push": done = self.push() - elif mapping.mapping_type == 'Pull': + elif mapping.mapping_type == "Pull": done = self.pull() if done: @@ -67,96 +76,106 @@ class DataMigrationRun(Document): self.enqueue_next_page() except Exception as e: - self.db_set('status', 'Error', notify=True, commit=True) - print('Data Migration Run failed') + self.db_set("status", "Error", notify=True, commit=True) + print("Data Migration Run failed") print(frappe.get_traceback()) - self.execute_postprocess('Error') + self.execute_postprocess("Error") raise e def get_last_modified_condition(self): - last_run_timestamp = frappe.db.get_value('Data Migration Run', dict( - data_migration_plan=self.data_migration_plan, - data_migration_connector=self.data_migration_connector, - name=('!=', self.name) - ), 'modified') + last_run_timestamp = frappe.db.get_value( + "Data Migration Run", + dict( + data_migration_plan=self.data_migration_plan, + data_migration_connector=self.data_migration_connector, + name=("!=", self.name), + ), + "modified", + ) if last_run_timestamp: - condition = dict(modified=('>', last_run_timestamp)) + condition = dict(modified=(">", last_run_timestamp)) else: condition = {} return condition def begin(self): plan_active_mappings = [m for m in self.get_plan().mappings if m.enabled] - self.mappings = [frappe.get_doc( - 'Data Migration Mapping', m.mapping) for m in plan_active_mappings] + self.mappings = [ + frappe.get_doc("Data Migration Mapping", m.mapping) for m in plan_active_mappings + ] total_pages = 0 for m in [mapping for mapping in self.mappings]: - if m.mapping_type == 'Push': + if m.mapping_type == "Push": count = float(self.get_count(m)) page_count = math.ceil(count / m.page_length) total_pages += page_count - if m.mapping_type == 'Pull': + if m.mapping_type == "Pull": total_pages += 10 - self.db_set(dict( - status = 'Started', - current_mapping = None, - current_mapping_start = 0, - current_mapping_delete_start = 0, - percent_complete = 0, - current_mapping_action = 'Insert', - total_pages = total_pages - ), notify=True, commit=True) + self.db_set( + dict( + status="Started", + current_mapping=None, + current_mapping_start=0, + current_mapping_delete_start=0, + percent_complete=0, + current_mapping_action="Insert", + total_pages=total_pages, + ), + notify=True, + commit=True, + ) def complete(self): fields = dict() - push_failed = self.get_log('push_failed', []) - pull_failed = self.get_log('pull_failed', []) + push_failed = self.get_log("push_failed", []) + pull_failed = self.get_log("pull_failed", []) - status = 'Partial Success' + status = "Partial Success" if not push_failed and not pull_failed: - status = 'Success' - fields['percent_complete'] = 100 + status = "Success" + fields["percent_complete"] = 100 - fields['status'] = status + fields["status"] = status self.db_set(fields, notify=True, commit=True) self.execute_postprocess(status) - frappe.publish_realtime(self.trigger_name, - {"progress_percent": 100}, user=frappe.session.user) + frappe.publish_realtime(self.trigger_name, {"progress_percent": 100}, user=frappe.session.user) def execute_postprocess(self, status): # Execute post process postprocess_method_path = self.get_plan().postprocess_method if postprocess_method_path: - frappe.get_attr(postprocess_method_path)({ - "status": status, - "stats": { - "push_insert": self.push_insert, - "push_update": self.push_update, - "push_delete": self.push_delete, - "pull_insert": self.pull_insert, - "pull_update": self.pull_update + frappe.get_attr(postprocess_method_path)( + { + "status": status, + "stats": { + "push_insert": self.push_insert, + "push_update": self.push_update, + "push_delete": self.push_delete, + "pull_insert": self.pull_insert, + "pull_update": self.pull_update, + }, } - }) + ) def get_plan(self): - if not hasattr(self, 'plan'): - self.plan = frappe.get_doc('Data Migration Plan', self.data_migration_plan) + if not hasattr(self, "plan"): + self.plan = frappe.get_doc("Data Migration Plan", self.data_migration_plan) return self.plan def get_mapping(self, mapping_name): - if hasattr(self, 'mappings'): + if hasattr(self, "mappings"): for m in self.mappings: if m.name == mapping_name: return m - return frappe.get_doc('Data Migration Mapping', mapping_name) + return frappe.get_doc("Data Migration Mapping", mapping_name) def get_next_mapping_name(self): mappings = [m for m in self.get_plan().mappings if m.enabled] @@ -168,9 +187,9 @@ class DataMigrationRun(Document): # last return None if d.mapping == self.current_mapping: - return mappings[i+1].mapping + return mappings[i + 1].mapping - raise frappe.ValidationError('Mapping Broken') + raise frappe.ValidationError("Mapping Broken") def get_data(self, filters): mapping = self.get_mapping(self.current_mapping) @@ -178,79 +197,85 @@ class DataMigrationRun(Document): start = self.current_mapping_start data = [] - doclist = frappe.get_all(mapping.local_doctype, - filters=filters, or_filters=or_filters, - start=start, page_length=mapping.page_length) + doclist = frappe.get_all( + mapping.local_doctype, + filters=filters, + or_filters=or_filters, + start=start, + page_length=mapping.page_length, + ) for d in doclist: - doc = frappe.get_doc(mapping.local_doctype, d['name']) + doc = frappe.get_doc(mapping.local_doctype, d["name"]) data.append(doc) return data def get_new_local_data(self): - '''Fetch newly inserted local data using `frappe.get_all`. Used during Push''' + """Fetch newly inserted local data using `frappe.get_all`. Used during Push""" mapping = self.get_mapping(self.current_mapping) filters = mapping.get_filters() or {} # new docs dont have migration field set - filters.update({ - mapping.migration_id_field: '' - }) + filters.update({mapping.migration_id_field: ""}) return self.get_data(filters) def get_updated_local_data(self): - '''Fetch local updated data using `frappe.get_all`. Used during Push''' + """Fetch local updated data using `frappe.get_all`. Used during Push""" mapping = self.get_mapping(self.current_mapping) filters = mapping.get_filters() or {} # existing docs must have migration field set - filters.update({ - mapping.migration_id_field: ('!=', '') - }) + filters.update({mapping.migration_id_field: ("!=", "")}) return self.get_data(filters) def get_deleted_local_data(self): - '''Fetch local deleted data using `frappe.get_all`. Used during Push''' + """Fetch local deleted data using `frappe.get_all`. Used during Push""" mapping = self.get_mapping(self.current_mapping) filters = self.get_last_modified_condition() - filters.update({ - "deleted_doctype": mapping.local_doctype - }) + filters.update({"deleted_doctype": mapping.local_doctype}) - data = frappe.get_all('Deleted Document', fields=['name', 'data'], - filters=filters) + data = frappe.get_all("Deleted Document", fields=["name", "data"], filters=filters) _data = [] for d in data: doc = json.loads(d.data) if doc.get(mapping.migration_id_field): - doc['_deleted_document_name'] = d["name"] + doc["_deleted_document_name"] = d["name"] _data.append(doc) return _data def get_remote_data(self): - '''Fetch data from remote using `connection.get`. Used during Pull''' + """Fetch data from remote using `connection.get`. Used during Pull""" mapping = self.get_mapping(self.current_mapping) start = self.current_mapping_start filters = mapping.get_filters() or {} connection = self.get_connection() - return connection.get(mapping.remote_objectname, - fields=["*"], filters=filters, start=start, - page_length=mapping.page_length) + return connection.get( + mapping.remote_objectname, + fields=["*"], + filters=filters, + start=start, + page_length=mapping.page_length, + ) def get_count(self, mapping): filters = mapping.get_filters() or {} or_filters = self.get_or_filters(mapping) - to_insert = frappe.get_all(mapping.local_doctype, ['count(name) as total'], - filters=filters, or_filters=or_filters)[0].total + to_insert = frappe.get_all( + mapping.local_doctype, ["count(name) as total"], filters=filters, or_filters=or_filters + )[0].total - to_delete = frappe.get_all('Deleted Document', ['count(name) as total'], - filters={'deleted_doctype': mapping.local_doctype}, or_filters=or_filters)[0].total + to_delete = frappe.get_all( + "Deleted Document", + ["count(name) as total"], + filters={"deleted_doctype": mapping.local_doctype}, + or_filters=or_filters, + )[0].total return to_insert + to_delete @@ -259,36 +284,35 @@ class DataMigrationRun(Document): # docs whose migration_id_field is not set # failed in the previous run, include those too - or_filters.update({ - mapping.migration_id_field: ('=', '') - }) + or_filters.update({mapping.migration_id_field: ("=", "")}) return or_filters def get_connection(self): - if not hasattr(self, 'connection'): - self.connection = frappe.get_doc('Data Migration Connector', - self.data_migration_connector).get_connection() + if not hasattr(self, "connection"): + self.connection = frappe.get_doc( + "Data Migration Connector", self.data_migration_connector + ).get_connection() return self.connection def push(self): - self.db_set('current_mapping_type', 'Push') + self.db_set("current_mapping_type", "Push") done = True - if self.current_mapping_action == 'Insert': + if self.current_mapping_action == "Insert": done = self._push_insert() - elif self.current_mapping_action == 'Update': + elif self.current_mapping_action == "Update": done = self._push_update() - elif self.current_mapping_action == 'Delete': + elif self.current_mapping_action == "Delete": done = self._push_delete() return done def _push_insert(self): - '''Inserts new local docs on remote''' + """Inserts new local docs on remote""" mapping = self.get_mapping(self.current_mapping) connection = self.get_connection() data = self.get_new_local_data() @@ -300,31 +324,31 @@ class DataMigrationRun(Document): try: response_doc = connection.insert(mapping.remote_objectname, doc) - frappe.db.set_value(mapping.local_doctype, d.name, - mapping.migration_id_field, response_doc[connection.name_field], - update_modified=False) + frappe.db.set_value( + mapping.local_doctype, + d.name, + mapping.migration_id_field, + response_doc[connection.name_field], + update_modified=False, + ) frappe.db.commit() - self.update_log('push_insert', 1) + self.update_log("push_insert", 1) # post process after insert self.post_process_doc(local_doc=d, remote_doc=response_doc) except Exception as e: - self.update_log('push_failed', {d.name: cstr(e)}) + self.update_log("push_failed", {d.name: cstr(e)}) # update page_start - self.db_set('current_mapping_start', - self.current_mapping_start + mapping.page_length) + self.db_set("current_mapping_start", self.current_mapping_start + mapping.page_length) if len(data) < mapping.page_length: # done, no more new data to insert - self.db_set({ - 'current_mapping_action': 'Update', - 'current_mapping_start': 0 - }) + self.db_set({"current_mapping_action": "Update", "current_mapping_start": 0}) # not done with this mapping return False def _push_update(self): - '''Updates local modified docs on remote''' + """Updates local modified docs on remote""" mapping = self.get_mapping(self.current_mapping) connection = self.get_connection() data = self.get_updated_local_data() @@ -336,27 +360,23 @@ class DataMigrationRun(Document): doc = mapping.get_mapped_record(doc) try: response_doc = connection.update(mapping.remote_objectname, doc, migration_id_value) - self.update_log('push_update', 1) + self.update_log("push_update", 1) # post process after update self.post_process_doc(local_doc=d, remote_doc=response_doc) except Exception as e: - self.update_log('push_failed', {d.name: cstr(e)}) + self.update_log("push_failed", {d.name: cstr(e)}) # update page_start - self.db_set('current_mapping_start', - self.current_mapping_start + mapping.page_length) + self.db_set("current_mapping_start", self.current_mapping_start + mapping.page_length) if len(data) < mapping.page_length: # done, no more data to update - self.db_set({ - 'current_mapping_action': 'Delete', - 'current_mapping_start': 0 - }) + self.db_set({"current_mapping_action": "Delete", "current_mapping_start": 0}) # not done with this mapping return False def _push_delete(self): - '''Deletes docs deleted from local on remote''' + """Deletes docs deleted from local on remote""" mapping = self.get_mapping(self.current_mapping) connection = self.get_connection() data = self.get_deleted_local_data() @@ -368,15 +388,14 @@ class DataMigrationRun(Document): self.pre_process_doc(d) try: response_doc = connection.delete(mapping.remote_objectname, migration_id_value) - self.update_log('push_delete', 1) + self.update_log("push_delete", 1) # post process only when action is success self.post_process_doc(local_doc=d, remote_doc=response_doc) except Exception as e: - self.update_log('push_failed', {d.name: cstr(e)}) + self.update_log("push_failed", {d.name: cstr(e)}) # update page_start - self.db_set('current_mapping_start', - self.current_mapping_start + mapping.page_length) + self.db_set("current_mapping_start", self.current_mapping_start + mapping.page_length) if len(data) < mapping.page_length: # done, no more new data to delete @@ -384,7 +403,7 @@ class DataMigrationRun(Document): return True def pull(self): - self.db_set('current_mapping_type', 'Pull') + self.db_set("current_mapping_type", "Pull") connection = self.get_connection() mapping = self.get_mapping(self.current_mapping) @@ -401,21 +420,25 @@ class DataMigrationRun(Document): # insert new local doc local_doc = insert_local_doc(mapping, doc) - self.update_log('pull_insert', 1) + self.update_log("pull_insert", 1) # set migration id - frappe.db.set_value(mapping.local_doctype, local_doc.name, - mapping.migration_id_field, migration_id_value, - update_modified=False) + frappe.db.set_value( + mapping.local_doctype, + local_doc.name, + mapping.migration_id_field, + migration_id_value, + update_modified=False, + ) frappe.db.commit() else: # update doc local_doc = update_local_doc(mapping, doc, migration_id_value) - self.update_log('pull_update', 1) + self.update_log("pull_update", 1) # post process doc after success self.post_process_doc(remote_doc=d, local_doc=local_doc) except Exception as e: # failed, append to log - self.update_log('pull_failed', {migration_id_value: cstr(e)}) + self.update_log("pull_failed", {migration_id_value: cstr(e)}) if len(data) < mapping.page_length: # last page, done with pull @@ -432,16 +455,16 @@ class DataMigrationRun(Document): return doc def set_log(self, key, value): - value = json.dumps(value) if '_failed' in key else value + value = json.dumps(value) if "_failed" in key else value self.db_set(key, value) def update_log(self, key, value=None): - ''' + """ Helper for updating logs, push_failed and pull_failed are stored as json, other keys are stored as int - ''' - if '_failed' in key: + """ + if "_failed" in key: # json self.set_log(key, self.get_log(key, []) + [value]) else: @@ -450,11 +473,13 @@ class DataMigrationRun(Document): def get_log(self, key, default=None): value = self.db_get(key) - if '_failed' in key: - if not value: value = json.dumps(default) + if "_failed" in key: + if not value: + value = json.dumps(default) value = json.loads(value) return value or default + def insert_local_doc(mapping, doc): try: # insert new doc @@ -463,26 +488,27 @@ def insert_local_doc(mapping, doc): doc = frappe.get_doc(doc).insert() return doc except Exception: - print('Data Migration Run failed: Error in Pull insert') + print("Data Migration Run failed: Error in Pull insert") print(frappe.get_traceback()) return None + def update_local_doc(mapping, remote_doc, migration_id_value): try: # migration id value is set in migration_id_field in mapping.local_doctype - docname = frappe.db.get_value(mapping.local_doctype, - filters={ mapping.migration_id_field: migration_id_value }) + docname = frappe.db.get_value( + mapping.local_doctype, filters={mapping.migration_id_field: migration_id_value} + ) doc = frappe.get_doc(mapping.local_doctype, docname) doc.update(remote_doc) doc.save() return doc except Exception: - print('Data Migration Run failed: Error in Pull update') + print("Data Migration Run failed: Error in Pull update") print(frappe.get_traceback()) return None + def local_doc_exists(mapping, migration_id_value): - return frappe.db.exists(mapping.local_doctype, { - mapping.migration_id_field: migration_id_value - }) + return frappe.db.exists(mapping.local_doctype, {mapping.migration_id_field: migration_id_value}) diff --git a/frappe/data_migration/doctype/data_migration_run/test_data_migration_run.py b/frappe/data_migration/doctype/data_migration_run/test_data_migration_run.py index 485f86a7f9..0357b1e0f5 100644 --- a/frappe/data_migration/doctype/data_migration_run/test_data_migration_run.py +++ b/frappe/data_migration/doctype/data_migration_run/test_data_migration_run.py @@ -1,113 +1,128 @@ # -*- coding: utf-8 -*- # Copyright (c) 2017, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest + +import frappe + class TestDataMigrationRun(unittest.TestCase): def test_run(self): create_plan() - description = 'data migration todo' - new_todo = frappe.get_doc({ - 'doctype': 'ToDo', - 'description': description - }).insert() - - event_subject = 'data migration event' - frappe.get_doc(dict( - doctype='Event', - subject=event_subject, - repeat_on='Monthly', - starts_on=frappe.utils.now_datetime() - )).insert() - - run = frappe.get_doc({ - 'doctype': 'Data Migration Run', - 'data_migration_plan': 'ToDo Sync', - 'data_migration_connector': 'Local Connector' - }).insert() + description = "data migration todo" + new_todo = frappe.get_doc({"doctype": "ToDo", "description": description}).insert() + + event_subject = "data migration event" + frappe.get_doc( + dict( + doctype="Event", + subject=event_subject, + repeat_on="Monthly", + starts_on=frappe.utils.now_datetime(), + ) + ).insert() + + run = frappe.get_doc( + { + "doctype": "Data Migration Run", + "data_migration_plan": "ToDo Sync", + "data_migration_connector": "Local Connector", + } + ).insert() run.run() - self.assertEqual(run.db_get('status'), 'Success') + self.assertEqual(run.db_get("status"), "Success") - self.assertEqual(run.db_get('push_insert'), 1) - self.assertEqual(run.db_get('pull_insert'), 1) + self.assertEqual(run.db_get("push_insert"), 1) + self.assertEqual(run.db_get("pull_insert"), 1) - todo = frappe.get_doc('ToDo', new_todo.name) + todo = frappe.get_doc("ToDo", new_todo.name) self.assertTrue(todo.todo_sync_id) # Pushed Event - event = frappe.get_doc('Event', todo.todo_sync_id) + event = frappe.get_doc("Event", todo.todo_sync_id) self.assertEqual(event.subject, description) # Pulled ToDo - created_todo = frappe.get_doc('ToDo', {'description': event_subject}) + created_todo = frappe.get_doc("ToDo", {"description": event_subject}) self.assertEqual(created_todo.description, event_subject) - todo_list = frappe.get_list('ToDo', filters={'description': 'data migration todo'}, fields=['name']) + todo_list = frappe.get_list( + "ToDo", filters={"description": "data migration todo"}, fields=["name"] + ) todo_name = todo_list[0].name - todo = frappe.get_doc('ToDo', todo_name) - todo.description = 'data migration todo updated' + todo = frappe.get_doc("ToDo", todo_name) + todo.description = "data migration todo updated" todo.save() - run = frappe.get_doc({ - 'doctype': 'Data Migration Run', - 'data_migration_plan': 'ToDo Sync', - 'data_migration_connector': 'Local Connector' - }).insert() + run = frappe.get_doc( + { + "doctype": "Data Migration Run", + "data_migration_plan": "ToDo Sync", + "data_migration_connector": "Local Connector", + } + ).insert() run.run() # Update - self.assertEqual(run.db_get('status'), 'Success') - self.assertEqual(run.db_get('pull_update'), 1) + self.assertEqual(run.db_get("status"), "Success") + self.assertEqual(run.db_get("pull_update"), 1) + def create_plan(): - frappe.get_doc({ - 'doctype': 'Data Migration Mapping', - 'mapping_name': 'Todo to Event', - 'remote_objectname': 'Event', - 'remote_primary_key': 'name', - 'mapping_type': 'Push', - 'local_doctype': 'ToDo', - 'fields': [ - { 'remote_fieldname': 'subject', 'local_fieldname': 'description' }, - { 'remote_fieldname': 'starts_on', 'local_fieldname': 'eval:frappe.utils.get_datetime_str(frappe.utils.get_datetime())' } - ], - 'condition': '{"description": "data migration todo" }' - }).insert(ignore_if_duplicate=True) - - frappe.get_doc({ - 'doctype': 'Data Migration Mapping', - 'mapping_name': 'Event to ToDo', - 'remote_objectname': 'Event', - 'remote_primary_key': 'name', - 'local_doctype': 'ToDo', - 'local_primary_key': 'name', - 'mapping_type': 'Pull', - 'condition': '{"subject": "data migration event" }', - 'fields': [ - { 'remote_fieldname': 'subject', 'local_fieldname': 'description' } - ] - }).insert(ignore_if_duplicate=True) - - frappe.get_doc({ - 'doctype': 'Data Migration Plan', - 'plan_name': 'ToDo Sync', - 'module': 'Core', - 'mappings': [ - { 'mapping': 'Todo to Event' }, - { 'mapping': 'Event to ToDo' } - ] - }).insert(ignore_if_duplicate=True) - - frappe.get_doc({ - 'doctype': 'Data Migration Connector', - 'connector_name': 'Local Connector', - 'connector_type': 'Frappe', - # connect to same host. - 'hostname': frappe.conf.host_name or frappe.utils.get_site_url(frappe.local.site), - 'username': 'Administrator', - 'password': frappe.conf.get("admin_password") or 'admin' - }).insert(ignore_if_duplicate=True) + frappe.get_doc( + { + "doctype": "Data Migration Mapping", + "mapping_name": "Todo to Event", + "remote_objectname": "Event", + "remote_primary_key": "name", + "mapping_type": "Push", + "local_doctype": "ToDo", + "fields": [ + {"remote_fieldname": "subject", "local_fieldname": "description"}, + { + "remote_fieldname": "starts_on", + "local_fieldname": "eval:frappe.utils.get_datetime_str(frappe.utils.get_datetime())", + }, + ], + "condition": '{"description": "data migration todo" }', + } + ).insert(ignore_if_duplicate=True) + + frappe.get_doc( + { + "doctype": "Data Migration Mapping", + "mapping_name": "Event to ToDo", + "remote_objectname": "Event", + "remote_primary_key": "name", + "local_doctype": "ToDo", + "local_primary_key": "name", + "mapping_type": "Pull", + "condition": '{"subject": "data migration event" }', + "fields": [{"remote_fieldname": "subject", "local_fieldname": "description"}], + } + ).insert(ignore_if_duplicate=True) + + frappe.get_doc( + { + "doctype": "Data Migration Plan", + "plan_name": "ToDo Sync", + "module": "Core", + "mappings": [{"mapping": "Todo to Event"}, {"mapping": "Event to ToDo"}], + } + ).insert(ignore_if_duplicate=True) + + frappe.get_doc( + { + "doctype": "Data Migration Connector", + "connector_name": "Local Connector", + "connector_type": "Frappe", + # connect to same host. + "hostname": frappe.conf.host_name or frappe.utils.get_site_url(frappe.local.site), + "username": "Administrator", + "password": frappe.conf.get("admin_password") or "admin", + } + ).insert(ignore_if_duplicate=True) diff --git a/frappe/database/__init__.py b/frappe/database/__init__.py index 5db0537ed7..7de3fabf01 100644 --- a/frappe/database/__init__.py +++ b/frappe/database/__init__.py @@ -6,38 +6,60 @@ from frappe.database.database import savepoint + def setup_database(force, source_sql=None, verbose=None, no_mariadb_socket=False): import frappe - if frappe.conf.db_type == 'postgres': + + if frappe.conf.db_type == "postgres": import frappe.database.postgres.setup_db + return frappe.database.postgres.setup_db.setup_database(force, source_sql, verbose) else: import frappe.database.mariadb.setup_db - return frappe.database.mariadb.setup_db.setup_database(force, source_sql, verbose, no_mariadb_socket=no_mariadb_socket) + + return frappe.database.mariadb.setup_db.setup_database( + force, source_sql, verbose, no_mariadb_socket=no_mariadb_socket + ) + def drop_user_and_database(db_name, root_login=None, root_password=None): import frappe - if frappe.conf.db_type == 'postgres': + + if frappe.conf.db_type == "postgres": import frappe.database.postgres.setup_db - return frappe.database.postgres.setup_db.drop_user_and_database(db_name, root_login, root_password) + + return frappe.database.postgres.setup_db.drop_user_and_database( + db_name, root_login, root_password + ) else: import frappe.database.mariadb.setup_db - return frappe.database.mariadb.setup_db.drop_user_and_database(db_name, root_login, root_password) + + return frappe.database.mariadb.setup_db.drop_user_and_database( + db_name, root_login, root_password + ) + def get_db(host=None, user=None, password=None, port=None): import frappe - if frappe.conf.db_type == 'postgres': + + if frappe.conf.db_type == "postgres": import frappe.database.postgres.database + return frappe.database.postgres.database.PostgresDatabase(host, user, password, port=port) else: import frappe.database.mariadb.database + return frappe.database.mariadb.database.MariaDBDatabase(host, user, password, port=port) + def setup_help_database(help_db_name): import frappe - if frappe.conf.db_type == 'postgres': + + if frappe.conf.db_type == "postgres": import frappe.database.postgres.setup_db + return frappe.database.postgres.setup_db.setup_help_database(help_db_name) else: import frappe.database.mariadb.setup_db + return frappe.database.mariadb.setup_db.setup_help_database(help_db_name) diff --git a/frappe/database/database.py b/frappe/database/database.py index 7551c5f628..424bcbbc63 100644 --- a/frappe/database/database.py +++ b/frappe/database/database.py @@ -28,27 +28,28 @@ from .query import Query class Database(object): """ - Open a database connection with the given parmeters, if use_default is True, use the - login details from `conf.py`. This is called by the request handler and is accessible using - the `db` global variable. the `sql` method is also global to run queries + Open a database connection with the given parmeters, if use_default is True, use the + login details from `conf.py`. This is called by the request handler and is accessible using + the `db` global variable. the `sql` method is also global to run queries """ + VARCHAR_LEN = 140 MAX_COLUMN_LENGTH = 64 OPTIONAL_COLUMNS = ["_user_tags", "_comments", "_assign", "_liked_by"] - DEFAULT_SHORTCUTS = ['_Login', '__user', '_Full Name', 'Today', '__today', "now", "Now"] - STANDARD_VARCHAR_COLUMNS = ('name', 'owner', 'modified_by') - DEFAULT_COLUMNS = ['name', 'creation', 'modified', 'modified_by', 'owner', 'docstatus', 'idx'] - CHILD_TABLE_COLUMNS = ('parent', 'parenttype', 'parentfield') + DEFAULT_SHORTCUTS = ["_Login", "__user", "_Full Name", "Today", "__today", "now", "Now"] + STANDARD_VARCHAR_COLUMNS = ("name", "owner", "modified_by") + DEFAULT_COLUMNS = ["name", "creation", "modified", "modified_by", "owner", "docstatus", "idx"] + CHILD_TABLE_COLUMNS = ("parent", "parenttype", "parentfield") MAX_WRITES_PER_TRANSACTION = 200_000 - class InvalidColumnName(frappe.ValidationError): pass - + class InvalidColumnName(frappe.ValidationError): + pass def __init__(self, host=None, user=None, password=None, ac_name=None, use_default=0, port=None): self.setup_type_map() - self.host = host or frappe.conf.db_host or '127.0.0.1' - self.port = port or frappe.conf.db_port or '' + self.host = host or frappe.conf.db_host or "127.0.0.1" + self.port = port or frappe.conf.db_port or "" self.user = user or frappe.conf.db_name self.db_name = frappe.conf.db_name self._conn = None @@ -86,9 +87,22 @@ class Database(object): def get_database_size(self): pass - def sql(self, query, values=(), as_dict = 0, as_list = 0, formatted = 0, - debug=0, ignore_ddl=0, as_utf8=0, auto_commit=0, update=None, - explain=False, run=True, pluck=False): + def sql( + self, + query, + values=(), + as_dict=0, + as_list=0, + formatted=0, + debug=0, + ignore_ddl=0, + as_utf8=0, + auto_commit=0, + update=None, + explain=False, + run=True, + pluck=False, + ): """Execute a SQL query and fetch all rows. :param query: SQL query. @@ -104,15 +118,15 @@ class Database(object): :param run: Returns query without executing it if False. Examples: - # return customer names as dicts - frappe.db.sql("select name from tabCustomer", as_dict=True) + # return customer names as dicts + frappe.db.sql("select name from tabCustomer", as_dict=True) - # return names beginning with a - frappe.db.sql("select name from tabCustomer where name like %s", "a%") + # return names beginning with a + frappe.db.sql("select name from tabCustomer where name like %s", "a%") - # values as dict - frappe.db.sql("select name from tabCustomer where name like %(name)s and owner=%(owner)s", - {"name": "a%", "owner":"test@example.com"}) + # values as dict + frappe.db.sql("select name from tabCustomer where name like %(name)s and owner=%(owner)s", + {"name": "a%", "owner":"test@example.com"}) """ debug = debug or getattr(self, "debug", False) @@ -123,9 +137,9 @@ class Database(object): # remove whitespace / indentation from start and end of query query = query.strip() - if re.search(r'ifnull\(', query, flags=re.IGNORECASE): + if re.search(r"ifnull\(", query, flags=re.IGNORECASE): # replaces ifnull in query with coalesce - query = re.sub(r'ifnull\(', 'coalesce(', query, flags=re.IGNORECASE) + query = re.sub(r"ifnull\(", "coalesce(", query, flags=re.IGNORECASE) if not self._conn: self.connect() @@ -136,7 +150,8 @@ class Database(object): self.clear_db_table_cache(query) # autocommit - if auto_commit: self.commit() + if auto_commit: + self.commit() # execute try: @@ -145,7 +160,7 @@ class Database(object): self.log_query(query, values, debug, explain) - if values!=(): + if values != (): # MySQL-python==1.2.5 hack! if not isinstance(values, (dict, tuple, list)): @@ -169,7 +184,7 @@ class Database(object): except Exception as e: if self.is_syntax_error(e): # only for mariadb - frappe.errprint('Syntax error in query:') + frappe.errprint("Syntax error in query:") frappe.errprint(query) elif self.is_deadlocked(e): @@ -178,17 +193,20 @@ class Database(object): elif self.is_timedout(e): raise frappe.QueryTimeoutError(e) - elif frappe.conf.db_type == 'postgres': + elif frappe.conf.db_type == "postgres": # TODO: added temporarily print(e) raise - if ignore_ddl and (self.is_missing_column(e) or self.is_table_missing(e) or self.cant_drop_field_or_key(e)): + if ignore_ddl and ( + self.is_missing_column(e) or self.is_table_missing(e) or self.cant_drop_field_or_key(e) + ): pass else: raise - if auto_commit: self.commit() + if auto_commit: + self.commit() if not self._cursor.description: return () @@ -212,29 +230,29 @@ class Database(object): def log_query(self, query, values, debug, explain): # for debugging in tests - if frappe.conf.get('allow_tests') and frappe.cache().get_value('flag_print_sql'): + if frappe.conf.get("allow_tests") and frappe.cache().get_value("flag_print_sql"): print(self.mogrify(query, values)) # debug if debug: - if explain and query.strip().lower().startswith('select'): + if explain and query.strip().lower().startswith("select"): self.explain_query(query, values) frappe.errprint(self.mogrify(query, values)) # info - if (frappe.conf.get("logging") or False)==2: + if (frappe.conf.get("logging") or False) == 2: frappe.log("<<<< query") frappe.log(self.mogrify(query, values)) frappe.log(">>>>") def mogrify(self, query, values): - '''build the query string with values''' + """build the query string with values""" if not values: return query else: try: return self._cursor.mogrify(query, values) - except: # noqa: E722 + except: # noqa: E722 return (query, values) def explain_query(self, query, values=None): @@ -246,6 +264,7 @@ class Database(object): else: self._cursor.execute("explain " + query, values) import json + frappe.errprint(json.dumps(self.fetch_as_dict(), indent=1)) frappe.errprint("--- query explain end ---") except Exception: @@ -256,8 +275,8 @@ class Database(object): Example: - # doctypes = ["DocType", "DocField", "User", ...] - doctypes = frappe.db.sql_list("select name from DocType") + # doctypes = ["DocType", "DocField", "User", ...] + doctypes = frappe.db.sql_list("select name from DocType") """ return [r[0] for r in self.sql(query, values, **kwargs, debug=debug)] @@ -267,17 +286,16 @@ class Database(object): self.commit() self.sql(query, debug=debug) - def check_transaction_status(self, query): """Raises exception if more than 20,000 `INSERT`, `UPDATE` queries are executed in one transaction. This is to ensure that writes are always flushed otherwise this could cause the system to hang.""" self.check_implicit_commit(query) - if query and query.strip().lower() in ('commit', 'rollback'): + if query and query.strip().lower() in ("commit", "rollback"): self.transaction_writes = 0 - if query[:6].lower() in ('update', 'insert', 'delete'): + if query[:6].lower() in ("update", "insert", "delete"): self.transaction_writes += 1 if self.transaction_writes > self.MAX_WRITES_PER_TRANSACTION: if self.auto_commit_on_many_writes: @@ -288,9 +306,13 @@ class Database(object): raise frappe.TooManyWritesError(msg) def check_implicit_commit(self, query): - if self.transaction_writes and \ - query and query.strip().split()[0].lower() in ['start', 'alter', 'drop', 'create', "begin", "truncate"]: - raise Exception('This statement can cause implicit commit') + if ( + self.transaction_writes + and query + and query.strip().split()[0].lower() + in ["start", "alter", "drop", "create", "begin", "truncate"] + ): + raise Exception("This statement can cause implicit commit") def fetch_as_dict(self, formatted=0, as_utf8=0): """Internal. Converts results to dict.""" @@ -303,7 +325,7 @@ class Database(object): values = [] for value in r: if as_utf8 and isinstance(value, str): - value = value.encode('utf-8') + value = value.encode("utf-8") values.append(value) ret.append(frappe._dict(zip(keys, values))) @@ -311,8 +333,8 @@ class Database(object): @staticmethod def clear_db_table_cache(query): - if query and query.strip().split()[0].lower() in {'drop', 'create'}: - frappe.cache().delete_key('db_tables') + if query and query.strip().split()[0].lower() in {"drop", "create"}: + frappe.cache().delete_key("db_tables") @staticmethod def needs_formatting(result, formatted): @@ -338,7 +360,7 @@ class Database(object): nr = [] for val in r: if as_utf8 and isinstance(val, str): - val = val.encode('utf-8') + val = val.encode("utf-8") nr.append(val) nres.append(nr) return nres @@ -375,21 +397,34 @@ class Database(object): Example: - # return first customer starting with a - frappe.db.get_value("Customer", {"name": ("like a%")}) + # return first customer starting with a + frappe.db.get_value("Customer", {"name": ("like a%")}) - # return last login of **User** `test@example.com` - frappe.db.get_value("User", "test@example.com", "last_login") + # return last login of **User** `test@example.com` + frappe.db.get_value("User", "test@example.com", "last_login") - last_login, last_ip = frappe.db.get_value("User", "test@example.com", - ["last_login", "last_ip"]) + last_login, last_ip = frappe.db.get_value("User", "test@example.com", + ["last_login", "last_ip"]) - # returns default date_format - frappe.db.get_value("System Settings", None, "date_format") + # returns default date_format + frappe.db.get_value("System Settings", None, "date_format") """ - result = self.get_values(doctype, filters, fieldname, ignore, as_dict, debug, - order_by, cache=cache, for_update=for_update, run=run, pluck=pluck, distinct=distinct, limit=1) + result = self.get_values( + doctype, + filters, + fieldname, + ignore, + as_dict, + debug, + order_by, + cache=cache, + for_update=for_update, + run=run, + pluck=pluck, + distinct=distinct, + limit=1, + ) if not run: return result @@ -405,10 +440,24 @@ class Database(object): # single field is requested, send it without wrapping in containers return row[0] - - def get_values(self, doctype, filters=None, fieldname="name", ignore=None, as_dict=False, - debug=False, order_by="KEEP_DEFAULT_ORDERING", update=None, cache=False, for_update=False, - *, run=True, pluck=False, distinct=False, limit=None): + def get_values( + self, + doctype, + filters=None, + fieldname="name", + ignore=None, + as_dict=False, + debug=False, + order_by="KEEP_DEFAULT_ORDERING", + update=None, + cache=False, + for_update=False, + *, + run=True, + pluck=False, + distinct=False, + limit=None, + ): """Returns multiple document properties. :param doctype: DocType name. @@ -422,15 +471,14 @@ class Database(object): Example: - # return first customer starting with a - customers = frappe.db.get_values("Customer", {"name": ("like a%")}) + # return first customer starting with a + customers = frappe.db.get_values("Customer", {"name": ("like a%")}) - # return last login of **User** `test@example.com` - user = frappe.db.get_values("User", "test@example.com", "*")[0] + # return last login of **User** `test@example.com` + user = frappe.db.get_values("User", "test@example.com", "*")[0] """ out = None - if cache and isinstance(filters, str) and \ - (doctype, filters, fieldname) in self.value_cache: + if cache and isinstance(filters, str) and (doctype, filters, fieldname) in self.value_cache: return self.value_cache[(doctype, filters, fieldname)] if distinct: @@ -456,7 +504,7 @@ class Database(object): if isinstance(fieldname, str): fields = [fieldname] - if (filters is not None) and (filters!=doctype or doctype=="DocType"): + if (filters is not None) and (filters != doctype or doctype == "DocType"): try: if order_by: order_by = "modified" if order_by == "KEEP_DEFAULT_ORDERING" else order_by @@ -480,12 +528,16 @@ class Database(object): out = None elif (not ignore) and frappe.db.is_table_missing(e): # table not found, look in singles - out = self.get_values_from_single(fields, filters, doctype, as_dict, debug, update, run=run, distinct=distinct) + out = self.get_values_from_single( + fields, filters, doctype, as_dict, debug, update, run=run, distinct=distinct + ) else: raise else: - out = self.get_values_from_single(fields, filters, doctype, as_dict, debug, update, run=run, pluck=pluck, distinct=distinct) + out = self.get_values_from_single( + fields, filters, doctype, as_dict, debug, update, run=run, pluck=pluck, distinct=distinct + ) if cache and isinstance(filters, str): self.value_cache[(doctype, filters, fieldname)] = out @@ -515,7 +567,7 @@ class Database(object): # if not frappe.model.meta.is_single(doctype): # raise frappe.DoesNotExistError("DocType", doctype) - if fields=="*" or isinstance(filters, dict): + if fields == "*" or isinstance(filters, dict): # check if single doc matches with filters values = self.get_singles_dict(doctype) if isinstance(filters, dict): @@ -550,7 +602,6 @@ class Database(object): else: return r and [[i[1] for i in r]] or [] - def get_singles_dict(self, doctype, debug=False, *, for_update=False): """Get Single DocType as dict. @@ -558,8 +609,8 @@ class Database(object): Example: - # Get coulmn and value of the single doctype Accounts Settings - account_settings = frappe.db.get_singles_dict("Accounts Settings") + # Get coulmn and value of the single doctype Accounts Settings + account_settings = frappe.db.get_singles_dict("Accounts Settings") """ result = self.query.get_sql( "Singles", @@ -578,7 +629,14 @@ class Database(object): def get_list(*args, **kwargs): return frappe.get_list(*args, **kwargs) - def set_single_value(self, doctype: str, fieldname: Union[str, Dict], value: Optional[Union[str, int]] = None, *args, **kwargs): + def set_single_value( + self, + doctype: str, + fieldname: Union[str, Dict], + value: Optional[Union[str, int]] = None, + *args, + **kwargs, + ): """Set field value of Single DocType. :param doctype: DocType of the single object @@ -587,8 +645,8 @@ class Database(object): Example: - # Update the `deny_multiple_sessions` field in System Settings DocType. - company = frappe.db.set_single_value("System Settings", "deny_multiple_sessions", True) + # Update the `deny_multiple_sessions` field in System Settings DocType. + company = frappe.db.set_single_value("System Settings", "deny_multiple_sessions", True) """ return self.set_value(doctype, doctype, fieldname, value, *args, **kwargs) @@ -600,8 +658,8 @@ class Database(object): Example: - # Get the default value of the company from the Global Defaults doctype. - company = frappe.db.get_single_value('Global Defaults', 'default_company') + # Get the default value of the company from the Global Defaults doctype. + company = frappe.db.get_single_value('Global Defaults', 'default_company') """ if doctype not in self.value_cache: @@ -620,7 +678,9 @@ class Database(object): df = frappe.get_meta(doctype).get_field(fieldname) if not df: - frappe.throw(_('Invalid field name: {0}').format(frappe.bold(fieldname)), self.InvalidColumnName) + frappe.throw( + _("Invalid field name: {0}").format(frappe.bold(fieldname)), self.InvalidColumnName + ) val = cast(df.fieldtype, val) @@ -667,16 +727,10 @@ class Database(object): distinct=distinct, limit=limit, ) - if ( - fields == "*" - and not isinstance(fields, (list, tuple)) - and not isinstance(fields, Criterion) - ): + if fields == "*" and not isinstance(fields, (list, tuple)) and not isinstance(fields, Criterion): as_dict = True - r = self.sql( - query, as_dict=as_dict, debug=debug, update=update, run=run, pluck=pluck - ) + r = self.sql(query, as_dict=as_dict, debug=debug, update=update, run=run, pluck=pluck) return r def _get_value_for_many_names( @@ -691,7 +745,7 @@ class Database(object): pluck=False, distinct=False, limit=None, - as_dict=False + as_dict=False, ): names = list(filter(None, names)) if names: @@ -705,7 +759,7 @@ class Database(object): as_list=not as_dict, run=run, distinct=distinct, - limit_page_length=limit + limit_page_length=limit, ) else: return {} @@ -714,8 +768,18 @@ class Database(object): """Update multiple values. Alias for `set_value`.""" return self.set_value(*args, **kwargs) - def set_value(self, dt, dn, field, val=None, modified=None, modified_by=None, - update_modified=True, debug=False, for_update=True): + def set_value( + self, + dt, + dn, + field, + val=None, + modified=None, + modified_by=None, + update_modified=True, + debug=False, + for_update=True, + ): """Set a single value in the database, do not call the ORM triggers but update the modified timestamp (unless specified not to). @@ -741,15 +805,12 @@ class Database(object): if is_single_doctype: frappe.db.delete( - "Singles", - filters={"field": ("in", tuple(to_update)), "doctype": dt}, debug=debug + "Singles", filters={"field": ("in", tuple(to_update)), "doctype": dt}, debug=debug ) singles_data = ((dt, key, sbool(value)) for key, value in to_update.items()) query = ( - frappe.qb.into("Singles") - .columns("doctype", "field", "value") - .insert(*singles_data) + frappe.qb.into("Singles").columns("doctype", "field", "value").insert(*singles_data) ).run(debug=debug) frappe.clear_document_cache(dt, dt) @@ -770,7 +831,7 @@ class Database(object): # TODO: Fix this; doesn't work rn - gavin@frappe.io # frappe.cache().hdel_keys(dt, "document_cache") # Workaround: clear all document caches - frappe.cache().delete_value('document_cache') + frappe.cache().delete_value("document_cache") for column, value in to_update.items(): query = query.set(column, value) @@ -788,8 +849,13 @@ class Database(object): def touch(self, doctype, docname): """Update the modified timestamp of this document.""" modified = now() - self.sql("""update `tab{doctype}` set `modified`=%s - where name=%s""".format(doctype=doctype), (modified, docname)) + self.sql( + """update `tab{doctype}` set `modified`=%s + where name=%s""".format( + doctype=doctype + ), + (modified, docname), + ) return modified @staticmethod @@ -804,11 +870,11 @@ class Database(object): """Return the temperory value and delete it.""" return frappe.cache().hget("temp", key) - def set_global(self, key, val, user='__global'): + def set_global(self, key, val, user="__global"): """Save a global key value. Global values will be automatically set if they match fieldname.""" self.set_default(key, val, user) - def get_global(self, key, user='__global'): + def get_global(self, key, user="__global"): """Returns a global key value.""" return self.get_default(key, user) @@ -827,14 +893,13 @@ class Database(object): """Append a default value for a key, there can be multiple default values for a particular key.""" frappe.defaults.add_default(key, val, parent, parenttype) - @staticmethod def get_defaults(key=None, parent="__default"): """Get all defaults""" if key: defaults = frappe.defaults.get_defaults(parent) d = defaults.get(key, None) - if(not d and key != frappe.scrub(key)): + if not d and key != frappe.scrub(key): d = defaults.get(frappe.scrub(key), None) return d else: @@ -871,8 +936,8 @@ class Database(object): Changes can be undone to a save point by doing frappe.db.rollback(save_point) Note: rollback watchers can not work with save points. - so only changes to database are undone when rolling back to a savepoint. - Avoid using savepoints when writing to filesystem.""" + so only changes to database are undone when rolling back to a savepoint. + Avoid using savepoints when writing to filesystem.""" self.sql(f"savepoint {save_point}") def release_savepoint(self, save_point): @@ -892,10 +957,7 @@ class Database(object): def field_exists(self, dt, fn): """Return true of field exists.""" - return self.exists('DocField', { - 'fieldname': fn, - 'parent': dt - }) + return self.exists("DocField", {"fieldname": fn, "parent": dt}) def table_exists(self, doctype, cached=True): """Returns True if table for given doctype exists.""" @@ -905,15 +967,17 @@ class Database(object): return self.table_exists(doctype) def get_tables(self, cached=True): - tables = frappe.cache().get_value('db_tables') + tables = frappe.cache().get_value("db_tables") if not tables or not cached: - table_rows = self.sql(""" + table_rows = self.sql( + """ SELECT table_name FROM information_schema.tables WHERE table_schema NOT IN ('pg_catalog', 'information_schema') - """) + """ + ) tables = {d[0] for d in table_rows} - frappe.cache().set_value('db_tables', tables) + frappe.cache().set_value("db_tables", tables) return tables def a_row_exists(self, doctype): @@ -950,7 +1014,7 @@ class Database(object): return dn if isinstance(dt, dict): - dt = dt.copy() # don't modify the original dict + dt = dt.copy() # don't modify the original dict dt, dn = dt.pop("doctype"), dt return self.get_value(dt, dn, ignore=True, cache=cache) @@ -958,7 +1022,7 @@ class Database(object): def count(self, dt, filters=None, debug=False, cache=False): """Returns `COUNT(*)` for given DocType and filters.""" if cache and not filters: - cache_count = frappe.cache().get_value('doctype:count:{}'.format(dt)) + cache_count = frappe.cache().get_value("doctype:count:{}".format(dt)) if cache_count is not None: return cache_count query = self.query.get_sql(table=dt, filters=filters, fields=Count("*")) @@ -968,7 +1032,7 @@ class Database(object): else: count = self.sql(query, debug=debug)[0][0] if cache: - frappe.cache().set_value('doctype:count:{}'.format(dt), count, expires_in_sec = 86400) + frappe.cache().set_value("doctype:count:{}".format(dt), count, expires_in_sec=86400) return count @staticmethod @@ -978,11 +1042,11 @@ class Database(object): @staticmethod def format_datetime(datetime): if not datetime: - return '0001-01-01 00:00:00.000000' + return "0001-01-01 00:00:00.000000" if isinstance(datetime, str): - if ':' not in datetime: - datetime = datetime + ' 00:00:00.000000' + if ":" not in datetime: + datetime = datetime + " 00:00:00.000000" else: datetime = datetime.strftime("%Y-%m-%d %H:%M:%S.%f") @@ -990,32 +1054,43 @@ class Database(object): def get_creation_count(self, doctype, minutes): """Get count of records created in the last x minutes""" - from frappe.utils import now_datetime from dateutil.relativedelta import relativedelta - return self.sql("""select count(name) from `tab{doctype}` - where creation >= %s""".format(doctype=doctype), - now_datetime() - relativedelta(minutes=minutes))[0][0] + from frappe.utils import now_datetime + + return self.sql( + """select count(name) from `tab{doctype}` + where creation >= %s""".format( + doctype=doctype + ), + now_datetime() - relativedelta(minutes=minutes), + )[0][0] def get_db_table_columns(self, table): """Returns list of column names from given table.""" - columns = frappe.cache().hget('table_columns', table) + columns = frappe.cache().hget("table_columns", table) if columns is None: - columns = [r[0] for r in self.sql(''' + columns = [ + r[0] + for r in self.sql( + """ select column_name from information_schema.columns - where table_name = %s ''', table)] + where table_name = %s """, + table, + ) + ] if columns: - frappe.cache().hset('table_columns', table, columns) + frappe.cache().hset("table_columns", table, columns) return columns def get_table_columns(self, doctype): """Returns list of column names from given doctype.""" - columns = self.get_db_table_columns('tab' + doctype) + columns = self.get_db_table_columns("tab" + doctype) if not columns: - raise self.TableMissingError('DocType', doctype) + raise self.TableMissingError("DocType", doctype) return columns def has_column(self, doctype, column): @@ -1023,8 +1098,12 @@ class Database(object): return column in self.get_table_columns(doctype) def get_column_type(self, doctype, column): - return self.sql('''SELECT column_type FROM INFORMATION_SCHEMA.COLUMNS - WHERE table_name = 'tab{0}' AND column_name = '{1}' '''.format(doctype, column))[0][0] + return self.sql( + """SELECT column_type FROM INFORMATION_SCHEMA.COLUMNS + WHERE table_name = 'tab{0}' AND column_name = '{1}' """.format( + doctype, column + ) + )[0][0] def has_index(self, table_name, index_name): raise NotImplementedError @@ -1045,6 +1124,7 @@ class Database(object): def get_system_setting(self, key): def _load_system_settings(): return self.get_singles_dict("System Settings") + return frappe.cache().get_value("system_settings", _load_system_settings).get(key) def close(self): @@ -1066,12 +1146,16 @@ class Database(object): return frappe.db.is_missing_column(e) def get_descendants(self, doctype, name): - '''Return descendants of the current record''' - node_location_indexes = self.get_value(doctype, name, ('lft', 'rgt')) + """Return descendants of the current record""" + node_location_indexes = self.get_value(doctype, name, ("lft", "rgt")) if node_location_indexes: lft, rgt = node_location_indexes - return self.sql_list('''select name from `tab{doctype}` - where lft > {lft} and rgt < {rgt}'''.format(doctype=doctype, lft=lft, rgt=rgt)) + return self.sql_list( + """select name from `tab{doctype}` + where lft > {lft} and rgt < {rgt}""".format( + doctype=doctype, lft=lft, rgt=rgt + ) + ) else: # when document does not exist return [] @@ -1080,7 +1164,7 @@ class Database(object): return self.is_missing_column(e) or self.is_table_missing(e) def multisql(self, sql_dict, values=(), **kwargs): - current_dialect = frappe.db.db_type or 'mariadb' + current_dialect = frappe.db.db_type or "mariadb" query = sql_dict.get(current_dialect) return self.sql(query, values, **kwargs) @@ -1110,7 +1194,7 @@ class Database(object): return self.truncate(doctype) def get_last_created(self, doctype): - last_record = self.get_all(doctype, ('creation'), limit=1, order_by='creation desc') + last_record = self.get_all(doctype, ("creation"), limit=1, order_by="creation desc") if last_record: return get_datetime(last_record[0].creation) else: @@ -1119,7 +1203,7 @@ class Database(object): def log_touched_tables(self, query, values=None): if values: query = frappe.safe_decode(self._cursor.mogrify(query, values)) - if query.strip().lower().split()[0] in ('insert', 'delete', 'update', 'alter', 'drop', 'rename'): + if query.strip().lower().split()[0] in ("insert", "delete", "update", "alter", "drop", "rename"): # single_word_regex is designed to match following patterns # `tabXxx`, tabXxx and "tabXxx" @@ -1146,24 +1230,27 @@ class Database(object): def bulk_insert(self, doctype, fields, values, ignore_duplicates=False): """ - Insert multiple records at a time + Insert multiple records at a time - :param doctype: Doctype name - :param fields: list of fields - :params values: list of list of values + :param doctype: Doctype name + :param fields: list of fields + :params values: list of list of values """ insert_list = [] - fields = ", ".join("`"+field+"`" for field in fields) + fields = ", ".join("`" + field + "`" for field in fields) for idx, value in enumerate(values): insert_list.append(tuple(value)) - if idx and (idx%10000 == 0 or idx < len(values)-1): - self.sql("""INSERT {ignore_duplicates} INTO `tab{doctype}` ({fields}) VALUES {values}""".format( + if idx and (idx % 10000 == 0 or idx < len(values) - 1): + self.sql( + """INSERT {ignore_duplicates} INTO `tab{doctype}` ({fields}) VALUES {values}""".format( ignore_duplicates="IGNORE" if ignore_duplicates else "", doctype=doctype, fields=fields, - values=", ".join(['%s'] * len(insert_list)) - ), tuple(insert_list)) + values=", ".join(["%s"] * len(insert_list)), + ), + tuple(insert_list), + ) insert_list = [] @@ -1173,30 +1260,30 @@ def enqueue_jobs_after_commit(): if frappe.flags.enqueue_after_commit and len(frappe.flags.enqueue_after_commit) > 0: for job in frappe.flags.enqueue_after_commit: q = get_queue(job.get("queue"), is_async=job.get("is_async")) - q.enqueue_call(execute_job, timeout=job.get("timeout"), - kwargs=job.get("queue_args")) + q.enqueue_call(execute_job, timeout=job.get("timeout"), kwargs=job.get("queue_args")) frappe.flags.enqueue_after_commit = [] + @contextmanager def savepoint(catch: Union[type, Tuple[type, ...]] = Exception): - """ Wrapper for wrapping blocks of DB operations in a savepoint. + """Wrapper for wrapping blocks of DB operations in a savepoint. - as contextmanager: + as contextmanager: - for doc in docs: - with savepoint(catch=DuplicateError): - doc.insert() + for doc in docs: + with savepoint(catch=DuplicateError): + doc.insert() - as decorator (wraps FULL function call): + as decorator (wraps FULL function call): - @savepoint(catch=DuplicateError) - def process_doc(doc): - doc.insert() + @savepoint(catch=DuplicateError) + def process_doc(doc): + doc.insert() """ try: - savepoint = ''.join(random.sample(string.ascii_lowercase, 10)) + savepoint = "".join(random.sample(string.ascii_lowercase, 10)) frappe.db.savepoint(savepoint) - yield # control back to calling function + yield # control back to calling function except catch: frappe.db.rollback(save_point=savepoint) else: diff --git a/frappe/database/db_manager.py b/frappe/database/db_manager.py index b8ffae519b..8f810fe54b 100644 --- a/frappe/database/db_manager.py +++ b/frappe/database/db_manager.py @@ -1,4 +1,5 @@ import os + import frappe @@ -11,7 +12,7 @@ class DbManager: self.db = db def get_current_host(self): - return self.db.sql("select user()")[0][0].split('@')[1] + return self.db.sql("select user()")[0][0].split("@")[1] def create_user(self, user, password, host=None): # Create user if it doesn't exist. @@ -47,8 +48,11 @@ class DbManager: if not host: host = self.get_current_host() - if frappe.conf.get('rds_db', 0) == 1: - self.db.sql("GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, CREATE VIEW, EVENT, TRIGGER, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EXECUTE, LOCK TABLES ON `%s`.* TO '%s'@'%s';" % (target, user, host)) + if frappe.conf.get("rds_db", 0) == 1: + self.db.sql( + "GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, CREATE VIEW, EVENT, TRIGGER, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EXECUTE, LOCK TABLES ON `%s`.* TO '%s'@'%s';" + % (target, user, host) + ) else: self.db.sql("GRANT ALL PRIVILEGES ON `%s`.* TO '%s'@'%s';" % (target, user, host)) @@ -62,24 +66,27 @@ class DbManager: @staticmethod def restore_database(target, source, user, password): from frappe.utils import make_esc - esc = make_esc('$ ') + + esc = make_esc("$ ") from distutils.spawn import find_executable - pv = find_executable('pv') + + pv = find_executable("pv") if pv: - pipe = '{pv} {source} |'.format( - pv=pv, - source=source - ) - source = '' + pipe = "{pv} {source} |".format(pv=pv, source=source) + source = "" else: - pipe = '' - source = '< {source}'.format(source=source) + pipe = "" + source = "< {source}".format(source=source) if pipe: - print('Restoring Database file...') + print("Restoring Database file...") - command = '{pipe} mysql -u {user} -p{password} -h{host} ' + ('-P{port}' if frappe.db.port else '') + ' {target} {source}' + command = ( + "{pipe} mysql -u {user} -p{password} -h{host} " + + ("-P{port}" if frappe.db.port else "") + + " {target} {source}" + ) command = command.format( pipe=pipe, user=esc(user), @@ -87,6 +94,6 @@ class DbManager: host=esc(frappe.db.host), target=esc(target), source=source, - port=frappe.db.port + port=frappe.db.port, ) os.system(command) diff --git a/frappe/database/mariadb/database.py b/frappe/database/mariadb/database.py index a6d5e7b3f2..dcb88d648b 100644 --- a/frappe/database/mariadb/database.py +++ b/frappe/database/mariadb/database.py @@ -17,43 +17,43 @@ class MariaDBDatabase(Database): InternalError = pymysql.err.InternalError SQLError = pymysql.err.ProgrammingError DataError = pymysql.err.DataError - REGEX_CHARACTER = 'regexp' + REGEX_CHARACTER = "regexp" def setup_type_map(self): - self.db_type = 'mariadb' + self.db_type = "mariadb" self.type_map = { - 'Currency': ('decimal', '21,9'), - 'Int': ('int', '11'), - 'Long Int': ('bigint', '20'), - 'Float': ('decimal', '21,9'), - 'Percent': ('decimal', '21,9'), - 'Check': ('int', '1'), - 'Small Text': ('text', ''), - 'Long Text': ('longtext', ''), - 'Code': ('longtext', ''), - 'Text Editor': ('longtext', ''), - 'Markdown Editor': ('longtext', ''), - 'HTML Editor': ('longtext', ''), - 'Date': ('date', ''), - 'Datetime': ('datetime', '6'), - 'Time': ('time', '6'), - 'Text': ('text', ''), - 'Data': ('varchar', self.VARCHAR_LEN), - 'Link': ('varchar', self.VARCHAR_LEN), - 'Dynamic Link': ('varchar', self.VARCHAR_LEN), - 'Password': ('text', ''), - 'Select': ('varchar', self.VARCHAR_LEN), - 'Rating': ('decimal', '3,2'), - 'Read Only': ('varchar', self.VARCHAR_LEN), - 'Attach': ('text', ''), - 'Attach Image': ('text', ''), - 'Signature': ('longtext', ''), - 'Color': ('varchar', self.VARCHAR_LEN), - 'Barcode': ('longtext', ''), - 'Geolocation': ('longtext', ''), - 'Duration': ('decimal', '21,9'), - 'Icon': ('varchar', self.VARCHAR_LEN), - 'Autocomplete': ('varchar', self.VARCHAR_LEN), + "Currency": ("decimal", "21,9"), + "Int": ("int", "11"), + "Long Int": ("bigint", "20"), + "Float": ("decimal", "21,9"), + "Percent": ("decimal", "21,9"), + "Check": ("int", "1"), + "Small Text": ("text", ""), + "Long Text": ("longtext", ""), + "Code": ("longtext", ""), + "Text Editor": ("longtext", ""), + "Markdown Editor": ("longtext", ""), + "HTML Editor": ("longtext", ""), + "Date": ("date", ""), + "Datetime": ("datetime", "6"), + "Time": ("time", "6"), + "Text": ("text", ""), + "Data": ("varchar", self.VARCHAR_LEN), + "Link": ("varchar", self.VARCHAR_LEN), + "Dynamic Link": ("varchar", self.VARCHAR_LEN), + "Password": ("text", ""), + "Select": ("varchar", self.VARCHAR_LEN), + "Rating": ("decimal", "3,2"), + "Read Only": ("varchar", self.VARCHAR_LEN), + "Attach": ("text", ""), + "Attach Image": ("text", ""), + "Signature": ("longtext", ""), + "Color": ("varchar", self.VARCHAR_LEN), + "Barcode": ("longtext", ""), + "Geolocation": ("longtext", ""), + "Duration": ("decimal", "21,9"), + "Icon": ("varchar", self.VARCHAR_LEN), + "Autocomplete": ("varchar", self.VARCHAR_LEN), } def get_connection(self): @@ -61,46 +61,52 @@ class MariaDBDatabase(Database): if frappe.conf.db_ssl_ca and frappe.conf.db_ssl_cert and frappe.conf.db_ssl_key: usessl = 1 ssl_params = { - 'ca':frappe.conf.db_ssl_ca, - 'cert':frappe.conf.db_ssl_cert, - 'key':frappe.conf.db_ssl_key + "ca": frappe.conf.db_ssl_ca, + "cert": frappe.conf.db_ssl_cert, + "key": frappe.conf.db_ssl_key, } - conversions.update({ - FIELD_TYPE.NEWDECIMAL: float, - FIELD_TYPE.DATETIME: get_datetime, - UnicodeWithAttrs: conversions[str] - }) + conversions.update( + { + FIELD_TYPE.NEWDECIMAL: float, + FIELD_TYPE.DATETIME: get_datetime, + UnicodeWithAttrs: conversions[str], + } + ) conn = pymysql.connect( - user=self.user or '', - password=self.password or '', + user=self.user or "", + password=self.password or "", host=self.host, port=self.port, - charset='utf8mb4', + charset="utf8mb4", use_unicode=True, ssl=ssl_params if usessl else None, conv=conversions, - local_infile=frappe.conf.local_infile + local_infile=frappe.conf.local_infile, ) # MYSQL_OPTION_MULTI_STATEMENTS_OFF = 1 # # self._conn.set_server_option(MYSQL_OPTION_MULTI_STATEMENTS_OFF) - if self.user != 'root': + if self.user != "root": conn.select_db(self.user) return conn def get_database_size(self): - ''''Returns database size in MB''' - db_size = self.sql(''' + """'Returns database size in MB""" + db_size = self.sql( + """ SELECT `table_schema` as `database_name`, SUM(`data_length` + `index_length`) / 1024 / 1024 AS `database_size` FROM information_schema.tables WHERE `table_schema` = %s GROUP BY `table_schema` - ''', self.db_name, as_dict=True) + """, + self.db_name, + as_dict=True, + ) - return db_size[0].get('database_size') + return db_size[0].get("database_size") @staticmethod def escape(s, percent=True): @@ -136,7 +142,9 @@ class MariaDBDatabase(Database): table_name = get_table_name(doctype) return self.sql(f"DESC `{table_name}`") - def change_column_type(self, doctype: str, column: str, type: str, nullable: bool = False) -> Union[List, Tuple]: + def change_column_type( + self, doctype: str, column: str, type: str, nullable: bool = False + ) -> Union[List, Tuple]: table_name = get_table_name(doctype) null_constraint = "NOT NULL" if not nullable else "" return self.sql(f"ALTER TABLE `{table_name}` MODIFY `{column}` {type} {null_constraint}") @@ -171,7 +179,7 @@ class MariaDBDatabase(Database): return e.args[0] == ER.DUP_ENTRY @staticmethod - def is_access_denied( e): + def is_access_denied(e): return e.args[0] == ER.ACCESS_DENIED_ERROR @staticmethod @@ -187,25 +195,27 @@ class MariaDBDatabase(Database): return e.args[0] == ER.DATA_TOO_LONG def is_primary_key_violation(self, e): - return self.is_duplicate_entry(e) and 'PRIMARY' in cstr(e.args[1]) + return self.is_duplicate_entry(e) and "PRIMARY" in cstr(e.args[1]) def is_unique_key_violation(self, e): - return self.is_duplicate_entry(e) and 'Duplicate' in cstr(e.args[1]) - + return self.is_duplicate_entry(e) and "Duplicate" in cstr(e.args[1]) def create_auth_table(self): - self.sql_ddl("""create table if not exists `__Auth` ( + self.sql_ddl( + """create table if not exists `__Auth` ( `doctype` VARCHAR(140) NOT NULL, `name` VARCHAR(255) NOT NULL, `fieldname` VARCHAR(140) NOT NULL, `password` TEXT NOT NULL, `encrypted` INT(1) NOT NULL DEFAULT 0, PRIMARY KEY (`doctype`, `name`, `fieldname`) - ) ENGINE=InnoDB ROW_FORMAT=DYNAMIC CHARACTER SET=utf8mb4 COLLATE=utf8mb4_unicode_ci""") + ) ENGINE=InnoDB ROW_FORMAT=DYNAMIC CHARACTER SET=utf8mb4 COLLATE=utf8mb4_unicode_ci""" + ) def create_global_search_table(self): - if not '__global_search' in self.get_tables(): - self.sql('''create table __global_search( + if not "__global_search" in self.get_tables(): + self.sql( + """create table __global_search( doctype varchar(100), name varchar({0}), title varchar({0}), @@ -216,18 +226,24 @@ class MariaDBDatabase(Database): unique `doctype_name` (doctype, name)) COLLATE=utf8mb4_unicode_ci ENGINE=MyISAM - CHARACTER SET=utf8mb4'''.format(self.VARCHAR_LEN)) + CHARACTER SET=utf8mb4""".format( + self.VARCHAR_LEN + ) + ) def create_user_settings_table(self): - self.sql_ddl("""create table if not exists __UserSettings ( + self.sql_ddl( + """create table if not exists __UserSettings ( `user` VARCHAR(180) NOT NULL, `doctype` VARCHAR(180) NOT NULL, `data` TEXT, UNIQUE(user, doctype) - ) ENGINE=InnoDB DEFAULT CHARSET=utf8""") + ) ENGINE=InnoDB DEFAULT CHARSET=utf8""" + ) def create_help_table(self): - self.sql('''create table help( + self.sql( + """create table help( path varchar(255), content text, title text, @@ -238,15 +254,17 @@ class MariaDBDatabase(Database): index (path)) COLLATE=utf8mb4_unicode_ci ENGINE=MyISAM - CHARACTER SET=utf8mb4''') + CHARACTER SET=utf8mb4""" + ) @staticmethod def get_on_duplicate_update(key=None): - return 'ON DUPLICATE key UPDATE ' + return "ON DUPLICATE key UPDATE " def get_table_columns_description(self, table_name): """Returns list of column and its description""" - return self.sql('''select + return self.sql( + """select column_name as 'name', column_type as 'type', column_default as 'default', @@ -260,14 +278,19 @@ class MariaDBDatabase(Database): ), 0) as 'index', column_key = 'UNI' as 'unique' from information_schema.columns as columns - where table_name = '{table_name}' '''.format(table_name=table_name), as_dict=1) + where table_name = '{table_name}' """.format( + table_name=table_name + ), + as_dict=1, + ) def has_index(self, table_name, index_name): - return self.sql("""SHOW INDEX FROM `{table_name}` + return self.sql( + """SHOW INDEX FROM `{table_name}` WHERE Key_name='{index_name}'""".format( - table_name=table_name, - index_name=index_name - )) + table_name=table_name, index_name=index_name + ) + ) def add_index(self, doctype: str, fields: List, index_name: str = None): """Creates an index with given fields if not already created. @@ -276,8 +299,11 @@ class MariaDBDatabase(Database): table_name = get_table_name(doctype) if not self.has_index(table_name, index_name): self.commit() - self.sql("""ALTER TABLE `%s` - ADD INDEX `%s`(%s)""" % (table_name, index_name, ", ".join(fields))) + self.sql( + """ALTER TABLE `%s` + ADD INDEX `%s`(%s)""" + % (table_name, index_name, ", ".join(fields)) + ) def add_unique(self, doctype, fields, constraint_name=None): if isinstance(fields, str): @@ -285,12 +311,17 @@ class MariaDBDatabase(Database): if not constraint_name: constraint_name = "unique_" + "_".join(fields) - if not self.sql("""select CONSTRAINT_NAME from information_schema.TABLE_CONSTRAINTS + if not self.sql( + """select CONSTRAINT_NAME from information_schema.TABLE_CONSTRAINTS where table_name=%s and constraint_type='UNIQUE' and CONSTRAINT_NAME=%s""", - ('tab' + doctype, constraint_name)): - self.commit() - self.sql("""alter table `tab%s` - add unique `%s`(%s)""" % (doctype, constraint_name, ", ".join(fields))) + ("tab" + doctype, constraint_name), + ): + self.commit() + self.sql( + """alter table `tab%s` + add unique `%s`(%s)""" + % (doctype, constraint_name, ", ".join(fields)) + ) def updatedb(self, doctype, meta=None): """ @@ -301,7 +332,7 @@ class MariaDBDatabase(Database): """ res = self.sql("select issingle from `tabDocType` where name=%s", (doctype,)) if not res: - raise Exception('Wrong doctype {0} in updatedb'.format(doctype)) + raise Exception("Wrong doctype {0} in updatedb".format(doctype)) if not res[0][0]: db_table = MariaDBTable(doctype, meta) diff --git a/frappe/database/mariadb/schema.py b/frappe/database/mariadb/schema.py index 3b7aa443f2..7c95e9ffcb 100644 --- a/frappe/database/mariadb/schema.py +++ b/frappe/database/mariadb/schema.py @@ -15,27 +15,31 @@ class MariaDBTable(DBTable): # columns column_defs = self.get_column_definitions() if column_defs: - additional_definitions += ',\n'.join(column_defs) + ',\n' + additional_definitions += ",\n".join(column_defs) + ",\n" # index index_defs = self.get_index_definitions() if index_defs: - additional_definitions += ',\n'.join(index_defs) + ',\n' + additional_definitions += ",\n".join(index_defs) + ",\n" # child table columns if self.meta.get("istable") or 0: - additional_definitions += ',\n'.join( - ( - f"parent varchar({varchar_len})", - f"parentfield varchar({varchar_len})", - f"parenttype varchar({varchar_len})", - "index parent(parent)" + additional_definitions += ( + ",\n".join( + ( + f"parent varchar({varchar_len})", + f"parentfield varchar({varchar_len})", + f"parenttype varchar({varchar_len})", + "index parent(parent)", + ) ) - ) + ',\n' + + ",\n" + ) # creating sequence(s) - if (not self.meta.issingle and self.meta.autoname == "autoincrement")\ - or self.doctype in log_types: + if ( + not self.meta.issingle and self.meta.autoname == "autoincrement" + ) or self.doctype in log_types: # NOTE: using a very small cache - as during backup, if the sequence was used in anyform, # it drops the cache and uses the next non cached value in setval func and @@ -78,7 +82,7 @@ class MariaDBTable(DBTable): add_index_query = [] drop_index_query = [] - columns_to_modify = set(self.change_type + self.add_unique + self.set_default) + columns_to_modify = set(self.change_type + self.add_unique + self.set_default) for col in self.add_column: add_column_query.append("ADD COLUMN `{}` {}".format(col.fieldname, col.get_definition())) @@ -88,31 +92,43 @@ class MariaDBTable(DBTable): for col in self.add_index: # if index key does not exists - if not frappe.db.has_index(self.table_name, col.fieldname + '_index'): + if not frappe.db.has_index(self.table_name, col.fieldname + "_index"): add_index_query.append("ADD INDEX `{}_index`(`{}`)".format(col.fieldname, col.fieldname)) for col in self.drop_index + self.drop_unique: - if col.fieldname != 'name': # primary key + if col.fieldname != "name": # primary key current_column = self.current_columns.get(col.fieldname.lower()) unique_constraint_changed = current_column.unique != col.unique if unique_constraint_changed and not col.unique: # nosemgrep - unique_index_record = frappe.db.sql(""" + unique_index_record = frappe.db.sql( + """ SHOW INDEX FROM `{0}` WHERE Key_name=%s AND Non_unique=0 - """.format(self.table_name), (col.fieldname), as_dict=1) + """.format( + self.table_name + ), + (col.fieldname), + as_dict=1, + ) if unique_index_record: drop_index_query.append("DROP INDEX `{}`".format(unique_index_record[0].Key_name)) index_constraint_changed = current_column.index != col.set_index # if index key exists if index_constraint_changed and not col.set_index: # nosemgrep - index_record = frappe.db.sql(""" + index_record = frappe.db.sql( + """ SHOW INDEX FROM `{0}` WHERE Key_name=%s AND Non_unique=1 - """.format(self.table_name), (col.fieldname + '_index'), as_dict=1) + """.format( + self.table_name + ), + (col.fieldname + "_index"), + as_dict=1, + ) if index_record: drop_index_query.append("DROP INDEX `{}`".format(index_record[0].Key_name)) @@ -125,13 +141,16 @@ class MariaDBTable(DBTable): except Exception as e: # sanitize - if e.args[0]==1060: + if e.args[0] == 1060: frappe.throw(str(e)) - elif e.args[0]==1062: + elif e.args[0] == 1062: fieldname = str(e).split("'")[-2] - frappe.throw(_("{0} field cannot be set as unique in {1}, as there are non-unique existing values").format( - fieldname, self.table_name)) - elif e.args[0]==1067: + frappe.throw( + _("{0} field cannot be set as unique in {1}, as there are non-unique existing values").format( + fieldname, self.table_name + ) + ) + elif e.args[0] == 1067: frappe.throw(str(e.args[1])) else: raise e diff --git a/frappe/database/mariadb/setup_db.py b/frappe/database/mariadb/setup_db.py index 1585e4537b..4399ccfa6a 100644 --- a/frappe/database/mariadb/setup_db.py +++ b/frappe/database/mariadb/setup_db.py @@ -1,5 +1,6 @@ -import frappe import os + +import frappe from frappe.database.db_manager import DbManager expected_settings_10_2_earlier = { @@ -7,12 +8,12 @@ expected_settings_10_2_earlier = { "innodb_file_per_table": "ON", "innodb_large_prefix": "ON", "character_set_server": "utf8mb4", - "collation_server": "utf8mb4_unicode_ci" + "collation_server": "utf8mb4_unicode_ci", } expected_settings_10_3_later = { "character_set_server": "utf8mb4", - "collation_server": "utf8mb4_unicode_ci" + "collation_server": "utf8mb4_unicode_ci", } @@ -20,16 +21,15 @@ def get_mariadb_versions(): # MariaDB classifies their versions as Major (1st and 2nd number), and Minor (3rd number) # Example: Version 10.3.13 is Major Version = 10.3, Minor Version = 13 mariadb_variables = frappe._dict(frappe.db.sql("""show variables""")) - version_string = mariadb_variables.get('version').split('-')[0] + version_string = mariadb_variables.get("version").split("-")[0] versions = {} - versions['major'] = version_string.split( - '.')[0] + '.' + version_string.split('.')[1] - versions['minor'] = version_string.split('.')[2] + versions["major"] = version_string.split(".")[0] + "." + version_string.split(".")[1] + versions["minor"] = version_string.split(".")[2] return versions def setup_database(force, source_sql, verbose, no_mariadb_socket=False): - frappe.local.session = frappe._dict({'user':'Administrator'}) + frappe.local.session = frappe._dict({"user": "Administrator"}) db_name = frappe.local.conf.db_name root_conn = get_root_connection(frappe.flags.root_login, frappe.flags.root_password) @@ -45,20 +45,24 @@ def setup_database(force, source_sql, verbose, no_mariadb_socket=False): raise Exception("Database %s already exists" % (db_name,)) dbman.create_user(db_name, frappe.conf.db_password, **dbman_kwargs) - if verbose: print("Created user %s" % db_name) + if verbose: + print("Created user %s" % db_name) dbman.create_database(db_name) - if verbose: print("Created database %s" % db_name) + if verbose: + print("Created database %s" % db_name) dbman.grant_all_privileges(db_name, db_name, **dbman_kwargs) dbman.flush_privileges() - if verbose: print("Granted privileges to user %s and database %s" % (db_name, db_name)) + if verbose: + print("Granted privileges to user %s and database %s" % (db_name, db_name)) # close root connection root_conn.close() bootstrap_database(db_name, verbose, source_sql) + def setup_help_database(help_db_name): dbman = DbManager(get_root_connection(frappe.flags.root_login, frappe.flags.root_password)) dbman.drop_database(help_db_name) @@ -69,11 +73,13 @@ def setup_help_database(help_db_name): dbman.create_user(help_db_name, help_db_name) except Exception as e: # user already exists - if e.args[0] != 1396: raise + if e.args[0] != 1396: + raise dbman.create_database(help_db_name) dbman.grant_all_privileges(help_db_name, help_db_name) dbman.flush_privileges() + def drop_user_and_database(db_name, root_login, root_password): frappe.local.db = get_root_connection(root_login, root_password) dbman = DbManager(frappe.local.db) @@ -81,18 +87,19 @@ def drop_user_and_database(db_name, root_login, root_password): dbman.delete_user(db_name) dbman.drop_database(db_name) + def bootstrap_database(db_name, verbose, source_sql=None): import sys frappe.connect(db_name=db_name) if not check_database_settings(): - print('Database settings do not match expected values; stopping database setup.') + print("Database settings do not match expected values; stopping database setup.") sys.exit(1) import_db_from_sql(source_sql, verbose) frappe.connect(db_name=db_name) - if 'tabDefaultValue' not in frappe.db.get_tables(cached=False): + if "tabDefaultValue" not in frappe.db.get_tables(cached=False): from click import secho secho( @@ -101,22 +108,25 @@ def bootstrap_database(db_name, verbose, source_sql=None): "permission, or that the database name exists. Check your mysql" " root password, validity of the backup file or use --force to" " reinstall", - fg="red" + fg="red", ) sys.exit(1) + def import_db_from_sql(source_sql=None, verbose=False): - if verbose: print("Starting database import...") + if verbose: + print("Starting database import...") db_name = frappe.conf.db_name if not source_sql: - source_sql = os.path.join(os.path.dirname(__file__), 'framework_mariadb.sql') + source_sql = os.path.join(os.path.dirname(__file__), "framework_mariadb.sql") DbManager(frappe.local.db).restore_database(db_name, source_sql, db_name, frappe.conf.db_password) - if verbose: print("Imported from database %s" % source_sql) + if verbose: + print("Imported from database %s" % source_sql) def check_database_settings(): versions = get_mariadb_versions() - if versions['major'] <= '10.2': + if versions["major"] <= "10.2": expected_variables = expected_settings_10_2_earlier else: expected_variables = expected_settings_10_3_later @@ -126,26 +136,31 @@ def check_database_settings(): result = True for key, expected_value in expected_variables.items(): if mariadb_variables.get(key) != expected_value: - print("For key %s. Expected value %s, found value %s" % - (key, expected_value, mariadb_variables.get(key))) + print( + "For key %s. Expected value %s, found value %s" + % (key, expected_value, mariadb_variables.get(key)) + ) result = False if not result: site = frappe.local.site - msg = ("Creation of your site - {x} failed because MariaDB is not properly {sep}" - "configured. If using version 10.2.x or earlier, make sure you use the {sep}" - "the Barracuda storage engine. {sep}{sep}" - "Please verify the settings above in MariaDB's my.cnf. Restart MariaDB. And {sep}" - "then run `bench new-site {x}` again.{sep2}" - "").format(x=site, sep2="\n"*2, sep="\n") + msg = ( + "Creation of your site - {x} failed because MariaDB is not properly {sep}" + "configured. If using version 10.2.x or earlier, make sure you use the {sep}" + "the Barracuda storage engine. {sep}{sep}" + "Please verify the settings above in MariaDB's my.cnf. Restart MariaDB. And {sep}" + "then run `bench new-site {x}` again.{sep2}" + "" + ).format(x=site, sep2="\n" * 2, sep="\n") print_db_config(msg) return result def get_root_connection(root_login, root_password): import getpass + if not frappe.local.flags.root_connection: if not root_login: - root_login = 'root' + root_login = "root" if not root_password: root_password = frappe.conf.get("root_password") or None @@ -153,12 +168,14 @@ def get_root_connection(root_login, root_password): if not root_password: root_password = getpass.getpass("MySQL root password: ") - frappe.local.flags.root_connection = frappe.database.get_db(user=root_login, password=root_password) + frappe.local.flags.root_connection = frappe.database.get_db( + user=root_login, password=root_password + ) return frappe.local.flags.root_connection def print_db_config(explanation): - print("="*80) + print("=" * 80) print(explanation) - print("="*80) + print("=" * 80) diff --git a/frappe/database/postgres/database.py b/frappe/database/postgres/database.py index eb3e33d39c..c34c20ee7b 100644 --- a/frappe/database/postgres/database.py +++ b/frappe/database/postgres/database.py @@ -3,8 +3,8 @@ from typing import List, Tuple, Union import psycopg2 import psycopg2.extensions -from psycopg2.extensions import ISOLATION_LEVEL_REPEATABLE_READ from psycopg2.errorcodes import STRING_DATA_RIGHT_TRUNCATION +from psycopg2.extensions import ISOLATION_LEVEL_REPEATABLE_READ import frappe from frappe.database.database import Database @@ -14,11 +14,13 @@ from frappe.utils import cstr, get_table_name # cast decimals as floats DEC2FLOAT = psycopg2.extensions.new_type( psycopg2.extensions.DECIMAL.values, - 'DEC2FLOAT', - lambda value, curs: float(value) if value is not None else None) + "DEC2FLOAT", + lambda value, curs: float(value) if value is not None else None, +) psycopg2.extensions.register_type(DEC2FLOAT) + class PostgresDatabase(Database): ProgrammingError = psycopg2.ProgrammingError TableMissingError = psycopg2.ProgrammingError @@ -27,49 +29,51 @@ class PostgresDatabase(Database): SQLError = psycopg2.ProgrammingError DataError = psycopg2.DataError InterfaceError = psycopg2.InterfaceError - REGEX_CHARACTER = '~' + REGEX_CHARACTER = "~" def setup_type_map(self): - self.db_type = 'postgres' + self.db_type = "postgres" self.type_map = { - 'Currency': ('decimal', '21,9'), - 'Int': ('bigint', None), - 'Long Int': ('bigint', None), - 'Float': ('decimal', '21,9'), - 'Percent': ('decimal', '21,9'), - 'Check': ('smallint', None), - 'Small Text': ('text', ''), - 'Long Text': ('text', ''), - 'Code': ('text', ''), - 'Text Editor': ('text', ''), - 'Markdown Editor': ('text', ''), - 'HTML Editor': ('text', ''), - 'Date': ('date', ''), - 'Datetime': ('timestamp', None), - 'Time': ('time', '6'), - 'Text': ('text', ''), - 'Data': ('varchar', self.VARCHAR_LEN), - 'Link': ('varchar', self.VARCHAR_LEN), - 'Dynamic Link': ('varchar', self.VARCHAR_LEN), - 'Password': ('text', ''), - 'Select': ('varchar', self.VARCHAR_LEN), - 'Rating': ('decimal', '3,2'), - 'Read Only': ('varchar', self.VARCHAR_LEN), - 'Attach': ('text', ''), - 'Attach Image': ('text', ''), - 'Signature': ('text', ''), - 'Color': ('varchar', self.VARCHAR_LEN), - 'Barcode': ('text', ''), - 'Geolocation': ('text', ''), - 'Duration': ('decimal', '21,9'), - 'Icon': ('varchar', self.VARCHAR_LEN), - 'Autocomplete': ('varchar', self.VARCHAR_LEN), + "Currency": ("decimal", "21,9"), + "Int": ("bigint", None), + "Long Int": ("bigint", None), + "Float": ("decimal", "21,9"), + "Percent": ("decimal", "21,9"), + "Check": ("smallint", None), + "Small Text": ("text", ""), + "Long Text": ("text", ""), + "Code": ("text", ""), + "Text Editor": ("text", ""), + "Markdown Editor": ("text", ""), + "HTML Editor": ("text", ""), + "Date": ("date", ""), + "Datetime": ("timestamp", None), + "Time": ("time", "6"), + "Text": ("text", ""), + "Data": ("varchar", self.VARCHAR_LEN), + "Link": ("varchar", self.VARCHAR_LEN), + "Dynamic Link": ("varchar", self.VARCHAR_LEN), + "Password": ("text", ""), + "Select": ("varchar", self.VARCHAR_LEN), + "Rating": ("decimal", "3,2"), + "Read Only": ("varchar", self.VARCHAR_LEN), + "Attach": ("text", ""), + "Attach Image": ("text", ""), + "Signature": ("text", ""), + "Color": ("varchar", self.VARCHAR_LEN), + "Barcode": ("text", ""), + "Geolocation": ("text", ""), + "Duration": ("decimal", "21,9"), + "Icon": ("varchar", self.VARCHAR_LEN), + "Autocomplete": ("varchar", self.VARCHAR_LEN), } def get_connection(self): - conn = psycopg2.connect("host='{}' dbname='{}' user='{}' password='{}' port={}".format( - self.host, self.user, self.user, self.password, self.port - )) + conn = psycopg2.connect( + "host='{}' dbname='{}' user='{}' password='{}' port={}".format( + self.host, self.user, self.user, self.password, self.port + ) + ) conn.set_isolation_level(ISOLATION_LEVEL_REPEATABLE_READ) return conn @@ -77,49 +81,54 @@ class PostgresDatabase(Database): def escape(self, s, percent=True): """Escape quotes and percent in given string.""" if isinstance(s, bytes): - s = s.decode('utf-8') + s = s.decode("utf-8") # MariaDB's driver treats None as an empty string # So Postgres should do the same if s is None: - s = '' + s = "" if percent: s = s.replace("%", "%%") - s = s.encode('utf-8') + s = s.encode("utf-8") return str(psycopg2.extensions.QuotedString(s)) def get_database_size(self): - ''''Returns database size in MB''' - db_size = self.sql("SELECT (pg_database_size(%s) / 1024 / 1024) as database_size", - self.db_name, as_dict=True) - return db_size[0].get('database_size') + """'Returns database size in MB""" + db_size = self.sql( + "SELECT (pg_database_size(%s) / 1024 / 1024) as database_size", self.db_name, as_dict=True + ) + return db_size[0].get("database_size") # pylint: disable=W0221 def sql(self, query, values=(), *args, **kwargs): return super(PostgresDatabase, self).sql( - modify_query(query), - modify_values(values), - *args, - **kwargs + modify_query(query), modify_values(values), *args, **kwargs ) def get_tables(self, cached=True): - return [d[0] for d in self.sql("""select table_name + return [ + d[0] + for d in self.sql( + """select table_name from information_schema.tables where table_catalog='{0}' and table_type = 'BASE TABLE' - and table_schema='{1}'""".format(frappe.conf.db_name, frappe.conf.get("db_schema", "public")))] + and table_schema='{1}'""".format( + frappe.conf.db_name, frappe.conf.get("db_schema", "public") + ) + ) + ] def format_date(self, date): if not date: - return '0001-01-01' + return "0001-01-01" if not isinstance(date, str): - date = date.strftime('%Y-%m-%d') + date = date.strftime("%Y-%m-%d") return date @@ -135,7 +144,7 @@ class PostgresDatabase(Database): # exception type @staticmethod def is_deadlocked(e): - return e.pgcode == '40P01' + return e.pgcode == "40P01" @staticmethod def is_timedout(e): @@ -148,7 +157,7 @@ class PostgresDatabase(Database): @staticmethod def is_table_missing(e): - return getattr(e, 'pgcode', None) == '42P01' + return getattr(e, "pgcode", None) == "42P01" @staticmethod def is_missing_table(e): @@ -156,31 +165,31 @@ class PostgresDatabase(Database): @staticmethod def is_missing_column(e): - return getattr(e, 'pgcode', None) == '42703' + return getattr(e, "pgcode", None) == "42703" @staticmethod def is_access_denied(e): - return e.pgcode == '42501' + return e.pgcode == "42501" @staticmethod def cant_drop_field_or_key(e): - return e.pgcode.startswith('23') + return e.pgcode.startswith("23") @staticmethod def is_duplicate_entry(e): - return e.pgcode == '23505' + return e.pgcode == "23505" @staticmethod def is_primary_key_violation(e): - return getattr(e, "pgcode", None) == '23505' and '_pkey' in cstr(e.args[0]) + return getattr(e, "pgcode", None) == "23505" and "_pkey" in cstr(e.args[0]) @staticmethod def is_unique_key_violation(e): - return getattr(e, "pgcode", None) == '23505' and '_key' in cstr(e.args[0]) + return getattr(e, "pgcode", None) == "23505" and "_key" in cstr(e.args[0]) @staticmethod def is_duplicate_fieldname(e): - return e.pgcode == '42701' + return e.pgcode == "42701" @staticmethod def is_data_too_long(e): @@ -191,54 +200,70 @@ class PostgresDatabase(Database): new_name = get_table_name(new_name) return self.sql(f"ALTER TABLE `{old_name}` RENAME TO `{new_name}`") - def describe(self, doctype: str)-> Union[List, Tuple]: + def describe(self, doctype: str) -> Union[List, Tuple]: table_name = get_table_name(doctype) - return self.sql(f"SELECT COLUMN_NAME FROM information_schema.COLUMNS WHERE TABLE_NAME = '{table_name}'") + return self.sql( + f"SELECT COLUMN_NAME FROM information_schema.COLUMNS WHERE TABLE_NAME = '{table_name}'" + ) - def change_column_type(self, doctype: str, column: str, type: str, nullable: bool = False) -> Union[List, Tuple]: + def change_column_type( + self, doctype: str, column: str, type: str, nullable: bool = False + ) -> Union[List, Tuple]: table_name = get_table_name(doctype) null_constraint = "SET NOT NULL" if not nullable else "DROP NOT NULL" - return self.sql(f"""ALTER TABLE "{table_name}" + return self.sql( + f"""ALTER TABLE "{table_name}" ALTER COLUMN "{column}" TYPE {type}, - ALTER COLUMN "{column}" {null_constraint}""") + ALTER COLUMN "{column}" {null_constraint}""" + ) def create_auth_table(self): - self.sql_ddl("""create table if not exists "__Auth" ( + self.sql_ddl( + """create table if not exists "__Auth" ( "doctype" VARCHAR(140) NOT NULL, "name" VARCHAR(255) NOT NULL, "fieldname" VARCHAR(140) NOT NULL, "password" TEXT NOT NULL, "encrypted" INT NOT NULL DEFAULT 0, PRIMARY KEY ("doctype", "name", "fieldname") - )""") + )""" + ) def create_global_search_table(self): - if not '__global_search' in self.get_tables(): - self.sql('''create table "__global_search"( + if not "__global_search" in self.get_tables(): + self.sql( + """create table "__global_search"( doctype varchar(100), name varchar({0}), title varchar({0}), content text, route varchar({0}), published int not null default 0, - unique (doctype, name))'''.format(self.VARCHAR_LEN)) + unique (doctype, name))""".format( + self.VARCHAR_LEN + ) + ) def create_user_settings_table(self): - self.sql_ddl("""create table if not exists "__UserSettings" ( + self.sql_ddl( + """create table if not exists "__UserSettings" ( "user" VARCHAR(180) NOT NULL, "doctype" VARCHAR(180) NOT NULL, "data" TEXT, UNIQUE ("user", "doctype") - )""") + )""" + ) def create_help_table(self): - self.sql('''CREATE TABLE "help"( + self.sql( + """CREATE TABLE "help"( "path" varchar(255), "content" text, "title" text, "intro" text, - "full_path" text)''') - self.sql('''CREATE INDEX IF NOT EXISTS "help_index" ON "help" ("path")''') + "full_path" text)""" + ) + self.sql("""CREATE INDEX IF NOT EXISTS "help_index" ON "help" ("path")""") def updatedb(self, doctype, meta=None): """ @@ -249,7 +274,7 @@ class PostgresDatabase(Database): """ res = self.sql("select issingle from `tabDocType` where name='{}'".format(doctype)) if not res: - raise Exception('Wrong doctype {0} in updatedb'.format(doctype)) + raise Exception("Wrong doctype {0} in updatedb".format(doctype)) if not res[0][0]: db_table = PostgresTable(doctype, meta) @@ -260,19 +285,21 @@ class PostgresDatabase(Database): self.begin() @staticmethod - def get_on_duplicate_update(key='name'): + def get_on_duplicate_update(key="name"): if isinstance(key, list): key = '", "'.join(key) - return 'ON CONFLICT ("{key}") DO UPDATE SET '.format( - key=key - ) + return 'ON CONFLICT ("{key}") DO UPDATE SET '.format(key=key) def check_implicit_commit(self, query): - pass # postgres can run DDL in transactions without implicit commits + pass # postgres can run DDL in transactions without implicit commits def has_index(self, table_name, index_name): - return self.sql("""SELECT 1 FROM pg_indexes WHERE tablename='{table_name}' - and indexname='{index_name}' limit 1""".format(table_name=table_name, index_name=index_name)) + return self.sql( + """SELECT 1 FROM pg_indexes WHERE tablename='{table_name}' + and indexname='{index_name}' limit 1""".format( + table_name=table_name, index_name=index_name + ) + ) def add_index(self, doctype: str, fields: List, index_name: str = None): """Creates an index with given fields if not already created. @@ -289,21 +316,27 @@ class PostgresDatabase(Database): if not constraint_name: constraint_name = "unique_" + "_".join(fields) - if not self.sql(""" + if not self.sql( + """ SELECT CONSTRAINT_NAME FROM information_schema.TABLE_CONSTRAINTS WHERE table_name=%s AND constraint_type='UNIQUE' AND CONSTRAINT_NAME=%s""", - ('tab' + doctype, constraint_name)): - self.commit() - self.sql("""ALTER TABLE `tab%s` - ADD CONSTRAINT %s UNIQUE (%s)""" % (doctype, constraint_name, ", ".join(fields))) + ("tab" + doctype, constraint_name), + ): + self.commit() + self.sql( + """ALTER TABLE `tab%s` + ADD CONSTRAINT %s UNIQUE (%s)""" + % (doctype, constraint_name, ", ".join(fields)) + ) def get_table_columns_description(self, table_name): """Returns list of column and its description""" # pylint: disable=W1401 - return self.sql(''' + return self.sql( + """ SELECT a.column_name AS name, CASE LOWER(a.data_type) WHEN 'character varying' THEN CONCAT('varchar(', a.character_maximum_length ,')') @@ -323,20 +356,25 @@ class PostgresDatabase(Database): ON SUBSTRING(b.indexdef, '(.*)') LIKE CONCAT('%', a.column_name, '%') WHERE a.table_name = '{table_name}' GROUP BY a.column_name, a.data_type, a.column_default, a.character_maximum_length; - '''.format(table_name=table_name), as_dict=1) + """.format( + table_name=table_name + ), + as_dict=1, + ) def get_database_list(self, target): return [d[0] for d in self.sql("SELECT datname FROM pg_database;")] + def modify_query(query): - """"Modifies query according to the requirements of postgres""" + """ "Modifies query according to the requirements of postgres""" # replace ` with " for definitions query = str(query) - query = query.replace('`', '"') + query = query.replace("`", '"') query = replace_locate_with_strpos(query) # select from requires "" - if re.search('from tab', query, flags=re.IGNORECASE): - query = re.sub(r'from tab([\w-]*)', r'from "tab\1"', query, flags=re.IGNORECASE) + if re.search("from tab", query, flags=re.IGNORECASE): + query = re.sub(r"from tab([\w-]*)", r'from "tab\1"', query, flags=re.IGNORECASE) # only find int (with/without signs), ignore decimals (with/without signs), ignore hashes (which start with numbers), # drop .0 from decimals and add quotes around them @@ -345,9 +383,12 @@ def modify_query(query): # >>> re.sub(r"([=><]+)\s*(?!\d+[a-zA-Z])(?![+-]?\d+\.\d\d+)([+-]?\d+)(\.0)?", r"\1 '\2'", query) # "c='abcd' , a >= '45', b = '-45', c = '40', d= '4500', e=3500.53, f=40psdfsd, g= '9092094312', h=12.00023 - query = re.sub(r"([=><]+)\s*(?!\d+[a-zA-Z])(?![+-]?\d+\.\d\d+)([+-]?\d+)(\.0)?", r"\1 '\2'", query) + query = re.sub( + r"([=><]+)\s*(?!\d+[a-zA-Z])(?![+-]?\d+\.\d\d+)([+-]?\d+)(\.0)?", r"\1 '\2'", query + ) return query + def modify_values(values): def stringify_value(value): if isinstance(value, int): @@ -375,8 +416,11 @@ def modify_values(values): return values + def replace_locate_with_strpos(query): # strpos is the locate equivalent in postgres - if re.search(r'locate\(', query, flags=re.IGNORECASE): - query = re.sub(r'locate\(([^,]+),([^)]+)(\)?)\)', r'strpos(\2\3, \1)', query, flags=re.IGNORECASE) + if re.search(r"locate\(", query, flags=re.IGNORECASE): + query = re.sub( + r"locate\(([^,]+),([^)]+)(\)?)\)", r"strpos(\2\3, \1)", query, flags=re.IGNORECASE + ) return query diff --git a/frappe/database/postgres/schema.py b/frappe/database/postgres/schema.py index b09f73300e..3432c8b548 100644 --- a/frappe/database/postgres/schema.py +++ b/frappe/database/postgres/schema.py @@ -1,9 +1,9 @@ import frappe from frappe import _ -from frappe.utils import cint, flt from frappe.database.schema import DBTable, get_definition from frappe.database.sequence import create_sequence from frappe.model import log_types +from frappe.utils import cint, flt class PostgresTable(DBTable): @@ -31,8 +31,9 @@ class PostgresTable(DBTable): ) # creating sequence(s) - if (not self.meta.issingle and self.meta.autoname == "autoincrement")\ - or self.doctype in log_types: + if ( + not self.meta.issingle and self.meta.autoname == "autoincrement" + ) or self.doctype in log_types: # The sequence cache is per connection. # Since we're opening and closing connections for every transaction this results in skipping the cache @@ -43,7 +44,8 @@ class PostgresTable(DBTable): # TODO: set docstatus length # create table - frappe.db.sql(f"""create table `{self.table_name}` ( + frappe.db.sql( + f"""create table `{self.table_name}` ( {name_column}, creation timestamp(6), modified timestamp(6), @@ -61,14 +63,15 @@ class PostgresTable(DBTable): def create_indexes(self): create_index_query = "" for key, col in self.columns.items(): - if (col.set_index + if ( + col.set_index and col.fieldtype in frappe.db.type_map - and frappe.db.type_map.get(col.fieldtype)[0] - not in ('text', 'longtext')): - create_index_query += 'CREATE INDEX IF NOT EXISTS "{index_name}" ON `{table_name}`(`{field}`);'.format( - index_name=col.fieldname, - table_name=self.table_name, - field=col.fieldname + and frappe.db.type_map.get(col.fieldtype)[0] not in ("text", "longtext") + ): + create_index_query += ( + 'CREATE INDEX IF NOT EXISTS "{index_name}" ON `{table_name}`(`{field}`);'.format( + index_name=col.fieldname, table_name=self.table_name, field=col.fieldname + ) ) if create_index_query: # nosemgrep @@ -93,14 +96,16 @@ class PostgresTable(DBTable): elif col.fieldtype in ("Check"): using_clause = "USING {}::smallint".format(col.fieldname) - query.append("ALTER COLUMN `{0}` TYPE {1} {2}".format( - col.fieldname, - get_definition(col.fieldtype, precision=col.precision, length=col.length), - using_clause - )) + query.append( + "ALTER COLUMN `{0}` TYPE {1} {2}".format( + col.fieldname, + get_definition(col.fieldtype, precision=col.precision, length=col.length), + using_clause, + ) + ) for col in self.set_default: - if col.fieldname=="name": + if col.fieldname == "name": continue if col.fieldtype in ("Check", "Int"): @@ -120,29 +125,30 @@ class PostgresTable(DBTable): create_contraint_query = "" for col in self.add_index: # if index key not exists - create_contraint_query += 'CREATE INDEX IF NOT EXISTS "{index_name}" ON `{table_name}`(`{field}`);'.format( - index_name=col.fieldname, - table_name=self.table_name, - field=col.fieldname) + create_contraint_query += ( + 'CREATE INDEX IF NOT EXISTS "{index_name}" ON `{table_name}`(`{field}`);'.format( + index_name=col.fieldname, table_name=self.table_name, field=col.fieldname + ) + ) for col in self.add_unique: # if index key not exists - create_contraint_query += 'CREATE UNIQUE INDEX IF NOT EXISTS "unique_{index_name}" ON `{table_name}`(`{field}`);'.format( - index_name=col.fieldname, - table_name=self.table_name, - field=col.fieldname + create_contraint_query += ( + 'CREATE UNIQUE INDEX IF NOT EXISTS "unique_{index_name}" ON `{table_name}`(`{field}`);'.format( + index_name=col.fieldname, table_name=self.table_name, field=col.fieldname + ) ) drop_contraint_query = "" for col in self.drop_index: # primary key - if col.fieldname != 'name': + if col.fieldname != "name": # if index key exists drop_contraint_query += 'DROP INDEX IF EXISTS "{}" ;'.format(col.fieldname) for col in self.drop_unique: # primary key - if col.fieldname != 'name': + if col.fieldname != "name": # if index key exists drop_contraint_query += 'DROP INDEX IF EXISTS "unique_{}" ;'.format(col.fieldname) try: @@ -163,8 +169,9 @@ class PostgresTable(DBTable): elif frappe.db.is_duplicate_entry(e): fieldname = str(e).split("'")[-2] frappe.throw( - _("{0} field cannot be set as unique in {1}, as there are non-unique existing values") - .format(fieldname, self.table_name) + _("{0} field cannot be set as unique in {1}, as there are non-unique existing values").format( + fieldname, self.table_name + ) ) else: raise e diff --git a/frappe/database/postgres/setup_db.py b/frappe/database/postgres/setup_db.py index 4b265e7660..90d5f72c16 100644 --- a/frappe/database/postgres/setup_db.py +++ b/frappe/database/postgres/setup_db.py @@ -9,45 +9,49 @@ def setup_database(force, source_sql=None, verbose=False): root_conn.sql("DROP DATABASE IF EXISTS `{0}`".format(frappe.conf.db_name)) root_conn.sql("DROP USER IF EXISTS {0}".format(frappe.conf.db_name)) root_conn.sql("CREATE DATABASE `{0}`".format(frappe.conf.db_name)) - root_conn.sql("CREATE user {0} password '{1}'".format(frappe.conf.db_name, - frappe.conf.db_password)) + root_conn.sql( + "CREATE user {0} password '{1}'".format(frappe.conf.db_name, frappe.conf.db_password) + ) root_conn.sql("GRANT ALL PRIVILEGES ON DATABASE `{0}` TO {0}".format(frappe.conf.db_name)) root_conn.close() bootstrap_database(frappe.conf.db_name, verbose, source_sql=source_sql) frappe.connect() + def bootstrap_database(db_name, verbose, source_sql=None): frappe.connect(db_name=db_name) import_db_from_sql(source_sql, verbose) frappe.connect(db_name=db_name) - if 'tabDefaultValue' not in frappe.db.get_tables(): + if "tabDefaultValue" not in frappe.db.get_tables(): import sys + from click import secho secho( "Table 'tabDefaultValue' missing in the restored site. " "This may be due to incorrect permissions or the result of a restore from a bad backup file. " "Database not installed correctly.", - fg="red" + fg="red", ) sys.exit(1) + def import_db_from_sql(source_sql=None, verbose=False): from shutil import which - from subprocess import run, PIPE + from subprocess import PIPE, run # we can't pass psql password in arguments in postgresql as mysql. So # set password connection parameter in environment variable subprocess_env = os.environ.copy() - subprocess_env['PGPASSWORD'] = str(frappe.conf.db_password) + subprocess_env["PGPASSWORD"] = str(frappe.conf.db_password) # bootstrap db if not source_sql: - source_sql = os.path.join(os.path.dirname(__file__), 'framework_postgres.sql') + source_sql = os.path.join(os.path.dirname(__file__), "framework_postgres.sql") - pv = which('pv') + pv = which("pv") _command = ( f"psql {frappe.conf.db_name} " @@ -67,7 +71,10 @@ def import_db_from_sql(source_sql=None, verbose=False): restore_proc = run(command, env=subprocess_env, shell=True, stdout=PIPE) if verbose: - print(f"\nSTDOUT by psql:\n{restore_proc.stdout.decode()}\nImported from Database File: {source_sql}") + print( + f"\nSTDOUT by psql:\n{restore_proc.stdout.decode()}\nImported from Database File: {source_sql}" + ) + def setup_help_database(help_db_name): root_conn = get_root_connection(frappe.flags.root_login, frappe.flags.root_password) @@ -77,6 +84,7 @@ def setup_help_database(help_db_name): root_conn.sql("CREATE user {0} password '{1}'".format(help_db_name, help_db_name)) root_conn.sql("GRANT ALL PRIVILEGES ON DATABASE `{0}` TO {0}".format(help_db_name)) + def get_root_connection(root_login=None, root_password=None): if not frappe.local.flags.root_connection: if not root_login: @@ -90,16 +98,24 @@ def get_root_connection(root_login=None, root_password=None): if not root_password: from getpass import getpass + root_password = getpass("Postgres super user password: ") - frappe.local.flags.root_connection = frappe.database.get_db(user=root_login, password=root_password) + frappe.local.flags.root_connection = frappe.database.get_db( + user=root_login, password=root_password + ) return frappe.local.flags.root_connection def drop_user_and_database(db_name, root_login, root_password): - root_conn = get_root_connection(frappe.flags.root_login or root_login, frappe.flags.root_password or root_password) + root_conn = get_root_connection( + frappe.flags.root_login or root_login, frappe.flags.root_password or root_password + ) root_conn.commit() - root_conn.sql(f"SELECT pg_terminate_backend (pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = %s", (db_name, )) + root_conn.sql( + f"SELECT pg_terminate_backend (pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = %s", + (db_name,), + ) root_conn.sql(f"DROP DATABASE IF EXISTS {db_name}") root_conn.sql(f"DROP USER IF EXISTS {db_name}") diff --git a/frappe/database/query.py b/frappe/database/query.py index 641b584932..8d8a767370 100644 --- a/frappe/database/query.py +++ b/frappe/database/query.py @@ -11,11 +11,11 @@ def like(key: str, value: str) -> frappe.qb: """Wrapper method for `LIKE` Args: - key (str): field - value (str): criterion + key (str): field + value (str): criterion Returns: - frappe.qb: `frappe.qb object with `LIKE` + frappe.qb: `frappe.qb object with `LIKE` """ return Field(key).like(value) @@ -24,11 +24,11 @@ def func_in(key: str, value: Union[List, Tuple]) -> frappe.qb: """Wrapper method for `IN` Args: - key (str): field - value (Union[int, str]): criterion + key (str): field + value (Union[int, str]): criterion Returns: - frappe.qb: `frappe.qb object with `IN` + frappe.qb: `frappe.qb object with `IN` """ return Field(key).isin(value) @@ -37,11 +37,11 @@ def not_like(key: str, value: str) -> frappe.qb: """Wrapper method for `NOT LIKE` Args: - key (str): field - value (str): criterion + key (str): field + value (str): criterion Returns: - frappe.qb: `frappe.qb object with `NOT LIKE` + frappe.qb: `frappe.qb object with `NOT LIKE` """ return Field(key).not_like(value) @@ -50,11 +50,11 @@ def func_not_in(key: str, value: Union[List, Tuple]): """Wrapper method for `NOT IN` Args: - key (str): field - value (Union[int, str]): criterion + key (str): field + value (Union[int, str]): criterion Returns: - frappe.qb: `frappe.qb object with `NOT IN` + frappe.qb: `frappe.qb object with `NOT IN` """ return Field(key).notin(value) @@ -63,11 +63,11 @@ def func_regex(key: str, value: str) -> frappe.qb: """Wrapper method for `REGEX` Args: - key (str): field - value (str): criterion + key (str): field + value (str): criterion Returns: - frappe.qb: `frappe.qb object with `REGEX` + frappe.qb: `frappe.qb object with `REGEX` """ return Field(key).regex(value) @@ -76,23 +76,24 @@ def func_between(key: str, value: Union[List, Tuple]) -> frappe.qb: """Wrapper method for `BETWEEN` Args: - key (str): field - value (Union[int, str]): criterion + key (str): field + value (Union[int, str]): criterion Returns: - frappe.qb: `frappe.qb object with `BETWEEN` + frappe.qb: `frappe.qb object with `BETWEEN` """ return Field(key)[slice(*value)] + def make_function(key: Any, value: Union[int, str]): """returns fucntion query Args: - key (Any): field - value (Union[int, str]): criterion + key (Any): field + value (Union[int, str]): criterion Returns: - frappe.qb: frappe.qb object + frappe.qb: frappe.qb object """ return OPERATOR_MAP[value[0]](key, value[1]) @@ -101,10 +102,10 @@ def change_orderby(order: str): """Convert orderby to standart Order object Args: - order (str): Field, order + order (str): Field, order Returns: - tuple: field, order + tuple: field, order """ order = order.split() if order[1].lower() == "asc": @@ -139,10 +140,10 @@ class Query: """Get initial table object Args: - table (str): DocType + table (str): DocType Returns: - frappe.qb: DocType with initial condition + frappe.qb: DocType with initial condition """ if kwargs.get("update"): return frappe.qb.update(table) @@ -154,11 +155,11 @@ class Query: """Generate filters from Criterion objects Args: - table (str): DocType - criterion (Criterion): Filters + table (str): DocType + criterion (Criterion): Filters Returns: - frappe.qb: condition object + frappe.qb: condition object """ condition = self.add_conditions(self.get_condition(table, **kwargs), **kwargs) return condition.where(criterion) @@ -167,10 +168,10 @@ class Query: """Adding additional conditions Args: - conditions (frappe.qb): built conditions + conditions (frappe.qb): built conditions Returns: - conditions (frappe.qb): frappe.qb object + conditions (frappe.qb): frappe.qb object """ if kwargs.get("orderby"): orderby = kwargs.get("orderby") @@ -194,8 +195,8 @@ class Query: """Build conditions using the given Lists or Tuple filters Args: - table (str): DocType - filters (Union[List, Tuple], optional): Filters. Defaults to None. + table (str): DocType + filters (Union[List, Tuple], optional): Filters. Defaults to None. """ conditions = self.get_condition(table, **kwargs) if not filters: @@ -215,15 +216,17 @@ class Query: return self.add_conditions(conditions, **kwargs) - def dict_query(self, table: str, filters: Dict[str, Union[str, int]] = None, **kwargs) -> frappe.qb: + def dict_query( + self, table: str, filters: Dict[str, Union[str, int]] = None, **kwargs + ) -> frappe.qb: """Build conditions using the given dictionary filters Args: - table (str): DocType - filters (Dict[str, Union[str, int]], optional): Filters. Defaults to None. + table (str): DocType + filters (Dict[str, Union[str, int]], optional): Filters. Defaults to None. Returns: - frappe.qb: conditions object + frappe.qb: conditions object """ conditions = self.get_condition(table, **kwargs) if not filters: @@ -255,19 +258,16 @@ class Query: return self.add_conditions(conditions, **kwargs) def build_conditions( - self, - table: str, - filters: Union[Dict[str, Union[str, int]], str, int] = None, - **kwargs + self, table: str, filters: Union[Dict[str, Union[str, int]], str, int] = None, **kwargs ) -> frappe.qb: """Build conditions for sql query Args: - filters (Union[Dict[str, Union[str, int]], str, int]): conditions in Dict - table (str): DocType + filters (Union[Dict[str, Union[str, int]], str, int]): conditions in Dict + table (str): DocType Returns: - frappe.qb: frappe.qb conditions object + frappe.qb: frappe.qb conditions object """ if isinstance(filters, int) or isinstance(filters, str): filters = {"name": str(filters)} @@ -326,9 +326,7 @@ class Permission: user=kwargs.get("user"), parent_doctype=kwargs.get("parent_doctype"), ): - frappe.throw( - _("Insufficient Permission for {0}").format(frappe.bold(dt)) - ) + frappe.throw(_("Insufficient Permission for {0}").format(frappe.bold(dt))) @staticmethod def get_tables_from_query(query: str): diff --git a/frappe/database/schema.py b/frappe/database/schema.py index 7cab8d42b2..19af447aae 100644 --- a/frappe/database/schema.py +++ b/frappe/database/schema.py @@ -1,16 +1,18 @@ import re -import frappe +import frappe from frappe import _ -from frappe.utils import cstr, cint, flt +from frappe.utils import cint, cstr, flt + +class InvalidColumnName(frappe.ValidationError): + pass -class InvalidColumnName(frappe.ValidationError): pass class DBTable: def __init__(self, doctype, meta=None): self.doctype = doctype - self.table_name = 'tab{}'.format(doctype) + self.table_name = "tab{}".format(doctype) self.meta = meta or frappe.get_meta(doctype, False) self.columns = {} self.current_columns = {} @@ -29,13 +31,13 @@ class DBTable: self.get_columns_from_docfields() def sync(self): - if self.meta.get('is_virtual'): + if self.meta.get("is_virtual"): # no schema to sync for virtual doctypes return if self.is_new(): self.create() else: - frappe.cache().hdel('table_columns', self.table_name) + frappe.cache().hdel("table_columns", self.table_name) self.alter() def create(self): @@ -48,56 +50,51 @@ class DBTable: if k not in column_list: d = self.columns[k].get_definition() if d: - ret.append('`'+ k + '` ' + d) + ret.append("`" + k + "` " + d) column_list.append(k) return ret def get_index_definitions(self): ret = [] for key, col in self.columns.items(): - if (col.set_index + if ( + col.set_index and not col.unique and col.fieldtype in frappe.db.type_map - and frappe.db.type_map.get(col.fieldtype)[0] - not in ('text', 'longtext')): - ret.append('index `' + key + '`(`' + key + '`)') + and frappe.db.type_map.get(col.fieldtype)[0] not in ("text", "longtext") + ): + ret.append("index `" + key + "`(`" + key + "`)") return ret def get_columns_from_docfields(self): """ - get columns from docfields and custom fields + get columns from docfields and custom fields """ fields = self.meta.get_fieldnames_with_value(with_field_meta=True) # optional fields like _comments - if not self.meta.get('istable'): + if not self.meta.get("istable"): for fieldname in frappe.db.OPTIONAL_COLUMNS: - fields.append({ - "fieldname": fieldname, - "fieldtype": "Text" - }) + fields.append({"fieldname": fieldname, "fieldtype": "Text"}) # add _seen column if track_seen - if self.meta.get('track_seen'): - fields.append({ - 'fieldname': '_seen', - 'fieldtype': 'Text' - }) + if self.meta.get("track_seen"): + fields.append({"fieldname": "_seen", "fieldtype": "Text"}) for field in fields: if field.get("is_virtual"): continue - self.columns[field.get('fieldname')] = DbColumn( + self.columns[field.get("fieldname")] = DbColumn( self, - field.get('fieldname'), - field.get('fieldtype'), - field.get('length'), - field.get('default'), - field.get('search_index'), - field.get('options'), - field.get('unique'), - field.get('precision') + field.get("fieldname"), + field.get("fieldtype"), + field.get("length"), + field.get("default"), + field.get("search_index"), + field.get("options"), + field.get("unique"), + field.get("precision"), ) def validate(self): @@ -107,19 +104,22 @@ class DBTable: self.setup_table_columns() - columns = [frappe._dict({"fieldname": f, "fieldtype": "Data"}) for f in - frappe.db.STANDARD_VARCHAR_COLUMNS] + columns = [ + frappe._dict({"fieldname": f, "fieldtype": "Data"}) for f in frappe.db.STANDARD_VARCHAR_COLUMNS + ] if self.meta.get("istable"): - columns += [frappe._dict({"fieldname": f, "fieldtype": "Data"}) for f in - frappe.db.CHILD_TABLE_COLUMNS] + columns += [ + frappe._dict({"fieldname": f, "fieldtype": "Data"}) for f in frappe.db.CHILD_TABLE_COLUMNS + ] columns += self.columns.values() for col in columns: if len(col.fieldname) >= 64: - frappe.throw(_("Fieldname is limited to 64 characters ({0})") - .format(frappe.bold(col.fieldname))) + frappe.throw( + _("Fieldname is limited to 64 characters ({0})").format(frappe.bold(col.fieldname)) + ) - if 'varchar' in frappe.db.type_map.get(col.fieldtype, ()): + if "varchar" in frappe.db.type_map.get(col.fieldtype, ()): # validate length range new_length = cint(col.length) or cint(frappe.db.VARCHAR_LEN) @@ -130,7 +130,7 @@ class DBTable: if not current_col: continue current_type = self.current_columns[col.fieldname]["type"] - current_length = re.findall(r'varchar\(([\d]+)\)', current_type) + current_length = re.findall(r"varchar\(([\d]+)\)", current_type) if not current_length: # case when the field is no longer a varchar continue @@ -138,8 +138,11 @@ class DBTable: if cint(current_length) != cint(new_length): try: # check for truncation - max_length = frappe.db.sql("""SELECT MAX(CHAR_LENGTH(`{fieldname}`)) FROM `tab{doctype}`""" - .format(fieldname=col.fieldname, doctype=self.doctype)) + max_length = frappe.db.sql( + """SELECT MAX(CHAR_LENGTH(`{fieldname}`)) FROM `tab{doctype}`""".format( + fieldname=col.fieldname, doctype=self.doctype + ) + ) except frappe.db.InternalError as e: if frappe.db.is_missing_column(e): @@ -150,8 +153,9 @@ class DBTable: if max_length and max_length[0][0] and max_length[0][0] > new_length: if col.fieldname in self.columns: self.columns[col.fieldname].length = current_length - info_message = _("Reverting length to {0} for '{1}' in '{2}'. Setting the length as {3} will cause truncation of data.") \ - .format(current_length, col.fieldname, self.doctype, new_length) + info_message = _( + "Reverting length to {0} for '{1}' in '{2}'. Setting the length as {3} will cause truncation of data." + ).format(current_length, col.fieldname, self.doctype, new_length) frappe.msgprint(info_message) def is_new(self): @@ -167,8 +171,9 @@ class DBTable: class DbColumn: - def __init__(self, table, fieldname, fieldtype, length, default, - set_index, options, unique, precision): + def __init__( + self, table, fieldname, fieldtype, length, default, set_index, options, unique, precision + ): self.table = table self.fieldname = fieldname self.fieldtype = fieldtype @@ -187,18 +192,22 @@ class DbColumn: if self.fieldtype in ("Check", "Int"): default_value = cint(self.default) or 0 - column_def += ' not null default {0}'.format(default_value) + column_def += " not null default {0}".format(default_value) elif self.fieldtype in ("Currency", "Float", "Percent"): default_value = flt(self.default) or 0 - column_def += ' not null default {0}'.format(default_value) + column_def += " not null default {0}".format(default_value) - elif self.default and (self.default not in frappe.db.DEFAULT_SHORTCUTS) \ - and not cstr(self.default).startswith(":") and column_def not in ('text', 'longtext'): + elif ( + self.default + and (self.default not in frappe.db.DEFAULT_SHORTCUTS) + and not cstr(self.default).startswith(":") + and column_def not in ("text", "longtext") + ): column_def += " default {}".format(frappe.db.escape(self.default)) - if self.unique and (column_def not in ('text', 'longtext')): - column_def += ' unique' + if self.unique and (column_def not in ("text", "longtext")): + column_def += " unique" return column_def @@ -214,7 +223,7 @@ class DbColumn: self.fieldname = validate_column_name(self.fieldname) self.table.add_column.append(self) - if column_type not in ('text', 'longtext'): + if column_type not in ("text", "longtext"): if self.unique: self.table.add_unique.append(self) if self.set_index: @@ -222,34 +231,36 @@ class DbColumn: return # type - if (current_def['type'] != column_type): + if current_def["type"] != column_type: self.table.change_type.append(self) # unique - if ((self.unique and not current_def['unique']) and column_type not in ('text', 'longtext')): + if (self.unique and not current_def["unique"]) and column_type not in ("text", "longtext"): self.table.add_unique.append(self) - elif (current_def['unique'] and not self.unique) and column_type not in ('text', 'longtext'): + elif (current_def["unique"] and not self.unique) and column_type not in ("text", "longtext"): self.table.drop_unique.append(self) # default - if (self.default_changed(current_def) + if ( + self.default_changed(current_def) and (self.default not in frappe.db.DEFAULT_SHORTCUTS) and not cstr(self.default).startswith(":") - and not (column_type in ['text','longtext'])): + and not (column_type in ["text", "longtext"]) + ): self.table.set_default.append(self) # index should be applied or dropped irrespective of type change - if (current_def['index'] and not self.set_index) and column_type not in ('text', 'longtext'): + if (current_def["index"] and not self.set_index) and column_type not in ("text", "longtext"): self.table.drop_index.append(self) - elif (not current_def['index'] and self.set_index) and not (column_type in ('text', 'longtext')): + elif (not current_def["index"] and self.set_index) and not (column_type in ("text", "longtext")): self.table.add_index.append(self) def default_changed(self, current_def): - if "decimal" in current_def['type']: + if "decimal" in current_def["type"]: return self.default_changed_for_decimal(current_def) else: - cur_default = current_def['default'] + cur_default = current_def["default"] new_default = self.default if cur_default == "NULL" or cur_default is None: cur_default = None @@ -259,21 +270,21 @@ class DbColumn: cur_default = cur_default.lstrip("'").rstrip("'") fieldtype = self.fieldtype - if fieldtype in ['Int', 'Check']: + if fieldtype in ["Int", "Check"]: cur_default = cint(cur_default) new_default = cint(new_default) - elif fieldtype in ['Currency', 'Float', 'Percent']: + elif fieldtype in ["Currency", "Float", "Percent"]: cur_default = flt(cur_default) new_default = flt(new_default) return cur_default != new_default def default_changed_for_decimal(self, current_def): try: - if current_def['default'] in ("", None) and self.default in ("", None): + if current_def["default"] in ("", None) and self.default in ("", None): # both none, empty return False - elif current_def['default'] in ("", None): + elif current_def["default"] in ("", None): try: # check if new default value is valid float(self.default) @@ -287,22 +298,29 @@ class DbColumn: else: # NOTE float() raise ValueError when "" or None is passed - return float(current_def['default'])!=float(self.default) + return float(current_def["default"]) != float(self.default) except TypeError: return True + def validate_column_name(n): special_characters = re.findall(r"[\W]", n, re.UNICODE) if special_characters: special_characters = ", ".join('"{0}"'.format(c) for c in special_characters) - frappe.throw(_("Fieldname {0} cannot have special characters like {1}").format( - frappe.bold(cstr(n)), special_characters), frappe.db.InvalidColumnName) + frappe.throw( + _("Fieldname {0} cannot have special characters like {1}").format( + frappe.bold(cstr(n)), special_characters + ), + frappe.db.InvalidColumnName, + ) return n + def validate_column_length(fieldname): if len(fieldname) > frappe.db.MAX_COLUMN_LENGTH: frappe.throw(_("Fieldname is limited to 64 characters ({0})").format(fieldname)) + def get_definition(fieldtype, precision=None, length=None): d = frappe.db.type_map.get(fieldtype) @@ -320,7 +338,7 @@ def get_definition(fieldtype, precision=None, length=None): # This check needs to exist for backward compatibility. # Till V13, default size used for float, currency and percent are (18, 6). if fieldtype in ["Float", "Currency", "Percent"] and cint(precision) > 6: - size = '21,9' + size = "21,9" if length: if coltype == "varchar": @@ -336,14 +354,9 @@ def get_definition(fieldtype, precision=None, length=None): return coltype + def add_column( - doctype, - column_name, - fieldtype, - precision=None, - length=None, - default=None, - not_null=False + doctype, column_name, fieldtype, precision=None, length=None, default=None, not_null=False ): if column_name in frappe.db.get_table_columns(doctype): # already exists @@ -354,7 +367,7 @@ def add_column( query = "alter table `tab%s` add column %s %s" % ( doctype, column_name, - get_definition(fieldtype, precision, length) + get_definition(fieldtype, precision, length), ) if not_null: diff --git a/frappe/database/sequence.py b/frappe/database/sequence.py index 334fd3d71e..c4789dbdaf 100644 --- a/frappe/database/sequence.py +++ b/frappe/database/sequence.py @@ -11,7 +11,7 @@ def create_sequence( start_value: int = 0, increment_by: int = 0, min_value: int = 0, - max_value: int = 0 + max_value: int = 0, ) -> str: query = "create sequence" @@ -57,16 +57,12 @@ def create_sequence( def get_next_val(doctype_name: str, slug: str = "_id_seq") -> int: if db.db_type == "postgres": - return db.sql(f"select nextval(\'\"{scrub(doctype_name + slug)}\"\')")[0][0] + return db.sql(f"select nextval('\"{scrub(doctype_name + slug)}\"')")[0][0] return db.sql(f"select nextval(`{scrub(doctype_name + slug)}`)")[0][0] def set_next_val( - doctype_name: str, - next_val: int, - *, - slug: str = "_id_seq", - is_val_used :bool = False + doctype_name: str, next_val: int, *, slug: str = "_id_seq", is_val_used: bool = False ) -> None: if not is_val_used: diff --git a/frappe/defaults.py b/frappe/defaults.py index e249ef2099..4bbdcf25c6 100644 --- a/frappe/defaults.py +++ b/frappe/defaults.py @@ -2,25 +2,28 @@ # License: MIT. See LICENSE import frappe -from frappe.desk.notifications import clear_notifications from frappe.cache_manager import clear_defaults_cache, common_default_keys +from frappe.desk.notifications import clear_notifications from frappe.query_builder import DocType # Note: DefaultValue records are identified by parenttype # __default, __global or 'User Permission' + def set_user_default(key, value, user=None, parenttype=None): set_default(key, value, user or frappe.session.user, parenttype) + def add_user_default(key, value, user=None, parenttype=None): add_default(key, value, user or frappe.session.user, parenttype) + def get_user_default(key, user=None): user_defaults = get_defaults(user or frappe.session.user) d = user_defaults.get(key, None) if is_a_user_permission_key(key): - if d and isinstance(d, (list, tuple)) and len(d)==1: + if d and isinstance(d, (list, tuple)) and len(d) == 1: # Use User Permission value when only when it has a single value d = d[0] @@ -33,12 +36,13 @@ def get_user_default(key, user=None): return value + def get_user_default_as_list(key, user=None): user_defaults = get_defaults(user or frappe.session.user) d = user_defaults.get(key, None) if is_a_user_permission_key(key): - if d and isinstance(d, (list, tuple)) and len(d)==1: + if d and isinstance(d, (list, tuple)) and len(d) == 1: # Use User Permission value when only when it has a single value d = [d[0]] @@ -52,9 +56,11 @@ def get_user_default_as_list(key, user=None): return values + def is_a_user_permission_key(key): return ":" not in key and key != frappe.scrub(key) + def not_in_user_permission(key, value, user=None): # returns true or false based on if value exist in user permission user = user or frappe.session.user @@ -62,17 +68,22 @@ def not_in_user_permission(key, value, user=None): for perm in user_permission: # doc found in user permission - if perm.get('doc') == value: return False + if perm.get("doc") == value: + return False # return true only if user_permission exists return True if user_permission else False + def get_user_permissions(user=None): - from frappe.core.doctype.user_permission.user_permission \ - import get_user_permissions as _get_user_permissions - '''Return frappe.core.doctype.user_permissions.user_permissions._get_user_permissions (kept for backward compatibility)''' + from frappe.core.doctype.user_permission.user_permission import ( + get_user_permissions as _get_user_permissions, + ) + + """Return frappe.core.doctype.user_permissions.user_permissions._get_user_permissions (kept for backward compatibility)""" return _get_user_permissions(user) + def get_defaults(user=None): globald = get_defaults_for() @@ -87,17 +98,22 @@ def get_defaults(user=None): return globald + def clear_user_default(key, user=None): clear_default(key, parent=user or frappe.session.user) + # Global + def set_global_default(key, value): set_default(key, value, "__default") + def add_global_default(key, value): add_default(key, value, "__default") + def get_global_default(key): d = get_defaults().get(key, None) @@ -107,8 +123,10 @@ def get_global_default(key): return value + # Common + def set_default(key, value, parent, parenttype="__default"): """Override or add a default value. Adds default value in table `tabDefaultValue`. @@ -118,31 +136,36 @@ def set_default(key, value, parent, parenttype="__default"): :param parent: Usually, **User** to whom the default belongs. :param parenttype: [optional] default is `__default`.""" table = DocType("DefaultValue") - key_exists = frappe.qb.from_(table).where( - (table.defkey == key) & (table.parent == parent) - ).select(table.defkey).for_update().run() + key_exists = ( + frappe.qb.from_(table) + .where((table.defkey == key) & (table.parent == parent)) + .select(table.defkey) + .for_update() + .run() + ) if key_exists: - frappe.db.delete("DefaultValue", { - "defkey": key, - "parent": parent - }) + frappe.db.delete("DefaultValue", {"defkey": key, "parent": parent}) if value is not None: add_default(key, value, parent) else: _clear_cache(parent) + def add_default(key, value, parent, parenttype=None): - d = frappe.get_doc({ - "doctype": "DefaultValue", - "parent": parent, - "parenttype": parenttype or "__default", - "parentfield": "system_defaults", - "defkey": key, - "defvalue": value - }) + d = frappe.get_doc( + { + "doctype": "DefaultValue", + "parent": parent, + "parenttype": parenttype or "__default", + "parentfield": "system_defaults", + "defkey": key, + "defvalue": value, + } + ) d.insert(ignore_permissions=True) _clear_cache(parent) + def clear_default(key=None, value=None, parent=None, name=None, parenttype=None): """Clear a default value by any of the given parameters and delete caches. @@ -183,6 +206,7 @@ def clear_default(key=None, value=None, parent=None, name=None, parenttype=None) _clear_cache(parent) + def get_defaults_for(parent="__default"): """get all defaults""" defaults = frappe.cache().hget("defaults", parent) @@ -190,11 +214,13 @@ def get_defaults_for(parent="__default"): if defaults is None: # sort descending because first default must get precedence table = DocType("DefaultValue") - res = frappe.qb.from_(table).where( - table.parent == parent - ).select( - table.defkey, table.defvalue - ).orderby("creation").run(as_dict=True) + res = ( + frappe.qb.from_(table) + .where(table.parent == parent) + .select(table.defkey, table.defvalue) + .orderby("creation") + .run(as_dict=True) + ) defaults = frappe._dict({}) for d in res: @@ -213,6 +239,7 @@ def get_defaults_for(parent="__default"): return defaults + def _clear_cache(parent): if parent in common_default_keys: frappe.clear_cache() diff --git a/frappe/deferred_insert.py b/frappe/deferred_insert.py index f9f1b1c777..28c77002f8 100644 --- a/frappe/deferred_insert.py +++ b/frappe/deferred_insert.py @@ -1,13 +1,16 @@ import json -from typing import Dict, List, Union, TYPE_CHECKING -import frappe +from typing import TYPE_CHECKING, Dict, List, Union + import redis + +import frappe from frappe.utils import cstr if TYPE_CHECKING: from frappe.model.document import Document -queue_prefix = 'insert_queue_for_' +queue_prefix = "insert_queue_for_" + def deferred_insert(doctype: str, records: Union[List[Union[Dict, "Document"]], str]): if isinstance(records, (dict, list)): @@ -21,6 +24,7 @@ def deferred_insert(doctype: str, records: Union[List[Union[Dict, "Document"]], for record in records: insert_record(record, doctype) + def save_to_db(): queue_keys = frappe.cache().get_keys(queue_prefix) for key in queue_keys: @@ -29,7 +33,7 @@ def save_to_db(): doctype = get_doctype_name(key) while frappe.cache().llen(queue_key) > 0 and record_count <= 500: records = frappe.cache().lpop(queue_key) - records = json.loads(records.decode('utf-8')) + records = json.loads(records.decode("utf-8")) if isinstance(records, dict): record_count += 1 insert_record(records, doctype) @@ -40,6 +44,7 @@ def save_to_db(): frappe.db.commit() + def insert_record(record: Union[Dict, "Document"], doctype: str): setattr(record, "doctype", doctype) try: @@ -47,8 +52,10 @@ def insert_record(record: Union[Dict, "Document"], doctype: str): except Exception as e: frappe.logger().error(f"Error while inserting deferred {doctype} record: {e}") + def get_key_name(key: str) -> str: - return cstr(key).split('|')[1] + return cstr(key).split("|")[1] + def get_doctype_name(key: str) -> str: return cstr(key).split(queue_prefix)[1] diff --git a/frappe/desk/__init__.py b/frappe/desk/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/desk/__init__.py +++ b/frappe/desk/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/desk/calendar.py b/frappe/desk/calendar.py index 66e6dd8434..d8c058536d 100644 --- a/frappe/desk/calendar.py +++ b/frappe/desk/calendar.py @@ -1,9 +1,11 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ -import json + @frappe.whitelist() def update_event(args, field_map): @@ -15,13 +17,16 @@ def update_event(args, field_map): w.set(field_map.end, args.get(field_map.end)) w.save() + def get_event_conditions(doctype, filters=None): """Returns SQL conditions with user permissions and filters for event queries""" from frappe.desk.reportview import get_filters_cond + if not frappe.has_permission(doctype): frappe.throw(_("Not Permitted"), frappe.PermissionError) - return get_filters_cond(doctype, filters, [], with_match_conditions = True) + return get_filters_cond(doctype, filters, [], with_match_conditions=True) + @frappe.whitelist() def get_events(doctype, start, end, field_map, filters=None, fields=None): @@ -31,14 +36,12 @@ def get_events(doctype, start, end, field_map, filters=None, fields=None): doc_meta = frappe.get_meta(doctype) for d in doc_meta.fields: if d.fieldtype == "Color": - field_map.update({ - "color": d.fieldname - }) + field_map.update({"color": d.fieldname}) filters = json.loads(filters) if filters else [] if not fields: - fields = [field_map.start, field_map.end, field_map.title, 'name'] + fields = [field_map.start, field_map.end, field_map.title, "name"] if field_map.color: fields.append(field_map.color) @@ -47,8 +50,8 @@ def get_events(doctype, start, end, field_map, filters=None, fields=None): end_date = "ifnull(%s, '2199-12-31 00:00:00')" % field_map.end filters += [ - [doctype, start_date, '<=', end], - [doctype, end_date, '>=', start], + [doctype, start_date, "<=", end], + [doctype, end_date, ">=", start], ] fields = list({field for field in fields if field}) return frappe.get_list(doctype, fields=fields, filters=filters) diff --git a/frappe/desk/desk_page.py b/frappe/desk/desk_page.py index a01008280c..ad0bd549d8 100644 --- a/frappe/desk/desk_page.py +++ b/frappe/desk/desk_page.py @@ -4,30 +4,31 @@ import frappe from frappe.translate import send_translations + @frappe.whitelist() def get(name): """ - Return the :term:`doclist` of the `Page` specified by `name` + Return the :term:`doclist` of the `Page` specified by `name` """ - page = frappe.get_doc('Page', name) + page = frappe.get_doc("Page", name) if page.is_permitted(): page.load_assets() docs = frappe._dict(page.as_dict()) - if getattr(page, '_dynamic_page', None): - docs['_dynamic_page'] = 1 + if getattr(page, "_dynamic_page", None): + docs["_dynamic_page"] = 1 return docs else: - frappe.response['403'] = 1 - raise frappe.PermissionError('No read permission for Page %s' %(page.title or name)) + frappe.response["403"] = 1 + raise frappe.PermissionError("No read permission for Page %s" % (page.title or name)) @frappe.whitelist(allow_guest=True) def getpage(): """ - Load the page from `frappe.form` and send it via `frappe.response` + Load the page from `frappe.form` and send it via `frappe.response` """ - page = frappe.form_dict.get('name') + page = frappe.form_dict.get("name") doc = get(page) # load translations @@ -36,6 +37,7 @@ def getpage(): frappe.response.docs.append(doc) + def has_permission(page): if frappe.session.user == "Administrator" or "System Manager" in frappe.get_roles(): return True diff --git a/frappe/desk/desktop.py b/frappe/desk/desktop.py index 4164db679d..385151f754 100644 --- a/frappe/desk/desktop.py +++ b/frappe/desk/desktop.py @@ -2,17 +2,19 @@ # License: MIT. See LICENSE # Author - Shivam Mishra
{}
'.format(frappe.bold(doctype)) + html = "{}
".format(frappe.bold(doctype)) for doc in docs: - html += ''.format(doctype=doctype, doc=doc) - html += '' + html += ''.format( + doctype=doctype, doc=doc + ) + html += "
" return html - html = message + '
' + html = message + "
" for doctype in non_standard_docs_map: if non_standard_docs_map[doctype]: diff --git a/frappe/desk/doctype/dashboard/test_dashboard.py b/frappe/desk/doctype/dashboard/test_dashboard.py index 15c132c027..ee3d1848e2 100644 --- a/frappe/desk/doctype/dashboard/test_dashboard.py +++ b/frappe/desk/doctype/dashboard/test_dashboard.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestDashboard(unittest.TestCase): pass diff --git a/frappe/desk/doctype/dashboard_chart/dashboard_chart.py b/frappe/desk/doctype/dashboard_chart/dashboard_chart.py index cb77ef7a1a..246c9ad4cd 100644 --- a/frappe/desk/doctype/dashboard_chart/dashboard_chart.py +++ b/frappe/desk/doctype/dashboard_chart/dashboard_chart.py @@ -2,25 +2,31 @@ # Copyright (c) 2019, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe -from frappe import _ import datetime import json -from frappe.utils.dashboard import cache_source -from frappe.utils import nowdate, getdate, get_datetime, cint, now_datetime -from frappe.utils.dateutils import get_period, get_period_beginning, get_from_date_from_timespan, get_dates_from_timegrain -from frappe.model.naming import append_number_if_name_exists + +import frappe +from frappe import _ from frappe.boot import get_allowed_reports from frappe.config import get_modules_from_all_apps_for_user from frappe.model.document import Document +from frappe.model.naming import append_number_if_name_exists from frappe.modules.export_file import export_to_files +from frappe.utils import cint, get_datetime, getdate, now_datetime, nowdate +from frappe.utils.dashboard import cache_source +from frappe.utils.dateutils import ( + get_dates_from_timegrain, + get_from_date_from_timespan, + get_period, + get_period_beginning, +) def get_permission_query_conditions(user): if not user: user = frappe.session.user - if user == 'Administrator': + if user == "Administrator": return roles = frappe.get_roles(user) @@ -31,22 +37,32 @@ def get_permission_query_conditions(user): report_condition = False module_condition = False - allowed_doctypes = [frappe.db.escape(doctype) for doctype in frappe.permissions.get_doctypes_with_read()] - allowed_reports = [frappe.db.escape(key) if type(key) == str else key.encode('UTF8') for key in get_allowed_reports()] - allowed_modules = [frappe.db.escape(module.get('module_name')) for module in get_modules_from_all_apps_for_user()] + allowed_doctypes = [ + frappe.db.escape(doctype) for doctype in frappe.permissions.get_doctypes_with_read() + ] + allowed_reports = [ + frappe.db.escape(key) if type(key) == str else key.encode("UTF8") + for key in get_allowed_reports() + ] + allowed_modules = [ + frappe.db.escape(module.get("module_name")) for module in get_modules_from_all_apps_for_user() + ] if allowed_doctypes: - doctype_condition = '`tabDashboard Chart`.`document_type` in ({allowed_doctypes})'.format( - allowed_doctypes=','.join(allowed_doctypes)) + doctype_condition = "`tabDashboard Chart`.`document_type` in ({allowed_doctypes})".format( + allowed_doctypes=",".join(allowed_doctypes) + ) if allowed_reports: - report_condition = '`tabDashboard Chart`.`report_name` in ({allowed_reports})'.format( - allowed_reports=','.join(allowed_reports)) + report_condition = "`tabDashboard Chart`.`report_name` in ({allowed_reports})".format( + allowed_reports=",".join(allowed_reports) + ) if allowed_modules: - module_condition = '''`tabDashboard Chart`.`module` in ({allowed_modules}) - or `tabDashboard Chart`.`module` is NULL'''.format( - allowed_modules=','.join(allowed_modules)) + module_condition = """`tabDashboard Chart`.`module` in ({allowed_modules}) + or `tabDashboard Chart`.`module` is NULL""".format( + allowed_modules=",".join(allowed_modules) + ) - return ''' + return """ ((`tabDashboard Chart`.`chart_type` in ('Count', 'Sum', 'Average') and {doctype_condition}) or @@ -54,20 +70,22 @@ def get_permission_query_conditions(user): and {report_condition})) and ({module_condition}) - '''.format( + """.format( doctype_condition=doctype_condition, report_condition=report_condition, - module_condition=module_condition + module_condition=module_condition, ) + def has_permission(doc, ptype, user): roles = frappe.get_roles(user) if "System Manager" in roles: return True - - if doc.chart_type == 'Report': - allowed_reports = [key if type(key) == str else key.encode('UTF8') for key in get_allowed_reports()] + if doc.chart_type == "Report": + allowed_reports = [ + key if type(key) == str else key.encode("UTF8") for key in get_allowed_reports() + ] if doc.report_name in allowed_reports: return True else: @@ -77,19 +95,30 @@ def has_permission(doc, ptype, user): return False + @frappe.whitelist() @cache_source -def get(chart_name = None, chart = None, no_cache = None, filters = None, from_date = None, - to_date = None, timespan = None, time_interval = None, heatmap_year=None, refresh = None): +def get( + chart_name=None, + chart=None, + no_cache=None, + filters=None, + from_date=None, + to_date=None, + timespan=None, + time_interval=None, + heatmap_year=None, + refresh=None, +): if chart_name: - chart = frappe.get_doc('Dashboard Chart', chart_name) + chart = frappe.get_doc("Dashboard Chart", chart_name) else: chart = frappe._dict(frappe.parse_json(chart)) heatmap_year = heatmap_year or chart.heatmap_year timespan = timespan or chart.timespan - if timespan == 'Select Date Range': + if timespan == "Select Date Range": if from_date and len(from_date): from_date = get_datetime(from_date) else: @@ -106,34 +135,36 @@ def get(chart_name = None, chart = None, no_cache = None, filters = None, from_d filters = [] # don't include cancelled documents - filters.append([chart.document_type, 'docstatus', '<', 2, False]) + filters.append([chart.document_type, "docstatus", "<", 2, False]) - if chart.chart_type == 'Group By': + if chart.chart_type == "Group By": chart_config = get_group_by_chart_config(chart, filters) else: - if chart.type == 'Heatmap': + if chart.type == "Heatmap": chart_config = get_heatmap_chart_config(chart, filters, heatmap_year) else: - chart_config = get_chart_config(chart, filters, timespan, timegrain, from_date, to_date) + chart_config = get_chart_config(chart, filters, timespan, timegrain, from_date, to_date) return chart_config + @frappe.whitelist() def create_dashboard_chart(args): args = frappe.parse_json(args) - doc = frappe.new_doc('Dashboard Chart') + doc = frappe.new_doc("Dashboard Chart") doc.update(args) - if args.get('custom_options'): - doc.custom_options = json.dumps(args.get('custom_options')) + if args.get("custom_options"): + doc.custom_options = json.dumps(args.get("custom_options")) - if frappe.db.exists('Dashboard Chart', args.chart_name): - args.chart_name = append_number_if_name_exists('Dashboard Chart', args.chart_name) + if frappe.db.exists("Dashboard Chart", args.chart_name): + args.chart_name = append_number_if_name_exists("Dashboard Chart", args.chart_name) doc.chart_name = args.chart_name doc.insert(ignore_permissions=True) return doc + @frappe.whitelist() def create_report_chart(args): doc = create_dashboard_chart(args) @@ -142,24 +173,26 @@ def create_report_chart(args): if args.dashboard: add_chart_to_dashboard(json.dumps(args)) + @frappe.whitelist() def add_chart_to_dashboard(args): args = frappe.parse_json(args) - dashboard = frappe.get_doc('Dashboard', args.dashboard) - dashboard_link = frappe.new_doc('Dashboard Chart Link') + dashboard = frappe.get_doc("Dashboard", args.dashboard) + dashboard_link = frappe.new_doc("Dashboard Chart Link") dashboard_link.chart = args.chart_name or args.name if args.set_standard and dashboard.is_standard: - chart = frappe.get_doc('Dashboard Chart', dashboard_link.chart) + chart = frappe.get_doc("Dashboard Chart", dashboard_link.chart) chart.is_standard = 1 chart.module = dashboard.module chart.save() - dashboard.append('charts', dashboard_link) + dashboard.append("charts", dashboard_link) dashboard.save() frappe.db.commit() + def get_chart_config(chart, filters, timespan, timegrain, from_date, to_date): if not from_date: from_date = get_from_date_from_timespan(to_date, timespan) @@ -169,108 +202,106 @@ def get_chart_config(chart, filters, timespan, timegrain, from_date, to_date): doctype = chart.document_type datefield = chart.based_on - value_field = chart.value_based_on or '1' - from_date = from_date.strftime('%Y-%m-%d') + value_field = chart.value_based_on or "1" + from_date = from_date.strftime("%Y-%m-%d") to_date = to_date - filters.append([doctype, datefield, '>=', from_date, False]) - filters.append([doctype, datefield, '<=', to_date, False]) + filters.append([doctype, datefield, ">=", from_date, False]) + filters.append([doctype, datefield, "<=", to_date, False]) data = frappe.db.get_list( doctype, - fields = [ - '{} as _unit'.format(datefield), - 'SUM({})'.format(value_field), - 'COUNT(*)' - ], - filters = filters, - group_by = '_unit', - order_by = '_unit asc', - as_list = True, - ignore_ifnull = True + fields=["{} as _unit".format(datefield), "SUM({})".format(value_field), "COUNT(*)"], + filters=filters, + group_by="_unit", + order_by="_unit asc", + as_list=True, + ignore_ifnull=True, ) result = get_result(data, timegrain, from_date, to_date, chart.chart_type) chart_config = { "labels": [get_period(r[0], timegrain) for r in result], - "datasets": [{ - "name": chart.name, - "values": [r[1] for r in result] - }] + "datasets": [{"name": chart.name, "values": [r[1] for r in result]}], } return chart_config + def get_heatmap_chart_config(chart, filters, heatmap_year): aggregate_function = get_aggregate_function(chart.chart_type) - value_field = chart.value_based_on or '1' + value_field = chart.value_based_on or "1" doctype = chart.document_type datefield = chart.based_on year = cint(heatmap_year) if heatmap_year else getdate(nowdate()).year - year_start_date = datetime.date(year, 1, 1).strftime('%Y-%m-%d') - next_year_start_date = datetime.date(year + 1, 1, 1).strftime('%Y-%m-%d') + year_start_date = datetime.date(year, 1, 1).strftime("%Y-%m-%d") + next_year_start_date = datetime.date(year + 1, 1, 1).strftime("%Y-%m-%d") - filters.append([doctype, datefield, '>', "{date}".format(date=year_start_date), False]) - filters.append([doctype, datefield, '<', "{date}".format(date=next_year_start_date), False]) + filters.append([doctype, datefield, ">", "{date}".format(date=year_start_date), False]) + filters.append([doctype, datefield, "<", "{date}".format(date=next_year_start_date), False]) - if frappe.db.db_type == 'mariadb': - timestamp_field = 'unix_timestamp({datefield})'.format(datefield=datefield) + if frappe.db.db_type == "mariadb": + timestamp_field = "unix_timestamp({datefield})".format(datefield=datefield) else: - timestamp_field = 'extract(epoch from timestamp {datefield})'.format(datefield=datefield) - - data = dict(frappe.db.get_all( - doctype, - fields = [ - timestamp_field, - '{aggregate_function}({value_field})'.format(aggregate_function=aggregate_function, value_field=value_field), - ], - filters = filters, - group_by = 'date({datefield})'.format(datefield=datefield), - as_list = 1, - order_by = '{datefield} asc'.format(datefield=datefield), - ignore_ifnull = True - )) + timestamp_field = "extract(epoch from timestamp {datefield})".format(datefield=datefield) + + data = dict( + frappe.db.get_all( + doctype, + fields=[ + timestamp_field, + "{aggregate_function}({value_field})".format( + aggregate_function=aggregate_function, value_field=value_field + ), + ], + filters=filters, + group_by="date({datefield})".format(datefield=datefield), + as_list=1, + order_by="{datefield} asc".format(datefield=datefield), + ignore_ifnull=True, + ) + ) chart_config = { - 'labels': [], - 'dataPoints': data, + "labels": [], + "dataPoints": data, } return chart_config + def get_group_by_chart_config(chart, filters): aggregate_function = get_aggregate_function(chart.group_by_type) - value_field = chart.aggregate_function_based_on or '1' + value_field = chart.aggregate_function_based_on or "1" group_by_field = chart.group_by_based_on doctype = chart.document_type data = frappe.db.get_list( doctype, - fields = [ - '{} as name'.format(group_by_field), - '{aggregate_function}({value_field}) as count'.format(aggregate_function=aggregate_function, value_field=value_field), + fields=[ + "{} as name".format(group_by_field), + "{aggregate_function}({value_field}) as count".format( + aggregate_function=aggregate_function, value_field=value_field + ), ], - filters = filters, - group_by = group_by_field, - order_by = 'count desc', - ignore_ifnull = True + filters=filters, + group_by=group_by_field, + order_by="count desc", + ignore_ifnull=True, ) if data: if chart.number_of_groups and chart.number_of_groups < len(data): other_count = 0 for i in range(chart.number_of_groups - 1, len(data)): - other_count += data[i]['count'] - data = data[0: chart.number_of_groups - 1] - data.append({'name': 'Other', 'count': other_count}) + other_count += data[i]["count"] + data = data[0 : chart.number_of_groups - 1] + data.append({"name": "Other", "count": other_count}) chart_config = { - "labels": [item['name'] if item['name'] else 'Not Specified' for item in data], - "datasets": [{ - "name": chart.name, - "values": [item['count'] for item in data] - }] + "labels": [item["name"] if item["name"] else "Not Specified" for item in data], + "datasets": [{"name": chart.name, "values": [item["count"] for item in data]}], } return chart_config @@ -297,35 +328,33 @@ def get_result(data, timegrain, from_date, to_date, chart_type): d[1] += data[data_index][1] count += data[data_index][2] data_index += 1 - if chart_type == 'Average' and not count == 0: - d[1] = d[1]/count - if chart_type == 'Count': + if chart_type == "Average" and not count == 0: + d[1] = d[1] / count + if chart_type == "Count": d[1] = count return result + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_charts_for_user(doctype, txt, searchfield, start, page_len, filters): - or_filters = {'owner': frappe.session.user, 'is_public': 1} - return frappe.db.get_list('Dashboard Chart', - fields=['name'], - filters=filters, - or_filters=or_filters, - as_list = 1) + or_filters = {"owner": frappe.session.user, "is_public": 1} + return frappe.db.get_list( + "Dashboard Chart", fields=["name"], filters=filters, or_filters=or_filters, as_list=1 + ) -class DashboardChart(Document): +class DashboardChart(Document): def on_update(self): - frappe.cache().delete_key('chart-data:{}'.format(self.name)) + frappe.cache().delete_key("chart-data:{}".format(self.name)) if frappe.conf.developer_mode and self.is_standard: - export_to_files(record_list=[['Dashboard Chart', self.name]], record_module=self.module) - + export_to_files(record_list=[["Dashboard Chart", self.name]], record_module=self.module) def validate(self): if not frappe.conf.developer_mode and self.is_standard: frappe.throw(_("Cannot edit Standard charts")) - if self.chart_type != 'Custom' and self.chart_type != 'Report': + if self.chart_type != "Custom" and self.chart_type != "Report": self.check_required_field() self.check_document_type() @@ -335,13 +364,17 @@ class DashboardChart(Document): if not self.document_type: frappe.throw(_("Document type is required to create a dashboard chart")) - if self.document_type and frappe.get_meta(self.document_type).istable and not self.parent_document_type: + if ( + self.document_type + and frappe.get_meta(self.document_type).istable + and not self.parent_document_type + ): frappe.throw(_("Parent document type is required to create a dashboard chart")) - if self.chart_type == 'Group By': + if self.chart_type == "Group By": if not self.group_by_based_on: frappe.throw(_("Group By field is required to create a dashboard chart")) - if self.group_by_type in ['Sum', 'Average'] and not self.aggregate_function_based_on: + if self.group_by_type in ["Sum", "Average"] and not self.aggregate_function_based_on: frappe.throw(_("Aggregate Function field is required to create a dashboard chart")) else: if not self.based_on: diff --git a/frappe/desk/doctype/dashboard_chart/test_dashboard_chart.py b/frappe/desk/doctype/dashboard_chart/test_dashboard_chart.py index 5c986b5b7c..94ea1af35c 100644 --- a/frappe/desk/doctype/dashboard_chart/test_dashboard_chart.py +++ b/frappe/desk/doctype/dashboard_chart/test_dashboard_chart.py @@ -1,182 +1,186 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE -import unittest, frappe -from frappe.utils import getdate, formatdate, get_last_day -from frappe.utils.dateutils import get_period_ending, get_period -from frappe.desk.doctype.dashboard_chart.dashboard_chart import get - +import unittest from datetime import datetime -from dateutil.relativedelta import relativedelta from unittest.mock import patch +from dateutil.relativedelta import relativedelta + +import frappe +from frappe.desk.doctype.dashboard_chart.dashboard_chart import get +from frappe.utils import formatdate, get_last_day, getdate +from frappe.utils.dateutils import get_period, get_period_ending + + class TestDashboardChart(unittest.TestCase): def test_period_ending(self): - self.assertEqual(get_period_ending('2019-04-10', 'Daily'), - getdate('2019-04-10')) + self.assertEqual(get_period_ending("2019-04-10", "Daily"), getdate("2019-04-10")) # week starts on monday with patch.object(frappe.utils.data, "get_first_day_of_the_week", return_value="Monday"): - self.assertEqual(get_period_ending('2019-04-10', 'Weekly'), - getdate('2019-04-14')) - - self.assertEqual(get_period_ending('2019-04-10', 'Monthly'), - getdate('2019-04-30')) - self.assertEqual(get_period_ending('2019-04-30', 'Monthly'), - getdate('2019-04-30')) - self.assertEqual(get_period_ending('2019-03-31', 'Monthly'), - getdate('2019-03-31')) - - self.assertEqual(get_period_ending('2019-04-10', 'Quarterly'), - getdate('2019-06-30')) - self.assertEqual(get_period_ending('2019-06-30', 'Quarterly'), - getdate('2019-06-30')) - self.assertEqual(get_period_ending('2019-10-01', 'Quarterly'), - getdate('2019-12-31')) + self.assertEqual(get_period_ending("2019-04-10", "Weekly"), getdate("2019-04-14")) + + self.assertEqual(get_period_ending("2019-04-10", "Monthly"), getdate("2019-04-30")) + self.assertEqual(get_period_ending("2019-04-30", "Monthly"), getdate("2019-04-30")) + self.assertEqual(get_period_ending("2019-03-31", "Monthly"), getdate("2019-03-31")) + + self.assertEqual(get_period_ending("2019-04-10", "Quarterly"), getdate("2019-06-30")) + self.assertEqual(get_period_ending("2019-06-30", "Quarterly"), getdate("2019-06-30")) + self.assertEqual(get_period_ending("2019-10-01", "Quarterly"), getdate("2019-12-31")) def test_dashboard_chart(self): - if frappe.db.exists('Dashboard Chart', 'Test Dashboard Chart'): - frappe.delete_doc('Dashboard Chart', 'Test Dashboard Chart') - - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Dashboard Chart', - chart_type = 'Count', - document_type = 'DocType', - based_on = 'creation', - timespan = 'Last Year', - time_interval = 'Monthly', - filters_json = '{}', - timeseries = 1 - )).insert() + if frappe.db.exists("Dashboard Chart", "Test Dashboard Chart"): + frappe.delete_doc("Dashboard Chart", "Test Dashboard Chart") + + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Dashboard Chart", + chart_type="Count", + document_type="DocType", + based_on="creation", + timespan="Last Year", + time_interval="Monthly", + filters_json="{}", + timeseries=1, + ) + ).insert() cur_date = datetime.now() - relativedelta(years=1) - result = get(chart_name='Test Dashboard Chart', refresh=1) + result = get(chart_name="Test Dashboard Chart", refresh=1) for idx in range(13): month = get_last_day(cur_date) - month = formatdate(month.strftime('%Y-%m-%d')) - self.assertEqual(result.get('labels')[idx], get_period(month)) + month = formatdate(month.strftime("%Y-%m-%d")) + self.assertEqual(result.get("labels")[idx], get_period(month)) cur_date += relativedelta(months=1) frappe.db.rollback() def test_empty_dashboard_chart(self): - if frappe.db.exists('Dashboard Chart', 'Test Empty Dashboard Chart'): - frappe.delete_doc('Dashboard Chart', 'Test Empty Dashboard Chart') + if frappe.db.exists("Dashboard Chart", "Test Empty Dashboard Chart"): + frappe.delete_doc("Dashboard Chart", "Test Empty Dashboard Chart") frappe.db.delete("Error Log") - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Empty Dashboard Chart', - chart_type = 'Count', - document_type = 'Error Log', - based_on = 'creation', - timespan = 'Last Year', - time_interval = 'Monthly', - filters_json = '[]', - timeseries = 1 - )).insert() + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Empty Dashboard Chart", + chart_type="Count", + document_type="Error Log", + based_on="creation", + timespan="Last Year", + time_interval="Monthly", + filters_json="[]", + timeseries=1, + ) + ).insert() cur_date = datetime.now() - relativedelta(years=1) - result = get(chart_name ='Test Empty Dashboard Chart', refresh=1) + result = get(chart_name="Test Empty Dashboard Chart", refresh=1) for idx in range(13): month = get_last_day(cur_date) - month = formatdate(month.strftime('%Y-%m-%d')) - self.assertEqual(result.get('labels')[idx], get_period(month)) + month = formatdate(month.strftime("%Y-%m-%d")) + self.assertEqual(result.get("labels")[idx], get_period(month)) cur_date += relativedelta(months=1) frappe.db.rollback() def test_chart_wih_one_value(self): - if frappe.db.exists('Dashboard Chart', 'Test Empty Dashboard Chart 2'): - frappe.delete_doc('Dashboard Chart', 'Test Empty Dashboard Chart 2') + if frappe.db.exists("Dashboard Chart", "Test Empty Dashboard Chart 2"): + frappe.delete_doc("Dashboard Chart", "Test Empty Dashboard Chart 2") frappe.db.delete("Error Log") # create one data point - frappe.get_doc(dict(doctype = 'Error Log', creation = '2018-06-01 00:00:00')).insert() - - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Empty Dashboard Chart 2', - chart_type = 'Count', - document_type = 'Error Log', - based_on = 'creation', - timespan = 'Last Year', - time_interval = 'Monthly', - filters_json = '[]', - timeseries = 1 - )).insert() + frappe.get_doc(dict(doctype="Error Log", creation="2018-06-01 00:00:00")).insert() + + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Empty Dashboard Chart 2", + chart_type="Count", + document_type="Error Log", + based_on="creation", + timespan="Last Year", + time_interval="Monthly", + filters_json="[]", + timeseries=1, + ) + ).insert() cur_date = datetime.now() - relativedelta(years=1) - result = get(chart_name ='Test Empty Dashboard Chart 2', refresh = 1) + result = get(chart_name="Test Empty Dashboard Chart 2", refresh=1) for idx in range(13): month = get_last_day(cur_date) - month = formatdate(month.strftime('%Y-%m-%d')) - self.assertEqual(result.get('labels')[idx], get_period(month)) + month = formatdate(month.strftime("%Y-%m-%d")) + self.assertEqual(result.get("labels")[idx], get_period(month)) cur_date += relativedelta(months=1) # only 1 data point with value - self.assertEqual(result.get('datasets')[0].get('values')[2], 0) + self.assertEqual(result.get("datasets")[0].get("values")[2], 0) frappe.db.rollback() def test_group_by_chart_type(self): - if frappe.db.exists('Dashboard Chart', 'Test Group By Dashboard Chart'): - frappe.delete_doc('Dashboard Chart', 'Test Group By Dashboard Chart') - - frappe.get_doc({"doctype":"ToDo", "description": "test"}).insert() - - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Group By Dashboard Chart', - chart_type = 'Group By', - document_type = 'ToDo', - group_by_based_on = 'status', - filters_json = '[]', - )).insert() + if frappe.db.exists("Dashboard Chart", "Test Group By Dashboard Chart"): + frappe.delete_doc("Dashboard Chart", "Test Group By Dashboard Chart") + + frappe.get_doc({"doctype": "ToDo", "description": "test"}).insert() + + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Group By Dashboard Chart", + chart_type="Group By", + document_type="ToDo", + group_by_based_on="status", + filters_json="[]", + ) + ).insert() - result = get(chart_name ='Test Group By Dashboard Chart', refresh = 1) - todo_status_count = frappe.db.count('ToDo', {'status': result.get('labels')[0]}) + result = get(chart_name="Test Group By Dashboard Chart", refresh=1) + todo_status_count = frappe.db.count("ToDo", {"status": result.get("labels")[0]}) - self.assertEqual(result.get('datasets')[0].get('values')[0], todo_status_count) + self.assertEqual(result.get("datasets")[0].get("values")[0], todo_status_count) frappe.db.rollback() def test_daily_dashboard_chart(self): insert_test_records() - if frappe.db.exists('Dashboard Chart', 'Test Daily Dashboard Chart'): - frappe.delete_doc('Dashboard Chart', 'Test Daily Dashboard Chart') - - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Daily Dashboard Chart', - chart_type = 'Sum', - document_type = 'Communication', - based_on = 'communication_date', - value_based_on = 'rating', - timespan = 'Select Date Range', - time_interval = 'Daily', - from_date = datetime(2019, 1, 6), - to_date = datetime(2019, 1, 11), - filters_json = '[]', - timeseries = 1 - )).insert() - - result = get(chart_name = 'Test Daily Dashboard Chart', refresh = 1) - - self.assertEqual(result.get('datasets')[0].get('values'), [200.0, 400.0, 300.0, 0.0, 100.0, 0.0]) + if frappe.db.exists("Dashboard Chart", "Test Daily Dashboard Chart"): + frappe.delete_doc("Dashboard Chart", "Test Daily Dashboard Chart") + + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Daily Dashboard Chart", + chart_type="Sum", + document_type="Communication", + based_on="communication_date", + value_based_on="rating", + timespan="Select Date Range", + time_interval="Daily", + from_date=datetime(2019, 1, 6), + to_date=datetime(2019, 1, 11), + filters_json="[]", + timeseries=1, + ) + ).insert() + + result = get(chart_name="Test Daily Dashboard Chart", refresh=1) + + self.assertEqual(result.get("datasets")[0].get("values"), [200.0, 400.0, 300.0, 0.0, 100.0, 0.0]) self.assertEqual( - result.get('labels'), - ['06-01-19', '07-01-19', '08-01-19', '09-01-19', '10-01-19', '11-01-19'] + result.get("labels"), ["06-01-19", "07-01-19", "08-01-19", "09-01-19", "10-01-19", "11-01-19"] ) frappe.db.rollback() @@ -184,81 +188,81 @@ class TestDashboardChart(unittest.TestCase): def test_weekly_dashboard_chart(self): insert_test_records() - if frappe.db.exists('Dashboard Chart', 'Test Weekly Dashboard Chart'): - frappe.delete_doc('Dashboard Chart', 'Test Weekly Dashboard Chart') - - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Weekly Dashboard Chart', - chart_type = 'Sum', - document_type = 'Communication', - based_on = 'communication_date', - value_based_on = 'rating', - timespan = 'Select Date Range', - time_interval = 'Weekly', - from_date = datetime(2018, 12, 30), - to_date = datetime(2019, 1, 15), - filters_json = '[]', - timeseries = 1 - )).insert() + if frappe.db.exists("Dashboard Chart", "Test Weekly Dashboard Chart"): + frappe.delete_doc("Dashboard Chart", "Test Weekly Dashboard Chart") + + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Weekly Dashboard Chart", + chart_type="Sum", + document_type="Communication", + based_on="communication_date", + value_based_on="rating", + timespan="Select Date Range", + time_interval="Weekly", + from_date=datetime(2018, 12, 30), + to_date=datetime(2019, 1, 15), + filters_json="[]", + timeseries=1, + ) + ).insert() with patch.object(frappe.utils.data, "get_first_day_of_the_week", return_value="Monday"): - result = get(chart_name ='Test Weekly Dashboard Chart', refresh = 1) + result = get(chart_name="Test Weekly Dashboard Chart", refresh=1) - self.assertEqual(result.get('datasets')[0].get('values'), [50.0, 300.0, 800.0, 0.0]) - self.assertEqual( - result.get('labels'), - ['30-12-18', '06-01-19', '13-01-19', '20-01-19'] - ) + self.assertEqual(result.get("datasets")[0].get("values"), [50.0, 300.0, 800.0, 0.0]) + self.assertEqual(result.get("labels"), ["30-12-18", "06-01-19", "13-01-19", "20-01-19"]) frappe.db.rollback() def test_avg_dashboard_chart(self): insert_test_records() - if frappe.db.exists('Dashboard Chart', 'Test Average Dashboard Chart'): - frappe.delete_doc('Dashboard Chart', 'Test Average Dashboard Chart') - - frappe.get_doc(dict( - doctype = 'Dashboard Chart', - chart_name = 'Test Average Dashboard Chart', - chart_type = 'Average', - document_type = 'Communication', - based_on = 'communication_date', - value_based_on = 'rating', - timespan = 'Select Date Range', - time_interval = 'Weekly', - from_date = datetime(2018, 12, 30), - to_date = datetime(2019, 1, 15), - filters_json = '[]', - timeseries = 1 - )).insert() + if frappe.db.exists("Dashboard Chart", "Test Average Dashboard Chart"): + frappe.delete_doc("Dashboard Chart", "Test Average Dashboard Chart") + + frappe.get_doc( + dict( + doctype="Dashboard Chart", + chart_name="Test Average Dashboard Chart", + chart_type="Average", + document_type="Communication", + based_on="communication_date", + value_based_on="rating", + timespan="Select Date Range", + time_interval="Weekly", + from_date=datetime(2018, 12, 30), + to_date=datetime(2019, 1, 15), + filters_json="[]", + timeseries=1, + ) + ).insert() with patch.object(frappe.utils.data, "get_first_day_of_the_week", return_value="Monday"): - result = get(chart_name='Test Average Dashboard Chart', refresh = 1) - self.assertEqual( - result.get('labels'), - ['30-12-18', '06-01-19', '13-01-19', '20-01-19'] - ) - self.assertEqual(result.get('datasets')[0].get('values'), [50.0, 150.0, 266.6666666666667, 0.0]) + result = get(chart_name="Test Average Dashboard Chart", refresh=1) + self.assertEqual(result.get("labels"), ["30-12-18", "06-01-19", "13-01-19", "20-01-19"]) + self.assertEqual(result.get("datasets")[0].get("values"), [50.0, 150.0, 266.6666666666667, 0.0]) frappe.db.rollback() + def insert_test_records(): - create_new_communication('Communication 1', datetime(2018, 12, 30), 50) - create_new_communication('Communication 2', datetime(2019, 1, 4), 100) - create_new_communication('Communication 3', datetime(2019, 1, 6), 200) - create_new_communication('Communication 4', datetime(2019, 1, 7), 400) - create_new_communication('Communication 5', datetime(2019, 1, 8), 300) - create_new_communication('Communication 6', datetime(2019, 1, 10), 100) + create_new_communication("Communication 1", datetime(2018, 12, 30), 50) + create_new_communication("Communication 2", datetime(2019, 1, 4), 100) + create_new_communication("Communication 3", datetime(2019, 1, 6), 200) + create_new_communication("Communication 4", datetime(2019, 1, 7), 400) + create_new_communication("Communication 5", datetime(2019, 1, 8), 300) + create_new_communication("Communication 6", datetime(2019, 1, 10), 100) + def create_new_communication(subject, date, rating): communication = { - 'doctype': 'Communication', - 'subject': subject, - 'rating': rating, - 'communication_date': date + "doctype": "Communication", + "subject": subject, + "rating": rating, + "communication_date": date, } comm = frappe.get_doc(communication) - if not frappe.db.exists("Communication", {'subject' : comm.subject}): + if not frappe.db.exists("Communication", {"subject": comm.subject}): comm.insert() diff --git a/frappe/desk/doctype/dashboard_chart_field/dashboard_chart_field.py b/frappe/desk/doctype/dashboard_chart_field/dashboard_chart_field.py index 8b2fba2e58..41f35d2ee4 100644 --- a/frappe/desk/doctype/dashboard_chart_field/dashboard_chart_field.py +++ b/frappe/desk/doctype/dashboard_chart_field/dashboard_chart_field.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class DashboardChartField(Document): pass diff --git a/frappe/desk/doctype/dashboard_chart_link/dashboard_chart_link.py b/frappe/desk/doctype/dashboard_chart_link/dashboard_chart_link.py index 87d095d5d1..b2a7caefeb 100644 --- a/frappe/desk/doctype/dashboard_chart_link/dashboard_chart_link.py +++ b/frappe/desk/doctype/dashboard_chart_link/dashboard_chart_link.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class DashboardChartLink(Document): pass diff --git a/frappe/desk/doctype/dashboard_chart_source/dashboard_chart_source.py b/frappe/desk/doctype/dashboard_chart_source/dashboard_chart_source.py index 71ded32837..29c1b6ee7d 100644 --- a/frappe/desk/doctype/dashboard_chart_source/dashboard_chart_source.py +++ b/frappe/desk/doctype/dashboard_chart_source/dashboard_chart_source.py @@ -2,21 +2,29 @@ # Copyright (c) 2019, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe, os +import os + +import frappe from frappe import _ from frappe.model.document import Document -from frappe.modules.export_file import export_to_files from frappe.modules import get_module_path, scrub +from frappe.modules.export_file import export_to_files @frappe.whitelist() def get_config(name): - doc = frappe.get_doc('Dashboard Chart Source', name) - with open(os.path.join(get_module_path(doc.module), - 'dashboard_chart_source', scrub(doc.name), scrub(doc.name) + '.js'), 'r') as f: + doc = frappe.get_doc("Dashboard Chart Source", name) + with open( + os.path.join( + get_module_path(doc.module), "dashboard_chart_source", scrub(doc.name), scrub(doc.name) + ".js" + ), + "r", + ) as f: return f.read() + class DashboardChartSource(Document): def on_update(self): - export_to_files(record_list=[[self.doctype, self.name]], - record_module=self.module, create_init=True) + export_to_files( + record_list=[[self.doctype, self.name]], record_module=self.module, create_init=True + ) diff --git a/frappe/desk/doctype/dashboard_chart_source/test_dashboard_chart_source.py b/frappe/desk/doctype/dashboard_chart_source/test_dashboard_chart_source.py index 6d6773d52e..0c219c08cc 100644 --- a/frappe/desk/doctype/dashboard_chart_source/test_dashboard_chart_source.py +++ b/frappe/desk/doctype/dashboard_chart_source/test_dashboard_chart_source.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE import unittest + class TestDashboardChartSource(unittest.TestCase): pass diff --git a/frappe/desk/doctype/dashboard_settings/dashboard_settings.py b/frappe/desk/doctype/dashboard_settings/dashboard_settings.py index 2f29b3e989..d43476ad7d 100644 --- a/frappe/desk/doctype/dashboard_settings/dashboard_settings.py +++ b/frappe/desk/doctype/dashboard_settings/dashboard_settings.py @@ -2,10 +2,13 @@ # Copyright (c) 2020, Frappe Technologies and contributors # License: MIT. See LICENSE +import json + +import frappe + # import frappe from frappe.model.document import Document -import frappe -import json + class DashboardSettings(Document): pass @@ -14,21 +17,24 @@ class DashboardSettings(Document): @frappe.whitelist() def create_dashboard_settings(user): if not frappe.db.exists("Dashboard Settings", user): - doc = frappe.new_doc('Dashboard Settings') + doc = frappe.new_doc("Dashboard Settings") doc.name = user doc.insert(ignore_permissions=True) frappe.db.commit() return doc + def get_permission_query_conditions(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user + + return """(`tabDashboard Settings`.name = '{user}')""".format(user=user) - return '''(`tabDashboard Settings`.name = '{user}')'''.format(user=user) @frappe.whitelist() def save_chart_config(reset, config, chart_name): reset = frappe.parse_json(reset) - doc = frappe.get_doc('Dashboard Settings', frappe.session.user) + doc = frappe.get_doc("Dashboard Settings", frappe.session.user) chart_config = frappe.parse_json(doc.chart_config) or {} if reset: @@ -39,4 +45,6 @@ def save_chart_config(reset, config, chart_name): chart_config[chart_name] = {} chart_config[chart_name].update(config) - frappe.db.set_value('Dashboard Settings', frappe.session.user, 'chart_config', json.dumps(chart_config)) \ No newline at end of file + frappe.db.set_value( + "Dashboard Settings", frappe.session.user, "chart_config", json.dumps(chart_config) + ) diff --git a/frappe/desk/doctype/desktop_icon/desktop_icon.py b/frappe/desk/doctype/desktop_icon/desktop_icon.py index 194b0d0ca4..29de1f56d9 100644 --- a/frappe/desk/doctype/desktop_icon/desktop_icon.py +++ b/frappe/desk/doctype/desktop_icon/desktop_icon.py @@ -2,13 +2,15 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and contributors # License: MIT. See LICENSE -import frappe -from frappe import _ import json import random + +import frappe +from frappe import _ from frappe.model.document import Document from frappe.utils.user import UserPermissions + class DesktopIcon(Document): def validate(self): if not self.label: @@ -17,30 +19,50 @@ class DesktopIcon(Document): def on_trash(self): clear_desktop_icons_cache() + def after_doctype_insert(): - frappe.db.add_unique('Desktop Icon', ('module_name', 'owner', 'standard')) + frappe.db.add_unique("Desktop Icon", ("module_name", "owner", "standard")) + def get_desktop_icons(user=None): - '''Return desktop icons for user''' + """Return desktop icons for user""" if not user: user = frappe.session.user - user_icons = frappe.cache().hget('desktop_icons', user) + user_icons = frappe.cache().hget("desktop_icons", user) if not user_icons: - fields = ['module_name', 'hidden', 'label', 'link', 'type', 'icon', 'color', 'description', 'category', - '_doctype', '_report', 'idx', 'force_show', 'reverse', 'custom', 'standard', 'blocked'] + fields = [ + "module_name", + "hidden", + "label", + "link", + "type", + "icon", + "color", + "description", + "category", + "_doctype", + "_report", + "idx", + "force_show", + "reverse", + "custom", + "standard", + "blocked", + ] active_domains = frappe.get_active_domains() - blocked_doctypes = frappe.get_all("DocType", filters={ - "ifnull(restrict_to_domain, '')": ("not in", ",".join(active_domains)) - }, fields=["name"]) + blocked_doctypes = frappe.get_all( + "DocType", + filters={"ifnull(restrict_to_domain, '')": ("not in", ",".join(active_domains))}, + fields=["name"], + ) - blocked_doctypes = [ d.get("name") for d in blocked_doctypes ] + blocked_doctypes = [d.get("name") for d in blocked_doctypes] - standard_icons = frappe.db.get_all('Desktop Icon', - fields=fields, filters={'standard': 1}) + standard_icons = frappe.db.get_all("Desktop Icon", fields=fields, filters={"standard": 1}) standard_map = {} for icon in standard_icons: @@ -48,8 +70,9 @@ def get_desktop_icons(user=None): icon.blocked = 1 standard_map[icon.module_name] = icon - user_icons = frappe.db.get_all('Desktop Icon', fields=fields, - filters={'standard': 0, 'owner': user}) + user_icons = frappe.db.get_all( + "Desktop Icon", fields=fields, filters={"standard": 0, "owner": user} + ) # update hidden property for icon in user_icons: @@ -60,11 +83,10 @@ def get_desktop_icons(user=None): # override properties from standard icon if standard_icon: - for key in ('route', 'label', 'color', 'icon', 'link'): + for key in ("route", "label", "color", "icon", "link"): if standard_icon.get(key): icon[key] = standard_icon.get(key) - if standard_icon.blocked: icon.hidden = 1 @@ -86,52 +108,68 @@ def get_desktop_icons(user=None): user_icons.append(standard_icon) - user_blocked_modules = frappe.get_doc('User', user).get_blocked_modules() + user_blocked_modules = frappe.get_doc("User", user).get_blocked_modules() for icon in user_icons: if icon.module_name in user_blocked_modules: icon.hidden = 1 # sort by idx - user_icons.sort(key = lambda a: a.idx) + user_icons.sort(key=lambda a: a.idx) # translate for d in user_icons: - if d.label: d.label = _(d.label) + if d.label: + d.label = _(d.label) - frappe.cache().hset('desktop_icons', user, user_icons) + frappe.cache().hset("desktop_icons", user, user_icons) return user_icons + @frappe.whitelist() -def add_user_icon(_doctype, _report=None, label=None, link=None, type='link', standard=0): - '''Add a new user desktop icon to the desktop''' +def add_user_icon(_doctype, _report=None, label=None, link=None, type="link", standard=0): + """Add a new user desktop icon to the desktop""" - if not label: label = _doctype or _report - if not link: link = 'List/{0}'.format(_doctype) + if not label: + label = _doctype or _report + if not link: + link = "List/{0}".format(_doctype) # find if a standard icon exists - icon_name = frappe.db.exists('Desktop Icon', {'standard': standard, 'link': link, - 'owner': frappe.session.user}) + icon_name = frappe.db.exists( + "Desktop Icon", {"standard": standard, "link": link, "owner": frappe.session.user} + ) if icon_name: - if frappe.db.get_value('Desktop Icon', icon_name, 'hidden'): + if frappe.db.get_value("Desktop Icon", icon_name, "hidden"): # if it is hidden, unhide it - frappe.db.set_value('Desktop Icon', icon_name, 'hidden', 0) + frappe.db.set_value("Desktop Icon", icon_name, "hidden", 0) clear_desktop_icons_cache() else: - idx = frappe.db.sql('select max(idx) from `tabDesktop Icon` where owner=%s', - frappe.session.user)[0][0] or \ - frappe.db.sql('select count(*) from `tabDesktop Icon` where standard=1')[0][0] + idx = ( + frappe.db.sql("select max(idx) from `tabDesktop Icon` where owner=%s", frappe.session.user)[0][ + 0 + ] + or frappe.db.sql("select count(*) from `tabDesktop Icon` where standard=1")[0][0] + ) if not frappe.db.get_value("Report", _report): _report = None - userdefined_icon = frappe.db.get_value('DocType', _doctype, ['icon','color','module'], as_dict=True) + userdefined_icon = frappe.db.get_value( + "DocType", _doctype, ["icon", "color", "module"], as_dict=True + ) else: - userdefined_icon = frappe.db.get_value('Report', _report, ['icon','color','module'], as_dict=True) + userdefined_icon = frappe.db.get_value( + "Report", _report, ["icon", "color", "module"], as_dict=True + ) - module_icon = frappe.get_value('Desktop Icon', {'standard':1, 'module_name':userdefined_icon.module}, - ['name', 'icon', 'color', 'reverse'], as_dict=True) + module_icon = frappe.get_value( + "Desktop Icon", + {"standard": 1, "module_name": userdefined_icon.module}, + ["name", "icon", "color", "reverse"], + as_dict=True, + ) if not module_icon: module_icon = frappe._dict() @@ -140,27 +178,29 @@ def add_user_icon(_doctype, _report=None, label=None, link=None, type='link', st module_icon.reverse = 0 if (len(opts) > 1) else 1 try: - new_icon = frappe.get_doc({ - 'doctype': 'Desktop Icon', - 'label': label, - 'module_name': label, - 'link': link, - 'type': type, - '_doctype': _doctype, - '_report': _report, - 'icon': userdefined_icon.icon or module_icon.icon, - 'color': userdefined_icon.color or module_icon.color, - 'reverse': module_icon.reverse, - 'idx': idx + 1, - 'custom': 1, - 'standard': standard - }).insert(ignore_permissions=True) + new_icon = frappe.get_doc( + { + "doctype": "Desktop Icon", + "label": label, + "module_name": label, + "link": link, + "type": type, + "_doctype": _doctype, + "_report": _report, + "icon": userdefined_icon.icon or module_icon.icon, + "color": userdefined_icon.color or module_icon.color, + "reverse": module_icon.reverse, + "idx": idx + 1, + "custom": 1, + "standard": standard, + } + ).insert(ignore_permissions=True) clear_desktop_icons_cache() icon_name = new_icon.name except frappe.UniqueValidationError as e: - frappe.throw(_('Desktop Icon already exists')) + frappe.throw(_("Desktop Icon already exists")) except Exception as e: raise e @@ -169,31 +209,31 @@ def add_user_icon(_doctype, _report=None, label=None, link=None, type='link', st @frappe.whitelist() def set_order(new_order, user=None): - '''set new order by duplicating user icons (if user is set) or set global order''' + """set new order by duplicating user icons (if user is set) or set global order""" if isinstance(new_order, str): new_order = json.loads(new_order) for i, module_name in enumerate(new_order): - if module_name not in ('Explore',): + if module_name not in ("Explore",): if user: icon = get_user_copy(module_name, user) else: - name = frappe.db.get_value('Desktop Icon', - {'standard': 1, 'module_name': module_name}) + name = frappe.db.get_value("Desktop Icon", {"standard": 1, "module_name": module_name}) if name: - icon = frappe.get_doc('Desktop Icon', name) + icon = frappe.get_doc("Desktop Icon", name) else: # standard icon missing, create one for DocType name = add_user_icon(module_name, standard=1) - icon = frappe.get_doc('Desktop Icon', name) + icon = frappe.get_doc("Desktop Icon", name) - icon.db_set('idx', i) + icon.db_set("idx", i) clear_desktop_icons_cache() + def set_desktop_icons(visible_list, ignore_duplicate=True): - '''Resets all lists and makes only the given one standard, + """Resets all lists and makes only the given one standard, if the desktop icon does not exist and the name is a DocType, then will create - an icon for the doctype''' + an icon for the doctype""" # clear all custom only if setup is not complete if not int(frappe.defaults.get_defaults().setup_complete or 0): @@ -201,15 +241,15 @@ def set_desktop_icons(visible_list, ignore_duplicate=True): # set standard as blocked and hidden if setting first active domain if not frappe.flags.keep_desktop_icons: - frappe.db.sql('update `tabDesktop Icon` set blocked=0, hidden=1 where standard=1') + frappe.db.sql("update `tabDesktop Icon` set blocked=0, hidden=1 where standard=1") # set as visible if present, or add icon for module_name in visible_list: - name = frappe.db.get_value('Desktop Icon', {'module_name': module_name}) + name = frappe.db.get_value("Desktop Icon", {"module_name": module_name}) if name: - frappe.db.set_value('Desktop Icon', name, 'hidden', 0) + frappe.db.set_value("Desktop Icon", name, "hidden", 0) else: - if frappe.db.exists('DocType', module_name): + if frappe.db.exists("DocType", module_name): try: add_user_icon(module_name, standard=1) except frappe.UniqueValidationError as e: @@ -225,10 +265,11 @@ def set_desktop_icons(visible_list, ignore_duplicate=True): clear_desktop_icons_cache() + def set_hidden_list(hidden_list, user=None): - '''Sets property `hidden`=1 in **Desktop Icon** for given user. + """Sets property `hidden`=1 in **Desktop Icon** for given user. If user is None then it will set global values. - It will also set the rest of the icons as shown (`hidden` = 0)''' + It will also set the rest of the icons as shown (`hidden` = 0)""" if isinstance(hidden_list, str): hidden_list = json.loads(hidden_list) @@ -245,9 +286,10 @@ def set_hidden_list(hidden_list, user=None): else: frappe.clear_cache() + def set_hidden(module_name, user=None, hidden=1): - '''Set module hidden property for given user. If user is not specified, - hide/unhide it globally''' + """Set module hidden property for given user. If user is not specified, + hide/unhide it globally""" if user: icon = get_user_copy(module_name, user) @@ -256,55 +298,71 @@ def set_hidden(module_name, user=None, hidden=1): return # hidden by user - icon.db_set('hidden', hidden) + icon.db_set("hidden", hidden) else: - icon = frappe.get_doc('Desktop Icon', {'standard': 1, 'module_name': module_name}) + icon = frappe.get_doc("Desktop Icon", {"standard": 1, "module_name": module_name}) # blocked is globally hidden - icon.db_set('blocked', hidden) + icon.db_set("blocked", hidden) + def get_all_icons(): - return [d.module_name for d in frappe.get_all('Desktop Icon', - filters={'standard': 1}, fields=['module_name'])] + return [ + d.module_name + for d in frappe.get_all("Desktop Icon", filters={"standard": 1}, fields=["module_name"]) + ] + def clear_desktop_icons_cache(user=None): - frappe.cache().hdel('desktop_icons', user or frappe.session.user) - frappe.cache().hdel('bootinfo', user or frappe.session.user) + frappe.cache().hdel("desktop_icons", user or frappe.session.user) + frappe.cache().hdel("bootinfo", user or frappe.session.user) + def get_user_copy(module_name, user=None): - '''Return user copy (Desktop Icon) of the given module_name. If user copy does not exist, create one. + """Return user copy (Desktop Icon) of the given module_name. If user copy does not exist, create one. :param module_name: Name of the module :param user: User for which the copy is required (optional) - ''' + """ if not user: user = frappe.session.user - desktop_icon_name = frappe.db.get_value('Desktop Icon', - {'module_name': module_name, 'owner': user, 'standard': 0}) + desktop_icon_name = frappe.db.get_value( + "Desktop Icon", {"module_name": module_name, "owner": user, "standard": 0} + ) if desktop_icon_name: - return frappe.get_doc('Desktop Icon', desktop_icon_name) + return frappe.get_doc("Desktop Icon", desktop_icon_name) else: return make_user_copy(module_name, user) + def make_user_copy(module_name, user): - '''Insert and return the user copy of a standard Desktop Icon''' - standard_name = frappe.db.get_value('Desktop Icon', {'module_name': module_name, 'standard': 1}) + """Insert and return the user copy of a standard Desktop Icon""" + standard_name = frappe.db.get_value("Desktop Icon", {"module_name": module_name, "standard": 1}) if not standard_name: - frappe.throw(_('{0} not found').format(module_name), frappe.DoesNotExistError) - - original = frappe.get_doc('Desktop Icon', standard_name) - - desktop_icon = frappe.get_doc({ - 'doctype': 'Desktop Icon', - 'standard': 0, - 'owner': user, - 'module_name': module_name - }) - - for key in ('app', 'label', 'route', 'type', '_doctype', 'idx', 'reverse', 'force_show', 'link', 'icon', 'color'): + frappe.throw(_("{0} not found").format(module_name), frappe.DoesNotExistError) + + original = frappe.get_doc("Desktop Icon", standard_name) + + desktop_icon = frappe.get_doc( + {"doctype": "Desktop Icon", "standard": 0, "owner": user, "module_name": module_name} + ) + + for key in ( + "app", + "label", + "route", + "type", + "_doctype", + "idx", + "reverse", + "force_show", + "link", + "icon", + "color", + ): if original.get(key): desktop_icon.set(key, original.get(key)) @@ -312,43 +370,42 @@ def make_user_copy(module_name, user): return desktop_icon + def sync_desktop_icons(): - '''Sync desktop icons from all apps''' + """Sync desktop icons from all apps""" for app in frappe.get_installed_apps(): sync_from_app(app) + def sync_from_app(app): - '''Sync desktop icons from app. To be called during install''' + """Sync desktop icons from app. To be called during install""" try: - modules = frappe.get_attr(app + '.config.desktop.get_data')() or {} + modules = frappe.get_attr(app + ".config.desktop.get_data")() or {} except ImportError: return [] if isinstance(modules, dict): modules_list = [] for m, desktop_icon in modules.items(): - desktop_icon['module_name'] = m + desktop_icon["module_name"] = m modules_list.append(desktop_icon) else: modules_list = modules for i, m in enumerate(modules_list): - desktop_icon_name = frappe.db.get_value('Desktop Icon', - {'module_name': m['module_name'], 'app': app, 'standard': 1}) + desktop_icon_name = frappe.db.get_value( + "Desktop Icon", {"module_name": m["module_name"], "app": app, "standard": 1} + ) if desktop_icon_name: - desktop_icon = frappe.get_doc('Desktop Icon', desktop_icon_name) + desktop_icon = frappe.get_doc("Desktop Icon", desktop_icon_name) else: # new icon - desktop_icon = frappe.get_doc({ - 'doctype': 'Desktop Icon', - 'idx': i, - 'standard': 1, - 'app': app, - 'owner': 'Administrator' - }) + desktop_icon = frappe.get_doc( + {"doctype": "Desktop Icon", "idx": i, "standard": 1, "app": app, "owner": "Administrator"} + ) - if 'doctype' in m: - m['_doctype'] = m.pop('doctype') + if "doctype" in m: + m["_doctype"] = m.pop("doctype") desktop_icon.update(m) try: @@ -358,46 +415,53 @@ def sync_from_app(app): return modules_list + @frappe.whitelist() def update_icons(hidden_list, user=None): """update modules""" if not user: - frappe.only_for('System Manager') + frappe.only_for("System Manager") set_hidden_list(hidden_list, user) - frappe.msgprint(frappe._('Updated'), indicator='green', title=_('Success'), alert=True) + frappe.msgprint(frappe._("Updated"), indicator="green", title=_("Success"), alert=True) + def get_context(context): context.icons = get_user_icons(frappe.session.user) context.user = frappe.session.user - if 'System Manager' in frappe.get_roles(): - context.users = frappe.db.get_all('User', filters={'user_type': 'System User', 'enabled': 1}, - fields = ['name', 'first_name', 'last_name']) + if "System Manager" in frappe.get_roles(): + context.users = frappe.db.get_all( + "User", + filters={"user_type": "System User", "enabled": 1}, + fields=["name", "first_name", "last_name"], + ) + @frappe.whitelist() def get_module_icons(user=None): if user != frappe.session.user: - frappe.only_for('System Manager') + frappe.only_for("System Manager") if not user: - icons = frappe.db.get_all('Desktop Icon', - fields='*', filters={'standard': 1}, order_by='idx') + icons = frappe.db.get_all("Desktop Icon", fields="*", filters={"standard": 1}, order_by="idx") else: - frappe.cache().hdel('desktop_icons', user) + frappe.cache().hdel("desktop_icons", user) icons = get_user_icons(user) for icon in icons: icon.value = frappe.db.escape(_(icon.label or icon.module_name)) - return {'icons': icons, 'user': user} + return {"icons": icons, "user": user} + def get_user_icons(user): - '''Get user icons for module setup page''' + """Get user icons for module setup page""" user_perms = UserPermissions(user) user_perms.build_permissions() from frappe.boot import get_allowed_pages + allowed_pages = get_allowed_pages() icons = [] @@ -407,13 +471,13 @@ def get_user_icons(user): add = False if not icon.custom: - if icon.module_name==['Help', 'Settings']: + if icon.module_name == ["Help", "Settings"]: pass - elif icon.type=="page" and icon.link not in allowed_pages: + elif icon.type == "page" and icon.link not in allowed_pages: add = False - elif icon.type=="module" and icon.module_name not in user_perms.allow_modules: + elif icon.type == "module" and icon.module_name not in user_perms.allow_modules: add = False if add: @@ -421,64 +485,66 @@ def get_user_icons(user): return icons + palette = ( - ('#FFC4C4',), - ('#FFE8CD',), - ('#FFD2C2',), - ('#FF8989',), - ('#FFD19C',), - ('#FFA685',), - ('#FF4D4D', 1), - ('#FFB868',), - ('#FF7846', 1), - ('#A83333', 1), - ('#A87945', 1), - ('#A84F2E', 1), - ('#D2D2FF',), - ('#F8D4F8',), - ('#DAC7FF',), - ('#A3A3FF',), - ('#F3AAF0',), - ('#B592FF',), - ('#7575FF', 1), - ('#EC7DEA', 1), - ('#8E58FF', 1), - ('#4D4DA8', 1), - ('#934F92', 1), - ('#5E3AA8', 1), - ('#EBF8CC',), - ('#FFD7D7',), - ('#D2F8ED',), - ('#D9F399',), - ('#FFB1B1',), - ('#A4F3DD',), - ('#C5EC63',), - ('#FF8989', 1), - ('#77ECCA',), - ('#7B933D', 1), - ('#A85B5B', 1), - ('#49937E', 1), - ('#FFFACD',), - ('#D2F1FF',), - ('#CEF6D1',), - ('#FFF69C',), - ('#A6E4FF',), - ('#9DECA2',), - ('#FFF168',), - ('#78D6FF',), - ('#6BE273',), - ('#A89F45', 1), - ('#4F8EA8', 1), - ('#428B46', 1) + ("#FFC4C4",), + ("#FFE8CD",), + ("#FFD2C2",), + ("#FF8989",), + ("#FFD19C",), + ("#FFA685",), + ("#FF4D4D", 1), + ("#FFB868",), + ("#FF7846", 1), + ("#A83333", 1), + ("#A87945", 1), + ("#A84F2E", 1), + ("#D2D2FF",), + ("#F8D4F8",), + ("#DAC7FF",), + ("#A3A3FF",), + ("#F3AAF0",), + ("#B592FF",), + ("#7575FF", 1), + ("#EC7DEA", 1), + ("#8E58FF", 1), + ("#4D4DA8", 1), + ("#934F92", 1), + ("#5E3AA8", 1), + ("#EBF8CC",), + ("#FFD7D7",), + ("#D2F8ED",), + ("#D9F399",), + ("#FFB1B1",), + ("#A4F3DD",), + ("#C5EC63",), + ("#FF8989", 1), + ("#77ECCA",), + ("#7B933D", 1), + ("#A85B5B", 1), + ("#49937E", 1), + ("#FFFACD",), + ("#D2F1FF",), + ("#CEF6D1",), + ("#FFF69C",), + ("#A6E4FF",), + ("#9DECA2",), + ("#FFF168",), + ("#78D6FF",), + ("#6BE273",), + ("#A89F45", 1), + ("#4F8EA8", 1), + ("#428B46", 1), ) + @frappe.whitelist() -def hide(name, user = None): +def hide(name, user=None): if not user: user = frappe.session.user try: - set_hidden(name, user, hidden = 1) + set_hidden(name, user, hidden=1) clear_desktop_icons_cache() except Exception: return False diff --git a/frappe/desk/doctype/event/__init__.py b/frappe/desk/doctype/event/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/desk/doctype/event/__init__.py +++ b/frappe/desk/doctype/event/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/desk/doctype/event/event.py b/frappe/desk/doctype/event/event.py index 86f0656bc6..531cc69c57 100644 --- a/frappe/desk/doctype/event/event.py +++ b/frappe/desk/doctype/event/event.py @@ -2,19 +2,40 @@ # License: MIT. See LICENSE -import frappe import json -from frappe.utils import (getdate, cint, add_months, date_diff, add_days, - nowdate, get_datetime_str, cstr, get_datetime, now_datetime, format_datetime) +import frappe from frappe import _ +from frappe.desk.doctype.notification_settings.notification_settings import ( + is_email_notifications_enabled_for_type, +) +from frappe.desk.reportview import get_filters_cond from frappe.model.document import Document +from frappe.utils import ( + add_days, + add_months, + cint, + cstr, + date_diff, + format_datetime, + get_datetime, + get_datetime_str, + getdate, + now_datetime, + nowdate, +) from frappe.utils.user import get_enabled_system_users -from frappe.desk.reportview import get_filters_cond -from frappe.desk.doctype.notification_settings.notification_settings import is_email_notifications_enabled_for_type weekdays = ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"] -communication_mapping = {"": "Event", "Event": "Event", "Meeting": "Meeting", "Call": "Phone", "Sent/Received Email": "Email", "Other": "Other"} +communication_mapping = { + "": "Event", + "Event": "Event", + "Meeting": "Meeting", + "Call": "Phone", + "Sent/Received Email": "Email", + "Other": "Other", +} + class Event(Document): def validate(self): @@ -27,7 +48,9 @@ class Event(Document): if self.starts_on and self.ends_on: self.validate_from_to_dates("starts_on", "ends_on") - if self.repeat_on == "Daily" and self.ends_on and getdate(self.starts_on) != getdate(self.ends_on): + if ( + self.repeat_on == "Daily" and self.ends_on and getdate(self.starts_on) != getdate(self.ends_on) + ): frappe.throw(_("Daily Events should finish on the Same Day.")) if self.sync_with_google_calendar and not self.google_calendar: @@ -37,7 +60,9 @@ class Event(Document): self.sync_communication() def on_trash(self): - communications = frappe.get_all("Communication", dict(reference_doctype=self.doctype, reference_name=self.name)) + communications = frappe.get_all( + "Communication", dict(reference_doctype=self.doctype, reference_name=self.name) + ) if communications: for communication in communications: frappe.delete_doc_if_exists("Communication", communication.name) @@ -49,7 +74,7 @@ class Event(Document): ["Communication", "reference_doctype", "=", self.doctype], ["Communication", "reference_name", "=", self.name], ["Communication Link", "link_doctype", "=", participant.reference_doctype], - ["Communication Link", "link_name", "=", participant.reference_docname] + ["Communication Link", "link_name", "=", participant.reference_docname], ] comms = frappe.get_all("Communication", filters=filters, fields=["name"]) @@ -59,7 +84,7 @@ class Event(Document): self.update_communication(participant, communication) else: meta = frappe.get_meta(participant.reference_doctype) - if hasattr(meta, "allow_events_in_timeline") and meta.allow_events_in_timeline==1: + if hasattr(meta, "allow_events_in_timeline") and meta.allow_events_in_timeline == 1: self.create_communication(participant) def create_communication(self, participant): @@ -76,7 +101,9 @@ class Event(Document): communication.sender_full_name = frappe.utils.get_fullname(self.owner) communication.reference_doctype = self.doctype communication.reference_name = self.name - communication.communication_medium = communication_mapping.get(self.event_category) if self.event_category else "" + communication.communication_medium = ( + communication_mapping.get(self.event_category) if self.event_category else "" + ) communication.status = "Linked" communication.add_link(participant.reference_doctype, participant.reference_docname) communication.save(ignore_permissions=True) @@ -85,23 +112,27 @@ class Event(Document): """Add a single participant to event participants Args: - doctype (string): Reference Doctype - docname (string): Reference Docname + doctype (string): Reference Doctype + docname (string): Reference Docname """ - self.append("event_participants", { - "reference_doctype": doctype, - "reference_docname": docname, - }) + self.append( + "event_participants", + { + "reference_doctype": doctype, + "reference_docname": docname, + }, + ) def add_participants(self, participants): """Add participant entry Args: - participants ([Array]): Array of a dict with doctype and docname + participants ([Array]): Array of a dict with doctype and docname """ - for participant in participants: + for participant in participants: self.add_participant(participant["doctype"], participant["docname"]) + @frappe.whitelist() def delete_communication(event, reference_doctype, reference_docname): deleted_participant = frappe.get_doc(reference_doctype, reference_docname) @@ -112,7 +143,7 @@ def delete_communication(event, reference_doctype, reference_docname): ["Communication", "reference_doctype", "=", event.get("doctype")], ["Communication", "reference_name", "=", event.get("name")], ["Communication Link", "link_doctype", "=", deleted_participant.reference_doctype], - ["Communication Link", "link_name", "=", deleted_participant.reference_docname] + ["Communication Link", "link_name", "=", deleted_participant.reference_docname], ] comms = frappe.get_list("Communication", filters=filters, fields=["name"]) @@ -129,23 +160,29 @@ def delete_communication(event, reference_doctype, reference_docname): def get_permission_query_conditions(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user return """(`tabEvent`.`event_type`='Public' or `tabEvent`.`owner`=%(user)s)""" % { - "user": frappe.db.escape(user), - } + "user": frappe.db.escape(user), + } + def has_permission(doc, user): - if doc.event_type=="Public" or doc.owner==user: + if doc.event_type == "Public" or doc.owner == user: return True return False + def send_event_digest(): today = nowdate() # select only those users that have event reminder email notifications enabled - users = [user for user in get_enabled_system_users() if - is_email_notifications_enabled_for_type(user.name, 'Event Reminders')] + users = [ + user + for user in get_enabled_system_users() + if is_email_notifications_enabled_for_type(user.name, "Event Reminders") + ] for user in users: events = get_events(today, today, user.name, for_reminder=True) @@ -153,7 +190,7 @@ def send_event_digest(): frappe.set_user_lang(user.name, user.language) for e in events: - e.starts_on = format_datetime(e.starts_on, 'hh:mm a') + e.starts_on = format_datetime(e.starts_on, "hh:mm a") if e.all_day: e.starts_on = "All Day" @@ -162,11 +199,12 @@ def send_event_digest(): subject=frappe._("Upcoming Events for Today"), template="upcoming_events", args={ - 'events': events, + "events": events, }, - header=[frappe._("Events in Today's Calendar"), 'blue'] + header=[frappe._("Events in Today's Calendar"), "blue"], ) + @frappe.whitelist() def get_events(start, end, user=None, for_reminder=False, filters=None): if not user: @@ -175,13 +213,14 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): if isinstance(filters, str): filters = json.loads(filters) - filter_condition = get_filters_cond('Event', filters, []) + filter_condition = get_filters_cond("Event", filters, []) tables = ["`tabEvent`"] if "`tabEvent Participants`" in filter_condition: tables.append("`tabEvent Participants`") - events = frappe.db.sql(""" + events = frappe.db.sql( + """ SELECT `tabEvent`.name, `tabEvent`.subject, `tabEvent`.description, @@ -234,12 +273,15 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): ORDER BY `tabEvent`.starts_on""".format( tables=", ".join(tables), filter_condition=filter_condition, - reminder_condition="AND coalesce(`tabEvent`.send_reminder, 0)=1" if for_reminder else "" - ), { + reminder_condition="AND coalesce(`tabEvent`.send_reminder, 0)=1" if for_reminder else "", + ), + { "start": start, "end": end, "user": user, - }, as_dict=1) + }, + as_dict=1, + ) # process recurring events start = start.split(" ")[0] @@ -250,11 +292,16 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): def add_event(e, date): new_event = e.copy() - enddate = add_days(date,int(date_diff(e.ends_on.split(" ")[0], e.starts_on.split(" ")[0]))) \ - if (e.starts_on and e.ends_on) else date + enddate = ( + add_days(date, int(date_diff(e.ends_on.split(" ")[0], e.starts_on.split(" ")[0]))) + if (e.starts_on and e.ends_on) + else date + ) new_event.starts_on = date + " " + e.starts_on.split(" ")[1] - new_event.ends_on = new_event.ends_on = enddate + " " + e.ends_on.split(" ")[1] if e.ends_on else None + new_event.ends_on = new_event.ends_on = ( + enddate + " " + e.ends_on.split(" ")[1] if e.ends_on else None + ) add_events.append(new_event) @@ -275,9 +322,13 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): event_start = "-".join(event_start.split("-")[1:]) # repeat for all years in period - for year in range(start_year, end_year+1): + for year in range(start_year, end_year + 1): date = str(year) + "-" + event_start - if getdate(date) >= getdate(start) and getdate(date) <= getdate(end) and getdate(date) <= getdate(repeat): + if ( + getdate(date) >= getdate(start) + and getdate(date) <= getdate(end) + and getdate(date) <= getdate(repeat) + ): add_event(e, date) remove_events.append(e) @@ -295,19 +346,27 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): start_from = date for i in range(int(date_diff(end, start) / 30) + 3): - if getdate(date) >= getdate(start) and getdate(date) <= getdate(end) \ - and getdate(date) <= getdate(repeat) and getdate(date) >= getdate(event_start): + if ( + getdate(date) >= getdate(start) + and getdate(date) <= getdate(end) + and getdate(date) <= getdate(repeat) + and getdate(date) >= getdate(event_start) + ): add_event(e, date) - date = add_months(start_from, i+1) + date = add_months(start_from, i + 1) remove_events.append(e) if e.repeat_on == "Weekly": for cnt in range(date_diff(end, start) + 1): date = add_days(start, cnt) - if getdate(date) >= getdate(start) and getdate(date) <= getdate(end) \ - and getdate(date) <= getdate(repeat) and getdate(date) >= getdate(event_start) \ - and e[weekdays[getdate(date).weekday()]]: + if ( + getdate(date) >= getdate(start) + and getdate(date) <= getdate(end) + and getdate(date) <= getdate(repeat) + and getdate(date) >= getdate(event_start) + and e[weekdays[getdate(date).weekday()]] + ): add_event(e, date) remove_events.append(e) @@ -315,7 +374,11 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): if e.repeat_on == "Daily": for cnt in range(date_diff(end, start) + 1): date = add_days(start, cnt) - if getdate(date) >= getdate(event_start) and getdate(date) <= getdate(end) and getdate(date) <= getdate(repeat): + if ( + getdate(date) >= getdate(event_start) + and getdate(date) <= getdate(end) + and getdate(date) <= getdate(repeat) + ): add_event(e, date) remove_events.append(e) @@ -332,26 +395,36 @@ def get_events(start, end, user=None, for_reminder=False, filters=None): return events + def delete_events(ref_type, ref_name, delete_event=False): - participations = frappe.get_all("Event Participants", filters={"reference_doctype": ref_type, "reference_docname": ref_name, - "parenttype": "Event"}, fields=["parent", "name"]) + participations = frappe.get_all( + "Event Participants", + filters={"reference_doctype": ref_type, "reference_docname": ref_name, "parenttype": "Event"}, + fields=["parent", "name"], + ) if participations: for participation in participations: if delete_event: frappe.delete_doc("Event", participation.parent, for_reload=True) else: - total_participants = frappe.get_all("Event Participants", filters={"parenttype": "Event", "parent": participation.parent}) + total_participants = frappe.get_all( + "Event Participants", filters={"parenttype": "Event", "parent": participation.parent} + ) if len(total_participants) <= 1: frappe.db.delete("Event", {"name": participation.parent}) frappe.db.delete("Event Participants", {"name": participation.name}) + # Close events if ends_on or repeat_till is less than now_datetime def set_status_of_events(): - events = frappe.get_list("Event", filters={"status": "Open"}, fields=["name", "ends_on", "repeat_till"]) + events = frappe.get_list( + "Event", filters={"status": "Open"}, fields=["name", "ends_on", "repeat_till"] + ) for event in events: - if (event.ends_on and getdate(event.ends_on) < getdate(nowdate())) \ - or (event.repeat_till and getdate(event.repeat_till) < getdate(nowdate())): + if (event.ends_on and getdate(event.ends_on) < getdate(nowdate())) or ( + event.repeat_till and getdate(event.repeat_till) < getdate(nowdate()) + ): frappe.db.set_value("Event", event.name, "status", "Closed") diff --git a/frappe/desk/doctype/event/test_event.py b/frappe/desk/doctype/event/test_event.py index b0269a80cc..041bda643e 100644 --- a/frappe/desk/doctype/event/test_event.py +++ b/frappe/desk/doctype/event/test_event.py @@ -2,22 +2,23 @@ # License: MIT. See LICENSE """Use blog post test to test user permissions logic""" -import frappe -import frappe.defaults -import unittest import json +import unittest +import frappe +import frappe.defaults from frappe.desk.doctype.event.event import get_events from frappe.test_runner import make_test_objects -test_records = frappe.get_test_records('Event') +test_records = frappe.get_test_records("Event") + class TestEvent(unittest.TestCase): def setUp(self): frappe.db.delete("Event") - make_test_objects('Event', reset=True) + make_test_objects("Event", reset=True) - self.test_records = frappe.get_test_records('Event') + self.test_records = frappe.get_test_records("Event") self.test_user = "test1@example.com" def tearDown(self): @@ -25,16 +26,16 @@ class TestEvent(unittest.TestCase): def test_allowed_public(self): frappe.set_user(self.test_user) - doc = frappe.get_doc("Event", frappe.db.get_value("Event", {"subject":"_Test Event 1"})) + doc = frappe.get_doc("Event", frappe.db.get_value("Event", {"subject": "_Test Event 1"})) self.assertTrue(frappe.has_permission("Event", doc=doc)) def test_not_allowed_private(self): frappe.set_user(self.test_user) - doc = frappe.get_doc("Event", frappe.db.get_value("Event", {"subject":"_Test Event 2"})) + doc = frappe.get_doc("Event", frappe.db.get_value("Event", {"subject": "_Test Event 2"})) self.assertFalse(frappe.has_permission("Event", doc=doc)) def test_allowed_private_if_in_event_user(self): - name = frappe.db.get_value("Event", {"subject":"_Test Event 3"}) + name = frappe.db.get_value("Event", {"subject": "_Test Event 3"}) frappe.share.add("Event", name, self.test_user, "read") frappe.set_user(self.test_user) doc = frappe.get_doc("Event", name) @@ -44,7 +45,9 @@ class TestEvent(unittest.TestCase): def test_event_list(self): frappe.set_user(self.test_user) - res = frappe.get_list("Event", filters=[["Event", "subject", "like", "_Test Event%"]], fields=["name", "subject"]) + res = frappe.get_list( + "Event", filters=[["Event", "subject", "like", "_Test Event%"]], fields=["name", "subject"] + ) self.assertEqual(len(res), 1) subjects = [r.subject for r in res] self.assertTrue("_Test Event 1" in subjects) @@ -68,32 +71,38 @@ class TestEvent(unittest.TestCase): ev = frappe.get_doc(self.test_records[0]).insert() - add({ - "assign_to": ["test@example.com"], - "doctype": "Event", - "name": ev.name, - "description": "Test Assignment" - }) + add( + { + "assign_to": ["test@example.com"], + "doctype": "Event", + "name": ev.name, + "description": "Test Assignment", + } + ) ev = frappe.get_doc("Event", ev.name) self.assertEqual(ev._assign, json.dumps(["test@example.com"])) # add another one - add({ - "assign_to": [self.test_user], - "doctype": "Event", - "name": ev.name, - "description": "Test Assignment" - }) + add( + { + "assign_to": [self.test_user], + "doctype": "Event", + "name": ev.name, + "description": "Test Assignment", + } + ) ev = frappe.get_doc("Event", ev.name) self.assertEqual(set(json.loads(ev._assign)), set(["test@example.com", self.test_user])) # Remove an assignment - todo = frappe.get_doc("ToDo", {"reference_type": ev.doctype, "reference_name": ev.name, - "allocated_to": self.test_user}) + todo = frappe.get_doc( + "ToDo", + {"reference_type": ev.doctype, "reference_name": ev.name, "allocated_to": self.test_user}, + ) todo.status = "Cancelled" todo.save() @@ -104,24 +113,26 @@ class TestEvent(unittest.TestCase): ev.delete() def test_recurring(self): - ev = frappe.get_doc({ - "doctype":"Event", - "subject": "_Test Event", - "starts_on": "2014-02-01", - "event_type": "Public", - "repeat_this_event": 1, - "repeat_on": "Yearly" - }) + ev = frappe.get_doc( + { + "doctype": "Event", + "subject": "_Test Event", + "starts_on": "2014-02-01", + "event_type": "Public", + "repeat_this_event": 1, + "repeat_on": "Yearly", + } + ) ev.insert() ev_list = get_events("2014-02-01", "2014-02-01", "Administrator", for_reminder=True) - self.assertTrue(bool(list(filter(lambda e: e.name==ev.name, ev_list)))) + self.assertTrue(bool(list(filter(lambda e: e.name == ev.name, ev_list)))) ev_list1 = get_events("2015-01-20", "2015-01-20", "Administrator", for_reminder=True) - self.assertFalse(bool(list(filter(lambda e: e.name==ev.name, ev_list1)))) + self.assertFalse(bool(list(filter(lambda e: e.name == ev.name, ev_list1)))) ev_list2 = get_events("2014-02-20", "2014-02-20", "Administrator", for_reminder=True) - self.assertFalse(bool(list(filter(lambda e: e.name==ev.name, ev_list2)))) + self.assertFalse(bool(list(filter(lambda e: e.name == ev.name, ev_list2)))) ev_list3 = get_events("2015-02-01", "2015-02-01", "Administrator", for_reminder=True) - self.assertTrue(bool(list(filter(lambda e: e.name==ev.name, ev_list3)))) + self.assertTrue(bool(list(filter(lambda e: e.name == ev.name, ev_list3)))) diff --git a/frappe/desk/doctype/event_participants/event_participants.py b/frappe/desk/doctype/event_participants/event_participants.py index b834ba3a82..fdb834b285 100644 --- a/frappe/desk/doctype/event_participants/event_participants.py +++ b/frappe/desk/doctype/event_participants/event_participants.py @@ -3,5 +3,6 @@ # License: MIT. See LICENSE from frappe.model.document import Document + class EventParticipants(Document): - pass \ No newline at end of file + pass diff --git a/frappe/desk/doctype/form_tour/test_form_tour.py b/frappe/desk/doctype/form_tour/test_form_tour.py index 3670cbc218..cb0c4ef33a 100644 --- a/frappe/desk/doctype/form_tour/test_form_tour.py +++ b/frappe/desk/doctype/form_tour/test_form_tour.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestFormTour(unittest.TestCase): pass diff --git a/frappe/desk/doctype/form_tour_step/form_tour_step.py b/frappe/desk/doctype/form_tour_step/form_tour_step.py index bbc8edea08..9d82ae8527 100644 --- a/frappe/desk/doctype/form_tour_step/form_tour_step.py +++ b/frappe/desk/doctype/form_tour_step/form_tour_step.py @@ -4,5 +4,6 @@ # import frappe from frappe.model.document import Document + class FormTourStep(Document): pass diff --git a/frappe/desk/doctype/global_search_doctype/global_search_doctype.py b/frappe/desk/doctype/global_search_doctype/global_search_doctype.py index 30a31f959f..8bdc05cd71 100644 --- a/frappe/desk/doctype/global_search_doctype/global_search_doctype.py +++ b/frappe/desk/doctype/global_search_doctype/global_search_doctype.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class GlobalSearchDocType(Document): pass diff --git a/frappe/desk/doctype/global_search_settings/global_search_settings.py b/frappe/desk/doctype/global_search_settings/global_search_settings.py index e9a47cecd1..b7ffd7faf7 100644 --- a/frappe/desk/doctype/global_search_settings/global_search_settings.py +++ b/frappe/desk/doctype/global_search_settings/global_search_settings.py @@ -3,11 +3,11 @@ # License: MIT. See LICENSE import frappe -from frappe.model.document import Document from frappe import _ +from frappe.model.document import Document -class GlobalSearchSettings(Document): +class GlobalSearchSettings(Document): def validate(self): dts, core_dts, repeated_dts = [], [], [] @@ -25,11 +25,12 @@ class GlobalSearchSettings(Document): frappe.throw(_("Core Modules {0} cannot be searched in Global Search.").format(core_dts)) if repeated_dts: - repeated_dts = (", ".join([frappe.bold(dt) for dt in repeated_dts])) + repeated_dts = ", ".join([frappe.bold(dt) for dt in repeated_dts]) frappe.throw(_("Document Type {0} has been repeated.").format(repeated_dts)) # reset cache - frappe.cache().hdel('global_search', 'search_priorities') + frappe.cache().hdel("global_search", "search_priorities") + def get_doctypes_for_global_search(): def get_from_db(): @@ -43,6 +44,7 @@ def get_doctypes_for_global_search(): def reset_global_search_settings_doctypes(): update_global_search_doctypes() + def update_global_search_doctypes(): global_search_doctypes = [] show_message(1, _("Fetching default Global Search documents.")) @@ -77,11 +79,14 @@ def update_global_search_doctypes(): if dt not in doctype_list: continue - global_search_settings.append("allowed_in_global_search", { - "document_type": dt - }) + global_search_settings.append("allowed_in_global_search", {"document_type": dt}) global_search_settings.save(ignore_permissions=True) show_message(3, "Global Search Documents have been reset.") + def show_message(progress, msg): - frappe.publish_realtime('global_search_settings', {"progress":progress, "total":3, "msg": msg}, user=frappe.session.user) + frappe.publish_realtime( + "global_search_settings", + {"progress": progress, "total": 3, "msg": msg}, + user=frappe.session.user, + ) diff --git a/frappe/desk/doctype/kanban_board/kanban_board.py b/frappe/desk/doctype/kanban_board/kanban_board.py index 97f529a061..ed936bb79e 100644 --- a/frappe/desk/doctype/kanban_board/kanban_board.py +++ b/frappe/desk/doctype/kanban_board/kanban_board.py @@ -2,8 +2,9 @@ # Copyright (c) 2015, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe import json + +import frappe from frappe import _ from frappe.model.document import Document @@ -24,14 +25,17 @@ class KanbanBoard(Document): if not column.column_name: frappe.msgprint(frappe._("Column Name cannot be empty"), raise_exception=True) + def get_permission_query_conditions(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user if user == "Administrator": return "" return """(`tabKanban Board`.private=0 or `tabKanban Board`.owner='{user}')""".format(user=user) + def has_permission(doc, ptype, user): if doc.private == 0 or user == "Administrator": return True @@ -41,32 +45,33 @@ def has_permission(doc, ptype, user): return False + @frappe.whitelist() def get_kanban_boards(doctype): - '''Get Kanban Boards for doctype to show in List View''' - return frappe.get_list('Kanban Board', - fields=['name', 'filters', 'reference_doctype', 'private'], - filters={ 'reference_doctype': doctype } + """Get Kanban Boards for doctype to show in List View""" + return frappe.get_list( + "Kanban Board", + fields=["name", "filters", "reference_doctype", "private"], + filters={"reference_doctype": doctype}, ) + @frappe.whitelist() def add_column(board_name, column_title): - '''Adds new column to Kanban Board''' + """Adds new column to Kanban Board""" doc = frappe.get_doc("Kanban Board", board_name) for col in doc.columns: if column_title == col.column_name: frappe.throw(_("Column {0} already exist.").format(column_title)) - doc.append("columns", dict( - column_name=column_title - )) + doc.append("columns", dict(column_name=column_title)) doc.save() return doc.columns @frappe.whitelist() def archive_restore_column(board_name, column_title, status): - '''Set column's status to status''' + """Set column's status to status""" doc = frappe.get_doc("Kanban Board", board_name) for col in doc.columns: if column_title == col.column_name: @@ -78,8 +83,8 @@ def archive_restore_column(board_name, column_title, status): @frappe.whitelist() def update_order(board_name, order): - '''Save the order of cards in columns''' - board = frappe.get_doc('Kanban Board', board_name) + """Save the order of cards in columns""" + board = frappe.get_doc("Kanban Board", board_name) doctype = board.reference_doctype fieldname = board.field_name order_dict = json.loads(order) @@ -88,17 +93,10 @@ def update_order(board_name, order): for col_name, cards in order_dict.items(): order_list = [] for card in cards: - column = frappe.get_value( - doctype, - {'name': card}, - fieldname - ) + column = frappe.get_value(doctype, {"name": card}, fieldname) if column != col_name: frappe.set_value(doctype, card, fieldname, col_name) - updated_cards.append(dict( - name=card, - column=col_name - )) + updated_cards.append(dict(name=card, column=col_name)) for column in board.columns: if column.column_name == col_name: @@ -107,10 +105,13 @@ def update_order(board_name, order): board.save() return board, updated_cards + @frappe.whitelist() -def update_order_for_single_card(board_name, docname, from_colname, to_colname, old_index, new_index): - '''Save the order of cards in columns''' - board = frappe.get_doc('Kanban Board', board_name) +def update_order_for_single_card( + board_name, docname, from_colname, to_colname, old_index, new_index +): + """Save the order of cards in columns""" + board = frappe.get_doc("Kanban Board", board_name) doctype = board.reference_doctype fieldname = board.field_name old_index = frappe.parse_json(old_index) @@ -135,6 +136,7 @@ def update_order_for_single_card(board_name, docname, from_colname, to_colname, return board + def get_kanban_column_order_and_index(board, colname): for i, col in enumerate(board.columns): if col.column_name == colname: @@ -143,9 +145,10 @@ def get_kanban_column_order_and_index(board, colname): return col_order, col_idx + @frappe.whitelist() def add_card(board_name, docname, colname): - board = frappe.get_doc('Kanban Board', board_name) + board = frappe.get_doc("Kanban Board", board_name) col_order, col_idx = get_kanban_column_order_and_index(board, colname) col_order.insert(0, docname) @@ -155,11 +158,12 @@ def add_card(board_name, docname, colname): board.save() return board + @frappe.whitelist() def quick_kanban_board(doctype, board_name, field_name, project=None): - '''Create new KanbanBoard quickly with default options''' + """Create new KanbanBoard quickly with default options""" - doc = frappe.new_doc('Kanban Board') + doc = frappe.new_doc("Kanban Board") meta = frappe.get_meta(doctype) doc.kanban_board_name = board_name @@ -169,40 +173,39 @@ def quick_kanban_board(doctype, board_name, field_name, project=None): if project: doc.filters = '[["Task","project","=","{0}"]]'.format(project) - options = '' + options = "" for field in meta.fields: if field.fieldname == field_name: options = field.options columns = [] if options: - columns = options.split('\n') + columns = options.split("\n") for column in columns: if not column: continue - doc.append("columns", dict( - column_name=column - )) - + doc.append("columns", dict(column_name=column)) - if doctype in ['Note', 'ToDo']: + if doctype in ["Note", "ToDo"]: doc.private = 1 doc.save() return doc + def get_order_for_column(board, colname): - filters = [[board.reference_doctype, board.field_name, '=', colname]] + filters = [[board.reference_doctype, board.field_name, "=", colname]] if board.filters: filters.append(frappe.parse_json(board.filters)[0]) - return frappe.as_json(frappe.get_list(board.reference_doctype, filters=filters, pluck='name')) + return frappe.as_json(frappe.get_list(board.reference_doctype, filters=filters, pluck="name")) + @frappe.whitelist() def update_column_order(board_name, order): - '''Set the order of columns in Kanban Board''' - board = frappe.get_doc('Kanban Board', board_name) + """Set the order of columns in Kanban Board""" + board = frappe.get_doc("Kanban Board", board_name) order = json.loads(order) old_columns = board.columns new_columns = [] @@ -217,20 +220,24 @@ def update_column_order(board_name, order): board.columns = [] for col in new_columns: - board.append("columns", dict( - column_name=col.column_name, - status=col.status, - order=col.order, - indicator=col.indicator, - )) + board.append( + "columns", + dict( + column_name=col.column_name, + status=col.status, + order=col.order, + indicator=col.indicator, + ), + ) board.save() return board + @frappe.whitelist() def set_indicator(board_name, column_name, indicator): - '''Set the indicator color of column''' - board = frappe.get_doc('Kanban Board', board_name) + """Set the indicator color of column""" + board = frappe.get_doc("Kanban Board", board_name) for column in board.columns: if column.column_name == column_name: @@ -242,6 +249,5 @@ def set_indicator(board_name, column_name, indicator): @frappe.whitelist() def save_filters(board_name, filters): - '''Save filters silently''' - frappe.db.set_value('Kanban Board', board_name, 'filters', - filters, update_modified=False) + """Save filters silently""" + frappe.db.set_value("Kanban Board", board_name, "filters", filters, update_modified=False) diff --git a/frappe/desk/doctype/kanban_board/test_kanban_board.py b/frappe/desk/doctype/kanban_board/test_kanban_board.py index f00446141a..179e6c71e5 100644 --- a/frappe/desk/doctype/kanban_board/test_kanban_board.py +++ b/frappe/desk/doctype/kanban_board/test_kanban_board.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Kanban Board') + class TestKanbanBoard(unittest.TestCase): pass diff --git a/frappe/desk/doctype/kanban_board_column/kanban_board_column.py b/frappe/desk/doctype/kanban_board_column/kanban_board_column.py index d919fd6aed..8a1f839c98 100644 --- a/frappe/desk/doctype/kanban_board_column/kanban_board_column.py +++ b/frappe/desk/doctype/kanban_board_column/kanban_board_column.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class KanbanBoardColumn(Document): pass diff --git a/frappe/desk/doctype/list_filter/list_filter.py b/frappe/desk/doctype/list_filter/list_filter.py index d2b01d301e..ac434a760a 100644 --- a/frappe/desk/doctype/list_filter/list_filter.py +++ b/frappe/desk/doctype/list_filter/list_filter.py @@ -2,8 +2,11 @@ # Copyright (c) 2018, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe, json +import json + +import frappe from frappe.model.document import Document + class ListFilter(Document): pass diff --git a/frappe/desk/doctype/list_view_settings/list_view_settings.py b/frappe/desk/doctype/list_view_settings/list_view_settings.py index 78b56fe7d5..7d25f57acf 100644 --- a/frappe/desk/doctype/list_view_settings/list_view_settings.py +++ b/frappe/desk/doctype/list_view_settings/list_view_settings.py @@ -5,11 +5,12 @@ import frappe from frappe.model.document import Document -class ListViewSettings(Document): +class ListViewSettings(Document): def on_update(self): frappe.clear_document_cache(self.doctype, self.name) + @frappe.whitelist() def save_listview_settings(doctype, listview_settings, removed_listview_fields): @@ -28,15 +29,15 @@ def save_listview_settings(doctype, listview_settings, removed_listview_fields): set_listview_fields(doctype, listview_settings.get("fields"), removed_listview_fields) - return { - "meta": frappe.get_meta(doctype, False), - "listview_settings": doc - } + return {"meta": frappe.get_meta(doctype, False), "listview_settings": doc} + def set_listview_fields(doctype, listview_fields, removed_listview_fields): meta = frappe.get_meta(doctype) - listview_fields = [f.get("fieldname") for f in frappe.parse_json(listview_fields) if f.get("fieldname")] + listview_fields = [ + f.get("fieldname") for f in frappe.parse_json(listview_fields) if f.get("fieldname") + ] for field in removed_listview_fields: set_in_list_view_property(doctype, meta.get_field(field), "0") @@ -44,29 +45,39 @@ def set_listview_fields(doctype, listview_fields, removed_listview_fields): for field in listview_fields: set_in_list_view_property(doctype, meta.get_field(field), "1") + def set_in_list_view_property(doctype, field, value): if not field or field.fieldname == "status_field": return - property_setter = frappe.db.get_value("Property Setter", {"doc_type": doctype, "field_name": field.fieldname, "property": "in_list_view"}) + property_setter = frappe.db.get_value( + "Property Setter", + {"doc_type": doctype, "field_name": field.fieldname, "property": "in_list_view"}, + ) if property_setter: doc = frappe.get_doc("Property Setter", property_setter) doc.value = value doc.save() else: - frappe.make_property_setter({ - "doctype": doctype, - "doctype_or_field": "DocField", - "fieldname": field.fieldname, - "property": "in_list_view", - "value": value, - "property_type": "Check" - }, ignore_validate=True) + frappe.make_property_setter( + { + "doctype": doctype, + "doctype_or_field": "DocField", + "fieldname": field.fieldname, + "property": "in_list_view", + "value": value, + "property_type": "Check", + }, + ignore_validate=True, + ) + @frappe.whitelist() def get_default_listview_fields(doctype): meta = frappe.get_meta(doctype) - path = frappe.get_module_path(frappe.scrub(meta.module), "doctype", frappe.scrub(meta.name), frappe.scrub(meta.name) + ".json") + path = frappe.get_module_path( + frappe.scrub(meta.module), "doctype", frappe.scrub(meta.name), frappe.scrub(meta.name) + ".json" + ) doctype_json = frappe.get_file_json(path) fields = [f.get("fieldname") for f in doctype_json.get("fields") if f.get("in_list_view")] diff --git a/frappe/desk/doctype/list_view_settings/test_list_view_settings.py b/frappe/desk/doctype/list_view_settings/test_list_view_settings.py index 85872dd36e..0b6a0773e3 100644 --- a/frappe/desk/doctype/list_view_settings/test_list_view_settings.py +++ b/frappe/desk/doctype/list_view_settings/test_list_view_settings.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestListViewSettings(unittest.TestCase): pass diff --git a/frappe/desk/doctype/module_onboarding/module_onboarding.py b/frappe/desk/doctype/module_onboarding/module_onboarding.py index aa268c792c..7a12328ee0 100644 --- a/frappe/desk/doctype/module_onboarding/module_onboarding.py +++ b/frappe/desk/doctype/module_onboarding/module_onboarding.py @@ -10,10 +10,10 @@ from frappe.modules.export_file import export_to_files class ModuleOnboarding(Document): def on_update(self): if frappe.conf.developer_mode: - export_to_files(record_list=[['Module Onboarding', self.name]], record_module=self.module) + export_to_files(record_list=[["Module Onboarding", self.name]], record_module=self.module) for step in self.steps: - export_to_files(record_list=[['Onboarding Step', step.step]], record_module=self.module) + export_to_files(record_list=[["Onboarding Step", step.step]], record_module=self.module) def get_steps(self): return [frappe.get_doc("Onboarding Step", step.step) for step in self.steps] diff --git a/frappe/desk/doctype/module_onboarding/test_module_onboarding.py b/frappe/desk/doctype/module_onboarding/test_module_onboarding.py index 42f472abc1..8def3ac40e 100644 --- a/frappe/desk/doctype/module_onboarding/test_module_onboarding.py +++ b/frappe/desk/doctype/module_onboarding/test_module_onboarding.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestModuleOnboarding(unittest.TestCase): pass diff --git a/frappe/desk/doctype/note/note.py b/frappe/desk/doctype/note/note.py index ae7af07cd9..de019d9898 100644 --- a/frappe/desk/doctype/note/note.py +++ b/frappe/desk/doctype/note/note.py @@ -4,10 +4,12 @@ import frappe from frappe.model.document import Document + class Note(Document): def autoname(self): # replace forbidden characters import re + self.name = re.sub("[%'\"#*?`]", "", self.title.strip()) def validate(self): @@ -20,21 +22,25 @@ class Note(Document): self.print_heading = self.name self.sub_heading = "" + @frappe.whitelist() def mark_as_seen(note): - note = frappe.get_doc('Note', note) + note = frappe.get_doc("Note", note) if frappe.session.user not in [d.user for d in note.seen_by]: - note.append('seen_by', {'user': frappe.session.user}) + note.append("seen_by", {"user": frappe.session.user}) note.save(ignore_version=True) + def get_permission_query_conditions(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user if user == "Administrator": return "" return """(`tabNote`.public=1 or `tabNote`.owner="{user}")""".format(user=user) + def has_permission(doc, ptype, user): if doc.public == 1 or user == "Administrator": return True diff --git a/frappe/desk/doctype/note/test_note.py b/frappe/desk/doctype/note/test_note.py index ac2116c38a..d8bdb9efc4 100644 --- a/frappe/desk/doctype/note/test_note.py +++ b/frappe/desk/doctype/note/test_note.py @@ -1,10 +1,12 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors and Contributors # License: MIT. See LICENSE -import frappe import unittest -test_records = frappe.get_test_records('Note') +import frappe + +test_records = frappe.get_test_records("Note") + class TestNote(unittest.TestCase): def insert_note(self): @@ -12,64 +14,65 @@ class TestNote(unittest.TestCase): frappe.db.delete("Note") frappe.db.delete("Note Seen By") - return frappe.get_doc(dict(doctype='Note', title='test note', - content='test note content')).insert() + return frappe.get_doc( + dict(doctype="Note", title="test note", content="test note content") + ).insert() def test_version(self): note = self.insert_note() - note.title = 'test note 1' - note.content = '1' + note.title = "test note 1" + note.content = "1" note.save(ignore_version=False) - version = frappe.get_doc('Version', dict(docname=note.name)) + version = frappe.get_doc("Version", dict(docname=note.name)) data = version.get_data() - self.assertTrue(('title', 'test note', 'test note 1'), data['changed']) - self.assertTrue(('content', 'test note content', '1'), data['changed']) + self.assertTrue(("title", "test note", "test note 1"), data["changed"]) + self.assertTrue(("content", "test note content", "1"), data["changed"]) def test_rows(self): note = self.insert_note() # test add - note.append('seen_by', {'user': 'Administrator'}) + note.append("seen_by", {"user": "Administrator"}) note.save(ignore_version=False) - version = frappe.get_doc('Version', dict(docname=note.name)) + version = frappe.get_doc("Version", dict(docname=note.name)) data = version.get_data() - self.assertEqual(len(data.get('added')), 1) - self.assertEqual(len(data.get('removed')), 0) - self.assertEqual(len(data.get('changed')), 0) + self.assertEqual(len(data.get("added")), 1) + self.assertEqual(len(data.get("removed")), 0) + self.assertEqual(len(data.get("changed")), 0) - for row in data.get('added'): - self.assertEqual(row[0], 'seen_by') - self.assertEqual(row[1]['user'], 'Administrator') + for row in data.get("added"): + self.assertEqual(row[0], "seen_by") + self.assertEqual(row[1]["user"], "Administrator") # test row change - note.seen_by[0].user = 'Guest' + note.seen_by[0].user = "Guest" note.save(ignore_version=False) - version = frappe.get_doc('Version', dict(docname=note.name)) + version = frappe.get_doc("Version", dict(docname=note.name)) data = version.get_data() - self.assertEqual(len(data.get('row_changed')), 1) - for row in data.get('row_changed'): - self.assertEqual(row[0], 'seen_by') + self.assertEqual(len(data.get("row_changed")), 1) + for row in data.get("row_changed"): + self.assertEqual(row[0], "seen_by") self.assertEqual(row[1], 0) self.assertEqual(row[2], note.seen_by[0].name) - self.assertEqual(row[3], [['user', 'Administrator', 'Guest']]) + self.assertEqual(row[3], [["user", "Administrator", "Guest"]]) # test remove note.seen_by = [] note.save(ignore_version=False) - version = frappe.get_doc('Version', dict(docname=note.name)) + version = frappe.get_doc("Version", dict(docname=note.name)) data = version.get_data() - self.assertEqual(len(data.get('removed')), 1) - for row in data.get('removed'): - self.assertEqual(row[0], 'seen_by') - self.assertEqual(row[1]['user'], 'Guest') + self.assertEqual(len(data.get("removed")), 1) + for row in data.get("removed"): + self.assertEqual(row[0], "seen_by") + self.assertEqual(row[1]["user"], "Guest") # self.assertTrue(('title', 'test note', 'test note 1'), data['changed']) # self.assertTrue(('content', 'test note content', '1'), data['changed']) diff --git a/frappe/desk/doctype/note_seen_by/note_seen_by.py b/frappe/desk/doctype/note_seen_by/note_seen_by.py index 01bee05a9f..7b87cf13b2 100644 --- a/frappe/desk/doctype/note_seen_by/note_seen_by.py +++ b/frappe/desk/doctype/note_seen_by/note_seen_by.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class NoteSeenBy(Document): pass diff --git a/frappe/desk/doctype/notification_log/notification_log.py b/frappe/desk/doctype/notification_log/notification_log.py index 12e628ada2..1a466ea78b 100644 --- a/frappe/desk/doctype/notification_log/notification_log.py +++ b/frappe/desk/doctype/notification_log/notification_log.py @@ -4,12 +4,17 @@ import frappe from frappe import _ +from frappe.desk.doctype.notification_settings.notification_settings import ( + is_email_notifications_enabled_for_type, + is_notifications_enabled, + set_seen_value, +) from frappe.model.document import Document -from frappe.desk.doctype.notification_settings.notification_settings import (is_notifications_enabled, is_email_notifications_enabled_for_type, set_seen_value) + class NotificationLog(Document): def after_insert(self): - frappe.publish_realtime('notification', after_commit=True, user=self.for_user) + frappe.publish_realtime("notification", after_commit=True, user=self.for_user) set_notifications_as_unseen(self.for_user) if is_email_notifications_enabled_for_type(self.for_user, self.type): try: @@ -22,61 +27,67 @@ def get_permission_query_conditions(for_user): if not for_user: for_user = frappe.session.user - if for_user == 'Administrator': + if for_user == "Administrator": return - return '''(`tabNotification Log`.for_user = '{user}')'''.format(user=for_user) + return """(`tabNotification Log`.for_user = '{user}')""".format(user=for_user) + def get_title(doctype, docname, title_field=None): if not title_field: title_field = frappe.get_meta(doctype).get_title_field() - title = docname if title_field == "name" else \ - frappe.db.get_value(doctype, docname, title_field) + title = docname if title_field == "name" else frappe.db.get_value(doctype, docname, title_field) return title + def get_title_html(title): return '{0}'.format(title) + def enqueue_create_notification(users, doc): - ''' + """ During installation of new site, enqueue_create_notification tries to connect to Redis. This breaks new site creation if Redis server is not running. We do not need any notifications in fresh installation - ''' + """ if frappe.flags.in_install: return doc = frappe._dict(doc) if isinstance(users, str): - users = [user.strip() for user in users.split(',') if user.strip()] + users = [user.strip() for user in users.split(",") if user.strip()] users = list(set(users)) frappe.enqueue( - 'frappe.desk.doctype.notification_log.notification_log.make_notification_logs', + "frappe.desk.doctype.notification_log.notification_log.make_notification_logs", doc=doc, users=users, - now=frappe.flags.in_test + now=frappe.flags.in_test, ) + def make_notification_logs(doc, users): - from frappe.social.doctype.energy_point_settings.energy_point_settings import is_energy_point_enabled + from frappe.social.doctype.energy_point_settings.energy_point_settings import ( + is_energy_point_enabled, + ) for user in users: - if frappe.db.exists('User', {"email": user, "enabled": 1}): + if frappe.db.exists("User", {"email": user, "enabled": 1}): if is_notifications_enabled(user): - if doc.type == 'Energy Point' and not is_energy_point_enabled(): + if doc.type == "Energy Point" and not is_energy_point_enabled(): return - _doc = frappe.new_doc('Notification Log') + _doc = frappe.new_doc("Notification Log") _doc.update(doc) _doc.for_user = user - if _doc.for_user != _doc.from_user or doc.type == 'Energy Point' or doc.type == 'Alert': + if _doc.for_user != _doc.from_user or doc.type == "Energy Point" or doc.type == "Alert": _doc.insert(ignore_permissions=True) + def send_notification_email(doc): - if doc.type == 'Energy Point' and doc.email_content is None: + if doc.type == "Energy Point" and doc.email_content is None: return from frappe.utils import get_url_to_form, strip_html @@ -86,52 +97,58 @@ def send_notification_email(doc): email_subject = strip_html(doc.subject) frappe.sendmail( - recipients = doc.for_user, - subject = email_subject, - template = "new_notification", - args = { - 'body_content': doc.subject, - 'description': doc.email_content, - 'document_type': doc.document_type, - 'document_name': doc.document_name, - 'doc_link': doc_link + recipients=doc.for_user, + subject=email_subject, + template="new_notification", + args={ + "body_content": doc.subject, + "description": doc.email_content, + "document_type": doc.document_type, + "document_name": doc.document_name, + "doc_link": doc_link, }, - header = [header, 'orange'], - now=frappe.flags.in_test + header=[header, "orange"], + now=frappe.flags.in_test, ) + def get_email_header(doc): docname = doc.document_name header_map = { - 'Default': _('New Notification'), - 'Mention': _('New Mention on {0}').format(docname), - 'Assignment': _('Assignment Update on {0}').format(docname), - 'Share': _('New Document Shared {0}').format(docname), - 'Energy Point': _('Energy Point Update on {0}').format(docname), + "Default": _("New Notification"), + "Mention": _("New Mention on {0}").format(docname), + "Assignment": _("Assignment Update on {0}").format(docname), + "Share": _("New Document Shared {0}").format(docname), + "Energy Point": _("Energy Point Update on {0}").format(docname), } - return header_map[doc.type or 'Default'] + return header_map[doc.type or "Default"] + @frappe.whitelist() def mark_all_as_read(): - unread_docs_list = frappe.db.get_all('Notification Log', filters = {'read': 0, 'for_user': frappe.session.user}) + unread_docs_list = frappe.db.get_all( + "Notification Log", filters={"read": 0, "for_user": frappe.session.user} + ) unread_docnames = [doc.name for doc in unread_docs_list] if unread_docnames: - filters = {'name': ['in', unread_docnames]} - frappe.db.set_value('Notification Log', filters, 'read', 1, update_modified=False) + filters = {"name": ["in", unread_docnames]} + frappe.db.set_value("Notification Log", filters, "read", 1, update_modified=False) @frappe.whitelist() def mark_as_read(docname): if docname: - frappe.db.set_value('Notification Log', docname, 'read', 1, update_modified=False) + frappe.db.set_value("Notification Log", docname, "read", 1, update_modified=False) + @frappe.whitelist() def trigger_indicator_hide(): - frappe.publish_realtime('indicator_hide', user=frappe.session.user) + frappe.publish_realtime("indicator_hide", user=frappe.session.user) + def set_notifications_as_unseen(user): try: - frappe.db.set_value('Notification Settings', user, 'seen', 0) + frappe.db.set_value("Notification Settings", user, "seen", 0) except frappe.DoesNotExistError: return diff --git a/frappe/desk/doctype/notification_log/test_notification_log.py b/frappe/desk/doctype/notification_log/test_notification_log.py index 4c415a860c..44b1b53ead 100644 --- a/frappe/desk/doctype/notification_log/test_notification_log.py +++ b/frappe/desk/doctype/notification_log/test_notification_log.py @@ -1,58 +1,55 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE +import unittest + import frappe from frappe.core.doctype.user.user import get_system_users from frappe.desk.form.assign_to import add as assign_task -import unittest + class TestNotificationLog(unittest.TestCase): def test_assignment(self): todo = get_todo() user = get_user() - assign_task({ - "assign_to": [user], - "doctype": 'ToDo', - "name": todo.name, - "description": todo.description - }) - log_type = frappe.db.get_value('Notification Log', { - 'document_type': 'ToDo', - 'document_name': todo.name - }, 'type') - self.assertEqual(log_type, 'Assignment') + assign_task( + {"assign_to": [user], "doctype": "ToDo", "name": todo.name, "description": todo.description} + ) + log_type = frappe.db.get_value( + "Notification Log", {"document_type": "ToDo", "document_name": todo.name}, "type" + ) + self.assertEqual(log_type, "Assignment") def test_share(self): todo = get_todo() user = get_user() - frappe.share.add('ToDo', todo.name, user, notify=1) - log_type = frappe.db.get_value('Notification Log', { - 'document_type': 'ToDo', - 'document_name': todo.name - }, 'type') - self.assertEqual(log_type, 'Share') + frappe.share.add("ToDo", todo.name, user, notify=1) + log_type = frappe.db.get_value( + "Notification Log", {"document_type": "ToDo", "document_name": todo.name}, "type" + ) + self.assertEqual(log_type, "Share") email = get_last_email_queue() - content = 'Subject: {} shared a document ToDo'.format(frappe.utils.get_fullname(frappe.session.user)) + content = "Subject: {} shared a document ToDo".format( + frappe.utils.get_fullname(frappe.session.user) + ) self.assertTrue(content in email.message) def get_last_email_queue(): - res = frappe.db.get_all('Email Queue', - fields=['message'], - order_by='creation desc', - limit=1 - ) + res = frappe.db.get_all("Email Queue", fields=["message"], order_by="creation desc", limit=1) return res[0] + def get_todo(): - if not frappe.get_all('ToDo'): - return frappe.get_doc({ 'doctype': 'ToDo', 'description': 'Test for Notification' }).insert() + if not frappe.get_all("ToDo"): + return frappe.get_doc({"doctype": "ToDo", "description": "Test for Notification"}).insert() + + res = frappe.get_all("ToDo", limit=1) + return frappe.get_cached_doc("ToDo", res[0].name) - res = frappe.get_all('ToDo', limit=1) - return frappe.get_cached_doc('ToDo', res[0].name) def get_user(): return get_system_users(limit=1)[0] diff --git a/frappe/desk/doctype/notification_settings/notification_settings.py b/frappe/desk/doctype/notification_settings/notification_settings.py index cf6bb2d78d..bbb4a62154 100644 --- a/frappe/desk/doctype/notification_settings/notification_settings.py +++ b/frappe/desk/doctype/notification_settings/notification_settings.py @@ -5,47 +5,52 @@ import frappe from frappe.model.document import Document + class NotificationSettings(Document): def on_update(self): from frappe.desk.notifications import clear_notification_config + clear_notification_config(frappe.session.user) def is_notifications_enabled(user): - enabled = frappe.db.get_value('Notification Settings', user, 'enabled') + enabled = frappe.db.get_value("Notification Settings", user, "enabled") if enabled is None: return True return enabled + def is_email_notifications_enabled(user): - enabled = frappe.db.get_value('Notification Settings', user, 'enable_email_notifications') + enabled = frappe.db.get_value("Notification Settings", user, "enable_email_notifications") if enabled is None: return True return enabled + def is_email_notifications_enabled_for_type(user, notification_type): if not is_email_notifications_enabled(user): return False - if notification_type == 'Alert': + if notification_type == "Alert": return False - fieldname = 'enable_email_' + frappe.scrub(notification_type) - enabled = frappe.db.get_value('Notification Settings', user, fieldname) + fieldname = "enable_email_" + frappe.scrub(notification_type) + enabled = frappe.db.get_value("Notification Settings", user, fieldname) if enabled is None: return True return enabled + def create_notification_settings(user): if not frappe.db.exists("Notification Settings", user): - _doc = frappe.new_doc('Notification Settings') + _doc = frappe.new_doc("Notification Settings") _doc.name = user _doc.insert(ignore_permissions=True) def toggle_notifications(user, enable=False): if frappe.db.exists("Notification Settings", user): - frappe.db.set_value("Notification Settings", user, 'enabled', enable) + frappe.db.set_value("Notification Settings", user, "enabled", enable) @frappe.whitelist() @@ -54,8 +59,8 @@ def get_subscribed_documents(): return [] try: - if frappe.db.exists('Notification Settings', frappe.session.user): - doc = frappe.get_doc('Notification Settings', frappe.session.user) + if frappe.db.exists("Notification Settings", frappe.session.user): + doc = frappe.get_doc("Notification Settings", frappe.session.user) return [item.document for item in doc.subscribed_documents] # Notification Settings is fetched even before sync doctype is called # but it will throw an ImportError, we can ignore it in migrate @@ -66,17 +71,19 @@ def get_subscribed_documents(): def get_permission_query_conditions(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user - if user == 'Administrator': + if user == "Administrator": return roles = frappe.get_roles(user) if "System Manager" in roles: - return '''(`tabNotification Settings`.name != 'Administrator')''' + return """(`tabNotification Settings`.name != 'Administrator')""" + + return """(`tabNotification Settings`.name = '{user}')""".format(user=user) - return '''(`tabNotification Settings`.name = '{user}')'''.format(user=user) @frappe.whitelist() def set_seen_value(value, user): - frappe.db.set_value('Notification Settings', user, 'seen', value, update_modified=False) + frappe.db.set_value("Notification Settings", user, "seen", value, update_modified=False) diff --git a/frappe/desk/doctype/notification_settings/test_notification_settings.py b/frappe/desk/doctype/notification_settings/test_notification_settings.py index e3dac0af5f..966b923567 100644 --- a/frappe/desk/doctype/notification_settings/test_notification_settings.py +++ b/frappe/desk/doctype/notification_settings/test_notification_settings.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestNotificationSettings(unittest.TestCase): pass diff --git a/frappe/desk/doctype/notification_subscribed_document/notification_subscribed_document.py b/frappe/desk/doctype/notification_subscribed_document/notification_subscribed_document.py index 1fdba22779..b72f827cd7 100644 --- a/frappe/desk/doctype/notification_subscribed_document/notification_subscribed_document.py +++ b/frappe/desk/doctype/notification_subscribed_document/notification_subscribed_document.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class NotificationSubscribedDocument(Document): pass diff --git a/frappe/desk/doctype/number_card/number_card.py b/frappe/desk/doctype/number_card/number_card.py index 784f46bb19..370b187ffe 100644 --- a/frappe/desk/doctype/number_card/number_card.py +++ b/frappe/desk/doctype/number_card/number_card.py @@ -4,11 +4,12 @@ import frappe from frappe import _ +from frappe.config import get_modules_from_all_apps_for_user from frappe.model.document import Document -from frappe.utils import cint from frappe.model.naming import append_number_if_name_exists from frappe.modules.export_file import export_to_files -from frappe.config import get_modules_from_all_apps_for_user +from frappe.utils import cint + class NumberCard(Document): def autoname(self): @@ -16,24 +17,29 @@ class NumberCard(Document): self.name = self.label if frappe.db.exists("Number Card", self.name): - self.name = append_number_if_name_exists('Number Card', self.name) + self.name = append_number_if_name_exists("Number Card", self.name) def validate(self): if not self.document_type: frappe.throw(_("Document type is required to create a number card")) - if self.document_type and frappe.get_meta(self.document_type).istable and not self.parent_document_type: + if ( + self.document_type + and frappe.get_meta(self.document_type).istable + and not self.parent_document_type + ): frappe.throw(_("Parent document type is required to create a number card")) def on_update(self): if frappe.conf.developer_mode and self.is_standard: - export_to_files(record_list=[['Number Card', self.name]], record_module=self.module) + export_to_files(record_list=[["Number Card", self.name]], record_module=self.module) + def get_permission_query_conditions(user=None): if not user: user = frappe.session.user - if user == 'Administrator': + if user == "Administrator": return roles = frappe.get_roles(user) @@ -43,22 +49,31 @@ def get_permission_query_conditions(user=None): doctype_condition = False module_condition = False - allowed_doctypes = [frappe.db.escape(doctype) for doctype in frappe.permissions.get_doctypes_with_read()] - allowed_modules = [frappe.db.escape(module.get('module_name')) for module in get_modules_from_all_apps_for_user()] + allowed_doctypes = [ + frappe.db.escape(doctype) for doctype in frappe.permissions.get_doctypes_with_read() + ] + allowed_modules = [ + frappe.db.escape(module.get("module_name")) for module in get_modules_from_all_apps_for_user() + ] if allowed_doctypes: - doctype_condition = '`tabNumber Card`.`document_type` in ({allowed_doctypes})'.format( - allowed_doctypes=','.join(allowed_doctypes)) + doctype_condition = "`tabNumber Card`.`document_type` in ({allowed_doctypes})".format( + allowed_doctypes=",".join(allowed_doctypes) + ) if allowed_modules: - module_condition = '''`tabNumber Card`.`module` in ({allowed_modules}) - or `tabNumber Card`.`module` is NULL'''.format( - allowed_modules=','.join(allowed_modules)) + module_condition = """`tabNumber Card`.`module` in ({allowed_modules}) + or `tabNumber Card`.`module` is NULL""".format( + allowed_modules=",".join(allowed_modules) + ) - return ''' + return """ {doctype_condition} and {module_condition} - '''.format(doctype_condition=doctype_condition, module_condition=module_condition) + """.format( + doctype_condition=doctype_condition, module_condition=module_condition + ) + def has_permission(doc, ptype, user): roles = frappe.get_roles(user) @@ -71,24 +86,29 @@ def has_permission(doc, ptype, user): return False + @frappe.whitelist() def get_result(doc, filters, to_date=None): doc = frappe.parse_json(doc) fields = [] sql_function_map = { - 'Count': 'count', - 'Sum': 'sum', - 'Average': 'avg', - 'Minimum': 'min', - 'Maximum': 'max' + "Count": "count", + "Sum": "sum", + "Average": "avg", + "Minimum": "min", + "Maximum": "max", } function = sql_function_map[doc.function] - if function == 'count': - fields = ['{function}(*) as result'.format(function=function)] + if function == "count": + fields = ["{function}(*) as result".format(function=function)] else: - fields = ['{function}({based_on}) as result'.format(function=function, based_on=doc.aggregate_function_based_on)] + fields = [ + "{function}({based_on}) as result".format( + function=function, based_on=doc.aggregate_function_based_on + ) + ] filters = frappe.parse_json(filters) @@ -96,21 +116,22 @@ def get_result(doc, filters, to_date=None): filters = [] if to_date: - filters.append([doc.document_type, 'creation', '<', to_date]) + filters.append([doc.document_type, "creation", "<", to_date]) res = frappe.db.get_list(doc.document_type, fields=fields, filters=filters) - number = res[0]['result'] if res else 0 + number = res[0]["result"] if res else 0 return cint(number) + @frappe.whitelist() def get_percentage_difference(doc, filters, result): doc = frappe.parse_json(doc) result = frappe.parse_json(result) - doc = frappe.get_doc('Number Card', doc.name) + doc = frappe.get_doc("Number Card", doc.name) - if not doc.get('show_percentage_stats'): + if not doc.get("show_percentage_stats"): return previous_result = calculate_previous_result(doc, filters) @@ -120,18 +141,18 @@ def get_percentage_difference(doc, filters, result): if result == previous_result: return 0 else: - return ((result/previous_result)-1)*100.0 + return ((result / previous_result) - 1) * 100.0 def calculate_previous_result(doc, filters): from frappe.utils import add_to_date current_date = frappe.utils.now() - if doc.stats_time_interval == 'Daily': + if doc.stats_time_interval == "Daily": previous_date = add_to_date(current_date, days=-1) - elif doc.stats_time_interval == 'Weekly': + elif doc.stats_time_interval == "Weekly": previous_date = add_to_date(current_date, weeks=-1) - elif doc.stats_time_interval == 'Monthly': + elif doc.stats_time_interval == "Monthly": previous_date = add_to_date(current_date, months=-1) else: previous_date = add_to_date(current_date, years=-1) @@ -139,15 +160,17 @@ def calculate_previous_result(doc, filters): number = get_result(doc, filters, previous_date) return number + @frappe.whitelist() def create_number_card(args): args = frappe.parse_json(args) - doc = frappe.new_doc('Number Card') + doc = frappe.new_doc("Number Card") doc.update(args) doc.insert(ignore_permissions=True) return doc + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_cards_for_user(doctype, txt, searchfield, start, page_len, filters): @@ -155,21 +178,23 @@ def get_cards_for_user(doctype, txt, searchfield, start, page_len, filters): searchfields = meta.get_search_fields() search_conditions = [] - if not frappe.db.exists('DocType', doctype): + if not frappe.db.exists("DocType", doctype): return if txt: for field in searchfields: - search_conditions.append('`tab{doctype}`.`{field}` like %(txt)s'.format(field=field, doctype=doctype, txt=txt)) + search_conditions.append( + "`tab{doctype}`.`{field}` like %(txt)s".format(field=field, doctype=doctype, txt=txt) + ) - search_conditions = ' or '.join(search_conditions) + search_conditions = " or ".join(search_conditions) - search_conditions = 'and (' + search_conditions +')' if search_conditions else '' + search_conditions = "and (" + search_conditions + ")" if search_conditions else "" conditions, values = frappe.db.build_conditions(filters) - values['txt'] = '%' + txt + '%' + values["txt"] = "%" + txt + "%" return frappe.db.sql( - '''select + """select `tabNumber Card`.name, `tabNumber Card`.label, `tabNumber Card`.document_type from `tabNumber Card` @@ -178,12 +203,15 @@ def get_cards_for_user(doctype, txt, searchfield, start, page_len, filters): (`tabNumber Card`.owner = '{user}' or `tabNumber Card`.is_public = 1) {search_conditions} - '''.format( - filters=filters, - user=frappe.session.user, - search_conditions=search_conditions, - conditions=conditions - ), values) + """.format( + filters=filters, + user=frappe.session.user, + search_conditions=search_conditions, + conditions=conditions, + ), + values, + ) + @frappe.whitelist() def create_report_number_card(args): @@ -193,19 +221,20 @@ def create_report_number_card(args): if args.dashboard: add_card_to_dashboard(frappe.as_json(args)) + @frappe.whitelist() def add_card_to_dashboard(args): args = frappe.parse_json(args) - dashboard = frappe.get_doc('Dashboard', args.dashboard) - dashboard_link = frappe.new_doc('Number Card Link') + dashboard = frappe.get_doc("Dashboard", args.dashboard) + dashboard_link = frappe.new_doc("Number Card Link") dashboard_link.card = args.name if args.set_standard and dashboard.is_standard: - card = frappe.get_doc('Number Card', dashboard_link.card) + card = frappe.get_doc("Number Card", dashboard_link.card) card.is_standard = 1 card.module = dashboard.module card.save() - dashboard.append('cards', dashboard_link) + dashboard.append("cards", dashboard_link) dashboard.save() diff --git a/frappe/desk/doctype/number_card/test_number_card.py b/frappe/desk/doctype/number_card/test_number_card.py index cc92e63341..817ea2fad4 100644 --- a/frappe/desk/doctype/number_card/test_number_card.py +++ b/frappe/desk/doctype/number_card/test_number_card.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestNumberCard(unittest.TestCase): pass diff --git a/frappe/desk/doctype/number_card_link/number_card_link.py b/frappe/desk/doctype/number_card_link/number_card_link.py index 0b55ae6dcd..b630d7caa7 100644 --- a/frappe/desk/doctype/number_card_link/number_card_link.py +++ b/frappe/desk/doctype/number_card_link/number_card_link.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class NumberCardLink(Document): pass diff --git a/frappe/desk/doctype/onboarding_permission/test_onboarding_permission.py b/frappe/desk/doctype/onboarding_permission/test_onboarding_permission.py index c13fb29678..9a12b0aab9 100644 --- a/frappe/desk/doctype/onboarding_permission/test_onboarding_permission.py +++ b/frappe/desk/doctype/onboarding_permission/test_onboarding_permission.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestOnboardingPermission(unittest.TestCase): pass diff --git a/frappe/desk/doctype/onboarding_step/onboarding_step.py b/frappe/desk/doctype/onboarding_step/onboarding_step.py index 45e0ca34fd..4a4d487cc8 100644 --- a/frappe/desk/doctype/onboarding_step/onboarding_step.py +++ b/frappe/desk/doctype/onboarding_step/onboarding_step.py @@ -2,11 +2,13 @@ # Copyright (c) 2020, Frappe Technologies and contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ -import json from frappe.model.document import Document + class OnboardingStep(Document): def before_export(self, doc): doc.is_complete = 0 @@ -17,11 +19,13 @@ class OnboardingStep(Document): def get_onboarding_steps(ob_steps): steps = [] for s in json.loads(ob_steps): - doc = frappe.get_doc('Onboarding Step', s.get('step')) + doc = frappe.get_doc("Onboarding Step", s.get("step")) step = doc.as_dict().copy() step.label = _(doc.title) if step.action == "Create Entry": - step.is_submittable = frappe.db.get_value("DocType", step.reference_document, 'is_submittable', cache=True) + step.is_submittable = frappe.db.get_value( + "DocType", step.reference_document, "is_submittable", cache=True + ) steps.append(step) return steps diff --git a/frappe/desk/doctype/onboarding_step/test_onboarding_step.py b/frappe/desk/doctype/onboarding_step/test_onboarding_step.py index b0651da4da..2342656a72 100644 --- a/frappe/desk/doctype/onboarding_step/test_onboarding_step.py +++ b/frappe/desk/doctype/onboarding_step/test_onboarding_step.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestOnboardingStep(unittest.TestCase): pass diff --git a/frappe/desk/doctype/route_history/route_history.py b/frappe/desk/doctype/route_history/route_history.py index bb10fb08f2..082bf84a47 100644 --- a/frappe/desk/doctype/route_history/route_history.py +++ b/frappe/desk/doctype/route_history/route_history.py @@ -4,8 +4,8 @@ import frappe from frappe.deferred_insert import deferred_insert as _deferred_insert from frappe.model.document import Document -from frappe.query_builder.utils import DocType from frappe.query_builder.functions import Count +from frappe.query_builder.utils import DocType class RouteHistory(Document): diff --git a/frappe/desk/doctype/system_console/system_console.json b/frappe/desk/doctype/system_console/system_console.json index 657e9df89d..c92b2005ed 100644 --- a/frappe/desk/doctype/system_console/system_console.json +++ b/frappe/desk/doctype/system_console/system_console.json @@ -1,7 +1,7 @@ { "actions": [ { - "action": "#List/Console Log/List", + "action": "app/console-log", "action_type": "Route", "label": "Logs" }, @@ -86,7 +86,7 @@ "index_web_pages_for_search": 1, "issingle": 1, "links": [], - "modified": "2021-09-15 17:17:44.844767", + "modified": "2022-04-09 16:35:32.345542", "modified_by": "Administrator", "module": "Desk", "name": "System Console", @@ -104,5 +104,6 @@ "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/frappe/desk/doctype/system_console/system_console.py b/frappe/desk/doctype/system_console/system_console.py index bf0925e2d7..ffebfe2dd0 100644 --- a/frappe/desk/doctype/system_console/system_console.py +++ b/frappe/desk/doctype/system_console/system_console.py @@ -5,20 +5,21 @@ import json import frappe -from frappe.utils.safe_exec import safe_exec, read_sql from frappe.model.document import Document +from frappe.utils.safe_exec import read_sql, safe_exec + class SystemConsole(Document): def run(self): - frappe.only_for('System Manager') + frappe.only_for("System Manager") try: frappe.debug_log = [] - if self.type == 'Python': + if self.type == "Python": safe_exec(self.console) - self.output = '\n'.join(frappe.debug_log) - elif self.type == 'SQL': + self.output = "\n".join(frappe.debug_log) + elif self.type == "SQL": self.output = frappe.as_json(read_sql(self.console, as_dict=1)) - except: # noqa: E722 + except: # noqa: E722 self.output = frappe.get_traceback() if self.commit: @@ -26,29 +27,31 @@ class SystemConsole(Document): else: frappe.db.rollback() - frappe.get_doc(dict( - doctype='Console Log', - script=self.console, - output=self.output)).insert() + frappe.get_doc(dict(doctype="Console Log", script=self.console, output=self.output)).insert() frappe.db.commit() + @frappe.whitelist() def execute_code(doc): console = frappe.get_doc(json.loads(doc)) console.run() return console.as_dict() + @frappe.whitelist() def show_processlist(): - frappe.only_for('System Manager') + frappe.only_for("System Manager") - return frappe.db.multisql({ - "postgres": """ + return frappe.db.multisql( + { + "postgres": """ SELECT pid AS "Id", query_start AS "Time", state AS "State", query AS "Info", wait_event AS "Progress" FROM pg_stat_activity""", - "mariadb": "show full processlist" - }, as_dict=True) + "mariadb": "show full processlist", + }, + as_dict=True, + ) diff --git a/frappe/desk/doctype/system_console/test_system_console.py b/frappe/desk/doctype/system_console/test_system_console.py index fa7c577faa..372cbbc1f4 100644 --- a/frappe/desk/doctype/system_console/test_system_console.py +++ b/frappe/desk/doctype/system_console/test_system_console.py @@ -1,18 +1,20 @@ # -*- coding: utf-8 -*- # Copyright (c) 2020, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + + class TestSystemConsole(unittest.TestCase): def test_system_console(self): - system_console = frappe.get_doc('System Console') + system_console = frappe.get_doc("System Console") system_console.console = 'log("hello")' system_console.run() - self.assertEqual(system_console.output, 'hello') + self.assertEqual(system_console.output, "hello") system_console.console = 'log(frappe.db.get_value("DocType", "DocType", "module"))' system_console.run() - self.assertEqual(system_console.output, 'Core') + self.assertEqual(system_console.output, "Core") diff --git a/frappe/desk/doctype/tag/tag.py b/frappe/desk/doctype/tag/tag.py index d44c481210..aabf0351a5 100644 --- a/frappe/desk/doctype/tag/tag.py +++ b/frappe/desk/doctype/tag/tag.py @@ -3,12 +3,14 @@ import frappe from frappe.model.document import Document -from frappe.utils import unique from frappe.query_builder import DocType +from frappe.utils import unique + class Tag(Document): pass + def check_user_tags(dt): "if the user does not have a tags column, then it creates one" try: @@ -18,6 +20,7 @@ def check_user_tags(dt): if frappe.db.is_column_missing(e): DocTags(dt).setup() + @frappe.whitelist() def add_tag(tag, dt, dn, color=None): "adds a new tag to a record, and creates the Tag master" @@ -25,6 +28,7 @@ def add_tag(tag, dt, dn, color=None): return tag + @frappe.whitelist() def add_tags(tags, dt, docs, color=None): "adds a new tag to a record, and creates the Tag master" @@ -36,20 +40,19 @@ def add_tags(tags, dt, docs, color=None): # return tag + @frappe.whitelist() def remove_tag(tag, dt, dn): "removes tag from the record" DocTags(dt).remove(dn, tag) + @frappe.whitelist() def get_tagged_docs(doctype, tag): frappe.has_permission(doctype, throw=True) doctype = DocType(doctype) - return ( - frappe.qb.from_(doctype) - .where(doctype._user_tags.like(tag)) - .select(doctype.name) - ).run() + return (frappe.qb.from_(doctype).where(doctype._user_tags.like(tag)).select(doctype.name)).run() + @frappe.whitelist() def get_tags(doctype, txt): @@ -58,22 +61,24 @@ def get_tags(doctype, txt): return sorted(filter(lambda t: t and txt.lower() in t.lower(), list(set(tags)))) + class DocTags: """Tags for a particular doctype""" + def __init__(self, dt): self.dt = dt def get_tag_fields(self): """returns tag_fields property""" - return frappe.db.get_value('DocType', self.dt, 'tag_fields') + return frappe.db.get_value("DocType", self.dt, "tag_fields") def get_tags(self, dn): """returns tag for a particular item""" - return (frappe.db.get_value(self.dt, dn, '_user_tags', ignore=1) or '').strip() + return (frappe.db.get_value(self.dt, dn, "_user_tags", ignore=1) or "").strip() def add(self, dn, tag): """add a new user tag""" - tl = self.get_tags(dn).split(',') + tl = self.get_tags(dn).split(",") if not tag in tl: tl.append(tag) if not frappe.db.exists("Tag", tag): @@ -82,8 +87,8 @@ class DocTags: def remove(self, dn, tag): """remove a user tag""" - tl = self.get_tags(dn).split(',') - self.update(dn, filter(lambda x:x.lower()!=tag.lower(), tl)) + tl = self.get_tags(dn).split(",") + self.update(dn, filter(lambda x: x.lower() != tag.lower(), tl)) def remove_all(self, dn): """remove all user tags (call before delete)""" @@ -93,14 +98,15 @@ class DocTags: """updates the _user_tag column in the table""" if not tl: - tags = '' + tags = "" else: tl = unique(filter(lambda x: x, tl)) - tags = ',' + ','.join(tl) + tags = "," + ",".join(tl) try: - frappe.db.sql("update `tab%s` set _user_tags=%s where name=%s" % \ - (self.dt,'%s','%s'), (tags , dn)) - doc= frappe.get_doc(self.dt, dn) + frappe.db.sql( + "update `tab%s` set _user_tags=%s where name=%s" % (self.dt, "%s", "%s"), (tags, dn) + ) + doc = frappe.get_doc(self.dt, dn) update_tags(doc, tags) except Exception as e: if frappe.db.is_column_missing(e): @@ -110,26 +116,27 @@ class DocTags: self.setup() self.update(dn, tl) - else: raise + else: + raise def setup(self): """adds the _user_tags column if not exists""" from frappe.database.schema import add_column + add_column(self.dt, "_user_tags", "Data") + def delete_tags_for_document(doc): """ - Delete the Tag Link entry of a document that has - been deleted - :param doc: Deleted document + Delete the Tag Link entry of a document that has + been deleted + :param doc: Deleted document """ if not frappe.db.table_exists("Tag Link"): return - frappe.db.delete("Tag Link", { - "document_type": doc.doctype, - "document_name": doc.name - }) + frappe.db.delete("Tag Link", {"document_type": doc.doctype, "document_name": doc.name}) + def update_tags(doc, tags): """Adds tags for documents @@ -137,50 +144,52 @@ def update_tags(doc, tags): :param doc: Document to be added to global tags """ new_tags = {tag.strip() for tag in tags.split(",") if tag} - existing_tags = [tag.tag for tag in frappe.get_list("Tag Link", filters={ - "document_type": doc.doctype, - "document_name": doc.name - }, fields=["tag"])] + existing_tags = [ + tag.tag + for tag in frappe.get_list( + "Tag Link", filters={"document_type": doc.doctype, "document_name": doc.name}, fields=["tag"] + ) + ] added_tags = set(new_tags) - set(existing_tags) for tag in added_tags: - frappe.get_doc({ - "doctype": "Tag Link", - "document_type": doc.doctype, - "document_name": doc.name, - "title": doc.get_title() or '', - "tag": tag - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Tag Link", + "document_type": doc.doctype, + "document_name": doc.name, + "title": doc.get_title() or "", + "tag": tag, + } + ).insert(ignore_permissions=True) deleted_tags = list(set(existing_tags) - set(new_tags)) for tag in deleted_tags: - frappe.db.delete("Tag Link", { - "document_type": doc.doctype, - "document_name": doc.name, - "tag": tag - }) + frappe.db.delete( + "Tag Link", {"document_type": doc.doctype, "document_name": doc.name, "tag": tag} + ) + @frappe.whitelist() def get_documents_for_tag(tag): """ - Search for given text in Tag Link - :param tag: tag to be searched + Search for given text in Tag Link + :param tag: tag to be searched """ # remove hastag `#` from tag tag = tag[1:] results = [] - result = frappe.get_list("Tag Link", filters={"tag": tag}, fields=["document_type", "document_name", "title", "tag"]) + result = frappe.get_list( + "Tag Link", filters={"tag": tag}, fields=["document_type", "document_name", "title", "tag"] + ) for res in result: - results.append({ - "doctype": res.document_type, - "name": res.document_name, - "content": res.title - }) + results.append({"doctype": res.document_type, "name": res.document_name, "content": res.title}) return results + @frappe.whitelist() def get_tags_list_for_awesomebar(): return [t.name for t in frappe.get_list("Tag")] diff --git a/frappe/desk/doctype/tag/test_tag.py b/frappe/desk/doctype/tag/test_tag.py index b9c6e0b744..8719da8c21 100644 --- a/frappe/desk/doctype/tag/test_tag.py +++ b/frappe/desk/doctype/tag/test_tag.py @@ -1,8 +1,9 @@ import unittest -import frappe -from frappe.desk.reportview import get_stats +import frappe from frappe.desk.doctype.tag.tag import add_tag +from frappe.desk.reportview import get_stats + class TestTag(unittest.TestCase): def setUp(self) -> None: @@ -10,17 +11,25 @@ class TestTag(unittest.TestCase): frappe.db.sql("UPDATE `tabDocType` set _user_tags=''") def test_tag_count_query(self): - self.assertDictEqual(get_stats('["_user_tags"]', 'DocType'), - {'_user_tags': [['No Tags', frappe.db.count('DocType')]]}) - add_tag('Standard', 'DocType', 'User') - add_tag('Standard', 'DocType', 'ToDo') + self.assertDictEqual( + get_stats('["_user_tags"]', "DocType"), + {"_user_tags": [["No Tags", frappe.db.count("DocType")]]}, + ) + add_tag("Standard", "DocType", "User") + add_tag("Standard", "DocType", "ToDo") # count with no filter - self.assertDictEqual(get_stats('["_user_tags"]', 'DocType'), - {'_user_tags': [['Standard', 2], ['No Tags', frappe.db.count('DocType') - 2]]}) + self.assertDictEqual( + get_stats('["_user_tags"]', "DocType"), + {"_user_tags": [["Standard", 2], ["No Tags", frappe.db.count("DocType") - 2]]}, + ) # count with child table field filter - self.assertDictEqual(get_stats('["_user_tags"]', - 'DocType', - filters='[["DocField", "fieldname", "like", "%last_name%"], ["DocType", "name", "like", "%use%"]]'), - {'_user_tags': [['Standard', 1], ['No Tags', 0]]}) \ No newline at end of file + self.assertDictEqual( + get_stats( + '["_user_tags"]', + "DocType", + filters='[["DocField", "fieldname", "like", "%last_name%"], ["DocType", "name", "like", "%use%"]]', + ), + {"_user_tags": [["Standard", 1], ["No Tags", 0]]}, + ) diff --git a/frappe/desk/doctype/tag_link/tag_link.py b/frappe/desk/doctype/tag_link/tag_link.py index d07894989d..ec816352ca 100644 --- a/frappe/desk/doctype/tag_link/tag_link.py +++ b/frappe/desk/doctype/tag_link/tag_link.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class TagLink(Document): pass diff --git a/frappe/desk/doctype/tag_link/test_tag_link.py b/frappe/desk/doctype/tag_link/test_tag_link.py index fa6a22903f..d4d1dd61fa 100644 --- a/frappe/desk/doctype/tag_link/test_tag_link.py +++ b/frappe/desk/doctype/tag_link/test_tag_link.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestTagLink(unittest.TestCase): pass diff --git a/frappe/desk/doctype/todo/__init__.py b/frappe/desk/doctype/todo/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/desk/doctype/todo/__init__.py +++ b/frappe/desk/doctype/todo/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/desk/doctype/todo/test_todo.py b/frappe/desk/doctype/todo/test_todo.py index 34d3cee191..5c54889e00 100644 --- a/frappe/desk/doctype/todo/test_todo.py +++ b/frappe/desk/doctype/todo/test_todo.py @@ -1,79 +1,90 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import unittest + +import frappe +from frappe.core.doctype.doctype.doctype import clear_permissions_cache from frappe.model.db_query import DatabaseQuery from frappe.permissions import add_permission, reset_perms -from frappe.core.doctype.doctype.doctype import clear_permissions_cache -test_dependencies = ['User'] +test_dependencies = ["User"] + class TestToDo(unittest.TestCase): def test_delete(self): - todo = frappe.get_doc(dict(doctype='ToDo', description='test todo', - assigned_by='Administrator')).insert() + todo = frappe.get_doc( + dict(doctype="ToDo", description="test todo", assigned_by="Administrator") + ).insert() frappe.db.delete("Deleted Document") todo.delete() - deleted = frappe.get_doc('Deleted Document', dict(deleted_doctype=todo.doctype, deleted_name=todo.name)) + deleted = frappe.get_doc( + "Deleted Document", dict(deleted_doctype=todo.doctype, deleted_name=todo.name) + ) self.assertEqual(todo.as_json(), deleted.data) def test_fetch(self): - todo = frappe.get_doc(dict(doctype='ToDo', description='test todo', - assigned_by='Administrator')).insert() - self.assertEqual(todo.assigned_by_full_name, - frappe.db.get_value('User', todo.assigned_by, 'full_name')) + todo = frappe.get_doc( + dict(doctype="ToDo", description="test todo", assigned_by="Administrator") + ).insert() + self.assertEqual( + todo.assigned_by_full_name, frappe.db.get_value("User", todo.assigned_by, "full_name") + ) def test_fetch_setup(self): frappe.db.delete("ToDo") - todo_meta = frappe.get_doc('DocType', 'ToDo') - todo_meta.get('fields', dict(fieldname='assigned_by_full_name'))[0].fetch_from = '' + todo_meta = frappe.get_doc("DocType", "ToDo") + todo_meta.get("fields", dict(fieldname="assigned_by_full_name"))[0].fetch_from = "" todo_meta.save() - frappe.clear_cache(doctype='ToDo') + frappe.clear_cache(doctype="ToDo") - todo = frappe.get_doc(dict(doctype='ToDo', description='test todo', - assigned_by='Administrator')).insert() + todo = frappe.get_doc( + dict(doctype="ToDo", description="test todo", assigned_by="Administrator") + ).insert() self.assertFalse(todo.assigned_by_full_name) - todo_meta = frappe.get_doc('DocType', 'ToDo') - todo_meta.get('fields', dict(fieldname='assigned_by_full_name'))[0].fetch_from = 'assigned_by.full_name' + todo_meta = frappe.get_doc("DocType", "ToDo") + todo_meta.get("fields", dict(fieldname="assigned_by_full_name"))[ + 0 + ].fetch_from = "assigned_by.full_name" todo_meta.save() todo.reload() - self.assertEqual(todo.assigned_by_full_name, - frappe.db.get_value('User', todo.assigned_by, 'full_name')) + self.assertEqual( + todo.assigned_by_full_name, frappe.db.get_value("User", todo.assigned_by, "full_name") + ) def test_todo_list_access(self): - create_new_todo('Test1', 'testperm@example.com') + create_new_todo("Test1", "testperm@example.com") - frappe.set_user('test4@example.com') - create_new_todo('Test2', 'test4@example.com') - test_user_data = DatabaseQuery('ToDo').execute() + frappe.set_user("test4@example.com") + create_new_todo("Test2", "test4@example.com") + test_user_data = DatabaseQuery("ToDo").execute() - frappe.set_user('testperm@example.com') - system_manager_data = DatabaseQuery('ToDo').execute() + frappe.set_user("testperm@example.com") + system_manager_data = DatabaseQuery("ToDo").execute() self.assertNotEqual(test_user_data, system_manager_data) - frappe.set_user('Administrator') + frappe.set_user("Administrator") frappe.db.rollback() def test_doc_read_access(self): - #owner and assigned_by is testperm - todo1 = create_new_todo('Test1', 'testperm@example.com') - test_user = frappe.get_doc('User', 'test4@example.com') + # owner and assigned_by is testperm + todo1 = create_new_todo("Test1", "testperm@example.com") + test_user = frappe.get_doc("User", "test4@example.com") - #owner is testperm, but assigned_by is test4 - todo2 = create_new_todo('Test2', 'test4@example.com') + # owner is testperm, but assigned_by is test4 + todo2 = create_new_todo("Test2", "test4@example.com") - frappe.set_user('test4@example.com') - #owner and assigned_by is test4 - todo3 = create_new_todo('Test3', 'test4@example.com') + frappe.set_user("test4@example.com") + # owner and assigned_by is test4 + todo3 = create_new_todo("Test3", "test4@example.com") # user without any role to read or write todo document self.assertFalse(todo1.has_permission("read")) @@ -87,54 +98,58 @@ class TestToDo(unittest.TestCase): self.assertTrue(todo3.has_permission("read")) self.assertTrue(todo3.has_permission("write")) - frappe.set_user('Administrator') + frappe.set_user("Administrator") - test_user.add_roles('Blogger') - add_permission('ToDo', 'Blogger') + test_user.add_roles("Blogger") + add_permission("ToDo", "Blogger") - frappe.set_user('test4@example.com') + frappe.set_user("test4@example.com") # user with only read access to todo document, not an owner or assigned_by self.assertTrue(todo1.has_permission("read")) self.assertFalse(todo1.has_permission("write")) - frappe.set_user('Administrator') - test_user.remove_roles('Blogger') - reset_perms('ToDo') - clear_permissions_cache('ToDo') + frappe.set_user("Administrator") + test_user.remove_roles("Blogger") + reset_perms("ToDo") + clear_permissions_cache("ToDo") frappe.db.rollback() def test_fetch_if_empty(self): frappe.db.delete("ToDo") # Allow user changes - todo_meta = frappe.get_doc('DocType', 'ToDo') - field = todo_meta.get('fields', dict(fieldname='assigned_by_full_name'))[0] - field.fetch_from = 'assigned_by.full_name' + todo_meta = frappe.get_doc("DocType", "ToDo") + field = todo_meta.get("fields", dict(fieldname="assigned_by_full_name"))[0] + field.fetch_from = "assigned_by.full_name" field.fetch_if_empty = 1 todo_meta.save() - frappe.clear_cache(doctype='ToDo') + frappe.clear_cache(doctype="ToDo") - todo = frappe.get_doc(dict(doctype='ToDo', description='test todo', - assigned_by='Administrator', assigned_by_full_name='Admin')).insert() + todo = frappe.get_doc( + dict( + doctype="ToDo", + description="test todo", + assigned_by="Administrator", + assigned_by_full_name="Admin", + ) + ).insert() - self.assertEqual(todo.assigned_by_full_name, 'Admin') + self.assertEqual(todo.assigned_by_full_name, "Admin") # Overwrite user changes - todo.meta.get('fields', dict(fieldname='assigned_by_full_name'))[0].fetch_if_empty = 0 + todo.meta.get("fields", dict(fieldname="assigned_by_full_name"))[0].fetch_if_empty = 0 todo.meta.save() todo.reload() todo.save() - self.assertEqual(todo.assigned_by_full_name, - frappe.db.get_value('User', todo.assigned_by, 'full_name')) + self.assertEqual( + todo.assigned_by_full_name, frappe.db.get_value("User", todo.assigned_by, "full_name") + ) + def create_new_todo(description, assigned_by): - todo = { - 'doctype': 'ToDo', - 'description': description, - 'assigned_by': assigned_by - } + todo = {"doctype": "ToDo", "description": description, "assigned_by": assigned_by} return frappe.get_doc(todo).insert() diff --git a/frappe/desk/doctype/todo/todo.py b/frappe/desk/doctype/todo/todo.py index 3b84b94754..e076f3384a 100644 --- a/frappe/desk/doctype/todo/todo.py +++ b/frappe/desk/doctype/todo/todo.py @@ -1,45 +1,46 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import json +import frappe from frappe.model.document import Document from frappe.utils import get_fullname, parse_addr exclude_from_linked_with = True + class ToDo(Document): - DocType = 'ToDo' + DocType = "ToDo" def validate(self): self._assignment = None if self.is_new(): if self.assigned_by == self.allocated_to: - assignment_message = frappe._("{0} self assigned this task: {1}").format(get_fullname(self.assigned_by), self.description) + assignment_message = frappe._("{0} self assigned this task: {1}").format( + get_fullname(self.assigned_by), self.description + ) else: - assignment_message = frappe._("{0} assigned {1}: {2}").format(get_fullname(self.assigned_by), get_fullname(self.allocated_to), self.description) + assignment_message = frappe._("{0} assigned {1}: {2}").format( + get_fullname(self.assigned_by), get_fullname(self.allocated_to), self.description + ) - self._assignment = { - "text": assignment_message, - "comment_type": "Assigned" - } + self._assignment = {"text": assignment_message, "comment_type": "Assigned"} else: # NOTE the previous value is only available in validate method if self.get_db_value("status") != self.status: if self.allocated_to == frappe.session.user: removal_message = frappe._("{0} removed their assignment.").format( - get_fullname(frappe.session.user)) + get_fullname(frappe.session.user) + ) else: removal_message = frappe._("Assignment of {0} removed by {1}").format( - get_fullname(self.allocated_to), get_fullname(frappe.session.user)) + get_fullname(self.allocated_to), get_fullname(frappe.session.user) + ) - self._assignment = { - "text": removal_message, - "comment_type": "Assignment Completed" - } + self._assignment = {"text": removal_message, "comment_type": "Assignment Completed"} def on_update(self): if self._assignment: @@ -59,26 +60,34 @@ class ToDo(Document): def delete_communication_links(self): # unlink todo from linked comments - return frappe.db.delete("Communication Link", { - "link_doctype": self.doctype, - "link_name": self.name - }) + return frappe.db.delete( + "Communication Link", {"link_doctype": self.doctype, "link_name": self.name} + ) def update_in_reference(self): if not (self.reference_type and self.reference_name): return try: - assignments = frappe.get_all("ToDo", filters={ - "reference_type": self.reference_type, - "reference_name": self.reference_name, - "status": ("!=", "Cancelled"), - "allocated_to": ("is", "set") - }, pluck="allocated_to") + assignments = frappe.get_all( + "ToDo", + filters={ + "reference_type": self.reference_type, + "reference_name": self.reference_name, + "status": ("!=", "Cancelled"), + "allocated_to": ("is", "set"), + }, + pluck="allocated_to", + ) assignments.reverse() - frappe.db.set_value(self.reference_type, self.reference_name, - "_assign", json.dumps(assignments), update_modified=False) + frappe.db.set_value( + self.reference_type, + self.reference_name, + "_assign", + json.dumps(assignments), + update_modified=False, + ) except Exception as e: if frappe.db.is_table_missing(e) and frappe.flags.in_install: @@ -87,6 +96,7 @@ class ToDo(Document): elif frappe.db.is_column_missing(e): from frappe.database.schema import add_column + add_column(self.reference_type, "_assign", "Text") self.update_in_reference() @@ -95,42 +105,44 @@ class ToDo(Document): @classmethod def get_owners(cls, filters=None): - """Returns list of owners after applying filters on todo's. - """ - rows = frappe.get_all(cls.DocType, filters=filters or {}, fields=['allocated_to']) + """Returns list of owners after applying filters on todo's.""" + rows = frappe.get_all(cls.DocType, filters=filters or {}, fields=["allocated_to"]) return [parse_addr(row.allocated_to)[1] for row in rows if row.allocated_to] + # NOTE: todo is viewable if a user is an owner, or set as assigned_to value, or has any role that is allowed to access ToDo doctype. def on_doctype_update(): frappe.db.add_index("ToDo", ["reference_type", "reference_name"]) + def get_permission_query_conditions(user): - if not user: user = frappe.session.user + if not user: + user = frappe.session.user - todo_roles = frappe.permissions.get_doctype_roles('ToDo') - if 'All' in todo_roles: - todo_roles.remove('All') + todo_roles = frappe.permissions.get_doctype_roles("ToDo") + if "All" in todo_roles: + todo_roles.remove("All") if any(check in todo_roles for check in frappe.get_roles(user)): return None else: - return """(`tabToDo`.allocated_to = {user} or `tabToDo`.assigned_by = {user})"""\ - .format(user=frappe.db.escape(user)) + return """(`tabToDo`.allocated_to = {user} or `tabToDo`.assigned_by = {user})""".format( + user=frappe.db.escape(user) + ) + def has_permission(doc, ptype="read", user=None): user = user or frappe.session.user - todo_roles = frappe.permissions.get_doctype_roles('ToDo', ptype) - if 'All' in todo_roles: - todo_roles.remove('All') + todo_roles = frappe.permissions.get_doctype_roles("ToDo", ptype) + if "All" in todo_roles: + todo_roles.remove("All") if any(check in todo_roles for check in frappe.get_roles(user)): return True else: - return doc.allocated_to==user or doc.assigned_by==user + return doc.allocated_to == user or doc.assigned_by == user + @frappe.whitelist() def new_todo(description): - frappe.get_doc({ - 'doctype': 'ToDo', - 'description': description - }).insert() + frappe.get_doc({"doctype": "ToDo", "description": description}).insert() diff --git a/frappe/desk/doctype/workspace/test_workspace.py b/frappe/desk/doctype/workspace/test_workspace.py index 6c16e69afe..9281240e08 100644 --- a/frappe/desk/doctype/workspace/test_workspace.py +++ b/frappe/desk/doctype/workspace/test_workspace.py @@ -1,8 +1,11 @@ # -*- coding: utf-8 -*- # Copyright (c) 2020, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest + +import frappe + + class TestWorkspace(unittest.TestCase): def setUp(self): create_module("Test Module") @@ -27,16 +30,16 @@ class TestWorkspace(unittest.TestCase): # else: # self.assertEqual(len(cards), 1) + def create_module(module_name): - module = frappe.get_doc({ - "doctype": "Module Def", - "module_name": module_name, - "app_name": "frappe" - }) - module.insert(ignore_if_duplicate = True) + module = frappe.get_doc( + {"doctype": "Module Def", "module_name": module_name, "app_name": "frappe"} + ) + module.insert(ignore_if_duplicate=True) return module + def create_workspace(**args): workspace = frappe.new_doc("Workspace") args = frappe._dict(args) @@ -49,47 +52,51 @@ def create_workspace(**args): return workspace + def insert_card(workspace, card_label, doctype1, doctype2, country=None): - workspace.append("links", { - "type": "Card Break", - "label": card_label, - "only_for": country - }) + workspace.append("links", {"type": "Card Break", "label": card_label, "only_for": country}) create_doctype(doctype1, "Test Module") - workspace.append("links", { - "type": "Link", - "label": doctype1, - "only_for": country, - "link_type": "DocType", - "link_to": doctype1 - }) + workspace.append( + "links", + { + "type": "Link", + "label": doctype1, + "only_for": country, + "link_type": "DocType", + "link_to": doctype1, + }, + ) create_doctype(doctype2, "Test Module") - workspace.append("links", { - "type": "Link", - "label": doctype2, - "only_for": country, - "link_type": "DocType", - "link_to": doctype2 - }) + workspace.append( + "links", + { + "type": "Link", + "label": doctype2, + "only_for": country, + "link_type": "DocType", + "link_to": doctype2, + }, + ) + def create_doctype(doctype_name, module): - frappe.get_doc({ - 'doctype': 'DocType', - 'name': doctype_name, - 'module': module, - 'custom': 1, - 'autoname': 'field:title', - 'fields': [ - {'label': 'Title', 'fieldname': 'title', 'reqd': 1, 'fieldtype': 'Data'}, - {'label': 'Description', 'fieldname': 'description', 'fieldtype': 'Small Text'}, - {'label': 'Date', 'fieldname': 'date', 'fieldtype': 'Date'}, - {'label': 'Duration', 'fieldname': 'duration', 'fieldtype': 'Duration'}, - {'label': 'Number', 'fieldname': 'number', 'fieldtype': 'Int'}, - {'label': 'Number', 'fieldname': 'another_number', 'fieldtype': 'Int'} - ], - 'permissions': [ - {'role': 'System Manager'} - ] - }).insert(ignore_if_duplicate = True) + frappe.get_doc( + { + "doctype": "DocType", + "name": doctype_name, + "module": module, + "custom": 1, + "autoname": "field:title", + "fields": [ + {"label": "Title", "fieldname": "title", "reqd": 1, "fieldtype": "Data"}, + {"label": "Description", "fieldname": "description", "fieldtype": "Small Text"}, + {"label": "Date", "fieldname": "date", "fieldtype": "Date"}, + {"label": "Duration", "fieldname": "duration", "fieldtype": "Duration"}, + {"label": "Number", "fieldname": "number", "fieldtype": "Int"}, + {"label": "Number", "fieldname": "another_number", "fieldtype": "Int"}, + ], + "permissions": [{"role": "System Manager"}], + } + ).insert(ignore_if_duplicate=True) diff --git a/frappe/desk/doctype/workspace/workspace.py b/frappe/desk/doctype/workspace/workspace.py index ba3319b591..a2dbcbfbe2 100644 --- a/frappe/desk/doctype/workspace/workspace.py +++ b/frappe/desk/doctype/workspace/workspace.py @@ -2,19 +2,20 @@ # Copyright (c) 2020, Frappe Technologies and contributors # License: MIT. See LICENSE +from json import loads + import frappe from frappe import _ -from frappe.modules.export_file import export_to_files -from frappe.model.document import Document -from frappe.model.rename_doc import rename_doc from frappe.desk.desktop import save_new_widget from frappe.desk.utils import validate_route_conflict +from frappe.model.document import Document +from frappe.model.rename_doc import rename_doc +from frappe.modules.export_file import export_to_files -from json import loads class Workspace(Document): def validate(self): - if (self.public and not is_workspace_manager() and not disable_saving_as_public()): + if self.public and not is_workspace_manager() and not disable_saving_as_public(): frappe.throw(_("You need to be Workspace Manager to edit this document")) validate_route_conflict(self.doctype, self.name) @@ -29,30 +30,37 @@ class Workspace(Document): return if frappe.conf.developer_mode and self.module and self.public: - export_to_files(record_list=[['Workspace', self.name]], record_module=self.module) + export_to_files(record_list=[["Workspace", self.name]], record_module=self.module) @staticmethod def get_module_page_map(): - pages = frappe.get_all("Workspace", fields=["name", "module"], filters={'for_user': ''}, as_list=1) + pages = frappe.get_all( + "Workspace", fields=["name", "module"], filters={"for_user": ""}, as_list=1 + ) - return { page[1]: page[0] for page in pages if page[1] } + return {page[1]: page[0] for page in pages if page[1]} def get_link_groups(self): cards = [] - current_card = frappe._dict({ - "label": "Link", - "type": "Card Break", - "icon": None, - "hidden": False, - }) + current_card = frappe._dict( + { + "label": "Link", + "type": "Card Break", + "icon": None, + "hidden": False, + } + ) card_links = [] for link in self.links: link = link.as_dict() if link.type == "Card Break": - if card_links and (not current_card.get('only_for') or current_card.get('only_for') == frappe.get_system_settings('country')): - current_card['links'] = card_links + if card_links and ( + not current_card.get("only_for") + or current_card.get("only_for") == frappe.get_system_settings("country") + ): + current_card["links"] = card_links cards.append(current_card) current_card = link @@ -60,7 +68,7 @@ class Workspace(Document): else: card_links.append(link) - current_card['links'] = card_links + current_card["links"] = card_links cards.append(current_card) return cards @@ -68,60 +76,68 @@ class Workspace(Document): def build_links_table_from_card(self, config): for idx, card in enumerate(config): - links = loads(card.get('links')) + links = loads(card.get("links")) # remove duplicate before adding for idx, link in enumerate(self.links): - if link.label == card.get('label') and link.type == 'Card Break': + if link.label == card.get("label") and link.type == "Card Break": del self.links[idx : idx + link.link_count + 1] - self.append('links', { - "label": card.get('label'), - "type": "Card Break", - "icon": card.get('icon'), - "hidden": card.get('hidden') or False, - "link_count": card.get('link_count'), - "idx": 1 if not self.links else self.links[-1].idx + 1 - }) + self.append( + "links", + { + "label": card.get("label"), + "type": "Card Break", + "icon": card.get("icon"), + "hidden": card.get("hidden") or False, + "link_count": card.get("link_count"), + "idx": 1 if not self.links else self.links[-1].idx + 1, + }, + ) for link in links: - self.append('links', { - "label": link.get('label'), - "type": "Link", - "link_type": link.get('link_type'), - "link_to": link.get('link_to'), - "onboard": link.get('onboard'), - "only_for": link.get('only_for'), - "dependencies": link.get('dependencies'), - "is_query_report": link.get('is_query_report'), - "idx": self.links[-1].idx + 1 - }) + self.append( + "links", + { + "label": link.get("label"), + "type": "Link", + "link_type": link.get("link_type"), + "link_to": link.get("link_to"), + "onboard": link.get("onboard"), + "only_for": link.get("only_for"), + "dependencies": link.get("dependencies"), + "is_query_report": link.get("is_query_report"), + "idx": self.links[-1].idx + 1, + }, + ) + def disable_saving_as_public(): - return frappe.flags.in_install or \ - frappe.flags.in_patch or \ - frappe.flags.in_test or \ - frappe.flags.in_fixtures or \ - frappe.flags.in_migrate + return ( + frappe.flags.in_install + or frappe.flags.in_patch + or frappe.flags.in_test + or frappe.flags.in_fixtures + or frappe.flags.in_migrate + ) + def get_link_type(key): key = key.lower() - link_type_map = { - "doctype": "DocType", - "page": "Page", - "report": "Report" - } + link_type_map = {"doctype": "DocType", "page": "Page", "report": "Report"} if key in link_type_map: return link_type_map[key] return "DocType" + def get_report_type(report): report_type = frappe.get_value("Report", report, "report_type") return report_type in ["Query Report", "Script Report", "Custom Report"] + @frappe.whitelist() def new_page(new_page): if not loads(new_page): @@ -132,33 +148,28 @@ def new_page(new_page): if page.get("public") and not is_workspace_manager(): return - doc = frappe.new_doc('Workspace') - doc.title = page.get('title') - doc.icon = page.get('icon') - doc.content = page.get('content') - doc.parent_page = page.get('parent_page') - doc.label = page.get('label') - doc.for_user = page.get('for_user') - doc.public = page.get('public') + doc = frappe.new_doc("Workspace") + doc.title = page.get("title") + doc.icon = page.get("icon") + doc.content = page.get("content") + doc.parent_page = page.get("parent_page") + doc.label = page.get("label") + doc.for_user = page.get("for_user") + doc.public = page.get("public") doc.sequence_id = last_sequence_id(doc) + 1 doc.save(ignore_permissions=True) return doc + @frappe.whitelist() def save_page(title, public, new_widgets, blocks): public = frappe.parse_json(public) - filters = { - 'public': public, - 'label': title - } + filters = {"public": public, "label": title} if not public: - filters = { - 'for_user': frappe.session.user, - 'label': title + "-" + frappe.session.user - } + filters = {"for_user": frappe.session.user, "label": title + "-" + frappe.session.user} pages = frappe.get_list("Workspace", filters=filters) if pages: doc = frappe.get_doc("Workspace", pages[0]) @@ -170,16 +181,14 @@ def save_page(title, public, new_widgets, blocks): return {"name": title, "public": public, "label": doc.label} + @frappe.whitelist() def update_page(name, title, icon, parent, public): public = frappe.parse_json(public) doc = frappe.get_doc("Workspace", name) - filters = { - 'parent_page': doc.title, - 'public': doc.public - } + filters = {"parent_page": doc.title, "public": doc.public} child_docs = frappe.get_list("Workspace", filters=filters) if doc: @@ -187,10 +196,10 @@ def update_page(name, title, icon, parent, public): doc.icon = icon doc.parent_page = parent if doc.public != public: - doc.sequence_id = frappe.db.count('Workspace', {'public':public}, cache=True) + doc.sequence_id = frappe.db.count("Workspace", {"public": public}, cache=True) doc.public = public - doc.for_user = '' if public else doc.for_user or frappe.session.user - doc.label = '{0}-{1}'.format(title, doc.for_user) if doc.for_user else title + doc.for_user = "" if public else doc.for_user or frappe.session.user + doc.label = "{0}-{1}".format(title, doc.for_user) if doc.for_user else title doc.save(ignore_permissions=True) if name != doc.label: @@ -206,6 +215,7 @@ def update_page(name, title, icon, parent, public): return {"name": doc.title, "public": doc.public, "label": doc.label} + @frappe.whitelist() def duplicate_page(page_name, new_page): if not loads(new_page): @@ -218,15 +228,15 @@ def duplicate_page(page_name, new_page): old_doc = frappe.get_doc("Workspace", page_name) doc = frappe.copy_doc(old_doc) - doc.title = new_page.get('title') - doc.icon = new_page.get('icon') - doc.parent_page = new_page.get('parent') or '' - doc.public = new_page.get('is_public') - doc.for_user = '' + doc.title = new_page.get("title") + doc.icon = new_page.get("icon") + doc.parent_page = new_page.get("parent") or "" + doc.public = new_page.get("is_public") + doc.for_user = "" doc.label = doc.title if not doc.public: doc.for_user = doc.for_user or frappe.session.user - doc.label = '{0}-{1}'.format(doc.title, doc.for_user) + doc.label = "{0}-{1}".format(doc.title, doc.for_user) doc.name = doc.label if old_doc.public == doc.public: doc.sequence_id += 0.1 @@ -236,6 +246,7 @@ def duplicate_page(page_name, new_page): return doc + @frappe.whitelist() def delete_page(page): if not loads(page): @@ -251,6 +262,7 @@ def delete_page(page): return {"name": page.get("name"), "public": page.get("public"), "title": page.get("title")} + @frappe.whitelist() def sort_pages(sb_public_items, sb_private_items): if not loads(sb_public_items) and not loads(sb_private_items): @@ -259,8 +271,8 @@ def sort_pages(sb_public_items, sb_private_items): sb_public_items = loads(sb_public_items) sb_private_items = loads(sb_private_items) - workspace_public_pages = get_page_list(['name', 'title'], {'public': 1}) - workspace_private_pages = get_page_list(['name', 'title'], {'for_user': frappe.session.user}) + workspace_public_pages = get_page_list(["name", "title"], {"public": 1}) + workspace_private_pages = get_page_list(["name", "title"], {"for_user": frappe.session.user}) if sb_private_items: return sort_page(workspace_private_pages, sb_private_items) @@ -270,40 +282,40 @@ def sort_pages(sb_public_items, sb_private_items): return False + def sort_page(workspace_pages, pages): for seq, d in enumerate(pages): for page in workspace_pages: - if page.title == d.get('title'): - doc = frappe.get_doc('Workspace', page.name) + if page.title == d.get("title"): + doc = frappe.get_doc("Workspace", page.name) doc.sequence_id = seq + 1 - doc.parent_page = d.get('parent_page') or "" + doc.parent_page = d.get("parent_page") or "" doc.flags.ignore_links = True doc.save(ignore_permissions=True) break return True + def last_sequence_id(doc): - doc_exists = frappe.db.exists({ - 'doctype': 'Workspace', - 'public': doc.public, - 'for_user': doc.for_user - }) + doc_exists = frappe.db.exists( + {"doctype": "Workspace", "public": doc.public, "for_user": doc.for_user} + ) if not doc_exists: return 0 - return frappe.db.get_list('Workspace', - fields=['sequence_id'], - filters={ - 'public': doc.public, - 'for_user': doc.for_user - }, - order_by="sequence_id desc" + return frappe.db.get_list( + "Workspace", + fields=["sequence_id"], + filters={"public": doc.public, "for_user": doc.for_user}, + order_by="sequence_id desc", )[0].sequence_id + def get_page_list(fields, filters): - return frappe.get_list("Workspace", fields=fields, filters=filters, order_by='sequence_id asc') + return frappe.get_list("Workspace", fields=fields, filters=filters, order_by="sequence_id asc") + def is_workspace_manager(): return "Workspace Manager" in frappe.get_roles() diff --git a/frappe/desk/doctype/workspace_chart/workspace_chart.py b/frappe/desk/doctype/workspace_chart/workspace_chart.py index a3b66d99ab..e02cf06ee0 100644 --- a/frappe/desk/doctype/workspace_chart/workspace_chart.py +++ b/frappe/desk/doctype/workspace_chart/workspace_chart.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class WorkspaceChart(Document): pass diff --git a/frappe/desk/doctype/workspace_link/workspace_link.py b/frappe/desk/doctype/workspace_link/workspace_link.py index 72256ba490..5e55a7c2bd 100644 --- a/frappe/desk/doctype/workspace_link/workspace_link.py +++ b/frappe/desk/doctype/workspace_link/workspace_link.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class WorkspaceLink(Document): pass diff --git a/frappe/desk/doctype/workspace_shortcut/workspace_shortcut.py b/frappe/desk/doctype/workspace_shortcut/workspace_shortcut.py index 1dad4cca05..4ca86c8146 100644 --- a/frappe/desk/doctype/workspace_shortcut/workspace_shortcut.py +++ b/frappe/desk/doctype/workspace_shortcut/workspace_shortcut.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class WorkspaceShortcut(Document): pass diff --git a/frappe/desk/form/__init__.py b/frappe/desk/form/__init__.py index eb5ba62e5c..98029dd956 100644 --- a/frappe/desk/form/__init__.py +++ b/frappe/desk/form/__init__.py @@ -1,3 +1,2 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE - diff --git a/frappe/desk/form/assign_to.py b/frappe/desk/form/assign_to.py index d79927a506..4107f95827 100644 --- a/frappe/desk/form/assign_to.py +++ b/frappe/desk/form/assign_to.py @@ -3,38 +3,51 @@ """assign/unassign to ToDo""" +import json + import frappe +import frappe.share +import frappe.utils from frappe import _ +from frappe.desk.doctype.notification_log.notification_log import ( + enqueue_create_notification, + get_title, + get_title_html, +) 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 + +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) + 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": - } + args = { + "assign_to": [], + "doctype": , + "name": , + "description": , + "assignment_rule": + } """ if not args: @@ -45,10 +58,10 @@ def add(args=None): for assign_to in frappe.parse_json(args.get("assign_to")): filters = { - "reference_type": args['doctype'], - "reference_name": args['name'], + "reference_type": args["doctype"], + "reference_name": args["name"], "status": "Open", - "allocated_to": assign_to + "allocated_to": assign_to, } if frappe.get_all("ToDo", filters=filters): @@ -56,27 +69,29 @@ def add(args=None): 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) + 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) + 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']) + 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): @@ -85,15 +100,23 @@ def add(args=None): # 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) + 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")) + 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)) + 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) @@ -101,20 +124,25 @@ def add(args=None): return get(args) + @frappe.whitelist() def add_multiple(args=None): if not args: args = frappe.local.form_dict - docname_list = json.loads(args['name']) + 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'))) + assignments = frappe.db.get_all( + "ToDo", + fields=["allocated_to"], + filters=dict(reference_type=doctype, reference_name=name, status=("!=", "Cancelled")), + ) if not assignments: return False @@ -123,15 +151,24 @@ def close_all_assignments(doctype, name): 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)}) + 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 @@ -142,17 +179,19 @@ def set_status(doctype, name, assign_to, status="Cancelled"): pass # clear assigned_to if field exists - if frappe.get_meta(doctype).get_field("assigned_to") and status=="Cancelled": + 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)) + """ + assignments = frappe.db.get_all( + "ToDo", fields=["allocated_to"], filters=dict(reference_type=doctype, reference_name=name) + ) if not assignments: return False @@ -161,42 +200,46 @@ def clear(doctype, name): return True -def notify_assignment(assigned_by, allocated_to, doc_type, doc_name, action='CLOSE', - description=None): + +def notify_assignment( + assigned_by, allocated_to, doc_type, doc_name, action="CLOSE", description=None +): """ - Notify assignee that there is a change in assignment + 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'): + 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') + user_name = frappe.get_cached_value("User", frappe.session.user, "full_name") title = get_title(doc_type, doc_name) - description_html = "
{0}
".format(description) if description else None
+ description_html = "{0}
".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))
+ 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)
+ 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
+ "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 "" + "
".join(users) \ No newline at end of file + return "
" + "
".join(users) diff --git a/frappe/desk/form/document_follow.py b/frappe/desk/form/document_follow.py index 7dd2b64c21..527b9da036 100644 --- a/frappe/desk/form/document_follow.py +++ b/frappe/desk/form/document_follow.py @@ -3,10 +3,11 @@ import frappe import frappe.utils -from frappe.utils import get_url_to_form -from frappe.model import log_types from frappe import _ +from frappe.model import log_types from frappe.query_builder import DocType +from frappe.utils import get_url_to_form + @frappe.whitelist() def update_follow(doctype, doc_name, following): @@ -18,22 +19,32 @@ def update_follow(doctype, doc_name, following): @frappe.whitelist() def follow_document(doctype, doc_name, user): - ''' - param: - Doctype name - doc name - user email - - condition: - avoided for some doctype - follow only if track changes are set to 1 - ''' - if (doctype in ("Communication", "ToDo", "Email Unsubscribe", "File", "Comment", "Email Account", "Email Domain") - or doctype in log_types): + """ + param: + Doctype name + doc name + user email + + condition: + avoided for some doctype + follow only if track changes are set to 1 + """ + if ( + doctype + in ( + "Communication", + "ToDo", + "Email Unsubscribe", + "File", + "Comment", + "Email Account", + "Email Domain", + ) + or doctype in log_types + ): return - if ((not frappe.get_meta(doctype).track_changes) - or user == "Administrator"): + if (not frappe.get_meta(doctype).track_changes) or user == "Administrator": return if not frappe.db.get_value("User", user, "document_follow_notify", ignore=True, cache=True): @@ -41,35 +52,32 @@ def follow_document(doctype, doc_name, user): if not is_document_followed(doctype, doc_name, user): doc = frappe.new_doc("Document Follow") - doc.update({ - "ref_doctype": doctype, - "ref_docname": doc_name, - "user": user - }) + doc.update({"ref_doctype": doctype, "ref_docname": doc_name, "user": user}) doc.save() return doc + @frappe.whitelist() def unfollow_document(doctype, doc_name, user): doc = frappe.get_all( "Document Follow", - filters={ - "ref_doctype": doctype, - "ref_docname": doc_name, - "user": user - }, + filters={"ref_doctype": doctype, "ref_docname": doc_name, "user": user}, fields=["name"], - limit=1 + limit=1, ) if doc: frappe.delete_doc("Document Follow", doc[0].name) return 1 return 0 + def get_message(doc_name, doctype, frequency, user): - activity_list = get_version(doctype, doc_name, frequency, user) + get_comments(doctype, doc_name, frequency, user) + activity_list = get_version(doctype, doc_name, frequency, user) + get_comments( + doctype, doc_name, frequency, user + ) return sorted(activity_list, key=lambda k: k["time"], reverse=True) + def send_email_alert(receiver, docinfo, timeline): if receiver: frappe.sendmail( @@ -79,20 +87,21 @@ def send_email_alert(receiver, docinfo, timeline): args={ "docinfo": docinfo, "timeline": timeline, - } + }, ) + def send_document_follow_mails(frequency): - ''' - param: - frequency for sanding mails + """ + param: + frequency for sanding mails - task: - set receiver according to frequency - group document list according to user - get changes, activity, comments on doctype - call method to send mail - ''' + task: + set receiver according to frequency + group document list according to user + get changes, activity, comments on doctype + call method to send mail + """ user_list = get_user_list(frequency) @@ -104,15 +113,20 @@ def send_document_follow_mails(frequency): # nosemgrep frappe.db.commit() + def get_user_list(frequency): - DocumentFollow = DocType('Document Follow') - User = DocType('User') - return (frappe.qb.from_(DocumentFollow).join(User) + DocumentFollow = DocType("Document Follow") + User = DocType("User") + return ( + frappe.qb.from_(DocumentFollow) + .join(User) .on(DocumentFollow.user == User.name) .where(User.document_follow_notify == 1) .where(User.document_follow_frequency == frequency) .select(DocumentFollow.user) - .groupby(DocumentFollow.user)).run(pluck="user") + .groupby(DocumentFollow.user) + ).run(pluck="user") + def get_message_for_user(frequency, user): message = [] @@ -123,28 +137,33 @@ def get_message_for_user(frequency, user): content = get_message(document_follow.ref_docname, document_follow.ref_doctype, frequency, user) if content: message = message + content - valid_document_follows.append({ - "reference_docname": document_follow.ref_docname, - "reference_doctype": document_follow.ref_doctype, - "reference_url": get_url_to_form(document_follow.ref_doctype, document_follow.ref_docname) - }) + valid_document_follows.append( + { + "reference_docname": document_follow.ref_docname, + "reference_doctype": document_follow.ref_doctype, + "reference_url": get_url_to_form(document_follow.ref_doctype, document_follow.ref_docname), + } + ) return message, valid_document_follows + def get_document_followed_by_user(user): - DocumentFollow = DocType('Document Follow') + DocumentFollow = DocType("Document Follow") # at max 20 documents are sent for each user - return (frappe.qb.from_(DocumentFollow) + return ( + frappe.qb.from_(DocumentFollow) .where(DocumentFollow.user == user) .select(DocumentFollow.ref_doctype, DocumentFollow.ref_docname) .orderby(DocumentFollow.modified) - .limit(20)).run(as_dict=True) + .limit(20) + ).run(as_dict=True) + def get_version(doctype, doc_name, frequency, user): timeline = [] filters = get_filters("docname", doc_name, frequency, user) - version = frappe.get_all("Version", - filters=filters, - fields=["ref_doctype", "data", "modified", "modified", "modified_by"] + version = frappe.get_all( + "Version", filters=filters, fields=["ref_doctype", "data", "modified", "modified", "modified_by"] ) if version: for v in version: @@ -162,154 +181,154 @@ def get_version(doctype, doc_name, frequency, user): return timeline + def get_comments(doctype, doc_name, frequency, user): from html2text import html2text timeline = [] filters = get_filters("reference_name", doc_name, frequency, user) - comments = frappe.get_all("Comment", - filters=filters, - fields=["content", "modified", "modified_by", "comment_type"] + comments = frappe.get_all( + "Comment", filters=filters, fields=["content", "modified", "modified_by", "comment_type"] ) for comment in comments: if comment.comment_type == "Like": - by = ''' By : {0}'''.format(comment.modified_by) + by = """ By : {0}""".format(comment.modified_by) elif comment.comment_type == "Comment": - by = '''Commented by : {0}'''.format(comment.modified_by) + by = """Commented by : {0}""".format(comment.modified_by) else: - by = '' + by = "" time = frappe.utils.format_datetime(comment.modified, "hh:mm a") - timeline.append({ - "time": comment.modified, - "data": { - "time": time, - "comment": html2text(str(comment.content)), - "by": by - }, - "doctype": doctype, - "doc_name": doc_name, - "type": "comment" - }) + timeline.append( + { + "time": comment.modified, + "data": {"time": time, "comment": html2text(str(comment.content)), "by": by}, + "doctype": doctype, + "doc_name": doc_name, + "type": "comment", + } + ) return timeline + def is_document_followed(doctype, doc_name, user): return frappe.db.exists( - "Document Follow", - { - "ref_doctype": doctype, - "ref_docname": doc_name, - "user": user - } + "Document Follow", {"ref_doctype": doctype, "ref_docname": doc_name, "user": user} ) + @frappe.whitelist() def get_follow_users(doctype, doc_name): return frappe.get_all( - "Document Follow", - filters={ - "ref_doctype": doctype, - "ref_docname":doc_name - }, - fields=["user"] + "Document Follow", filters={"ref_doctype": doctype, "ref_docname": doc_name}, fields=["user"] ) + def get_row_changed(row_changed, time, doctype, doc_name, v): from html2text import html2text items = [] for d in row_changed: - d[2] = d[2] if d[2] else ' ' - d[0] = d[0] if d[0] else ' ' - d[3][0][1] = d[3][0][1] if d[3][0][1] else ' ' - items.append({ - "time": v.modified, - "data": { + d[2] = d[2] if d[2] else " " + d[0] = d[0] if d[0] else " " + d[3][0][1] = d[3][0][1] if d[3][0][1] else " " + items.append( + { + "time": v.modified, + "data": { "time": time, "table_field": d[0], "row": str(d[1]), "field": d[3][0][0], "from": html2text(str(d[3][0][1])), - "to": html2text(str(d[3][0][2])) + "to": html2text(str(d[3][0][2])), }, - "doctype": doctype, - "doc_name": doc_name, - "type": "row changed", - "by": v.modified_by - }) + "doctype": doctype, + "doc_name": doc_name, + "type": "row changed", + "by": v.modified_by, + } + ) return items + def get_added_row(added, time, doctype, doc_name, v): items = [] for d in added: - items.append({ - "time": v.modified, - "data": { - "to": d[0], - "time": time - }, - "doctype": doctype, - "doc_name": doc_name, - "type": "row added", - "by": v.modified_by - }) + items.append( + { + "time": v.modified, + "data": {"to": d[0], "time": time}, + "doctype": doctype, + "doc_name": doc_name, + "type": "row added", + "by": v.modified_by, + } + ) return items + def get_field_changed(changed, time, doctype, doc_name, v): from html2text import html2text items = [] for d in changed: - d[1] = d[1] if d[1] else ' ' - d[2] = d[2] if d[2] else ' ' - d[0] = d[0] if d[0] else ' ' - items.append({ - "time": v.modified, - "data": { + d[1] = d[1] if d[1] else " " + d[2] = d[2] if d[2] else " " + d[0] = d[0] if d[0] else " " + items.append( + { + "time": v.modified, + "data": { "time": time, "field": d[0], "from": html2text(str(d[1])), - "to": html2text(str(d[2])) + "to": html2text(str(d[2])), }, - "doctype": doctype, - "doc_name": doc_name, - "type": "field changed", - "by": v.modified_by - }) + "doctype": doctype, + "doc_name": doc_name, + "type": "field changed", + "by": v.modified_by, + } + ) return items + def send_hourly_updates(): send_document_follow_mails("Hourly") + def send_daily_updates(): send_document_follow_mails("Daily") + def send_weekly_updates(): send_document_follow_mails("Weekly") + def get_filters(search_by, name, frequency, user): filters = [] if frequency == "Weekly": filters = [ [search_by, "=", name], - ["modified", ">", frappe.utils.add_days(frappe.utils.nowdate(),-7)], + ["modified", ">", frappe.utils.add_days(frappe.utils.nowdate(), -7)], ["modified", "<", frappe.utils.nowdate()], - ["modified_by", "!=", user] + ["modified_by", "!=", user], ] elif frequency == "Daily": filters = [ [search_by, "=", name], - ["modified", ">", frappe.utils.add_days(frappe.utils.nowdate(),-1)], + ["modified", ">", frappe.utils.add_days(frappe.utils.nowdate(), -1)], ["modified", "<", frappe.utils.nowdate()], - ["modified_by", "!=", user] + ["modified_by", "!=", user], ] elif frequency == "Hourly": filters = [ [search_by, "=", name], ["modified", ">", frappe.utils.add_to_date(frappe.utils.now_datetime(), hours=-1)], ["modified", "<", frappe.utils.now_datetime()], - ["modified_by", "!=", user] + ["modified_by", "!=", user], ] return filters diff --git a/frappe/desk/form/linked_with.py b/frappe/desk/form/linked_with.py index 010d65c95b..7a53c8b65a 100644 --- a/frappe/desk/form/linked_with.py +++ b/frappe/desk/form/linked_with.py @@ -1,9 +1,9 @@ # Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import itertools import json from collections import defaultdict -import itertools from typing import Dict, List, Optional import frappe @@ -16,7 +16,7 @@ from frappe.modules import load_doctype_module @frappe.whitelist() def get_submitted_linked_docs(doctype: str, name: str) -> List[tuple]: - """ Get all the nested submitted documents those are present in referencing tables (dependent tables). + """Get all the nested submitted documents those are present in referencing tables (dependent tables). :param doctype: Document type :param name: Name of the document @@ -25,31 +25,29 @@ def get_submitted_linked_docs(doctype: str, name: str) -> List[tuple]: * User should be able to cancel the linked documents along with the one user trying to cancel. Case1: If document sd1-n1 (document name n1 from sumittable doctype sd1) is linked to sd2-n2 and sd2-n2 is linked to sd3-n3, - Getting submittable linked docs of `sd1-n1`should give both sd2-n2 and sd3-n3. + Getting submittable linked docs of `sd1-n1`should give both sd2-n2 and sd3-n3. Case2: If document sd1-n1 (document name n1 from sumittable doctype sd1) is linked to d2-n2 and d2-n2 is linked to sd3-n3, - Getting submittable linked docs of `sd1-n1`should give None. (because d2-n2 is not a submittable doctype) + Getting submittable linked docs of `sd1-n1`should give None. (because d2-n2 is not a submittable doctype) Case3: If document sd1-n1 (document name n1 from submittable doctype sd1) is linked to d2-n2 & sd2-n2. d2-n2 is linked to sd3-n3. - Getting submittable linked docs of `sd1-n1`should give sd2-n2. + Getting submittable linked docs of `sd1-n1`should give sd2-n2. Logic: ----- 1. We can find linked documents only if we know how the doctypes are related. 2. As we need only submittable documents, we can limit doctype relations search to submittable doctypes by - finding the relationships(Foreign key references) across submittable doctypes. + finding the relationships(Foreign key references) across submittable doctypes. 3. Searching for links is going to be a tree like structure where at every level, - you will be finding documents using parent document and parent document links. + you will be finding documents using parent document and parent document links. """ tree = SubmittableDocumentTree(doctype, name) visited_documents = tree.get_all_children() docs = [] for dt, names in visited_documents.items(): - docs.extend([{'doctype': dt, 'name': name, 'docstatus': 1} for name in names]) + docs.extend([{"doctype": dt, "name": name, "docstatus": 1} for name in names]) + + return {"docs": docs, "count": len(docs)} - return { - "docs": docs, - "count": len(docs) - } class SubmittableDocumentTree: def __init__(self, doctype: str, name: str): @@ -68,8 +66,8 @@ class SubmittableDocumentTree: self.to_be_visited_documents = {doctype: [name]} self.visited_documents = defaultdict(list) - self._submittable_doctypes = None # All submittable doctypes in the system - self._references_across_doctypes = None # doctype wise links/references + self._submittable_doctypes = None # All submittable doctypes in the system + self._references_across_doctypes = None # doctype wise links/references def get_all_children(self): """Get all nodes of a tree except the root node (all the nested submitted @@ -98,75 +96,86 @@ class SubmittableDocumentTree: return self.visited_documents def get_next_level_children(self, parent_dt, parent_names): - """Get immediate children of a Node(parent_dt, parent_names) - """ + """Get immediate children of a Node(parent_dt, parent_names)""" referencing_fields = self.get_doctype_references(parent_dt) child_docs = defaultdict(list) for field in referencing_fields: - links = get_referencing_documents(parent_dt, parent_names.copy(), field, get_parent_if_child_table_doc=True, - parent_filters=[('docstatus', '=', 1)], allowed_parents=self.get_link_sources()) or {} + links = ( + get_referencing_documents( + parent_dt, + parent_names.copy(), + field, + get_parent_if_child_table_doc=True, + parent_filters=[("docstatus", "=", 1)], + allowed_parents=self.get_link_sources(), + ) + or {} + ) for dt, names in links.items(): child_docs[dt].extend(names) return child_docs def get_doctype_references(self, doctype): - """Get references for a given document. - """ + """Get references for a given document.""" if self._references_across_doctypes is None: get_links_to = self.get_document_sources() limit_link_doctypes = self.get_link_sources() self._references_across_doctypes = get_references_across_doctypes( - get_links_to, limit_link_doctypes) + get_links_to, limit_link_doctypes + ) return self._references_across_doctypes.get(doctype, []) def get_document_sources(self): - """Returns list of doctypes from where we access submittable documents. - """ + """Returns list of doctypes from where we access submittable documents.""" return list(set(self.get_link_sources() + [self.root_doctype])) def get_link_sources(self): - """limit doctype links to these doctypes. - """ + """limit doctype links to these doctypes.""" return list(set(self.get_submittable_doctypes()) - set(get_exempted_doctypes() or [])) def get_submittable_doctypes(self) -> List[str]: - """Returns list of submittable doctypes. - """ + """Returns list of submittable doctypes.""" if not self._submittable_doctypes: - self._submittable_doctypes = frappe.db.get_all('DocType', {'is_submittable': 1}, pluck='name') + self._submittable_doctypes = frappe.db.get_all("DocType", {"is_submittable": 1}, pluck="name") return self._submittable_doctypes -def get_child_tables_of_doctypes(doctypes: List[str]=None): - """Returns child tables by doctype. - """ - filters=[['fieldtype','=', 'Table']] +def get_child_tables_of_doctypes(doctypes: List[str] = None): + """Returns child tables by doctype.""" + filters = [["fieldtype", "=", "Table"]] filters_for_docfield = filters filters_for_customfield = filters if doctypes: - filters_for_docfield = filters + [['parent', 'in', tuple(doctypes)]] - filters_for_customfield = filters + [['dt', 'in', tuple(doctypes)]] + filters_for_docfield = filters + [["parent", "in", tuple(doctypes)]] + filters_for_customfield = filters + [["dt", "in", tuple(doctypes)]] - links = frappe.get_all("DocField", + links = frappe.get_all( + "DocField", fields=["parent", "fieldname", "options as child_table"], filters=filters_for_docfield, - as_list=1) + as_list=1, + ) - links+= frappe.get_all("Custom Field", + links += frappe.get_all( + "Custom Field", fields=["dt as parent", "fieldname", "options as child_table"], filters=filters_for_customfield, - as_list=1) + as_list=1, + ) child_tables_by_doctype = defaultdict(list) for doctype, fieldname, child_table in links: child_tables_by_doctype[doctype].append( - {'doctype': doctype, 'fieldname': fieldname, 'child_table': child_table}) + {"doctype": doctype, "fieldname": fieldname, "child_table": child_table} + ) return child_tables_by_doctype -def get_references_across_doctypes(to_doctypes: List[str]=None, limit_link_doctypes: List[str]=None) -> List: +def get_references_across_doctypes( + to_doctypes: List[str] = None, limit_link_doctypes: List[str] = None +) -> List: """Find doctype wise foreign key references. :param to_doctypes: Get links of these doctypes. @@ -176,14 +185,22 @@ def get_references_across_doctypes(to_doctypes: List[str]=None, limit_link_docty """ if limit_link_doctypes: child_tables_by_doctype = get_child_tables_of_doctypes(limit_link_doctypes) - all_child_tables = [each['child_table'] for each in itertools.chain(*child_tables_by_doctype.values())] + all_child_tables = [ + each["child_table"] for each in itertools.chain(*child_tables_by_doctype.values()) + ] limit_link_doctypes = limit_link_doctypes + all_child_tables else: child_tables_by_doctype = get_child_tables_of_doctypes() - all_child_tables = [each['child_table'] for each in itertools.chain(*child_tables_by_doctype.values())] + all_child_tables = [ + each["child_table"] for each in itertools.chain(*child_tables_by_doctype.values()) + ] - references_by_link_fields = get_references_across_doctypes_by_link_field(to_doctypes, limit_link_doctypes) - references_by_dlink_fields = get_references_across_doctypes_by_dynamic_link_field(to_doctypes, limit_link_doctypes) + references_by_link_fields = get_references_across_doctypes_by_link_field( + to_doctypes, limit_link_doctypes + ) + references_by_dlink_fields = get_references_across_doctypes_by_dynamic_link_field( + to_doctypes, limit_link_doctypes + ) references = references_by_link_fields.copy() for k, v in references_by_dlink_fields.items(): @@ -191,118 +208,140 @@ def get_references_across_doctypes(to_doctypes: List[str]=None, limit_link_docty for doctype, links in references.items(): for link in links: - link['is_child'] = (link['doctype'] in all_child_tables) + link["is_child"] = link["doctype"] in all_child_tables return references -def get_references_across_doctypes_by_link_field(to_doctypes: List[str]=None, limit_link_doctypes: List[str]=None): +def get_references_across_doctypes_by_link_field( + to_doctypes: List[str] = None, limit_link_doctypes: List[str] = None +): """Find doctype wise foreign key references based on link fields. :param to_doctypes: Get links to these doctypes. :param limit_link_doctypes: limit links to these doctypes. """ - filters=[['fieldtype','=', 'Link']] + filters = [["fieldtype", "=", "Link"]] if to_doctypes: - filters += [['options', 'in', tuple(to_doctypes)]] + filters += [["options", "in", tuple(to_doctypes)]] filters_for_docfield = filters[:] filters_for_customfield = filters[:] if limit_link_doctypes: - filters_for_docfield += [['parent', 'in', tuple(limit_link_doctypes)]] - filters_for_customfield += [['dt', 'in', tuple(limit_link_doctypes)]] + filters_for_docfield += [["parent", "in", tuple(limit_link_doctypes)]] + filters_for_customfield += [["dt", "in", tuple(limit_link_doctypes)]] - links = frappe.get_all("DocField", + links = frappe.get_all( + "DocField", fields=["parent", "fieldname", "options as linked_to"], filters=filters_for_docfield, - as_list=1) + as_list=1, + ) - links+= frappe.get_all("Custom Field", + links += frappe.get_all( + "Custom Field", fields=["dt as parent", "fieldname", "options as linked_to"], filters=filters_for_customfield, - as_list=1) + as_list=1, + ) links_by_doctype = defaultdict(list) for doctype, fieldname, linked_to in links: - links_by_doctype[linked_to].append({'doctype': doctype, 'fieldname': fieldname}) + links_by_doctype[linked_to].append({"doctype": doctype, "fieldname": fieldname}) return links_by_doctype -def get_references_across_doctypes_by_dynamic_link_field(to_doctypes: List[str]=None, limit_link_doctypes: List[str]=None): +def get_references_across_doctypes_by_dynamic_link_field( + to_doctypes: List[str] = None, limit_link_doctypes: List[str] = None +): """Find doctype wise foreign key references based on dynamic link fields. :param to_doctypes: Get links to these doctypes. :param limit_link_doctypes: limit links to these doctypes. """ - filters=[['fieldtype','=', 'Dynamic Link']] + filters = [["fieldtype", "=", "Dynamic Link"]] filters_for_docfield = filters[:] filters_for_customfield = filters[:] if limit_link_doctypes: - filters_for_docfield += [['parent', 'in', tuple(limit_link_doctypes)]] - filters_for_customfield += [['dt', 'in', tuple(limit_link_doctypes)]] + filters_for_docfield += [["parent", "in", tuple(limit_link_doctypes)]] + filters_for_customfield += [["dt", "in", tuple(limit_link_doctypes)]] # find dynamic links of parents - links = frappe.get_all("DocField", + links = frappe.get_all( + "DocField", fields=["parent as doctype", "fieldname", "options as doctype_fieldname"], filters=filters_for_docfield, - as_list=1) + as_list=1, + ) - links += frappe.get_all("Custom Field", + links += frappe.get_all( + "Custom Field", fields=["dt as doctype", "fieldname", "options as doctype_fieldname"], filters=filters_for_customfield, - as_list=1) + as_list=1, + ) links_by_doctype = defaultdict(list) for doctype, fieldname, doctype_fieldname in links: try: - filters = [[doctype_fieldname, 'in', to_doctypes]] if to_doctypes else [] - for linked_to in frappe.db.get_all(doctype, pluck=doctype_fieldname, filters = filters, distinct=1): + filters = [[doctype_fieldname, "in", to_doctypes]] if to_doctypes else [] + for linked_to in frappe.db.get_all( + doctype, pluck=doctype_fieldname, filters=filters, distinct=1 + ): if linked_to: - links_by_doctype[linked_to].append({'doctype': doctype, 'fieldname': fieldname, 'doctype_fieldname': doctype_fieldname}) + links_by_doctype[linked_to].append( + {"doctype": doctype, "fieldname": fieldname, "doctype_fieldname": doctype_fieldname} + ) except frappe.db.ProgrammingError: # TODO: FIXME continue return links_by_doctype -def get_referencing_documents(reference_doctype: str, reference_names: List[str], - link_info: dict, get_parent_if_child_table_doc: bool=True, - parent_filters: List[list]=None, child_filters=None, allowed_parents=None): + +def get_referencing_documents( + reference_doctype: str, + reference_names: List[str], + link_info: dict, + get_parent_if_child_table_doc: bool = True, + parent_filters: List[list] = None, + child_filters=None, + allowed_parents=None, +): """Get linked documents based on link_info. :param reference_doctype: reference doctype to find links :param reference_names: reference document names to find links for :param link_info: linking details to get the linked documents - Ex: {'doctype': 'Purchase Invoice Advance', 'fieldname': 'reference_name', - 'doctype_fieldname': 'reference_type', 'is_child': True} + Ex: {'doctype': 'Purchase Invoice Advance', 'fieldname': 'reference_name', + 'doctype_fieldname': 'reference_type', 'is_child': True} :param get_parent_if_child_table_doc: Get parent record incase linked document is a child table record. :param parent_filters: filters to apply on if not a child table. :param child_filters: apply filters if it is a child table. :param allowed_parents: list of parents allowed in case of get_parent_if_child_table_doc - is enabled. + is enabled. """ - from_table = link_info['doctype'] - filters = [[link_info['fieldname'], 'in', tuple(reference_names)]] - if link_info.get('doctype_fieldname'): - filters.append([link_info['doctype_fieldname'], '=', reference_doctype]) + from_table = link_info["doctype"] + filters = [[link_info["fieldname"], "in", tuple(reference_names)]] + if link_info.get("doctype_fieldname"): + filters.append([link_info["doctype_fieldname"], "=", reference_doctype]) - if not link_info.get('is_child'): + if not link_info.get("is_child"): filters.extend(parent_filters or []) - return {from_table: frappe.db.get_all(from_table, filters, pluck='name')} - + return {from_table: frappe.db.get_all(from_table, filters, pluck="name")} filters.extend(child_filters or []) - res = frappe.db.get_all(from_table, filters = filters, fields = ['name', 'parenttype', 'parent']) + res = frappe.db.get_all(from_table, filters=filters, fields=["name", "parenttype", "parent"]) documents = defaultdict(list) - for parent, rows in itertools.groupby(res, key = lambda row: row['parenttype']): + for parent, rows in itertools.groupby(res, key=lambda row: row["parenttype"]): if allowed_parents and parent not in allowed_parents: continue - filters = (parent_filters or []) + [['name', 'in', tuple([row.parent for row in rows])]] - documents[parent].extend(frappe.db.get_all(parent, filters=filters, pluck='name') or []) + filters = (parent_filters or []) + [["name", "in", tuple([row.parent for row in rows])]] + documents[parent].extend(frappe.db.get_all(parent, filters=filters, pluck="name") or []) return documents @@ -312,8 +351,8 @@ def cancel_all_linked_docs(docs, ignore_doctypes_on_cancel_all=None): Cancel all linked doctype, optionally ignore doctypes specified in a list. Arguments: - docs (json str) - It contains list of dictionaries of a linked documents. - ignore_doctypes_on_cancel_all (list) - List of doctypes to ignore while cancelling. + docs (json str) - It contains list of dictionaries of a linked documents. + ignore_doctypes_on_cancel_all (list) - List of doctypes to ignore while cancelling. """ if ignore_doctypes_on_cancel_all is None: ignore_doctypes_on_cancel_all = [] @@ -325,7 +364,7 @@ def cancel_all_linked_docs(docs, ignore_doctypes_on_cancel_all=None): if validate_linked_doc(doc, ignore_doctypes_on_cancel_all): linked_doc = frappe.get_doc(doc.get("doctype"), doc.get("name")) linked_doc.cancel() - frappe.publish_progress(percent=i/len(docs) * 100, title=_("Cancelling documents")) + frappe.publish_progress(percent=i / len(docs) * 100, title=_("Cancelling documents")) def validate_linked_doc(docinfo, ignore_doctypes_on_cancel_all=None): @@ -333,36 +372,36 @@ def validate_linked_doc(docinfo, ignore_doctypes_on_cancel_all=None): Validate a document to be submitted and non-exempted from auto-cancel. Arguments: - docinfo (dict): The document to check for submitted and non-exempt from auto-cancel - ignore_doctypes_on_cancel_all (list) - List of doctypes to ignore while cancelling. + docinfo (dict): The document to check for submitted and non-exempt from auto-cancel + ignore_doctypes_on_cancel_all (list) - List of doctypes to ignore while cancelling. Returns: - bool: True if linked document passes all validations, else False + bool: True if linked document passes all validations, else False """ - #ignore doctype to cancel + # ignore doctype to cancel if docinfo.get("doctype") in (ignore_doctypes_on_cancel_all or []): return False # skip non-submittable doctypes since they don't need to be cancelled - if not frappe.get_meta(docinfo.get('doctype')).is_submittable: + if not frappe.get_meta(docinfo.get("doctype")).is_submittable: return False # skip draft or cancelled documents - if docinfo.get('docstatus') != 1: + if docinfo.get("docstatus") != 1: return False # skip other doctypes since they don't need to be cancelled auto_cancel_exempt_doctypes = get_exempted_doctypes() - if docinfo.get('doctype') in auto_cancel_exempt_doctypes: + if docinfo.get("doctype") in auto_cancel_exempt_doctypes: return False return True def get_exempted_doctypes(): - """ Get list of doctypes exempted from being auto-cancelled """ + """Get list of doctypes exempted from being auto-cancelled""" auto_cancel_exempt_doctypes = [] - for doctypes in frappe.get_hooks('auto_cancel_exempted_doctypes'): + for doctypes in frappe.get_hooks("auto_cancel_exempted_doctypes"): auto_cancel_exempt_doctypes.append(doctypes) return auto_cancel_exempt_doctypes @@ -394,16 +433,23 @@ def get_linked_docs(doctype: str, name: str, linkinfo: Optional[Dict] = None) -> continue if not linkmeta.get("issingle"): - fields = [d.fieldname for d in linkmeta.get("fields", { - "in_list_view": 1, - "fieldtype": ["not in", ("Image", "HTML", "Button") + frappe.model.table_fields] - })] + ["name", "modified", "docstatus"] + fields = [ + d.fieldname + for d in linkmeta.get( + "fields", + { + "in_list_view": 1, + "fieldtype": ["not in", ("Image", "HTML", "Button") + frappe.model.table_fields], + }, + ) + ] + ["name", "modified", "docstatus"] if link.get("add_fields"): fields += link["add_fields"] - fields = ["`tab{dt}`.`{fn}`".format(dt=dt, fn=sf.strip()) for sf in fields if sf - and "`tab" not in sf] + fields = [ + "`tab{dt}`.`{fn}`".format(dt=dt, fn=sf.strip()) for sf in fields if sf and "`tab" not in sf + ] try: if link.get("filters"): @@ -418,24 +464,28 @@ def get_linked_docs(doctype: str, name: str, linkinfo: Optional[Dict] = None) -> me = frappe.db.get_value(doctype, name, ["parenttype", "parent"], as_dict=True) if me and me.parenttype == dt: - ret = frappe.get_all(doctype=dt, fields=fields, - filters=[[dt, "name", '=', me.parent]]) + ret = frappe.get_all(doctype=dt, fields=fields, filters=[[dt, "name", "=", me.parent]]) elif link.get("child_doctype"): - or_filters = [[link.get('child_doctype'), link_fieldnames, '=', name] for link_fieldnames in link.get("fieldname")] + or_filters = [ + [link.get("child_doctype"), link_fieldnames, "=", name] + for link_fieldnames in link.get("fieldname") + ] # dynamic link if link.get("doctype_fieldname"): - filters.append([link.get('child_doctype'), link.get("doctype_fieldname"), "=", doctype]) + filters.append([link.get("child_doctype"), link.get("doctype_fieldname"), "=", doctype]) - ret = frappe.get_all(doctype=dt, fields=fields, filters=filters, or_filters=or_filters, distinct=True) + ret = frappe.get_all( + doctype=dt, fields=fields, filters=filters, or_filters=or_filters, distinct=True + ) else: link_fieldnames = link.get("fieldname") if link_fieldnames: if isinstance(link_fieldnames, str): link_fieldnames = [link_fieldnames] - or_filters = [[dt, fieldname, '=', name] for fieldname in link_fieldnames] + or_filters = [[dt, fieldname, "=", name] for fieldname in link_fieldnames] # dynamic link if link.get("doctype_fieldname"): filters.append([dt, link.get("doctype_fieldname"), "=", doctype]) @@ -468,11 +518,14 @@ def get_linked_doctypes(doctype, without_ignore_user_permissions_enabled=False): Example, for Customer: - {"Address": {"fieldname": "customer"}..} + {"Address": {"fieldname": "customer"}..} """ - if(without_ignore_user_permissions_enabled): - return frappe.cache().hget("linked_doctypes_without_ignore_user_permissions_enabled", - doctype, lambda: _get_linked_doctypes(doctype, without_ignore_user_permissions_enabled)) + if without_ignore_user_permissions_enabled: + return frappe.cache().hget( + "linked_doctypes_without_ignore_user_permissions_enabled", + doctype, + lambda: _get_linked_doctypes(doctype, without_ignore_user_permissions_enabled), + ) else: return frappe.cache().hget("linked_doctypes", doctype, lambda: _get_linked_doctypes(doctype)) @@ -483,14 +536,16 @@ def _get_linked_doctypes(doctype, without_ignore_user_permissions_enabled=False) ret.update(get_linked_fields(doctype, without_ignore_user_permissions_enabled)) ret.update(get_dynamic_linked_fields(doctype, without_ignore_user_permissions_enabled)) - filters = [['fieldtype', 'in', frappe.model.table_fields], ['options', '=', doctype]] - if without_ignore_user_permissions_enabled: filters.append(['ignore_user_permissions', '!=', 1]) + filters = [["fieldtype", "in", frappe.model.table_fields], ["options", "=", doctype]] + if without_ignore_user_permissions_enabled: + filters.append(["ignore_user_permissions", "!=", 1]) # find links of parents links = frappe.get_all("DocField", fields=["parent as dt"], filters=filters) - links+= frappe.get_all("Custom Field", fields=["dt"], filters=filters) + links += frappe.get_all("Custom Field", fields=["dt"], filters=filters) - for dt, in links: - if dt in ret: continue + for (dt,) in links: + if dt in ret: + continue ret[dt] = {"get_parent": True} for dt in list(ret): @@ -509,31 +564,44 @@ def _get_linked_doctypes(doctype, without_ignore_user_permissions_enabled=False) def get_linked_fields(doctype, without_ignore_user_permissions_enabled=False): - filters = [['fieldtype','=', 'Link'], ['options', '=', doctype]] - if without_ignore_user_permissions_enabled: filters.append(['ignore_user_permissions', '!=', 1]) + filters = [["fieldtype", "=", "Link"], ["options", "=", doctype]] + if without_ignore_user_permissions_enabled: + filters.append(["ignore_user_permissions", "!=", 1]) # find links of parents links = frappe.get_all("DocField", fields=["parent", "fieldname"], filters=filters, as_list=1) - links += frappe.get_all("Custom Field", fields=["dt as parent", "fieldname"], filters=filters, as_list=1) + links += frappe.get_all( + "Custom Field", fields=["dt as parent", "fieldname"], filters=filters, as_list=1 + ) ret = {} - if not links: return ret + if not links: + return ret links_dict = defaultdict(list) for doctype, fieldname in links: links_dict[doctype].append(fieldname) for doctype_name in links_dict: - ret[doctype_name] = { "fieldname": links_dict.get(doctype_name) } - table_doctypes = frappe.get_all("DocType", filters=[["istable", "=", "1"], ["name", "in", tuple(links_dict)]]) - child_filters = [['fieldtype','in', frappe.model.table_fields], ['options', 'in', tuple(doctype.name for doctype in table_doctypes)]] - if without_ignore_user_permissions_enabled: child_filters.append(['ignore_user_permissions', '!=', 1]) + ret[doctype_name] = {"fieldname": links_dict.get(doctype_name)} + table_doctypes = frappe.get_all( + "DocType", filters=[["istable", "=", "1"], ["name", "in", tuple(links_dict)]] + ) + child_filters = [ + ["fieldtype", "in", frappe.model.table_fields], + ["options", "in", tuple(doctype.name for doctype in table_doctypes)], + ] + if without_ignore_user_permissions_enabled: + child_filters.append(["ignore_user_permissions", "!=", 1]) # find out if linked in a child table - for parent, options in frappe.get_all("DocField", fields=["parent", "options"], filters=child_filters, as_list=1): - ret[parent] = { "child_doctype": options, "fieldname": links_dict[options]} - if options in ret: del ret[options] + for parent, options in frappe.get_all( + "DocField", fields=["parent", "options"], filters=child_filters, as_list=1 + ): + ret[parent] = {"child_doctype": options, "fieldname": links_dict[options]} + if options in ret: + del ret[options] return ret @@ -541,37 +609,45 @@ def get_linked_fields(doctype, without_ignore_user_permissions_enabled=False): def get_dynamic_linked_fields(doctype, without_ignore_user_permissions_enabled=False): ret = {} - filters = [['fieldtype','=', 'Dynamic Link']] - if without_ignore_user_permissions_enabled: filters.append(['ignore_user_permissions', '!=', 1]) + filters = [["fieldtype", "=", "Dynamic Link"]] + if without_ignore_user_permissions_enabled: + filters.append(["ignore_user_permissions", "!=", 1]) # find dynamic links of parents - links = frappe.get_all("DocField", fields=["parent as doctype", "fieldname", "options as doctype_fieldname"], filters=filters) - links += frappe.get_all("Custom Field", fields=["dt as doctype", "fieldname", "options as doctype_fieldname"], filters=filters) + links = frappe.get_all( + "DocField", + fields=["parent as doctype", "fieldname", "options as doctype_fieldname"], + filters=filters, + ) + links += frappe.get_all( + "Custom Field", + fields=["dt as doctype", "fieldname", "options as doctype_fieldname"], + filters=filters, + ) for df in links: - if is_single(df.doctype): continue + if is_single(df.doctype): + continue is_child = frappe.get_meta(df.doctype).istable possible_link = frappe.get_all( df.doctype, filters={df.doctype_fieldname: doctype}, fields=["parenttype"] if is_child else None, - distinct=True + distinct=True, ) - if not possible_link: continue + if not possible_link: + continue if is_child: for d in possible_link: ret[d.parenttype] = { "child_doctype": df.doctype, "fieldname": [df.fieldname], - "doctype_fieldname": df.doctype_fieldname + "doctype_fieldname": df.doctype_fieldname, } else: - ret[df.doctype] = { - "fieldname": [df.fieldname], - "doctype_fieldname": df.doctype_fieldname - } + ret[df.doctype] = {"fieldname": [df.fieldname], "doctype_fieldname": df.doctype_fieldname} return ret diff --git a/frappe/desk/form/load.py b/frappe/desk/form/load.py index 9abf64c2cc..636b662a09 100644 --- a/frappe/desk/form/load.py +++ b/frappe/desk/form/load.py @@ -1,19 +1,20 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json from typing import Dict, List, Union -import frappe, json -import frappe.utils -import frappe.share +from urllib.parse import quote + +import frappe import frappe.defaults import frappe.desk.form.meta +import frappe.share +import frappe.utils +from frappe import _, _dict +from frappe.desk.form.document_follow import is_document_followed from frappe.model.utils.user_settings import get_user_settings from frappe.permissions import get_doc_permissions -from frappe.desk.form.document_follow import is_document_followed from frappe.utils.data import cstr -from frappe import _ -from frappe import _dict -from urllib.parse import quote @frappe.whitelist() @@ -25,7 +26,7 @@ def getdoc(doctype, name, user=None): """ if not (doctype and name): - raise Exception('doctype and name required!') + raise Exception("doctype and name required!") if not name: name = doctype @@ -38,7 +39,9 @@ def getdoc(doctype, name, user=None): run_onload(doc) if not doc.has_permission("read"): - frappe.flags.error_message = _('Insufficient Permission for {0}').format(frappe.bold(doctype + ' ' + name)) + frappe.flags.error_message = _("Insufficient Permission for {0}").format( + frappe.bold(doctype + " " + name) + ) raise frappe.PermissionError(("read", doctype, name)) doc.apply_fieldlevel_read_permissions() @@ -70,18 +73,19 @@ def getdoctype(doctype, with_parent=False, cached_timestamp=None): parent_dt = frappe.model.meta.get_parent_dt(doctype) if parent_dt: docs = get_meta_bundle(parent_dt) - frappe.response['parent_dt'] = parent_dt + frappe.response["parent_dt"] = parent_dt if not docs: docs = get_meta_bundle(doctype) - frappe.response['user_settings'] = get_user_settings(parent_dt or doctype) + frappe.response["user_settings"] = get_user_settings(parent_dt or doctype) - if cached_timestamp and docs[0].modified==cached_timestamp: + if cached_timestamp and docs[0].modified == cached_timestamp: return "use_cache" frappe.response.docs.extend(docs) + def get_meta_bundle(doctype): bundle = [frappe.desk.form.meta.get_meta(doctype)] for df in bundle[0].fields: @@ -89,6 +93,7 @@ def get_meta_bundle(doctype): bundle.append(frappe.desk.form.meta.get_meta(df.options, not frappe.conf.developer_mode)) return bundle + @frappe.whitelist() def get_docinfo(doc=None, doctype=None, name=None): if not doc: @@ -97,35 +102,42 @@ def get_docinfo(doc=None, doctype=None, name=None): raise frappe.PermissionError all_communications = _get_communications(doc.doctype, doc.name) - automated_messages = [msg for msg in all_communications if msg['communication_type'] == 'Automated Message'] - communications_except_auto_messages = [msg for msg in all_communications if msg['communication_type'] != 'Automated Message'] + automated_messages = [ + msg for msg in all_communications if msg["communication_type"] == "Automated Message" + ] + communications_except_auto_messages = [ + msg for msg in all_communications if msg["communication_type"] != "Automated Message" + ] - docinfo = frappe._dict(user_info = {}) + docinfo = frappe._dict(user_info={}) add_comments(doc, docinfo) - docinfo.update({ - "attachments": get_attachments(doc.doctype, doc.name), - "communications": communications_except_auto_messages, - "automated_messages": automated_messages, - 'total_comments': len(json.loads(doc.get('_comments') or '[]')), - 'versions': get_versions(doc), - "assignments": get_assignments(doc.doctype, doc.name), - "permissions": get_doc_permissions(doc), - "shared": frappe.share.get_users(doc.doctype, doc.name), - "views": get_view_logs(doc.doctype, doc.name), - "energy_point_logs": get_point_logs(doc.doctype, doc.name), - "additional_timeline_content": get_additional_timeline_content(doc.doctype, doc.name), - "milestones": get_milestones(doc.doctype, doc.name), - "is_document_followed": is_document_followed(doc.doctype, doc.name, frappe.session.user), - "tags": get_tags(doc.doctype, doc.name), - "document_email": get_document_email(doc.doctype, doc.name), - }) + docinfo.update( + { + "attachments": get_attachments(doc.doctype, doc.name), + "communications": communications_except_auto_messages, + "automated_messages": automated_messages, + "total_comments": len(json.loads(doc.get("_comments") or "[]")), + "versions": get_versions(doc), + "assignments": get_assignments(doc.doctype, doc.name), + "permissions": get_doc_permissions(doc), + "shared": frappe.share.get_users(doc.doctype, doc.name), + "views": get_view_logs(doc.doctype, doc.name), + "energy_point_logs": get_point_logs(doc.doctype, doc.name), + "additional_timeline_content": get_additional_timeline_content(doc.doctype, doc.name), + "milestones": get_milestones(doc.doctype, doc.name), + "is_document_followed": is_document_followed(doc.doctype, doc.name, frappe.session.user), + "tags": get_tags(doc.doctype, doc.name), + "document_email": get_document_email(doc.doctype, doc.name), + } + ) update_user_info(docinfo) frappe.response["docinfo"] = docinfo + def add_comments(doc, docinfo): # divide comments into separate lists docinfo.comments = [] @@ -136,12 +148,10 @@ def add_comments(doc, docinfo): docinfo.like_logs = [] docinfo.workflow_logs = [] - comments = frappe.get_all("Comment", + comments = frappe.get_all( + "Comment", fields=["name", "creation", "content", "owner", "comment_type"], - filters={ - "reference_doctype": doc.doctype, - "reference_name": doc.name - } + filters={"reference_doctype": doc.doctype, "reference_name": doc.name}, ) for c in comments: @@ -149,16 +159,16 @@ def add_comments(doc, docinfo): c.content = frappe.utils.markdown(c.content) docinfo.comments.append(c) - elif c.comment_type in ('Shared', 'Unshared'): + elif c.comment_type in ("Shared", "Unshared"): docinfo.shared.append(c) - elif c.comment_type in ('Assignment Completed', 'Assigned'): + elif c.comment_type in ("Assignment Completed", "Assigned"): docinfo.assignment_logs.append(c) - elif c.comment_type in ('Attachment', 'Attachment Removed'): + elif c.comment_type in ("Attachment", "Attachment Removed"): docinfo.attachment_logs.append(c) - elif c.comment_type in ('Info', 'Edit', 'Label'): + elif c.comment_type in ("Info", "Edit", "Label"): docinfo.info_logs.append(c) elif c.comment_type == "Like": @@ -169,21 +179,34 @@ def add_comments(doc, docinfo): frappe.utils.add_user_info(c.owner, docinfo.user_info) - return comments def get_milestones(doctype, name): - return frappe.db.get_all('Milestone', fields = ['creation', 'owner', 'track_field', 'value'], - filters=dict(reference_type=doctype, reference_name=name)) + return frappe.db.get_all( + "Milestone", + fields=["creation", "owner", "track_field", "value"], + filters=dict(reference_type=doctype, reference_name=name), + ) + def get_attachments(dt, dn): - return frappe.get_all("File", fields=["name", "file_name", "file_url", "is_private"], - filters = {"attached_to_name": dn, "attached_to_doctype": dt}) + return frappe.get_all( + "File", + fields=["name", "file_name", "file_url", "is_private"], + filters={"attached_to_name": dn, "attached_to_doctype": dt}, + ) + def get_versions(doc): - return frappe.get_all('Version', filters=dict(ref_doctype=doc.doctype, docname=doc.name), - fields=['name', 'owner', 'creation', 'data'], limit=10, order_by='creation desc') + return frappe.get_all( + "Version", + filters=dict(ref_doctype=doc.doctype, docname=doc.name), + fields=["name", "owner", "creation", "data"], + limit=10, + order_by="creation desc", + ) + @frappe.whitelist() def get_communications(doctype, name, start=0, limit=20): @@ -194,29 +217,32 @@ def get_communications(doctype, name, start=0, limit=20): return _get_communications(doctype, name, start, limit) -def get_comments(doctype: str, name: str, comment_type : Union[str, List[str]] = "Comment") -> List[frappe._dict]: +def get_comments( + doctype: str, name: str, comment_type: Union[str, List[str]] = "Comment" +) -> List[frappe._dict]: if isinstance(comment_type, list): comment_types = comment_type - elif comment_type == 'share': - comment_types = ['Shared', 'Unshared'] + elif comment_type == "share": + comment_types = ["Shared", "Unshared"] - elif comment_type == 'assignment': - comment_types = ['Assignment Completed', 'Assigned'] + elif comment_type == "assignment": + comment_types = ["Assignment Completed", "Assigned"] - elif comment_type == 'attachment': - comment_types = ['Attachment', 'Attachment Removed'] + elif comment_type == "attachment": + comment_types = ["Attachment", "Attachment Removed"] else: comment_types = [comment_type] - comments = frappe.get_all("Comment", + comments = frappe.get_all( + "Comment", fields=["name", "creation", "content", "owner", "comment_type"], filters={ "reference_doctype": doctype, "reference_name": name, - "comment_type": ['in', comment_types], - } + "comment_type": ["in", comment_types], + }, ) # convert to markdown (legacy ?) @@ -226,94 +252,111 @@ def get_comments(doctype: str, name: str, comment_type : Union[str, List[str]] = return comments + def get_point_logs(doctype, docname): - return frappe.db.get_all('Energy Point Log', filters={ - 'reference_doctype': doctype, - 'reference_name': docname, - 'type': ['!=', 'Review'] - }, fields=['*']) + return frappe.db.get_all( + "Energy Point Log", + filters={"reference_doctype": doctype, "reference_name": docname, "type": ["!=", "Review"]}, + fields=["*"], + ) + def _get_communications(doctype, name, start=0, limit=20): communications = get_communication_data(doctype, name, start, limit) for c in communications: - if c.communication_type=="Communication": - c.attachments = json.dumps(frappe.get_all("File", - fields=["file_url", "is_private"], - filters={"attached_to_doctype": "Communication", - "attached_to_name": c.name} - )) + if c.communication_type == "Communication": + c.attachments = json.dumps( + frappe.get_all( + "File", + fields=["file_url", "is_private"], + filters={"attached_to_doctype": "Communication", "attached_to_name": c.name}, + ) + ) return communications -def get_communication_data(doctype, name, start=0, limit=20, after=None, fields=None, - group_by=None, as_dict=True): - '''Returns list of communications for a given document''' + +def get_communication_data( + doctype, name, start=0, limit=20, after=None, fields=None, group_by=None, as_dict=True +): + """Returns list of communications for a given document""" if not fields: - fields = ''' + fields = """ C.name, C.communication_type, C.communication_medium, C.comment_type, C.communication_date, C.content, C.sender, C.sender_full_name, C.cc, C.bcc, C.creation AS creation, C.subject, C.delivery_status, C._liked_by, C.reference_doctype, C.reference_name, C.read_by_recipient, C.rating, C.recipients - ''' + """ - conditions = '' + conditions = "" if after: # find after a particular date - conditions += ''' + conditions += """ AND C.creation > {0} - '''.format(after) + """.format( + after + ) - if doctype=='User': - conditions += ''' + if doctype == "User": + conditions += """ AND NOT (C.reference_doctype='User' AND C.communication_type='Communication') - ''' + """ # communications linked to reference_doctype - part1 = ''' + part1 = """ SELECT {fields} FROM `tabCommunication` as C WHERE C.communication_type IN ('Communication', 'Feedback', 'Automated Message') AND (C.reference_doctype = %(doctype)s AND C.reference_name = %(name)s) {conditions} - '''.format(fields=fields, conditions=conditions) + """.format( + fields=fields, conditions=conditions + ) # communications linked in Timeline Links - part2 = ''' + part2 = """ SELECT {fields} FROM `tabCommunication` as C INNER JOIN `tabCommunication Link` ON C.name=`tabCommunication Link`.parent WHERE C.communication_type IN ('Communication', 'Feedback', 'Automated Message') AND `tabCommunication Link`.link_doctype = %(doctype)s AND `tabCommunication Link`.link_name = %(name)s {conditions} - '''.format(fields=fields, conditions=conditions) + """.format( + fields=fields, conditions=conditions + ) - communications = frappe.db.sql(''' + communications = frappe.db.sql( + """ SELECT * FROM (({part1}) UNION ({part2})) AS combined {group_by} ORDER BY creation DESC LIMIT %(limit)s OFFSET %(start)s - '''.format(part1=part1, part2=part2, group_by=(group_by or '')), dict( - doctype=doctype, - name=name, - start=frappe.utils.cint(start), - limit=limit - ), as_dict=as_dict) + """.format( + part1=part1, part2=part2, group_by=(group_by or "") + ), + dict(doctype=doctype, name=name, start=frappe.utils.cint(start), limit=limit), + as_dict=as_dict, + ) return communications + def get_assignments(dt, dn): - return frappe.get_all("ToDo", - fields=['name', 'allocated_to as owner', 'description', 'status'], + return frappe.get_all( + "ToDo", + fields=["name", "allocated_to as owner", "description", "status"], filters={ - 'reference_type': dt, - 'reference_name': dn, - 'status': ('!=', 'Cancelled'), - 'allocated_to': ("is", "set") - }) + "reference_type": dt, + "reference_name": dn, + "status": ("!=", "Cancelled"), + "allocated_to": ("is", "set"), + }, + ) + @frappe.whitelist() def get_badge_info(doctypes, filters): @@ -326,31 +369,42 @@ def get_badge_info(doctypes, filters): return out + def run_onload(doc): doc.set("__onload", frappe._dict()) doc.run_method("onload") + def get_view_logs(doctype, docname): - """ get and return the latest view logs if available """ + """get and return the latest view logs if available""" logs = [] - if hasattr(frappe.get_meta(doctype), 'track_views') and frappe.get_meta(doctype).track_views: - view_logs = frappe.get_all("View Log", filters={ - "reference_doctype": doctype, - "reference_name": docname, - }, fields=["name", "creation", "owner"], order_by="creation desc") + if hasattr(frappe.get_meta(doctype), "track_views") and frappe.get_meta(doctype).track_views: + view_logs = frappe.get_all( + "View Log", + filters={ + "reference_doctype": doctype, + "reference_name": docname, + }, + fields=["name", "creation", "owner"], + order_by="creation desc", + ) if view_logs: logs = view_logs return logs + def get_tags(doctype, name): - tags = [tag.tag for tag in frappe.get_all("Tag Link", filters={ - "document_type": doctype, - "document_name": name - }, fields=["tag"])] + tags = [ + tag.tag + for tag in frappe.get_all( + "Tag Link", filters={"document_type": doctype, "document_name": name}, fields=["tag"] + ) + ] return ",".join(tags) + def get_document_email(doctype, name): email = get_automatic_email_link() if not email: @@ -359,13 +413,17 @@ def get_document_email(doctype, name): email = email.split("@") return "{0}+{1}+{2}@{3}".format(email[0], quote(doctype), quote(cstr(name)), email[1]) + def get_automatic_email_link(): - return frappe.db.get_value("Email Account", {"enable_incoming": 1, "enable_automatic_linking": 1}, "email_id") + return frappe.db.get_value( + "Email Account", {"enable_incoming": 1, "enable_automatic_linking": 1}, "email_id" + ) + def get_additional_timeline_content(doctype, docname): contents = [] - hooks = frappe.get_hooks().get('additional_timeline_content', {}) - methods_for_all_doctype = hooks.get('*', []) + hooks = frappe.get_hooks().get("additional_timeline_content", {}) + methods_for_all_doctype = hooks.get("*", []) methods_for_current_doctype = hooks.get(doctype, []) for method in methods_for_all_doctype + methods_for_current_doctype: @@ -373,6 +431,7 @@ def get_additional_timeline_content(doctype, docname): return contents + def set_link_titles(doc): link_titles = {} link_titles.update(get_title_values_for_link_and_dynamic_link_fields(doc)) @@ -380,6 +439,7 @@ def set_link_titles(doc): send_link_titles(link_titles) + def get_title_values_for_link_and_dynamic_link_fields(doc, link_fields=None): link_titles = {} @@ -397,13 +457,12 @@ def get_title_values_for_link_and_dynamic_link_fields(doc, link_fields=None): if not meta or not (meta.title_field and meta.show_title_field_in_link): continue - link_title = frappe.db.get_value( - doctype, doc.get(field.fieldname), meta.title_field, cache=True - ) + link_title = frappe.db.get_value(doctype, doc.get(field.fieldname), meta.title_field, cache=True) link_titles.update({doctype + "::" + doc.get(field.fieldname): link_title}) return link_titles + def get_title_values_for_table_and_multiselect_fields(doc, table_fields=None): link_titles = {} @@ -420,6 +479,7 @@ def get_title_values_for_table_and_multiselect_fields(doc, table_fields=None): return link_titles + def send_link_titles(link_titles): """Append link titles dict in `frappe.local.response`.""" if "_link_titles" not in frappe.local.response: @@ -427,6 +487,7 @@ def send_link_titles(link_titles): frappe.local.response["_link_titles"].update(link_titles) + def update_user_info(docinfo): for d in docinfo.communications: frappe.utils.add_user_info(d.sender, docinfo.user_info) @@ -440,6 +501,7 @@ def update_user_info(docinfo): for d in docinfo.views: frappe.utils.add_user_info(d.owner, docinfo.user_info) + @frappe.whitelist() def get_user_info_for_viewers(users): user_info = {} @@ -447,4 +509,3 @@ def get_user_info_for_viewers(users): frappe.utils.add_user_info(user, user_info) return user_info - diff --git a/frappe/desk/form/meta.py b/frappe/desk/form/meta.py index fa6a1f313b..ba19377c48 100644 --- a/frappe/desk/form/meta.py +++ b/frappe/desk/form/meta.py @@ -11,13 +11,24 @@ from frappe.modules import get_module_path, load_doctype_module, scrub from frappe.translate import extract_messages_from_code, make_dict_from_messages from frappe.utils import get_html_format - ASSET_KEYS = ( - "__js", "__css", "__list_js", "__calendar_js", "__map_js", - "__linked_with", "__messages", "__print_formats", "__workflow_docs", - "__form_grid_templates", "__listview_template", "__tree_js", - "__dashboard", "__kanban_column_fields", '__templates', - '__custom_js', '__custom_list_js' + "__js", + "__css", + "__list_js", + "__calendar_js", + "__map_js", + "__linked_with", + "__messages", + "__print_formats", + "__workflow_docs", + "__form_grid_templates", + "__listview_template", + "__tree_js", + "__dashboard", + "__kanban_column_fields", + "__templates", + "__custom_js", + "__custom_list_js", ) @@ -33,11 +44,12 @@ def get_meta(doctype, cached=True): else: meta = FormMeta(doctype) - if frappe.local.lang != 'en': + if frappe.local.lang != "en": meta.set_translations(frappe.local.lang) return meta + class FormMeta(Meta): def __init__(self, doctype): super(FormMeta, self).__init__(doctype) @@ -50,7 +62,7 @@ class FormMeta(Meta): super(FormMeta, self).set(key, value, *args, **kwargs) def load_assets(self): - if self.get('__assets_loaded', False): + if self.get("__assets_loaded", False): return self.add_search_fields() @@ -65,7 +77,7 @@ class FormMeta(Meta): self.load_dashboard() self.load_kanban_meta() - self.set('__assets_loaded', True) + self.set("__assets_loaded", True) def as_dict(self, no_nulls=False): d = super(FormMeta, self).as_dict(no_nulls=no_nulls) @@ -85,25 +97,26 @@ class FormMeta(Meta): if self.custom: return - path = os.path.join(get_module_path(self.module), 'doctype', scrub(self.name)) + path = os.path.join(get_module_path(self.module), "doctype", scrub(self.name)) + def _get_path(fname): return os.path.join(path, scrub(fname)) system_country = frappe.get_system_settings("country") - self._add_code(_get_path(self.name + '.js'), '__js') + self._add_code(_get_path(self.name + ".js"), "__js") if system_country: - self._add_code(_get_path(os.path.join('regional', system_country + '.js')), '__js') + self._add_code(_get_path(os.path.join("regional", system_country + ".js")), "__js") - self._add_code(_get_path(self.name + '.css'), "__css") - self._add_code(_get_path(self.name + '_list.js'), '__list_js') + self._add_code(_get_path(self.name + ".css"), "__css") + self._add_code(_get_path(self.name + "_list.js"), "__list_js") if system_country: - self._add_code(_get_path(os.path.join('regional', system_country + '_list.js')), '__list_js') + self._add_code(_get_path(os.path.join("regional", system_country + "_list.js")), "__list_js") - self._add_code(_get_path(self.name + '_calendar.js'), '__calendar_js') - self._add_code(_get_path(self.name + '_tree.js'), '__tree_js') + self._add_code(_get_path(self.name + "_calendar.js"), "__calendar_js") + self._add_code(_get_path(self.name + "_tree.js"), "__tree_js") - listview_template = _get_path(self.name + '_list.html') + listview_template = _get_path(self.name + "_list.html") if os.path.exists(listview_template): self.set("__listview_template", get_html_format(listview_template)) @@ -126,8 +139,8 @@ class FormMeta(Meta): templates = dict() for fname in os.listdir(path): if fname.endswith(".html"): - with io.open(os.path.join(path, fname), 'r', encoding = 'utf-8') as f: - templates[fname.split('.')[0]] = scrub_html_template(f.read()) + with io.open(os.path.join(path, fname), "r", encoding="utf-8") as f: + templates[fname.split(".")[0]] = scrub_html_template(f.read()) self.set("__templates", templates or None) @@ -138,19 +151,23 @@ class FormMeta(Meta): def add_custom_script(self): """embed all require files""" # custom script - client_scripts = frappe.db.get_all("Client Script", - filters={"dt": self.name, "enabled": 1}, - fields=["script", "view"], - order_by="creation asc" - ) or "" - - list_script = '' - form_script = '' + client_scripts = ( + frappe.db.get_all( + "Client Script", + filters={"dt": self.name, "enabled": 1}, + fields=["script", "view"], + order_by="creation asc", + ) + or "" + ) + + list_script = "" + form_script = "" for script in client_scripts: - if script.view == 'List': + if script.view == "List": list_script += script.script - if script.view == 'Form': + if script.view == "Form": form_script += script.script file = scrub(self.name) @@ -162,7 +179,7 @@ class FormMeta(Meta): def add_search_fields(self): """add search fields found in the doctypes indicated by link fields' options""" - for df in self.get("fields", {"fieldtype": "Link", "options":["!=", "[Select]"]}): + for df in self.get("fields", {"fieldtype": "Link", "options": ["!=", "[Select]"]}): if df.options: search_fields = frappe.get_meta(df.options).search_fields if search_fields: @@ -179,9 +196,13 @@ class FormMeta(Meta): pass def load_print_formats(self): - print_formats = frappe.db.sql("""select * FROM `tabPrint Format` - WHERE doc_type=%s AND docstatus<2 and disabled=0""", (self.name,), as_dict=1, - update={"doctype":"Print Format"}) + print_formats = frappe.db.sql( + """select * FROM `tabPrint Format` + WHERE doc_type=%s AND docstatus<2 and disabled=0""", + (self.name,), + as_dict=1, + update={"doctype": "Print Format"}, + ) self.set("__print_formats", print_formats) @@ -199,7 +220,6 @@ class FormMeta(Meta): self.set("__workflow_docs", workflow_docs) - def load_templates(self): if not self.custom: module = load_doctype_module(self.name) @@ -222,7 +242,7 @@ class FormMeta(Meta): self.get("__messages").update(messages) def load_dashboard(self): - self.set('__dashboard', self.get_dashboard_data()) + self.set("__dashboard", self.get_dashboard_data()) def load_kanban_meta(self): self.load_kanban_column_fields() @@ -230,16 +250,17 @@ class FormMeta(Meta): def load_kanban_column_fields(self): try: values = frappe.get_list( - 'Kanban Board', fields=['field_name'], - filters={'reference_doctype': self.name}) + "Kanban Board", fields=["field_name"], filters={"reference_doctype": self.name} + ) - fields = [x['field_name'] for x in values] + fields = [x["field_name"] for x in values] fields = list(set(fields)) self.set("__kanban_column_fields", fields) except frappe.PermissionError: # no access to kanban board pass + def get_code_files_via_hooks(hook, name): code_files = [] for app_name in frappe.get_installed_apps(): @@ -257,6 +278,7 @@ def get_code_files_via_hooks(hook, name): return code_files + def get_js(path): js = frappe.read_file(path) if js: diff --git a/frappe/desk/form/save.py b/frappe/desk/form/save.py index b580e2c769..cc3865bc60 100644 --- a/frappe/desk/form/save.py +++ b/frappe/desk/form/save.py @@ -1,9 +1,12 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, json +import json + +import frappe from frappe.desk.form.load import run_onload + @frappe.whitelist() def savedocs(doc, action): """save / submit / update doclist""" @@ -12,9 +15,9 @@ def savedocs(doc, action): set_local_name(doc) # action - doc.docstatus = {"Save":0, "Submit": 1, "Update": 1, "Cancel": 2}[action] + doc.docstatus = {"Save": 0, "Submit": 1, "Update": 1, "Cancel": 2}[action] - if doc.docstatus==1: + if doc.docstatus == 1: doc.submit() else: doc.save() @@ -23,11 +26,12 @@ def savedocs(doc, action): run_onload(doc) send_updated_docs(doc) - frappe.msgprint(frappe._("Saved"), indicator='green', alert=True) + frappe.msgprint(frappe._("Saved"), indicator="green", alert=True) except Exception: frappe.errprint(frappe.utils.get_traceback()) raise + @frappe.whitelist() def cancel(doctype=None, name=None, workflow_state_fieldname=None, workflow_state=None): """cancel a doclist""" @@ -37,25 +41,28 @@ def cancel(doctype=None, name=None, workflow_state_fieldname=None, workflow_stat doc.set(workflow_state_fieldname, workflow_state) doc.cancel() send_updated_docs(doc) - frappe.msgprint(frappe._("Cancelled"), indicator='red', alert=True) + frappe.msgprint(frappe._("Cancelled"), indicator="red", alert=True) except Exception: frappe.errprint(frappe.utils.get_traceback()) raise + def send_updated_docs(doc): from .load import get_docinfo + get_docinfo(doc) d = doc.as_dict() - if hasattr(doc, 'localname'): + if hasattr(doc, "localname"): d["localname"] = doc.localname frappe.response.docs.append(d) + def set_local_name(doc): def _set_local_name(d): - if doc.get('__islocal') or d.get('__islocal'): + if doc.get("__islocal") or d.get("__islocal"): d.localname = d.name d.name = None diff --git a/frappe/desk/form/test_form.py b/frappe/desk/form/test_form.py index 86c3aba29a..c05a932241 100644 --- a/frappe/desk/form/test_form.py +++ b/frappe/desk/form/test_form.py @@ -1,16 +1,19 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest +import frappe from frappe.desk.form.linked_with import get_linked_docs, get_linked_doctypes + class TestForm(unittest.TestCase): def test_linked_with(self): results = get_linked_docs("Role", "System Manager", linkinfo=get_linked_doctypes("Role")) self.assertTrue("User" in results) self.assertTrue("DocType" in results) -if __name__=="__main__": + +if __name__ == "__main__": frappe.connect() unittest.main() diff --git a/frappe/desk/form/utils.py b/frappe/desk/form/utils.py index f80b89d2b8..2738d1f74a 100644 --- a/frappe/desk/form/utils.py +++ b/frappe/desk/form/utils.py @@ -1,33 +1,37 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, json -import frappe.desk.form.meta +import json + +import frappe import frappe.desk.form.load -from frappe.desk.form.document_follow import follow_document +import frappe.desk.form.meta +from frappe import _ from frappe.core.doctype.file.file import extract_images_from_html +from frappe.desk.form.document_follow import follow_document -from frappe import _ @frappe.whitelist() def remove_attach(): """remove attachment""" - fid = frappe.form_dict.get('fid') - file_name = frappe.form_dict.get('file_name') - frappe.delete_doc('File', fid) + fid = frappe.form_dict.get("fid") + file_name = frappe.form_dict.get("file_name") + frappe.delete_doc("File", fid) @frappe.whitelist() def add_comment(reference_doctype, reference_name, content, comment_email, comment_by): """allow any logged user to post a comment""" - doc = frappe.get_doc(dict( - doctype='Comment', - reference_doctype=reference_doctype, - reference_name=reference_name, - comment_email=comment_email, - comment_type='Comment', - comment_by=comment_by - )) + doc = frappe.get_doc( + dict( + doctype="Comment", + reference_doctype=reference_doctype, + reference_name=reference_name, + comment_email=comment_email, + comment_type="Comment", + comment_by=comment_by, + ) + ) reference_doc = frappe.get_doc(reference_doctype, reference_name) doc.content = extract_images_from_html(reference_doc, content, is_private=True) doc.insert(ignore_permissions=True) @@ -35,22 +39,25 @@ def add_comment(reference_doctype, reference_name, content, comment_email, comme follow_document(doc.reference_doctype, doc.reference_name, frappe.session.user) return doc.as_dict() + @frappe.whitelist() def update_comment(name, content): """allow only owner to update comment""" - doc = frappe.get_doc('Comment', name) + doc = frappe.get_doc("Comment", name) - if frappe.session.user not in ['Administrator', doc.owner]: - frappe.throw(_('Comment can only be edited by the owner'), frappe.PermissionError) + if frappe.session.user not in ["Administrator", doc.owner]: + frappe.throw(_("Comment can only be edited by the owner"), frappe.PermissionError) doc.content = content doc.save(ignore_permissions=True) + @frappe.whitelist() -def get_next(doctype, value, prev, filters=None, sort_order='desc', sort_field='modified'): +def get_next(doctype, value, prev, filters=None, sort_order="desc", sort_field="modified"): prev = int(prev) - if not filters: filters = [] + if not filters: + filters = [] if isinstance(filters, str): filters = json.loads(filters) @@ -65,11 +72,15 @@ def get_next(doctype, value, prev, filters=None, sort_order='desc', sort_field=' # # add condition for next or prev item filters.append([doctype, sort_field, condition, frappe.get_value(doctype, value, sort_field)]) - res = frappe.get_list(doctype, - fields = ["name"], - filters = filters, - order_by = "`tab{0}`.{1}".format(doctype, sort_field) + " " + sort_order, - limit_start=0, limit_page_length=1, as_list=True) + res = frappe.get_list( + doctype, + fields=["name"], + filters=filters, + order_by="`tab{0}`.{1}".format(doctype, sort_field) + " " + sort_order, + limit_start=0, + limit_page_length=1, + as_list=True, + ) if not res: frappe.msgprint(_("No further records")) @@ -77,10 +88,8 @@ def get_next(doctype, value, prev, filters=None, sort_order='desc', sort_field=' else: return res[0][0] -def get_pdf_link(doctype, docname, print_format='Standard', no_letterhead=0): - return '/api/method/frappe.utils.print_format.download_pdf?doctype={doctype}&name={docname}&format={print_format}&no_letterhead={no_letterhead}'.format( - doctype = doctype, - docname = docname, - print_format = print_format, - no_letterhead = no_letterhead + +def get_pdf_link(doctype, docname, print_format="Standard", no_letterhead=0): + return "/api/method/frappe.utils.print_format.download_pdf?doctype={doctype}&name={docname}&format={print_format}&no_letterhead={no_letterhead}".format( + doctype=doctype, docname=docname, print_format=print_format, no_letterhead=no_letterhead ) diff --git a/frappe/desk/gantt.py b/frappe/desk/gantt.py index 58ef3b836e..a09c52dafe 100644 --- a/frappe/desk/gantt.py +++ b/frappe/desk/gantt.py @@ -1,7 +1,10 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, json +import json + +import frappe + @frappe.whitelist() def update_task(args, field_map): @@ -11,4 +14,4 @@ def update_task(args, field_map): d = frappe.get_doc(args.doctype, args.name) d.set(field_map.start, args.start) d.set(field_map.end, args.end) - d.save() \ No newline at end of file + d.save() diff --git a/frappe/desk/leaderboard.py b/frappe/desk/leaderboard.py index a98ae1a1c6..a5f5de3117 100644 --- a/frappe/desk/leaderboard.py +++ b/frappe/desk/leaderboard.py @@ -1,50 +1,54 @@ import frappe from frappe.utils import get_fullname + def get_leaderboards(): leaderboards = { - 'User': { - 'fields': ['points'], - 'method': 'frappe.desk.leaderboard.get_energy_point_leaderboard', - 'company_disabled': 1, - 'icon': 'users' + "User": { + "fields": ["points"], + "method": "frappe.desk.leaderboard.get_energy_point_leaderboard", + "company_disabled": 1, + "icon": "users", } } return leaderboards + @frappe.whitelist() -def get_energy_point_leaderboard(date_range, company = None, field = None, limit = None): - all_users = frappe.db.get_all('User', - filters = { - 'name': ['not in', ['Administrator', 'Guest']], - 'enabled': 1, - 'user_type': ['!=', 'Website User'] +def get_energy_point_leaderboard(date_range, company=None, field=None, limit=None): + all_users = frappe.db.get_all( + "User", + filters={ + "name": ["not in", ["Administrator", "Guest"]], + "enabled": 1, + "user_type": ["!=", "Website User"], }, - order_by = 'name ASC') - all_users_list = list(map(lambda x: x['name'], all_users)) + order_by="name ASC", + ) + all_users_list = list(map(lambda x: x["name"], all_users)) - filters = [ - ['type', '!=', 'Review'], - ['user', 'in', all_users_list] - ] + filters = [["type", "!=", "Review"], ["user", "in", all_users_list]] if date_range: date_range = frappe.parse_json(date_range) - filters.append(['creation', 'between', [date_range[0], date_range[1]]]) - energy_point_users = frappe.db.get_all('Energy Point Log', - fields = ['user as name', 'sum(points) as value'], - filters = filters, - group_by = 'user', - order_by = 'value desc' + filters.append(["creation", "between", [date_range[0], date_range[1]]]) + energy_point_users = frappe.db.get_all( + "Energy Point Log", + fields=["user as name", "sum(points) as value"], + filters=filters, + group_by="user", + order_by="value desc", ) - energy_point_users_list = list(map(lambda x: x['name'], energy_point_users)) + energy_point_users_list = list(map(lambda x: x["name"], energy_point_users)) for user in all_users_list: if user not in energy_point_users_list: - energy_point_users.append({'name': user, 'value': 0}) + energy_point_users.append({"name": user, "value": 0}) for user in energy_point_users: - user_id = user['name'] - user['name'] = get_fullname(user['name']) - user['formatted_name'] = '{}'.format(user_id, get_fullname(user_id)) + user_id = user["name"] + user["name"] = get_fullname(user["name"]) + user["formatted_name"] = '{}'.format( + user_id, get_fullname(user_id) + ) - return energy_point_users \ No newline at end of file + return energy_point_users diff --git a/frappe/desk/like.py b/frappe/desk/like.py index 5e5a789973..9e97cb269c 100644 --- a/frappe/desk/like.py +++ b/frappe/desk/like.py @@ -3,12 +3,15 @@ """Allow adding of likes to documents""" -import frappe, json -from frappe.database.schema import add_column +import json + +import frappe from frappe import _ +from frappe.database.schema import add_column from frappe.desk.form.document_follow import follow_document from frappe.utils import get_link_to_form + @frappe.whitelist() def toggle_like(doctype, name, add=False): """Adds / removes the current user in the `__liked_by` property of the given document. @@ -23,6 +26,7 @@ def toggle_like(doctype, name, add=False): _toggle_like(doctype, name, add) + def _toggle_like(doctype, name, add, user=None): """Same as toggle_like but hides param `user` from API""" @@ -37,7 +41,7 @@ def _toggle_like(doctype, name, add, user=None): else: liked_by = [] - if add=="Yes": + if add == "Yes": if user not in liked_by: liked_by.append(user) add_comment(doctype, name) @@ -57,28 +61,44 @@ def _toggle_like(doctype, name, add, user=None): else: raise + def remove_like(doctype, name): """Remove previous Like""" # remove Comment - frappe.delete_doc("Comment", [c.name for c in frappe.get_all("Comment", - filters={ - "comment_type": "Like", - "reference_doctype": doctype, - "reference_name": name, - "owner": frappe.session.user, - } - )], ignore_permissions=True) + frappe.delete_doc( + "Comment", + [ + c.name + for c in frappe.get_all( + "Comment", + filters={ + "comment_type": "Like", + "reference_doctype": doctype, + "reference_name": name, + "owner": frappe.session.user, + }, + ) + ], + ignore_permissions=True, + ) + def add_comment(doctype, name): doc = frappe.get_doc(doctype, name) - if doctype=="Communication" and doc.reference_doctype and doc.reference_name: - link = get_link_to_form(doc.reference_doctype, doc.reference_name, - "{0} {1}".format(_(doc.reference_doctype), doc.reference_name)) - - doc.add_comment("Like", _("{0}: {1} in {2}").format(_(doc.communication_type), - "" + doc.subject + "", link), - link_doctype=doc.reference_doctype, link_name=doc.reference_name) + if doctype == "Communication" and doc.reference_doctype and doc.reference_name: + link = get_link_to_form( + doc.reference_doctype, + doc.reference_name, + "{0} {1}".format(_(doc.reference_doctype), doc.reference_name), + ) + + doc.add_comment( + "Like", + _("{0}: {1} in {2}").format(_(doc.communication_type), "" + doc.subject + "", link), + link_doctype=doc.reference_doctype, + link_name=doc.reference_name, + ) else: doc.add_comment("Like", _("Liked")) diff --git a/frappe/desk/link_preview.py b/frappe/desk/link_preview.py index 03f8368a3a..374a151505 100644 --- a/frappe/desk/link_preview.py +++ b/frappe/desk/link_preview.py @@ -1,45 +1,52 @@ +import json + import frappe from frappe.model import no_value_fields, table_fields -import json + @frappe.whitelist() def get_preview_data(doctype, docname): preview_fields = [] meta = frappe.get_meta(doctype) - if not meta.show_preview_popup: return + if not meta.show_preview_popup: + return - preview_fields = [field.fieldname for field in meta.fields \ - if field.in_preview and field.fieldtype not in no_value_fields \ - and field.fieldtype not in table_fields] + preview_fields = [ + field.fieldname + for field in meta.fields + if field.in_preview + and field.fieldtype not in no_value_fields + and field.fieldtype not in table_fields + ] # no preview fields defined, build list from mandatory fields if not preview_fields: - preview_fields = [field.fieldname for field in meta.fields if field.reqd \ - and field.fieldtype not in table_fields] + preview_fields = [ + field.fieldname for field in meta.fields if field.reqd and field.fieldtype not in table_fields + ] title_field = meta.get_title_field() image_field = meta.image_field preview_fields.append(title_field) preview_fields.append(image_field) - preview_fields.append('name') + preview_fields.append("name") - preview_data = frappe.get_list(doctype, filters={ - 'name': docname - }, fields=preview_fields, limit=1) + preview_data = frappe.get_list(doctype, filters={"name": docname}, fields=preview_fields, limit=1) - if not preview_data: return + if not preview_data: + return preview_data = preview_data[0] formatted_preview_data = { - 'preview_image': preview_data.get(image_field), - 'preview_title': preview_data.get(title_field), - 'name': preview_data.get('name'), + "preview_image": preview_data.get(image_field), + "preview_title": preview_data.get(title_field), + "name": preview_data.get("name"), } for key, val in preview_data.items(): - if val and meta.has_field(key) and key not in [image_field, title_field, 'name']: + if val and meta.has_field(key) and key not in [image_field, title_field, "name"]: formatted_preview_data[meta.get_field(key).label] = frappe.format( val, meta.get_field(key).fieldtype, diff --git a/frappe/desk/listview.py b/frappe/desk/listview.py index 3d6f1254a2..88216d3998 100644 --- a/frappe/desk/listview.py +++ b/frappe/desk/listview.py @@ -2,6 +2,7 @@ # License: MIT. See LICENSE import frappe + @frappe.whitelist() def get_list_settings(doctype): try: @@ -9,6 +10,7 @@ def get_list_settings(doctype): except frappe.DoesNotExistError: frappe.clear_messages() + @frappe.whitelist() def set_list_settings(doctype, values): try: @@ -24,12 +26,13 @@ def set_list_settings(doctype, values): @frappe.whitelist() def get_group_by_count(doctype, current_filters, field): current_filters = frappe.parse_json(current_filters) - subquery_condition = '' + subquery_condition = "" subquery = frappe.get_all(doctype, filters=current_filters, run=False) - if field == 'assigned_to': - subquery_condition = ' and `tabToDo`.reference_name in ({subquery})'.format(subquery = subquery) - return frappe.db.sql("""select `tabToDo`.allocated_to as name, count(*) as count + if field == "assigned_to": + subquery_condition = " and `tabToDo`.reference_name in ({subquery})".format(subquery=subquery) + return frappe.db.sql( + """select `tabToDo`.allocated_to as name, count(*) as count from `tabToDo`, `tabUser` where @@ -41,13 +44,17 @@ def get_group_by_count(doctype, current_filters, field): `tabToDo`.allocated_to order by count desc - limit 50""".format(subquery_condition = subquery_condition), as_dict=True) + limit 50""".format( + subquery_condition=subquery_condition + ), + as_dict=True, + ) else: - return frappe.db.get_list(doctype, + return frappe.db.get_list( + doctype, filters=current_filters, - group_by='`tab{0}`.{1}'.format(doctype, field), - fields=['count(*) as count', '`{}` as name'.format(field)], - order_by='count desc', + group_by="`tab{0}`.{1}".format(doctype, field), + fields=["count(*) as count", "`{}` as name".format(field)], + order_by="count desc", limit=50, ) - diff --git a/frappe/desk/moduleview.py b/frappe/desk/moduleview.py index 7a9c211c3c..a4fc2ccd1e 100644 --- a/frappe/desk/moduleview.py +++ b/frappe/desk/moduleview.py @@ -1,12 +1,18 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import json + +import frappe from frappe import _ from frappe.boot import get_allowed_pages, get_allowed_reports -from frappe.desk.doctype.desktop_icon.desktop_icon import set_hidden, clear_desktop_icons_cache -from frappe.cache_manager import build_domain_restriced_doctype_cache, build_domain_restriced_page_cache, build_table_count_cache +from frappe.cache_manager import ( + build_domain_restriced_doctype_cache, + build_domain_restriced_page_cache, + build_table_count_cache, +) +from frappe.desk.doctype.desktop_icon.desktop_icon import clear_desktop_icons_cache, set_hidden + @frappe.whitelist() def get(module): @@ -14,17 +20,17 @@ def get(module): `/desk/#Module/[name]`.""" data = get_data(module) - out = { - "data": data - } + out = {"data": data} return out + @frappe.whitelist() def hide_module(module): set_hidden(module, frappe.session.user, 1) clear_desktop_icons_cache() + def get_table_with_counts(): counts = frappe.cache().get_value("information_schema:counts") if counts: @@ -32,6 +38,7 @@ def get_table_with_counts(): else: return build_table_count_cache() + def get_data(module, build=True): """Get module data for the module view `desk/#Module/[name]`""" doctype_info = get_doctype_info(module) @@ -42,8 +49,7 @@ def get_data(module, build=True): else: add_custom_doctypes(data, doctype_info) - add_section(data, _("Custom Reports"), "fa fa-list-alt", - get_report_list(module)) + add_section(data, _("Custom Reports"), "fa fa-list-alt", get_report_list(module)) data = combine_common_sections(data) data = apply_permissions(data) @@ -52,10 +58,11 @@ def get_data(module, build=True): if build: exists_cache = get_table_with_counts() + def doctype_contains_a_record(name): exists = exists_cache.get(name) if not exists: - if not frappe.db.get_value('DocType', name, 'issingle'): + if not frappe.db.get_value("DocType", name, "issingle"): exists = frappe.db.count(name) else: exists = True @@ -88,6 +95,7 @@ def get_data(module, build=True): return data + def build_config_from_file(module): """Build module info from `app/config/desktop.py` files.""" data = [] @@ -101,9 +109,12 @@ def build_config_from_file(module): return filter_by_restrict_to_domain(data) + def filter_by_restrict_to_domain(data): - """ filter Pages and DocType depending on the Active Module(s) """ - doctypes = frappe.cache().get_value("domain_restricted_doctypes") or build_domain_restriced_doctype_cache() + """filter Pages and DocType depending on the Active Module(s)""" + doctypes = ( + frappe.cache().get_value("domain_restricted_doctypes") or build_domain_restriced_doctype_cache() + ) pages = frappe.cache().get_value("domain_restricted_pages") or build_domain_restriced_page_cache() for d in data: @@ -113,13 +124,14 @@ def filter_by_restrict_to_domain(data): item_type = item.get("type") item_name = item.get("name") - if (item_name in pages) or (item_name in doctypes) or item_type == 'report': + if (item_name in pages) or (item_name in doctypes) or item_type == "report": _items.append(item) - d.update({ "items": _items }) + d.update({"items": _items}) return data + def build_standard_config(module, doctype_info): """Build standard module data from DocTypes.""" if not frappe.db.get_value("Module Def", module): @@ -127,47 +139,60 @@ def build_standard_config(module, doctype_info): data = [] - add_section(data, _("Documents"), "fa fa-star", - [d for d in doctype_info if d.document_type in ("Document", "Transaction")]) + add_section( + data, + _("Documents"), + "fa fa-star", + [d for d in doctype_info if d.document_type in ("Document", "Transaction")], + ) - add_section(data, _("Setup"), "fa fa-cog", - [d for d in doctype_info if d.document_type in ("Master", "Setup", "")]) + add_section( + data, + _("Setup"), + "fa fa-cog", + [d for d in doctype_info if d.document_type in ("Master", "Setup", "")], + ) - add_section(data, _("Standard Reports"), "fa fa-list", - get_report_list(module, is_standard="Yes")) + add_section(data, _("Standard Reports"), "fa fa-list", get_report_list(module, is_standard="Yes")) return data + def add_section(data, label, icon, items): """Adds a section to the module data.""" - if not items: return - data.append({ - "label": label, - "icon": icon, - "items": items - }) + if not items: + return + data.append({"label": label, "icon": icon, "items": items}) def add_custom_doctypes(data, doctype_info): """Adds Custom DocTypes to modules setup via `config/desktop.py`.""" - add_section(data, _("Documents"), "fa fa-star", - [d for d in doctype_info if (d.custom and d.document_type in ("Document", "Transaction"))]) + add_section( + data, + _("Documents"), + "fa fa-star", + [d for d in doctype_info if (d.custom and d.document_type in ("Document", "Transaction"))], + ) + + add_section( + data, + _("Setup"), + "fa fa-cog", + [d for d in doctype_info if (d.custom and d.document_type in ("Setup", "Master", ""))], + ) - add_section(data, _("Setup"), "fa fa-cog", - [d for d in doctype_info if (d.custom and d.document_type in ("Setup", "Master", ""))]) def get_doctype_info(module): """Returns list of non child DocTypes for given module.""" active_domains = frappe.get_active_domains() - doctype_info = frappe.get_all("DocType", filters={ - "module": module, - "istable": 0 - }, or_filters={ - "ifnull(restrict_to_domain, '')": "", - "restrict_to_domain": ("in", active_domains) - }, fields=["'doctype' as type", "name", "description", "document_type", - "custom", "issingle"], order_by="custom asc, document_type desc, name asc") + doctype_info = frappe.get_all( + "DocType", + filters={"module": module, "istable": 0}, + or_filters={"ifnull(restrict_to_domain, '')": "", "restrict_to_domain": ("in", active_domains)}, + fields=["'doctype' as type", "name", "description", "document_type", "custom", "issingle"], + order_by="custom asc, document_type desc, name asc", + ) for d in doctype_info: d.document_type = d.document_type or "" @@ -175,6 +200,7 @@ def get_doctype_info(module): return doctype_info + def combine_common_sections(data): """Combine sections declared in separate apps.""" sections = [] @@ -188,6 +214,7 @@ def combine_common_sections(data): return sections + def apply_permissions(data): default_country = frappe.db.get_default("country") @@ -201,16 +228,18 @@ def apply_permissions(data): for section in data: new_items = [] - for item in (section.get("items") or []): + for item in section.get("items") or []: item = frappe._dict(item) - if item.country and item.country!=default_country: + if item.country and item.country != default_country: continue - if ((item.type=="doctype" and item.name in user.can_read) - or (item.type=="page" and item.name in allowed_pages) - or (item.type=="report" and item.name in allowed_reports) - or item.type=="help"): + if ( + (item.type == "doctype" and item.name in user.can_read) + or (item.type == "page" and item.name in allowed_pages) + or (item.type == "report" and item.name in allowed_reports) + or item.type == "help" + ): new_items.append(item) @@ -221,11 +250,13 @@ def apply_permissions(data): return new_data + def get_disabled_reports(): if not hasattr(frappe.local, "disabled_reports"): frappe.local.disabled_reports = set(r.name for r in frappe.get_all("Report", {"disabled": 1})) return frappe.local.disabled_reports + def get_config(app, module): """Load module info from `[app].config.[module]`.""" config = frappe.get_module("{app}.config.{module}".format(app=app, module=module)) @@ -237,7 +268,7 @@ def get_config(app, module): for section in sections: items = [] for item in section["items"]: - if item["type"]=="report" and item["name"] in disabled_reports: + if item["type"] == "report" and item["name"] in disabled_reports: continue # some module links might not have name if not item.get("name"): @@ -245,10 +276,11 @@ def get_config(app, module): if not item.get("label"): item["label"] = _(item.get("name")) items.append(item) - section['items'] = items + section["items"] = items return sections + def config_exists(app, module): try: frappe.get_module("{app}.config.{module}".format(app=app, module=module)) @@ -256,6 +288,7 @@ def config_exists(app, module): except ImportError: return False + def add_setup_section(config, app, module, label, icon): """Add common sections to `/desk#Module/Setup`""" try: @@ -265,16 +298,13 @@ def add_setup_section(config, app, module, label, icon): except ImportError: pass + def get_setup_section(app, module, label, icon): """Get the setup section from each module (for global Setup page).""" config = get_config(app, module) for section in config: - if section.get("label")==_("Setup"): - return { - "label": label, - "icon": icon, - "items": section["items"] - } + if section.get("label") == _("Setup"): + return {"label": label, "icon": icon, "items": section["items"]} def get_onboard_items(app, module): @@ -303,9 +333,11 @@ def get_onboard_items(app, module): return onboard_items or fallback_items + @frappe.whitelist() def get_links_for_module(app, module): - return [{'value': l.get('name'), 'label': l.get('label')} for l in get_links(app, module)] + return [{"value": l.get("name"), "label": l.get("label")} for l in get_links(app, module)] + def get_links(app, module): try: @@ -315,21 +347,23 @@ def get_links(app, module): links = [] for section in sections: - for item in section['items']: + for item in section["items"]: links.append(item) return links + @frappe.whitelist() def get_desktop_settings(): from frappe.config import get_modules_from_all_apps_for_user + all_modules = get_modules_from_all_apps_for_user() home_settings = get_home_settings() modules_by_name = {} for m in all_modules: - modules_by_name[m['module_name']] = m + modules_by_name[m["module_name"]] = m - module_categories = ['Modules', 'Domains', 'Places', 'Administration'] + module_categories = ["Modules", "Domains", "Places", "Administration"] user_modules_by_category = {} user_saved_modules_by_category = home_settings.modules_by_category or {} @@ -340,7 +374,7 @@ def get_desktop_settings(): all_links = get_links(module.app, module.module_name) module_links_by_name = {} for link in all_links: - module_links_by_name[link['name']] = link + module_links_by_name[link["name"]] = link if module.module_name in user_saved_links_by_module: user_links = frappe.parse_json(user_saved_links_by_module[module.module_name]) @@ -351,21 +385,26 @@ def get_desktop_settings(): for category in module_categories: if category in user_saved_modules_by_category: user_modules = user_saved_modules_by_category[category] - user_modules_by_category[category] = [apply_user_saved_links(modules_by_name[m]) \ - for m in user_modules if modules_by_name.get(m)] + user_modules_by_category[category] = [ + apply_user_saved_links(modules_by_name[m]) for m in user_modules if modules_by_name.get(m) + ] else: - user_modules_by_category[category] = [apply_user_saved_links(m) \ - for m in all_modules if m.get('category') == category] + user_modules_by_category[category] = [ + apply_user_saved_links(m) for m in all_modules if m.get("category") == category + ] # filter out hidden modules if home_settings.hidden_modules: for category in user_modules_by_category: hidden_modules = home_settings.hidden_modules or [] modules = user_modules_by_category[category] - user_modules_by_category[category] = [module for module in modules if module.module_name not in hidden_modules] + user_modules_by_category[category] = [ + module for module in modules if module.module_name not in hidden_modules + ] return user_modules_by_category + @frappe.whitelist() def update_hidden_modules(category_map): category_map = frappe.parse_json(category_map) @@ -378,8 +417,10 @@ def update_hidden_modules(category_map): saved_hidden_modules += config.removed or [] saved_hidden_modules = [d for d in saved_hidden_modules if d not in (config.added or [])] - if home_settings.get('modules_by_category') and home_settings.modules_by_category.get(category): - module_placement = [d for d in (config.added or []) if d not in home_settings.modules_by_category[category]] + if home_settings.get("modules_by_category") and home_settings.modules_by_category.get(category): + module_placement = [ + d for d in (config.added or []) if d not in home_settings.modules_by_category[category] + ] home_settings.modules_by_category[category] += module_placement home_settings.hidden_modules = saved_hidden_modules @@ -387,17 +428,16 @@ def update_hidden_modules(category_map): return get_desktop_settings() + @frappe.whitelist() def update_global_hidden_modules(modules): modules = frappe.parse_json(modules) - frappe.only_for('System Manager') + frappe.only_for("System Manager") - doc = frappe.get_doc('User', 'Administrator') - doc.set('block_modules', []) + doc = frappe.get_doc("User", "Administrator") + doc.set("block_modules", []) for module in modules: - doc.append('block_modules', { - 'module': module - }) + doc.append("block_modules", {"module": module}) doc.save(ignore_permissions=True) @@ -414,53 +454,58 @@ def update_modules_order(module_category, modules): set_home_settings(home_settings) + @frappe.whitelist() def update_links_for_module(module_name, links): links = frappe.parse_json(links) home_settings = get_home_settings() - home_settings.setdefault('links_by_module', {}) - home_settings['links_by_module'].setdefault(module_name, None) - home_settings['links_by_module'][module_name] = links + home_settings.setdefault("links_by_module", {}) + home_settings["links_by_module"].setdefault(module_name, None) + home_settings["links_by_module"][module_name] = links set_home_settings(home_settings) return get_desktop_settings() + @frappe.whitelist() def get_options_for_show_hide_cards(): global_options = [] - if 'System Manager' in frappe.get_roles(): + if "System Manager" in frappe.get_roles(): global_options = get_options_for_global_modules() - return { - 'user_options': get_options_for_user_blocked_modules(), - 'global_options': global_options - } + return {"user_options": get_options_for_user_blocked_modules(), "global_options": global_options} + @frappe.whitelist() def get_options_for_global_modules(): from frappe.config import get_modules_from_all_apps + all_modules = get_modules_from_all_apps() - blocked_modules = frappe.get_doc('User', 'Administrator').get_blocked_modules() + blocked_modules = frappe.get_doc("User", "Administrator").get_blocked_modules() options = [] for module in all_modules: module = frappe._dict(module) - options.append({ - 'category': module.category, - 'label': module.label, - 'value': module.module_name, - 'checked': module.module_name not in blocked_modules - }) + options.append( + { + "category": module.category, + "label": module.label, + "value": module.module_name, + "checked": module.module_name not in blocked_modules, + } + ) return options + @frappe.whitelist() def get_options_for_user_blocked_modules(): from frappe.config import get_modules_from_all_apps_for_user + all_modules = get_modules_from_all_apps_for_user() home_settings = get_home_settings() @@ -469,26 +514,30 @@ def get_options_for_user_blocked_modules(): options = [] for module in all_modules: module = frappe._dict(module) - options.append({ - 'category': module.category, - 'label': module.label, - 'value': module.module_name, - 'checked': module.module_name not in hidden_modules - }) + options.append( + { + "category": module.category, + "label": module.label, + "value": module.module_name, + "checked": module.module_name not in hidden_modules, + } + ) return options + def set_home_settings(home_settings): - frappe.cache().hset('home_settings', frappe.session.user, home_settings) - frappe.db.set_value('User', frappe.session.user, 'home_settings', json.dumps(home_settings)) + frappe.cache().hset("home_settings", frappe.session.user, home_settings) + frappe.db.set_value("User", frappe.session.user, "home_settings", json.dumps(home_settings)) + @frappe.whitelist() def get_home_settings(): def get_from_db(): - settings = frappe.db.get_value("User", frappe.session.user, 'home_settings') - return frappe.parse_json(settings or '{}') + settings = frappe.db.get_value("User", frappe.session.user, "home_settings") + return frappe.parse_json(settings or "{}") - home_settings = frappe.cache().hget('home_settings', frappe.session.user, get_from_db) + home_settings = frappe.cache().hget("home_settings", frappe.session.user, get_from_db) return home_settings @@ -513,10 +562,13 @@ def set_last_modified(data): if item["type"] == "doctype": item["last_modified"] = get_last_modified(item["name"]) + def get_last_modified(doctype): def _get(): try: - last_modified = frappe.get_all(doctype, fields=["max(modified)"], as_list=True, limit_page_length=1)[0][0] + last_modified = frappe.get_all( + doctype, fields=["max(modified)"], as_list=True, limit_page_length=1 + )[0][0] except Exception as e: if frappe.db.is_table_missing(e): last_modified = None @@ -531,25 +583,33 @@ def get_last_modified(doctype): last_modified = frappe.cache().hget("last_modified", doctype, _get) - if last_modified==-1: + if last_modified == -1: last_modified = None return last_modified + def get_report_list(module, is_standard="No"): """Returns list on new style reports for modules.""" - reports = frappe.get_list("Report", fields=["name", "ref_doctype", "report_type"], filters= - {"is_standard": is_standard, "disabled": 0, "module": module}, - order_by="name") + reports = frappe.get_list( + "Report", + fields=["name", "ref_doctype", "report_type"], + filters={"is_standard": is_standard, "disabled": 0, "module": module}, + order_by="name", + ) out = [] for r in reports: - out.append({ - "type": "report", - "doctype": r.ref_doctype, - "is_query_report": 1 if r.report_type in ("Query Report", "Script Report", "Custom Report") else 0, - "label": _(r.name), - "name": r.name - }) - - return out \ No newline at end of file + out.append( + { + "type": "report", + "doctype": r.ref_doctype, + "is_query_report": 1 + if r.report_type in ("Query Report", "Script Report", "Custom Report") + else 0, + "label": _(r.name), + "name": r.name, + } + ) + + return out diff --git a/frappe/desk/notifications.py b/frappe/desk/notifications.py index 3fa41790b4..e92a7492ce 100644 --- a/frappe/desk/notifications.py +++ b/frappe/desk/notifications.py @@ -1,10 +1,14 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe -from frappe.desk.doctype.notification_settings.notification_settings import get_subscribed_documents import json +import frappe +from frappe.desk.doctype.notification_settings.notification_settings import ( + get_subscribed_documents, +) + + @frappe.whitelist() @frappe.read_only() def get_notifications(): @@ -12,8 +16,7 @@ def get_notifications(): "open_count_doctype": {}, "targets": {}, } - if (frappe.flags.in_install or - not frappe.db.get_single_value('System Settings', 'setup_complete')): + if frappe.flags.in_install or not frappe.db.get_single_value("System Settings", "setup_complete"): return out config = get_notification_config() @@ -32,11 +35,12 @@ def get_notifications(): if count is not None: notification_count[name] = count - out['open_count_doctype'] = get_notifications_for_doctypes(config, notification_count) - out['targets'] = get_notifications_for_targets(config, notification_percent) + out["open_count_doctype"] = get_notifications_for_doctypes(config, notification_count) + out["targets"] = get_notifications_for_targets(config, notification_percent) return out + def get_notifications_for_doctypes(config, notification_count): """Notifications for DocTypes""" can_read = frappe.get_user().get_can_read() @@ -51,7 +55,9 @@ def get_notifications_for_doctypes(config, notification_count): else: try: if isinstance(condition, dict): - result = frappe.get_list(d, fields=["count(*) as count"], filters=condition, ignore_ifnull=True)[0].count + result = frappe.get_list( + d, fields=["count(*) as count"], filters=condition, ignore_ifnull=True + )[0].count else: result = frappe.get_attr(condition)() @@ -72,6 +78,7 @@ def get_notifications_for_doctypes(config, notification_count): return open_count_doctype + def get_notifications_for_targets(config, notification_percent): """Notifications for doc targets""" can_read = frappe.get_user().get_can_read() @@ -96,8 +103,13 @@ def get_notifications_for_targets(config, notification_percent): value_field = d["value_field"] try: if isinstance(condition, dict): - doc_list = frappe.get_list(doctype, fields=["name", target_field, value_field], - filters=condition, limit_page_length = 100, ignore_ifnull=True) + doc_list = frappe.get_list( + doctype, + fields=["name", target_field, value_field], + filters=condition, + limit_page_length=100, + ignore_ifnull=True, + ) except frappe.PermissionError: frappe.clear_messages() @@ -110,10 +122,11 @@ def get_notifications_for_targets(config, notification_percent): for doc in doc_list: value = doc[value_field] target = doc[target_field] - doc_target_percents[doctype][doc.name] = (value/target * 100) if value < target else 100 + doc_target_percents[doctype][doc.name] = (value / target * 100) if value < target else 100 return doc_target_percents + def clear_notifications(user=None): if frappe.flags.in_install: return @@ -123,8 +136,8 @@ def clear_notifications(user=None): if not config: return - for_doctype = list(config.get('for_doctype')) if config.get('for_doctype') else [] - for_module = list(config.get('for_module')) if config.get('for_module') else [] + for_doctype = list(config.get("for_doctype")) if config.get("for_doctype") else [] + for_module = list(config.get("for_module")) if config.get("for_module") else [] groups = for_doctype + for_module for name in groups: @@ -133,21 +146,24 @@ def clear_notifications(user=None): else: cache.delete_key("notification_count:" + name) - frappe.publish_realtime('clear_notifications') + frappe.publish_realtime("clear_notifications") + def clear_notification_config(user): - frappe.cache().hdel('notification_config', user) + frappe.cache().hdel("notification_config", user) + def delete_notification_count_for(doctype): frappe.cache().delete_key("notification_count:" + doctype) - frappe.publish_realtime('clear_notifications') + frappe.publish_realtime("clear_notifications") + def clear_doctype_notifications(doc, method=None, *args, **kwargs): config = get_notification_config() if not config: return if isinstance(doc, str): - doctype = doc # assuming doctype name was passed directly + doctype = doc # assuming doctype name was passed directly else: doctype = doc.doctype @@ -155,6 +171,7 @@ def clear_doctype_notifications(doc, method=None, *args, **kwargs): delete_notification_count_for(doctype) return + @frappe.whitelist() def get_notification_info(): config = get_notification_config() @@ -171,15 +188,18 @@ def get_notification_info(): if d in doctype_info: module_doctypes.setdefault(doctype_info[d], []).append(d) - out.update({ - "conditions": conditions, - "module_doctypes": module_doctypes, - }) + out.update( + { + "conditions": conditions, + "module_doctypes": module_doctypes, + } + ) return out + def get_notification_config(): - user = frappe.session.user or 'Guest' + user = frappe.session.user or "Guest" def _get(): subscribed_documents = get_subscribed_documents() @@ -206,28 +226,28 @@ def get_notification_config(): return frappe.cache().hget("notification_config", user, _get) + def get_filters_for(doctype): - '''get open filters for doctype''' + """get open filters for doctype""" config = get_notification_config() doctype_config = config.get("for_doctype").get(doctype, {}) filters = doctype_config if not isinstance(doctype_config, str) else None return filters + @frappe.whitelist() @frappe.read_only() def get_open_count(doctype, name, items=None): - '''Get open count for given transactions and filters + """Get open count for given transactions and filters :param doctype: Reference DocType :param name: Reference Name :param transactions: List of transactions (json/dict) - :param filters: optional filters (json/list)''' + :param filters: optional filters (json/list)""" if frappe.flags.in_migrate or frappe.flags.in_install: - return { - "count": [] - } + return {"count": []} frappe.has_permission(doc=frappe.get_doc(doctype, name), throw=True) @@ -250,18 +270,22 @@ def get_open_count(doctype, name, items=None): continue filters = get_filters_for(d) - fieldname = links.get("non_standard_fieldnames", {}).get(d, links.get('fieldname')) + fieldname = links.get("non_standard_fieldnames", {}).get(d, links.get("fieldname")) data = {"name": d} if filters: # get the fieldname for the current document # we only need open documents related to the current document filters[fieldname] = name - total = len(frappe.get_all(d, fields="name", - filters=filters, limit=100, distinct=True, ignore_ifnull=True)) + total = len( + frappe.get_all(d, fields="name", filters=filters, limit=100, distinct=True, ignore_ifnull=True) + ) data["open_count"] = total - total = len(frappe.get_all(d, fields="name", - filters={fieldname: name}, limit=100, distinct=True, ignore_ifnull=True)) + total = len( + frappe.get_all( + d, fields="name", filters={fieldname: name}, limit=100, distinct=True, ignore_ifnull=True + ) + ) data["count"] = total out.append(data) diff --git a/frappe/desk/page/activity/activity.py b/frappe/desk/page/activity/activity.py index 71130f2304..d22fa006a4 100644 --- a/frappe/desk/page/activity/activity.py +++ b/frappe/desk/page/activity/activity.py @@ -2,16 +2,18 @@ # License: MIT. See LICENSE import frappe -from frappe.utils import cint from frappe.core.doctype.activity_log.feed import get_feed_match_conditions +from frappe.utils import cint + @frappe.whitelist() def get_feed(start, page_length): """get feed""" - match_conditions_communication = get_feed_match_conditions(frappe.session.user, 'Communication') - match_conditions_comment = get_feed_match_conditions(frappe.session.user, 'Comment') + match_conditions_communication = get_feed_match_conditions(frappe.session.user, "Communication") + match_conditions_comment = get_feed_match_conditions(frappe.session.user, "Comment") - result = frappe.db.sql("""select X.* + result = frappe.db.sql( + """select X.* from (select name, owner, modified, creation, seen, comment_type, reference_doctype, reference_name, '' as link_doctype, '' as link_name, subject, communication_type, communication_medium, content @@ -38,21 +40,26 @@ def get_feed(start, page_length): ) X order by X.creation DESC LIMIT %(page_length)s - OFFSET %(start)s""" - .format(match_conditions_comment = match_conditions_comment, - match_conditions_communication = match_conditions_communication), { - "user": frappe.session.user, - "start": cint(start), - "page_length": cint(page_length) - }, as_dict=True) + OFFSET %(start)s""".format( + match_conditions_comment=match_conditions_comment, + match_conditions_communication=match_conditions_communication, + ), + {"user": frappe.session.user, "start": cint(start), "page_length": cint(page_length)}, + as_dict=True, + ) return result + @frappe.whitelist() def get_heatmap_data(): - return dict(frappe.db.sql("""select unix_timestamp(date(creation)), count(name) + return dict( + frappe.db.sql( + """select unix_timestamp(date(creation)), count(name) from `tabActivity Log` where date(creation) > subdate(curdate(), interval 1 year) group by date(creation) - order by creation asc""")) + order by creation asc""" + ) + ) diff --git a/frappe/desk/page/backups/backups.py b/frappe/desk/page/backups/backups.py index 14ed025e08..ec5bea3c4b 100644 --- a/frappe/desk/page/backups/backups.py +++ b/frappe/desk/page/backups/backups.py @@ -1,15 +1,18 @@ - +import datetime import os + import frappe from frappe import _ -from frappe.utils import get_site_path, cint, get_url +from frappe.utils import cint, get_site_path, get_url from frappe.utils.data import convert_utc_to_user_timezone -import datetime + def get_context(context): def get_time(path): dt = os.path.getmtime(path) - return convert_utc_to_user_timezone(datetime.datetime.utcfromtimestamp(dt)).strftime('%a %b %d %H:%M %Y') + return convert_utc_to_user_timezone(datetime.datetime.utcfromtimestamp(dt)).strftime( + "%a %b %d %H:%M %Y" + ) def get_encrytion_status(path): if "-enc" in path: @@ -22,29 +25,37 @@ def get_context(context): else: return "{0:.1f}K".format(float(size) / 1024) - path = get_site_path('private', 'backups') + path = get_site_path("private", "backups") files = [x for x in os.listdir(path) if os.path.isfile(os.path.join(path, x))] backup_limit = get_scheduled_backup_limit() if len(files) > backup_limit: cleanup_old_backups(path, files, backup_limit) - files = [('/backups/' + _file, + files = [ + ( + "/backups/" + _file, get_time(os.path.join(path, _file)), get_encrytion_status(os.path.join(path, _file)), - get_size(os.path.join(path, _file))) for _file in files if _file.endswith('sql.gz')] + get_size(os.path.join(path, _file)), + ) + for _file in files + if _file.endswith("sql.gz") + ] files.sort(key=lambda x: x[1], reverse=True) return {"files": files[:backup_limit]} + def get_scheduled_backup_limit(): - backup_limit = frappe.db.get_singles_value('System Settings', 'backup_limit') + backup_limit = frappe.db.get_singles_value("System Settings", "backup_limit") return cint(backup_limit) + def cleanup_old_backups(site_path, files, limit): backup_paths = [] for f in files: - if f.endswith('sql.gz'): + if f.endswith("sql.gz"): _path = os.path.abspath(os.path.join(site_path, f)) backup_paths.append(_path) @@ -57,28 +68,39 @@ def cleanup_old_backups(site_path, files, limit): os.remove(backup_paths[idx]) + def delete_downloadable_backups(): - path = get_site_path('private', 'backups') + path = get_site_path("private", "backups") files = [x for x in os.listdir(path) if os.path.isfile(os.path.join(path, x))] backup_limit = get_scheduled_backup_limit() if len(files) > backup_limit: cleanup_old_backups(path, files, backup_limit) + @frappe.whitelist() def schedule_files_backup(user_email): from frappe.utils.background_jobs import enqueue, get_jobs + queued_jobs = get_jobs(site=frappe.local.site, queue="long") - method = 'frappe.desk.page.backups.backups.backup_files_and_notify_user' + method = "frappe.desk.page.backups.backups.backup_files_and_notify_user" if method not in queued_jobs[frappe.local.site]: - enqueue("frappe.desk.page.backups.backups.backup_files_and_notify_user", queue='long', user_email=user_email) + enqueue( + "frappe.desk.page.backups.backups.backup_files_and_notify_user", + queue="long", + user_email=user_email, + ) frappe.msgprint(_("Queued for backup. You will receive an email with the download link")) else: - frappe.msgprint(_("Backup job is already queued. You will receive an email with the download link")) + frappe.msgprint( + _("Backup job is already queued. You will receive an email with the download link") + ) + def backup_files_and_notify_user(user_email=None): from frappe.utils.backups import backup + backup_files = backup(with_files=True) get_downloadable_links(backup_files) @@ -88,10 +110,11 @@ def backup_files_and_notify_user(user_email=None): subject=subject, template="file_backup_notification", args=backup_files, - header=[subject, 'green'] + header=[subject, "green"], ) + def get_downloadable_links(backup_files): - for key in ['backup_path_files', 'backup_path_private_files']: + for key in ["backup_path_files", "backup_path_private_files"]: path = backup_files[key] - backup_files[key] = get_url('/'.join(path.split('/')[-2:])) + backup_files[key] = get_url("/".join(path.split("/")[-2:])) diff --git a/frappe/desk/page/leaderboard/leaderboard.py b/frappe/desk/page/leaderboard/leaderboard.py index ad22eb9199..0ad4538a81 100644 --- a/frappe/desk/page/leaderboard/leaderboard.py +++ b/frappe/desk/page/leaderboard/leaderboard.py @@ -2,11 +2,12 @@ # License: MIT. See LICENSE import frappe + @frappe.whitelist() def get_leaderboard_config(): leaderboard_config = frappe._dict() - leaderboard_hooks = frappe.get_hooks('leaderboards') + leaderboard_hooks = frappe.get_hooks("leaderboards") for hook in leaderboard_hooks: leaderboard_config.update(frappe.get_attr(hook)()) - return leaderboard_config \ No newline at end of file + return leaderboard_config diff --git a/frappe/desk/page/setup_wizard/install_fixtures.py b/frappe/desk/page/setup_wizard/install_fixtures.py index 1ef83f7ba0..18a519f87f 100644 --- a/frappe/desk/page/setup_wizard/install_fixtures.py +++ b/frappe/desk/page/setup_wizard/install_fixtures.py @@ -3,9 +3,12 @@ import frappe from frappe import _ -from frappe.desk.doctype.global_search_settings.global_search_settings import update_global_search_doctypes +from frappe.desk.doctype.global_search_settings.global_search_settings import ( + update_global_search_doctypes, +) from frappe.utils.dashboard import sync_dashboards + def install(): update_genders() update_salutations() @@ -14,33 +17,47 @@ def install(): sync_dashboards() add_unsubscribe() + @frappe.whitelist() def update_genders(): - default_genders = ["Male", "Female", "Other","Transgender", "Genderqueer", "Non-Conforming","Prefer not to say"] - records = [{'doctype': 'Gender', 'gender': d} for d in default_genders] + default_genders = [ + "Male", + "Female", + "Other", + "Transgender", + "Genderqueer", + "Non-Conforming", + "Prefer not to say", + ] + records = [{"doctype": "Gender", "gender": d} for d in default_genders] for record in records: frappe.get_doc(record).insert(ignore_permissions=True, ignore_if_duplicate=True) + @frappe.whitelist() def update_salutations(): - default_salutations = ["Mr", "Ms", 'Mx', "Dr", "Mrs", "Madam", "Miss", "Master", "Prof"] - records = [{'doctype': 'Salutation', 'salutation': d} for d in default_salutations] + default_salutations = ["Mr", "Ms", "Mx", "Dr", "Mrs", "Madam", "Miss", "Master", "Prof"] + records = [{"doctype": "Salutation", "salutation": d} for d in default_salutations] for record in records: doc = frappe.new_doc(record.get("doctype")) doc.update(record) doc.insert(ignore_permissions=True, ignore_if_duplicate=True) + def setup_email_linking(): - doc = frappe.get_doc({ - "doctype": "Email Account", - "email_id": "email_linking@example.com", - }) + doc = frappe.get_doc( + { + "doctype": "Email Account", + "email_id": "email_linking@example.com", + } + ) doc.insert(ignore_permissions=True, ignore_if_duplicate=True) + def add_unsubscribe(): email_unsubscribe = [ {"email": "admin@example.com", "global_unsubscribe": 1}, - {"email": "guest@example.com", "global_unsubscribe": 1} + {"email": "guest@example.com", "global_unsubscribe": 1}, ] for unsubscribe in email_unsubscribe: diff --git a/frappe/desk/page/setup_wizard/setup_wizard.py b/frappe/desk/page/setup_wizard/setup_wizard.py index 0c32e886f4..f85d24704f 100755 --- a/frappe/desk/page/setup_wizard/setup_wizard.py +++ b/frappe/desk/page/setup_wizard/setup_wizard.py @@ -1,93 +1,101 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, json, os -from frappe.utils import strip, cint -from frappe.translate import (set_default_language, get_dict, send_translations) +import json +import os + +import frappe from frappe.geo.country_info import get_country_info +from frappe.translate import get_dict, send_translations, set_default_language +from frappe.utils import cint, strip from frappe.utils.password import update_password + from . import install_fixtures + def get_setup_stages(args): # App setup stage functions should not include frappe.db.commit # That is done by frappe after successful completion of all stages stages = [ { - 'status': 'Updating global settings', - 'fail_msg': 'Failed to update global settings', - 'tasks': [ - { - 'fn': update_global_settings, - 'args': args, - 'fail_msg': 'Failed to update global settings' - } - ] + "status": "Updating global settings", + "fail_msg": "Failed to update global settings", + "tasks": [ + {"fn": update_global_settings, "args": args, "fail_msg": "Failed to update global settings"} + ], } ] stages += get_stages_hooks(args) + get_setup_complete_hooks(args) - stages.append({ - # post executing hooks - 'status': 'Wrapping up', - 'fail_msg': 'Failed to complete setup', - 'tasks': [ - { - 'fn': run_post_setup_complete, - 'args': args, - 'fail_msg': 'Failed to complete setup' - } - ] - }) + stages.append( + { + # post executing hooks + "status": "Wrapping up", + "fail_msg": "Failed to complete setup", + "tasks": [ + {"fn": run_post_setup_complete, "args": args, "fail_msg": "Failed to complete setup"} + ], + } + ) return stages + @frappe.whitelist() def setup_complete(args): """Calls hooks for `setup_wizard_complete`, sets home page as `desktop` and clears cache. If wizard breaks, calls `setup_wizard_exception` hook""" # Setup complete: do not throw an exception, let the user continue to desk - if cint(frappe.db.get_single_value('System Settings', 'setup_complete')): - return {'status': 'ok'} + if cint(frappe.db.get_single_value("System Settings", "setup_complete")): + return {"status": "ok"} args = parse_args(args) stages = get_setup_stages(args) - is_background_task = frappe.conf.get('trigger_site_setup_in_background') + is_background_task = frappe.conf.get("trigger_site_setup_in_background") if is_background_task: process_setup_stages.enqueue(stages=stages, user_input=args, is_background_task=True) - return {'status': 'registered'} + return {"status": "registered"} else: return process_setup_stages(stages, args) + @frappe.task() def process_setup_stages(stages, user_input, is_background_task=False): try: frappe.flags.in_setup_wizard = True current_task = None for idx, stage in enumerate(stages): - frappe.publish_realtime('setup_task', {"progress": [idx, len(stages)], - "stage_status": stage.get('status')}, user=frappe.session.user) + frappe.publish_realtime( + "setup_task", + {"progress": [idx, len(stages)], "stage_status": stage.get("status")}, + user=frappe.session.user, + ) - for task in stage.get('tasks'): + for task in stage.get("tasks"): current_task = task - task.get('fn')(task.get('args')) + task.get("fn")(task.get("args")) except Exception: handle_setup_exception(user_input) if not is_background_task: - return {'status': 'fail', 'fail': current_task.get('fail_msg')} - frappe.publish_realtime('setup_task', - {'status': 'fail', "fail_msg": current_task.get('fail_msg')}, user=frappe.session.user) + return {"status": "fail", "fail": current_task.get("fail_msg")} + frappe.publish_realtime( + "setup_task", + {"status": "fail", "fail_msg": current_task.get("fail_msg")}, + user=frappe.session.user, + ) else: run_setup_success(user_input) if not is_background_task: - return {'status': 'ok'} - frappe.publish_realtime('setup_task', {"status": 'ok'}, user=frappe.session.user) + return {"status": "ok"} + frappe.publish_realtime("setup_task", {"status": "ok"}, user=frappe.session.user) finally: frappe.flags.in_setup_wizard = False + def update_global_settings(args): if args.language and args.language != "English": set_default_language(get_language_code(args.lang)) @@ -97,38 +105,41 @@ def update_global_settings(args): update_system_settings(args) update_user_name(args) + def run_post_setup_complete(args): disable_future_access() frappe.db.commit() frappe.clear_cache() + def run_setup_success(args): for hook in frappe.get_hooks("setup_wizard_success"): frappe.get_attr(hook)(args) install_fixtures.install() + def get_stages_hooks(args): stages = [] for method in frappe.get_hooks("setup_wizard_stages"): stages += frappe.get_attr(method)(args) return stages + def get_setup_complete_hooks(args): stages = [] for method in frappe.get_hooks("setup_wizard_complete"): - stages.append({ - 'status': 'Executing method', - 'fail_msg': 'Failed to execute method', - 'tasks': [ - { - 'fn': frappe.get_attr(method), - 'args': args, - 'fail_msg': 'Failed to execute method' - } - ] - }) + stages.append( + { + "status": "Executing method", + "fail_msg": "Failed to execute method", + "tasks": [ + {"fn": frappe.get_attr(method), "args": args, "fail_msg": "Failed to execute method"} + ], + } + ) return stages + def handle_setup_exception(args): frappe.db.rollback() if args: @@ -137,83 +148,91 @@ def handle_setup_exception(args): for hook in frappe.get_hooks("setup_wizard_exception"): frappe.get_attr(hook)(traceback, args) + def update_system_settings(args): number_format = get_country_info(args.get("country")).get("number_format", "#,###.##") # replace these as float number formats, as they have 0 precision # and are currency number formats and not for floats - if number_format=="#.###": + if number_format == "#.###": number_format = "#.###,##" - elif number_format=="#,###": + elif number_format == "#,###": number_format = "#,###.##" system_settings = frappe.get_doc("System Settings", "System Settings") - system_settings.update({ - "country": args.get("country"), - "language": get_language_code(args.get("language")) or 'en', - "time_zone": args.get("timezone"), - "float_precision": 3, - 'date_format': frappe.db.get_value("Country", args.get("country"), "date_format"), - 'time_format': frappe.db.get_value("Country", args.get("country"), "time_format"), - 'number_format': number_format, - 'enable_scheduler': 1 if not frappe.flags.in_test else 0, - 'backup_limit': 3 # Default for downloadable backups - }) + system_settings.update( + { + "country": args.get("country"), + "language": get_language_code(args.get("language")) or "en", + "time_zone": args.get("timezone"), + "float_precision": 3, + "date_format": frappe.db.get_value("Country", args.get("country"), "date_format"), + "time_format": frappe.db.get_value("Country", args.get("country"), "time_format"), + "number_format": number_format, + "enable_scheduler": 1 if not frappe.flags.in_test else 0, + "backup_limit": 3, # Default for downloadable backups + } + ) system_settings.save() + def update_user_name(args): - first_name, last_name = args.get('full_name', ''), '' - if ' ' in first_name: - first_name, last_name = first_name.split(' ', 1) + first_name, last_name = args.get("full_name", ""), "" + if " " in first_name: + first_name, last_name = first_name.split(" ", 1) if args.get("email"): - if frappe.db.exists('User', args.get('email')): + if frappe.db.exists("User", args.get("email")): # running again return - - args['name'] = args.get("email") + args["name"] = args.get("email") _mute_emails, frappe.flags.mute_emails = frappe.flags.mute_emails, True - doc = frappe.get_doc({ - "doctype":"User", - "email": args.get("email"), - "first_name": first_name, - "last_name": last_name - }) + doc = frappe.get_doc( + { + "doctype": "User", + "email": args.get("email"), + "first_name": first_name, + "last_name": last_name, + } + ) doc.flags.no_welcome_mail = True doc.insert() frappe.flags.mute_emails = _mute_emails update_password(args.get("email"), args.get("password")) elif first_name: - args.update({ - "name": frappe.session.user, - "first_name": first_name, - "last_name": last_name - }) + args.update({"name": frappe.session.user, "first_name": first_name, "last_name": last_name}) - frappe.db.sql("""update `tabUser` SET first_name=%(first_name)s, - last_name=%(last_name)s WHERE name=%(name)s""", args) + frappe.db.sql( + """update `tabUser` SET first_name=%(first_name)s, + last_name=%(last_name)s WHERE name=%(name)s""", + args, + ) if args.get("attach_user"): attach_user = args.get("attach_user").split(",") - if len(attach_user)==3: + if len(attach_user) == 3: filename, filetype, content = attach_user - _file = frappe.get_doc({ - "doctype": "File", - "file_name": filename, - "attached_to_doctype": "User", - "attached_to_name": args.get("name"), - "content": content, - "decode": True}) + _file = frappe.get_doc( + { + "doctype": "File", + "file_name": filename, + "attached_to_doctype": "User", + "attached_to_name": args.get("name"), + "content": content, + "decode": True, + } + ) _file.save() fileurl = _file.file_url frappe.db.set_value("User", args.get("name"), "user_image", fileurl) - if args.get('name'): + if args.get("name"): add_all_roles_to(args.get("name")) + def parse_args(args): if not args: args = frappe.local.form_dict @@ -229,31 +248,42 @@ def parse_args(args): return args + def add_all_roles_to(name): user = frappe.get_doc("User", name) for role in frappe.db.sql("""select name from tabRole"""): - if role[0] not in ["Administrator", "Guest", "All", "Customer", "Supplier", "Partner", "Employee"]: + if role[0] not in [ + "Administrator", + "Guest", + "All", + "Customer", + "Supplier", + "Partner", + "Employee", + ]: d = user.append("roles") d.role = role[0] user.save() + def disable_future_access(): - frappe.db.set_default('desktop:home_page', 'workspace') - frappe.db.set_value('System Settings', 'System Settings', 'setup_complete', 1) - frappe.db.set_value('System Settings', 'System Settings', 'is_first_startup', 1) + frappe.db.set_default("desktop:home_page", "workspace") + frappe.db.set_value("System Settings", "System Settings", "setup_complete", 1) + frappe.db.set_value("System Settings", "System Settings", "is_first_startup", 1) # Enable onboarding after install - frappe.db.set_value('System Settings', 'System Settings', 'enable_onboarding', 1) + frappe.db.set_value("System Settings", "System Settings", "enable_onboarding", 1) if not frappe.flags.in_test: # remove all roles and add 'Administrator' to prevent future access - page = frappe.get_doc('Page', 'setup-wizard') + page = frappe.get_doc("Page", "setup-wizard") page.roles = [] - page.append('roles', {'role': 'Administrator'}) + page.append("roles", {"role": "Administrator"}) page.flags.do_not_update_json = True page.flags.ignore_permissions = True page.save() + @frappe.whitelist() def load_messages(language): """Load translation messages for given language from all `setup_wizard_requires` @@ -272,33 +302,42 @@ def load_messages(language): send_translations(m) return frappe.local.lang + @frappe.whitelist() def load_languages(): - language_codes = frappe.db.sql('select language_code, language_name from tabLanguage order by name', as_dict=True) + language_codes = frappe.db.sql( + "select language_code, language_name from tabLanguage order by name", as_dict=True + ) codes_to_names = {} for d in language_codes: codes_to_names[d.language_code] = d.language_name return { - "default_language": frappe.db.get_value('Language', frappe.local.lang, 'language_name') or frappe.local.lang, - "languages": sorted(frappe.db.sql_list('select language_name from tabLanguage order by name')), - "codes_to_names": codes_to_names + "default_language": frappe.db.get_value("Language", frappe.local.lang, "language_name") + or frappe.local.lang, + "languages": sorted(frappe.db.sql_list("select language_name from tabLanguage order by name")), + "codes_to_names": codes_to_names, } + @frappe.whitelist() def load_country(): from frappe.sessions import get_geo_ip_country + return get_geo_ip_country(frappe.local.request_ip) if frappe.local.request_ip else None + @frappe.whitelist() def load_user_details(): return { "full_name": frappe.cache().hget("full_name", "signup"), - "email": frappe.cache().hget("email", "signup") + "email": frappe.cache().hget("email", "signup"), } + @frappe.whitelist() def reset_is_first_startup(): - frappe.db.set_value('System Settings', 'System Settings', 'is_first_startup', 0) + frappe.db.set_value("System Settings", "System Settings", "is_first_startup", 0) + def prettify_args(args): # remove attachments @@ -313,6 +352,7 @@ def prettify_args(args): pretty_args.append("{} = {}".format(key, args[key])) return pretty_args + def email_setup_wizard_exception(traceback, args): if not frappe.conf.setup_wizard_exception_email: return @@ -349,25 +389,31 @@ def email_setup_wizard_exception(traceback, args): headers=frappe.request.headers, ) - frappe.sendmail(recipients=frappe.conf.setup_wizard_exception_email, + frappe.sendmail( + recipients=frappe.conf.setup_wizard_exception_email, sender=frappe.session.user, subject="Setup failed: {}".format(frappe.local.site), message=message, - delayed=False) + delayed=False, + ) + def log_setup_wizard_exception(traceback, args): - with open('../logs/setup-wizard.log', 'w+') as setup_log: + with open("../logs/setup-wizard.log", "w+") as setup_log: setup_log.write(traceback) setup_log.write(json.dumps(args)) + def get_language_code(lang): - return frappe.db.get_value('Language', {'language_name':lang}) + return frappe.db.get_value("Language", {"language_name": lang}) + def enable_twofactor_all_roles(): - all_role = frappe.get_doc('Role',{'role_name':'All'}) + all_role = frappe.get_doc("Role", {"role_name": "All"}) all_role.two_factor_auth = True all_role.save(ignore_permissions=True) + def make_records(records, debug=False): from frappe import _dict from frappe.modules import scrub @@ -378,7 +424,7 @@ def make_records(records, debug=False): # LOG every success and failure for record in records: doctype = record.get("doctype") - condition = record.get('__condition') + condition = record.get("__condition") if condition and not condition(): continue @@ -387,7 +433,7 @@ def make_records(records, debug=False): doc.update(record) # ignore mandatory for root - parent_link_field = ("parent_" + scrub(doc.doctype)) + parent_link_field = "parent_" + scrub(doc.doctype) if doc.meta.get_field(parent_link_field) and not doc.get(parent_link_field): doc.flags.ignore_mandatory = True @@ -399,7 +445,7 @@ def make_records(records, debug=False): # print("Failed to insert duplicate {0} {1}".format(doctype, doc.name)) # pass DuplicateEntryError and continue - if e.args and e.args[0]==doc.doctype and e.args[1]==doc.name: + if e.args and e.args[0] == doc.doctype and e.args[1] == doc.name: # make sure DuplicateEntryError is for the exact same doc and not a related doc frappe.clear_messages() else: @@ -407,7 +453,7 @@ def make_records(records, debug=False): except Exception as e: frappe.db.rollback() - exception = record.get('__exception') + exception = record.get("__exception") if exception: config = _dict(exception) if isinstance(e, config.exception): diff --git a/frappe/desk/page/user_profile/user_profile.py b/frappe/desk/page/user_profile/user_profile.py index 0d91fd0d91..f9c8d98869 100644 --- a/frappe/desk/page/user_profile/user_profile.py +++ b/frappe/desk/page/user_profile/user_profile.py @@ -1,7 +1,9 @@ -import frappe from datetime import datetime + +import frappe from frappe.utils import getdate + @frappe.whitelist() def get_energy_points_heatmap_data(user, date): try: @@ -9,7 +11,9 @@ def get_energy_points_heatmap_data(user, date): except Exception: date = getdate() - return dict(frappe.db.sql("""select unix_timestamp(date(creation)), sum(points) + return dict( + frappe.db.sql( + """select unix_timestamp(date(creation)), sum(points) from `tabEnergy Point Log` where date(creation) > subdate('{date}', interval 1 year) and @@ -17,68 +21,93 @@ def get_energy_points_heatmap_data(user, date): user = %s and type != 'Review' group by date(creation) - order by creation asc""".format(date = date), user)) + order by creation asc""".format( + date=date + ), + user, + ) + ) @frappe.whitelist() def get_energy_points_percentage_chart_data(user, field): - result = frappe.db.get_all('Energy Point Log', - filters = {'user': user, 'type': ['!=', 'Review']}, - group_by = field, - order_by = field, - fields = [field, 'ABS(sum(points)) as points'], - as_list = True) + result = frappe.db.get_all( + "Energy Point Log", + filters={"user": user, "type": ["!=", "Review"]}, + group_by=field, + order_by=field, + fields=[field, "ABS(sum(points)) as points"], + as_list=True, + ) return { "labels": [r[0] for r in result if r[0] is not None], - "datasets": [{ - "values": [r[1] for r in result] - }] + "datasets": [{"values": [r[1] for r in result]}], } + @frappe.whitelist() def get_user_rank(user): month_start = datetime.today().replace(day=1) - monthly_rank = frappe.db.get_all('Energy Point Log', - group_by = 'user', - filters = {'creation': ['>', month_start], 'type' : ['!=', 'Review']}, - fields = ['user', 'sum(points)'], - order_by = 'sum(points) desc', - as_list = True) - - all_time_rank = frappe.db.get_all('Energy Point Log', - group_by = 'user', - filters = {'type' : ['!=', 'Review']}, - fields = ['user', 'sum(points)'], - order_by = 'sum(points) desc', - as_list = True) + monthly_rank = frappe.db.get_all( + "Energy Point Log", + group_by="user", + filters={"creation": [">", month_start], "type": ["!=", "Review"]}, + fields=["user", "sum(points)"], + order_by="sum(points) desc", + as_list=True, + ) + + all_time_rank = frappe.db.get_all( + "Energy Point Log", + group_by="user", + filters={"type": ["!=", "Review"]}, + fields=["user", "sum(points)"], + order_by="sum(points) desc", + as_list=True, + ) return { - 'monthly_rank': [i+1 for i, r in enumerate(monthly_rank) if r[0] == user], - 'all_time_rank': [i+1 for i, r in enumerate(all_time_rank) if r[0] == user] + "monthly_rank": [i + 1 for i, r in enumerate(monthly_rank) if r[0] == user], + "all_time_rank": [i + 1 for i, r in enumerate(all_time_rank) if r[0] == user], } @frappe.whitelist() def update_profile_info(profile_info): profile_info = frappe.parse_json(profile_info) - keys = ['location', 'interest', 'user_image', 'bio'] + keys = ["location", "interest", "user_image", "bio"] for key in keys: if key not in profile_info: profile_info[key] = None - user = frappe.get_doc('User', frappe.session.user) + user = frappe.get_doc("User", frappe.session.user) user.update(profile_info) user.save() return user + @frappe.whitelist() def get_energy_points_list(start, limit, user): - return frappe.db.get_list('Energy Point Log', - filters = {'user': user, 'type': ['!=', 'Review']}, - fields = ['name','user', 'points', 'reference_doctype', 'reference_name', 'reason', - 'type', 'seen', 'rule', 'owner', 'creation', 'revert_of'], - start = start, - limit = limit, - order_by = 'creation desc') + return frappe.db.get_list( + "Energy Point Log", + filters={"user": user, "type": ["!=", "Review"]}, + fields=[ + "name", + "user", + "points", + "reference_doctype", + "reference_name", + "reason", + "type", + "seen", + "rule", + "owner", + "creation", + "revert_of", + ], + start=start, + limit=limit, + order_by="creation desc", + ) diff --git a/frappe/desk/query_report.py b/frappe/desk/query_report.py index f5f50b14fe..7de8ccabbf 100644 --- a/frappe/desk/query_report.py +++ b/frappe/desk/query_report.py @@ -1,27 +1,27 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe -import os import json +import os +from datetime import timedelta +import frappe +import frappe.desk.reportview from frappe import _ -from frappe.modules import scrub, get_module_path +from frappe.core.utils import ljust_list +from frappe.model.utils import render_include +from frappe.modules import get_module_path, scrub +from frappe.permissions import get_role_permissions +from frappe.translate import send_translations from frappe.utils import ( - flt, cint, cstr, + flt, + format_duration, get_html_format, get_url_to_form, gzip_decompress, - format_duration, ) -from frappe.model.utils import render_include -from frappe.translate import send_translations -import frappe.desk.reportview -from frappe.permissions import get_role_permissions -from datetime import timedelta -from frappe.core.utils import ljust_list def get_report_doc(report_name): @@ -47,9 +47,7 @@ def get_report_doc(report_name): if not frappe.has_permission(doc.ref_doctype, "report"): frappe.throw( - _("You don't have permission to get a report on: {0}").format( - doc.ref_doctype - ), + _("You don't have permission to get a report on: {0}").format(doc.ref_doctype), frappe.PermissionError, ) @@ -72,8 +70,11 @@ def get_report_result(report, filters): return res + @frappe.read_only() -def generate_report_result(report, filters=None, user=None, custom_columns=None, is_tree=False, parent_field=None): +def generate_report_result( + report, filters=None, user=None, custom_columns=None, is_tree=False, parent_field=None +): user = user or frappe.session.user filters = filters or [] @@ -99,7 +100,9 @@ def generate_report_result(report, filters=None, user=None, custom_columns=None, columns.insert(custom_column["insert_after_index"] + 1, custom_column) # all columns which are not in original report - report_custom_columns = [column for column in columns if column["fieldname"] not in report_column_names] + report_custom_columns = [ + column for column in columns if column["fieldname"] not in report_column_names + ] if report_custom_columns: result = add_custom_column_data(report_custom_columns, result) @@ -118,10 +121,10 @@ def generate_report_result(report, filters=None, user=None, custom_columns=None, "report_summary": report_summary, "skip_total_row": skip_total_row or 0, "status": None, - "execution_time": frappe.cache().hget("report_execution_time", report.name) - or 0, + "execution_time": frappe.cache().hget("report_execution_time", report.name) or 0, } + def normalize_result(result, columns): # Converts to list of dicts from list of lists/tuples data = [] @@ -137,6 +140,7 @@ def normalize_result(result, columns): return data + @frappe.whitelist() def background_enqueue_run(report_name, filters=None, user=None): """run reports in background""" @@ -169,14 +173,12 @@ def background_enqueue_run(report_name, filters=None, user=None): @frappe.whitelist() def get_script(report_name): report = get_report_doc(report_name) - module = report.module or frappe.db.get_value( - "DocType", report.ref_doctype, "module" - ) + module = report.module or frappe.db.get_value("DocType", report.ref_doctype, "module") is_custom_module = frappe.get_cached_value("Module Def", module, "custom") # custom modules are virtual modules those exists in DB but not in disk. - module_path = '' if is_custom_module else get_module_path(module) + module_path = "" if is_custom_module else get_module_path(module) report_folder = module_path and os.path.join(module_path, "report", scrub(report.name)) script_path = report_folder and os.path.join(report_folder, scrub(report.name) + ".js") print_path = report_folder and os.path.join(report_folder, scrub(report.name) + ".html") @@ -203,14 +205,21 @@ def get_script(report_name): return { "script": render_include(script), "html_format": html_format, - "execution_time": frappe.cache().hget("report_execution_time", report_name) - or 0, + "execution_time": frappe.cache().hget("report_execution_time", report_name) or 0, } @frappe.whitelist() @frappe.read_only() -def run(report_name, filters=None, user=None, ignore_prepared_report=False, custom_columns=None, is_tree=False, parent_field=None): +def run( + report_name, + filters=None, + user=None, + ignore_prepared_report=False, + custom_columns=None, + is_tree=False, + parent_field=None, +): report = get_report_doc(report_name) if not user: user = frappe.session.user @@ -240,9 +249,7 @@ def run(report_name, filters=None, user=None, ignore_prepared_report=False, cust else: result = generate_report_result(report, filters, user, custom_columns, is_tree, parent_field) - result["add_total_row"] = report.add_total_row and not result.get( - "skip_total_row", False - ) + result["add_total_row"] = report.add_total_row and not result.get("skip_total_row", False) return result @@ -251,14 +258,14 @@ def add_custom_column_data(custom_columns, result): custom_column_data = get_data_for_custom_report(custom_columns) for column in custom_columns: - key = (column.get('doctype'), column.get('fieldname')) + key = (column.get("doctype"), column.get("fieldname")) if key in custom_column_data: for row in result: - row_reference = row.get(column.get('link_field')) + row_reference = row.get(column.get("link_field")) # possible if the row is empty if not row_reference: continue - row[column.get('fieldname')] = custom_column_data.get(key).get(row_reference) + row[column.get("fieldname")] = custom_column_data.get(key).get(row_reference) return result @@ -382,7 +389,7 @@ def build_xlsx_data(data, visible_idx, include_indentation, ignore_visible_idx=F if column.get("hidden"): continue result[0].append(_(column.get("label"))) - column_width = cint(column.get('width', 0)) + column_width = cint(column.get("width", 0)) # to convert into scale accepted by openpyxl column_width /= 10 column_widths.append(column_width) @@ -441,9 +448,7 @@ def add_total_row(result, columns, meta=None, is_tree=False, parent_field=None): if i >= len(row): continue cell = row.get(fieldname) if isinstance(row, dict) else row[i] - if fieldtype in ["Currency", "Int", "Float", "Percent", "Duration"] and flt( - cell - ): + if fieldtype in ["Currency", "Int", "Float", "Percent", "Duration"] and flt(cell): if not (is_tree and row.get(parent_field)): total_row[i] = flt(total_row[i]) + flt(cell) @@ -456,11 +461,7 @@ def add_total_row(result, columns, meta=None, is_tree=False, parent_field=None): total_row[i] = total_row[i] + cell if fieldtype == "Link" and options == "Currency": - total_row[i] = ( - result[0].get(fieldname) - if isinstance(result[0], dict) - else result[0][i] - ) + total_row[i] = result[0].get(fieldname) if isinstance(result[0], dict) else result[0][i] for i in has_percent: total_row[i] = flt(total_row[i]) / len(result) @@ -498,9 +499,7 @@ def get_data_for_custom_report(columns): if column.get("link_field"): fieldname = column.get("fieldname") doctype = column.get("doctype") - doc_field_value_map[(doctype, fieldname)] = get_data_for_custom_field( - doctype, fieldname - ) + doc_field_value_map[(doctype, fieldname)] = get_data_for_custom_field(doctype, fieldname) return doc_field_value_map @@ -522,7 +521,7 @@ def save_report(reference_report, report_name, columns): report = frappe.get_doc("Report", docname) existing_jd = json.loads(report.json) existing_jd["columns"] = json.loads(columns) - report.update({"json": json.dumps(existing_jd, separators=(',', ':'))}) + report.update({"json": json.dumps(existing_jd, separators=(",", ":"))}) report.save() frappe.msgprint(_("Report updated successfully")) @@ -556,11 +555,7 @@ def get_filtered_data(ref_doctype, columns, data, user): if match_filters_per_doctype: for row in data: # Why linked_doctypes.get(ref_doctype)? because if column is empty, linked_doctypes[ref_doctype] is removed - if ( - linked_doctypes.get(ref_doctype) - and shared - and row[linked_doctypes[ref_doctype]] in shared - ): + if linked_doctypes.get(ref_doctype) and shared and row[linked_doctypes[ref_doctype]] in shared: result.append(row) elif has_match( @@ -610,11 +605,7 @@ def has_match( if doctype == ref_doctype and if_owner: idx = linked_doctypes.get("User") - if ( - idx is not None - and row[idx] == user - and columns_dict[idx] == columns_dict.get("owner") - ): + if idx is not None and row[idx] == user and columns_dict[idx] == columns_dict.get("owner"): # owner match is true matched_for_doctype = True diff --git a/frappe/desk/report/todo/todo.py b/frappe/desk/report/todo/todo.py index b1e49bc95d..7c566c74ea 100644 --- a/frappe/desk/report/todo/todo.py +++ b/frappe/desk/report/todo/todo.py @@ -5,29 +5,65 @@ import frappe from frappe import _ from frappe.utils import getdate + def execute(filters=None): priority_map = {"High": 3, "Medium": 2, "Low": 1} - todo_list = frappe.get_list('ToDo', fields=["name", "date", "description", - "priority", "reference_type", "reference_name", "assigned_by", "owner"], - filters={'status': 'Open'}) + todo_list = frappe.get_list( + "ToDo", + fields=[ + "name", + "date", + "description", + "priority", + "reference_type", + "reference_name", + "assigned_by", + "owner", + ], + filters={"status": "Open"}, + ) - todo_list.sort(key=lambda todo: (priority_map.get(todo.priority, 0), - todo.date and getdate(todo.date) or getdate("1900-01-01")), reverse=True) + todo_list.sort( + key=lambda todo: ( + priority_map.get(todo.priority, 0), + todo.date and getdate(todo.date) or getdate("1900-01-01"), + ), + reverse=True, + ) - columns = [_("ID")+":Link/ToDo:90", _("Priority")+"::60", _("Date")+ ":Date", - _("Description")+"::150", _("Assigned To/Owner") + ":Data:120", - _("Assigned By")+":Data:120", _("Reference")+"::200"] + columns = [ + _("ID") + ":Link/ToDo:90", + _("Priority") + "::60", + _("Date") + ":Date", + _("Description") + "::150", + _("Assigned To/Owner") + ":Data:120", + _("Assigned By") + ":Data:120", + _("Reference") + "::200", + ] result = [] for todo in todo_list: - if todo.owner==frappe.session.user or todo.assigned_by==frappe.session.user: + if todo.owner == frappe.session.user or todo.assigned_by == frappe.session.user: if todo.reference_type: - todo.reference = """%s: %s""" % (todo.reference_type, - todo.reference_name, todo.reference_type, todo.reference_name) + todo.reference = """%s: %s""" % ( + todo.reference_type, + todo.reference_name, + todo.reference_type, + todo.reference_name, + ) else: todo.reference = None - result.append([todo.name, todo.priority, todo.date, todo.description, - todo.owner, todo.assigned_by, todo.reference]) + result.append( + [ + todo.name, + todo.priority, + todo.date, + todo.description, + todo.owner, + todo.assigned_by, + todo.reference, + ] + ) - return columns, result \ No newline at end of file + return columns, result diff --git a/frappe/desk/report_dump.py b/frappe/desk/report_dump.py index f57ed97fa5..ac01cf892f 100644 --- a/frappe/desk/report_dump.py +++ b/frappe/desk/report_dump.py @@ -2,9 +2,11 @@ # License: MIT. See LICENSE -import frappe -import json import copy +import json + +import frappe + @frappe.whitelist() def get_data(doctypes, last_modified): @@ -19,7 +21,7 @@ def get_data(doctypes, last_modified): for d in doctypes: args = copy.deepcopy(data_map[d]) - dt = d.find("[") != -1 and d[:d.find("[")] or d + dt = d.find("[") != -1 and d[: d.find("[")] or d out[dt] = {} if args.get("from"): @@ -32,10 +34,14 @@ def get_data(doctypes, last_modified): if d in last_modified: if not args.get("conditions"): - args['conditions'] = [] - args['conditions'].append(modified_table + "modified > '" + last_modified[d] + "'") - out[dt]["modified_names"] = frappe.db.sql_list("""select %sname from %s - where %smodified > %s""" % (modified_table, table, modified_table, "%s"), last_modified[d]) + args["conditions"] = [] + args["conditions"].append(modified_table + "modified > '" + last_modified[d] + "'") + out[dt]["modified_names"] = frappe.db.sql_list( + """select %sname from %s + where %smodified > %s""" + % (modified_table, table, modified_table, "%s"), + last_modified[d], + ) if args.get("force_index"): conditions = " force index (%s) " % args["force_index"] @@ -44,16 +50,23 @@ def get_data(doctypes, last_modified): if args.get("order_by"): order_by = " order by " + args["order_by"] - out[dt]["data"] = [list(t) for t in frappe.db.sql("""select %s from %s %s %s""" \ - % (",".join(args["columns"]), table, conditions, order_by))] + out[dt]["data"] = [ + list(t) + for t in frappe.db.sql( + """select %s from %s %s %s""" % (",".join(args["columns"]), table, conditions, order_by) + ) + ] # last modified modified_table = table if "," in table: modified_table = " ".join(table.split(",")[0].split(" ")[:-1]) - tmp = frappe.db.sql("""select `modified` - from %s order by modified desc limit 1""" % modified_table) + tmp = frappe.db.sql( + """select `modified` + from %s order by modified desc limit 1""" + % modified_table + ) out[dt]["last_modified"] = tmp and tmp[0][0] or "" out[dt]["columns"] = list(map(lambda c: c.split(" as ")[-1], args["columns"])) diff --git a/frappe/desk/reportview.py b/frappe/desk/reportview.py index 1ec8ede62e..b45f80f6ff 100644 --- a/frappe/desk/reportview.py +++ b/frappe/desk/reportview.py @@ -3,16 +3,18 @@ """build query for doclistview and return results""" -import frappe, json +import json +from io import StringIO + +import frappe import frappe.permissions -from frappe.model.db_query import DatabaseQuery -from frappe.model import default_fields, optional_fields, child_table_fields from frappe import _ -from io import StringIO from frappe.core.doctype.access_log.access_log import make_access_log -from frappe.utils import cstr, format_duration +from frappe.model import child_table_fields, default_fields, optional_fields from frappe.model.base_document import get_controller -from frappe.utils import add_user_info +from frappe.model.db_query import DatabaseQuery +from frappe.utils import add_user_info, cstr, format_duration + @frappe.whitelist() @frappe.read_only() @@ -26,6 +28,7 @@ def get(): data = compress(execute(**args), args=args) return data + @frappe.whitelist() @frappe.read_only() def get_list(): @@ -40,6 +43,7 @@ def get_list(): return data + @frappe.whitelist() @frappe.read_only() def get_count(): @@ -49,15 +53,17 @@ def get_count(): controller = get_controller(args.doctype) data = controller(args.doctype).get_count(args) else: - distinct = 'distinct ' if args.distinct=='true' else '' + distinct = "distinct " if args.distinct == "true" else "" args.fields = [f"count({distinct}`tab{args.doctype}`.name) as total_count"] - data = execute(**args)[0].get('total_count') + data = execute(**args)[0].get("total_count") return data + def execute(doctype, *args, **kwargs): return DatabaseQuery(doctype).execute(*args, **kwargs) + def get_form_params(): """Stringify GET request parameters.""" data = frappe._dict(frappe.local.form_dict) @@ -65,6 +71,7 @@ def get_form_params(): validate_args(data) return data + def validate_args(data): parse_json(data) setup_group_by(data) @@ -79,6 +86,7 @@ def validate_args(data): return data + def validate_fields(data): wildcard = update_wildcard_field_param(data) @@ -96,19 +104,20 @@ def validate_fields(data): raise_invalid_field(fieldname) # remove the field from the query if the report hide flag is set and current view is Report - if df.report_hide and data.view == 'Report': + if df.report_hide and data.view == "Report": data.fields.remove(field) continue if df.fieldname in [_df.fieldname for _df in meta.get_high_permlevel_fields()]: - if df.get('permlevel') not in meta.get_permlevel_access(parenttype=data.doctype): + if df.get("permlevel") not in meta.get_permlevel_access(parenttype=data.doctype): data.fields.remove(field) + def validate_filters(data, filters): if isinstance(filters, list): # filters as list for condition in filters: - if len(condition)==3: + if len(condition) == 3: # [fieldname, condition, value] fieldname = condition[0] if is_standard(fieldname): @@ -133,60 +142,71 @@ def validate_filters(data, filters): if not df: raise_invalid_field(fieldname) + def setup_group_by(data): - '''Add columns for aggregated values e.g. count(name)''' + """Add columns for aggregated values e.g. count(name)""" if data.group_by and data.aggregate_function: - if data.aggregate_function.lower() not in ('count', 'sum', 'avg'): - frappe.throw(_('Invalid aggregate function')) + if data.aggregate_function.lower() not in ("count", "sum", "avg"): + frappe.throw(_("Invalid aggregate function")) if frappe.db.has_column(data.aggregate_on_doctype, data.aggregate_on_field): - data.fields.append('{aggregate_function}(`tab{aggregate_on_doctype}`.`{aggregate_on_field}`) AS _aggregate_column'.format(**data)) + data.fields.append( + "{aggregate_function}(`tab{aggregate_on_doctype}`.`{aggregate_on_field}`) AS _aggregate_column".format( + **data + ) + ) if data.aggregate_on_field: data.fields.append(f"`tab{data.aggregate_on_doctype}`.`{data.aggregate_on_field}`") else: raise_invalid_field(data.aggregate_on_field) - data.pop('aggregate_on_doctype') - data.pop('aggregate_on_field') - data.pop('aggregate_function') + data.pop("aggregate_on_doctype") + data.pop("aggregate_on_field") + data.pop("aggregate_function") + def raise_invalid_field(fieldname): - frappe.throw(_('Field not permitted in query') + ': {0}'.format(fieldname), frappe.DataError) + frappe.throw(_("Field not permitted in query") + ": {0}".format(fieldname), frappe.DataError) + def is_standard(fieldname): - if '.' in fieldname: + if "." in fieldname: parenttype, fieldname = get_parenttype_and_fieldname(fieldname, None) - return fieldname in default_fields or fieldname in optional_fields or fieldname in child_table_fields + return ( + fieldname in default_fields or fieldname in optional_fields or fieldname in child_table_fields + ) + def extract_fieldname(field): - for text in (',', '/*', '#'): + for text in (",", "/*", "#"): if text in field: raise_invalid_field(field) fieldname = field - for sep in (' as ', ' AS '): + for sep in (" as ", " AS "): if sep in fieldname: fieldname = fieldname.split(sep)[0] # certain functions allowed, extract the fieldname from the function - if (fieldname.startswith('count(') - or fieldname.startswith('sum(') - or fieldname.startswith('avg(')): - if not fieldname.strip().endswith(')'): + if fieldname.startswith("count(") or fieldname.startswith("sum(") or fieldname.startswith("avg("): + if not fieldname.strip().endswith(")"): raise_invalid_field(field) - fieldname = fieldname.split('(', 1)[1][:-1] + fieldname = fieldname.split("(", 1)[1][:-1] return fieldname + def get_meta_and_docfield(fieldname, data): parenttype, fieldname = get_parenttype_and_fieldname(fieldname, data) meta = frappe.get_meta(parenttype) df = meta.get_field(fieldname) return meta, df + def update_wildcard_field_param(data): - if ((isinstance(data.fields, str) and data.fields == "*") - or (isinstance(data.fields, (list, tuple)) and len(data.fields) == 1 and data.fields[0] == "*")): + if (isinstance(data.fields, str) and data.fields == "*") or ( + isinstance(data.fields, (list, tuple)) and len(data.fields) == 1 and data.fields[0] == "*" + ): data.fields = frappe.db.get_table_columns(data.doctype) return True @@ -194,17 +214,10 @@ def update_wildcard_field_param(data): def clean_params(data): - for param in ( - "cmd", - "data", - "ignore_permissions", - "view", - "user", - "csrf_token", - "join" - ): + for param in ("cmd", "data", "ignore_permissions", "view", "user", "csrf_token", "join"): data.pop(param, None) + def parse_json(data): if isinstance(data.get("filters"), str): data["filters"] = json.loads(data["filters"]) @@ -229,13 +242,15 @@ def get_parenttype_and_fieldname(field, data): return parenttype, fieldname + def compress(data, args=None): """separate keys and values""" from frappe.desk.query_report import add_total_row user_info = {} - if not data: return data + if not data: + return data if args is None: args = {} values = [] @@ -255,34 +270,25 @@ def compress(data, args=None): meta = frappe.get_meta(args.doctype) values = add_total_row(values, keys, meta) - return { - "keys": keys, - "values": values, - "user_info": user_info - } + return {"keys": keys, "values": values, "user_info": user_info} + @frappe.whitelist() def save_report(name, doctype, report_settings): """Save reports of type Report Builder from Report View""" - if frappe.db.exists('Report', name): - report = frappe.get_doc('Report', name) + if frappe.db.exists("Report", name): + report = frappe.get_doc("Report", name) if report.is_standard == "Yes": frappe.throw(_("Standard Reports cannot be edited")) if report.report_type != "Report Builder": frappe.throw(_("Only reports of type Report Builder can be edited")) - if ( - report.owner != frappe.session.user - and not frappe.has_permission("Report", "write") - ): - frappe.throw( - _("Insufficient Permissions for editing Report"), - frappe.PermissionError - ) + if report.owner != frappe.session.user and not frappe.has_permission("Report", "write"): + frappe.throw(_("Insufficient Permissions for editing Report"), frappe.PermissionError) else: - report = frappe.new_doc('Report') + report = frappe.new_doc("Report") report.report_name = name report.ref_doctype = doctype @@ -296,6 +302,7 @@ def save_report(name, doctype, report_settings): ) return report.name + @frappe.whitelist() def delete_report(name): """Delete reports of type Report Builder from Report View""" @@ -307,14 +314,8 @@ def delete_report(name): if report.report_type != "Report Builder": frappe.throw(_("Only reports of type Report Builder can be deleted")) - if ( - report.owner != frappe.session.user - and not frappe.has_permission("Report", "delete") - ): - frappe.throw( - _("Insufficient Permissions for deleting Report"), - frappe.PermissionError - ) + if report.owner != frappe.session.user and not frappe.has_permission("Report", "delete"): + frappe.throw(_("Insufficient Permissions for deleting Report"), frappe.PermissionError) report.delete(ignore_permissions=True) frappe.msgprint( @@ -323,12 +324,13 @@ def delete_report(name): alert=True, ) + @frappe.whitelist() @frappe.read_only() def export_query(): """export from report builder""" title = frappe.form_dict.title - frappe.form_dict.pop('title', None) + frappe.form_dict.pop("title", None) form_params = get_form_params() form_params["limit_page_length"] = None @@ -341,21 +343,23 @@ def export_query(): del form_params["doctype"] del form_params["file_format_type"] - if 'add_totals_row' in form_params and form_params['add_totals_row']=='1': + if "add_totals_row" in form_params and form_params["add_totals_row"] == "1": add_totals_row = 1 del form_params["add_totals_row"] frappe.permissions.can_export(doctype, raise_exception=True) - if 'selected_items' in form_params: - si = json.loads(frappe.form_dict.get('selected_items')) + if "selected_items" in form_params: + si = json.loads(frappe.form_dict.get("selected_items")) form_params["filters"] = {"name": ("in", si)} del form_params["selected_items"] - make_access_log(doctype=doctype, + make_access_log( + doctype=doctype, file_type=file_format_type, report_name=form_params.report_name, - filters=form_params.filters) + filters=form_params.filters, + ) db_query = DatabaseQuery(doctype) ret = db_query.execute(**form_params) @@ -363,9 +367,9 @@ def export_query(): if add_totals_row: ret = append_totals_row(ret) - data = [[_('Sr')] + get_labels(db_query.fields, doctype)] + data = [[_("Sr")] + get_labels(db_query.fields, doctype)] for i, row in enumerate(ret): - data.append([i+1] + list(row)) + data.append([i + 1] + list(row)) data = handle_duration_fieldtype_values(doctype, data, db_query.fields) @@ -373,28 +377,29 @@ def export_query(): # convert to csv import csv + from frappe.utils.xlsxutils import handle_html f = StringIO() writer = csv.writer(f) for r in data: # encode only unicode type strings and not int, floats etc. - writer.writerow([handle_html(frappe.as_unicode(v)) \ - if isinstance(v, str) else v for v in r]) + writer.writerow([handle_html(frappe.as_unicode(v)) if isinstance(v, str) else v for v in r]) f.seek(0) - frappe.response['result'] = cstr(f.read()) - frappe.response['type'] = 'csv' - frappe.response['doctype'] = title + frappe.response["result"] = cstr(f.read()) + frappe.response["type"] = "csv" + frappe.response["doctype"] = title elif file_format_type == "Excel": from frappe.utils.xlsxutils import make_xlsx + xlsx_file = make_xlsx(data, doctype) - frappe.response['filename'] = title + '.xlsx' - frappe.response['filecontent'] = xlsx_file.getvalue() - frappe.response['type'] = 'binary' + frappe.response["filename"] = title + ".xlsx" + frappe.response["filecontent"] = xlsx_file.getvalue() + frappe.response["type"] = "binary" def append_totals_row(data): @@ -402,7 +407,7 @@ def append_totals_row(data): return data data = list(data) totals = [] - totals.extend([""]*len(data[0])) + totals.extend([""] * len(data[0])) for row in data: for i in range(len(row)): @@ -410,19 +415,20 @@ def append_totals_row(data): totals[i] = (totals[i] or 0) + row[i] if not isinstance(totals[0], (int, float)): - totals[0] = 'Total' + totals[0] = "Total" data.append(totals) return data + def get_labels(fields, doctype): """get column labels based on column names""" labels = [] for key in fields: key = key.split(" as ")[0] - if key.startswith(('count(', 'sum(', 'avg(')): + if key.startswith(("count(", "sum(", "avg(")): continue if "." in key: @@ -445,11 +451,13 @@ def get_labels(fields, doctype): return labels + def handle_duration_fieldtype_values(doctype, data, fields): for field in fields: key = field.split(" as ")[0] - if key.startswith(('count(', 'sum(', 'avg(')): continue + if key.startswith(("count(", "sum(", "avg(")): + continue if "." in key: parenttype, fieldname = key.split(".")[0][4:-1], key.split(".")[1].strip("`") @@ -459,7 +467,7 @@ def handle_duration_fieldtype_values(doctype, data, fields): df = frappe.get_meta(parenttype).get_field(fieldname) - if df and df.fieldtype == 'Duration': + if df and df.fieldtype == "Duration": index = fields.index(field) + 1 for i in range(1, len(data)): val_in_seconds = data[i][index] @@ -468,28 +476,31 @@ def handle_duration_fieldtype_values(doctype, data, fields): data[i][index] = duration_val return data + @frappe.whitelist() def delete_items(): """delete selected items""" import json - items = sorted(json.loads(frappe.form_dict.get('items')), reverse=True) - doctype = frappe.form_dict.get('doctype') + items = sorted(json.loads(frappe.form_dict.get("items")), reverse=True) + doctype = frappe.form_dict.get("doctype") if len(items) > 10: - frappe.enqueue('frappe.desk.reportview.delete_bulk', - doctype=doctype, items=items) + frappe.enqueue("frappe.desk.reportview.delete_bulk", doctype=doctype, items=items) else: delete_bulk(doctype, items) + def delete_bulk(doctype, items): for i, d in enumerate(items): try: frappe.delete_doc(doctype, d) if len(items) >= 5: - frappe.publish_realtime("progress", - dict(progress=[i+1, len(items)], title=_('Deleting {0}').format(doctype), description=d), - user=frappe.session.user) + frappe.publish_realtime( + "progress", + dict(progress=[i + 1, len(items)], title=_("Deleting {0}").format(doctype), description=d), + user=frappe.session.user, + ) # Commit after successful deletion frappe.db.commit() except Exception: @@ -497,6 +508,7 @@ def delete_bulk(doctype, items): # if not rollbacked, queries get committed on after_request method in app.py frappe.db.rollback() + @frappe.whitelist() @frappe.read_only() def get_sidebar_stats(stats, doctype, filters=None): @@ -512,6 +524,7 @@ def get_sidebar_stats(stats, doctype, filters=None): return {"stats": data} + @frappe.whitelist() @frappe.read_only() def get_stats(stats, doctype, filters=None): @@ -536,19 +549,21 @@ def get_stats(stats, doctype, filters=None): if tag not in columns: continue try: - tag_count = frappe.get_list(doctype, + tag_count = frappe.get_list( + doctype, fields=[tag, "count(*)"], - filters=filters + [[tag, '!=', '']], + filters=filters + [[tag, "!=", ""]], group_by=tag, as_list=True, distinct=1, ) - if tag == '_user_tags': + if tag == "_user_tags": stats[tag] = scrub_user_tags(tag_count) - no_tag_count = frappe.get_list(doctype, + no_tag_count = frappe.get_list( + doctype, fields=[tag, "count(*)"], - filters=filters + [[tag, "in", ('', ',')]], + filters=filters + [[tag, "in", ("", ",")]], as_list=True, group_by=tag, order_by=tag, @@ -568,34 +583,52 @@ def get_stats(stats, doctype, filters=None): return stats + @frappe.whitelist() def get_filter_dashboard_data(stats, doctype, filters=None): """get tags info""" import json + tags = json.loads(stats) filters = json.loads(filters or []) stats = {} columns = frappe.db.get_table_columns(doctype) for tag in tags: - if not tag["name"] in columns: continue + if not tag["name"] in columns: + continue tagcount = [] - if tag["type"] not in ['Date', 'Datetime']: - tagcount = frappe.get_list(doctype, + if tag["type"] not in ["Date", "Datetime"]: + tagcount = frappe.get_list( + doctype, fields=[tag["name"], "count(*)"], - filters = filters + ["ifnull(`%s`,'')!=''" % tag["name"]], - group_by = tag["name"], - as_list = True) + filters=filters + ["ifnull(`%s`,'')!=''" % tag["name"]], + group_by=tag["name"], + as_list=True, + ) - if tag["type"] not in ['Check','Select','Date','Datetime','Int', - 'Float','Currency','Percent'] and tag['name'] not in ['docstatus']: + if tag["type"] not in [ + "Check", + "Select", + "Date", + "Datetime", + "Int", + "Float", + "Currency", + "Percent", + ] and tag["name"] not in ["docstatus"]: stats[tag["name"]] = list(tagcount) if stats[tag["name"]]: - data =["No Data", frappe.get_list(doctype, - fields=[tag["name"], "count(*)"], - filters=filters + ["({0} = '' or {0} is null)".format(tag["name"])], - as_list=True)[0][1]] - if data and data[1]!=0: + data = [ + "No Data", + frappe.get_list( + doctype, + fields=[tag["name"], "count(*)"], + filters=filters + ["({0} = '' or {0} is null)".format(tag["name"])], + as_list=True, + )[0][1], + ] + if data and data[1] != 0: stats[tag["name"]].append(data) else: @@ -603,6 +636,7 @@ def get_filter_dashboard_data(stats, doctype, filters=None): return stats + def scrub_user_tags(tagcount): """rebuild tag list for tags""" rdict = {} @@ -610,7 +644,7 @@ def scrub_user_tags(tagcount): for t in tagdict: if not t: continue - alltags = t.split(',') + alltags = t.split(",") for tag in alltags: if tag: if tag not in rdict: @@ -624,22 +658,29 @@ def scrub_user_tags(tagcount): return rlist + # used in building query in queries.py def get_match_cond(doctype, as_condition=True): cond = DatabaseQuery(doctype).build_match_conditions(as_condition=as_condition) if not as_condition: return cond - return ((' and ' + cond) if cond else "").replace("%", "%%") + return ((" and " + cond) if cond else "").replace("%", "%%") + def build_match_conditions(doctype, user=None, as_condition=True): - match_conditions = DatabaseQuery(doctype, user=user).build_match_conditions(as_condition=as_condition) + match_conditions = DatabaseQuery(doctype, user=user).build_match_conditions( + as_condition=as_condition + ) if as_condition: return match_conditions.replace("%", "%%") else: return match_conditions -def get_filters_cond(doctype, filters, conditions, ignore_permissions=None, with_match_conditions=False): + +def get_filters_cond( + doctype, filters, conditions, ignore_permissions=None, with_match_conditions=False +): if isinstance(filters, str): filters = json.loads(filters) @@ -649,14 +690,24 @@ def get_filters_cond(doctype, filters, conditions, ignore_permissions=None, with filters = filters.items() flt = [] for f in filters: - if isinstance(f[1], str) and f[1][0] == '!': - flt.append([doctype, f[0], '!=', f[1][1:]]) - elif isinstance(f[1], (list, tuple)) and \ - f[1][0] in (">", "<", ">=", "<=", "!=", "like", "not like", "in", "not in", "between"): + if isinstance(f[1], str) and f[1][0] == "!": + flt.append([doctype, f[0], "!=", f[1][1:]]) + elif isinstance(f[1], (list, tuple)) and f[1][0] in ( + ">", + "<", + ">=", + "<=", + "!=", + "like", + "not like", + "in", + "not in", + "between", + ): flt.append([doctype, f[0], f[1][0], f[1][1]]) else: - flt.append([doctype, f[0], '=', f[1]]) + flt.append([doctype, f[0], "=", f[1]]) query = DatabaseQuery(doctype) query.filters = flt @@ -667,11 +718,11 @@ def get_filters_cond(doctype, filters, conditions, ignore_permissions=None, with query.build_filter_conditions(flt, conditions, ignore_permissions) - cond = ' and ' + ' and '.join(query.conditions) + cond = " and " + " and ".join(query.conditions) else: - cond = '' + cond = "" return cond + def is_virtual_doctype(doctype): return frappe.db.get_value("DocType", doctype, "is_virtual") - diff --git a/frappe/desk/search.py b/frappe/desk/search.py index dd22f821cf..ba4c5fb4fb 100644 --- a/frappe/desk/search.py +++ b/frappe/desk/search.py @@ -1,20 +1,23 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -# Search -import frappe, json -from frappe.utils import cstr, unique, cint -from frappe.permissions import has_permission -from frappe import _, is_whitelisted +import json import re + import wrapt +# Search +import frappe +from frappe import _, is_whitelisted +from frappe.permissions import has_permission +from frappe.utils import cint, cstr, unique + def sanitize_searchfield(searchfield): - blacklisted_keywords = ['select', 'delete', 'drop', 'update', 'case', 'and', 'or', 'like'] + blacklisted_keywords = ["select", "delete", "drop", "update", "case", "and", "or", "like"] def _raise_exception(searchfield): - frappe.throw(_('Invalid Search Field {0}').format(searchfield), frappe.DataError) + frappe.throw(_("Invalid Search Field {0}").format(searchfield), frappe.DataError) if len(searchfield) == 1: # do not allow special characters to pass as searchfields @@ -25,15 +28,15 @@ def sanitize_searchfield(searchfield): if len(searchfield) >= 3: # to avoid 1=1 - if '=' in searchfield: + if "=" in searchfield: _raise_exception(searchfield) # in mysql -- is used for commenting the query - elif ' --' in searchfield: + elif " --" in searchfield: _raise_exception(searchfield) # to avoid and, or and like - elif any(' {0} '.format(keyword) in searchfield.split() for keyword in blacklisted_keywords): + elif any(" {0} ".format(keyword) in searchfield.split() for keyword in blacklisted_keywords): _raise_exception(searchfield) # to avoid select, delete, drop, update and case @@ -45,19 +48,49 @@ def sanitize_searchfield(searchfield): if any(regex.match(f) for f in searchfield.split()): _raise_exception(searchfield) + # this is called by the Link Field @frappe.whitelist() -def search_link(doctype, txt, query=None, filters=None, page_length=20, searchfield=None, reference_doctype=None, ignore_user_permissions=False): - search_widget(doctype, txt.strip(), query, searchfield=searchfield, page_length=page_length, filters=filters, - reference_doctype=reference_doctype, ignore_user_permissions=ignore_user_permissions) +def search_link( + doctype, + txt, + query=None, + filters=None, + page_length=20, + searchfield=None, + reference_doctype=None, + ignore_user_permissions=False, +): + search_widget( + doctype, + txt.strip(), + query, + searchfield=searchfield, + page_length=page_length, + filters=filters, + reference_doctype=reference_doctype, + ignore_user_permissions=ignore_user_permissions, + ) frappe.response["results"] = build_for_autosuggest(frappe.response["values"], doctype=doctype) del frappe.response["values"] + # this is called by the search box @frappe.whitelist() -def search_widget(doctype, txt, query=None, searchfield=None, start=0, - page_length=20, filters=None, filter_fields=None, as_dict=False, reference_doctype=None, ignore_user_permissions=False): +def search_widget( + doctype, + txt, + query=None, + searchfield=None, + start=0, + page_length=20, + filters=None, + filter_fields=None, + as_dict=False, + reference_doctype=None, + ignore_user_permissions=False, +): start = cint(start) @@ -72,25 +105,28 @@ def search_widget(doctype, txt, query=None, searchfield=None, start=0, standard_queries = frappe.get_hooks().standard_queries or {} - if query and query.split()[0].lower()!="select": + if query and query.split()[0].lower() != "select": # by method try: is_whitelisted(frappe.get_attr(query)) - frappe.response["values"] = frappe.call(query, doctype, txt, - searchfield, start, page_length, filters, as_dict=as_dict) + frappe.response["values"] = frappe.call( + query, doctype, txt, searchfield, start, page_length, filters, as_dict=as_dict + ) except frappe.exceptions.PermissionError as e: if frappe.local.conf.developer_mode: raise e else: - frappe.respond_as_web_page(title='Invalid Method', html='Method not found', - indicator_color='red', http_status_code=404) + frappe.respond_as_web_page( + title="Invalid Method", html="Method not found", indicator_color="red", http_status_code=404 + ) return except Exception as e: raise e elif not query and doctype in standard_queries: # from standard queries - search_widget(doctype, txt, standard_queries[doctype][0], - searchfield, start, page_length, filters) + search_widget( + doctype, txt, standard_queries[doctype][0], searchfield, start, page_length, filters + ) else: meta = frappe.get_meta(doctype) @@ -112,7 +148,6 @@ def search_widget(doctype, txt, query=None, searchfield=None, start=0, filters = [] or_filters = [] - translated_search_doctypes = frappe.get_hooks("translated_search_doctypes") # build from doctype if txt: @@ -125,20 +160,26 @@ def search_widget(doctype, txt, query=None, searchfield=None, start=0, for f in search_fields: fmeta = meta.get_field(f.strip()) - if (doctype not in translated_search_doctypes) and (f == "name" or (fmeta and fmeta.fieldtype in ["Data", "Text", "Small Text", "Long Text", - "Link", "Select", "Read Only", "Text Editor"])): - or_filters.append([doctype, f.strip(), "like", "%{0}%".format(txt)]) - - if meta.get("fields", {"fieldname":"enabled", "fieldtype":"Check"}): + if (doctype not in translated_search_doctypes) and ( + f == "name" + or ( + fmeta + and fmeta.fieldtype + in ["Data", "Text", "Small Text", "Long Text", "Link", "Select", "Read Only", "Text Editor"] + ) + ): + or_filters.append([doctype, f.strip(), "like", "%{0}%".format(txt)]) + + if meta.get("fields", {"fieldname": "enabled", "fieldtype": "Check"}): filters.append([doctype, "enabled", "=", 1]) - if meta.get("fields", {"fieldname":"disabled", "fieldtype":"Check"}): + if meta.get("fields", {"fieldname": "disabled", "fieldtype": "Check"}): filters.append([doctype, "disabled", "!=", 1]) # format a list of fields combining search fields and filter fields fields = get_std_fields_list(meta, searchfield or "name") if filter_fields: fields = list(set(fields + json.loads(filter_fields))) - formatted_fields = ['`tab%s`.`%s`' % (meta.name, f.strip()) for f in fields] + formatted_fields = ["`tab%s`.`%s`" % (meta.name, f.strip()) for f in fields] title_field_query = get_title_field_query(meta) @@ -147,23 +188,31 @@ def search_widget(doctype, txt, query=None, searchfield=None, start=0, formatted_fields.insert(1, title_field_query) # find relevance as location of search term from the beginning of string `name`. used for sorting results. - formatted_fields.append("""locate({_txt}, `tab{doctype}`.`name`) as `_relevance`""".format( - _txt=frappe.db.escape((txt or "").replace("%", "").replace("@", "")), doctype=doctype)) - + formatted_fields.append( + """locate({_txt}, `tab{doctype}`.`name`) as `_relevance`""".format( + _txt=frappe.db.escape((txt or "").replace("%", "").replace("@", "")), doctype=doctype + ) + ) # In order_by, `idx` gets second priority, because it stores link count from frappe.model.db_query import get_order_by + order_by_based_on_meta = get_order_by(doctype, meta) # 2 is the index of _relevance column order_by = "_relevance, {0}, `tab{1}`.idx desc".format(order_by_based_on_meta, doctype) - ptype = 'select' if frappe.only_has_select_perm(doctype) else 'read' - ignore_permissions = True if doctype == "DocType" else (cint(ignore_user_permissions) and has_permission(doctype, ptype=ptype)) + ptype = "select" if frappe.only_has_select_perm(doctype) else "read" + ignore_permissions = ( + True + if doctype == "DocType" + else (cint(ignore_user_permissions) and has_permission(doctype, ptype=ptype)) + ) if doctype in translated_search_doctypes: page_length = None - values = frappe.get_list(doctype, + values = frappe.get_list( + doctype, filters=filters, fields=formatted_fields, or_filters=or_filters, @@ -173,15 +222,15 @@ def search_widget(doctype, txt, query=None, searchfield=None, start=0, ignore_permissions=ignore_permissions, reference_doctype=reference_doctype, as_list=not as_dict, - strict=False) + strict=False, + ) if doctype in translated_search_doctypes: # Filtering the values array so that query is included in very element values = ( - v for v in values - if re.search( - f"{re.escape(txt)}.*", _(v.name if as_dict else v[0]), re.IGNORECASE - ) + v + for v in values + if re.search(f"{re.escape(txt)}.*", _(v.name if as_dict else v[0]), re.IGNORECASE) ) # Sorting the values array so that relevant results always come first @@ -197,6 +246,7 @@ def search_widget(doctype, txt, query=None, searchfield=None, start=0, else: frappe.response["values"] = [r[:-1] for r in values] + def get_std_fields_list(meta, key): # get additional search fields sflist = ["name"] @@ -213,9 +263,12 @@ def get_std_fields_list(meta, key): return sflist + def get_title_field_query(meta): title_field = meta.title_field if meta.title_field else None - show_title_field_in_link = meta.show_title_field_in_link if meta.show_title_field_in_link else None + show_title_field_in_link = ( + meta.show_title_field_in_link if meta.show_title_field_in_link else None + ) field = None if title_field and show_title_field_in_link: @@ -223,52 +276,52 @@ def get_title_field_query(meta): return field + def build_for_autosuggest(res, doctype): results = [] meta = frappe.get_meta(doctype) if not (meta.title_field and meta.show_title_field_in_link): for r in res: r = list(r) - results.append({ - "value": r[0], - "description": ", ".join(unique(cstr(d) for d in r[1:] if d)) - }) + results.append({"value": r[0], "description": ", ".join(unique(cstr(d) for d in r[1:] if d))}) else: title_field_exists = meta.title_field and meta.show_title_field_in_link - _from = 2 if title_field_exists else 1 # to exclude title from description if title_field_exists + _from = 2 if title_field_exists else 1 # to exclude title from description if title_field_exists for r in res: r = list(r) - results.append({ - "value": r[0], - "label": r[1] if title_field_exists else None, - "description": ", ".join(unique(cstr(d) for d in r[_from:] if d)) - }) + results.append( + { + "value": r[0], + "label": r[1] if title_field_exists else None, + "description": ", ".join(unique(cstr(d) for d in r[_from:] if d)), + } + ) return results + def scrub_custom_query(query, key, txt): - if '%(key)s' in query: - query = query.replace('%(key)s', key) - if '%s' in query: - query = query.replace('%s', ((txt or '') + '%')) + if "%(key)s" in query: + query = query.replace("%(key)s", key) + if "%s" in query: + query = query.replace("%s", ((txt or "") + "%")) return query + def relevance_sorter(key, query, as_dict): value = _(key.name if as_dict else key[0]) - return ( - cstr(value).lower().startswith(query.lower()) is not True, - value - ) + return (cstr(value).lower().startswith(query.lower()) is not True, value) + @wrapt.decorator def validate_and_sanitize_search_inputs(fn, instance, args, kwargs): kwargs.update(dict(zip(fn.__code__.co_varnames, args))) - sanitize_searchfield(kwargs['searchfield']) - kwargs['start'] = cint(kwargs['start']) - kwargs['page_len'] = cint(kwargs['page_len']) + sanitize_searchfield(kwargs["searchfield"]) + kwargs["start"] = cint(kwargs["start"]) + kwargs["page_len"] = cint(kwargs["page_len"]) - if kwargs['doctype'] and not frappe.db.exists('DocType', kwargs['doctype']): + if kwargs["doctype"] and not frappe.db.exists("DocType", kwargs["doctype"]): return [] return fn(**kwargs) @@ -276,37 +329,41 @@ def validate_and_sanitize_search_inputs(fn, instance, args, kwargs): @frappe.whitelist() def get_names_for_mentions(search_term): - users_for_mentions = frappe.cache().get_value('users_for_mentions', get_users_for_mentions) - user_groups = frappe.cache().get_value('user_groups', get_user_groups) + users_for_mentions = frappe.cache().get_value("users_for_mentions", get_users_for_mentions) + user_groups = frappe.cache().get_value("user_groups", get_user_groups) filtered_mentions = [] for mention_data in users_for_mentions + user_groups: if search_term.lower() not in mention_data.value.lower(): continue - mention_data['link'] = frappe.utils.get_url_to_form( - 'User Group' if mention_data.get('is_group') else 'User Profile', - mention_data['id'] + mention_data["link"] = frappe.utils.get_url_to_form( + "User Group" if mention_data.get("is_group") else "User Profile", mention_data["id"] ) filtered_mentions.append(mention_data) - return sorted(filtered_mentions, key=lambda d: d['value']) + return sorted(filtered_mentions, key=lambda d: d["value"]) + def get_users_for_mentions(): - return frappe.get_all('User', - fields=['name as id', 'full_name as value'], + return frappe.get_all( + "User", + fields=["name as id", "full_name as value"], filters={ - 'name': ['not in', ('Administrator', 'Guest')], - 'allowed_in_mentions': True, - 'user_type': 'System User', - 'enabled': True, - }) + "name": ["not in", ("Administrator", "Guest")], + "allowed_in_mentions": True, + "user_type": "System User", + "enabled": True, + }, + ) + def get_user_groups(): - return frappe.get_all('User Group', fields=['name as id', 'name as value'], update={ - 'is_group': True - }) + return frappe.get_all( + "User Group", fields=["name as id", "name as value"], update={"is_group": True} + ) + @frappe.whitelist() def get_link_title(doctype, docname): @@ -315,4 +372,4 @@ def get_link_title(doctype, docname): if meta.title_field and meta.show_title_field_in_link: return frappe.db.get_value(doctype, docname, meta.title_field) - return docname \ No newline at end of file + return docname diff --git a/frappe/desk/treeview.py b/frappe/desk/treeview.py index 5e8fb18fe4..d7a8db8792 100644 --- a/frappe/desk/treeview.py +++ b/frappe/desk/treeview.py @@ -7,11 +7,11 @@ from frappe import _ @frappe.whitelist() def get_all_nodes(doctype, label, parent, tree_method, **filters): - '''Recursively gets all data from tree nodes''' + """Recursively gets all data from tree nodes""" - if 'cmd' in filters: - del filters['cmd'] - filters.pop('data', None) + if "cmd" in filters: + del filters["cmd"] + filters.pop("data", None) tree_method = frappe.get_attr(tree_method) @@ -21,43 +21,45 @@ def get_all_nodes(doctype, label, parent, tree_method, **filters): data = tree_method(doctype, parent, **filters) out = [dict(parent=label, data=data)] - if 'is_root' in filters: - del filters['is_root'] - to_check = [d.get('value') for d in data if d.get('expandable')] + if "is_root" in filters: + del filters["is_root"] + to_check = [d.get("value") for d in data if d.get("expandable")] while to_check: parent = to_check.pop() data = tree_method(doctype, parent, is_root=False, **filters) out.append(dict(parent=parent, data=data)) for d in data: - if d.get('expandable'): - to_check.append(d.get('value')) + if d.get("expandable"): + to_check.append(d.get("value")) return out + @frappe.whitelist() -def get_children(doctype, parent='', **filters): +def get_children(doctype, parent="", **filters): return _get_children(doctype, parent) -def _get_children(doctype, parent='', ignore_permissions=False): - parent_field = 'parent_' + doctype.lower().replace(' ', '_') - filters = [["ifnull(`{0}`,'')".format(parent_field), '=', parent], - ['docstatus', '<' ,2]] + +def _get_children(doctype, parent="", ignore_permissions=False): + parent_field = "parent_" + doctype.lower().replace(" ", "_") + filters = [["ifnull(`{0}`,'')".format(parent_field), "=", parent], ["docstatus", "<", 2]] meta = frappe.get_meta(doctype) return frappe.get_list( doctype, fields=[ - 'name as value', - '{0} as title'.format(meta.get('title_field') or 'name'), - 'is_group as expandable' + "name as value", + "{0} as title".format(meta.get("title_field") or "name"), + "is_group as expandable", ], filters=filters, - order_by='name', - ignore_permissions=ignore_permissions + order_by="name", + ignore_permissions=ignore_permissions, ) + @frappe.whitelist() def add_node(): args = make_tree_args(**frappe.form_dict) @@ -65,17 +67,18 @@ def add_node(): doc.save() + def make_tree_args(**kwarg): - kwarg.pop('cmd', None) + kwarg.pop("cmd", None) - doctype = kwarg['doctype'] - parent_field = 'parent_' + doctype.lower().replace(' ', '_') + doctype = kwarg["doctype"] + parent_field = "parent_" + doctype.lower().replace(" ", "_") - if kwarg['is_root'] == 'false': kwarg['is_root'] = False - if kwarg['is_root'] == 'true': kwarg['is_root'] = True + if kwarg["is_root"] == "false": + kwarg["is_root"] = False + if kwarg["is_root"] == "true": + kwarg["is_root"] = True - kwarg.update({ - parent_field: kwarg.get("parent") or kwarg.get(parent_field) - }) + kwarg.update({parent_field: kwarg.get("parent") or kwarg.get(parent_field)}) return frappe._dict(kwarg) diff --git a/frappe/desk/utils.py b/frappe/desk/utils.py index 3328d47318..72cba79963 100644 --- a/frappe/desk/utils.py +++ b/frappe/desk/utils.py @@ -3,21 +3,27 @@ import frappe + def validate_route_conflict(doctype, name): - ''' + """ Raises exception if name clashes with routes from other documents for /app routing - ''' + """ all_names = [] - for _doctype in ['Page', 'Workspace', 'DocType']: + for _doctype in ["Page", "Workspace", "DocType"]: try: - all_names.extend([slug(d) for d in frappe.get_all(_doctype, pluck='name') if (doctype != _doctype and d != name)]) + all_names.extend( + [ + slug(d) for d in frappe.get_all(_doctype, pluck="name") if (doctype != _doctype and d != name) + ] + ) except frappe.db.TableMissingError: pass if slug(name) in all_names: - frappe.msgprint(frappe._('Name already taken, please set a new name')) + frappe.msgprint(frappe._("Name already taken, please set a new name")) raise frappe.NameError + def slug(name): - return name.lower().replace(' ', '-') + return name.lower().replace(" ", "-") diff --git a/frappe/email/__init__.py b/frappe/email/__init__.py index 79dec977b7..fae60baebf 100644 --- a/frappe/email/__init__.py +++ b/frappe/email/__init__.py @@ -4,9 +4,11 @@ import frappe from frappe.desk.reportview import build_match_conditions + def sendmail_to_system_managers(subject, content): frappe.sendmail(recipients=get_system_managers(), subject=subject, content=content) + @frappe.whitelist() def get_contact_list(txt, page_length=20): """Returns contacts (from autosuggest)""" @@ -16,19 +18,19 @@ def get_contact_list(txt, page_length=20): return cached_contacts[:page_length] try: - match_conditions = build_match_conditions('Contact') + match_conditions = build_match_conditions("Contact") match_conditions = "and {0}".format(match_conditions) if match_conditions else "" - out = frappe.db.sql("""select email_id as value, + out = frappe.db.sql( + """select email_id as value, concat(first_name, ifnull(concat(' ',last_name), '' )) as description from tabContact where name like %(txt)s or email_id like %(txt)s %(condition)s - limit %(page_length)s""", { - 'txt': '%' + txt + '%', - 'condition': match_conditions, - 'page_length': page_length - }, as_dict=True) + limit %(page_length)s""", + {"txt": "%" + txt + "%", "condition": match_conditions, "page_length": page_length}, + as_dict=True, + ) out = filter(None, out) except: @@ -38,15 +40,20 @@ def get_contact_list(txt, page_length=20): return out + def get_system_managers(): - return frappe.db.sql_list("""select parent FROM `tabHas Role` + return frappe.db.sql_list( + """select parent FROM `tabHas Role` WHERE role='System Manager' AND parent!='Administrator' - AND parent IN (SELECT email FROM tabUser WHERE enabled=1)""") + AND parent IN (SELECT email FROM tabUser WHERE enabled=1)""" + ) + @frappe.whitelist() def relink(name, reference_doctype=None, reference_name=None): - frappe.db.sql("""update + frappe.db.sql( + """update `tabCommunication` set reference_doctype = %s, @@ -54,7 +61,10 @@ def relink(name, reference_doctype=None, reference_name=None): status = "Linked" where communication_type = "Communication" and - name = %s""", (reference_doctype, reference_name, name)) + name = %s""", + (reference_doctype, reference_name, name), + ) + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs @@ -63,19 +73,22 @@ def get_communication_doctype(doctype, txt, searchfield, start, page_len, filter user_perms.build_permissions() can_read = user_perms.can_read from frappe.modules import load_doctype_module + com_doctypes = [] - if len(txt)<2: + if len(txt) < 2: for name in frappe.get_hooks("communication_doctypes"): try: - module = load_doctype_module(name, suffix='_dashboard') - if hasattr(module, 'get_data'): - for i in module.get_data()['transactions']: + module = load_doctype_module(name, suffix="_dashboard") + if hasattr(module, "get_data"): + for i in module.get_data()["transactions"]: com_doctypes += i["items"] except ImportError: pass else: - com_doctypes = [d[0] for d in frappe.db.get_values("DocType", {"issingle": 0, "istable": 0, "hide_toolbar": 0})] + com_doctypes = [ + d[0] for d in frappe.db.get_values("DocType", {"issingle": 0, "istable": 0, "hide_toolbar": 0}) + ] out = [] for dt in com_doctypes: @@ -83,6 +96,7 @@ def get_communication_doctype(doctype, txt, searchfield, start, page_len, filter out.append([dt]) return out + def get_cached_contacts(txt): contacts = frappe.cache().hget("contacts", frappe.session.user) or [] @@ -92,9 +106,14 @@ def get_cached_contacts(txt): if not txt: return contacts - match = [d for d in contacts if (d.value and ((d.value and txt in d.value) or (d.description and txt in d.description)))] + match = [ + d + for d in contacts + if (d.value and ((d.value and txt in d.value) or (d.description and txt in d.description))) + ] return match + def update_contact_cache(contacts): cached_contacts = frappe.cache().hget("contacts", frappe.session.user) or [] diff --git a/frappe/email/doctype/auto_email_report/auto_email_report.py b/frappe/email/doctype/auto_email_report/auto_email_report.py index abeb681a25..f4fdcf4275 100644 --- a/frappe/email/doctype/auto_email_report/auto_email_report.py +++ b/frappe/email/doctype/auto_email_report/auto_email_report.py @@ -7,20 +7,29 @@ from datetime import timedelta import frappe from frappe import _ +from frappe.desk.query_report import build_xlsx_data from frappe.model.document import Document -from frappe.utils import (format_time, get_link_to_form, get_url_to_report, - global_date_format, now, now_datetime, validate_email_address, today, add_to_date) from frappe.model.naming import append_number_if_name_exists +from frappe.utils import ( + add_to_date, + format_time, + get_link_to_form, + get_url_to_report, + global_date_format, + now, + now_datetime, + today, + validate_email_address, +) from frappe.utils.csvutils import to_csv from frappe.utils.xlsxutils import make_xlsx -from frappe.desk.query_report import build_xlsx_data class AutoEmailReport(Document): def autoname(self): self.name = _(self.report) - if frappe.db.exists('Auto Email Report', self.name): - self.name = append_number_if_name_exists('Auto Email Report', self.name) + if frappe.db.exists("Auto Email Report", self.name): + self.name = append_number_if_name_exists("Auto Email Report", self.name) def validate(self): self.validate_report_count() @@ -29,9 +38,9 @@ class AutoEmailReport(Document): self.validate_mandatory_fields() def validate_emails(self): - '''Cleanup list of emails''' - if ',' in self.email_to: - self.email_to.replace(',', '\n') + """Cleanup list of emails""" + if "," in self.email_to: + self.email_to.replace(",", "\n") valid = [] for email in self.email_to.split(): @@ -39,22 +48,27 @@ class AutoEmailReport(Document): validate_email_address(email, True) valid.append(email) - self.email_to = '\n'.join(valid) + self.email_to = "\n".join(valid) def validate_report_count(self): - '''check that there are only 3 enabled reports per user''' - count = frappe.db.sql('select count(*) from `tabAuto Email Report` where user=%s and enabled=1', self.user)[0][0] + """check that there are only 3 enabled reports per user""" + count = frappe.db.sql( + "select count(*) from `tabAuto Email Report` where user=%s and enabled=1", self.user + )[0][0] max_reports_per_user = frappe.local.conf.max_reports_per_user or 3 if count > max_reports_per_user + (-1 if self.flags.in_insert else 0): - frappe.throw(_('Only {0} emailed reports are allowed per user').format(max_reports_per_user)) + frappe.throw(_("Only {0} emailed reports are allowed per user").format(max_reports_per_user)) def validate_report_format(self): - """ check if user has select correct report format """ + """check if user has select correct report format""" valid_report_formats = ["HTML", "XLSX", "CSV"] if self.format not in valid_report_formats: - frappe.throw(_("{0} is not a valid report format. Report format should one of the following {1}") - .format(frappe.bold(self.format), frappe.bold(", ".join(valid_report_formats)))) + frappe.throw( + _("{0} is not a valid report format. Report format should one of the following {1}").format( + frappe.bold(self.format), frappe.bold(", ".join(valid_report_formats)) + ) + ) def validate_mandatory_fields(self): # Check if all Mandatory Report Filters are filled by the User @@ -63,77 +77,87 @@ class AutoEmailReport(Document): throw_list = [] for meta in filter_meta: if meta.get("reqd") and not filters.get(meta["fieldname"]): - throw_list.append(meta['label']) + throw_list.append(meta["label"]) if throw_list: frappe.throw( - title= _('Missing Filters Required'), - msg= _('Following Report Filters have missing values:') + - '
- ' + '
- '.join(throw_list) + '
- " + + "
- ".join(throw_list) + + "
" + _("Message from server: {0}").format(cstr(e)) self.handle_incoming_connect_error(description=error_message) return None @@ -296,9 +318,11 @@ class EmailAccount(Document): @classmethod @raise_error_on_no_output( - keep_quiet = lambda: not cint(frappe.get_system_settings('setup_complete')), - error_message = OUTGOING_EMAIL_ACCOUNT_MISSING, error_type = frappe.OutgoingEmailError) # noqa - @cache_email_account('outgoing_email_account') + keep_quiet=lambda: not cint(frappe.get_system_settings("setup_complete")), + error_message=OUTGOING_EMAIL_ACCOUNT_MISSING, + error_type=frappe.OutgoingEmailError, + ) # noqa + @cache_email_account("outgoing_email_account") def find_outgoing(cls, match_by_email=None, match_by_doctype=None, _raise_error=False): """Find the outgoing Email account to use. @@ -319,12 +343,11 @@ class EmailAccount(Document): doc = cls.find_default_outgoing() if doc: - return {'default': doc} + return {"default": doc} @classmethod def find_default_outgoing(cls): - """ Find default outgoing account. - """ + """Find default outgoing account.""" doc = cls.find_one_by_filters(enable_outgoing=1, default_outgoing=1) doc = doc or cls.find_from_config() return doc or (are_emails_muted() and cls.create_dummy()) @@ -357,35 +380,42 @@ class EmailAccount(Document): return {} field_to_conf_name_map = { - 'smtp_server': {'conf_names': ('mail_server',)}, - 'smtp_port': {'conf_names': ('mail_port',)}, - 'use_tls': {'conf_names': ('use_tls', 'mail_login')}, - 'login_id': {'conf_names': ('mail_login',)}, - 'email_id': {'conf_names': ('auto_email_id', 'mail_login'), 'default': 'notifications@example.com'}, - 'password': {'conf_names': ('mail_password',)}, - 'always_use_account_email_id_as_sender': - {'conf_names': ('always_use_account_email_id_as_sender',), 'default': 0}, - 'always_use_account_name_as_sender_name': - {'conf_names': ('always_use_account_name_as_sender_name',), 'default': 0}, - 'name': {'conf_names': ('email_sender_name',), 'default': 'Frappe'}, - 'from_site_config': {'default': True} + "smtp_server": {"conf_names": ("mail_server",)}, + "smtp_port": {"conf_names": ("mail_port",)}, + "use_tls": {"conf_names": ("use_tls", "mail_login")}, + "login_id": {"conf_names": ("mail_login",)}, + "email_id": { + "conf_names": ("auto_email_id", "mail_login"), + "default": "notifications@example.com", + }, + "password": {"conf_names": ("mail_password",)}, + "always_use_account_email_id_as_sender": { + "conf_names": ("always_use_account_email_id_as_sender",), + "default": 0, + }, + "always_use_account_name_as_sender_name": { + "conf_names": ("always_use_account_name_as_sender_name",), + "default": 0, + }, + "name": {"conf_names": ("email_sender_name",), "default": "Frappe"}, + "from_site_config": {"default": True}, } account_details = {} for doc_field_name, d in field_to_conf_name_map.items(): - conf_names, default = d.get('conf_names') or [], d.get('default') + conf_names, default = d.get("conf_names") or [], d.get("default") value = [frappe.conf.get(k) for k in conf_names if frappe.conf.get(k)] account_details[doc_field_name] = (value and value[0]) or default return account_details def sendmail_config(self): return { - 'server': self.smtp_server, - 'port': cint(self.smtp_port), - 'login': getattr(self, "login_id", None) or self.email_id, - 'password': self._password, - 'use_ssl': cint(self.use_ssl_for_outgoing), - 'use_tls': cint(self.use_tls) + "server": self.smtp_server, + "port": cint(self.smtp_port), + "login": getattr(self, "login_id", None) or self.email_id, + "password": self._password, + "use_ssl": cint(self.use_ssl_for_outgoing), + "use_tls": cint(self.use_tls), } def get_smtp_server(self): @@ -399,14 +429,16 @@ class EmailAccount(Document): for user in get_system_managers(only_name=True): try: - assign_to.add({ - 'assign_to': user, - 'doctype': self.doctype, - 'name': self.name, - 'description': description, - 'priority': 'High', - 'notify': 1 - }) + assign_to.add( + { + "assign_to": user, + "doctype": self.doctype, + "name": self.name, + "description": description, + "priority": "High", + "notify": 1, + } + ) except assign_to.DuplicateToDoError: frappe.message_log.pop() pass @@ -416,10 +448,10 @@ class EmailAccount(Document): frappe.cache().set_value("workers:no-internet", True) def set_failed_attempts_count(self, value): - frappe.cache().set('{0}:email-account-failed-attempts'.format(self.name), value) + frappe.cache().set("{0}:email-account-failed-attempts".format(self.name), value) def get_failed_attempts_count(self): - return cint(frappe.cache().get('{0}:email-account-failed-attempts'.format(self.name))) + return cint(frappe.cache().get("{0}:email-account-failed-attempts".format(self.name))) def receive(self): """Called by scheduler to receive emails from this EMail account using POP3/IMAP.""" @@ -448,26 +480,24 @@ class EmailAccount(Document): else: frappe.db.commit() - #notify if user is linked to account - if len(inbound_mails)>0 and not frappe.local.flags.in_test: - frappe.publish_realtime('new_email', - {"account":self.email_account_name, "number":len(inbound_mails)} + # notify if user is linked to account + if len(inbound_mails) > 0 and not frappe.local.flags.in_test: + frappe.publish_realtime( + "new_email", {"account": self.email_account_name, "number": len(inbound_mails)} ) if exceptions: raise Exception(frappe.as_json(exceptions)) def get_inbound_mails(self) -> List[InboundMail]: - """retrive and return inbound mails. - - """ + """retrive and return inbound mails.""" mails = [] def process_mail(messages, append_to=None): for index, message in enumerate(messages.get("latest_messages", [])): - uid = messages['uid_list'][index] if messages.get('uid_list') else None - seen_status = messages.get('seen_status', {}).get(uid) - if self.email_sync_option != 'UNSEEN' or seen_status != "SEEN": + uid = messages["uid_list"][index] if messages.get("uid_list") else None + seen_status = messages.get("seen_status", {}).get(uid) + if self.email_sync_option != "UNSEEN" or seen_status != "SEEN": # only append the emails with status != 'SEEN' if sync option is set to 'UNSEEN' mails.append(InboundMail(message, self, uid, seen_status, append_to)) @@ -481,7 +511,7 @@ class EmailAccount(Document): # process all given imap folder for folder in self.imap_folder: if email_server.select_imap_folder(folder.folder_name): - email_server.settings['uid_validity'] = folder.uidvalidity + email_server.settings["uid_validity"] = folder.uidvalidity messages = email_server.get_messages(folder=f'"{folder.folder_name}"') or {} process_mail(messages, folder.append_to) else: @@ -498,45 +528,51 @@ class EmailAccount(Document): def handle_bad_emails(self, uid, raw, reason): if cint(self.use_imap): import email + try: if isinstance(raw, bytes): mail = email.message_from_bytes(raw) else: mail = email.message_from_string(raw) - message_id = mail.get('Message-ID') + message_id = mail.get("Message-ID") except Exception: message_id = "can't be parsed" - unhandled_email = frappe.get_doc({ - "raw": raw, - "uid": uid, - "reason":reason, - "message_id": message_id, - "doctype": "Unhandled Email", - "email_account": self.name - }) + unhandled_email = frappe.get_doc( + { + "raw": raw, + "uid": uid, + "reason": reason, + "message_id": message_id, + "doctype": "Unhandled Email", + "email_account": self.name, + } + ) unhandled_email.insert(ignore_permissions=True) frappe.db.commit() def send_auto_reply(self, communication, email): """Send auto reply if set.""" from frappe.core.doctype.communication.email import set_incoming_outgoing_accounts + if self.enable_auto_reply: set_incoming_outgoing_accounts(communication) unsubscribe_message = (self.send_unsubscribe_message and _("Leave this conversation")) or "" - frappe.sendmail(recipients = [email.from_email], - sender = self.email_id, - reply_to = communication.incoming_email_account, - subject = " ".join([_("Re:"), communication.subject]), - content = render_template(self.auto_reply_message or "", communication.as_dict()) or \ - frappe.get_template("templates/emails/auto_reply.html").render(communication.as_dict()), - reference_doctype = communication.reference_doctype, - reference_name = communication.reference_name, - in_reply_to = email.mail.get("Message-Id"), # send back the Message-Id as In-Reply-To - unsubscribe_message = unsubscribe_message) + frappe.sendmail( + recipients=[email.from_email], + sender=self.email_id, + reply_to=communication.incoming_email_account, + subject=" ".join([_("Re:"), communication.subject]), + content=render_template(self.auto_reply_message or "", communication.as_dict()) + or frappe.get_template("templates/emails/auto_reply.html").render(communication.as_dict()), + reference_doctype=communication.reference_doctype, + reference_name=communication.reference_name, + in_reply_to=email.mail.get("Message-Id"), # send back the Message-Id as In-Reply-To + unsubscribe_message=unsubscribe_message, + ) def get_unreplied_notification_emails(self): """Return list of emails listed""" @@ -547,9 +583,9 @@ class EmailAccount(Document): def on_trash(self): """Clear communications where email account is linked""" Communication = frappe.qb.DocType("Communication") - frappe.qb.update(Communication) \ - .set(Communication.email_account, "") \ - .where(Communication.email_account == self.name).run() + frappe.qb.update(Communication).set(Communication.email_account, "").where( + Communication.email_account == self.name + ).run() remove_user_email_inbox(email_account=self.name) @@ -568,7 +604,7 @@ class EmailAccount(Document): return self.email_sync_option or "UNSEEN" def mark_emails_as_read_unread(self, email_server=None, folder_name="INBOX"): - """ mark Email Flag Queue of self.email_account mails as read""" + """mark Email Flag Queue of self.email_account mails as read""" if not self.use_imap: return @@ -580,7 +616,7 @@ class EmailAccount(Document): .where(EmailFlagQ.email_account == frappe.db.escape(self.name)) ).run(as_dict=True) - uid_list = { flag.get("uid", None): flag.get("action", "Read") for flag in flags } + uid_list = {flag.get("uid", None): flag.get("action", "Read") for flag in flags} if flags and uid_list: if not email_server: email_server = self.get_incoming_server() @@ -589,37 +625,41 @@ class EmailAccount(Document): email_server.update_flag(folder_name, uid_list=uid_list) # mark communication as read - docnames = ",".join("'%s'"%flag.get("communication") for flag in flags \ - if flag.get("action") == "Read") + docnames = ",".join( + "'%s'" % flag.get("communication") for flag in flags if flag.get("action") == "Read" + ) self.set_communication_seen_status(docnames, seen=1) # mark communication as unread - docnames = ",".join([ "'%s'"%flag.get("communication") for flag in flags \ - if flag.get("action") == "Unread" ]) + docnames = ",".join( + ["'%s'" % flag.get("communication") for flag in flags if flag.get("action") == "Unread"] + ) self.set_communication_seen_status(docnames, seen=0) - docnames = ",".join([ "'%s'"%flag.get("name") for flag in flags ]) + docnames = ",".join(["'%s'" % flag.get("name") for flag in flags]) EmailFlagQueue = frappe.qb.DocType("Email Flag Queue") - frappe.qb.update(EmailFlagQueue) \ - .set(EmailFlagQueue.is_completed, 1) \ - .where(EmailFlagQueue.name.isin(docnames)).run() + frappe.qb.update(EmailFlagQueue).set(EmailFlagQueue.is_completed, 1).where( + EmailFlagQueue.name.isin(docnames) + ).run() def set_communication_seen_status(self, docnames, seen=0): - """ mark Email Flag Queue of self.email_account mails as read""" + """mark Email Flag Queue of self.email_account mails as read""" if not docnames: return Communication = frappe.qb.from_("Communication") - frappe.qb.update(Communication) \ - .set(Communication.seen == seen) \ - .where(Communication.name.isin(docnames)).run() + frappe.qb.update(Communication).set(Communication.seen == seen).where( + Communication.name.isin(docnames) + ).run() def check_automatic_linking_email_account(self): if self.enable_automatic_linking: if not self.enable_incoming: frappe.throw(_("Automatic Linking can be activated only if Incoming is enabled.")) - if frappe.db.exists("Email Account", {"enable_automatic_linking": 1, "name": ('!=', self.name)}): + if frappe.db.exists( + "Email Account", {"enable_automatic_linking": 1, "name": ("!=", self.name)} + ): frappe.throw(_("Automatic Linking can be activated only for one Email Account.")) def append_email_to_sent_folder(self, message): @@ -643,7 +683,9 @@ class EmailAccount(Document): @frappe.whitelist() -def get_append_to(doctype=None, txt=None, searchfield=None, start=None, page_len=None, filters=None): +def get_append_to( + doctype=None, txt=None, searchfield=None, start=None, page_len=None, filters=None +): txt = txt if txt else "" email_append_to_list = [] @@ -653,13 +695,16 @@ def get_append_to(doctype=None, txt=None, searchfield=None, start=None, page_len email_append_to_list.append(dt.name) # Set Email Append To DocTypes set via Customize Form - for dt in frappe.get_list("Property Setter", filters={"property": "email_append_to", "value": 1}, fields=["doc_type"]): + for dt in frappe.get_list( + "Property Setter", filters={"property": "email_append_to", "value": 1}, fields=["doc_type"] + ): email_append_to_list.append(dt.doc_type) email_append_to = [[d] for d in set(email_append_to_list) if txt in d] return email_append_to + def test_internet(host="8.8.8.8", port=53, timeout=3): """Returns True if internet is connected @@ -675,10 +720,13 @@ def test_internet(host="8.8.8.8", port=53, timeout=3): print(ex.message) return False + def notify_unreplied(): """Sends email notifications if there are unreplied Communications - and `notify_if_unreplied` is set as true.""" - for email_account in frappe.get_all("Email Account", "name", filters={"enable_incoming": 1, "notify_if_unreplied": 1}): + and `notify_if_unreplied` is set as true.""" + for email_account in frappe.get_all( + "Email Account", "name", filters={"enable_incoming": 1, "notify_if_unreplied": 1} + ): email_account = frappe.get_doc("Email Account", email_account.name) if email_account.use_imap: @@ -688,25 +736,44 @@ def notify_unreplied(): if append_to: # get open communications younger than x mins, for given doctype - for comm in frappe.get_all("Communication", "name", filters=[ + for comm in frappe.get_all( + "Communication", + "name", + filters=[ {"sent_or_received": "Received"}, {"reference_doctype": ("in", append_to)}, {"unread_notification_sent": 0}, - {"email_account":email_account.name}, - {"creation": ("<", datetime.now() - timedelta(seconds = (email_account.unreplied_for_mins or 30) * 60))}, - {"creation": (">", datetime.now() - timedelta(seconds = (email_account.unreplied_for_mins or 30) * 60 * 3))} - ]): + {"email_account": email_account.name}, + { + "creation": ( + "<", + datetime.now() - timedelta(seconds=(email_account.unreplied_for_mins or 30) * 60), + ) + }, + { + "creation": ( + ">", + datetime.now() - timedelta(seconds=(email_account.unreplied_for_mins or 30) * 60 * 3), + ) + }, + ], + ): comm = frappe.get_doc("Communication", comm.name) - if frappe.db.get_value(comm.reference_doctype, comm.reference_name, "status")=="Open": + if frappe.db.get_value(comm.reference_doctype, comm.reference_name, "status") == "Open": # if status is still open - frappe.sendmail(recipients=email_account.get_unreplied_notification_emails(), - content=comm.content, subject=comm.subject, doctype= comm.reference_doctype, - name=comm.reference_name) + frappe.sendmail( + recipients=email_account.get_unreplied_notification_emails(), + content=comm.content, + subject=comm.subject, + doctype=comm.reference_doctype, + name=comm.reference_name, + ) # update flag comm.db_set("unread_notification_sent", 1) + def pull(now=False): """Will be called via scheduler, pull emails from all enabled Email accounts.""" if frappe.cache().get_value("workers:no-internet") == True: @@ -714,34 +781,46 @@ def pull(now=False): frappe.cache().set_value("workers:no-internet", False) else: return - queued_jobs = get_jobs(site=frappe.local.site, key='job_name')[frappe.local.site] - for email_account in frappe.get_list("Email Account", - filters={"enable_incoming": 1, "awaiting_password": 0}): + queued_jobs = get_jobs(site=frappe.local.site, key="job_name")[frappe.local.site] + for email_account in frappe.get_list( + "Email Account", filters={"enable_incoming": 1, "awaiting_password": 0} + ): if now: pull_from_email_account(email_account.name) else: # job_name is used to prevent duplicates in queue - job_name = 'pull_from_email_account|{0}'.format(email_account.name) + job_name = "pull_from_email_account|{0}".format(email_account.name) if job_name not in queued_jobs: - enqueue(pull_from_email_account, 'short', event='all', job_name=job_name, - email_account=email_account.name) + enqueue( + pull_from_email_account, + "short", + event="all", + job_name=job_name, + email_account=email_account.name, + ) + def pull_from_email_account(email_account): - '''Runs within a worker process''' + """Runs within a worker process""" email_account = frappe.get_doc("Email Account", email_account) email_account.receive() + def get_max_email_uid(email_account): # get maximum uid of emails max_uid = 1 - result = frappe.db.get_all("Communication", filters={ - "communication_medium": "Email", - "sent_or_received": "Received", - "email_account": email_account - }, fields=["max(uid) as uid"]) + result = frappe.db.get_all( + "Communication", + filters={ + "communication_medium": "Email", + "sent_or_received": "Received", + "email_account": email_account, + }, + fields=["max(uid) as uid"], + ) if not result: return 1 @@ -751,7 +830,7 @@ def get_max_email_uid(email_account): def setup_user_email_inbox(email_account, awaiting_password, email_id, enable_outgoing): - """ setup email inbox for user """ + """setup email inbox for user""" from frappe.core.doctype.user.user import ask_pass_update def add_user_email(user): @@ -777,10 +856,12 @@ def setup_user_email_inbox(email_account, awaiting_password, email_id, enable_ou user_name = user.get("name") # check if inbox is alreay configured - user_inbox = frappe.db.get_value("User Email", { - "email_account": email_account, - "parent": user_name - }, ["name"]) or None + user_inbox = ( + frappe.db.get_value( + "User Email", {"email_account": email_account, "parent": user_name}, ["name"] + ) + or None + ) if not user_inbox: add_user_email(user_name) @@ -790,24 +871,24 @@ def setup_user_email_inbox(email_account, awaiting_password, email_id, enable_ou if update_user_email_settings: UserEmail = frappe.qb.DocType("User Email") - frappe.qb.update(UserEmail) \ - .set(UserEmail.awaiting_password, (awaiting_password or 0)) \ - .set(UserEmail.enable_outgoing, enable_outgoing) \ - .where(UserEmail.email_account == email_account).run() + frappe.qb.update(UserEmail).set(UserEmail.awaiting_password, (awaiting_password or 0)).set( + UserEmail.enable_outgoing, enable_outgoing + ).where(UserEmail.email_account == email_account).run() else: users = " and ".join([frappe.bold(user.get("name")) for user in user_names]) frappe.msgprint(_("Enabled email inbox for user {0}").format(users)) ask_pass_update() + def remove_user_email_inbox(email_account): - """ remove user email inbox settings if email account is deleted """ + """remove user email inbox settings if email account is deleted""" if not email_account: return - users = frappe.get_all("User Email", filters={ - "email_account": email_account - }, fields=["parent as name"]) + users = frappe.get_all( + "User Email", filters={"email_account": email_account}, fields=["parent as name"] + ) for user in users: doc = frappe.get_doc("User", user.get("name")) @@ -816,6 +897,7 @@ def remove_user_email_inbox(email_account): doc.save(ignore_permissions=True) + @frappe.whitelist(allow_guest=False) def set_email_password(email_account, user, password): account = frappe.get_doc("Email Account", email_account) diff --git a/frappe/email/doctype/email_account/test_email_account.py b/frappe/email/doctype/email_account/test_email_account.py index f609c2947d..a027a81bd7 100644 --- a/frappe/email/doctype/email_account/test_email_account.py +++ b/frappe/email/doctype/email_account/test_email_account.py @@ -1,24 +1,24 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import os import email +import os import unittest from datetime import datetime, timedelta +from unittest.mock import patch -from frappe.email.receive import InboundMail, SentEmailInInboxError, Email -from frappe.email.email_body import get_message_id import frappe -from frappe.test_runner import make_test_records from frappe.core.doctype.communication.email import make from frappe.desk.form.load import get_attachments from frappe.email.doctype.email_account.email_account import notify_unreplied - -from unittest.mock import patch +from frappe.email.email_body import get_message_id +from frappe.email.receive import Email, InboundMail, SentEmailInInboxError +from frappe.test_runner import make_test_records make_test_records("User") make_test_records("Email Account") + class TestEmailAccount(unittest.TestCase): @classmethod def setUpClass(cls): @@ -48,13 +48,9 @@ class TestEmailAccount(unittest.TestCase): messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - self.get_test_mail('incoming-1.raw') - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] + "latest_messages": [self.get_test_mail("incoming-1.raw")], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], } } @@ -70,29 +66,33 @@ class TestEmailAccount(unittest.TestCase): self.test_incoming() comm = frappe.get_doc("Communication", {"sender": "test_sender@example.com"}) - comm.db_set("creation", datetime.now() - timedelta(seconds = 30 * 60)) + comm.db_set("creation", datetime.now() - timedelta(seconds=30 * 60)) frappe.db.delete("Email Queue") notify_unreplied() - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": comm.reference_doctype, - "reference_name": comm.reference_name, "status":"Not Sent"})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + { + "reference_doctype": comm.reference_doctype, + "reference_name": comm.reference_name, + "status": "Not Sent", + }, + ) + ) def test_incoming_with_attach(self): cleanup("test_sender@example.com") - existing_file = frappe.get_doc({'doctype': 'File', 'file_name': 'erpnext-conf-14.png'}) + existing_file = frappe.get_doc({"doctype": "File", "file_name": "erpnext-conf-14.png"}) frappe.delete_doc("File", existing_file.name) messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - self.get_test_mail('incoming-2.raw') - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] + "latest_messages": [self.get_test_mail("incoming-2.raw")], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], } } @@ -107,23 +107,18 @@ class TestEmailAccount(unittest.TestCase): self.assertTrue("erpnext-conf-14.png" in [f.file_name for f in attachments]) # cleanup - existing_file = frappe.get_doc({'doctype': 'File', 'file_name': 'erpnext-conf-14.png'}) + existing_file = frappe.get_doc({"doctype": "File", "file_name": "erpnext-conf-14.png"}) frappe.delete_doc("File", existing_file.name) - def test_incoming_attached_email_from_outlook_plain_text_only(self): cleanup("test_sender@example.com") messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - self.get_test_mail('incoming-3.raw') - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] + "latest_messages": [self.get_test_mail("incoming-3.raw")], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], } } @@ -131,8 +126,12 @@ class TestEmailAccount(unittest.TestCase): TestEmailAccount.mocked_email_receive(email_account, messages) comm = frappe.get_doc("Communication", {"sender": "test_sender@example.com"}) - self.assertTrue("From: "Microsoft Outlook" <test_sender@example.com>" in comm.content) - self.assertTrue("This is an e-mail message sent automatically by Microsoft Outlook while" in comm.content) + self.assertTrue( + "From: "Microsoft Outlook" <test_sender@example.com>" in comm.content + ) + self.assertTrue( + "This is an e-mail message sent automatically by Microsoft Outlook while" in comm.content + ) def test_incoming_attached_email_from_outlook_layers(self): cleanup("test_sender@example.com") @@ -140,13 +139,9 @@ class TestEmailAccount(unittest.TestCase): messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - self.get_test_mail('incoming-4.raw') - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] + "latest_messages": [self.get_test_mail("incoming-4.raw")], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], } } @@ -154,38 +149,65 @@ class TestEmailAccount(unittest.TestCase): TestEmailAccount.mocked_email_receive(email_account, messages) comm = frappe.get_doc("Communication", {"sender": "test_sender@example.com"}) - self.assertTrue("From: "Microsoft Outlook" <test_sender@example.com>" in comm.content) - self.assertTrue("This is an e-mail message sent automatically by Microsoft Outlook while" in comm.content) + self.assertTrue( + "From: "Microsoft Outlook" <test_sender@example.com>" in comm.content + ) + self.assertTrue( + "This is an e-mail message sent automatically by Microsoft Outlook while" in comm.content + ) def test_outgoing(self): - make(subject = "test-mail-000", content="test mail 000", recipients="test_receiver@example.com", - send_email=True, sender="test_sender@example.com") + make( + subject="test-mail-000", + content="test mail 000", + recipients="test_receiver@example.com", + send_email=True, + sender="test_sender@example.com", + ) mail = email.message_from_string(frappe.get_last_doc("Email Queue").message) self.assertTrue("test-mail-000" in mail.get("Subject")) def test_sendmail(self): - frappe.sendmail(sender="test_sender@example.com", recipients="test_recipient@example.com", - content="test mail 001", subject="test-mail-001", delayed=False) + frappe.sendmail( + sender="test_sender@example.com", + recipients="test_recipient@example.com", + content="test mail 001", + subject="test-mail-001", + delayed=False, + ) sent_mail = email.message_from_string(frappe.safe_decode(frappe.flags.sent_mail)) self.assertTrue("test-mail-001" in sent_mail.get("Subject")) def test_print_format(self): - make(sender="test_sender@example.com", recipients="test_recipient@example.com", - content="test mail 001", subject="test-mail-002", doctype="Email Account", - name="_Test Email Account 1", print_format="Standard", send_email=True) + make( + sender="test_sender@example.com", + recipients="test_recipient@example.com", + content="test mail 001", + subject="test-mail-002", + doctype="Email Account", + name="_Test Email Account 1", + print_format="Standard", + send_email=True, + ) sent_mail = email.message_from_string(frappe.get_last_doc("Email Queue").message) self.assertTrue("test-mail-002" in sent_mail.get("Subject")) def test_threading(self): - cleanup(["in", ['test_sender@example.com', 'test@example.com']]) + cleanup(["in", ["test_sender@example.com", "test@example.com"]]) # send - sent_name = make(subject = "Test", content="test content", - recipients="test_receiver@example.com", sender="test@example.com",doctype="ToDo",name=frappe.get_last_doc("ToDo").name, - send_email=True)["name"] + sent_name = make( + subject="Test", + content="test content", + recipients="test_receiver@example.com", + sender="test@example.com", + doctype="ToDo", + name=frappe.get_last_doc("ToDo").name, + send_email=True, + )["name"] sent_mail = email.message_from_string(frappe.get_last_doc("Email Queue").message) @@ -196,15 +218,7 @@ class TestEmailAccount(unittest.TestCase): # parse reply messages = { # append_to = ToDo - '"INBOX"': { - 'latest_messages': [ - raw - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] - } + '"INBOX"': {"latest_messages": [raw], "seen_status": {2: "UNSEEN"}, "uid_list": [2]} } email_account = frappe.get_doc("Email Account", "_Test Email Account 1") @@ -217,7 +231,7 @@ class TestEmailAccount(unittest.TestCase): self.assertEqual(comm.reference_name, sent.reference_name) def test_threading_by_subject(self): - cleanup(["in", ['test_sender@example.com', 'test@example.com']]) + cleanup(["in", ["test_sender@example.com", "test@example.com"]]) with open(os.path.join(os.path.dirname(__file__), "test_mails", "reply-2.raw"), "r") as f: test_mails = [f.read()] @@ -229,20 +243,20 @@ class TestEmailAccount(unittest.TestCase): messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': test_mails, - 'seen_status': { - 2: 'UNSEEN', - 3: 'UNSEEN' - }, - 'uid_list': [2, 3] + "latest_messages": test_mails, + "seen_status": {2: "UNSEEN", 3: "UNSEEN"}, + "uid_list": [2, 3], } } email_account = frappe.get_doc("Email Account", "_Test Email Account 1") TestEmailAccount.mocked_email_receive(email_account, messages) - comm_list = frappe.get_all("Communication", filters={"sender":"test_sender@example.com"}, - fields=["name", "reference_doctype", "reference_name"]) + comm_list = frappe.get_all( + "Communication", + filters={"sender": "test_sender@example.com"}, + fields=["name", "reference_doctype", "reference_name"], + ) # both communications attached to the same reference self.assertEqual(comm_list[0].reference_doctype, comm_list[1].reference_doctype) self.assertEqual(comm_list[0].reference_name, comm_list[1].reference_name) @@ -252,26 +266,27 @@ class TestEmailAccount(unittest.TestCase): frappe.db.delete("Email Queue") # reference document for testing - event = frappe.get_doc(dict(doctype='Event', subject='test-message')).insert() + event = frappe.get_doc(dict(doctype="Event", subject="test-message")).insert() # send a mail against this - frappe.sendmail(recipients='test@example.com', subject='test message for threading', - message='testing', reference_doctype=event.doctype, reference_name=event.name) + frappe.sendmail( + recipients="test@example.com", + subject="test message for threading", + message="testing", + reference_doctype=event.doctype, + reference_name=event.name, + ) - last_mail = frappe.get_doc('Email Queue', dict(reference_name=event.name)) + last_mail = frappe.get_doc("Email Queue", dict(reference_name=event.name)) # get test mail with message-id as in-reply-to with open(os.path.join(os.path.dirname(__file__), "test_mails", "reply-4.raw"), "r") as f: messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - f.read().replace('{{ message_id }}', last_mail.message_id) - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] + "latest_messages": [f.read().replace("{{ message_id }}", last_mail.message_id)], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], } } @@ -279,8 +294,11 @@ class TestEmailAccount(unittest.TestCase): email_account = frappe.get_doc("Email Account", "_Test Email Account 1") TestEmailAccount.mocked_email_receive(email_account, messages) - comm_list = frappe.get_all("Communication", filters={"sender":"test_sender@example.com"}, - fields=["name", "reference_doctype", "reference_name"]) + comm_list = frappe.get_all( + "Communication", + filters={"sender": "test_sender@example.com"}, + fields=["name", "reference_doctype", "reference_name"], + ) # check if threaded correctly self.assertEqual(comm_list[0].reference_doctype, event.doctype) @@ -292,13 +310,9 @@ class TestEmailAccount(unittest.TestCase): messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - self.get_test_mail('incoming-1.raw') - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] + "latest_messages": [self.get_test_mail("incoming-1.raw")], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], } } @@ -306,16 +320,20 @@ class TestEmailAccount(unittest.TestCase): TestEmailAccount.mocked_email_receive(email_account, messages) comm = frappe.get_doc("Communication", {"sender": "test_sender@example.com"}) - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": comm.reference_doctype, - "reference_name": comm.reference_name})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": comm.reference_doctype, "reference_name": comm.reference_name}, + ) + ) def test_handle_bad_emails(self): mail_content = self.get_test_mail(fname="incoming-1.raw") - message_id = Email(mail_content).mail.get('Message-ID') + message_id = Email(mail_content).mail.get("Message-ID") email_account = frappe.get_doc("Email Account", "_Test Email Account 1") email_account.handle_bad_emails(uid=-1, raw=mail_content, reason="Testing") - self.assertTrue(frappe.db.get_value("Unhandled Email", {'message_id': message_id})) + self.assertTrue(frappe.db.get_value("Unhandled Email", {"message_id": message_id})) def test_imap_folder(self): # assert tests if imap_folder >= 1 and imap is checked @@ -337,10 +355,10 @@ class TestEmailAccount(unittest.TestCase): email_account = frappe.get_doc("Email Account", "_Test Email Account 1") mail_content = self.get_test_mail(fname="incoming-2.raw") - inbound_mail = InboundMail(mail_content, email_account, 12345, 1, 'ToDo') + inbound_mail = InboundMail(mail_content, email_account, 12345, 1, "ToDo") communication = inbound_mail.process() # the append_to for the email is set to ToDO in "_Test Email Account 1" - self.assertEqual(communication.reference_doctype, 'ToDo') + self.assertEqual(communication.reference_doctype, "ToDo") self.assertTrue(communication.reference_name) self.assertTrue(frappe.db.exists(communication.reference_doctype, communication.reference_name)) @@ -352,26 +370,16 @@ class TestEmailAccount(unittest.TestCase): messages = { # append_to = ToDo '"INBOX"': { - 'latest_messages': [ - mail_content_1, - mail_content_2 - ], - 'seen_status': { - 0: 'UNSEEN', - 1: 'UNSEEN' - }, - 'uid_list': [0,1] + "latest_messages": [mail_content_1, mail_content_2], + "seen_status": {0: "UNSEEN", 1: "UNSEEN"}, + "uid_list": [0, 1], }, # append_to = Communication '"Test Folder"': { - 'latest_messages': [ - mail_content_3 - ], - 'seen_status': { - 2: 'UNSEEN' - }, - 'uid_list': [2] - } + "latest_messages": [mail_content_3], + "seen_status": {2: "UNSEEN"}, + "uid_list": [2], + }, } email_account = frappe.get_doc("Email Account", "_Test Email Account 1") @@ -383,11 +391,13 @@ class TestEmailAccount(unittest.TestCase): for mail in mails: communication = mail.process() - if mail.append_to == 'ToDo': + if mail.append_to == "ToDo": inbox_mails += 1 - self.assertEqual(communication.reference_doctype, 'ToDo') + self.assertEqual(communication.reference_doctype, "ToDo") self.assertTrue(communication.reference_name) - self.assertTrue(frappe.db.exists(communication.reference_doctype, communication.reference_name)) + self.assertTrue( + frappe.db.exists(communication.reference_doctype, communication.reference_name) + ) else: test_folder_mails += 1 self.assertEqual(communication.reference_doctype, None) @@ -397,7 +407,9 @@ class TestEmailAccount(unittest.TestCase): @patch("frappe.email.receive.EmailServer.select_imap_folder", return_value=True) @patch("frappe.email.receive.EmailServer.logout", side_effect=lambda: None) - def mocked_get_inbound_mails(email_account, messages={}, mocked_logout=None, mocked_select_imap_folder=None): + def mocked_get_inbound_mails( + email_account, messages={}, mocked_logout=None, mocked_select_imap_folder=None + ): from frappe.email.receive import EmailServer def get_mocked_messages(**kwargs): @@ -410,14 +422,18 @@ class TestEmailAccount(unittest.TestCase): @patch("frappe.email.receive.EmailServer.select_imap_folder", return_value=True) @patch("frappe.email.receive.EmailServer.logout", side_effect=lambda: None) - def mocked_email_receive(email_account, messages={}, mocked_logout=None, mocked_select_imap_folder=None): + def mocked_email_receive( + email_account, messages={}, mocked_logout=None, mocked_select_imap_folder=None + ): def get_mocked_messages(**kwargs): return messages.get(kwargs["folder"], {}) from frappe.email.receive import EmailServer + with patch.object(EmailServer, "get_messages", side_effect=get_mocked_messages): email_account.receive() + class TestInboundMail(unittest.TestCase): @classmethod def setUpClass(cls): @@ -446,29 +462,22 @@ class TestInboundMail(unittest.TestCase): return doc def new_communication(self, **kwargs): - defaults = { - 'subject': "Test Subject" - } + defaults = {"subject": "Test Subject"} d = {**defaults, **kwargs} - return self.new_doc('Communication', **d) + return self.new_doc("Communication", **d) def new_email_queue(self, **kwargs): - defaults = { - 'message_id': get_message_id().strip(" <>") - } + defaults = {"message_id": get_message_id().strip(" <>")} d = {**defaults, **kwargs} - return self.new_doc('Email Queue', **d) + return self.new_doc("Email Queue", **d) def new_todo(self, **kwargs): - defaults = { - 'description': "Description" - } + defaults = {"description": "Description"} d = {**defaults, **kwargs} - return self.new_doc('ToDo', **d) + return self.new_doc("ToDo", **d) def test_self_sent_mail(self): - """Check that we raise SentEmailInInboxError if the inbound mail is self sent mail. - """ + """Check that we raise SentEmailInInboxError if the inbound mail is self sent mail.""" mail_content = self.get_test_mail(fname="incoming-self-sent.raw") email_account = frappe.get_doc("Email Account", "_Test Email Account 1") inbound_mail = InboundMail(mail_content, email_account, 1, 1) @@ -476,8 +485,7 @@ class TestInboundMail(unittest.TestCase): inbound_mail.process() def test_mail_exist_validation(self): - """Do not create communication record if the mail is already downloaded into the system. - """ + """Do not create communication record if the mail is already downloaded into the system.""" mail_content = self.get_test_mail(fname="incoming-1.raw") message_id = Email(mail_content).message_id # Create new communication record in DB @@ -492,8 +500,7 @@ class TestInboundMail(unittest.TestCase): self.assertEqual(communication.name, new_communication.name) def test_find_parent_email_queue(self): - """If the mail is reply to the already sent mail, there will be a email queue record. - """ + """If the mail is reply to the already sent mail, there will be a email queue record.""" # Create email queue record queue_record = self.new_email_queue() @@ -532,9 +539,7 @@ class TestInboundMail(unittest.TestCase): Ex: User replied to his/her mail. """ message_id = "new-message-id" - mail_content = self.get_test_mail(fname="reply-4.raw").replace( - "{{ message_id }}", message_id - ) + mail_content = self.get_test_mail(fname="reply-4.raw").replace("{{ message_id }}", message_id) email_account = frappe.get_doc("Email Account", "_Test Email Account 1") inbound_mail = InboundMail(mail_content, email_account, 12345, 1) @@ -547,8 +552,7 @@ class TestInboundMail(unittest.TestCase): self.assertEqual(parent_communication.name, communication.name) def test_find_parent_communication_from_header(self): - """Incase of header contains parent communication name - """ + """Incase of header contains parent communication name""" communication = self.new_communication() mail_content = self.get_test_mail(fname="reply-4.raw").replace( "{{ message_id }}", f"<{communication.name}@{frappe.local.site}>" @@ -563,7 +567,7 @@ class TestInboundMail(unittest.TestCase): # Create email queue record todo = self.new_todo() # communication = self.new_communication(reference_doctype='ToDo', reference_name=todo.name) - queue_record = self.new_email_queue(reference_doctype='ToDo', reference_name=todo.name) + queue_record = self.new_email_queue(reference_doctype="ToDo", reference_name=todo.name) mail_content = self.get_test_mail(fname="reply-4.raw").replace( "{{ message_id }}", queue_record.message_id ) @@ -588,7 +592,7 @@ class TestInboundMail(unittest.TestCase): def test_reference_document_by_subject_match(self): subject = "New todo" - todo = self.new_todo(sender='test_sender@example.com', description=subject) + todo = self.new_todo(sender="test_sender@example.com", description=subject) mail_content = self.get_test_mail(fname="incoming-subject-placeholder.raw").replace( "{{ subject }}", f"RE: {subject}" @@ -607,6 +611,7 @@ class TestInboundMail(unittest.TestCase): self.assertTrue(communication.is_first) self.assertTrue(communication._attachments) + def cleanup(sender=None): filters = {} if sender: diff --git a/frappe/email/doctype/email_domain/email_domain.py b/frappe/email/doctype/email_domain/email_domain.py index 1611d32351..ff59725fd7 100644 --- a/frappe/email/doctype/email_domain/email_domain.py +++ b/frappe/email/doctype/email_domain/email_domain.py @@ -2,12 +2,16 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and contributors # License: MIT. See LICENSE +import imaplib +import poplib +import smtplib + import frappe from frappe import _ -from frappe.model.document import Document -from frappe.utils import validate_email_address ,cint, cstr -import imaplib,poplib,smtplib from frappe.email.utils import get_port +from frappe.model.document import Document +from frappe.utils import cint, cstr, validate_email_address + class EmailDomain(Document): def autoname(self): @@ -27,25 +31,35 @@ class EmailDomain(Document): if not frappe.local.flags.in_install and not frappe.local.flags.in_patch: try: if self.use_imap: - logger.info('Checking incoming IMAP email server {host}:{port} ssl={ssl}...'.format( - host=self.email_server, port=get_port(self), ssl=self.use_ssl)) + logger.info( + "Checking incoming IMAP email server {host}:{port} ssl={ssl}...".format( + host=self.email_server, port=get_port(self), ssl=self.use_ssl + ) + ) if self.use_ssl: test = imaplib.IMAP4_SSL(self.email_server, port=get_port(self)) else: test = imaplib.IMAP4(self.email_server, port=get_port(self)) else: - logger.info('Checking incoming POP3 email server {host}:{port} ssl={ssl}...'.format( - host=self.email_server, port=get_port(self), ssl=self.use_ssl)) + logger.info( + "Checking incoming POP3 email server {host}:{port} ssl={ssl}...".format( + host=self.email_server, port=get_port(self), ssl=self.use_ssl + ) + ) if self.use_ssl: test = poplib.POP3_SSL(self.email_server, port=get_port(self)) else: test = poplib.POP3(self.email_server, port=get_port(self)) except Exception as e: - logger.warn('Incoming email account "{host}" not correct'.format(host=self.email_server), exc_info=e) - frappe.throw(title=_("Incoming email account not correct"), - msg='Error connecting IMAP/POP3 "{host}": {e}'.format(host=self.email_server, e=e)) + logger.warn( + 'Incoming email account "{host}" not correct'.format(host=self.email_server), exc_info=e + ) + frappe.throw( + title=_("Incoming email account not correct"), + msg='Error connecting IMAP/POP3 "{host}": {e}'.format(host=self.email_server, e=e), + ) finally: try: @@ -57,34 +71,58 @@ class EmailDomain(Document): pass try: - if self.get('use_ssl_for_outgoing'): - if not self.get('smtp_port'): + if self.get("use_ssl_for_outgoing"): + if not self.get("smtp_port"): self.smtp_port = 465 - logger.info('Checking outgoing SMTPS email server {host}:{port}...'.format( - host=self.smtp_server, port=self.smtp_port)) - sess = smtplib.SMTP_SSL((self.smtp_server or "").encode('utf-8'), - cint(self.smtp_port) or None) + logger.info( + "Checking outgoing SMTPS email server {host}:{port}...".format( + host=self.smtp_server, port=self.smtp_port + ) + ) + sess = smtplib.SMTP_SSL( + (self.smtp_server or "").encode("utf-8"), cint(self.smtp_port) or None + ) else: if self.use_tls and not self.smtp_port: self.smtp_port = 587 - logger.info('Checking outgoing SMTP email server {host}:{port} STARTTLS={tls}...'.format( - host=self.smtp_server, port=self.get('smtp_port'), tls=self.use_tls)) + logger.info( + "Checking outgoing SMTP email server {host}:{port} STARTTLS={tls}...".format( + host=self.smtp_server, port=self.get("smtp_port"), tls=self.use_tls + ) + ) sess = smtplib.SMTP(cstr(self.smtp_server or ""), cint(self.smtp_port) or None) sess.quit() except Exception as e: - logger.warn('Outgoing email account "{host}" not correct'.format(host=self.smtp_server), exc_info=e) - frappe.throw(title=_("Outgoing email account not correct"), - msg='Error connecting SMTP "{host}": {e}'.format(host=self.smtp_server, e=e)) + logger.warn( + 'Outgoing email account "{host}" not correct'.format(host=self.smtp_server), exc_info=e + ) + frappe.throw( + title=_("Outgoing email account not correct"), + msg='Error connecting SMTP "{host}": {e}'.format(host=self.smtp_server, e=e), + ) def on_update(self): """update all email accounts using this domain""" for email_account in frappe.get_all("Email Account", filters={"domain": self.name}): try: email_account = frappe.get_doc("Email Account", email_account.name) - for attr in ["email_server", "use_imap", "use_ssl", "use_tls", "attachment_limit", "smtp_server", "smtp_port", "use_ssl_for_outgoing", "append_emails_to_sent_folder", "incoming_port"]: + for attr in [ + "email_server", + "use_imap", + "use_ssl", + "use_tls", + "attachment_limit", + "smtp_server", + "smtp_port", + "use_ssl_for_outgoing", + "append_emails_to_sent_folder", + "incoming_port", + ]: email_account.set(attr, self.get(attr, default=0)) email_account.save() except Exception as e: - frappe.msgprint(_("Error has occurred in {0}").format(email_account.name), raise_exception=e.__class__) + frappe.msgprint( + _("Error has occurred in {0}").format(email_account.name), raise_exception=e.__class__ + ) diff --git a/frappe/email/doctype/email_domain/test_email_domain.py b/frappe/email/doctype/email_domain/test_email_domain.py index 7522dd5282..0162e4efe0 100644 --- a/frappe/email/doctype/email_domain/test_email_domain.py +++ b/frappe/email/doctype/email_domain/test_email_domain.py @@ -1,16 +1,17 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import unittest + +import frappe from frappe.test_runner import make_test_objects -test_records = frappe.get_test_records('Email Domain') +test_records = frappe.get_test_records("Email Domain") -class TestDomain(unittest.TestCase): +class TestDomain(unittest.TestCase): def setUp(self): - make_test_objects('Email Domain', reset=True) + make_test_objects("Email Domain", reset=True) def tearDown(self): frappe.delete_doc("Email Account", "Test") diff --git a/frappe/email/doctype/email_flag_queue/email_flag_queue.py b/frappe/email/doctype/email_flag_queue/email_flag_queue.py index 886cf3c24b..1b29d2f9d8 100644 --- a/frappe/email/doctype/email_flag_queue/email_flag_queue.py +++ b/frappe/email/doctype/email_flag_queue/email_flag_queue.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class EmailFlagQueue(Document): pass diff --git a/frappe/email/doctype/email_flag_queue/test_email_flag_queue.py b/frappe/email/doctype/email_flag_queue/test_email_flag_queue.py index b0e17b3b85..f52aeb61fa 100644 --- a/frappe/email/doctype/email_flag_queue/test_email_flag_queue.py +++ b/frappe/email/doctype/email_flag_queue/test_email_flag_queue.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Email Flag Queue') + class TestEmailFlagQueue(unittest.TestCase): pass diff --git a/frappe/email/doctype/email_group/email_group.py b/frappe/email/doctype/email_group/email_group.py index ad52d9a9ec..6489e82341 100755 --- a/frappe/email/doctype/email_group/email_group.py +++ b/frappe/email/doctype/email_group/email_group.py @@ -4,22 +4,27 @@ import frappe from frappe import _ -from frappe.utils import validate_email_address from frappe.model.document import Document -from frappe.utils import parse_addr +from frappe.utils import parse_addr, validate_email_address + class EmailGroup(Document): def onload(self): - singles = [d.name for d in frappe.db.get_all("DocType", "name", {"issingle": 1})] - self.get("__onload").import_types = [{"value": d.parent, "label": "{0} ({1})".format(d.parent, d.label)} \ - for d in frappe.db.get_all("DocField", ("parent", "label"), {"options": "Email"}) - if d.parent not in singles] + singles = [d.name for d in frappe.db.get_all("DocType", "name", {"issingle": 1})] + self.get("__onload").import_types = [ + {"value": d.parent, "label": "{0} ({1})".format(d.parent, d.label)} + for d in frappe.db.get_all("DocField", ("parent", "label"), {"options": "Email"}) + if d.parent not in singles + ] def import_from(self, doctype): """Extract Email Addresses from given doctype and add them to the current list""" meta = frappe.get_meta(doctype) - email_field = [d.fieldname for d in meta.fields - if d.fieldtype in ("Data", "Small Text", "Text", "Code") and d.options=="Email"][0] + email_field = [ + d.fieldname + for d in meta.fields + if d.fieldtype in ("Data", "Small Text", "Text", "Code") and d.options == "Email" + ][0] unsubscribed_field = "unsubscribed" if meta.get_field("unsubscribed") else None added = 0 @@ -27,12 +32,14 @@ class EmailGroup(Document): try: email = parse_addr(user.get(email_field))[1] if user.get(email_field) else None if email: - frappe.get_doc({ - "doctype": "Email Group Member", - "email_group": self.name, - "email": email, - "unsubscribed": user.get(unsubscribed_field) if unsubscribed_field else 0 - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Group Member", + "email_group": self.name, + "email": email, + "unsubscribed": user.get(unsubscribed_field) if unsubscribed_field else 0, + } + ).insert(ignore_permissions=True) added += 1 except frappe.UniqueValidationError: @@ -48,25 +55,30 @@ class EmailGroup(Document): return self.total_subscribers def get_total_subscribers(self): - return frappe.db.sql("""select count(*) from `tabEmail Group Member` - where email_group=%s""", self.name)[0][0] + return frappe.db.sql( + """select count(*) from `tabEmail Group Member` + where email_group=%s""", + self.name, + )[0][0] def on_trash(self): for d in frappe.get_all("Email Group Member", "name", {"email_group": self.name}): frappe.delete_doc("Email Group Member", d.name) + @frappe.whitelist() def import_from(name, doctype): nlist = frappe.get_doc("Email Group", name) if nlist.has_permission("write"): return nlist.import_from(doctype) + @frappe.whitelist() def add_subscribers(name, email_list): if not isinstance(email_list, (list, tuple)): email_list = email_list.replace(",", "\n").split("\n") - template = frappe.db.get_value('Email Group', name, 'welcome_email_template') + template = frappe.db.get_value("Email Group", name, "welcome_email_template") welcome_email = frappe.get_doc("Email Template", template) if template else None count = 0 @@ -75,13 +87,10 @@ def add_subscribers(name, email_list): parsed_email = validate_email_address(email, False) if parsed_email: - if not frappe.db.get_value("Email Group Member", - {"email_group": name, "email": parsed_email}): - frappe.get_doc({ - "doctype": "Email Group Member", - "email_group": name, - "email": parsed_email - }).insert(ignore_permissions=frappe.flags.ignore_permissions) + if not frappe.db.get_value("Email Group Member", {"email_group": name, "email": parsed_email}): + frappe.get_doc( + {"doctype": "Email Group Member", "email_group": name, "email": parsed_email} + ).insert(ignore_permissions=frappe.flags.ignore_permissions) send_welcome_email(welcome_email, parsed_email, name) @@ -95,15 +104,13 @@ def add_subscribers(name, email_list): return frappe.get_doc("Email Group", name).update_total_subscribers() + def send_welcome_email(welcome_email, email, email_group): """Send welcome email for the subscribers of a given email group.""" if not welcome_email: return - args = dict( - email=email, - email_group=email_group - ) + args = dict(email=email, email_group=email_group) email_message = welcome_email.response or welcome_email.response_html message = frappe.render_template(email_message, args) frappe.sendmail(email, subject=welcome_email.subject, message=message) diff --git a/frappe/email/doctype/email_group/test_email_group.py b/frappe/email/doctype/email_group/test_email_group.py index 06341c128e..4013c17d93 100644 --- a/frappe/email/doctype/email_group/test_email_group.py +++ b/frappe/email/doctype/email_group/test_email_group.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Email Group') + class TestEmailGroup(unittest.TestCase): pass diff --git a/frappe/email/doctype/email_group_member/email_group_member.py b/frappe/email/doctype/email_group_member/email_group_member.py index a9fd26f710..76990b18fb 100644 --- a/frappe/email/doctype/email_group_member/email_group_member.py +++ b/frappe/email/doctype/email_group_member/email_group_member.py @@ -5,14 +5,16 @@ import frappe from frappe.model.document import Document + class EmailGroupMember(Document): def after_delete(self): - email_group = frappe.get_doc('Email Group', self.email_group) + email_group = frappe.get_doc("Email Group", self.email_group) email_group.update_total_subscribers() def after_insert(self): - email_group = frappe.get_doc('Email Group', self.email_group) + email_group = frappe.get_doc("Email Group", self.email_group) email_group.update_total_subscribers() + def after_doctype_insert(): frappe.db.add_unique("Email Group Member", ("email_group", "email")) diff --git a/frappe/email/doctype/email_group_member/test_email_group_member.py b/frappe/email/doctype/email_group_member/test_email_group_member.py index de006dccb9..562b0327f2 100644 --- a/frappe/email/doctype/email_group_member/test_email_group_member.py +++ b/frappe/email/doctype/email_group_member/test_email_group_member.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Email Group Member') + class TestEmailGroupMember(unittest.TestCase): pass diff --git a/frappe/email/doctype/email_queue/email_queue.py b/frappe/email/doctype/email_queue/email_queue.py index 9003158a85..38577eeb97 100644 --- a/frappe/email/doctype/email_queue/email_queue.py +++ b/frappe/email/doctype/email_queue/email_queue.py @@ -2,45 +2,46 @@ # Copyright (c) 2015, Frappe Technologies and contributors # License: MIT. See LICENSE -import traceback import json - -from rq.timeouts import JobTimeoutException -import smtplib import quopri +import smtplib +import traceback from email.parser import Parser from email.policy import SMTPUTF8 + from html2text import html2text +from rq.timeouts import JobTimeoutException import frappe from frappe import _, safe_encode, task -from frappe.model.document import Document -from frappe.email.queue import get_unsubcribed_url, get_unsubscribe_message -from frappe.email.email_body import add_attachment, get_formatted_html, get_email -from frappe.utils import cint, split_emails, add_days, nowdate, cstr, get_hook_method from frappe.email.doctype.email_account.email_account import EmailAccount +from frappe.email.email_body import add_attachment, get_email, get_formatted_html +from frappe.email.queue import get_unsubcribed_url, get_unsubscribe_message +from frappe.model.document import Document from frappe.query_builder.utils import DocType - +from frappe.utils import add_days, cint, cstr, get_hook_method, nowdate, split_emails MAX_RETRY_COUNT = 3 + + class EmailQueue(Document): - DOCTYPE = 'Email Queue' + DOCTYPE = "Email Queue" def set_recipients(self, recipients): self.set("recipients", []) for r in recipients: - self.append("recipients", {"recipient":r, "status":"Not Sent"}) + self.append("recipients", {"recipient": r, "status": "Not Sent"}) def on_trash(self): self.prevent_email_queue_delete() def prevent_email_queue_delete(self): - if frappe.session.user != 'Administrator': - frappe.throw(_('Only Administrator can delete Email Queue')) + if frappe.session.user != "Administrator": + frappe.throw(_("Only Administrator can delete Email Queue")) def get_duplicate(self, recipients): values = self.as_dict() - del values['name'] + del values["name"] duplicate = frappe.get_doc(values) duplicate.set_recipients(recipients) return duplicate @@ -48,10 +49,10 @@ class EmailQueue(Document): @classmethod def new(cls, doc_data, ignore_permissions=False): data = doc_data.copy() - if not data.get('recipients'): + if not data.get("recipients"): return - recipients = data.pop('recipients') + recipients = data.pop("recipients") doc = frappe.new_doc(cls.DOCTYPE) doc.update(data) doc.set_recipients(recipients) @@ -73,9 +74,9 @@ class EmailQueue(Document): frappe.db.commit() def update_status(self, status, commit=False, **kwargs): - self.update_db(status = status, commit = commit, **kwargs) + self.update_db(status=status, commit=commit, **kwargs) if self.communication: - communication_doc = frappe.get_doc('Communication', self.communication) + communication_doc = frappe.get_doc("Communication", self.communication) communication_doc.set_delivery_status(commit=commit) @property @@ -92,24 +93,24 @@ class EmailQueue(Document): def get_email_account(self): if self.email_account: - return frappe.get_doc('Email Account', self.email_account) + return frappe.get_doc("Email Account", self.email_account) return EmailAccount.find_outgoing( - match_by_email = self.sender, match_by_doctype = self.reference_doctype) + match_by_email=self.sender, match_by_doctype=self.reference_doctype + ) def is_to_be_sent(self): - return self.status in ['Not Sent','Partially Sent'] + return self.status in ["Not Sent", "Partially Sent"] def can_send_now(self): - hold_queue = (cint(frappe.defaults.get_defaults().get("hold_queue"))==1) + hold_queue = cint(frappe.defaults.get_defaults().get("hold_queue")) == 1 if frappe.are_emails_muted() or not self.is_to_be_sent() or hold_queue: return False return True def send(self, is_background_task=False): - """ Send emails to recipients. - """ + """Send emails to recipients.""" if not self.can_send_now(): return @@ -120,7 +121,7 @@ class EmailQueue(Document): continue message = ctx.build_message(recipient.recipient) - method = get_hook_method('override_email_send') + method = get_hook_method("override_email_send") if method: method(self, self.sender, recipient.recipient, message) else: @@ -136,7 +137,7 @@ class EmailQueue(Document): ctx.email_account_doc.append_email_to_sent_folder(message) -@task(queue = 'short') +@task(queue="short") def send_mail(email_queue_name, is_background_task=False): """This is equalent to EmqilQueue.send. @@ -145,6 +146,7 @@ def send_mail(email_queue_name, is_background_task=False): record = EmailQueue.find(email_queue_name) record.send(is_background_task=is_background_task) + class SendMailContext: def __init__(self, queue_doc: Document, is_background_task: bool = False): self.queue_doc = queue_doc @@ -154,7 +156,7 @@ class SendMailContext: self.sent_to = [rec.recipient for rec in self.queue_doc.recipients if rec.is_main_sent()] def __enter__(self): - self.queue_doc.update_status(status='Sending', commit=True) + self.queue_doc.update_status(status="Sending", commit=True) return self def __exit__(self, exc_type, exc_val, exc_tb): @@ -164,32 +166,32 @@ class SendMailContext: smtplib.SMTPRecipientsRefused, smtplib.SMTPConnectError, smtplib.SMTPHeloError, - JobTimeoutException + JobTimeoutException, ] self.smtp_server.quit() self.log_exception(exc_type, exc_val, exc_tb) if exc_type in exceptions: - email_status = (self.sent_to and 'Partially Sent') or 'Not Sent' - self.queue_doc.update_status(status = email_status, commit = True) + email_status = (self.sent_to and "Partially Sent") or "Not Sent" + self.queue_doc.update_status(status=email_status, commit=True) elif exc_type: if self.queue_doc.retry < MAX_RETRY_COUNT: - update_fields = {'status': 'Not Sent', 'retry': self.queue_doc.retry + 1} + update_fields = {"status": "Not Sent", "retry": self.queue_doc.retry + 1} else: - update_fields = {'status': (self.sent_to and 'Partially Errored') or 'Error'} - self.queue_doc.update_status(**update_fields, commit = True) + update_fields = {"status": (self.sent_to and "Partially Errored") or "Error"} + self.queue_doc.update_status(**update_fields, commit=True) else: - email_status = self.is_mail_sent_to_all() and 'Sent' - email_status = email_status or (self.sent_to and 'Partially Sent') or 'Not Sent' + email_status = self.is_mail_sent_to_all() and "Sent" + email_status = email_status or (self.sent_to and "Partially Sent") or "Not Sent" - update_fields = {'status': email_status} + update_fields = {"status": email_status} if self.email_account_doc.is_exists_in_db(): - update_fields['email_account'] = self.email_account_doc.name + update_fields["email_account"] = self.email_account_doc.name else: - update_fields['email_account'] = None + update_fields["email_account"] = None - self.queue_doc.update_status(**update_fields, commit = True) + self.queue_doc.update_status(**update_fields, commit=True) def log_exception(self, exc_type, exc_val, exc_tb): if exc_type: @@ -197,9 +199,9 @@ class SendMailContext: traceback_string += f"\n Queue Name: {self.queue_doc.name}" if self.is_background_task: - frappe.log_error(title = 'frappe.email.queue.flush', message = traceback_string) + frappe.log_error(title="frappe.email.queue.flush", message=traceback_string) else: - frappe.log_error(message = traceback_string) + frappe.log_error(message=traceback_string) @property def smtp_session(self): @@ -209,7 +211,7 @@ class SendMailContext: def add_to_sent_list(self, recipient): # Update recipient status - recipient.update_db(status='Sent', commit=True) + recipient.update_db(status="Sent", commit=True) self.sent_to.append(recipient.recipient) def is_mail_sent_to_all(self): @@ -220,34 +222,34 @@ class SendMailContext: def message_placeholder(self, placeholder_key): map = { - 'tracker': '', - 'unsubscribe_url': '', - 'cc': '', - 'recipient': '', + "tracker": "", + "unsubscribe_url": "", + "cc": "", + "recipient": "", } return map.get(placeholder_key) def build_message(self, recipient_email): - """Build message specific to the recipient. - """ + """Build message specific to the recipient.""" message = self.queue_doc.message if not message: return "" - message = message.replace(self.message_placeholder('tracker'), self.get_tracker_str()) - message = message.replace(self.message_placeholder('unsubscribe_url'), - self.get_unsubscribe_str(recipient_email)) - message = message.replace(self.message_placeholder('cc'), self.get_receivers_str()) - message = message.replace(self.message_placeholder('recipient'), - self.get_receipient_str(recipient_email)) + message = message.replace(self.message_placeholder("tracker"), self.get_tracker_str()) + message = message.replace( + self.message_placeholder("unsubscribe_url"), self.get_unsubscribe_str(recipient_email) + ) + message = message.replace(self.message_placeholder("cc"), self.get_receivers_str()) + message = message.replace( + self.message_placeholder("recipient"), self.get_receipient_str(recipient_email) + ) message = self.include_attachments(message) return message def get_tracker_str(self): - tracker_url_html = \ - '
{0}. {1}.
- """.format(*translatable_content) + """.format( + *translatable_content + ) frappe.sendmail( email, @@ -296,9 +290,7 @@ def confirm_subscription(email, email_group=_("Website")): return if not frappe.db.exists("Email Group", email_group): - frappe.get_doc({"doctype": "Email Group", "title": email_group}).insert( - ignore_permissions=True - ) + frappe.get_doc({"doctype": "Email Group", "title": email_group}).insert(ignore_permissions=True) frappe.flags.ignore_permissions = True @@ -313,13 +305,15 @@ def confirm_subscription(email, email_group=_("Website")): def get_list_context(context=None): - context.update({ - "show_search": True, - "no_breadcrumbs": True, - "title": _("Newsletters"), - "filters": {"published": 1}, - "row_template": "email/doctype/newsletter/templates/newsletter_row.html", - }) + context.update( + { + "show_search": True, + "no_breadcrumbs": True, + "title": _("Newsletters"), + "filters": {"published": 1}, + "row_template": "email/doctype/newsletter/templates/newsletter_row.html", + } + ) def send_scheduled_email(): @@ -345,9 +339,7 @@ def send_scheduled_email(): # wasn't able to send emails :( frappe.db.set_value("Newsletter", newsletter, "email_sent", 0) message = ( - f"Newsletter {newsletter} failed to send" - "\n\n" - f"Traceback: {frappe.get_traceback()}" + f"Newsletter {newsletter} failed to send" "\n\n" f"Traceback: {frappe.get_traceback()}" ) frappe.log_error(title="Send Newsletter", message=message) diff --git a/frappe/email/doctype/newsletter/test_newsletter.py b/frappe/email/doctype/newsletter/test_newsletter.py index b091c31c74..c62b7e84aa 100644 --- a/frappe/email/doctype/newsletter/test_newsletter.py +++ b/frappe/email/doctype/newsletter/test_newsletter.py @@ -9,17 +9,17 @@ from unittest.mock import MagicMock, PropertyMock, patch import frappe from frappe.desk.form.load import run_onload from frappe.email.doctype.newsletter.exceptions import ( - NewsletterAlreadySentError, NoRecipientFoundError + NewsletterAlreadySentError, + NoRecipientFoundError, ) from frappe.email.doctype.newsletter.newsletter import ( Newsletter, confirmed_unsubscribe, - send_scheduled_email + send_scheduled_email, ) from frappe.email.queue import flush from frappe.utils import add_days, getdate - test_dependencies = ["Email Group"] emails = [ "test_subscriber1@example.com", @@ -33,8 +33,8 @@ newsletters = [] def get_dotted_path(obj: type) -> str: klass = obj.__class__ module = klass.__module__ - if module == 'builtins': - return klass.__qualname__ # avoid outputs like 'builtins.str' + if module == "builtins": + return klass.__qualname__ # avoid outputs like 'builtins.str' return f"{module}.{klass.__qualname__}" @@ -46,32 +46,31 @@ class TestNewsletterMixin: def tearDown(self): frappe.set_user("Administrator") for newsletter in newsletters: - frappe.db.delete("Email Queue", { - "reference_doctype": "Newsletter", - "reference_name": newsletter, - }) + frappe.db.delete( + "Email Queue", + { + "reference_doctype": "Newsletter", + "reference_name": newsletter, + }, + ) frappe.delete_doc("Newsletter", newsletter) frappe.db.delete("Newsletter Email Group", {"parent": newsletter}) newsletters.remove(newsletter) def setup_email_group(self): if not frappe.db.exists("Email Group", "_Test Email Group"): - frappe.get_doc({ - "doctype": "Email Group", - "title": "_Test Email Group" - }).insert() + frappe.get_doc({"doctype": "Email Group", "title": "_Test Email Group"}).insert() for email in emails: doctype = "Email Group Member" - email_filters = { - "email": email, - "email_group": "_Test Email Group" - } + email_filters = {"email": email, "email_group": "_Test Email Group"} try: - frappe.get_doc({ - "doctype": doctype, - **email_filters, - }).insert() + frappe.get_doc( + { + "doctype": doctype, + **email_filters, + } + ).insert() except Exception: frappe.db.update(doctype, email_filters, "unsubscribed", 0) @@ -83,7 +82,7 @@ class TestNewsletterMixin: newsletter_options = { "published": published, "schedule_sending": bool(schedule_send), - "schedule_send": schedule_send + "schedule_send": schedule_send, } newsletter = self.get_newsletter(**newsletter_options) @@ -95,8 +94,7 @@ class TestNewsletterMixin: @staticmethod def get_newsletter(**kwargs) -> "Newsletter": - """Generate and return Newsletter object - """ + """Generate and return Newsletter object""" doctype = "Newsletter" newsletter_content = { "subject": "_Test Newsletter", @@ -116,7 +114,9 @@ class TestNewsletterMixin: newsletter.reload() newsletters.append(newsletter.name) - attached_files = frappe.get_all("File", { + attached_files = frappe.get_all( + "File", + { "attached_to_doctype": newsletter.doctype, "attached_to_name": newsletter.name, }, @@ -141,15 +141,15 @@ class TestNewsletter(TestNewsletterMixin, unittest.TestCase): def test_unsubscribe(self): name = self.send_newsletter() to_unsubscribe = choice(emails) - group = frappe.get_all("Newsletter Email Group", filters={"parent": name}, fields=["email_group"]) + group = frappe.get_all( + "Newsletter Email Group", filters={"parent": name}, fields=["email_group"] + ) flush(from_test=True) confirmed_unsubscribe(to_unsubscribe, group[0].email_group) name = self.send_newsletter() - email_queue_list = [ - frappe.get_doc("Email Queue", e.name) for e in frappe.get_all("Email Queue") - ] + email_queue_list = [frappe.get_doc("Email Queue", e.name) for e in frappe.get_all("Email Queue")] self.assertEqual(len(email_queue_list), 3) recipients = [e.recipients[0].recipient for e in email_queue_list] @@ -160,15 +160,14 @@ class TestNewsletter(TestNewsletterMixin, unittest.TestCase): def test_schedule_send(self): self.send_newsletter(schedule_send=add_days(getdate(), -1)) - email_queue_list = [frappe.get_doc('Email Queue', e.name) for e in frappe.get_all("Email Queue")] + email_queue_list = [frappe.get_doc("Email Queue", e.name) for e in frappe.get_all("Email Queue")] self.assertEqual(len(email_queue_list), 4) recipients = [e.recipients[0].recipient for e in email_queue_list] for email in emails: self.assertTrue(email in recipients) def test_newsletter_send_test_email(self): - """Test "Send Test Email" functionality of Newsletter - """ + """Test "Send Test Email" functionality of Newsletter""" newsletter = self.get_newsletter() test_email = choice(emails) newsletter.send_test_email(test_email) @@ -177,21 +176,23 @@ class TestNewsletter(TestNewsletterMixin, unittest.TestCase): newsletter.save = MagicMock() self.assertFalse(newsletter.save.called) # check if the test email is in the queue - email_queue = frappe.db.get_all('Email Queue', filters=[ - ['reference_doctype', '=', 'Newsletter'], - ['reference_name', '=', newsletter.name], - ['Email Queue Recipient', 'recipient', '=', test_email] - ]) + email_queue = frappe.db.get_all( + "Email Queue", + filters=[ + ["reference_doctype", "=", "Newsletter"], + ["reference_name", "=", newsletter.name], + ["Email Queue Recipient", "recipient", "=", test_email], + ], + ) self.assertTrue(email_queue) def test_newsletter_status(self): - """Test for Newsletter's stats on onload event - """ + """Test for Newsletter's stats on onload event""" newsletter = self.get_newsletter() newsletter.email_sent = True result = newsletter.get_sending_status() - self.assertTrue('total' in result) - self.assertTrue('sent' in result) + self.assertTrue("total" in result) + self.assertTrue("sent" in result) def test_already_sent_newsletter(self): newsletter = self.get_newsletter() diff --git a/frappe/email/doctype/newsletter_attachment/newsletter_attachment.py b/frappe/email/doctype/newsletter_attachment/newsletter_attachment.py index 7842badbe1..01d194fb8d 100644 --- a/frappe/email/doctype/newsletter_attachment/newsletter_attachment.py +++ b/frappe/email/doctype/newsletter_attachment/newsletter_attachment.py @@ -4,5 +4,6 @@ # import frappe from frappe.model.document import Document + class NewsletterAttachment(Document): pass diff --git a/frappe/email/doctype/newsletter_email_group/newsletter_email_group.py b/frappe/email/doctype/newsletter_email_group/newsletter_email_group.py index 89476c4d53..b7a00ac7d2 100644 --- a/frappe/email/doctype/newsletter_email_group/newsletter_email_group.py +++ b/frappe/email/doctype/newsletter_email_group/newsletter_email_group.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class NewsletterEmailGroup(Document): pass diff --git a/frappe/email/doctype/notification/notification.py b/frappe/email/doctype/notification/notification.py index bad32fb68f..5c27eb95eb 100644 --- a/frappe/email/doctype/notification/notification.py +++ b/frappe/email/doctype/notification/notification.py @@ -2,22 +2,25 @@ # Copyright (c) 2018, Frappe Technologies and contributors # License: MIT. See LICENSE +import json +import os + import frappe -import json, os from frappe import _ -from frappe.model.document import Document from frappe.core.doctype.role.role import get_info_based_on_role, get_user_info -from frappe.utils import validate_email_address, nowdate, parse_val, is_html, add_to_date -from frappe.utils.jinja import validate_template -from frappe.utils.safe_exec import get_safe_globals -from frappe.modules.utils import export_module_json, get_doc_module -from frappe.integrations.doctype.slack_webhook_url.slack_webhook_url import send_slack_message from frappe.core.doctype.sms_settings.sms_settings import send_sms from frappe.desk.doctype.notification_log.notification_log import enqueue_create_notification +from frappe.integrations.doctype.slack_webhook_url.slack_webhook_url import send_slack_message +from frappe.model.document import Document +from frappe.modules.utils import export_module_json, get_doc_module +from frappe.utils import add_to_date, is_html, nowdate, parse_val, validate_email_address +from frappe.utils.jinja import validate_template +from frappe.utils.safe_exec import get_safe_globals + class Notification(Document): def onload(self): - '''load message''' + """load message""" if self.is_standard: self.message = self.get_template() @@ -34,35 +37,39 @@ class Notification(Document): if self.event in ("Days Before", "Days After") and not self.date_changed: frappe.throw(_("Please specify which date field must be checked")) - if self.event=="Value Change" and not self.value_changed: + if self.event == "Value Change" and not self.value_changed: frappe.throw(_("Please specify which value field must be checked")) self.validate_forbidden_types() self.validate_condition() self.validate_standard() - frappe.cache().hdel('notifications', self.document_type) + frappe.cache().hdel("notifications", self.document_type) def on_update(self): path = export_module_json(self, self.is_standard, self.module) if path: # js - if not os.path.exists(path + '.md') and not os.path.exists(path + '.html'): - with open(path + '.md', 'w') as f: + if not os.path.exists(path + ".md") and not os.path.exists(path + ".html"): + with open(path + ".md", "w") as f: f.write(self.message) # py - if not os.path.exists(path + '.py'): - with open(path + '.py', 'w') as f: - f.write("""import frappe + if not os.path.exists(path + ".py"): + with open(path + ".py", "w") as f: + f.write( + """import frappe def get_context(context): # do your magic here pass -""") +""" + ) def validate_standard(self): if self.is_standard and self.enabled and not frappe.conf.developer_mode: - frappe.throw(_('Cannot edit Standard Notification. To edit, please disable this and duplicate it')) + frappe.throw( + _("Cannot edit Standard Notification. To edit, please disable this and duplicate it") + ) def validate_condition(self): temp_doc = frappe.new_doc(self.document_type) @@ -74,30 +81,31 @@ def get_context(context): def validate_forbidden_types(self): forbidden_document_types = ("Email Queue",) - if (self.document_type in forbidden_document_types - or frappe.get_meta(self.document_type).istable): + if self.document_type in forbidden_document_types or frappe.get_meta(self.document_type).istable: # currently notifications don't work on child tables as events are not fired for each record of child table frappe.throw(_("Cannot set Notification on Document Type {0}").format(self.document_type)) def get_documents_for_today(self): - '''get list of documents that will be triggered today''' + """get list of documents that will be triggered today""" docs = [] diff_days = self.days_in_advance - if self.event=="Days After": + if self.event == "Days After": diff_days = -diff_days reference_date = add_to_date(nowdate(), days=diff_days) - reference_date_start = reference_date + ' 00:00:00.000000' - reference_date_end = reference_date + ' 23:59:59.000000' + reference_date_start = reference_date + " 00:00:00.000000" + reference_date_end = reference_date + " 23:59:59.000000" - doc_list = frappe.get_all(self.document_type, - fields='name', + doc_list = frappe.get_all( + self.document_type, + fields="name", filters=[ - { self.date_changed: ('>=', reference_date_start) }, - { self.date_changed: ('<=', reference_date_end) } - ]) + {self.date_changed: (">=", reference_date_start)}, + {self.date_changed: ("<=", reference_date_end)}, + ], + ) for d in doc_list: doc = frappe.get_doc(self.document_type, d.name) @@ -110,7 +118,7 @@ def get_context(context): return docs def send(self, doc): - '''Build recipients and send Notification''' + """Build recipients and send Notification""" context = get_context(doc) context = {"doc": doc, "alert": self, "comments": None} @@ -120,24 +128,27 @@ def get_context(context): if self.is_standard: self.load_standard_properties(context) try: - if self.channel == 'Email': + if self.channel == "Email": self.send_an_email(doc, context) - if self.channel == 'Slack': + if self.channel == "Slack": self.send_a_slack_msg(doc, context) - if self.channel == 'SMS': + if self.channel == "SMS": self.send_sms(doc, context) - if self.channel == 'System Notification' or self.send_system_notification: + if self.channel == "System Notification" or self.send_system_notification: self.create_system_notification(doc, context) except: - frappe.log_error(title='Failed to send notification', message=frappe.get_traceback()) + frappe.log_error(title="Failed to send notification", message=frappe.get_traceback()) if self.set_property_after_alert: allow_update = True - if doc.docstatus.is_submitted() and not doc.meta.get_field(self.set_property_after_alert).allow_on_submit: + if ( + doc.docstatus.is_submitted() + and not doc.meta.get_field(self.set_property_after_alert).allow_on_submit + ): allow_update = False try: if allow_update and not doc.flags.in_notification_update: @@ -149,15 +160,15 @@ def get_context(context): doc.reload() doc.set(fieldname, value) doc.flags.updater_reference = { - 'doctype': self.doctype, - 'docname': self.name, - 'label': _('via Notification') + "doctype": self.doctype, + "docname": self.name, + "label": _("via Notification"), } doc.flags.in_notification_update = True doc.save(ignore_permissions=True) doc.flags.in_notification_update = False except Exception: - frappe.log_error(title='Document update failed', message=frappe.get_traceback()) + frappe.log_error(title="Document update failed", message=frappe.get_traceback()) def create_system_notification(self, doc, context): subject = self.subject @@ -174,19 +185,21 @@ def get_context(context): return notification_doc = { - 'type': 'Alert', - 'document_type': doc.doctype, - 'document_name': doc.name, - 'subject': subject, - 'from_user': doc.modified_by or doc.owner, - 'email_content': frappe.render_template(self.message, context), - 'attached_file': attachments and json.dumps(attachments[0]) + "type": "Alert", + "document_type": doc.doctype, + "document_name": doc.name, + "subject": subject, + "from_user": doc.modified_by or doc.owner, + "email_content": frappe.render_template(self.message, context), + "attached_file": attachments and json.dumps(attachments[0]), } enqueue_create_notification(users, notification_doc) def send_an_email(self, doc, context): from email.utils import formataddr + from frappe.core.doctype.communication.email import _make as make_communication + subject = self.subject if "{" in subject: subject = frappe.render_template(self.subject, context) @@ -200,22 +213,23 @@ def get_context(context): message = frappe.render_template(self.message, context) if self.sender and self.sender_email: sender = formataddr((self.sender, self.sender_email)) - frappe.sendmail(recipients = recipients, - subject = subject, - sender = sender, - cc = cc, - bcc = bcc, - message = message, - reference_doctype = doc.doctype, - reference_name = doc.name, - attachments = attachments, + frappe.sendmail( + recipients=recipients, + subject=subject, + sender=sender, + cc=cc, + bcc=bcc, + message=message, + reference_doctype=doc.doctype, + reference_name=doc.name, + attachments=attachments, expose_recipients="header", - print_letterhead = ((attachments - and attachments[0].get('print_letterhead')) or False)) + print_letterhead=((attachments and attachments[0].get("print_letterhead")) or False), + ) # Add mail notification to communication list # No need to add if it is already a communication. - if doc.doctype != 'Communication': + if doc.doctype != "Communication": make_communication( doctype=doc.doctype, name=doc.name, @@ -228,7 +242,7 @@ def get_context(context): attachments=attachments, cc=cc, bcc=bcc, - communication_type='Automated Message', + communication_type="Automated Message", ) def send_a_slack_msg(self, doc, context): @@ -236,12 +250,13 @@ def get_context(context): webhook_url=self.slack_webhook_url, message=frappe.render_template(self.message, context), reference_doctype=doc.doctype, - reference_name=doc.name) + reference_name=doc.name, + ) def send_sms(self, doc, context): send_sms( receiver_list=self.get_receiver_list(doc, context), - msg=frappe.render_template(self.message, context) + msg=frappe.render_template(self.message, context), ) def get_list_of_recipients(self, doc, context): @@ -253,7 +268,7 @@ def get_context(context): if not frappe.safe_eval(recipient.condition, None, context): continue if recipient.receiver_by_document_field: - fields = recipient.receiver_by_document_field.split(',') + fields = recipient.receiver_by_document_field.split(",") # fields from child table if len(fields) > 1: for d in doc.get(fields[1]): @@ -281,9 +296,9 @@ def get_context(context): recipient.bcc = recipient.bcc.replace(",", "\n") bcc = bcc + recipient.bcc.split("\n") - #For sending emails to specified role + # For sending emails to specified role if recipient.receiver_by_role: - emails = get_info_based_on_role(recipient.receiver_by_role, 'email') + emails = get_info_based_on_role(recipient.receiver_by_role, "email") for email in emails: recipients = recipients + email.split("\n") @@ -294,7 +309,7 @@ def get_context(context): return list(set(recipients)), list(set(cc)), list(set(bcc)) def get_receiver_list(self, doc, context): - ''' return receiver list based on the doc field and role specified ''' + """return receiver list based on the doc field and role specified""" receiver_list = [] for recipient in self.recipients: if recipient.condition: @@ -302,89 +317,98 @@ def get_context(context): continue # For sending messages to the owner's mobile phone number - if recipient.receiver_by_document_field == 'owner': - receiver_list += get_user_info([dict(user_name=doc.get('owner'))], 'mobile_no') + if recipient.receiver_by_document_field == "owner": + receiver_list += get_user_info([dict(user_name=doc.get("owner"))], "mobile_no") # For sending messages to the number specified in the receiver field elif recipient.receiver_by_document_field: receiver_list.append(doc.get(recipient.receiver_by_document_field)) - #For sending messages to specified role + # For sending messages to specified role if recipient.receiver_by_role: - receiver_list += get_info_based_on_role(recipient.receiver_by_role, 'mobile_no') + receiver_list += get_info_based_on_role(recipient.receiver_by_role, "mobile_no") return receiver_list def get_attachment(self, doc): - """ check print settings are attach the pdf """ + """check print settings are attach the pdf""" if not self.attach_print: return None print_settings = frappe.get_doc("Print Settings", "Print Settings") - if (doc.docstatus == 0 and not print_settings.allow_print_for_draft) or \ - (doc.docstatus == 2 and not print_settings.allow_print_for_cancelled): + if (doc.docstatus == 0 and not print_settings.allow_print_for_draft) or ( + doc.docstatus == 2 and not print_settings.allow_print_for_cancelled + ): # ignoring attachment as draft and cancelled documents are not allowed to print status = "Draft" if doc.docstatus == 0 else "Cancelled" - frappe.throw(_("""Not allowed to attach {0} document, please enable Allow Print For {0} in Print Settings""").format(status), - title=_("Error in Notification")) + frappe.throw( + _( + """Not allowed to attach {0} document, please enable Allow Print For {0} in Print Settings""" + ).format(status), + title=_("Error in Notification"), + ) else: - return [{ - "print_format_attachment": 1, - "doctype": doc.doctype, - "name": doc.name, - "print_format": self.print_format, - "print_letterhead": print_settings.with_letterhead, - "lang": frappe.db.get_value('Print Format', self.print_format, 'default_print_language') - if self.print_format else 'en' - }] - + return [ + { + "print_format_attachment": 1, + "doctype": doc.doctype, + "name": doc.name, + "print_format": self.print_format, + "print_letterhead": print_settings.with_letterhead, + "lang": frappe.db.get_value("Print Format", self.print_format, "default_print_language") + if self.print_format + else "en", + } + ] def get_template(self): module = get_doc_module(self.module, self.doctype, self.name) + def load_template(extn): - template = '' - template_path = os.path.join(os.path.dirname(module.__file__), - frappe.scrub(self.name) + extn) + template = "" + template_path = os.path.join(os.path.dirname(module.__file__), frappe.scrub(self.name) + extn) if os.path.exists(template_path): - with open(template_path, 'r') as f: + with open(template_path, "r") as f: template = f.read() return template - return load_template('.html') or load_template('.md') + return load_template(".html") or load_template(".md") def load_standard_properties(self, context): - '''load templates and run get_context''' + """load templates and run get_context""" module = get_doc_module(self.module, self.doctype, self.name) if module: - if hasattr(module, 'get_context'): + if hasattr(module, "get_context"): out = module.get_context(context) - if out: context.update(out) + if out: + context.update(out) self.message = self.get_template() if not is_html(self.message): self.message = frappe.utils.md_to_html(self.message) + @frappe.whitelist() def get_documents_for_today(notification): - notification = frappe.get_doc('Notification', notification) - notification.check_permission('read') + notification = frappe.get_doc("Notification", notification) + notification.check_permission("read") return [d.name for d in notification.get_documents_for_today()] + def trigger_daily_alerts(): trigger_notifications(None, "daily") + def trigger_notifications(doc, method=None): if frappe.flags.in_import or frappe.flags.in_patch: # don't send notifications while syncing or patching return if method == "daily": - doc_list = frappe.get_all('Notification', - filters={ - 'event': ('in', ('Days Before', 'Days After')), - 'enabled': 1 - }) + doc_list = frappe.get_all( + "Notification", filters={"event": ("in", ("Days Before", "Days After")), "enabled": 1} + ) for d in doc_list: alert = frappe.get_doc("Notification", d.name) @@ -392,8 +416,10 @@ def trigger_notifications(doc, method=None): evaluate_alert(doc, alert, alert.event) frappe.db.commit() + def evaluate_alert(doc, alert, event): from jinja2 import TemplateError + try: if isinstance(alert, str): alert = frappe.get_doc("Notification", alert) @@ -404,17 +430,17 @@ def evaluate_alert(doc, alert, event): if not frappe.safe_eval(alert.condition, None, context): return - if event=="Value Change" and not doc.is_new(): + if event == "Value Change" and not doc.is_new(): if not frappe.db.has_column(doc.doctype, alert.value_changed): - alert.db_set('enabled', 0) - frappe.log_error('Notification {0} has been disabled due to missing field'.format(alert.name)) + alert.db_set("enabled", 0) + frappe.log_error("Notification {0} has been disabled due to missing field".format(alert.name)) return doc_before_save = doc.get_doc_before_save() field_value_before_save = doc_before_save.get(alert.value_changed) if doc_before_save else None field_value_before_save = parse_val(field_value_before_save) - if (doc.get(alert.value_changed) == field_value_before_save): + if doc.get(alert.value_changed) == field_value_before_save: # value not changed return @@ -424,19 +450,33 @@ def evaluate_alert(doc, alert, event): doc.reload() alert.send(doc) except TemplateError: - frappe.throw(_("Error while evaluating Notification {0}. Please fix your template.").format(alert)) + frappe.throw( + _("Error while evaluating Notification {0}. Please fix your template.").format(alert) + ) except Exception as e: error_log = frappe.log_error(message=frappe.get_traceback(), title=str(e)) - frappe.throw(_("Error in Notification: {}").format( - frappe.utils.get_link_to_form('Error Log', error_log.name))) + frappe.throw( + _("Error in Notification: {}").format( + frappe.utils.get_link_to_form("Error Log", error_log.name) + ) + ) + def get_context(doc): - return {"doc": doc, "nowdate": nowdate, "frappe": frappe._dict(utils=get_safe_globals().get("frappe").get("utils"))} + return { + "doc": doc, + "nowdate": nowdate, + "frappe": frappe._dict(utils=get_safe_globals().get("frappe").get("utils")), + } + def get_assignees(doc): assignees = [] - assignees = frappe.get_all('ToDo', filters={'status': 'Open', 'reference_name': doc.name, - 'reference_type': doc.doctype}, fields=['allocated_to']) + assignees = frappe.get_all( + "ToDo", + filters={"status": "Open", "reference_name": doc.name, "reference_type": doc.doctype}, + fields=["allocated_to"], + ) recipients = [d.allocated_to for d in assignees] diff --git a/frappe/email/doctype/notification/test_notification.py b/frappe/email/doctype/notification/test_notification.py index f6f216ada2..4d8b26c559 100644 --- a/frappe/email/doctype/notification/test_notification.py +++ b/frappe/email/doctype/notification/test_notification.py @@ -1,91 +1,122 @@ # -*- coding: utf-8 -*- # Copyright (c) 2018, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe, frappe.utils, frappe.utils.scheduler -from frappe.desk.form import assign_to import unittest +import frappe +import frappe.utils +import frappe.utils.scheduler +from frappe.desk.form import assign_to + test_dependencies = ["User", "Notification"] + class TestNotification(unittest.TestCase): def setUp(self): frappe.db.delete("Email Queue") frappe.set_user("test@example.com") - if not frappe.db.exists('Notification', {'name': 'ToDo Status Update'}, 'name'): - notification = frappe.new_doc('Notification') - notification.name = 'ToDo Status Update' - notification.subject = 'ToDo Status Update' - notification.document_type = 'ToDo' - notification.event = 'Value Change' - notification.value_changed = 'status' + if not frappe.db.exists("Notification", {"name": "ToDo Status Update"}, "name"): + notification = frappe.new_doc("Notification") + notification.name = "ToDo Status Update" + notification.subject = "ToDo Status Update" + notification.document_type = "ToDo" + notification.event = "Value Change" + notification.value_changed = "status" notification.send_to_all_assignees = 1 - notification.set_property_after_alert = 'description' - notification.property_value = 'Changed by Notification' + notification.set_property_after_alert = "description" + notification.property_value = "Changed by Notification" notification.save() - if not frappe.db.exists('Notification', {'name': 'Contact Status Update'}, 'name'): - notification = frappe.new_doc('Notification') - notification.name = 'Contact Status Update' - notification.subject = 'Contact Status Update' - notification.document_type = 'Contact' - notification.event = 'Value Change' - notification.value_changed = 'status' - notification.message = 'Test Contact Update' - notification.append('recipients', { - 'receiver_by_document_field': 'email_id,email_ids' - }) + if not frappe.db.exists("Notification", {"name": "Contact Status Update"}, "name"): + notification = frappe.new_doc("Notification") + notification.name = "Contact Status Update" + notification.subject = "Contact Status Update" + notification.document_type = "Contact" + notification.event = "Value Change" + notification.value_changed = "status" + notification.message = "Test Contact Update" + notification.append("recipients", {"receiver_by_document_field": "email_id,email_ids"}) notification.save() - def tearDown(self): frappe.set_user("Administrator") def test_new_and_save(self): - """Check creating a new communication triggers a notification. - """ + """Check creating a new communication triggers a notification.""" communication = frappe.new_doc("Communication") - communication.communication_type = 'Comment' + communication.communication_type = "Comment" communication.subject = "test" communication.content = "test" communication.insert(ignore_permissions=True) - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": "Communication", - "reference_name": communication.name, "status":"Not Sent"})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + { + "reference_doctype": "Communication", + "reference_name": communication.name, + "status": "Not Sent", + }, + ) + ) frappe.db.delete("Email Queue") communication.reload() communication.content = "test 2" communication.save() - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": "Communication", - "reference_name": communication.name, "status":"Not Sent"})) - - self.assertEqual(frappe.db.get_value('Communication', - communication.name, 'subject'), '__testing__') + self.assertTrue( + frappe.db.get_value( + "Email Queue", + { + "reference_doctype": "Communication", + "reference_name": communication.name, + "status": "Not Sent", + }, + ) + ) + + self.assertEqual( + frappe.db.get_value("Communication", communication.name, "subject"), "__testing__" + ) def test_condition(self): - """Check notification is triggered based on a condition. - """ + """Check notification is triggered based on a condition.""" event = frappe.new_doc("Event") - event.subject = "test", + event.subject = ("test",) event.event_type = "Private" - event.starts_on = "2014-06-06 12:00:00" + event.starts_on = "2014-06-06 12:00:00" event.insert() - self.assertFalse(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status":"Not Sent"})) + self.assertFalse( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) event.event_type = "Public" event.save() - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status":"Not Sent"})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) # Make sure that we track the triggered notifications in communication doctype. - self.assertTrue(frappe.db.get_value("Communication", {"reference_doctype": "Event", - "reference_name": event.name, "communication_type": 'Automated Message'})) - + self.assertTrue( + frappe.db.get_value( + "Communication", + { + "reference_doctype": "Event", + "reference_name": event.name, + "communication_type": "Automated Message", + }, + ) + ) def test_invalid_condition(self): frappe.set_user("Administrator") @@ -104,49 +135,60 @@ class TestNotification(unittest.TestCase): self.assertRaises(frappe.ValidationError, notification.save) notification.delete() - def test_value_changed(self): event = frappe.new_doc("Event") - event.subject = "test", + event.subject = ("test",) event.event_type = "Private" - event.starts_on = "2014-06-06 12:00:00" + event.starts_on = "2014-06-06 12:00:00" event.insert() - self.assertFalse(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status":"Not Sent"})) + self.assertFalse( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) event.subject = "test 1" event.save() - self.assertFalse(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status":"Not Sent"})) + self.assertFalse( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) event.description = "test" event.save() - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status":"Not Sent"})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) def test_alert_disabled_on_wrong_field(self): - frappe.set_user('Administrator') - notification = frappe.get_doc({ - "doctype": "Notification", - "subject":"_Test Notification for wrong field", - "document_type": "Event", - "event": "Value Change", - "attach_print": 0, - "value_changed": "description1", - "message": "Description changed", - "recipients": [ - { "receiver_by_document_field": "owner" } - ] - }).insert() + frappe.set_user("Administrator") + notification = frappe.get_doc( + { + "doctype": "Notification", + "subject": "_Test Notification for wrong field", + "document_type": "Event", + "event": "Value Change", + "attach_print": 0, + "value_changed": "description1", + "message": "Description changed", + "recipients": [{"receiver_by_document_field": "owner"}], + } + ).insert() frappe.db.commit() event = frappe.new_doc("Event") - event.subject = "test-2", + event.subject = ("test-2",) event.event_type = "Private" - event.starts_on = "2014-06-06 12:00:00" + event.starts_on = "2014-06-06 12:00:00" event.insert() event.subject = "test 1" event.save() @@ -160,34 +202,56 @@ class TestNotification(unittest.TestCase): def test_date_changed(self): event = frappe.new_doc("Event") - event.subject = "test", + event.subject = ("test",) event.event_type = "Private" event.starts_on = "2014-01-01 12:00:00" event.insert() - self.assertFalse(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status": "Not Sent"})) + self.assertFalse( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) - frappe.set_user('Administrator') - frappe.get_doc('Scheduled Job Type', dict(method='frappe.email.doctype.notification.notification.trigger_daily_alerts')).execute() + frappe.set_user("Administrator") + frappe.get_doc( + "Scheduled Job Type", + dict(method="frappe.email.doctype.notification.notification.trigger_daily_alerts"), + ).execute() # not today, so no alert - self.assertFalse(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status": "Not Sent"})) - - event.starts_on = frappe.utils.add_days(frappe.utils.nowdate(), 2) + " 12:00:00" + self.assertFalse( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) + + event.starts_on = frappe.utils.add_days(frappe.utils.nowdate(), 2) + " 12:00:00" event.save() # Value Change notification alert will be trigger as description is not changed # mail will not be sent - self.assertFalse(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status": "Not Sent"})) - - frappe.get_doc('Scheduled Job Type', dict(method='frappe.email.doctype.notification.notification.trigger_daily_alerts')).execute() + self.assertFalse( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) + + frappe.get_doc( + "Scheduled Job Type", + dict(method="frappe.email.doctype.notification.notification.trigger_daily_alerts"), + ).execute() # today so show alert - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": "Event", - "reference_name": event.name, "status":"Not Sent"})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "Event", "reference_name": event.name, "status": "Not Sent"}, + ) + ) def test_cc_jinja(self): @@ -196,85 +260,92 @@ class TestNotification(unittest.TestCase): frappe.db.delete("Email Queue Recipient") test_user = frappe.new_doc("User") - test_user.name = 'test_jinja' - test_user.first_name = 'test_jinja' - test_user.email = 'test_jinja@example.com' + test_user.name = "test_jinja" + test_user.first_name = "test_jinja" + test_user.email = "test_jinja@example.com" test_user.insert(ignore_permissions=True) - self.assertTrue(frappe.db.get_value("Email Queue", {"reference_doctype": "User", - "reference_name": test_user.name, "status":"Not Sent"})) + self.assertTrue( + frappe.db.get_value( + "Email Queue", + {"reference_doctype": "User", "reference_name": test_user.name, "status": "Not Sent"}, + ) + ) - self.assertTrue(frappe.db.get_value("Email Queue Recipient", {"recipient": "test_jinja@example.com"})) + self.assertTrue( + frappe.db.get_value("Email Queue Recipient", {"recipient": "test_jinja@example.com"}) + ) frappe.db.delete("User", {"email": "test_jinja@example.com"}) frappe.db.delete("Email Queue") frappe.db.delete("Email Queue Recipient") def test_notification_to_assignee(self): - todo = frappe.new_doc('ToDo') - todo.description = 'Test Notification' + todo = frappe.new_doc("ToDo") + todo.description = "Test Notification" todo.save() - assign_to.add({ - "assign_to": ["test2@example.com"], - "doctype": todo.doctype, - "name": todo.name, - "description": "Close this Todo" - }) - - assign_to.add({ - "assign_to": ["test1@example.com"], - "doctype": todo.doctype, - "name": todo.name, - "description": "Close this Todo" - }) - - #change status of todo - todo.status = 'Closed' + assign_to.add( + { + "assign_to": ["test2@example.com"], + "doctype": todo.doctype, + "name": todo.name, + "description": "Close this Todo", + } + ) + + assign_to.add( + { + "assign_to": ["test1@example.com"], + "doctype": todo.doctype, + "name": todo.name, + "description": "Close this Todo", + } + ) + + # change status of todo + todo.status = "Closed" todo.save() - email_queue = frappe.get_doc('Email Queue', {'reference_doctype': 'ToDo', - 'reference_name': todo.name}) + email_queue = frappe.get_doc( + "Email Queue", {"reference_doctype": "ToDo", "reference_name": todo.name} + ) self.assertTrue(email_queue) # check if description is changed after alert since set_property_after_alert is set - self.assertEqual(todo.description, 'Changed by Notification') + self.assertEqual(todo.description, "Changed by Notification") recipients = [d.recipient for d in email_queue.recipients] - self.assertTrue('test2@example.com' in recipients) - self.assertTrue('test1@example.com' in recipients) + self.assertTrue("test2@example.com" in recipients) + self.assertTrue("test1@example.com" in recipients) def test_notification_by_child_table_field(self): - contact = frappe.new_doc('Contact') - contact.first_name = 'John Doe' - contact.status = 'Open' - contact.append('email_ids', { - 'email_id': 'test2@example.com', - 'is_primary': 1 - }) - - contact.append('email_ids', { - 'email_id': 'test1@example.com' - }) + contact = frappe.new_doc("Contact") + contact.first_name = "John Doe" + contact.status = "Open" + contact.append("email_ids", {"email_id": "test2@example.com", "is_primary": 1}) + + contact.append("email_ids", {"email_id": "test1@example.com"}) contact.save() - #change status of contact - contact.status = 'Replied' + # change status of contact + contact.status = "Replied" contact.save() - email_queue = frappe.get_doc('Email Queue', {'reference_doctype': 'Contact', - 'reference_name': contact.name}) + email_queue = frappe.get_doc( + "Email Queue", {"reference_doctype": "Contact", "reference_name": contact.name} + ) self.assertTrue(email_queue) recipients = [d.recipient for d in email_queue.recipients] - self.assertTrue('test2@example.com' in recipients) - self.assertTrue('test1@example.com' in recipients) + self.assertTrue("test2@example.com" in recipients) + self.assertTrue("test1@example.com" in recipients) @classmethod def tearDownClass(cls): frappe.delete_doc_if_exists("Notification", "ToDo Status Update") - frappe.delete_doc_if_exists("Notification", "Contact Status Update") \ No newline at end of file + frappe.delete_doc_if_exists("Notification", "Contact Status Update") diff --git a/frappe/email/doctype/notification_recipient/notification_recipient.py b/frappe/email/doctype/notification_recipient/notification_recipient.py index 68871e5047..9de15f46c0 100644 --- a/frappe/email/doctype/notification_recipient/notification_recipient.py +++ b/frappe/email/doctype/notification_recipient/notification_recipient.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class NotificationRecipient(Document): pass diff --git a/frappe/email/doctype/unhandled_email/test_unhandled_email.py b/frappe/email/doctype/unhandled_email/test_unhandled_email.py index 37c65584e0..694b3e03a6 100644 --- a/frappe/email/doctype/unhandled_email/test_unhandled_email.py +++ b/frappe/email/doctype/unhandled_email/test_unhandled_email.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Unhandled Emails') + class TestUnhandledEmail(unittest.TestCase): pass diff --git a/frappe/email/doctype/unhandled_email/unhandled_email.py b/frappe/email/doctype/unhandled_email/unhandled_email.py index db14a50d09..e703f1ec97 100644 --- a/frappe/email/doctype/unhandled_email/unhandled_email.py +++ b/frappe/email/doctype/unhandled_email/unhandled_email.py @@ -5,11 +5,12 @@ import frappe from frappe.model.document import Document + class UnhandledEmail(Document): pass def remove_old_unhandled_emails(): - frappe.db.delete("Unhandled Email", { - "creation": ("<", frappe.utils.add_days(frappe.utils.nowdate(), -30)) - }) \ No newline at end of file + frappe.db.delete( + "Unhandled Email", {"creation": ("<", frappe.utils.add_days(frappe.utils.nowdate(), -30))} + ) diff --git a/frappe/email/email_body.py b/frappe/email/email_body.py index 0f45e42aac..07f698f740 100755 --- a/frappe/email/email_body.py +++ b/frappe/email/email_body.py @@ -1,28 +1,57 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, re, os -from frappe.utils.pdf import get_pdf -from frappe.email.doctype.email_account.email_account import EmailAccount -from frappe.utils import (get_url, scrub_urls, strip, expand_relative_urls, cint, - split_emails, to_markdown, markdown, random_string, parse_addr) import email.utils -from email.mime.multipart import MIMEMultipart -from email.header import Header +import os +import re from email import policy +from email.header import Header +from email.mime.multipart import MIMEMultipart + +import frappe +from frappe.email.doctype.email_account.email_account import EmailAccount +from frappe.utils import ( + cint, + expand_relative_urls, + get_url, + markdown, + parse_addr, + random_string, + scrub_urls, + split_emails, + strip, + to_markdown, +) +from frappe.utils.pdf import get_pdf -def get_email(recipients, sender='', msg='', subject='[No Subject]', - text_content = None, footer=None, print_html=None, formatted=None, attachments=None, - content=None, reply_to=None, cc=None, bcc=None, email_account=None, expose_recipients=None, - inline_images=None, header=None): - """ Prepare an email with the following format: - - multipart/mixed - - multipart/alternative - - text/plain - - multipart/related - - text/html - - inline image - - attachment + +def get_email( + recipients, + sender="", + msg="", + subject="[No Subject]", + text_content=None, + footer=None, + print_html=None, + formatted=None, + attachments=None, + content=None, + reply_to=None, + cc=None, + bcc=None, + email_account=None, + expose_recipients=None, + inline_images=None, + header=None, +): + """Prepare an email with the following format: + - multipart/mixed + - multipart/alternative + - text/plain + - multipart/related + - text/html + - inline image + - attachment """ content = content or msg @@ -33,36 +62,67 @@ def get_email(recipients, sender='', msg='', subject='[No Subject]', if inline_images is None: inline_images = [] - emailobj = EMail(sender, recipients, subject, reply_to=reply_to, cc=cc, bcc=bcc, email_account=email_account, expose_recipients=expose_recipients) + emailobj = EMail( + sender, + recipients, + subject, + reply_to=reply_to, + cc=cc, + bcc=bcc, + email_account=email_account, + expose_recipients=expose_recipients, + ) if not content.strip().startswith("<"): content = markdown(content) - emailobj.set_html(content, text_content, footer=footer, header=header, - print_html=print_html, formatted=formatted, inline_images=inline_images) + emailobj.set_html( + content, + text_content, + footer=footer, + header=header, + print_html=print_html, + formatted=formatted, + inline_images=inline_images, + ) if isinstance(attachments, dict): attachments = [attachments] - for attach in (attachments or []): + for attach in attachments or []: # cannot attach if no filecontent - if attach.get('fcontent') is None: continue + if attach.get("fcontent") is None: + continue emailobj.add_attachment(**attach) return emailobj + class EMail: """ Wrapper on the email module. Email object represents emails to be sent to the client. Also provides a clean way to add binary `FileData` attachments Also sets all messages as multipart/alternative for cleaner reading in text-only clients """ - def __init__(self, sender='', recipients=(), subject='', alternative=0, reply_to=None, cc=(), bcc=(), email_account=None, expose_recipients=None): + + def __init__( + self, + sender="", + recipients=(), + subject="", + alternative=0, + reply_to=None, + cc=(), + bcc=(), + email_account=None, + expose_recipients=None, + ): from email import charset as Charset - Charset.add_charset('utf-8', Charset.QP, Charset.QP, 'utf-8') + + Charset.add_charset("utf-8", Charset.QP, Charset.QP, "utf-8") if isinstance(recipients, str): - recipients = recipients.replace(';', ',').replace('\n', '') + recipients = recipients.replace(";", ",").replace("\n", "") recipients = split_emails(recipients) # remove null @@ -74,22 +134,38 @@ class EMail: self.subject = subject self.expose_recipients = expose_recipients - self.msg_root = MIMEMultipart('mixed', policy=policy.SMTPUTF8) - self.msg_alternative = MIMEMultipart('alternative', policy=policy.SMTPUTF8) + self.msg_root = MIMEMultipart("mixed", policy=policy.SMTPUTF8) + self.msg_alternative = MIMEMultipart("alternative", policy=policy.SMTPUTF8) self.msg_root.attach(self.msg_alternative) self.cc = cc or [] self.bcc = bcc or [] self.html_set = False - self.email_account = email_account or \ - EmailAccount.find_outgoing(match_by_email=sender, _raise_error=True) - - def set_html(self, message, text_content = None, footer=None, print_html=None, - formatted=None, inline_images=None, header=None): + self.email_account = email_account or EmailAccount.find_outgoing( + match_by_email=sender, _raise_error=True + ) + + def set_html( + self, + message, + text_content=None, + footer=None, + print_html=None, + formatted=None, + inline_images=None, + header=None, + ): """Attach message in the html portion of multipart/alternative""" if not formatted: - formatted = get_formatted_html(self.subject, message, footer, print_html, - email_account=self.email_account, header=header, sender=self.sender) + formatted = get_formatted_html( + self.subject, + message, + footer, + print_html, + email_account=self.email_account, + header=header, + sender=self.sender, + ) # this is the first html part of a multi-part message, # convert to text well @@ -104,48 +180,56 @@ class EMail: def set_text(self, message): """ - Attach message in the text portion of multipart/alternative + Attach message in the text portion of multipart/alternative """ from email.mime.text import MIMEText - part = MIMEText(message, 'plain', 'utf-8', policy=policy.SMTPUTF8) + + part = MIMEText(message, "plain", "utf-8", policy=policy.SMTPUTF8) self.msg_alternative.attach(part) def set_part_html(self, message, inline_images): from email.mime.text import MIMEText - has_inline_images = re.search('''embed=['"].*?['"]''', message) + has_inline_images = re.search("""embed=['"].*?['"]""", message) if has_inline_images: # process inline images message, _inline_images = replace_filename_with_cid(message) # prepare parts - msg_related = MIMEMultipart('related', policy=policy.SMTPUTF8) + msg_related = MIMEMultipart("related", policy=policy.SMTPUTF8) - html_part = MIMEText(message, 'html', 'utf-8', policy=policy.SMTPUTF8) + html_part = MIMEText(message, "html", "utf-8", policy=policy.SMTPUTF8) msg_related.attach(html_part) for image in _inline_images: - self.add_attachment(image.get('filename'), image.get('filecontent'), - content_id=image.get('content_id'), parent=msg_related, inline=True) + self.add_attachment( + image.get("filename"), + image.get("filecontent"), + content_id=image.get("content_id"), + parent=msg_related, + inline=True, + ) self.msg_alternative.attach(msg_related) else: - self.msg_alternative.attach(MIMEText(message, 'html', 'utf-8', policy=policy.SMTPUTF8)) + self.msg_alternative.attach(MIMEText(message, "html", "utf-8", policy=policy.SMTPUTF8)) def set_html_as_text(self, html): """Set plain text from HTML""" self.set_text(to_markdown(html)) - def set_message(self, message, mime_type='text/html', as_attachment=0, filename='attachment.html'): + def set_message( + self, message, mime_type="text/html", as_attachment=0, filename="attachment.html" + ): """Append the message with MIME content to the root node (as attachment)""" from email.mime.text import MIMEText - maintype, subtype = mime_type.split('/') - part = MIMEText(message, _subtype = subtype, policy=policy.SMTPUTF8) + maintype, subtype = mime_type.split("/") + part = MIMEText(message, _subtype=subtype, policy=policy.SMTPUTF8) if as_attachment: - part.add_header('Content-Disposition', 'attachment', filename=filename) + part.add_header("Content-Disposition", "attachment", filename=filename) self.msg_root.attach(part) @@ -158,8 +242,9 @@ class EMail: self.add_attachment(_file.file_name, content) - def add_attachment(self, fname, fcontent, content_type=None, - parent=None, content_id=None, inline=False): + def add_attachment( + self, fname, fcontent, content_type=None, parent=None, content_id=None, inline=False + ): """add attachment""" if not parent: @@ -168,7 +253,7 @@ class EMail: add_attachment(fname, fcontent, content_type, parent, content_id, inline) def add_pdf_attachment(self, name, html, options=None): - self.add_attachment(name, get_pdf(html, options), 'application/octet-stream') + self.add_attachment(name, get_pdf(html, options), "application/octet-stream") def validate(self): """validate the Email Addresses""" @@ -192,42 +277,46 @@ class EMail: def replace_sender(self): if cint(self.email_account.always_use_account_email_id_as_sender): - self.set_header('X-Original-From', self.sender) + self.set_header("X-Original-From", self.sender) sender_name, sender_email = parse_addr(self.sender) - self.sender = email.utils.formataddr((str(Header(sender_name or self.email_account.name, 'utf-8')), self.email_account.email_id)) + self.sender = email.utils.formataddr( + (str(Header(sender_name or self.email_account.name, "utf-8")), self.email_account.email_id) + ) def replace_sender_name(self): if cint(self.email_account.always_use_account_name_as_sender_name): - self.set_header('X-Original-From', self.sender) + self.set_header("X-Original-From", self.sender) sender_name, sender_email = parse_addr(self.sender) - self.sender = email.utils.formataddr((str(Header(self.email_account.name, 'utf-8')), sender_email)) + self.sender = email.utils.formataddr( + (str(Header(self.email_account.name, "utf-8")), sender_email) + ) def set_message_id(self, message_id, is_notification=False): if message_id: - message_id = '<' + message_id + '>' + message_id = "<" + message_id + ">" else: message_id = get_message_id() - self.set_header('isnotification', '" + email_account.signature else: return "" + def get_footer(email_account, footer=None): """append a footer (signature)""" footer = footer or "" @@ -368,75 +475,78 @@ def get_footer(email_account, footer=None): args = {} if email_account and email_account.footer: - args.update({'email_account_footer': email_account.footer}) + args.update({"email_account_footer": email_account.footer}) sender_address = frappe.db.get_default("email_footer_address") if sender_address: - args.update({'sender_address': sender_address}) + args.update({"sender_address": sender_address}) if not cint(frappe.db.get_default("disable_standard_email_footer")): - args.update({'default_mail_footer': frappe.get_hooks('default_mail_footer')}) + args.update({"default_mail_footer": frappe.get_hooks("default_mail_footer")}) - footer += frappe.utils.jinja.get_email_from_template('email_footer', args)[0] + footer += frappe.utils.jinja.get_email_from_template("email_footer", args)[0] return footer + def replace_filename_with_cid(message): - """ Replaces
@@ -78,23 +85,29 @@ def get_unsubscribe_message(unsubscribe_message, expose_recipients):
""".format(unsubscribe_html)
+ """.format(
+ unsubscribe_html
+ )
if expose_recipients == "footer":
text = "\n"
else:
text = ""
- text += "\n\n{unsubscribe_message}: \n".format(unsubscribe_message=unsubscribe_message)
+ text += "\n\n{unsubscribe_message}: \n".format(
+ unsubscribe_message=unsubscribe_message
+ )
+
+ return frappe._dict({"html": html, "text": text})
- return frappe._dict({
- "html": html,
- "text": text
- })
-def get_unsubcribed_url(reference_doctype, reference_name, email, unsubscribe_method, unsubscribe_params):
- params = {"email": email.encode("utf-8"),
+def get_unsubcribed_url(
+ reference_doctype, reference_name, email, unsubscribe_method, unsubscribe_params
+):
+ params = {
+ "email": email.encode("utf-8"),
"doctype": reference_doctype.encode("utf-8"),
- "name": reference_name.encode("utf-8")}
+ "name": reference_name.encode("utf-8"),
+ }
if unsubscribe_params:
params.update(unsubscribe_params)
@@ -105,6 +118,7 @@ def get_unsubcribed_url(reference_doctype, reference_name, email, unsubscribe_me
return get_url(unsubscribe_method + "?" + get_signed_params(params))
+
@frappe.whitelist(allow_guest=True)
def unsubscribe(doctype, name, email):
# unsubsribe from comments and communications
@@ -112,12 +126,14 @@ def unsubscribe(doctype, name, email):
return
try:
- frappe.get_doc({
- "doctype": "Email Unsubscribe",
- "email": email,
- "reference_doctype": doctype,
- "reference_name": name
- }).insert(ignore_permissions=True)
+ frappe.get_doc(
+ {
+ "doctype": "Email Unsubscribe",
+ "email": email,
+ "reference_doctype": doctype,
+ "reference_name": name,
+ }
+ ).insert(ignore_permissions=True)
except frappe.DuplicateEntryError:
frappe.db.rollback()
@@ -127,33 +143,39 @@ def unsubscribe(doctype, name, email):
return_unsubscribed_page(email, doctype, name)
+
def return_unsubscribed_page(email, doctype, name):
- frappe.respond_as_web_page(_("Unsubscribed"),
+ frappe.respond_as_web_page(
+ _("Unsubscribed"),
_("{0} has left the conversation in {1} {2}").format(email, _(doctype), name),
- indicator_color='green')
+ indicator_color="green",
+ )
+
def flush(from_test=False):
- """flush email queue, every time: called from scheduler
- """
+ """flush email queue, every time: called from scheduler"""
from frappe.email.doctype.email_queue.email_queue import send_mail
+
# To avoid running jobs inside unit tests
if frappe.are_emails_muted():
msgprint(_("Emails are muted"))
from_test = True
- if cint(frappe.defaults.get_defaults().get("hold_queue"))==1:
+ if cint(frappe.defaults.get_defaults().get("hold_queue")) == 1:
return
for row in get_queue():
try:
func = send_mail if from_test else send_mail.enqueue
is_background_task = not from_test
- func(email_queue_name = row.name, is_background_task = is_background_task)
+ func(email_queue_name=row.name, is_background_task=is_background_task)
except Exception:
frappe.log_error()
+
def get_queue():
- return frappe.db.sql('''select
+ return frappe.db.sql(
+ """select
name, sender
from
`tabEmail Queue`
@@ -162,7 +184,11 @@ def get_queue():
(send_after is null or send_after < %(now)s)
order
by priority desc, creation asc
- limit 500''', { 'now': now_datetime() }, as_dict=True)
+ limit 500""",
+ {"now": now_datetime()},
+ as_dict=True,
+ )
+
def clear_outbox(days: int = None) -> None:
"""Remove low priority older than 31 days in Outbox or configured in Log Settings.
@@ -171,22 +197,29 @@ def clear_outbox(days: int = None) -> None:
days = days or 31
email_queue = DocType("Email Queue")
- email_queues = frappe.qb.from_(email_queue).select(email_queue.name).where(
- email_queue.modified < (Now() - Interval(days=days))
- ).run(pluck=True)
+ email_queues = (
+ frappe.qb.from_(email_queue)
+ .select(email_queue.name)
+ .where(email_queue.modified < (Now() - Interval(days=days)))
+ .run(pluck=True)
+ )
if email_queues:
frappe.db.delete("Email Queue", {"name": ("in", email_queues)})
frappe.db.delete("Email Queue Recipient", {"parent": ("in", email_queues)})
+
def set_expiry_for_email_queue():
- ''' Mark emails as expire that has not sent for 7 days.
- Called daily via scheduler.
- '''
+ """Mark emails as expire that has not sent for 7 days.
+ Called daily via scheduler.
+ """
- frappe.db.sql("""
+ frappe.db.sql(
+ """
UPDATE `tabEmail Queue`
SET `status`='Expired'
WHERE `modified` < (NOW() - INTERVAL '7' DAY)
AND `status`='Not Sent'
- AND (`send_after` IS NULL OR `send_after` < %(now)s)""", { 'now': now_datetime() })
+ AND (`send_after` IS NULL OR `send_after` < %(now)s)""",
+ {"now": now_datetime()},
+ )
diff --git a/frappe/email/receive.py b/frappe/email/receive.py
index 8aa32fc1a5..4a6db65a84 100644
--- a/frappe/email/receive.py
+++ b/frappe/email/receive.py
@@ -5,10 +5,10 @@ import datetime
import email
import email.utils
import imaplib
+import json
import poplib
import re
import time
-import json
from email.header import decode_header
import _socket
@@ -17,28 +17,50 @@ from email_reply_parser import EmailReplyParser
import frappe
from frappe import _, safe_decode, safe_encode
-from frappe.core.doctype.file.file import (MaxFileSizeReachedError,
- get_random_filename)
-from frappe.utils import (cint, convert_utc_to_user_timezone, cstr,
- extract_email_id, markdown, now, parse_addr, strip, get_datetime,
- add_days, sanitize_html)
-from frappe.utils.user import is_system_user
+from frappe.core.doctype.file.file import MaxFileSizeReachedError, get_random_filename
+from frappe.utils import (
+ add_days,
+ cint,
+ convert_utc_to_user_timezone,
+ cstr,
+ extract_email_id,
+ get_datetime,
+ markdown,
+ now,
+ parse_addr,
+ sanitize_html,
+ strip,
+)
from frappe.utils.html_utils import clean_email_html
+from frappe.utils.user import is_system_user
# fix due to a python bug in poplib that limits it to 2048
poplib._MAXLINE = 20480
+class EmailSizeExceededError(frappe.ValidationError):
+ pass
+
+
+class EmailTimeoutError(frappe.ValidationError):
+ pass
+
+
+class TotalSizeExceededError(frappe.ValidationError):
+ pass
+
+
+class LoginLimitExceeded(frappe.ValidationError):
+ pass
+
-class EmailSizeExceededError(frappe.ValidationError): pass
-class EmailTimeoutError(frappe.ValidationError): pass
-class TotalSizeExceededError(frappe.ValidationError): pass
-class LoginLimitExceeded(frappe.ValidationError): pass
class SentEmailInInboxError(Exception):
pass
+
class EmailServer:
"""Wrapper for POP server to pull emails."""
+
def __init__(self, args=None):
self.setup(args)
@@ -65,25 +87,33 @@ class EmailServer:
"""Connect to IMAP"""
try:
if cint(self.settings.use_ssl):
- self.imap = Timed_IMAP4_SSL(self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout"))
+ self.imap = Timed_IMAP4_SSL(
+ self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout")
+ )
else:
- self.imap = Timed_IMAP4(self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout"))
+ self.imap = Timed_IMAP4(
+ self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout")
+ )
self.imap.login(self.settings.username, self.settings.password)
# connection established!
return True
except _socket.error:
# Invalid mail server -- due to refusing connection
- frappe.msgprint(_('Invalid Mail Server. Please rectify and try again.'))
+ frappe.msgprint(_("Invalid Mail Server. Please rectify and try again."))
raise
def connect_pop(self):
- #this method return pop connection
+ # this method return pop connection
try:
if cint(self.settings.use_ssl):
- self.pop = Timed_POP3_SSL(self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout"))
+ self.pop = Timed_POP3_SSL(
+ self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout")
+ )
else:
- self.pop = Timed_POP3(self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout"))
+ self.pop = Timed_POP3(
+ self.settings.host, self.settings.incoming_port, timeout=frappe.conf.get("pop_timeout")
+ )
self.pop.user(self.settings.username)
self.pop.pass_(self.settings.password)
@@ -96,7 +126,7 @@ class EmailServer:
frappe.log_error("receive.connect_pop")
# Invalid mail server -- due to refusing connection
- frappe.msgprint(_('Invalid Mail Server. Please rectify and try again.'))
+ frappe.msgprint(_("Invalid Mail Server. Please rectify and try again."))
raise
except poplib.error_proto as e:
@@ -104,12 +134,12 @@ class EmailServer:
return False
else:
- frappe.msgprint(_('Invalid User Name or Support Password. Please rectify and try again.'))
+ frappe.msgprint(_("Invalid User Name or Support Password. Please rectify and try again."))
raise
def select_imap_folder(self, folder):
res = self.imap.select(f'"{folder}"')
- return res[0] == 'OK' # The folder exsits TODO: handle other resoponses too
+ return res[0] == "OK" # The folder exsits TODO: handle other resoponses too
def logout(self):
if cint(self.settings.use_imap):
@@ -142,7 +172,8 @@ class EmailServer:
num = num_copy = len(email_list)
# WARNING: Hard coded max no. of messages to be popped
- if num > 50: num = 50
+ if num > 50:
+ num = 50
# size limits
self.total_size = 0
@@ -151,7 +182,7 @@ class EmailServer:
for i, message_meta in enumerate(email_list[:num]):
try:
- self.retrieve_message(message_meta, i+1)
+ self.retrieve_message(message_meta, i + 1)
except (TotalSizeExceededError, EmailTimeoutError, LoginLimitExceeded):
break
# WARNING: Mark as read - message number 101 onwards from the pop list
@@ -159,7 +190,7 @@ class EmailServer:
num = num_copy
if not cint(self.settings.use_imap):
if num > 100 and not self.errors:
- for m in range(101, num+1):
+ for m in range(101, num + 1):
self.pop.dele(m)
except Exception as e:
@@ -168,13 +199,11 @@ class EmailServer:
else:
raise
- out = { "latest_messages": self.latest_messages }
+ out = {"latest_messages": self.latest_messages}
if self.settings.use_imap:
- out.update({
- "uid_list": uid_list,
- "seen_status": self.seen_status,
- "uid_reindexed": self.uid_reindexed
- })
+ out.update(
+ {"uid_list": uid_list, "seen_status": self.seen_status, "uid_reindexed": self.uid_reindexed}
+ )
return out
@@ -187,9 +216,9 @@ class EmailServer:
readonly = False if self.settings.email_sync_rule == "UNSEEN" else True
self.imap.select(folder, readonly=readonly)
- response, message = self.imap.uid('search', None, self.settings.email_sync_rule)
+ response, message = self.imap.uid("search", None, self.settings.email_sync_rule)
if message[0]:
- email_list = message[0].split()
+ email_list = message[0].split()
else:
email_list = self.pop.list()[1]
@@ -208,25 +237,23 @@ class EmailServer:
if not uid_validity or uid_validity != current_uid_validity:
# uidvalidity changed & all email uids are reindexed by server
Communication = frappe.qb.DocType("Communication")
- frappe.qb.update(Communication) \
- .set(Communication.uid, -1) \
- .where(Communication.communication_medium == "Email") \
- .where(Communication.email_account == self.settings.email_account).run()
+ frappe.qb.update(Communication).set(Communication.uid, -1).where(
+ Communication.communication_medium == "Email"
+ ).where(Communication.email_account == self.settings.email_account).run()
if self.settings.use_imap:
# new update for the IMAP Folder DocType
IMAPFolder = frappe.qb.DocType("IMAP Folder")
- frappe.qb.update(IMAPFolder) \
- .set(IMAPFolder.uidvalidity, current_uid_validity) \
- .set(IMAPFolder.uidnext, uidnext) \
- .where(IMAPFolder.parent == self.settings.email_account_name) \
- .where(IMAPFolder.folder_name == folder).run()
+ frappe.qb.update(IMAPFolder).set(IMAPFolder.uidvalidity, current_uid_validity).set(
+ IMAPFolder.uidnext, uidnext
+ ).where(IMAPFolder.parent == self.settings.email_account_name).where(
+ IMAPFolder.folder_name == folder
+ ).run()
else:
EmailAccount = frappe.qb.DocType("Email Account")
- frappe.qb.update(EmailAccount) \
- .set(EmailAccount.uidvalidity, current_uid_validity) \
- .set(EmailAccount.uidnext, uidnext) \
- .where(EmailAccount.name == self.settings.email_account_name).run()
+ frappe.qb.update(EmailAccount).set(EmailAccount.uidvalidity, current_uid_validity).set(
+ EmailAccount.uidnext, uidnext
+ ).where(EmailAccount.name == self.settings.email_account_name).run()
# uid validity not found pulling emails for first time
if not uid_validity:
@@ -234,7 +261,9 @@ class EmailServer:
return
sync_count = 100 if uid_validity else int(self.settings.initial_sync_count)
- from_uid = 1 if uidnext < (sync_count + 1) or (uidnext - sync_count) < 1 else uidnext - sync_count
+ from_uid = (
+ 1 if uidnext < (sync_count + 1) or (uidnext - sync_count) < 1 else uidnext - sync_count
+ )
# sync last 100 email
self.settings.email_sync_rule = "UID {}:{}".format(from_uid, uidnext)
self.uid_reindexed = True
@@ -244,7 +273,7 @@ class EmailServer:
def parse_imap_response(self, cmd, response):
pattern = r"(?<={cmd} )[0-9]*".format(cmd=cmd)
- match = re.search(pattern, response.decode('utf-8'), re.U | re.I)
+ match = re.search(pattern, response.decode("utf-8"), re.U | re.I)
if match:
return match.group(0)
@@ -257,14 +286,14 @@ class EmailServer:
self.validate_message_limits(message_meta)
if cint(self.settings.use_imap):
- status, message = self.imap.uid('fetch', message_meta, '(BODY.PEEK[] BODY.PEEK[HEADER] FLAGS)')
+ status, message = self.imap.uid("fetch", message_meta, "(BODY.PEEK[] BODY.PEEK[HEADER] FLAGS)")
raw = message[0]
self.get_email_seen_status(message_meta, raw[0])
self.latest_messages.append(raw[1])
else:
msg = self.pop.retr(msg_num)
- self.latest_messages.append(b'\n'.join(msg[1]))
+ self.latest_messages.append(b"\n".join(msg[1]))
except (TotalSizeExceededError, EmailTimeoutError):
# propagate this error to break the loop
self.errors = True
@@ -286,17 +315,17 @@ class EmailServer:
else:
# mark as seen if email sync rule is UNSEEN (syncing only unseen mails)
if self.settings.email_sync_rule == "UNSEEN":
- self.imap.uid('STORE', message_meta, '+FLAGS', '(\\SEEN)')
+ self.imap.uid("STORE", message_meta, "+FLAGS", "(\\SEEN)")
else:
if not cint(self.settings.use_imap):
self.pop.dele(msg_num)
else:
# mark as seen if email sync rule is UNSEEN (syncing only unseen mails)
if self.settings.email_sync_rule == "UNSEEN":
- self.imap.uid('STORE', message_meta, '+FLAGS', '(\\SEEN)')
+ self.imap.uid("STORE", message_meta, "+FLAGS", "(\\SEEN)")
def get_email_seen_status(self, uid, flag_string):
- """ parse the email FLAGS response """
+ """parse the email FLAGS response"""
if not flag_string:
return None
@@ -307,9 +336,9 @@ class EmailServer:
flags.append(match.group(0))
if "Seen" in flags:
- self.seen_status.update({ uid: "SEEN" })
+ self.seen_status.update({uid: "SEEN"})
else:
- self.seen_status.update({ uid: "UNSEEN" })
+ self.seen_status.update({uid: "UNSEEN"})
def has_login_limit_exceeded(self, e):
return "-ERR Exceeded the login limit" in strip(cstr(e.message))
@@ -320,7 +349,7 @@ class EmailServer:
"Connection timed out",
)
for message in messages:
- if message in strip(cstr(e)) or message in strip(cstr(getattr(e, 'strerror', ''))):
+ if message in strip(cstr(e)) or message in strip(cstr(getattr(e, "strerror", ""))):
return True
return False
@@ -344,18 +373,19 @@ class EmailServer:
if not incoming_mail:
try:
# retrieve headers
- incoming_mail = Email(b'\n'.join(self.pop.top(msg_num, 5)[1]))
+ incoming_mail = Email(b"\n".join(self.pop.top(msg_num, 5)[1]))
except:
pass
if incoming_mail:
error_msg += "\nDate: {date}\nFrom: {from_email}\nSubject: {subject}\n".format(
- date=incoming_mail.date, from_email=incoming_mail.from_email, subject=incoming_mail.subject)
+ date=incoming_mail.date, from_email=incoming_mail.from_email, subject=incoming_mail.subject
+ )
return error_msg
def update_flag(self, folder, uid_list=None):
- """ set all uids mails the flag as seen """
+ """set all uids mails the flag as seen"""
if not uid_list:
return
@@ -364,16 +394,19 @@ class EmailServer:
self.imap.select(folder)
for uid, operation in uid_list.items():
- if not uid: continue
+ if not uid:
+ continue
op = "+FLAGS" if operation == "Read" else "-FLAGS"
try:
- self.imap.uid('STORE', uid, op, '(\\SEEN)')
+ self.imap.uid("STORE", uid, op, "(\\SEEN)")
except Exception:
continue
+
class Email:
"""Wrapper for an email."""
+
def __init__(self, content):
"""Parses headers, content, attachments from given raw message.
@@ -384,21 +417,21 @@ class Email:
self.mail = email.message_from_string(content)
self.raw_message = content
- self.text_content = ''
- self.html_content = ''
+ self.text_content = ""
+ self.html_content = ""
self.attachments = []
self.cid_map = {}
self.parse()
self.set_content_and_type()
self.set_subject()
self.set_from()
- self.message_id = (self.mail.get('Message-ID') or "").strip(" <>")
+ self.message_id = (self.mail.get("Message-ID") or "").strip(" <>")
if self.mail["Date"]:
try:
utc = email.utils.mktime_tz(email.utils.parsedate_tz(self.mail["Date"]))
utc_dt = datetime.datetime.utcfromtimestamp(utc)
- self.date = convert_utc_to_user_timezone(utc_dt).strftime('%Y-%m-%d %H:%M:%S')
+ self.date = convert_utc_to_user_timezone(utc_dt).strftime("%Y-%m-%d %H:%M:%S")
except:
self.date = now()
else:
@@ -434,7 +467,7 @@ class Email:
_from_email = self.decode_email(self.mail.get("X-Original-From") or self.mail["From"])
_reply_to = self.decode_email(self.mail.get("Reply-To"))
- if _reply_to and not frappe.db.get_value('Email Account', {"email_id":_reply_to}, 'email_id'):
+ if _reply_to and not frappe.db.get_value("Email Account", {"email_id": _reply_to}, "email_id"):
self.from_email = extract_email_id(_reply_to)
else:
self.from_email = extract_email_id(_from_email)
@@ -445,9 +478,12 @@ class Email:
self.from_real_name = parse_addr(_from_email)[0] if "@" in _from_email else _from_email
def decode_email(self, email):
- if not email: return
+ if not email:
+ return
decoded = ""
- for part, encoding in decode_header(frappe.as_unicode(email).replace("\""," ").replace("\'"," ")):
+ for part, encoding in decode_header(
+ frappe.as_unicode(email).replace('"', " ").replace("'", " ")
+ ):
if encoding:
decoded += part.decode(encoding)
else:
@@ -455,26 +491,29 @@ class Email:
return decoded
def set_content_and_type(self):
- self.content, self.content_type = '[Blank Email]', 'text/plain'
+ self.content, self.content_type = "[Blank Email]", "text/plain"
if self.html_content:
- self.content, self.content_type = self.html_content, 'text/html'
+ self.content, self.content_type = self.html_content, "text/html"
else:
- self.content, self.content_type = EmailReplyParser.read(self.text_content).text.replace("\n","\n\n"), 'text/plain'
+ self.content, self.content_type = (
+ EmailReplyParser.read(self.text_content).text.replace("\n", "\n\n"),
+ "text/plain",
+ )
def process_part(self, part):
"""Parse email `part` and set it to `text_content`, `html_content` or `attachments`."""
content_type = part.get_content_type()
- if content_type == 'text/plain':
+ if content_type == "text/plain":
self.text_content += self.get_payload(part)
- elif content_type == 'text/html':
+ elif content_type == "text/html":
self.html_content += self.get_payload(part)
- elif content_type == 'message/rfc822':
+ elif content_type == "message/rfc822":
# sent by outlook when another email is sent as an attachment to this email
self.show_attached_email_headers_in_content(part)
- elif part.get_filename() or 'image' in content_type:
+ elif part.get_filename() or "image" in content_type:
self.get_attachment(part)
def show_attached_email_headers_in_content(self, part):
@@ -486,15 +525,15 @@ class Email:
message = list(part.walk())[1]
headers = []
- for key in ('From', 'To', 'Subject', 'Date'):
+ for key in ("From", "To", "Subject", "Date"):
value = cstr(message.get(key))
if value:
- headers.append('{label}: {value}'.format(label=_(key), value=escape(value)))
+ headers.append("{label}: {value}".format(label=_(key), value=escape(value)))
- self.text_content += '\n'.join(headers)
- self.html_content += '
{0}
- ' + '\n'.join('
{0}
'.format(h) for h in headers) + self.text_content += "\n".join(headers) + self.html_content += "" + "\n".join("
{0}
".format(h) for h in headers) - if not message.is_multipart() and message.get_content_type()=='text/plain': + if not message.is_multipart() and message.get_content_type() == "text/plain": # email.parser didn't parse it! text_content = self.get_payload(message) self.text_content += text_content @@ -504,7 +543,7 @@ class Email: """Detect charset.""" charset = part.get_content_charset() if not charset: - charset = chardet.detect(safe_encode(cstr(part)))['encoding'] + charset = chardet.detect(safe_encode(cstr(part)))["encoding"] return charset @@ -517,7 +556,7 @@ class Email: return part.get_payload() def get_attachment(self, part): - #charset = self.get_charset(part) + # charset = self.get_charset(part) fcontent = part.get_payload(decode=True) if fcontent: @@ -525,18 +564,20 @@ class Email: fname = part.get_filename() if fname: try: - fname = fname.replace('\n', ' ').replace('\r', '') + fname = fname.replace("\n", " ").replace("\r", "") fname = cstr(decode_header(fname)[0][0]) except: fname = get_random_filename(content_type=content_type) else: fname = get_random_filename(content_type=content_type) - self.attachments.append({ - 'content_type': content_type, - 'fname': fname, - 'fcontent': fcontent, - }) + self.attachments.append( + { + "content_type": content_type, + "fname": fname, + "fcontent": fcontent, + } + ) cid = (cstr(part.get("Content-Id")) or "").strip("><") if cid: @@ -548,18 +589,21 @@ class Email: for attachment in self.attachments: try: - _file = frappe.get_doc({ - "doctype": "File", - "file_name": attachment['fname'], - "attached_to_doctype": doc.doctype, - "attached_to_name": doc.name, - "is_private": 1, - "content": attachment['fcontent']}) + _file = frappe.get_doc( + { + "doctype": "File", + "file_name": attachment["fname"], + "attached_to_doctype": doc.doctype, + "attached_to_name": doc.name, + "is_private": 1, + "content": attachment["fcontent"], + } + ) _file.save() saved_attachments.append(_file) - if attachment['fname'] in self.cid_map: - self.cid_map[_file.name] = self.cid_map[attachment['fname']] + if attachment["fname"] in self.cid_map: + self.cid_map[_file.name] = self.cid_map[attachment["fname"]] except MaxFileSizeReachedError: # WARNING: bypass max file size exception @@ -574,15 +618,16 @@ class Email: def get_thread_id(self): """Extract thread ID from `[]`""" - l = re.findall(r'(?<=\[)[\w/-]+', self.subject) + l = re.findall(r"(?<=\[)[\w/-]+", self.subject) return l and l[0] or None def is_reply(self): return bool(self.in_reply_to) + class InboundMail(Email): - """Class representation of incoming mail along with mail handlers. - """ + """Class representation of incoming mail along with mail handlers.""" + def __init__(self, content, email_account, uid=None, seen_status=None, append_to=None): super().__init__(content) self.email_account = email_account @@ -598,15 +643,14 @@ class InboundMail(Email): self.flags = frappe._dict() def get_content(self): - if self.content_type == 'text/html': + if self.content_type == "text/html": return clean_email_html(self.content) def process(self): - """Create communication record from email. - """ + """Create communication record from email.""" if self.is_sender_same_as_receiver() and not self.is_reply(): if frappe.flags.in_test: - print('WARN: Cannot pull email. Sender same as recipient inbox') + print("WARN: Cannot pull email. Sender same as recipient inbox") raise SentEmailInInboxError communication = self.is_exist_in_system() @@ -620,30 +664,30 @@ class InboundMail(Email): def _build_communication_doc(self): data = self.as_dict() - data['doctype'] = "Communication" + data["doctype"] = "Communication" if self.parent_communication(): - data['in_reply_to'] = self.parent_communication().name + data["in_reply_to"] = self.parent_communication().name append_to = self.append_to if self.email_account.use_imap else self.email_account.append_to if self.reference_document(): - data['reference_doctype'] = self.reference_document().doctype - data['reference_name'] = self.reference_document().name + data["reference_doctype"] = self.reference_document().doctype + data["reference_name"] = self.reference_document().name else: - if append_to and append_to != 'Communication': + if append_to and append_to != "Communication": reference_doc = self._create_reference_document(append_to) if reference_doc: - data['reference_doctype'] = reference_doc.doctype - data['reference_name'] = reference_doc.name - data['is_first'] = True + data["reference_doctype"] = reference_doc.doctype + data["reference_name"] = reference_doc.name + data["is_first"] = True if self.is_notification(): # Disable notifications for notification. - data['unread_notification_sent'] = 1 + data["unread_notification_sent"] = 1 if self.seen_status: - data['_seen'] = json.dumps(self.get_users_linked_to_account(self.email_account)) + data["_seen"] = json.dumps(self.get_users_linked_to_account(self.email_account)) communication = frappe.get_doc(data) communication.flags.in_receive = True @@ -660,8 +704,7 @@ class InboundMail(Email): content = self.content for file in attachments: if file.name in self.cid_map and self.cid_map[file.name]: - content = content.replace("cid:{0}".format(self.cid_map[file.name]), - file.file_url) + content = content.replace("cid:{0}".format(self.cid_map[file.name]), file.file_url) return content def is_notification(self): @@ -669,21 +712,19 @@ class InboundMail(Email): return isnotification and ("notification" in isnotification) def is_exist_in_system(self): - """Check if this email already exists in the system(as communication document). - """ + """Check if this email already exists in the system(as communication document).""" from frappe.core.doctype.communication.communication import Communication + if not self.message_id: return - return Communication.find_one_by_filters(message_id = self.message_id, - order_by = 'creation DESC') + return Communication.find_one_by_filters(message_id=self.message_id, order_by="creation DESC") def is_sender_same_as_receiver(self): return self.from_email == self.email_account.email_id def is_reply_to_system_sent_mail(self): - """Is it a reply to already sent mail. - """ + """Is it a reply to already sent mail.""" return self.is_reply() and frappe.local.site in self.in_reply_to def parent_email_queue(self): @@ -696,11 +737,11 @@ class InboundMail(Email): if self._parent_email_queue is not None: return self._parent_email_queue - parent_email_queue = '' + parent_email_queue = "" if self.is_reply_to_system_sent_mail(): parent_email_queue = EmailQueue.find_one_by_filters(message_id=self.in_reply_to) - self._parent_email_queue = parent_email_queue or '' + self._parent_email_queue = parent_email_queue or "" return self._parent_email_queue def parent_communication(self): @@ -710,30 +751,32 @@ class InboundMail(Email): Here are the cases to handle: 1. If mail is a reply to already sent mail, then we can get parent communicaion from - Email Queue record. + Email Queue record. 2. Sometimes we send communication name in message-ID directly, use that to get parent communication. 3. Sender sent a reply but reply is on top of what (s)he sent before, - then parent record exists directly in communication. + then parent record exists directly in communication. """ from frappe.core.doctype.communication.communication import Communication + if self._parent_communication is not None: return self._parent_communication if not self.is_reply(): - return '' + return "" if not self.is_reply_to_system_sent_mail(): - communication = Communication.find_one_by_filters(message_id=self.in_reply_to, - creation = ['>=', self.get_relative_dt(-30)]) + communication = Communication.find_one_by_filters( + message_id=self.in_reply_to, creation=[">=", self.get_relative_dt(-30)] + ) elif self.parent_email_queue() and self.parent_email_queue().communication: communication = Communication.find(self.parent_email_queue().communication, ignore_error=True) else: reference = self.in_reply_to - if '@' in self.in_reply_to: + if "@" in self.in_reply_to: reference, _ = self.in_reply_to.split("@", 1) communication = Communication.find(reference, ignore_error=True) - self._parent_communication = communication or '' + self._parent_communication = communication or "" return self._parent_communication def reference_document(self): @@ -755,14 +798,14 @@ class InboundMail(Email): if not reference_document and self.email_account.append_to: reference_document = self.match_record_by_subject_and_sender(self.email_account.append_to) - self._reference_document = reference_document or '' + self._reference_document = reference_document or "" return self._reference_document def get_reference_name_from_subject(self): """ Ex: "Re: Your email (#OPP-2020-2334343)" """ - return self.subject.rsplit('#', 1)[-1].strip(' ()') + return self.subject.rsplit("#", 1)[-1].strip(" ()") def match_record_by_subject_and_sender(self, doctype): """Find a record in the given doctype that matches with email subject and sender. @@ -771,12 +814,12 @@ class InboundMail(Email): 1. Sometimes record name is part of subject. We can get document by parsing name from subject 2. Find by matching sender and subject 3. Find by matching subject alone (Special case) - Ex: when a System User is using Outlook and replies to an email from their own client, - it reaches the Email Account with the threading info lost and the (sender + subject match) - doesn't work because the sender in the first communication was someone different to whom - the system user is replying to via the common email account in Frappe. This fix bypasses - the sender match when the sender is a system user and subject is atleast 10 chars long - (for additional safety) + Ex: when a System User is using Outlook and replies to an email from their own client, + it reaches the Email Account with the threading info lost and the (sender + subject match) + doesn't work because the sender in the first communication was someone different to whom + the system user is replying to via the common email account in Frappe. This fix bypasses + the sender match when the sender is a system user and subject is atleast 10 chars long + (for additional safety) NOTE: We consider not to match by subject if match record is very old. """ @@ -789,20 +832,19 @@ class InboundMail(Email): subject = self.clean_subject(self.subject) filters = { email_fields.subject_field: ("like", f"%{subject}%"), - "creation": (">", self.get_relative_dt(days=-60)) + "creation": (">", self.get_relative_dt(days=-60)), } # Sender check is not needed incase mail is from system user. if not (len(subject) > 10 and is_system_user(self.from_email)): filters[email_fields.sender_field] = self.from_email - name = frappe.db.get_value(self.email_account.append_to, filters = filters) + name = frappe.db.get_value(self.email_account.append_to, filters=filters) record = self.get_doc(doctype, name, ignore_error=True) if name else None return record def _create_reference_document(self, doctype): - """ Create reference document if it does not exist in the system. - """ + """Create reference document if it does not exist in the system.""" parent = frappe.new_doc(doctype) email_fileds = self.get_email_fields(doctype) @@ -818,8 +860,8 @@ class InboundMail(Email): parent.insert(ignore_permissions=True) except frappe.DuplicateEntryError: # try and find matching parent - parent_name = frappe.db.get_value(self.email_account.append_to, - {email_fileds.sender_field: self.from_email} + parent_name = frappe.db.get_value( + self.email_account.append_to, {email_fileds.sender_field: self.from_email} ) if parent_name: parent.name = parent_name @@ -827,7 +869,6 @@ class InboundMail(Email): parent = None return parent - @staticmethod def get_doc(doctype, docname, ignore_error=False): try: @@ -839,33 +880,30 @@ class InboundMail(Email): @staticmethod def get_relative_dt(days): - """Get relative to current datetime. Only relative days are supported. - """ + """Get relative to current datetime. Only relative days are supported.""" return add_days(get_datetime(), days) @staticmethod def get_users_linked_to_account(email_account): - """Get list of users who linked to Email account. - """ - users = frappe.get_all("User Email", filters={"email_account": email_account.name}, - fields=["parent"]) + """Get list of users who linked to Email account.""" + users = frappe.get_all( + "User Email", filters={"email_account": email_account.name}, fields=["parent"] + ) return list(set([user.get("parent") for user in users])) @staticmethod def clean_subject(subject): - """Remove Prefixes like 'fw', FWD', 're' etc from subject. - """ + """Remove Prefixes like 'fw', FWD', 're' etc from subject.""" # Match strings like "fw:", "re :" etc. regex = r"(^\s*(fw|fwd|wg)[^:]*:|\s*(re|aw)[^:]*:\s*)*" return frappe.as_unicode(strip(re.sub(regex, "", subject, 0, flags=re.IGNORECASE))) @staticmethod def get_email_fields(doctype): - """Returns Email related fields of a doctype. - """ + """Returns Email related fields of a doctype.""" fields = frappe._dict() - email_fields = ['subject_field', 'sender_field'] + email_fields = ["subject_field", "sender_field"] meta = frappe.get_meta(doctype) for field in email_fields: @@ -875,20 +913,18 @@ class InboundMail(Email): @staticmethod def get_document(self, doctype, name): - """Is same as frappe.get_doc but suppresses the DoesNotExist error. - """ + """Is same as frappe.get_doc but suppresses the DoesNotExist error.""" try: return frappe.get_doc(doctype, name) except frappe.DoesNotExistError: return None def as_dict(self): - """ - """ + """ """ return { "subject": self.subject, "content": self.get_content(), - 'text_content': self.text_content, + "text_content": self.text_content, "sent_or_received": "Received", "sender_full_name": self.from_real_name, "sender": self.from_email, @@ -900,12 +936,13 @@ class InboundMail(Email): "message_id": self.message_id, "communication_date": self.date, "has_attachment": 1 if self.attachments else 0, - "seen": self.seen_status or 0 + "seen": self.seen_status or 0, } + class TimerMixin(object): def __init__(self, *args, **kwargs): - self.timeout = kwargs.pop('timeout', 0.0) + self.timeout = kwargs.pop("timeout", 0.0) self.elapsed_time = 0.0 self._super.__init__(self, *args, **kwargs) if self.timeout: @@ -926,14 +963,18 @@ class TimerMixin(object): self.elapsed_time = 0.0 return self._super.quit(self, *args, **kwargs) + class Timed_POP3(TimerMixin, poplib.POP3): _super = poplib.POP3 + class Timed_POP3_SSL(TimerMixin, poplib.POP3_SSL): _super = poplib.POP3_SSL + class Timed_IMAP4(TimerMixin, imaplib.IMAP4): _super = imaplib.IMAP4 + class Timed_IMAP4_SSL(TimerMixin, imaplib.IMAP4_SSL): _super = imaplib.IMAP4_SSL diff --git a/frappe/email/smtp.py b/frappe/email/smtp.py index 6f73a73f11..1c91356506 100644 --- a/frappe/email/smtp.py +++ b/frappe/email/smtp.py @@ -1,28 +1,37 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe -import smtplib import email.utils -import _socket, sys +import smtplib +import sys + +import _socket + +import frappe from frappe import _ from frappe.utils import cint, cstr, parse_addr -CONNECTION_FAILED = _('Could not connect to outgoing email server') +CONNECTION_FAILED = _("Could not connect to outgoing email server") AUTH_ERROR_TITLE = _("Invalid Credentials") AUTH_ERROR = _("Incorrect email or password. Please check your login credentials.") SOCKET_ERROR_TITLE = _("Incorrect Configuration") SOCKET_ERROR = _("Invalid Outgoing Mail Server or Port") SEND_MAIL_FAILED = _("Unable to send emails at this time") -EMAIL_ACCOUNT_MISSING = _('Email Account not setup. Please create a new Email Account from Setup > Email > Email Account') +EMAIL_ACCOUNT_MISSING = _( + "Email Account not setup. Please create a new Email Account from Setup > Email > Email Account" +) + class InvalidEmailCredentials(frappe.ValidationError): pass + def send(email, append_to=None, retry=1): """Deprecated: Send the message or add it to Outbox Email""" + def _send(retry): from frappe.email.doctype.email_account.email_account import EmailAccount + try: email_account = EmailAccount.find_outgoing(match_by_doctype=append_to) smtpserver = email_account.get_smtp_server() @@ -32,10 +41,10 @@ def send(email, append_to=None, retry=1): smtpserver.sess.sendmail(email.sender, email.recipients + (email.cc or []), email_body) except smtplib.SMTPSenderRefused: - frappe.throw(_("Invalid login or password"), title='Email Failed') + frappe.throw(_("Invalid login or password"), title="Email Failed") raise except smtplib.SMTPRecipientsRefused: - frappe.msgprint(_("Invalid recipient address"), title='Email Failed') + frappe.msgprint(_("Invalid recipient address"), title="Email Failed") raise except (smtplib.SMTPServerDisconnected, smtplib.SMTPAuthenticationError): if not retry: @@ -46,6 +55,7 @@ def send(email, append_to=None, retry=1): _send(retry) + class SMTPServer: def __init__(self, server, login=None, password=None, port=None, use_tls=None, use_ssl=None): self.login = login @@ -69,8 +79,7 @@ class SMTPServer: return cstr(self._server or "") def secure_session(self, conn): - """Secure the connection incase of TLS. - """ + """Secure the connection incase of TLS.""" if self.use_tls: conn.ehlo() conn.starttls() @@ -93,7 +102,7 @@ class SMTPServer: res = _session.login(str(self.login or ""), str(self.password or "")) # check if logged correctly - if res[0]!=235: + if res[0] != 235: frappe.msgprint(res[1], raise_exception=frappe.OutgoingEmailError) self._session = _session diff --git a/frappe/email/test_email_body.py b/frappe/email/test_email_body.py index c542bc2578..3de21f64ce 100644 --- a/frappe/email/test_email_body.py +++ b/frappe/email/test_email_body.py @@ -1,83 +1,96 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import unittest, os, base64 +import base64 +import os +import unittest + from frappe import safe_decode +from frappe.email.doctype.email_queue.email_queue import QueueBuilder, SendMailContext +from frappe.email.email_body import ( + get_email, + get_header, + inline_style_in_html, + replace_filename_with_cid, +) from frappe.email.receive import Email -from frappe.email.email_body import (replace_filename_with_cid, - get_email, inline_style_in_html, get_header) -from frappe.email.doctype.email_queue.email_queue import SendMailContext, QueueBuilder class TestEmailBody(unittest.TestCase): def setUp(self): - email_html = ''' + email_html = """Hey John Doe!
This is embedded image you asked for
' + uni_chr1 + 'abcd' + uni_chr2 + '
', - text_content='whatever').process()[0] - mail_ctx = SendMailContext(queue_doc = queue_doc) - result = mail_ctx.build_message(recipient_email = 'test@test.com') + recipients=["test@example.com"], + sender="me@example.com", + subject="Test Subject", + message="" + uni_chr1 + "abcd" + uni_chr2 + "
", + text_content="whatever", + ).process()[0] + mail_ctx = SendMailContext(queue_doc=queue_doc) + result = mail_ctx.build_message(recipient_email="test@test.com") self.assertTrue(b"=EA=80=80abcd=DE=B4
" in result) def test_prepare_message_returns_cr_lf(self): queue_doc = QueueBuilder( - recipients=['test@example.com'], - sender='me@example.com', - subject='Test Subject', - message='\n this is a test of newlines\n' + '
', - text_content='whatever').process()[0] + recipients=["test@example.com"], + sender="me@example.com", + subject="Test Subject", + message="\n this is a test of newlines\n" + "
", + text_content="whatever", + ).process()[0] - mail_ctx = SendMailContext(queue_doc = queue_doc) - result = safe_decode(mail_ctx.build_message(recipient_email='test@test.com')) + mail_ctx = SendMailContext(queue_doc=queue_doc) + result = safe_decode(mail_ctx.build_message(recipient_email="test@test.com")) - self.assertTrue(result.count('\n') == result.count("\r")) + self.assertTrue(result.count("\n") == result.count("\r")) def test_image(self): - img_signature = ''' + img_signature = """ Content-Type: image/svg+xml MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline; filename="frappe-favicon.svg" -''' +""" self.assertTrue(img_signature in self.email_string) self.assertTrue(self.img_base64 in self.email_string) def test_text_content(self): - text_content = ''' + text_content = """ Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable @@ -85,11 +98,11 @@ Content-Transfer-Encoding: quoted-printable Hey John Doe! This is the text version of this email -''' +""" self.assertTrue(text_content in self.email_string) def test_email_content(self): - html_head = ''' + html_head = """ Content-Type: text/html; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable @@ -97,84 +110,93 @@ Content-Transfer-Encoding: quoted-printable -''' +""" - html = '''Hey John Doe!
''' + html = """Hey John Doe!
""" self.assertTrue(html_head in self.email_string) self.assertTrue(html in self.email_string) def test_replace_filename_with_cid(self): - original_message = ''' + original_message = """Hi John
This is a test email
-''' - transformed_html = ''' +""" + transformed_html = """Hi John
This is a test email
-''' +""" self.assertTrue(transformed_html in inline_style_in_html(html)) def test_email_header(self): - email_html = ''' + email_html = """Hey John Doe!
This is embedded image you asked for
-''' - email_string = get_email( - recipients=['test@example.com'], - sender='me@example.com', - subject='Test Subject', - content=email_html, - header=['Email Title', 'green'] - ).as_string().replace("\r\n", "\n") +""" + email_string = ( + get_email( + recipients=["test@example.com"], + sender="me@example.com", + subject="Test Subject", + content=email_html, + header=["Email Title", "green"], + ) + .as_string() + .replace("\r\n", "\n") + ) # REDESIGN-TODO: Add style for indicators in email - self.assertTrue('''''' in email_string) - self.assertTrue('Email Title' in email_string) + self.assertTrue("""""" in email_string) + self.assertTrue("Email Title" in email_string) def test_get_email_header(self): - html = get_header(['This is test', 'orange']) + html = get_header(["This is test", "orange"]) self.assertTrue('' in html) - self.assertTrue('This is test' in html) + self.assertTrue("This is test" in html) - html = get_header(['This is another test']) - self.assertTrue('This is another test' in html) + html = get_header(["This is another test"]) + self.assertTrue("This is another test" in html) - html = get_header('This is string') - self.assertTrue('This is string' in html) + html = get_header("This is string") + self.assertTrue("This is string" in html) def test_8bit_utf_8_decoding(self): text_content_bytes = b"\xed\x95\x9c\xea\xb8\x80\xe1\xa5\xa1\xe2\x95\xa5\xe0\xba\xaa\xe0\xa4\x8f" - text_content = text_content_bytes.decode('utf-8') + text_content = text_content_bytes.decode("utf-8") - content_bytes = b"""MIME-Version: 1.0 + content_bytes = ( + b"""MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit From: test1_@erpnext.com Reply-To: test2_@erpnext.com -""" + text_content_bytes +""" + + text_content_bytes + ) mail = Email(content_bytes) self.assertEqual(mail.text_content, text_content) def fixed_column_width(string, chunk_size): - parts = [string[0 + i:chunk_size + i] for i in range(0, len(string), chunk_size)] - return '\n'.join(parts) + parts = [string[0 + i : chunk_size + i] for i in range(0, len(string), chunk_size)] + return "\n".join(parts) diff --git a/frappe/email/test_smtp.py b/frappe/email/test_smtp.py index 127bdd44ce..448f61925c 100644 --- a/frappe/email/test_smtp.py +++ b/frappe/email/test_smtp.py @@ -2,9 +2,11 @@ # License: The MIT License import unittest + import frappe -from frappe.email.smtp import SMTPServer from frappe.email.doctype.email_account.email_account import EmailAccount +from frappe.email.smtp import SMTPServer + class TestSMTP(unittest.TestCase): def test_smtp_ssl_session(self): @@ -16,65 +18,72 @@ class TestSMTP(unittest.TestCase): make_server(port, 0, 1) def test_get_email_account(self): - existing_email_accounts = frappe.get_all("Email Account", fields = ["name", "enable_outgoing", "default_outgoing","append_to", "use_imap"]) - unset_details = { - "enable_outgoing": 0, - "default_outgoing": 0, - "append_to": None, - "use_imap": 0 - } + existing_email_accounts = frappe.get_all( + "Email Account", fields=["name", "enable_outgoing", "default_outgoing", "append_to", "use_imap"] + ) + unset_details = {"enable_outgoing": 0, "default_outgoing": 0, "append_to": None, "use_imap": 0} for email_account in existing_email_accounts: - frappe.db.set_value('Email Account', email_account['name'], unset_details) + frappe.db.set_value("Email Account", email_account["name"], unset_details) # remove mail_server config so that test@example.com is not created - mail_server = frappe.conf.get('mail_server') - del frappe.conf['mail_server'] + mail_server = frappe.conf.get("mail_server") + del frappe.conf["mail_server"] frappe.local.outgoing_email_account = {} frappe.local.outgoing_email_account = {} # lowest preference given to email account with default incoming enabled - create_email_account(email_id="default_outgoing_enabled@gmail.com", password="password", enable_outgoing = 1, default_outgoing=1) + create_email_account( + email_id="default_outgoing_enabled@gmail.com", + password="password", + enable_outgoing=1, + default_outgoing=1, + ) self.assertEqual(EmailAccount.find_outgoing().email_id, "default_outgoing_enabled@gmail.com") frappe.local.outgoing_email_account = {} # highest preference given to email account with append_to matching - create_email_account(email_id="append_to@gmail.com", password="password", enable_outgoing = 1, default_outgoing=1, append_to="Blog Post") - self.assertEqual(EmailAccount.find_outgoing(match_by_doctype="Blog Post").email_id, "append_to@gmail.com") + create_email_account( + email_id="append_to@gmail.com", + password="password", + enable_outgoing=1, + default_outgoing=1, + append_to="Blog Post", + ) + self.assertEqual( + EmailAccount.find_outgoing(match_by_doctype="Blog Post").email_id, "append_to@gmail.com" + ) # add back the mail_server - frappe.conf['mail_server'] = mail_server + frappe.conf["mail_server"] = mail_server for email_account in existing_email_accounts: set_details = { - "enable_outgoing": email_account['enable_outgoing'], - "default_outgoing": email_account['default_outgoing'], - "append_to": email_account['append_to'] + "enable_outgoing": email_account["enable_outgoing"], + "default_outgoing": email_account["default_outgoing"], + "append_to": email_account["append_to"], } - frappe.db.set_value('Email Account', email_account['name'], set_details) + frappe.db.set_value("Email Account", email_account["name"], set_details) + def create_email_account(email_id, password, enable_outgoing, default_outgoing=0, append_to=None): email_dict = { "email_id": email_id, "passsword": password, - "enable_outgoing":enable_outgoing , - "default_outgoing":default_outgoing , + "enable_outgoing": enable_outgoing, + "default_outgoing": default_outgoing, "enable_incoming": 1, - "append_to":append_to, + "append_to": append_to, "is_dummy_password": 1, "smtp_server": "localhost", - "use_imap": 0 + "use_imap": 0, } - email_account = frappe.new_doc('Email Account') + email_account = frappe.new_doc("Email Account") email_account.update(email_dict) email_account.save() + def make_server(port, ssl, tls): - server = SMTPServer( - server = "smtp.gmail.com", - port = port, - use_ssl = ssl, - use_tls = tls - ) + server = SMTPServer(server="smtp.gmail.com", port=port, use_ssl=ssl, use_tls=tls) server.session diff --git a/frappe/email/utils.py b/frappe/email/utils.py index 1138698491..147284a625 100644 --- a/frappe/email/utils.py +++ b/frappe/email/utils.py @@ -1,15 +1,17 @@ # Copyright (c) 2019, Frappe Technologies Pvt. Ltd. and contributors # License: MIT. See LICENSE -import imaplib, poplib +import imaplib +import poplib from frappe.utils import cint + def get_port(doc): if not doc.incoming_port: if doc.use_imap: - doc.incoming_port = imaplib.IMAP4_SSL_PORT if doc.use_ssl else imaplib.IMAP4_PORT + doc.incoming_port = imaplib.IMAP4_SSL_PORT if doc.use_ssl else imaplib.IMAP4_PORT else: - doc.incoming_port = poplib.POP3_SSL_PORT if doc.use_ssl else poplib.POP3_PORT + doc.incoming_port = poplib.POP3_SSL_PORT if doc.use_ssl else poplib.POP3_PORT - return cint(doc.incoming_port) \ No newline at end of file + return cint(doc.incoming_port) diff --git a/frappe/event_streaming/doctype/document_type_mapping/document_type_mapping.py b/frappe/event_streaming/doctype/document_type_mapping/document_type_mapping.py index 0565b3219d..bcd2b275d1 100644 --- a/frappe/event_streaming/doctype/document_type_mapping/document_type_mapping.py +++ b/frappe/event_streaming/doctype/document_type_mapping/document_type_mapping.py @@ -1,11 +1,13 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe import json + +import frappe from frappe import _ +from frappe.model import child_table_fields, default_fields from frappe.model.document import Document -from frappe.model import default_fields, child_table_fields + class DocumentTypeMapping(Document): def validate(self): @@ -17,19 +19,21 @@ class DocumentTypeMapping(Document): if field_map.local_fieldname not in (default_fields + child_table_fields): field = meta.get_field(field_map.local_fieldname) if not field: - frappe.throw(_('Row #{0}: Invalid Local Fieldname').format(field_map.idx)) + frappe.throw(_("Row #{0}: Invalid Local Fieldname").format(field_map.idx)) - fieldtype = field.get('fieldtype') - if fieldtype in ['Link', 'Dynamic Link', 'Table']: + fieldtype = field.get("fieldtype") + if fieldtype in ["Link", "Dynamic Link", "Table"]: if not field_map.mapping and not field_map.default_value: - msg = _('Row #{0}: Please set Mapping or Default Value for the field {1} since its a dependency field').format( - field_map.idx, frappe.bold(field_map.local_fieldname)) - frappe.throw(msg, title='Inner Mapping Missing') + msg = _( + "Row #{0}: Please set Mapping or Default Value for the field {1} since its a dependency field" + ).format(field_map.idx, frappe.bold(field_map.local_fieldname)) + frappe.throw(msg, title="Inner Mapping Missing") - if field_map.mapping_type == 'Document' and not field_map.remote_value_filters: - msg = _('Row #{0}: Please set remote value filters for the field {1} to fetch the unique remote dependency document').format( - field_map.idx, frappe.bold(field_map.remote_fieldname)) - frappe.throw(msg, title='Remote Value Filters Missing') + if field_map.mapping_type == "Document" and not field_map.remote_value_filters: + msg = _( + "Row #{0}: Please set remote value filters for the field {1} to fetch the unique remote dependency document" + ).format(field_map.idx, frappe.bold(field_map.remote_fieldname)) + frappe.throw(msg, title="Remote Value Filters Missing") def get_mapping(self, doc, producer_site, update_type): remote_fields = [] @@ -38,7 +42,7 @@ class DocumentTypeMapping(Document): for mapping in self.field_mapping: if doc.get(mapping.remote_fieldname): - if mapping.mapping_type == 'Document': + if mapping.mapping_type == "Document": if not mapping.default_value: dependency = self.get_mapped_dependency(mapping, producer_site, doc) if dependency: @@ -46,8 +50,10 @@ class DocumentTypeMapping(Document): else: doc[mapping.local_fieldname] = mapping.default_value - if mapping.mapping_type == 'Child Table' and update_type != 'Update': - doc[mapping.local_fieldname] = get_mapped_child_table_docs(mapping.mapping, doc[mapping.remote_fieldname], producer_site) + if mapping.mapping_type == "Child Table" and update_type != "Update": + doc[mapping.local_fieldname] = get_mapped_child_table_docs( + mapping.mapping, doc[mapping.remote_fieldname], producer_site + ) else: # copy value into local fieldname key and remove remote fieldname key doc[mapping.local_fieldname] = doc[mapping.remote_fieldname] @@ -55,75 +61,75 @@ class DocumentTypeMapping(Document): if mapping.local_fieldname != mapping.remote_fieldname: remote_fields.append(mapping.remote_fieldname) - if not doc.get(mapping.remote_fieldname) and mapping.default_value and update_type != 'Update': + if not doc.get(mapping.remote_fieldname) and mapping.default_value and update_type != "Update": doc[mapping.local_fieldname] = mapping.default_value - #remove the remote fieldnames + # remove the remote fieldnames for field in remote_fields: doc.pop(field, None) - if update_type != 'Update': - doc['doctype'] = self.local_doctype + if update_type != "Update": + doc["doctype"] = self.local_doctype - mapping = {'doc': frappe.as_json(doc)} + mapping = {"doc": frappe.as_json(doc)} if len(dependencies): - mapping['dependencies'] = dependencies + mapping["dependencies"] = dependencies return mapping - def get_mapped_update(self, update, producer_site): update_diff = frappe._dict(json.loads(update.data)) mapping = update_diff dependencies = [] if update_diff.changed: - doc_map = self.get_mapping(update_diff.changed, producer_site, 'Update') - mapped_doc = doc_map.get('doc') + doc_map = self.get_mapping(update_diff.changed, producer_site, "Update") + mapped_doc = doc_map.get("doc") mapping.changed = json.loads(mapped_doc) - if doc_map.get('dependencies'): - dependencies += doc_map.get('dependencies') + if doc_map.get("dependencies"): + dependencies += doc_map.get("dependencies") if update_diff.removed: mapping = self.map_rows_removed(update_diff, mapping) if update_diff.added: - mapping = self.map_rows(update_diff, mapping, producer_site, operation='added') + mapping = self.map_rows(update_diff, mapping, producer_site, operation="added") if update_diff.row_changed: - mapping = self.map_rows(update_diff, mapping, producer_site, operation='row_changed') + mapping = self.map_rows(update_diff, mapping, producer_site, operation="row_changed") - update = {'doc': frappe.as_json(mapping)} + update = {"doc": frappe.as_json(mapping)} if len(dependencies): - update['dependencies'] = dependencies + update["dependencies"] = dependencies return update def get_mapped_dependency(self, mapping, producer_site, doc): - inner_mapping = frappe.get_doc('Document Type Mapping', mapping.mapping) + inner_mapping = frappe.get_doc("Document Type Mapping", mapping.mapping) filters = json.loads(mapping.remote_value_filters) for key, value in filters.items(): - if value.startswith('eval:'): + if value.startswith("eval:"): val = frappe.safe_eval(value[5:], None, dict(doc=doc)) filters[key] = val if doc.get(value): filters[key] = doc.get(value) matching_docs = producer_site.get_doc(inner_mapping.remote_doctype, filters=filters) if len(matching_docs): - remote_docname = matching_docs[0].get('name') + remote_docname = matching_docs[0].get("name") remote_doc = producer_site.get_doc(inner_mapping.remote_doctype, remote_docname) - doc = inner_mapping.get_mapping(remote_doc, producer_site, 'Insert').get('doc') + doc = inner_mapping.get_mapping(remote_doc, producer_site, "Insert").get("doc") return doc return def map_rows_removed(self, update_diff, mapping): removed = [] - mapping['removed'] = update_diff.removed + mapping["removed"] = update_diff.removed for key, value in update_diff.removed.copy().items(): - local_table_name = frappe.db.get_value('Document Type Field Mapping', { - 'remote_fieldname': key, - 'parent': self.name - },'local_fieldname') + local_table_name = frappe.db.get_value( + "Document Type Field Mapping", + {"remote_fieldname": key, "parent": self.name}, + "local_fieldname", + ) mapping.removed[local_table_name] = value if local_table_name != key: removed.append(key) - #remove the remote fieldnames + # remove the remote fieldnames for field in removed: mapping.removed.pop(field, None) return mapping @@ -131,12 +137,18 @@ class DocumentTypeMapping(Document): def map_rows(self, update_diff, mapping, producer_site, operation): remote_fields = [] for tablename, entries in update_diff.get(operation).copy().items(): - local_table_name = frappe.db.get_value('Document Type Field Mapping', {'remote_fieldname': tablename}, 'local_fieldname') - table_map = frappe.db.get_value('Document Type Field Mapping', {'local_fieldname': local_table_name, 'parent': self.name}, 'mapping') - table_map = frappe.get_doc('Document Type Mapping', table_map) + local_table_name = frappe.db.get_value( + "Document Type Field Mapping", {"remote_fieldname": tablename}, "local_fieldname" + ) + table_map = frappe.db.get_value( + "Document Type Field Mapping", + {"local_fieldname": local_table_name, "parent": self.name}, + "mapping", + ) + table_map = frappe.get_doc("Document Type Mapping", table_map) docs = [] for entry in entries: - mapped_doc = table_map.get_mapping(entry, producer_site, 'Update').get('doc') + mapped_doc = table_map.get_mapping(entry, producer_site, "Update").get("doc") docs.append(json.loads(mapped_doc)) mapping.get(operation)[local_table_name] = docs if local_table_name != tablename: @@ -148,9 +160,10 @@ class DocumentTypeMapping(Document): return mapping + def get_mapped_child_table_docs(child_map, table_entries, producer_site): """Get mapping for child doctypes""" - child_map = frappe.get_doc('Document Type Mapping', child_map) + child_map = frappe.get_doc("Document Type Mapping", child_map) mapped_entries = [] remote_fields = [] for child_doc in table_entries: @@ -161,9 +174,9 @@ def get_mapped_child_table_docs(child_map, table_entries, producer_site): child_doc.pop(mapping.remote_fieldname, None) mapped_entries.append(child_doc) - #remove the remote fieldnames + # remove the remote fieldnames for field in remote_fields: child_doc.pop(field, None) - child_doc['doctype'] = child_map.local_doctype + child_doc["doctype"] = child_map.local_doctype return mapped_entries diff --git a/frappe/event_streaming/doctype/document_type_mapping/test_document_type_mapping.py b/frappe/event_streaming/doctype/document_type_mapping/test_document_type_mapping.py index a277139985..1d5c4862de 100644 --- a/frappe/event_streaming/doctype/document_type_mapping/test_document_type_mapping.py +++ b/frappe/event_streaming/doctype/document_type_mapping/test_document_type_mapping.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestDocumentTypeMapping(unittest.TestCase): pass diff --git a/frappe/event_streaming/doctype/event_consumer/event_consumer.py b/frappe/event_streaming/doctype/event_consumer/event_consumer.py index e8b84d1345..287a1fca03 100644 --- a/frappe/event_streaming/doctype/event_consumer/event_consumer.py +++ b/frappe/event_streaming/doctype/event_consumer/event_consumer.py @@ -2,24 +2,26 @@ # Copyright (c) 2019, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe import json -import requests import os + +import requests + +import frappe from frappe import _ -from frappe.model.document import Document from frappe.frappeclient import FrappeClient -from frappe.utils.data import get_url +from frappe.model.document import Document from frappe.utils.background_jobs import get_jobs +from frappe.utils.data import get_url class EventConsumer(Document): def validate(self): # approve subscribed doctypes for tests # frappe.flags.in_test won't work here as tests are running on the consumer site - if os.environ.get('CI'): + if os.environ.get("CI"): for entry in self.consumer_doctypes: - entry.status = 'Approved' + entry.status = "Approved" def on_update(self): if not self.incoming_change: @@ -29,28 +31,32 @@ class EventConsumer(Document): self.update_consumer_status() else: - frappe.db.set_value(self.doctype, self.name, 'incoming_change', 0) + frappe.db.set_value(self.doctype, self.name, "incoming_change", 0) - frappe.cache().delete_value('event_consumer_document_type_map') + frappe.cache().delete_value("event_consumer_document_type_map") def on_trash(self): - for i in frappe.get_all('Event Update Log Consumer', {'consumer': self.name}): - frappe.delete_doc('Event Update Log Consumer', i.name) - frappe.cache().delete_value('event_consumer_document_type_map') + for i in frappe.get_all("Event Update Log Consumer", {"consumer": self.name}): + frappe.delete_doc("Event Update Log Consumer", i.name) + frappe.cache().delete_value("event_consumer_document_type_map") def update_consumer_status(self): consumer_site = get_consumer_site(self.callback_url) - event_producer = consumer_site.get_doc('Event Producer', get_url()) + event_producer = consumer_site.get_doc("Event Producer", get_url()) event_producer = frappe._dict(event_producer) config = event_producer.producer_doctypes event_producer.producer_doctypes = [] for entry in config: - if entry.get('has_mapping'): - ref_doctype = consumer_site.get_value('Document Type Mapping', 'remote_doctype', entry.get('mapping')).get('remote_doctype') + if entry.get("has_mapping"): + ref_doctype = consumer_site.get_value( + "Document Type Mapping", "remote_doctype", entry.get("mapping") + ).get("remote_doctype") else: - ref_doctype = entry.get('ref_doctype') + ref_doctype = entry.get("ref_doctype") - entry['status'] = frappe.db.get_value('Event Consumer Document Type', {'parent': self.name, 'ref_doctype': ref_doctype}, 'status') + entry["status"] = frappe.db.get_value( + "Event Consumer Document Type", {"parent": self.name, "ref_doctype": ref_doctype}, "status" + ) event_producer.producer_doctypes = config # when producer doc is updated it updates the consumer doc @@ -61,38 +67,38 @@ class EventConsumer(Document): def get_consumer_status(self): response = requests.get(self.callback_url) if response.status_code != 200: - return 'offline' - return 'online' + return "offline" + return "online" + @frappe.whitelist() def register_consumer(data): """create an event consumer document for registering a consumer""" data = json.loads(data) # to ensure that consumer is created only once - if frappe.db.exists('Event Consumer', data['event_consumer']): + if frappe.db.exists("Event Consumer", data["event_consumer"]): return None - user = data['user'] - if not frappe.db.exists('User', user): - frappe.throw(_('User {0} not found on the producer site').format(user)) + user = data["user"] + if not frappe.db.exists("User", user): + frappe.throw(_("User {0} not found on the producer site").format(user)) if "System Manager" not in frappe.get_roles(user): frappe.throw(_("Event Subscriber has to be a System Manager.")) - consumer = frappe.new_doc('Event Consumer') - consumer.callback_url = data['event_consumer'] - consumer.user = data['user'] - consumer.api_key = data['api_key'] - consumer.api_secret = data['api_secret'] + consumer = frappe.new_doc("Event Consumer") + consumer.callback_url = data["event_consumer"] + consumer.user = data["user"] + consumer.api_key = data["api_key"] + consumer.api_secret = data["api_secret"] consumer.incoming_change = True - consumer_doctypes = json.loads(data['consumer_doctypes']) + consumer_doctypes = json.loads(data["consumer_doctypes"]) for entry in consumer_doctypes: - consumer.append('consumer_doctypes', { - 'ref_doctype': entry.get('doctype'), - 'status': 'Pending', - 'condition': entry.get('condition') - }) + consumer.append( + "consumer_doctypes", + {"ref_doctype": entry.get("doctype"), "status": "Pending", "condition": entry.get("condition")}, + ) consumer.insert() @@ -100,23 +106,25 @@ def register_consumer(data): # in producer's update log when subscribing # so that, updates after subscribing are consumed and not the old ones. last_update = str(get_last_update()) - return json.dumps({'last_update': last_update}) + return json.dumps({"last_update": last_update}) def get_consumer_site(consumer_url): """create a FrappeClient object for event consumer site""" - consumer_doc = frappe.get_doc('Event Consumer', consumer_url) + consumer_doc = frappe.get_doc("Event Consumer", consumer_url) consumer_site = FrappeClient( url=consumer_url, api_key=consumer_doc.api_key, - api_secret=consumer_doc.get_password('api_secret') + api_secret=consumer_doc.get_password("api_secret"), ) return consumer_site def get_last_update(): """get the creation timestamp of last update consumed""" - updates = frappe.get_list('Event Update Log', 'creation', ignore_permissions=True, limit=1, order_by='creation desc') + updates = frappe.get_list( + "Event Update Log", "creation", ignore_permissions=True, limit=1, order_by="creation desc" + ) if updates: return updates[0].creation return frappe.utils.now_datetime() @@ -125,9 +133,11 @@ def get_last_update(): @frappe.whitelist() def notify_event_consumers(doctype): """get all event consumers and set flag for notification status""" - event_consumers = frappe.get_all('Event Consumer Document Type', ['parent'], {'ref_doctype': doctype, 'status': 'Approved'}) + event_consumers = frappe.get_all( + "Event Consumer Document Type", ["parent"], {"ref_doctype": doctype, "status": "Approved"} + ) for entry in event_consumers: - consumer = frappe.get_doc('Event Consumer', entry.parent) + consumer = frappe.get_doc("Event Consumer", entry.parent) consumer.flags.notified = False notify(consumer) @@ -136,13 +146,15 @@ def notify_event_consumers(doctype): def notify(consumer): """notify individual event consumers about a new update""" consumer_status = consumer.get_consumer_status() - if consumer_status == 'online': + if consumer_status == "online": try: client = get_consumer_site(consumer.callback_url) - client.post_request({ - 'cmd': 'frappe.event_streaming.doctype.event_producer.event_producer.new_event_notification', - 'producer_url': get_url() - }) + client.post_request( + { + "cmd": "frappe.event_streaming.doctype.event_producer.event_producer.new_event_notification", + "producer_url": get_url(), + } + ) consumer.flags.notified = True except Exception: consumer.flags.notified = False @@ -151,35 +163,37 @@ def notify(consumer): # enqueue another job if the site was not notified if not consumer.flags.notified: - enqueued_method = 'frappe.event_streaming.doctype.event_consumer.event_consumer.notify' + enqueued_method = "frappe.event_streaming.doctype.event_consumer.event_consumer.notify" jobs = get_jobs() if not jobs or enqueued_method not in jobs[frappe.local.site] and not consumer.flags.notifed: - frappe.enqueue(enqueued_method, queue='long', enqueue_after_commit=True, **{'consumer': consumer}) + frappe.enqueue( + enqueued_method, queue="long", enqueue_after_commit=True, **{"consumer": consumer} + ) def has_consumer_access(consumer, update_log): """Checks if consumer has completely satisfied all the conditions on the doc""" if isinstance(consumer, str): - consumer = frappe.get_doc('Event Consumer', consumer) + consumer = frappe.get_doc("Event Consumer", consumer) if not frappe.db.exists(update_log.ref_doctype, update_log.docname): # Delete Log # Check if the last Update Log of this document was read by this consumer last_update_log = frappe.get_all( - 'Event Update Log', + "Event Update Log", filters={ - 'ref_doctype': update_log.ref_doctype, - 'docname': update_log.docname, - 'creation': ['<', update_log.creation] + "ref_doctype": update_log.ref_doctype, + "docname": update_log.docname, + "creation": ["<", update_log.creation], }, - order_by='creation desc', - limit_page_length=1 + order_by="creation desc", + limit_page_length=1, ) if not len(last_update_log): return False - last_update_log = frappe.get_doc('Event Update Log', last_update_log[0].name) + last_update_log = frappe.get_doc("Event Update Log", last_update_log[0].name) return len([x for x in last_update_log.consumers if x.consumer == consumer.name]) doc = frappe.get_doc(update_log.ref_doctype, update_log.docname) @@ -192,16 +206,12 @@ def has_consumer_access(consumer, update_log): return True condition: str = dt_entry.condition - if condition.startswith('cmd:'): - cmd = condition.split('cmd:')[1].strip() - args = { - 'consumer': consumer, - 'doc': doc, - 'update_log': update_log - } + if condition.startswith("cmd:"): + cmd = condition.split("cmd:")[1].strip() + args = {"consumer": consumer, "doc": doc, "update_log": update_log} return frappe.call(cmd, **args) else: return frappe.safe_eval(condition, frappe._dict(doc=doc)) except Exception as e: - frappe.log_error(title='has_consumer_access error', message=e) - return False \ No newline at end of file + frappe.log_error(title="has_consumer_access error", message=e) + return False diff --git a/frappe/event_streaming/doctype/event_consumer/test_event_consumer.py b/frappe/event_streaming/doctype/event_consumer/test_event_consumer.py index 11c69e7ba3..605fc7982a 100644 --- a/frappe/event_streaming/doctype/event_consumer/test_event_consumer.py +++ b/frappe/event_streaming/doctype/event_consumer/test_event_consumer.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestEventConsumer(unittest.TestCase): pass diff --git a/frappe/event_streaming/doctype/event_producer/event_producer.py b/frappe/event_streaming/doctype/event_producer/event_producer.py index a6c2a257fa..f639e48b50 100644 --- a/frappe/event_streaming/doctype/event_producer/event_producer.py +++ b/frappe/event_streaming/doctype/event_producer/event_producer.py @@ -29,19 +29,21 @@ class EventProducer(Document): self.validate_event_subscriber() if frappe.flags.in_test: for entry in self.producer_doctypes: - entry.status = 'Approved' + entry.status = "Approved" def validate_event_subscriber(self): - if not frappe.db.get_value('User', self.user, 'api_key'): - frappe.throw(_('Please generate keys for the Event Subscriber User {0} first.').format( - frappe.bold(get_link_to_form('User', self.user)) - )) + if not frappe.db.get_value("User", self.user, "api_key"): + frappe.throw( + _("Please generate keys for the Event Subscriber User {0} first.").format( + frappe.bold(get_link_to_form("User", self.user)) + ) + ) def on_update(self): if not self.incoming_change: - if frappe.db.exists('Event Producer', self.name): + if frappe.db.exists("Event Producer", self.name): if not self.api_key or not self.api_secret: - frappe.throw(_('Please set API Key and Secret on the producer and consumer sites first.')) + frappe.throw(_("Please set API Key and Secret on the producer and consumer sites first.")) else: doc_before_save = self.get_doc_before_save() if doc_before_save.api_key != self.api_key or doc_before_save.api_secret != self.api_secret: @@ -51,13 +53,13 @@ class EventProducer(Document): self.create_custom_fields() else: # when producer doc is updated it updates the consumer doc, set flag to avoid deadlock - self.db_set('incoming_change', 0) + self.db_set("incoming_change", 0) self.reload() def on_trash(self): - last_update = frappe.db.get_value('Event Producer Last Update', dict(event_producer=self.name)) + last_update = frappe.db.get_value("Event Producer Last Update", dict(event_producer=self.name)) if last_update: - frappe.delete_doc('Event Producer Last Update', last_update) + frappe.delete_doc("Event Producer Last Update", last_update) def check_url(self): valid_url_schemes = ("http", "https") @@ -72,73 +74,96 @@ class EventProducer(Document): """register event consumer on the producer site""" if self.is_producer_online(): producer_site = FrappeClient( - url=self.producer_url, - api_key=self.api_key, - api_secret=self.get_password('api_secret') + url=self.producer_url, api_key=self.api_key, api_secret=self.get_password("api_secret") ) response = producer_site.post_api( - 'frappe.event_streaming.doctype.event_consumer.event_consumer.register_consumer', - params={'data': json.dumps(self.get_request_data())} + "frappe.event_streaming.doctype.event_consumer.event_consumer.register_consumer", + params={"data": json.dumps(self.get_request_data())}, ) if response: response = json.loads(response) - self.set_last_update(response['last_update']) + self.set_last_update(response["last_update"]) else: - frappe.throw(_('Failed to create an Event Consumer or an Event Consumer for the current site is already registered.')) + frappe.throw( + _( + "Failed to create an Event Consumer or an Event Consumer for the current site is already registered." + ) + ) def set_last_update(self, last_update): - last_update_doc_name = frappe.db.get_value('Event Producer Last Update', dict(event_producer=self.name)) + last_update_doc_name = frappe.db.get_value( + "Event Producer Last Update", dict(event_producer=self.name) + ) if not last_update_doc_name: - frappe.get_doc(dict( - doctype = 'Event Producer Last Update', - event_producer = self.producer_url, - last_update = last_update - )).insert(ignore_permissions=True) + frappe.get_doc( + dict( + doctype="Event Producer Last Update", + event_producer=self.producer_url, + last_update=last_update, + ) + ).insert(ignore_permissions=True) else: - frappe.db.set_value('Event Producer Last Update', last_update_doc_name, 'last_update', last_update) + frappe.db.set_value( + "Event Producer Last Update", last_update_doc_name, "last_update", last_update + ) def get_last_update(self): - return frappe.db.get_value('Event Producer Last Update', dict(event_producer=self.name), 'last_update') + return frappe.db.get_value( + "Event Producer Last Update", dict(event_producer=self.name), "last_update" + ) def get_request_data(self): consumer_doctypes = [] for entry in self.producer_doctypes: if entry.has_mapping: # if mapping, subscribe to remote doctype on consumer's site - dt = frappe.db.get_value('Document Type Mapping', entry.mapping, 'remote_doctype') + dt = frappe.db.get_value("Document Type Mapping", entry.mapping, "remote_doctype") else: dt = entry.ref_doctype - consumer_doctypes.append({ - "doctype": dt, - "condition": entry.condition - }) + consumer_doctypes.append({"doctype": dt, "condition": entry.condition}) - user_key = frappe.db.get_value('User', self.user, 'api_key') - user_secret = get_decrypted_password('User', self.user, 'api_secret') + user_key = frappe.db.get_value("User", self.user, "api_key") + user_secret = get_decrypted_password("User", self.user, "api_secret") return { - 'event_consumer': get_url(), - 'consumer_doctypes': json.dumps(consumer_doctypes), - 'user': self.user, - 'api_key': user_key, - 'api_secret': user_secret + "event_consumer": get_url(), + "consumer_doctypes": json.dumps(consumer_doctypes), + "user": self.user, + "api_key": user_key, + "api_secret": user_secret, } def create_custom_fields(self): """create custom field to store remote docname and remote site url""" for entry in self.producer_doctypes: if not entry.use_same_name: - if not frappe.db.exists('Custom Field', {'fieldname': 'remote_docname', 'dt': entry.ref_doctype}): - df = dict(fieldname='remote_docname', label='Remote Document Name', fieldtype='Data', read_only=1, print_hide=1) + if not frappe.db.exists( + "Custom Field", {"fieldname": "remote_docname", "dt": entry.ref_doctype} + ): + df = dict( + fieldname="remote_docname", + label="Remote Document Name", + fieldtype="Data", + read_only=1, + print_hide=1, + ) create_custom_field(entry.ref_doctype, df) - if not frappe.db.exists('Custom Field', {'fieldname': 'remote_site_name', 'dt': entry.ref_doctype}): - df = dict(fieldname='remote_site_name', label='Remote Site', fieldtype='Data', read_only=1, print_hide=1) + if not frappe.db.exists( + "Custom Field", {"fieldname": "remote_site_name", "dt": entry.ref_doctype} + ): + df = dict( + fieldname="remote_site_name", + label="Remote Site", + fieldtype="Data", + read_only=1, + print_hide=1, + ) create_custom_field(entry.ref_doctype, df) def update_event_consumer(self): if self.is_producer_online(): producer_site = get_producer_site(self.producer_url) - event_consumer = producer_site.get_doc('Event Consumer', get_url()) + event_consumer = producer_site.get_doc("Event Consumer", get_url()) event_consumer = frappe._dict(event_consumer) if event_consumer: config = event_consumer.consumer_doctypes @@ -146,16 +171,18 @@ class EventProducer(Document): for entry in self.producer_doctypes: if entry.has_mapping: # if mapping, subscribe to remote doctype on consumer's site - ref_doctype = frappe.db.get_value('Document Type Mapping', entry.mapping, 'remote_doctype') + ref_doctype = frappe.db.get_value("Document Type Mapping", entry.mapping, "remote_doctype") else: ref_doctype = entry.ref_doctype - event_consumer.consumer_doctypes.append({ - 'ref_doctype': ref_doctype, - 'status': get_approval_status(config, ref_doctype), - 'unsubscribed': entry.unsubscribe, - 'condition': entry.condition - }) + event_consumer.consumer_doctypes.append( + { + "ref_doctype": ref_doctype, + "status": get_approval_status(config, ref_doctype), + "unsubscribed": entry.unsubscribe, + "condition": entry.condition, + } + ) event_consumer.user = self.user event_consumer.incoming_change = True producer_site.update(event_consumer) @@ -169,16 +196,16 @@ class EventProducer(Document): return True retry -= 1 time.sleep(5) - frappe.throw(_('Failed to connect to the Event Producer site. Retry after some time.')) + frappe.throw(_("Failed to connect to the Event Producer site. Retry after some time.")) def get_producer_site(producer_url): """create a FrappeClient object for event producer site""" - producer_doc = frappe.get_doc('Event Producer', producer_url) + producer_doc = frappe.get_doc("Event Producer", producer_url) producer_site = FrappeClient( url=producer_url, api_key=producer_doc.api_key, - api_secret=producer_doc.get_password('api_secret') + api_secret=producer_doc.get_password("api_secret"), ) return producer_site @@ -186,9 +213,9 @@ def get_producer_site(producer_url): def get_approval_status(config, ref_doctype): """check the approval status for consumption""" for entry in config: - if entry.get('ref_doctype') == ref_doctype: - return entry.get('status') - return 'Pending' + if entry.get("ref_doctype") == ref_doctype: + return entry.get("status") + return "Pending" @frappe.whitelist() @@ -196,16 +223,16 @@ def pull_producer_data(): """Fetch data from producer node.""" response = requests.get(get_url()) if response.status_code == 200: - for event_producer in frappe.get_all('Event Producer'): + for event_producer in frappe.get_all("Event Producer"): pull_from_node(event_producer.name) - return 'success' + return "success" return None @frappe.whitelist() def pull_from_node(event_producer): """pull all updates after the last update timestamp from event producer site""" - event_producer = frappe.get_doc('Event Producer', event_producer) + event_producer = frappe.get_doc("Event Producer", event_producer) producer_site = get_producer_site(event_producer.producer_url) last_update = event_producer.get_last_update() @@ -219,7 +246,7 @@ def pull_from_node(event_producer): if mapping: update.mapping = mapping update = get_mapped_update(update, producer_site) - if not update.update_type == 'Delete': + if not update.update_type == "Delete": update.data = json.loads(update.data) sync(update, producer_site, event_producer) @@ -230,9 +257,11 @@ def get_config(event_config): doctypes, mapping_config, naming_config = [], {}, {} for entry in event_config: - if entry.status == 'Approved': + if entry.status == "Approved": if entry.has_mapping: - (mapped_doctype, mapping) = frappe.db.get_value('Document Type Mapping', entry.mapping, ['remote_doctype', 'name']) + (mapped_doctype, mapping) = frappe.db.get_value( + "Document Type Mapping", entry.mapping, ["remote_doctype", "name"] + ) mapping_config[mapped_doctype] = mapping naming_config[mapped_doctype] = entry.use_same_name doctypes.append(mapped_doctype) @@ -245,22 +274,22 @@ def get_config(event_config): def sync(update, producer_site, event_producer, in_retry=False): """Sync the individual update""" try: - if update.update_type == 'Create': + if update.update_type == "Create": set_insert(update, producer_site, event_producer.name) - if update.update_type == 'Update': + if update.update_type == "Update": set_update(update, producer_site) - if update.update_type == 'Delete': + if update.update_type == "Delete": set_delete(update) if in_retry: - return 'Synced' - log_event_sync(update, event_producer.name, 'Synced') + return "Synced" + log_event_sync(update, event_producer.name, "Synced") except Exception: if in_retry: if frappe.flags.in_test: print(frappe.get_traceback()) - return 'Failed' - log_event_sync(update, event_producer.name, 'Failed', frappe.get_traceback()) + return "Failed" + log_event_sync(update, event_producer.name, "Failed", frappe.get_traceback()) event_producer.set_last_update(update.creation) frappe.db.commit() @@ -274,7 +303,7 @@ def set_insert(update, producer_site, event_producer): doc = frappe.get_doc(update.data) if update.mapping: - if update.get('dependencies'): + if update.get("dependencies"): dependencies_created = sync_mapped_dependencies(update.dependencies, producer_site) for fieldname, value in dependencies_created.items(): doc.update({fieldname: value}) @@ -306,7 +335,7 @@ def set_update(update, producer_site): local_doc = update_row_added(local_doc, data.added) if update.mapping: - if update.get('dependencies'): + if update.get("dependencies"): dependencies_created = sync_mapped_dependencies(update.dependencies, producer_site) for fieldname, value in dependencies_created.items(): local_doc.update({fieldname: value}) @@ -331,7 +360,7 @@ def update_row_removed(local_doc, removed): def get_child_table_row(table_rows, row): for entry in table_rows: - if entry.get('name') == row: + if entry.get("name") == row: return entry @@ -341,7 +370,7 @@ def update_row_changed(local_doc, changed): old = local_doc.get(tablename) for doc in old: for row in rows: - if row['name'] == doc.get('name'): + if row["name"] == doc.get("name"): doc.update(row) @@ -366,12 +395,14 @@ def set_delete(update): def get_updates(producer_site, last_update, doctypes): """Get all updates generated after the last update timestamp""" - docs = producer_site.post_request({ - 'cmd': 'frappe.event_streaming.doctype.event_update_log.event_update_log.get_update_logs_for_consumer', - 'event_consumer': get_url(), - 'doctypes': frappe.as_json(doctypes), - 'last_update': last_update - }) + docs = producer_site.post_request( + { + "cmd": "frappe.event_streaming.doctype.event_update_log.event_update_log.get_update_logs_for_consumer", + "event_consumer": get_url(), + "doctypes": frappe.as_json(doctypes), + "last_update": last_update, + } + ) return [frappe._dict(d) for d in (docs or [])] @@ -379,7 +410,7 @@ def get_local_doc(update): """Get the local document if created with a different name""" try: if not update.use_same_name: - return frappe.get_doc(update.ref_doctype, {'remote_docname': update.docname}) + return frappe.get_doc(update.ref_doctype, {"remote_docname": update.docname}) return frappe.get_doc(update.ref_doctype, update.docname) except frappe.DoesNotExistError: return None @@ -479,9 +510,10 @@ def sync_mapped_dependencies(dependencies, producer_site): return dependencies_created + def log_event_sync(update, event_producer, sync_status, error=None): """Log event update received with the sync_status as Synced or Failed""" - doc = frappe.new_doc('Event Sync Log') + doc = frappe.new_doc("Event Sync Log") doc.update_type = update.update_type doc.ref_doctype = update.ref_doctype doc.status = sync_status @@ -493,7 +525,7 @@ def log_event_sync(update, event_producer, sync_status, error=None): if update.use_same_name: doc.docname = update.docname else: - doc.docname = frappe.db.get_value(update.ref_doctype, {'remote_docname': update.docname}, 'name') + doc.docname = frappe.db.get_value(update.ref_doctype, {"remote_docname": update.docname}, "name") if error: doc.error = error doc.insert() @@ -501,28 +533,28 @@ def log_event_sync(update, event_producer, sync_status, error=None): def get_mapped_update(update, producer_site): """get the new update document with mapped fields""" - mapping = frappe.get_doc('Document Type Mapping', update.mapping) - if update.update_type == 'Create': + mapping = frappe.get_doc("Document Type Mapping", update.mapping) + if update.update_type == "Create": doc = frappe._dict(json.loads(update.data)) mapped_update = mapping.get_mapping(doc, producer_site, update.update_type) - update.data = mapped_update.get('doc') - update.dependencies = mapped_update.get('dependencies', None) - elif update.update_type == 'Update': + update.data = mapped_update.get("doc") + update.dependencies = mapped_update.get("dependencies", None) + elif update.update_type == "Update": mapped_update = mapping.get_mapped_update(update, producer_site) - update.data = mapped_update.get('doc') - update.dependencies = mapped_update.get('dependencies', None) + update.data = mapped_update.get("doc") + update.dependencies = mapped_update.get("dependencies", None) - update['ref_doctype'] = mapping.local_doctype + update["ref_doctype"] = mapping.local_doctype return update @frappe.whitelist() def new_event_notification(producer_url): """Pull data from producer when notified""" - enqueued_method = 'frappe.event_streaming.doctype.event_producer.event_producer.pull_from_node' + enqueued_method = "frappe.event_streaming.doctype.event_producer.event_producer.pull_from_node" jobs = get_jobs() if not jobs or enqueued_method not in jobs[frappe.local.site]: - frappe.enqueue(enqueued_method, queue='default', **{'event_producer': producer_url}) + frappe.enqueue(enqueued_method, queue="default", **{"event_producer": producer_url}) @frappe.whitelist() @@ -530,7 +562,7 @@ def resync(update): """Retry syncing update if failed""" update = frappe._dict(json.loads(update)) producer_site = get_producer_site(update.event_producer) - event_producer = frappe.get_doc('Event Producer', update.event_producer) + event_producer = frappe.get_doc("Event Producer", update.event_producer) if update.mapping: update = get_mapped_update(update, producer_site) update.data = json.loads(update.data) @@ -539,5 +571,5 @@ def resync(update): def set_custom_fields(local_doc, remote_docname, remote_site_name): """sets custom field in doc for storing remote docname""" - frappe.db.set_value(local_doc.doctype, local_doc.name, 'remote_docname', remote_docname) - frappe.db.set_value(local_doc.doctype, local_doc.name, 'remote_site_name', remote_site_name) + frappe.db.set_value(local_doc.doctype, local_doc.name, "remote_docname", remote_docname) + frappe.db.set_value(local_doc.doctype, local_doc.name, "remote_site_name", remote_site_name) diff --git a/frappe/event_streaming/doctype/event_producer/test_event_producer.py b/frappe/event_streaming/doctype/event_producer/test_event_producer.py index 3d697ceb3a..4464b0a434 100644 --- a/frappe/event_streaming/doctype/event_producer/test_event_producer.py +++ b/frappe/event_streaming/doctype/event_producer/test_event_producer.py @@ -1,14 +1,16 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe -import unittest import json -from frappe.frappeclient import FrappeClient -from frappe.event_streaming.doctype.event_producer.event_producer import pull_from_node +import unittest + +import frappe from frappe.core.doctype.user.user import generate_keys +from frappe.event_streaming.doctype.event_producer.event_producer import pull_from_node +from frappe.frappeclient import FrappeClient + +producer_url = "http://test_site_producer:8000" -producer_url = 'http://test_site_producer:8000' class TestEventProducer(unittest.TestCase): # @classmethod @@ -27,14 +29,14 @@ class TestEventProducer(unittest.TestCase): def test_insert(self): producer = get_remote_site() - producer_doc = insert_into_producer(producer, 'test creation 1 sync') + producer_doc = insert_into_producer(producer, "test creation 1 sync") self.pull_producer_data() - self.assertTrue(frappe.db.exists('ToDo', producer_doc.name)) + self.assertTrue(frappe.db.exists("ToDo", producer_doc.name)) def test_update(self): producer = get_remote_site() - producer_doc = insert_into_producer(producer, 'test update 1') - producer_doc['description'] = 'test update 2' + producer_doc = insert_into_producer(producer, "test update 1") + producer_doc["description"] = "test update 2" producer_doc = producer.update(producer_doc) self.pull_producer_data() local_doc = frappe.get_doc(producer_doc.doctype, producer_doc.name) @@ -42,111 +44,123 @@ class TestEventProducer(unittest.TestCase): def test_delete(self): producer = get_remote_site() - producer_doc = insert_into_producer(producer, 'test delete sync') + producer_doc = insert_into_producer(producer, "test delete sync") self.pull_producer_data() - self.assertTrue(frappe.db.exists('ToDo', producer_doc.name)) - producer.delete('ToDo', producer_doc.name) + self.assertTrue(frappe.db.exists("ToDo", producer_doc.name)) + producer.delete("ToDo", producer_doc.name) self.pull_producer_data() - self.assertFalse(frappe.db.exists('ToDo', producer_doc.name)) + self.assertFalse(frappe.db.exists("ToDo", producer_doc.name)) def test_multiple_doctypes_sync(self): producer = get_remote_site() - #insert todo and note in producer - producer_todo = insert_into_producer(producer, 'test multiple doc sync') - producer_note1 = frappe._dict(doctype='Note', title='test multiple doc sync 1') - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note1['title']}) - frappe.db.delete('Note', {'title': producer_note1['title']}) + # insert todo and note in producer + producer_todo = insert_into_producer(producer, "test multiple doc sync") + producer_note1 = frappe._dict(doctype="Note", title="test multiple doc sync 1") + delete_on_remote_if_exists(producer, "Note", {"title": producer_note1["title"]}) + frappe.db.delete("Note", {"title": producer_note1["title"]}) producer_note1 = producer.insert(producer_note1) - producer_note2 = frappe._dict(doctype='Note', title='test multiple doc sync 2') - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note2['title']}) - frappe.db.delete('Note', {'title': producer_note2['title']}) + producer_note2 = frappe._dict(doctype="Note", title="test multiple doc sync 2") + delete_on_remote_if_exists(producer, "Note", {"title": producer_note2["title"]}) + frappe.db.delete("Note", {"title": producer_note2["title"]}) producer_note2 = producer.insert(producer_note2) - #update in producer - producer_todo['description'] = 'test multiple doc update sync' + # update in producer + producer_todo["description"] = "test multiple doc update sync" producer_todo = producer.update(producer_todo) - producer_note1['content'] = 'testing update sync' + producer_note1["content"] = "testing update sync" producer_note1 = producer.update(producer_note1) - producer.delete('Note', producer_note2.name) + producer.delete("Note", producer_note2.name) self.pull_producer_data() - #check inserted - self.assertTrue(frappe.db.exists('ToDo', producer_todo.name)) + # check inserted + self.assertTrue(frappe.db.exists("ToDo", producer_todo.name)) - #check update - local_todo = frappe.get_doc('ToDo', producer_todo.name) + # check update + local_todo = frappe.get_doc("ToDo", producer_todo.name) self.assertEqual(local_todo.description, producer_todo.description) - local_note1 = frappe.get_doc('Note', producer_note1.name) + local_note1 = frappe.get_doc("Note", producer_note1.name) self.assertEqual(local_note1.content, producer_note1.content) - #check delete - self.assertFalse(frappe.db.exists('Note', producer_note2.name)) + # check delete + self.assertFalse(frappe.db.exists("Note", producer_note2.name)) def test_child_table_sync_with_dependencies(self): producer = get_remote_site() - producer_user = frappe._dict(doctype='User', email='test_user@sync.com', send_welcome_email=0, - first_name='Test Sync User', enabled=1, roles=[{'role': 'System Manager'}]) - delete_on_remote_if_exists(producer, 'User', {'email': producer_user.email}) - frappe.db.delete('User', {'email':producer_user.email}) + producer_user = frappe._dict( + doctype="User", + email="test_user@sync.com", + send_welcome_email=0, + first_name="Test Sync User", + enabled=1, + roles=[{"role": "System Manager"}], + ) + delete_on_remote_if_exists(producer, "User", {"email": producer_user.email}) + frappe.db.delete("User", {"email": producer_user.email}) producer_user = producer.insert(producer_user) - producer_note = frappe._dict(doctype='Note', title='test child table dependency sync', - seen_by=[{'user': producer_user.name}]) - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note.title}) - frappe.db.delete('Note', {'title': producer_note.title}) + producer_note = frappe._dict( + doctype="Note", title="test child table dependency sync", seen_by=[{"user": producer_user.name}] + ) + delete_on_remote_if_exists(producer, "Note", {"title": producer_note.title}) + frappe.db.delete("Note", {"title": producer_note.title}) producer_note = producer.insert(producer_note) self.pull_producer_data() - self.assertTrue(frappe.db.exists('User', producer_user.name)) - if self.assertTrue(frappe.db.exists('Note', producer_note.name)): - local_note = frappe.get_doc('Note', producer_note.name) + self.assertTrue(frappe.db.exists("User", producer_user.name)) + if self.assertTrue(frappe.db.exists("Note", producer_note.name)): + local_note = frappe.get_doc("Note", producer_note.name) self.assertEqual(len(local_note.seen_by), 1) def test_dynamic_link_dependencies_synced(self): producer = get_remote_site() - #unsubscribe for Note to check whether dependency is fulfilled - event_producer = frappe.get_doc('Event Producer', producer_url, for_update=True) + # unsubscribe for Note to check whether dependency is fulfilled + event_producer = frappe.get_doc("Event Producer", producer_url, for_update=True) event_producer.producer_doctypes = [] - event_producer.append('producer_doctypes', { - 'ref_doctype': 'ToDo', - 'use_same_name': 1 - }) + event_producer.append("producer_doctypes", {"ref_doctype": "ToDo", "use_same_name": 1}) event_producer.save() - producer_link_doc = frappe._dict(doctype='Note', title='Test Dynamic Link 1') + producer_link_doc = frappe._dict(doctype="Note", title="Test Dynamic Link 1") - delete_on_remote_if_exists(producer, 'Note', {'title': producer_link_doc.title}) - frappe.db.delete('Note', {'title': producer_link_doc.title}) + delete_on_remote_if_exists(producer, "Note", {"title": producer_link_doc.title}) + frappe.db.delete("Note", {"title": producer_link_doc.title}) producer_link_doc = producer.insert(producer_link_doc) - producer_doc = frappe._dict(doctype='ToDo', description='Test Dynamic Link 2', assigned_by='Administrator', - reference_type='Note', reference_name=producer_link_doc.name) + producer_doc = frappe._dict( + doctype="ToDo", + description="Test Dynamic Link 2", + assigned_by="Administrator", + reference_type="Note", + reference_name=producer_link_doc.name, + ) producer_doc = producer.insert(producer_doc) self.pull_producer_data() - #check dynamic link dependency created - self.assertTrue(frappe.db.exists('Note', producer_link_doc.name)) - self.assertEqual(producer_link_doc.name, frappe.db.get_value('ToDo', producer_doc.name, 'reference_name')) + # check dynamic link dependency created + self.assertTrue(frappe.db.exists("Note", producer_link_doc.name)) + self.assertEqual( + producer_link_doc.name, frappe.db.get_value("ToDo", producer_doc.name, "reference_name") + ) reset_configuration(producer_url) def test_naming_configuration(self): - #test with use_same_name = 0 + # test with use_same_name = 0 producer = get_remote_site() - event_producer = frappe.get_doc('Event Producer', producer_url, for_update=True) + event_producer = frappe.get_doc("Event Producer", producer_url, for_update=True) event_producer.producer_doctypes = [] - event_producer.append('producer_doctypes', { - 'ref_doctype': 'ToDo', - 'use_same_name': 0 - }) + event_producer.append("producer_doctypes", {"ref_doctype": "ToDo", "use_same_name": 0}) event_producer.save() - producer_doc = insert_into_producer(producer, 'test different name sync') + producer_doc = insert_into_producer(producer, "test different name sync") self.pull_producer_data() - self.assertTrue(frappe.db.exists('ToDo', {'remote_docname': producer_doc.name, 'remote_site_name': producer_url})) + self.assertTrue( + frappe.db.exists( + "ToDo", {"remote_docname": producer_doc.name, "remote_site_name": producer_url} + ) + ) reset_configuration(producer_url) @@ -154,36 +168,34 @@ class TestEventProducer(unittest.TestCase): producer = get_remote_site() # Add Condition - event_producer = frappe.get_doc('Event Producer', producer_url) - note_producer_entry = [ - x for x in event_producer.producer_doctypes if x.ref_doctype == 'Note' - ][0] - note_producer_entry.condition = 'doc.public == 1' + event_producer = frappe.get_doc("Event Producer", producer_url) + note_producer_entry = [x for x in event_producer.producer_doctypes if x.ref_doctype == "Note"][0] + note_producer_entry.condition = "doc.public == 1" event_producer.save() # Make test doc - producer_note1 = frappe._dict(doctype='Note', public=0, title='test conditional sync') - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note1['title']}) + producer_note1 = frappe._dict(doctype="Note", public=0, title="test conditional sync") + delete_on_remote_if_exists(producer, "Note", {"title": producer_note1["title"]}) producer_note1 = producer.insert(producer_note1) # Make Update - producer_note1['content'] = 'Test Conditional Sync Content' + producer_note1["content"] = "Test Conditional Sync Content" producer_note1 = producer.update(producer_note1) self.pull_producer_data() # Check if synced here - self.assertFalse(frappe.db.exists('Note', producer_note1.name)) + self.assertFalse(frappe.db.exists("Note", producer_note1.name)) # Lets satisfy the condition - producer_note1['public'] = 1 + producer_note1["public"] = 1 producer_note1 = producer.update(producer_note1) self.pull_producer_data() # it should sync now - self.assertTrue(frappe.db.exists('Note', producer_note1.name)) - local_note = frappe.get_doc('Note', producer_note1.name) + self.assertTrue(frappe.db.exists("Note", producer_note1.name)) + local_note = frappe.get_doc("Note", producer_note1.name) self.assertEqual(local_note.content, producer_note1.content) reset_configuration(producer_url) @@ -192,90 +204,92 @@ class TestEventProducer(unittest.TestCase): producer = get_remote_site() # Add Condition - event_producer = frappe.get_doc('Event Producer', producer_url) - note_producer_entry = [ - x for x in event_producer.producer_doctypes if x.ref_doctype == 'Note' - ][0] - note_producer_entry.condition = 'cmd: frappe.event_streaming.doctype.event_producer.test_event_producer.can_sync_note' + event_producer = frappe.get_doc("Event Producer", producer_url) + note_producer_entry = [x for x in event_producer.producer_doctypes if x.ref_doctype == "Note"][0] + note_producer_entry.condition = ( + "cmd: frappe.event_streaming.doctype.event_producer.test_event_producer.can_sync_note" + ) event_producer.save() # Make test doc - producer_note1 = frappe._dict(doctype='Note', public=0, title='test conditional sync cmd') - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note1['title']}) + producer_note1 = frappe._dict(doctype="Note", public=0, title="test conditional sync cmd") + delete_on_remote_if_exists(producer, "Note", {"title": producer_note1["title"]}) producer_note1 = producer.insert(producer_note1) # Make Update - producer_note1['content'] = 'Test Conditional Sync Content' + producer_note1["content"] = "Test Conditional Sync Content" producer_note1 = producer.update(producer_note1) self.pull_producer_data() # Check if synced here - self.assertFalse(frappe.db.exists('Note', producer_note1.name)) + self.assertFalse(frappe.db.exists("Note", producer_note1.name)) # Lets satisfy the condition - producer_note1['public'] = 1 + producer_note1["public"] = 1 producer_note1 = producer.update(producer_note1) self.pull_producer_data() # it should sync now - self.assertTrue(frappe.db.exists('Note', producer_note1.name)) - local_note = frappe.get_doc('Note', producer_note1.name) + self.assertTrue(frappe.db.exists("Note", producer_note1.name)) + local_note = frappe.get_doc("Note", producer_note1.name) self.assertEqual(local_note.content, producer_note1.content) reset_configuration(producer_url) def test_update_log(self): producer = get_remote_site() - producer_doc = insert_into_producer(producer, 'test update log') - update_log_doc = producer.get_value('Event Update Log', 'docname', {'docname': producer_doc.get('name')}) - self.assertEqual(update_log_doc.get('docname'), producer_doc.get('name')) + producer_doc = insert_into_producer(producer, "test update log") + update_log_doc = producer.get_value( + "Event Update Log", "docname", {"docname": producer_doc.get("name")} + ) + self.assertEqual(update_log_doc.get("docname"), producer_doc.get("name")) def test_event_sync_log(self): producer = get_remote_site() - producer_doc = insert_into_producer(producer, 'test event sync log') + producer_doc = insert_into_producer(producer, "test event sync log") self.pull_producer_data() - self.assertTrue(frappe.db.exists('Event Sync Log', {'docname': producer_doc.name})) + self.assertTrue(frappe.db.exists("Event Sync Log", {"docname": producer_doc.name})) def pull_producer_data(self): pull_from_node(producer_url) def test_mapping(self): producer = get_remote_site() - event_producer = frappe.get_doc('Event Producer', producer_url, for_update=True) + event_producer = frappe.get_doc("Event Producer", producer_url, for_update=True) event_producer.producer_doctypes = [] - mapping = [{ - 'local_fieldname': 'description', - 'remote_fieldname': 'content' - }] - event_producer.append('producer_doctypes', { - 'ref_doctype': 'ToDo', - 'use_same_name': 1, - 'has_mapping': 1, - 'mapping': get_mapping('ToDo to Note', 'ToDo', 'Note', mapping) - }) + mapping = [{"local_fieldname": "description", "remote_fieldname": "content"}] + event_producer.append( + "producer_doctypes", + { + "ref_doctype": "ToDo", + "use_same_name": 1, + "has_mapping": 1, + "mapping": get_mapping("ToDo to Note", "ToDo", "Note", mapping), + }, + ) event_producer.save() - producer_note = frappe._dict(doctype='Note', title='Test Mapping', content='Test Mapping') - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note.title}) + producer_note = frappe._dict(doctype="Note", title="Test Mapping", content="Test Mapping") + delete_on_remote_if_exists(producer, "Note", {"title": producer_note.title}) producer_note = producer.insert(producer_note) self.pull_producer_data() - #check inserted - self.assertTrue(frappe.db.exists('ToDo', {'description': producer_note.content})) + # check inserted + self.assertTrue(frappe.db.exists("ToDo", {"description": producer_note.content})) - #update in producer - producer_note['content'] = 'test mapped doc update sync' + # update in producer + producer_note["content"] = "test mapped doc update sync" producer_note = producer.update(producer_note) self.pull_producer_data() # check updated - self.assertTrue(frappe.db.exists('ToDo', {'description': producer_note['content']})) + self.assertTrue(frappe.db.exists("ToDo", {"description": producer_note["content"]})) - producer.delete('Note', producer_note.name) + producer.delete("Note", producer_note.name) self.pull_producer_data() - #check delete - self.assertFalse(frappe.db.exists('ToDo', {'description': producer_note.content})) + # check delete + self.assertFalse(frappe.db.exists("ToDo", {"description": producer_note.content})) reset_configuration(producer_url) @@ -283,158 +297,146 @@ class TestEventProducer(unittest.TestCase): producer = get_remote_site() setup_event_producer_for_inner_mapping() - producer_note = frappe._dict(doctype='Note', title='Inner Mapping Tester', content='Test Inner Mapping') - delete_on_remote_if_exists(producer, 'Note', {'title': producer_note.title}) + producer_note = frappe._dict( + doctype="Note", title="Inner Mapping Tester", content="Test Inner Mapping" + ) + delete_on_remote_if_exists(producer, "Note", {"title": producer_note.title}) producer_note = producer.insert(producer_note) self.pull_producer_data() - #check dependency inserted - self.assertTrue(frappe.db.exists('Role', {'role_name': producer_note.title})) - #check doc inserted - self.assertTrue(frappe.db.exists('ToDo', {'description': producer_note.content})) + # check dependency inserted + self.assertTrue(frappe.db.exists("Role", {"role_name": producer_note.title})) + # check doc inserted + self.assertTrue(frappe.db.exists("ToDo", {"description": producer_note.content})) reset_configuration(producer_url) + def can_sync_note(consumer, doc, update_log): return doc.public == 1 + def setup_event_producer_for_inner_mapping(): - event_producer = frappe.get_doc('Event Producer', producer_url, for_update=True) + event_producer = frappe.get_doc("Event Producer", producer_url, for_update=True) event_producer.producer_doctypes = [] - inner_mapping = [ - { - 'local_fieldname':'role_name', - 'remote_fieldname':'title' - } - ] - inner_map = get_mapping('Role to Note Dependency Creation', 'Role', 'Note', inner_mapping) + inner_mapping = [{"local_fieldname": "role_name", "remote_fieldname": "title"}] + inner_map = get_mapping("Role to Note Dependency Creation", "Role", "Note", inner_mapping) mapping = [ { - 'local_fieldname':'description', - 'remote_fieldname':'content', + "local_fieldname": "description", + "remote_fieldname": "content", }, { - 'local_fieldname': 'role', - 'remote_fieldname': 'title', - 'mapping_type': 'Document', - 'mapping': inner_map, - 'remote_value_filters': json.dumps({'title': 'title'}) - } + "local_fieldname": "role", + "remote_fieldname": "title", + "mapping_type": "Document", + "mapping": inner_map, + "remote_value_filters": json.dumps({"title": "title"}), + }, ] - event_producer.append('producer_doctypes', { - 'ref_doctype': 'ToDo', - 'use_same_name': 1, - 'has_mapping': 1, - 'mapping': get_mapping('ToDo to Note Mapping', 'ToDo', 'Note', mapping) - }) + event_producer.append( + "producer_doctypes", + { + "ref_doctype": "ToDo", + "use_same_name": 1, + "has_mapping": 1, + "mapping": get_mapping("ToDo to Note Mapping", "ToDo", "Note", mapping), + }, + ) event_producer.save() return event_producer def insert_into_producer(producer, description): - #create and insert todo on remote site - todo = dict(doctype='ToDo', description=description, assigned_by='Administrator') + # create and insert todo on remote site + todo = dict(doctype="ToDo", description=description, assigned_by="Administrator") return producer.insert(todo) + def delete_on_remote_if_exists(producer, doctype, filters): - remote_doc = producer.get_value(doctype, 'name', filters) + remote_doc = producer.get_value(doctype, "name", filters) if remote_doc: - producer.delete(doctype, remote_doc.get('name')) + producer.delete(doctype, remote_doc.get("name")) + def get_mapping(mapping_name, local, remote, field_map): - name = frappe.db.exists('Document Type Mapping', mapping_name) + name = frappe.db.exists("Document Type Mapping", mapping_name) if name: - doc = frappe.get_doc('Document Type Mapping', name) + doc = frappe.get_doc("Document Type Mapping", name) else: - doc = frappe.new_doc('Document Type Mapping') + doc = frappe.new_doc("Document Type Mapping") doc.mapping_name = mapping_name doc.local_doctype = local doc.remote_doctype = remote for entry in field_map: - doc.append('field_mapping', entry) + doc.append("field_mapping", entry) doc.save() return doc.name def create_event_producer(producer_url): - if frappe.db.exists('Event Producer', producer_url): - event_producer = frappe.get_doc('Event Producer', producer_url) + if frappe.db.exists("Event Producer", producer_url): + event_producer = frappe.get_doc("Event Producer", producer_url) for entry in event_producer.producer_doctypes: entry.unsubscribe = 0 event_producer.save() return - generate_keys('Administrator') + generate_keys("Administrator") producer_site = connect() response = producer_site.post_api( - 'frappe.core.doctype.user.user.generate_keys', - params={'user': 'Administrator'} + "frappe.core.doctype.user.user.generate_keys", params={"user": "Administrator"} ) - api_secret = response.get('api_secret') + api_secret = response.get("api_secret") - response = producer_site.get_value('User', 'api_key', {'name': 'Administrator'}) - api_key = response.get('api_key') + response = producer_site.get_value("User", "api_key", {"name": "Administrator"}) + api_key = response.get("api_key") - event_producer = frappe.new_doc('Event Producer') + event_producer = frappe.new_doc("Event Producer") event_producer.producer_doctypes = [] event_producer.producer_url = producer_url - event_producer.append('producer_doctypes', { - 'ref_doctype': 'ToDo', - 'use_same_name': 1 - }) - event_producer.append('producer_doctypes', { - 'ref_doctype': 'Note', - 'use_same_name': 1 - }) - event_producer.user = 'Administrator' + event_producer.append("producer_doctypes", {"ref_doctype": "ToDo", "use_same_name": 1}) + event_producer.append("producer_doctypes", {"ref_doctype": "Note", "use_same_name": 1}) + event_producer.user = "Administrator" event_producer.api_key = api_key event_producer.api_secret = api_secret event_producer.save() + def reset_configuration(producer_url): - event_producer = frappe.get_doc('Event Producer', producer_url, for_update=True) + event_producer = frappe.get_doc("Event Producer", producer_url, for_update=True) event_producer.producer_doctypes = [] event_producer.conditions = [] event_producer.producer_url = producer_url - event_producer.append('producer_doctypes', { - 'ref_doctype': 'ToDo', - 'use_same_name': 1 - }) - event_producer.append('producer_doctypes', { - 'ref_doctype': 'Note', - 'use_same_name': 1 - }) - event_producer.user = 'Administrator' + event_producer.append("producer_doctypes", {"ref_doctype": "ToDo", "use_same_name": 1}) + event_producer.append("producer_doctypes", {"ref_doctype": "Note", "use_same_name": 1}) + event_producer.user = "Administrator" event_producer.save() + def get_remote_site(): - producer_doc = frappe.get_doc('Event Producer', producer_url) + producer_doc = frappe.get_doc("Event Producer", producer_url) producer_site = FrappeClient( - url=producer_doc.producer_url, - username='Administrator', - password='admin', - verify=False + url=producer_doc.producer_url, username="Administrator", password="admin", verify=False ) return producer_site + def unsubscribe_doctypes(producer_url): - event_producer = frappe.get_doc('Event Producer', producer_url) + event_producer = frappe.get_doc("Event Producer", producer_url) for entry in event_producer.producer_doctypes: entry.unsubscribe = 1 event_producer.save() + def connect(): def _connect(): - return FrappeClient( - url=producer_url, - username='Administrator', - password='admin', - verify=False - ) + return FrappeClient(url=producer_url, username="Administrator", password="admin", verify=False) + try: return _connect() except Exception: diff --git a/frappe/event_streaming/doctype/event_producer_last_update/event_producer_last_update.py b/frappe/event_streaming/doctype/event_producer_last_update/event_producer_last_update.py index 0868e86253..8e32e6fe6f 100644 --- a/frappe/event_streaming/doctype/event_producer_last_update/event_producer_last_update.py +++ b/frappe/event_streaming/doctype/event_producer_last_update/event_producer_last_update.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class EventProducerLastUpdate(Document): pass diff --git a/frappe/event_streaming/doctype/event_producer_last_update/test_event_producer_last_update.py b/frappe/event_streaming/doctype/event_producer_last_update/test_event_producer_last_update.py index c2d943a463..6054ec873f 100644 --- a/frappe/event_streaming/doctype/event_producer_last_update/test_event_producer_last_update.py +++ b/frappe/event_streaming/doctype/event_producer_last_update/test_event_producer_last_update.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestEventProducerLastUpdate(unittest.TestCase): pass diff --git a/frappe/event_streaming/doctype/event_sync_log/test_event_sync_log.py b/frappe/event_streaming/doctype/event_sync_log/test_event_sync_log.py index b901f92ef8..da90c8e634 100644 --- a/frappe/event_streaming/doctype/event_sync_log/test_event_sync_log.py +++ b/frappe/event_streaming/doctype/event_sync_log/test_event_sync_log.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestEventSyncLog(unittest.TestCase): pass diff --git a/frappe/event_streaming/doctype/event_update_log/event_update_log.py b/frappe/event_streaming/doctype/event_update_log/event_update_log.py index cd5100623c..658a3b47cc 100644 --- a/frappe/event_streaming/doctype/event_update_log/event_update_log.py +++ b/frappe/event_streaming/doctype/event_update_log/event_update_log.py @@ -3,60 +3,70 @@ # License: MIT. See LICENSE import frappe +from frappe.model import no_value_fields, table_fields from frappe.model.document import Document from frappe.utils.background_jobs import get_jobs -from frappe.model import no_value_fields, table_fields + class EventUpdateLog(Document): def after_insert(self): """Send update notification updates to event consumers whenever update log is generated""" - enqueued_method = 'frappe.event_streaming.doctype.event_consumer.event_consumer.notify_event_consumers' + enqueued_method = ( + "frappe.event_streaming.doctype.event_consumer.event_consumer.notify_event_consumers" + ) jobs = get_jobs() if not jobs or enqueued_method not in jobs[frappe.local.site]: - frappe.enqueue(enqueued_method, doctype=self.ref_doctype, queue='long', - enqueue_after_commit=True) + frappe.enqueue( + enqueued_method, doctype=self.ref_doctype, queue="long", enqueue_after_commit=True + ) + def notify_consumers(doc, event): - '''called via hooks''' + """called via hooks""" # make event update log for doctypes having event consumers if frappe.flags.in_install or frappe.flags.in_migrate: return consumers = check_doctype_has_consumers(doc.doctype) if consumers: - if event=='after_insert': - doc.flags.event_update_log = make_event_update_log(doc, update_type='Create') - elif event=='on_trash': - make_event_update_log(doc, update_type='Delete') + if event == "after_insert": + doc.flags.event_update_log = make_event_update_log(doc, update_type="Create") + elif event == "on_trash": + make_event_update_log(doc, update_type="Delete") else: # on_update # called after saving - if not doc.flags.event_update_log: # if not already inserted + if not doc.flags.event_update_log: # if not already inserted diff = get_update(doc.get_doc_before_save(), doc) if diff: doc.diff = diff - make_event_update_log(doc, update_type='Update') + make_event_update_log(doc, update_type="Update") + def check_doctype_has_consumers(doctype): """Check if doctype has event consumers for event streaming""" - return frappe.cache_manager.get_doctype_map('Event Consumer Document Type', doctype, - dict(ref_doctype=doctype, status='Approved', unsubscribed=0)) + return frappe.cache_manager.get_doctype_map( + "Event Consumer Document Type", + doctype, + dict(ref_doctype=doctype, status="Approved", unsubscribed=0), + ) + def get_update(old, new, for_child=False): """ Get document objects with updates only If there is a change, then returns a dict like: { - "changed" : {fieldname1: new_value1, fieldname2: new_value2, }, - "added" : {table_fieldname1: [{row_dict1}, {row_dict2}], }, - "removed" : {table_fieldname1: [row_name1, row_name2], }, - "row_changed" : {table_fieldname1: - { - child_fieldname1: new_val, - child_fieldname2: new_val - }, - }, + "changed" : {fieldname1: new_value1, fieldname2: new_value2, }, + "added" : {table_fieldname1: [{row_dict1}, {row_dict2}], }, + "removed" : {table_fieldname1: [row_name1, row_name2], }, + "row_changed" : {table_fieldname1: + { + child_fieldname1: new_val, + child_fieldname2: new_val + }, + }, } """ if not new: @@ -82,20 +92,24 @@ def get_update(old, new, for_child=False): return out return None + def make_event_update_log(doc, update_type): """Save update info for doctypes that have event consumers""" - if update_type != 'Delete': + if update_type != "Delete": # diff for update type, doc for create type - data = frappe.as_json(doc) if not doc.get('diff') else frappe.as_json(doc.diff) + data = frappe.as_json(doc) if not doc.get("diff") else frappe.as_json(doc.diff) else: data = None - return frappe.get_doc({ - 'doctype': 'Event Update Log', - 'update_type': update_type, - 'ref_doctype': doc.doctype, - 'docname': doc.name, - 'data': data - }).insert(ignore_permissions=True) + return frappe.get_doc( + { + "doctype": "Event Update Log", + "update_type": update_type, + "ref_doctype": doc.doctype, + "docname": doc.name, + "data": data, + } + ).insert(ignore_permissions=True) + def make_maps(old_value, new_value): """make maps""" @@ -115,7 +129,7 @@ def check_for_additions(out, df, new_value, old_row_by_name): if diff and diff.changed: if not out.row_changed.get(df.fieldname): out.row_changed[df.fieldname] = [] - diff.changed['name'] = d.name + diff.changed["name"] = d.name out.row_changed[df.fieldname].append(diff.changed) else: if not out.added.get(df.fieldname): @@ -137,7 +151,7 @@ def check_for_deletions(out, df, old_value, new_row_by_name): def check_docstatus(out, old, new, for_child): """docstatus changes""" if not for_child and old.docstatus != new.docstatus: - out.changed['docstatus'] = new.docstatus + out.changed["docstatus"] = new.docstatus return out @@ -147,32 +161,32 @@ def is_consumer_uptodate(update_log, consumer): :param update_log: The UpdateLog Doc in context :param consumer: The EventConsumer doc """ - if update_log.update_type == 'Create': + if update_log.update_type == "Create": # consumer is obviously up to date return True prev_logs = frappe.get_all( - 'Event Update Log', + "Event Update Log", filters={ - 'ref_doctype': update_log.ref_doctype, - 'docname': update_log.docname, - 'creation': ['<', update_log.creation] + "ref_doctype": update_log.ref_doctype, + "docname": update_log.docname, + "creation": ["<", update_log.creation], }, - order_by='creation desc', - limit_page_length=1 + order_by="creation desc", + limit_page_length=1, ) if not len(prev_logs): return False prev_log_consumers = frappe.get_all( - 'Event Update Log Consumer', - fields=['consumer'], + "Event Update Log Consumer", + fields=["consumer"], filters={ - 'parent': prev_logs[0].name, - 'parenttype': 'Event Update Log', - 'consumer': consumer.name - } + "parent": prev_logs[0].name, + "parenttype": "Event Update Log", + "consumer": consumer.name, + }, ) return len(prev_log_consumers) > 0 @@ -182,24 +196,29 @@ def mark_consumer_read(update_log_name, consumer_name): """ This function appends the Consumer to the list of Consumers that has 'read' an Update Log """ - update_log = frappe.get_doc('Event Update Log', update_log_name) + update_log = frappe.get_doc("Event Update Log", update_log_name) if len([x for x in update_log.consumers if x.consumer == consumer_name]): return - frappe.get_doc(frappe._dict( - doctype='Event Update Log Consumer', + frappe.get_doc( + frappe._dict( + doctype="Event Update Log Consumer", consumer=consumer_name, parent=update_log_name, - parenttype='Event Update Log', - parentfield='consumers' - )).insert(ignore_permissions=True) + parenttype="Event Update Log", + parentfield="consumers", + ) + ).insert(ignore_permissions=True) def get_unread_update_logs(consumer_name, dt, dn): """ Get old logs unread by the consumer on a particular document """ - already_consumed = [x[0] for x in frappe.db.sql(""" + already_consumed = [ + x[0] + for x in frappe.db.sql( + """ SELECT update_log.name FROM `tabEvent Update Log` update_log @@ -208,23 +227,24 @@ def get_unread_update_logs(consumer_name, dt, dn): consumer.consumer = %(consumer)s AND update_log.ref_doctype = %(dt)s AND update_log.docname = %(dn)s - """, { - "consumer": consumer_name, - "dt": dt, - "dn": dn, - "log_name": "update_log.name" if frappe.conf.db_type == "mariadb" else "CAST(update_log.name AS VARCHAR)" - }, as_dict=0)] + """, + { + "consumer": consumer_name, + "dt": dt, + "dn": dn, + "log_name": "update_log.name" + if frappe.conf.db_type == "mariadb" + else "CAST(update_log.name AS VARCHAR)", + }, + as_dict=0, + ) + ] logs = frappe.get_all( - 'Event Update Log', - fields=['update_type', 'ref_doctype', - 'docname', 'data', 'name', 'creation'], - filters={ - 'ref_doctype': dt, - 'docname': dn, - 'name': ['not in', already_consumed] - }, - order_by='creation' + "Event Update Log", + fields=["update_type", "ref_doctype", "docname", "data", "name", "creation"], + filters={"ref_doctype": dt, "docname": dn, "name": ["not in", already_consumed]}, + order_by="creation", ) return logs @@ -242,14 +262,12 @@ def get_update_logs_for_consumer(event_consumer, doctypes, last_update): from frappe.event_streaming.doctype.event_consumer.event_consumer import has_consumer_access - consumer = frappe.get_doc('Event Consumer', event_consumer) + consumer = frappe.get_doc("Event Consumer", event_consumer) docs = frappe.get_list( - doctype='Event Update Log', - filters={'ref_doctype': ('in', doctypes), - 'creation': ('>', last_update)}, - fields=['update_type', 'ref_doctype', - 'docname', 'data', 'name', 'creation'], - order_by='creation desc' + doctype="Event Update Log", + filters={"ref_doctype": ("in", doctypes), "creation": (">", last_update)}, + fields=["update_type", "ref_doctype", "docname", "data", "name", "creation"], + order_by="creation desc", ) result = [] @@ -272,9 +290,8 @@ def get_update_logs_for_consumer(event_consumer, doctypes, last_update): else: result.append(d) - for d in result: mark_consumer_read(update_log_name=d.name, consumer_name=consumer.name) result.reverse() - return result \ No newline at end of file + return result diff --git a/frappe/event_streaming/doctype/event_update_log/test_event_update_log.py b/frappe/event_streaming/doctype/event_update_log/test_event_update_log.py index 752f4bbb44..673164b8d7 100644 --- a/frappe/event_streaming/doctype/event_update_log/test_event_update_log.py +++ b/frappe/event_streaming/doctype/event_update_log/test_event_update_log.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestEventUpdateLog(unittest.TestCase): pass diff --git a/frappe/event_streaming/doctype/event_update_log_consumer/event_update_log_consumer.py b/frappe/event_streaming/doctype/event_update_log_consumer/event_update_log_consumer.py index 47180db74e..4f00504538 100644 --- a/frappe/event_streaming/doctype/event_update_log_consumer/event_update_log_consumer.py +++ b/frappe/event_streaming/doctype/event_update_log_consumer/event_update_log_consumer.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class EventUpdateLogConsumer(Document): pass diff --git a/frappe/exceptions.py b/frappe/exceptions.py index fcac349708..a8569481d3 100644 --- a/frappe/exceptions.py +++ b/frappe/exceptions.py @@ -4,47 +4,61 @@ # BEWARE don't put anything in this file except exceptions from werkzeug.exceptions import NotFound + class SiteNotSpecifiedError(Exception): def __init__(self, *args, **kwargs): self.message = "Please specify --site sitename" super(Exception, self).__init__(self.message) + class ValidationError(Exception): http_status_code = 417 + class AuthenticationError(Exception): http_status_code = 401 + class SessionExpired(Exception): http_status_code = 401 + class PermissionError(Exception): http_status_code = 403 + class DoesNotExistError(ValidationError): http_status_code = 404 + class PageDoesNotExistError(ValidationError): http_status_code = 404 + class NameError(Exception): http_status_code = 409 + class OutgoingEmailError(Exception): http_status_code = 501 + class SessionStopped(Exception): http_status_code = 503 + class UnsupportedMediaType(Exception): http_status_code = 415 + class RequestToken(Exception): http_status_code = 200 + class Redirect(Exception): http_status_code = 301 + class CSRFTokenError(Exception): http_status_code = 400 @@ -58,58 +72,194 @@ class ImproperDBConfigurationError(Exception): Used when frappe detects that database or tables are not properly configured """ + def __init__(self, reason, msg=None): if not msg: msg = "MariaDb is not properly configured" super(ImproperDBConfigurationError, self).__init__(msg) self.reason = reason -class DuplicateEntryError(NameError):pass -class DataError(ValidationError): pass -class UnknownDomainError(Exception): pass -class MappingMismatchError(ValidationError): pass -class InvalidStatusError(ValidationError): pass -class MandatoryError(ValidationError): pass -class NonNegativeError(ValidationError): pass -class InvalidSignatureError(ValidationError): pass -class RateLimitExceededError(ValidationError): pass -class CannotChangeConstantError(ValidationError): pass -class CharacterLengthExceededError(ValidationError): pass -class UpdateAfterSubmitError(ValidationError): pass -class LinkValidationError(ValidationError): pass -class CancelledLinkError(LinkValidationError): pass -class DocstatusTransitionError(ValidationError): pass -class TimestampMismatchError(ValidationError): pass -class EmptyTableError(ValidationError): pass -class LinkExistsError(ValidationError): pass -class InvalidEmailAddressError(ValidationError): pass -class InvalidNameError(ValidationError): pass -class InvalidPhoneNumberError(ValidationError): pass -class TemplateNotFoundError(ValidationError): pass -class UniqueValidationError(ValidationError): pass -class AppNotInstalledError(ValidationError): pass -class IncorrectSitePath(NotFound): pass -class ImplicitCommitError(ValidationError): pass -class RetryBackgroundJobError(Exception): pass -class DocumentLockedError(ValidationError): pass -class CircularLinkingError(ValidationError): pass -class SecurityException(Exception): pass -class InvalidColumnName(ValidationError): pass -class IncompatibleApp(ValidationError): pass -class InvalidDates(ValidationError): pass -class DataTooLongException(ValidationError): pass -class FileAlreadyAttachedException(Exception): pass -class DocumentAlreadyRestored(ValidationError): pass -class AttachmentLimitReached(ValidationError): pass -class QueryTimeoutError(Exception): pass -class QueryDeadlockError(Exception): pass -class TooManyWritesError(Exception): pass + +class DuplicateEntryError(NameError): + pass + + +class DataError(ValidationError): + pass + + +class UnknownDomainError(Exception): + pass + + +class MappingMismatchError(ValidationError): + pass + + +class InvalidStatusError(ValidationError): + pass + + +class MandatoryError(ValidationError): + pass + + +class NonNegativeError(ValidationError): + pass + + +class InvalidSignatureError(ValidationError): + pass + + +class RateLimitExceededError(ValidationError): + pass + + +class CannotChangeConstantError(ValidationError): + pass + + +class CharacterLengthExceededError(ValidationError): + pass + + +class UpdateAfterSubmitError(ValidationError): + pass + + +class LinkValidationError(ValidationError): + pass + + +class CancelledLinkError(LinkValidationError): + pass + + +class DocstatusTransitionError(ValidationError): + pass + + +class TimestampMismatchError(ValidationError): + pass + + +class EmptyTableError(ValidationError): + pass + + +class LinkExistsError(ValidationError): + pass + + +class InvalidEmailAddressError(ValidationError): + pass + + +class InvalidNameError(ValidationError): + pass + + +class InvalidPhoneNumberError(ValidationError): + pass + + +class TemplateNotFoundError(ValidationError): + pass + + +class UniqueValidationError(ValidationError): + pass + + +class AppNotInstalledError(ValidationError): + pass + + +class IncorrectSitePath(NotFound): + pass + + +class ImplicitCommitError(ValidationError): + pass + + +class RetryBackgroundJobError(Exception): + pass + + +class DocumentLockedError(ValidationError): + pass + + +class CircularLinkingError(ValidationError): + pass + + +class SecurityException(Exception): + pass + + +class InvalidColumnName(ValidationError): + pass + + +class IncompatibleApp(ValidationError): + pass + + +class InvalidDates(ValidationError): + pass + + +class DataTooLongException(ValidationError): + pass + + +class FileAlreadyAttachedException(Exception): + pass + + +class DocumentAlreadyRestored(ValidationError): + pass + + +class AttachmentLimitReached(ValidationError): + pass + + +class QueryTimeoutError(Exception): + pass + + +class QueryDeadlockError(Exception): + pass + + +class TooManyWritesError(Exception): + pass + + # OAuth exceptions -class InvalidAuthorizationHeader(CSRFTokenError): pass -class InvalidAuthorizationPrefix(CSRFTokenError): pass -class InvalidAuthorizationToken(CSRFTokenError): pass -class InvalidDatabaseFile(ValidationError): pass -class ExecutableNotFound(FileNotFoundError): pass +class InvalidAuthorizationHeader(CSRFTokenError): + pass + + +class InvalidAuthorizationPrefix(CSRFTokenError): + pass + + +class InvalidAuthorizationToken(CSRFTokenError): + pass + + +class InvalidDatabaseFile(ValidationError): + pass + + +class ExecutableNotFound(FileNotFoundError): + pass + class InvalidRemoteException(Exception): pass diff --git a/frappe/frappeclient.py b/frappe/frappeclient.py index 7a1587aae0..04087463bc 100644 --- a/frappe/frappeclient.py +++ b/frappe/frappeclient.py @@ -1,6 +1,6 @@ -''' +""" FrappeClient is a library that helps you connect with other frappe systems -''' +""" import base64 import json @@ -13,20 +13,33 @@ from frappe.utils.data import cstr class AuthError(Exception): pass + class SiteExpiredError(Exception): pass + class SiteUnreachableError(Exception): pass + class FrappeException(Exception): pass + class FrappeClient(object): - def __init__(self, url, username=None, password=None, verify=True, api_key=None, api_secret=None, frappe_authorization_source=None): + def __init__( + self, + url, + username=None, + password=None, + verify=True, + api_key=None, + api_secret=None, + frappe_authorization_source=None, + ): self.headers = { - 'Accept': 'application/json', - 'content-type': 'application/x-www-form-urlencoded', + "Accept": "application/json", + "content-type": "application/x-www-form-urlencoded", } self.verify = verify self.session = requests.session() @@ -48,21 +61,22 @@ class FrappeClient(object): self.logout() def _login(self, username, password): - '''Login/start a sesion. Called internally on init''' - r = self.session.post(self.url, params={ - 'cmd': 'login', - 'usr': username, - 'pwd': password - }, verify=self.verify, headers=self.headers) - - if r.status_code==200 and r.json().get('message') in ("Logged In", "No App"): + """Login/start a sesion. Called internally on init""" + r = self.session.post( + self.url, + params={"cmd": "login", "usr": username, "pwd": password}, + verify=self.verify, + headers=self.headers, + ) + + if r.status_code == 200 and r.json().get("message") in ("Logged In", "No App"): return r.json() elif r.status_code == 502: raise SiteUnreachableError else: try: error = json.loads(r.text) - if error.get('exc_type') == "SiteExpiredError": + if error.get("exc_type") == "SiteExpiredError": raise SiteExpiredError except json.decoder.JSONDecodeError: error = r.text @@ -71,21 +85,28 @@ class FrappeClient(object): def setup_key_authentication_headers(self): if self.api_key and self.api_secret: - token = base64.b64encode(('{}:{}'.format(self.api_key, self.api_secret)).encode('utf-8')).decode('utf-8') + token = base64.b64encode( + ("{}:{}".format(self.api_key, self.api_secret)).encode("utf-8") + ).decode("utf-8") auth_header = { - 'Authorization': 'Basic {}'.format(token), + "Authorization": "Basic {}".format(token), } self.headers.update(auth_header) if self.frappe_authorization_source: - auth_source = {'Frappe-Authorization-Source': self.frappe_authorization_source} + auth_source = {"Frappe-Authorization-Source": self.frappe_authorization_source} self.headers.update(auth_source) def logout(self): - '''Logout session''' - self.session.get(self.url, params={ - 'cmd': 'logout', - }, verify=self.verify, headers=self.headers) + """Logout session""" + self.session.get( + self.url, + params={ + "cmd": "logout", + }, + verify=self.verify, + headers=self.headers, + ) def get_list(self, doctype, fields='["name"]', filters=None, limit_start=0, limit_page_length=0): """Returns list of records of a particular type""" @@ -99,144 +120,147 @@ class FrappeClient(object): if limit_page_length: params["limit_start"] = limit_start params["limit_page_length"] = limit_page_length - res = self.session.get(self.url + "/api/resource/" + doctype, params=params, verify=self.verify, headers=self.headers) + res = self.session.get( + self.url + "/api/resource/" + doctype, params=params, verify=self.verify, headers=self.headers + ) return self.post_process(res) def insert(self, doc): - '''Insert a document to the remote server - - :param doc: A dict or Document object to be inserted remotely''' - res = self.session.post(self.url + "/api/resource/" + doc.get("doctype"), - data={"data":frappe.as_json(doc)}, verify=self.verify, headers=self.headers) + """Insert a document to the remote server + + :param doc: A dict or Document object to be inserted remotely""" + res = self.session.post( + self.url + "/api/resource/" + doc.get("doctype"), + data={"data": frappe.as_json(doc)}, + verify=self.verify, + headers=self.headers, + ) return frappe._dict(self.post_process(res)) def insert_many(self, docs): - '''Insert multiple documents to the remote server + """Insert multiple documents to the remote server - :param docs: List of dict or Document objects to be inserted in one request''' - return self.post_request({ - "cmd": "frappe.client.insert_many", - "docs": frappe.as_json(docs) - }) + :param docs: List of dict or Document objects to be inserted in one request""" + return self.post_request({"cmd": "frappe.client.insert_many", "docs": frappe.as_json(docs)}) def update(self, doc): - '''Update a remote document + """Update a remote document - :param doc: dict or Document object to be updated remotely. `name` is mandatory for this''' + :param doc: dict or Document object to be updated remotely. `name` is mandatory for this""" url = self.url + "/api/resource/" + doc.get("doctype") + "/" + cstr(doc.get("name")) - res = self.session.put(url, data={"data":frappe.as_json(doc)}, verify=self.verify, headers=self.headers) + res = self.session.put( + url, data={"data": frappe.as_json(doc)}, verify=self.verify, headers=self.headers + ) return frappe._dict(self.post_process(res)) def bulk_update(self, docs): - '''Bulk update documents remotely + """Bulk update documents remotely - :param docs: List of dict or Document objects to be updated remotely (by `name`)''' - return self.post_request({ - "cmd": "frappe.client.bulk_update", - "docs": frappe.as_json(docs) - }) + :param docs: List of dict or Document objects to be updated remotely (by `name`)""" + return self.post_request({"cmd": "frappe.client.bulk_update", "docs": frappe.as_json(docs)}) def delete(self, doctype, name): - '''Delete remote document by name + """Delete remote document by name :param doctype: `doctype` to be deleted - :param name: `name` of document to be deleted''' - return self.post_request({ - "cmd": "frappe.client.delete", - "doctype": doctype, - "name": name - }) + :param name: `name` of document to be deleted""" + return self.post_request({"cmd": "frappe.client.delete", "doctype": doctype, "name": name}) def submit(self, doc): - '''Submit remote document + """Submit remote document - :param doc: dict or Document object to be submitted remotely''' - return self.post_request({ - "cmd": "frappe.client.submit", - "doc": frappe.as_json(doc) - }) + :param doc: dict or Document object to be submitted remotely""" + return self.post_request({"cmd": "frappe.client.submit", "doc": frappe.as_json(doc)}) def get_value(self, doctype, fieldname=None, filters=None): - '''Returns a value form a document + """Returns a value form a document :param doctype: DocType to be queried :param fieldname: Field to be returned (default `name`) - :param filters: dict or string for identifying the record''' - return self.get_request({ - "cmd": "frappe.client.get_value", - "doctype": doctype, - "fieldname": fieldname or "name", - "filters": frappe.as_json(filters) - }) + :param filters: dict or string for identifying the record""" + return self.get_request( + { + "cmd": "frappe.client.get_value", + "doctype": doctype, + "fieldname": fieldname or "name", + "filters": frappe.as_json(filters), + } + ) def set_value(self, doctype, docname, fieldname, value): - '''Set a value in a remote document + """Set a value in a remote document :param doctype: DocType of the document to be updated :param docname: name of the document to be updated :param fieldname: fieldname of the document to be updated - :param value: value to be updated''' - return self.post_request({ - "cmd": "frappe.client.set_value", - "doctype": doctype, - "name": docname, - "fieldname": fieldname, - "value": value - }) + :param value: value to be updated""" + return self.post_request( + { + "cmd": "frappe.client.set_value", + "doctype": doctype, + "name": docname, + "fieldname": fieldname, + "value": value, + } + ) def cancel(self, doctype, name): - '''Cancel a remote document + """Cancel a remote document :param doctype: DocType of the document to be cancelled - :param name: name of the document to be cancelled''' - return self.post_request({ - "cmd": "frappe.client.cancel", - "doctype": doctype, - "name": name - }) + :param name: name of the document to be cancelled""" + return self.post_request({"cmd": "frappe.client.cancel", "doctype": doctype, "name": name}) def get_doc(self, doctype, name="", filters=None, fields=None): - '''Returns a single remote document + """Returns a single remote document :param doctype: DocType of the document to be returned :param name: (optional) `name` of the document to be returned :param filters: (optional) Filter by this dict if name is not set - :param fields: (optional) Fields to be returned, will return everythign if not set''' + :param fields: (optional) Fields to be returned, will return everythign if not set""" params = {} if filters: params["filters"] = json.dumps(filters) if fields: params["fields"] = json.dumps(fields) - res = self.session.get(self.url + "/api/resource/" + doctype + "/" + cstr(name), - params=params, verify=self.verify, headers=self.headers) + res = self.session.get( + self.url + "/api/resource/" + doctype + "/" + cstr(name), + params=params, + verify=self.verify, + headers=self.headers, + ) return self.post_process(res) def rename_doc(self, doctype, old_name, new_name): - '''Rename remote document + """Rename remote document :param doctype: DocType of the document to be renamed :param old_name: Current `name` of the document to be renamed - :param new_name: New `name` to be set''' + :param new_name: New `name` to be set""" params = { "cmd": "frappe.client.rename_doc", "doctype": doctype, "old_name": old_name, - "new_name": new_name + "new_name": new_name, } return self.post_request(params) - def migrate_doctype(self, doctype, filters=None, update=None, verbose=1, exclude=None, preprocess=None): + def migrate_doctype( + self, doctype, filters=None, update=None, verbose=1, exclude=None, preprocess=None + ): """Migrate records from another doctype""" meta = frappe.get_meta(doctype) tables = {} for df in meta.get_table_fields(): - if verbose: print("getting " + df.options) + if verbose: + print("getting " + df.options) tables[df.fieldname] = self.get_list(df.options, limit_page_length=999999) # get links - if verbose: print("getting " + doctype) + if verbose: + print("getting " + doctype) docs = self.get_list(doctype, limit_page_length=999999, filters=filters) # build - attach children to parents @@ -250,7 +274,8 @@ class FrappeClient(object): if child.parent in docs_map: docs_map[child.parent].setdefault(fieldname, []).append(child) - if verbose: print("inserting " + doctype) + if verbose: + print("inserting " + doctype) for doc in docs: if exclude and doc["name"] in exclude: continue @@ -262,8 +287,9 @@ class FrappeClient(object): doc["owner"] = "Administrator" if doctype != "User" and not frappe.db.exists("User", doc.get("owner")): - frappe.get_doc({"doctype": "User", "email": doc.get("owner"), - "first_name": doc.get("owner").split("@")[0] }).insert() + frappe.get_doc( + {"doctype": "User", "email": doc.get("owner"), "first_name": doc.get("owner").split("@")[0]} + ).insert() if update: doc.update(update) @@ -274,12 +300,20 @@ class FrappeClient(object): if not meta.istable: if doctype != "Communication": - self.migrate_doctype("Communication", {"reference_doctype": doctype, "reference_name": doc["name"]}, - update={"reference_name": new_doc.name}, verbose=0) + self.migrate_doctype( + "Communication", + {"reference_doctype": doctype, "reference_name": doc["name"]}, + update={"reference_name": new_doc.name}, + verbose=0, + ) if doctype != "File": - self.migrate_doctype("File", {"attached_to_doctype": doctype, - "attached_to_name": doc["name"]}, update={"attached_to_name": new_doc.name}, verbose=0) + self.migrate_doctype( + "File", + {"attached_to_doctype": doctype, "attached_to_name": doc["name"]}, + update={"attached_to_name": new_doc.name}, + verbose=0, + ) def migrate_single(self, doctype): doc = self.get_doc(doctype, doctype) @@ -292,24 +326,30 @@ class FrappeClient(object): def get_api(self, method, params=None): if params is None: params = {} - res = self.session.get(f"{self.url}/api/method/{method}", - params=params, verify=self.verify, headers=self.headers) + res = self.session.get( + f"{self.url}/api/method/{method}", params=params, verify=self.verify, headers=self.headers + ) return self.post_process(res) def post_api(self, method, params=None): if params is None: params = {} - res = self.session.post(f"{self.url}/api/method/{method}", - params=params, verify=self.verify, headers=self.headers) + res = self.session.post( + f"{self.url}/api/method/{method}", params=params, verify=self.verify, headers=self.headers + ) return self.post_process(res) def get_request(self, params): - res = self.session.get(self.url, params=self.preprocess(params), verify=self.verify, headers=self.headers) + res = self.session.get( + self.url, params=self.preprocess(params), verify=self.verify, headers=self.headers + ) res = self.post_process(res) return res def post_request(self, data): - res = self.session.post(self.url, data=self.preprocess(data), verify=self.verify, headers=self.headers) + res = self.session.post( + self.url, data=self.preprocess(data), verify=self.verify, headers=self.headers + ) res = self.post_process(res) return res @@ -331,48 +371,57 @@ class FrappeClient(object): if rjson and ("exc" in rjson) and rjson["exc"]: try: exc = json.loads(rjson["exc"])[0] - exc = 'FrappeClient Request Failed\n\n' + exc + exc = "FrappeClient Request Failed\n\n" + exc except Exception: exc = rjson["exc"] raise FrappeException(exc) - if 'message' in rjson: - return rjson['message'] - elif 'data' in rjson: - return rjson['data'] + if "message" in rjson: + return rjson["message"] + elif "data" in rjson: + return rjson["data"] else: return None + class FrappeOAuth2Client(FrappeClient): def __init__(self, url, access_token, verify=True): self.access_token = access_token self.headers = { "Authorization": "Bearer " + access_token, - "content-type": "application/x-www-form-urlencoded" + "content-type": "application/x-www-form-urlencoded", } self.verify = verify self.session = OAuth2Session(self.headers) self.url = url def get_request(self, params): - res = requests.get(self.url, params=self.preprocess(params), headers=self.headers, verify=self.verify) + res = requests.get( + self.url, params=self.preprocess(params), headers=self.headers, verify=self.verify + ) res = self.post_process(res) return res def post_request(self, data): - res = requests.post(self.url, data=self.preprocess(data), headers=self.headers, verify=self.verify) + res = requests.post( + self.url, data=self.preprocess(data), headers=self.headers, verify=self.verify + ) res = self.post_process(res) return res -class OAuth2Session(): + +class OAuth2Session: def __init__(self, headers): self.headers = headers + def get(self, url, params, verify): res = requests.get(url, params=params, headers=self.headers, verify=verify) return res + def post(self, url, data, verify): res = requests.post(url, data=data, headers=self.headers, verify=verify) return res + def put(self, url, data, verify): res = requests.put(url, data=data, headers=self.headers, verify=verify) return res diff --git a/frappe/geo/country_info.py b/frappe/geo/country_info.py index 86f1d9bc2f..1de8467a6a 100644 --- a/frappe/geo/country_info.py +++ b/frappe/geo/country_info.py @@ -1,43 +1,48 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json + # all country info -import os, json, frappe +import os + +import frappe from frappe.utils.momentjs import get_all_timezones + def get_country_info(country=None): data = get_all() data = frappe._dict(data.get(country, {})) - if 'date_format' not in data: + if "date_format" not in data: data.date_format = "dd-mm-yyyy" - if 'time_format' not in data: + if "time_format" not in data: data.time_format = "HH:mm:ss" return data + def get_all(): with open(os.path.join(os.path.dirname(__file__), "country_info.json"), "r") as local_info: all_data = json.loads(local_info.read()) return all_data + @frappe.whitelist() def get_country_timezone_info(): - return { - "country_info": get_all(), - "all_timezones": get_all_timezones() - } + return {"country_info": get_all(), "all_timezones": get_all_timezones()} + def get_translated_dict(): - from babel.dates import get_timezone, get_timezone_name, Locale + from babel.dates import Locale, get_timezone, get_timezone_name translated_dict = {} locale = Locale.parse(frappe.local.lang, sep="-") # timezones for tz in get_all_timezones(): - timezone_name = get_timezone_name(get_timezone(tz), locale=locale, width='short') + timezone_name = get_timezone_name(get_timezone(tz), locale=locale, width="short") if timezone_name: - translated_dict[tz] = timezone_name + ' - ' + tz + translated_dict[tz] = timezone_name + " - " + tz # country names && currencies for country, info in get_all().items(): @@ -52,6 +57,7 @@ def get_translated_dict(): return translated_dict + def update(): with open(os.path.join(os.path.dirname(__file__), "currency_info.json"), "r") as nformats: nformats = json.loads(nformats.read()) @@ -60,8 +66,9 @@ def update(): for country in all_data: data = all_data[country] - data["number_format"] = nformats.get(data.get("currency", "default"), - nformats.get("default"))["display"] + data["number_format"] = nformats.get(data.get("currency", "default"), nformats.get("default"))[ + "display" + ] with open(os.path.join(os.path.dirname(__file__), "country_info.json"), "w") as local_info: local_info.write(json.dumps(all_data, indent=1)) diff --git a/frappe/geo/doctype/country/country.py b/frappe/geo/doctype/country/country.py index a648744058..b3ba1b7127 100644 --- a/frappe/geo/doctype/country/country.py +++ b/frappe/geo/doctype/country/country.py @@ -2,8 +2,8 @@ # License: MIT. See LICENSE import frappe - from frappe.model.document import Document + class Country(Document): - pass \ No newline at end of file + pass diff --git a/frappe/geo/doctype/country/test_country.py b/frappe/geo/doctype/country/test_country.py index b4d15f81b3..ecc2fb6863 100644 --- a/frappe/geo/doctype/country/test_country.py +++ b/frappe/geo/doctype/country/test_country.py @@ -2,4 +2,5 @@ # License: MIT. See LICENSE import frappe -test_records = frappe.get_test_records('Country') \ No newline at end of file + +test_records = frappe.get_test_records("Country") diff --git a/frappe/geo/doctype/currency/currency.py b/frappe/geo/doctype/currency/currency.py index fbe37e73bd..dd5df57bab 100644 --- a/frappe/geo/doctype/currency/currency.py +++ b/frappe/geo/doctype/currency/currency.py @@ -2,10 +2,10 @@ # License: MIT. See LICENSE import frappe -from frappe import throw, _ - +from frappe import _, throw from frappe.model.document import Document + class Currency(Document): def validate(self): if not frappe.flags.in_install_app: diff --git a/frappe/geo/doctype/currency/test_currency.py b/frappe/geo/doctype/currency/test_currency.py index 71b963cc86..f93a452462 100644 --- a/frappe/geo/doctype/currency/test_currency.py +++ b/frappe/geo/doctype/currency/test_currency.py @@ -4,4 +4,5 @@ # pre loaded import frappe -test_records = frappe.get_test_records('Currency') \ No newline at end of file + +test_records = frappe.get_test_records("Currency") diff --git a/frappe/geo/utils.py b/frappe/geo/utils.py index 9b44a2f3d8..577c5de2ff 100644 --- a/frappe/geo/utils.py +++ b/frappe/geo/utils.py @@ -2,92 +2,101 @@ # Copyright (c) 2020, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe - from pymysql import InternalError +import frappe + @frappe.whitelist() def get_coords(doctype, filters, type): - '''Get a geojson dict representing a doctype.''' + """Get a geojson dict representing a doctype.""" filters_sql = get_coords_conditions(doctype, filters)[4:] coords = None - if type == 'location_field': + if type == "location_field": coords = return_location(doctype, filters_sql) - elif type == 'coordinates': + elif type == "coordinates": coords = return_coordinates(doctype, filters_sql) out = convert_to_geojson(type, coords) return out + def convert_to_geojson(type, coords): - '''Converts GPS coordinates to geoJSON string.''' + """Converts GPS coordinates to geoJSON string.""" geojson = {"type": "FeatureCollection", "features": None} - if type == 'location_field': - geojson['features'] = merge_location_features_in_one(coords) - elif type == 'coordinates': - geojson['features'] = create_gps_markers(coords) + if type == "location_field": + geojson["features"] = merge_location_features_in_one(coords) + elif type == "coordinates": + geojson["features"] = create_gps_markers(coords) return geojson def merge_location_features_in_one(coords): - '''Merging all features from location field.''' + """Merging all features from location field.""" geojson_dict = [] for element in coords: - geojson_loc = frappe.parse_json(element['location']) + geojson_loc = frappe.parse_json(element["location"]) if not geojson_loc: continue - for coord in geojson_loc['features']: - coord['properties']['name'] = element['name'] + for coord in geojson_loc["features"]: + coord["properties"]["name"] = element["name"] geojson_dict.append(coord.copy()) return geojson_dict def create_gps_markers(coords): - '''Build Marker based on latitude and longitude.''' + """Build Marker based on latitude and longitude.""" geojson_dict = [] for i in coords: node = {"type": "Feature", "properties": {}, "geometry": {"type": "Point", "coordinates": None}} - node['properties']['name'] = i.name - node['geometry']['coordinates'] = [i.latitude, i.longitude] + node["properties"]["name"] = i.name + node["geometry"]["coordinates"] = [i.latitude, i.longitude] geojson_dict.append(node.copy()) return geojson_dict def return_location(doctype, filters_sql): - '''Get name and location fields for Doctype.''' + """Get name and location fields for Doctype.""" if filters_sql: try: - coords = frappe.db.sql('''SELECT name, location FROM `tab{}` WHERE {}'''.format(doctype, filters_sql), as_dict=True) + coords = frappe.db.sql( + """SELECT name, location FROM `tab{}` WHERE {}""".format(doctype, filters_sql), as_dict=True + ) except InternalError: - frappe.msgprint(frappe._('This Doctype does not contain location fields'), raise_exception=True) + frappe.msgprint(frappe._("This Doctype does not contain location fields"), raise_exception=True) return else: - coords = frappe.get_all(doctype, fields=['name', 'location']) + coords = frappe.get_all(doctype, fields=["name", "location"]) return coords def return_coordinates(doctype, filters_sql): - '''Get name, latitude and longitude fields for Doctype.''' + """Get name, latitude and longitude fields for Doctype.""" if filters_sql: try: - coords = frappe.db.sql('''SELECT name, latitude, longitude FROM `tab{}` WHERE {}'''.format(doctype, filters_sql), as_dict=True) + coords = frappe.db.sql( + """SELECT name, latitude, longitude FROM `tab{}` WHERE {}""".format(doctype, filters_sql), + as_dict=True, + ) except InternalError: - frappe.msgprint(frappe._('This Doctype does not contain latitude and longitude fields'), raise_exception=True) + frappe.msgprint( + frappe._("This Doctype does not contain latitude and longitude fields"), raise_exception=True + ) return else: - coords = frappe.get_all(doctype, fields=['name', 'latitude', 'longitude']) + coords = frappe.get_all(doctype, fields=["name", "latitude", "longitude"]) return coords def get_coords_conditions(doctype, filters=None): - '''Returns SQL conditions with user permissions and filters for event queries.''' + """Returns SQL conditions with user permissions and filters for event queries.""" from frappe.desk.reportview import get_filters_cond + if not frappe.has_permission(doctype): frappe.throw(frappe._("Not Permitted"), frappe.PermissionError) diff --git a/frappe/handler.py b/frappe/handler.py index ebc72da937..7b010eb716 100644 --- a/frappe/handler.py +++ b/frappe/handler.py @@ -1,24 +1,31 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +from mimetypes import guess_type + from werkzeug.wrappers import Response import frappe -import frappe.utils import frappe.sessions -from frappe.utils import cint +import frappe.utils from frappe import _, is_whitelisted -from frappe.utils.response import build_response +from frappe.core.doctype.server_script.server_script_utils import get_server_script_map +from frappe.utils import cint from frappe.utils.csvutils import build_csv_response from frappe.utils.image import optimize_image -from mimetypes import guess_type -from frappe.core.doctype.server_script.server_script_utils import get_server_script_map - +from frappe.utils.response import build_response -ALLOWED_MIMETYPES = ('image/png', 'image/jpeg', 'application/pdf', 'application/msword', - 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', - 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', - 'application/vnd.oasis.opendocument.text', 'application/vnd.oasis.opendocument.spreadsheet') +ALLOWED_MIMETYPES = ( + "image/png", + "image/jpeg", + "application/pdf", + "application/msword", + "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "application/vnd.ms-excel", + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "application/vnd.oasis.opendocument.text", + "application/vnd.oasis.opendocument.spreadsheet", +) def handle(): @@ -27,7 +34,7 @@ def handle(): cmd = frappe.local.form_dict.cmd data = None - if cmd != 'login': + if cmd != "login": data = execute_cmd(cmd) # data can be an empty string or list which are valid responses @@ -37,10 +44,11 @@ def handle(): return data # add the response to `message` label - frappe.response['message'] = data + frappe.response["message"] = data return build_response("json") + def execute_cmd(cmd, from_async=False): """execute a request as python module""" for hook in frappe.get_hooks("override_whitelisted_methods", {}).get(cmd, []): @@ -49,14 +57,14 @@ def execute_cmd(cmd, from_async=False): break # via server script - server_script = get_server_script_map().get('_api', {}).get(cmd) + server_script = get_server_script_map().get("_api", {}).get(cmd) if server_script: return run_server_script(server_script) try: method = get_attr(cmd) except Exception as e: - frappe.throw(_('Failed to get method for command {0} with {1}').format(cmd, e)) + frappe.throw(_("Failed to get method for command {0} with {1}").format(cmd, e)) if from_async: method = method.queue @@ -69,7 +77,7 @@ def execute_cmd(cmd, from_async=False): def run_server_script(server_script): - response = frappe.get_doc('Server Script', server_script).execute_method() + response = frappe.get_doc("Server Script", server_script).execute_method() # some server scripts return output using flags (empty dict by default), # while others directly modify frappe.response @@ -77,6 +85,7 @@ def run_server_script(server_script): if response != {}: return response + def is_valid_http_method(method): if frappe.flags.in_safe_exec: return @@ -86,65 +95,74 @@ def is_valid_http_method(method): if http_method not in frappe.allowed_http_methods_for_whitelisted_func[method]: throw_permission_error() + def throw_permission_error(): frappe.throw(_("Not permitted"), frappe.PermissionError) + @frappe.whitelist(allow_guest=True) def version(): return frappe.__version__ + @frappe.whitelist(allow_guest=True) def logout(): frappe.local.login_manager.logout() frappe.db.commit() + @frappe.whitelist(allow_guest=True) def web_logout(): frappe.local.login_manager.logout() frappe.db.commit() - frappe.respond_as_web_page(_("Logged Out"), _("You have been successfully logged out"), - indicator_color='green') + frappe.respond_as_web_page( + _("Logged Out"), _("You have been successfully logged out"), indicator_color="green" + ) + @frappe.whitelist() def uploadfile(): ret = None try: - if frappe.form_dict.get('from_form'): + if frappe.form_dict.get("from_form"): try: - ret = frappe.get_doc({ - "doctype": "File", - "attached_to_name": frappe.form_dict.docname, - "attached_to_doctype": frappe.form_dict.doctype, - "attached_to_field": frappe.form_dict.docfield, - "file_url": frappe.form_dict.file_url, - "file_name": frappe.form_dict.filename, - "is_private": frappe.utils.cint(frappe.form_dict.is_private), - "content": frappe.form_dict.filedata, - "decode": True - }) + ret = frappe.get_doc( + { + "doctype": "File", + "attached_to_name": frappe.form_dict.docname, + "attached_to_doctype": frappe.form_dict.doctype, + "attached_to_field": frappe.form_dict.docfield, + "file_url": frappe.form_dict.file_url, + "file_name": frappe.form_dict.filename, + "is_private": frappe.utils.cint(frappe.form_dict.is_private), + "content": frappe.form_dict.filedata, + "decode": True, + } + ) ret.save() except frappe.DuplicateEntryError: # ignore pass ret = None frappe.db.rollback() else: - if frappe.form_dict.get('method'): + if frappe.form_dict.get("method"): method = frappe.get_attr(frappe.form_dict.method) is_whitelisted(method) ret = method() except Exception: frappe.errprint(frappe.utils.get_traceback()) - frappe.response['http_status_code'] = 500 + frappe.response["http_status_code"] = 500 ret = None return ret + @frappe.whitelist(allow_guest=True) def upload_file(): user = None - if frappe.session.user == 'Guest': - if frappe.get_system_settings('allow_guests_to_upload_files'): + if frappe.session.user == "Guest": + if frappe.get_system_settings("allow_guests_to_upload_files"): ignore_permissions = True else: return @@ -158,23 +176,20 @@ def upload_file(): docname = frappe.form_dict.docname fieldname = frappe.form_dict.fieldname file_url = frappe.form_dict.file_url - folder = frappe.form_dict.folder or 'Home' + folder = frappe.form_dict.folder or "Home" method = frappe.form_dict.method filename = frappe.form_dict.file_name optimize = frappe.form_dict.optimize content = None - if 'file' in files: - file = files['file'] + if "file" in files: + file = files["file"] content = file.stream.read() filename = file.filename content_type = guess_type(filename)[0] if optimize and content_type.startswith("image/"): - args = { - "content": content, - "content_type": content_type - } + args = {"content": content, "content_type": content_type} if frappe.form_dict.max_width: args["max_width"] = int(frappe.form_dict.max_width) if frappe.form_dict.max_height: @@ -194,30 +209,33 @@ def upload_file(): is_whitelisted(method) return method() else: - ret = frappe.get_doc({ - "doctype": "File", - "attached_to_doctype": doctype, - "attached_to_name": docname, - "attached_to_field": fieldname, - "folder": folder, - "file_name": filename, - "file_url": file_url, - "is_private": cint(is_private), - "content": content - }) + ret = frappe.get_doc( + { + "doctype": "File", + "attached_to_doctype": doctype, + "attached_to_name": docname, + "attached_to_field": fieldname, + "folder": folder, + "file_name": filename, + "file_url": file_url, + "is_private": cint(is_private), + "content": content, + } + ) ret.save(ignore_permissions=ignore_permissions) return ret def get_attr(cmd): """get method object from cmd""" - if '.' in cmd: + if "." in cmd: method = frappe.get_attr(cmd) else: method = globals()[cmd] frappe.log("method:" + cmd) return method + @frappe.whitelist(allow_guest=True) def ping(): return "pong" @@ -230,9 +248,9 @@ def run_doc_method(method, docs=None, dt=None, dn=None, arg=None, args=None): if not args and arg: args = arg - if dt: # not called from a doctype (from a page) + if dt: # not called from a doctype (from a page) if not dn: - dn = dt # single + dn = dt # single doc = frappe.get_doc(dt, dn) else: @@ -250,13 +268,13 @@ def run_doc_method(method, docs=None, dt=None, dn=None, arg=None, args=None): pass method_obj = getattr(doc, method) - fn = getattr(method_obj, '__func__', method_obj) + fn = getattr(method_obj, "__func__", method_obj) is_whitelisted(fn) is_valid_http_method(fn) fnargs = getfullargspec(method_obj).args - if not fnargs or (len(fnargs)==1 and fnargs[0]=="self"): + if not fnargs or (len(fnargs) == 1 and fnargs[0] == "self"): response = doc.run_method(method) elif "args" in fnargs or not isinstance(args, dict): @@ -270,11 +288,12 @@ def run_doc_method(method, docs=None, dt=None, dn=None, arg=None, args=None): return # build output as csv - if cint(frappe.form_dict.get('as_csv')): - build_csv_response(response, _(doc.doctype).replace(' ', '')) + if cint(frappe.form_dict.get("as_csv")): + build_csv_response(response, _(doc.doctype).replace(" ", "")) return - frappe.response['message'] = response + frappe.response["message"] = response + # for backwards compatibility runserverobj = run_doc_method diff --git a/frappe/hooks.py b/frappe/hooks.py index b545c6a719..d3de3877ba 100644 --- a/frappe/hooks.py +++ b/frappe/hooks.py @@ -1,7 +1,5 @@ - from . import __version__ as app_version - app_name = "frappe" app_title = "Frappe Framework" app_publisher = "Frappe Technologies" @@ -10,9 +8,9 @@ app_icon = "octicon octicon-circuit-board" app_color = "orange" source_link = "https://github.com/frappe/frappe" app_license = "MIT" -app_logo_url = '/assets/frappe/images/frappe-framework-logo.svg' +app_logo_url = "/assets/frappe/images/frappe-framework-logo.svg" -develop_version = '14.x.x-develop' +develop_version = "14.x.x-develop" app_email = "developers@frappe.io" @@ -23,9 +21,7 @@ translator_url = "https://translate.erpnext.com" before_install = "frappe.utils.install.before_install" after_install = "frappe.utils.install.after_install" -page_js = { - "setup-wizard": "public/js/frappe/setup_wizard.js" -} +page_js = {"setup-wizard": "public/js/frappe/setup_wizard.js"} # website app_include_js = [ @@ -43,16 +39,14 @@ app_include_css = [ doctype_js = { "Web Page": "public/js/frappe/utils/web_template.js", - "Website Settings": "public/js/frappe/utils/web_template.js" + "Website Settings": "public/js/frappe/utils/web_template.js", } -web_include_js = [ - "website_script.js" -] +web_include_js = ["website_script.js"] web_include_css = [] -email_css = ['email.bundle.css'] +email_css = ["email.bundle.css"] website_route_rules = [ {"from_route": "/blog/' + _('Please close this window') + '
' + close = '' + _("Please close this window") + "
" dropbox_oauth_flow = dropbox.DropboxOAuth2Flow( consumer_key=app_details["app_key"], redirect_uri=app_details["redirect_uri"], - session={ - 'dropbox-auth-csrf-token': callback.state - }, + session={"dropbox-auth-csrf-token": callback.state}, csrf_token_session_key="dropbox-auth-csrf-token", - consumer_secret=app_details["app_secret"] + consumer_secret=app_details["app_secret"], ) if callback.state or callback.code: - token = dropbox_oauth_flow.finish({'state': callback.state, 'code': callback.code}) + token = dropbox_oauth_flow.finish({"state": callback.state, "code": callback.code}) if return_access_token and token.access_token: return token.access_token, callback.state set_dropbox_access_token(token.access_token) else: - frappe.respond_as_web_page(_("Dropbox Setup"), + frappe.respond_as_web_page( + _("Dropbox Setup"), _("Illegal Access Token. Please try again") + close, - indicator_color='red', - http_status_code=frappe.AuthenticationError.http_status_code) + indicator_color="red", + http_status_code=frappe.AuthenticationError.http_status_code, + ) + + frappe.respond_as_web_page( + _("Dropbox Setup"), _("Dropbox access is approved!") + close, indicator_color="green" + ) - frappe.respond_as_web_page(_("Dropbox Setup"), - _("Dropbox access is approved!") + close, - indicator_color='green') def set_dropbox_access_token(access_token): - frappe.db.set_value("Dropbox Settings", None, 'dropbox_access_token', access_token) + frappe.db.set_value("Dropbox Settings", None, "dropbox_access_token", access_token) frappe.db.commit() + def generate_oauth2_access_token_from_oauth1_token(dropbox_settings=None): if not dropbox_settings.get("access_key") or not dropbox_settings.get("access_secret"): return {} @@ -349,7 +407,7 @@ def generate_oauth2_access_token_from_oauth1_token(dropbox_settings=None): auth = (dropbox_settings["app_key"], dropbox_settings["app_secret"]) data = { "oauth1_token": dropbox_settings["access_key"], - "oauth1_token_secret": dropbox_settings["access_secret"] + "oauth1_token_secret": dropbox_settings["access_secret"], } return make_post_request(url, auth=auth, headers=headers, data=json.dumps(data)) diff --git a/frappe/integrations/doctype/dropbox_settings/test_dropbox_settings.py b/frappe/integrations/doctype/dropbox_settings/test_dropbox_settings.py index 458f876444..e73cf03268 100644 --- a/frappe/integrations/doctype/dropbox_settings/test_dropbox_settings.py +++ b/frappe/integrations/doctype/dropbox_settings/test_dropbox_settings.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestDropboxSettings(unittest.TestCase): pass diff --git a/frappe/integrations/doctype/google_calendar/google_calendar.py b/frappe/integrations/doctype/google_calendar/google_calendar.py index 0d4c5bbe5c..71f0e83f80 100644 --- a/frappe/integrations/doctype/google_calendar/google_calendar.py +++ b/frappe/integrations/doctype/google_calendar/google_calendar.py @@ -16,8 +16,15 @@ import frappe from frappe import _ from frappe.integrations.doctype.google_settings.google_settings import get_auth_url from frappe.model.document import Document -from frappe.utils import (add_days, add_to_date, get_datetime, - get_request_site_address, get_time_zone, get_weekdays, now_datetime) +from frappe.utils import ( + add_days, + add_to_date, + get_datetime, + get_request_site_address, + get_time_zone, + get_weekdays, + now_datetime, +) from frappe.utils.password import set_encrypted_password SCOPES = "https://www.googleapis.com/auth/calendar" @@ -26,7 +33,7 @@ google_calendar_frequencies = { "RRULE:FREQ=DAILY": "Daily", "RRULE:FREQ=WEEKLY": "Weekly", "RRULE:FREQ=MONTHLY": "Monthly", - "RRULE:FREQ=YEARLY": "Yearly" + "RRULE:FREQ=YEARLY": "Yearly", } google_calendar_days = { @@ -36,14 +43,14 @@ google_calendar_days = { "TH": "thursday", "FR": "friday", "SA": "saturday", - "SU": "sunday" + "SU": "sunday", } framework_frequencies = { "Daily": "RRULE:FREQ=DAILY;", "Weekly": "RRULE:FREQ=WEEKLY;", "Monthly": "RRULE:FREQ=MONTHLY;", - "Yearly": "RRULE:FREQ=YEARLY;" + "Yearly": "RRULE:FREQ=YEARLY;", } framework_days = { @@ -53,11 +60,11 @@ framework_days = { "thursday": "TH", "friday": "FR", "saturday": "SA", - "sunday": "SU" + "sunday": "SU", } -class GoogleCalendar(Document): +class GoogleCalendar(Document): def validate(self): google_settings = frappe.get_single("Google Settings") if not google_settings.enable: @@ -80,27 +87,35 @@ class GoogleCalendar(Document): "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), "refresh_token": self.get_password(fieldname="refresh_token", raise_exception=False), "grant_type": "refresh_token", - "scope": SCOPES + "scope": SCOPES, } try: r = requests.post(get_auth_url(), data=data).json() except requests.exceptions.HTTPError: button_label = frappe.bold(_("Allow Google Calendar Access")) - frappe.throw(_("Something went wrong during the token generation. Click on {0} to generate a new one.").format(button_label)) + frappe.throw( + _( + "Something went wrong during the token generation. Click on {0} to generate a new one." + ).format(button_label) + ) return r.get("access_token") + @frappe.whitelist() def authorize_access(g_calendar, reauthorize=None): """ - If no Authorization code get it from Google and then request for Refresh Token. - Google Calendar Name is set to flags to set_value after Authorization Code is obtained. + If no Authorization code get it from Google and then request for Refresh Token. + Google Calendar Name is set to flags to set_value after Authorization Code is obtained. """ google_settings = frappe.get_doc("Google Settings") google_calendar = frappe.get_doc("Google Calendar", g_calendar) - redirect_uri = get_request_site_address(True) + "?cmd=frappe.integrations.doctype.google_calendar.google_calendar.google_callback" + redirect_uri = ( + get_request_site_address(True) + + "?cmd=frappe.integrations.doctype.google_calendar.google_calendar.google_callback" + ) if not google_calendar.authorization_code or reauthorize: frappe.cache().hset("google_calendar", "google_calendar", google_calendar.name) @@ -110,32 +125,42 @@ def authorize_access(g_calendar, reauthorize=None): data = { "code": google_calendar.get_password(fieldname="authorization_code", raise_exception=False), "client_id": google_settings.client_id, - "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), + "client_secret": google_settings.get_password( + fieldname="client_secret", raise_exception=False + ), "redirect_uri": redirect_uri, - "grant_type": "authorization_code" + "grant_type": "authorization_code", } r = requests.post(get_auth_url(), data=data).json() if "refresh_token" in r: - frappe.db.set_value("Google Calendar", google_calendar.name, "refresh_token", r.get("refresh_token")) + frappe.db.set_value( + "Google Calendar", google_calendar.name, "refresh_token", r.get("refresh_token") + ) frappe.db.commit() frappe.local.response["type"] = "redirect" - frappe.local.response["location"] = "/app/Form/{0}/{1}".format(quote("Google Calendar"), quote(google_calendar.name)) + frappe.local.response["location"] = "/app/Form/{0}/{1}".format( + quote("Google Calendar"), quote(google_calendar.name) + ) frappe.msgprint(_("Google Calendar has been configured.")) except Exception as e: frappe.throw(e) + def get_authentication_url(client_id=None, redirect_uri=None): return { - "url": "https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&response_type=code&prompt=consent&client_id={}&include_granted_scopes=true&scope={}&redirect_uri={}".format(client_id, SCOPES, redirect_uri) + "url": "https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&response_type=code&prompt=consent&client_id={}&include_granted_scopes=true&scope={}&redirect_uri={}".format( + client_id, SCOPES, redirect_uri + ) } + @frappe.whitelist() def google_callback(code=None): """ - Authorization code is sent to callback as per the API configuration + Authorization code is sent to callback as per the API configuration """ google_calendar = frappe.cache().hget("google_calendar", "google_calendar") frappe.db.set_value("Google Calendar", google_calendar, "authorization_code", code) @@ -143,6 +168,7 @@ def google_callback(code=None): authorize_access(google_calendar) + @frappe.whitelist() def sync(g_calendar=None): filters = {"enable": 1} @@ -155,9 +181,10 @@ def sync(g_calendar=None): for g in google_calendars: return sync_events_from_google_calendar(g.name) + def get_google_calendar_object(g_calendar): """ - Returns an object of Google Calendar along with Google Calendar doc. + Returns an object of Google Calendar along with Google Calendar doc. """ google_settings = frappe.get_doc("Google Settings") account = frappe.get_doc("Google Calendar", g_calendar) @@ -168,15 +195,12 @@ def get_google_calendar_object(g_calendar): "token_uri": get_auth_url(), "client_id": google_settings.client_id, "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), - "scopes": "https://www.googleapis.com/auth/calendar/v3" + "scopes": "https://www.googleapis.com/auth/calendar/v3", } credentials = google.oauth2.credentials.Credentials(**credentials_dict) google_calendar = build( - serviceName="calendar", - version="v3", - credentials=credentials, - static_discovery=False + serviceName="calendar", version="v3", credentials=credentials, static_discovery=False ) check_google_calendar(account, google_calendar) @@ -184,10 +208,11 @@ def get_google_calendar_object(g_calendar): account.load_from_db() return google_calendar, account + def check_google_calendar(account, google_calendar): """ - Checks if Google Calendar is present with the specified name. - If not, creates one. + Checks if Google Calendar is present with the specified name. + If not, creates one. """ account.load_from_db() try: @@ -197,20 +222,27 @@ def check_google_calendar(account, google_calendar): # If no Calendar ID create a new Calendar calendar = { "summary": account.calendar_name, - "timeZone": frappe.db.get_single_value("System Settings", "time_zone") + "timeZone": frappe.db.get_single_value("System Settings", "time_zone"), } created_calendar = google_calendar.calendars().insert(body=calendar).execute() - frappe.db.set_value("Google Calendar", account.name, "google_calendar_id", created_calendar.get("id")) + frappe.db.set_value( + "Google Calendar", account.name, "google_calendar_id", created_calendar.get("id") + ) frappe.db.commit() except HttpError as err: - frappe.throw(_("Google Calendar - Could not create Calendar for {0}, error code {1}.").format(account.name, err.resp.status)) + frappe.throw( + _("Google Calendar - Could not create Calendar for {0}, error code {1}.").format( + account.name, err.resp.status + ) + ) + def sync_events_from_google_calendar(g_calendar, method=None): """ - Syncs Events from Google Calendar in Framework Calendar. - Google Calendar returns nextSyncToken when all the events in Google Calendar are fetched. - nextSyncToken is returned at the very last page - https://developers.google.com/calendar/v3/sync + Syncs Events from Google Calendar in Framework Calendar. + Google Calendar returns nextSyncToken when all the events in Google Calendar are fetched. + nextSyncToken is returned at the very last page + https://developers.google.com/calendar/v3/sync """ google_calendar, account = get_google_calendar_object(g_calendar) @@ -223,16 +255,28 @@ def sync_events_from_google_calendar(g_calendar, method=None): while True: try: # API Response listed at EOF - events = google_calendar.events().list(calendarId=account.google_calendar_id, maxResults=2000, - pageToken=events.get("nextPageToken"), singleEvents=False, showDeleted=True, syncToken=sync_token).execute() + events = ( + google_calendar.events() + .list( + calendarId=account.google_calendar_id, + maxResults=2000, + pageToken=events.get("nextPageToken"), + singleEvents=False, + showDeleted=True, + syncToken=sync_token, + ) + .execute() + ) except HttpError as err: - msg = _("Google Calendar - Could not fetch event from Google Calendar, error code {0}.").format(err.resp.status) + msg = _("Google Calendar - Could not fetch event from Google Calendar, error code {0}.").format( + err.resp.status + ) if err.resp.status == 410: set_encrypted_password("Google Calendar", account.name, "", "next_sync_token") frappe.db.commit() - msg += ' ' + _('Sync token was invalid and has been resetted, Retry syncing.') - frappe.msgprint(msg, title='Invalid Sync Token', indicator='blue') + msg += " " + _("Sync token was invalid and has been resetted, Retry syncing.") + frappe.msgprint(msg, title="Invalid Sync Token", indicator="blue") else: frappe.throw(msg) @@ -246,7 +290,9 @@ def sync_events_from_google_calendar(g_calendar, method=None): break for idx, event in enumerate(results): - frappe.publish_realtime("import_google_calendar", dict(progress=idx+1, total=len(results)), user=frappe.session.user) + frappe.publish_realtime( + "import_google_calendar", dict(progress=idx + 1, total=len(results)), user=frappe.session.user + ) # If Google Calendar Event if confirmed, then create an Event if event.get("status") == "confirmed": @@ -263,14 +309,31 @@ def sync_events_from_google_calendar(g_calendar, method=None): update_event_in_calendar(account, event, recurrence) elif event.get("status") == "cancelled": # If any synced Google Calendar Event is cancelled, then close the Event - frappe.db.set_value("Event", {"google_calendar_id": account.google_calendar_id, "google_calendar_event_id": event.get("id")}, "status", "Closed") - frappe.get_doc({ - "doctype": "Comment", - "comment_type": "Info", - "reference_doctype": "Event", - "reference_name": frappe.db.get_value("Event", {"google_calendar_id": account.google_calendar_id, "google_calendar_event_id": event.get("id")}, "name"), - "content": " - Event deleted from Google Calendar.", - }).insert(ignore_permissions=True) + frappe.db.set_value( + "Event", + { + "google_calendar_id": account.google_calendar_id, + "google_calendar_event_id": event.get("id"), + }, + "status", + "Closed", + ) + frappe.get_doc( + { + "doctype": "Comment", + "comment_type": "Info", + "reference_doctype": "Event", + "reference_name": frappe.db.get_value( + "Event", + { + "google_calendar_id": account.google_calendar_id, + "google_calendar_event_id": event.get("id"), + }, + "name", + ), + "content": " - Event deleted from Google Calendar.", + } + ).insert(ignore_permissions=True) else: pass @@ -281,9 +344,10 @@ def sync_events_from_google_calendar(g_calendar, method=None): else: return _("{0} Google Calendar Events synced.").format(len(results)) + def insert_event_to_calendar(account, event, recurrence=None): """ - Inserts event in Frappe Calendar during Sync + Inserts event in Frappe Calendar during Sync """ calendar_event = { "doctype": "Event", @@ -293,27 +357,40 @@ def insert_event_to_calendar(account, event, recurrence=None): "google_calendar": account.name, "google_calendar_id": account.google_calendar_id, "google_calendar_event_id": event.get("id"), - "pulled_from_google_calendar": 1 + "pulled_from_google_calendar": 1, } - calendar_event.update(google_calendar_to_repeat_on(recurrence=recurrence, start=event.get("start"), end=event.get("end"))) + calendar_event.update( + google_calendar_to_repeat_on( + recurrence=recurrence, start=event.get("start"), end=event.get("end") + ) + ) frappe.get_doc(calendar_event).insert(ignore_permissions=True) + def update_event_in_calendar(account, event, recurrence=None): """ - Updates Event in Frappe Calendar if any existing Google Calendar Event is updated + Updates Event in Frappe Calendar if any existing Google Calendar Event is updated """ calendar_event = frappe.get_doc("Event", {"google_calendar_event_id": event.get("id")}) calendar_event.subject = event.get("summary") calendar_event.description = event.get("description") - calendar_event.update(google_calendar_to_repeat_on(recurrence=recurrence, start=event.get("start"), end=event.get("end"))) + calendar_event.update( + google_calendar_to_repeat_on( + recurrence=recurrence, start=event.get("start"), end=event.get("end") + ) + ) calendar_event.save(ignore_permissions=True) + def insert_event_in_google_calendar(doc, method=None): """ - Insert Events in Google Calendar if sync_with_google_calendar is checked. + Insert Events in Google Calendar if sync_with_google_calendar is checked. """ - if not frappe.db.exists("Google Calendar", {"name": doc.google_calendar}) or doc.pulled_from_google_calendar \ - or not doc.sync_with_google_calendar: + if ( + not frappe.db.exists("Google Calendar", {"name": doc.google_calendar}) + or doc.pulled_from_google_calendar + or not doc.sync_with_google_calendar + ): return google_calendar, account = get_google_calendar_object(doc.google_calendar) @@ -321,31 +398,41 @@ def insert_event_in_google_calendar(doc, method=None): if not account.push_to_google_calendar: return - event = { - "summary": doc.subject, - "description": doc.description, - "google_calendar_event": 1 - } - event.update(format_date_according_to_google_calendar(doc.all_day, get_datetime(doc.starts_on), get_datetime(doc.ends_on))) + event = {"summary": doc.subject, "description": doc.description, "google_calendar_event": 1} + event.update( + format_date_according_to_google_calendar( + doc.all_day, get_datetime(doc.starts_on), get_datetime(doc.ends_on) + ) + ) if doc.repeat_on: event.update({"recurrence": repeat_on_to_google_calendar_recurrence_rule(doc)}) try: event = google_calendar.events().insert(calendarId=doc.google_calendar_id, body=event).execute() - frappe.db.set_value("Event", doc.name, "google_calendar_event_id", event.get("id"), update_modified=False) + frappe.db.set_value( + "Event", doc.name, "google_calendar_event_id", event.get("id"), update_modified=False + ) frappe.msgprint(_("Event Synced with Google Calendar.")) except HttpError as err: - frappe.throw(_("Google Calendar - Could not insert event in Google Calendar {0}, error code {1}.").format(account.name, err.resp.status)) + frappe.throw( + _("Google Calendar - Could not insert event in Google Calendar {0}, error code {1}.").format( + account.name, err.resp.status + ) + ) + def update_event_in_google_calendar(doc, method=None): """ - Updates Events in Google Calendar if any existing event is modified in Frappe Calendar + Updates Events in Google Calendar if any existing event is modified in Frappe Calendar """ # Workaround to avoid triggering updation when Event is being inserted since # creation and modified are same when inserting doc - if not frappe.db.exists("Google Calendar", {"name": doc.google_calendar}) or doc.modified == doc.creation \ - or not doc.sync_with_google_calendar: + if ( + not frappe.db.exists("Google Calendar", {"name": doc.google_calendar}) + or doc.modified == doc.creation + or not doc.sync_with_google_calendar + ): return if doc.sync_with_google_calendar and not doc.google_calendar_event_id: @@ -359,21 +446,38 @@ def update_event_in_google_calendar(doc, method=None): return try: - event = google_calendar.events().get(calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id).execute() + event = ( + google_calendar.events() + .get(calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id) + .execute() + ) event["summary"] = doc.subject event["description"] = doc.description event["recurrence"] = repeat_on_to_google_calendar_recurrence_rule(doc) - event["status"] = "cancelled" if doc.event_type == "Cancelled" or doc.status == "Closed" else event.get("status") - event.update(format_date_according_to_google_calendar(doc.all_day, get_datetime(doc.starts_on), get_datetime(doc.ends_on))) - - google_calendar.events().update(calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id, body=event).execute() + event["status"] = ( + "cancelled" if doc.event_type == "Cancelled" or doc.status == "Closed" else event.get("status") + ) + event.update( + format_date_according_to_google_calendar( + doc.all_day, get_datetime(doc.starts_on), get_datetime(doc.ends_on) + ) + ) + + google_calendar.events().update( + calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id, body=event + ).execute() frappe.msgprint(_("Event Synced with Google Calendar.")) except HttpError as err: - frappe.throw(_("Google Calendar - Could not update Event {0} in Google Calendar, error code {1}.").format(doc.name, err.resp.status)) + frappe.throw( + _("Google Calendar - Could not update Event {0} in Google Calendar, error code {1}.").format( + doc.name, err.resp.status + ) + ) + def delete_event_from_google_calendar(doc, method=None): """ - Delete Events from Google Calendar if Frappe Event is deleted. + Delete Events from Google Calendar if Frappe Event is deleted. """ if not frappe.db.exists("Google Calendar", {"name": doc.google_calendar}): @@ -385,24 +489,39 @@ def delete_event_from_google_calendar(doc, method=None): return try: - event = google_calendar.events().get(calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id).execute() + event = ( + google_calendar.events() + .get(calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id) + .execute() + ) event["recurrence"] = None event["status"] = "cancelled" - google_calendar.events().update(calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id, body=event).execute() + google_calendar.events().update( + calendarId=doc.google_calendar_id, eventId=doc.google_calendar_event_id, body=event + ).execute() except HttpError as err: - frappe.msgprint(_("Google Calendar - Could not delete Event {0} from Google Calendar, error code {1}.").format(doc.name, err.resp.status)) + frappe.msgprint( + _("Google Calendar - Could not delete Event {0} from Google Calendar, error code {1}.").format( + doc.name, err.resp.status + ) + ) + def google_calendar_to_repeat_on(start, end, recurrence=None): """ - recurrence is in the form ['RRULE:FREQ=WEEKLY;BYDAY=MO,TU,TH'] - has the frequency and then the days on which the event recurs + recurrence is in the form ['RRULE:FREQ=WEEKLY;BYDAY=MO,TU,TH'] + has the frequency and then the days on which the event recurs - Both have been mapped in a dict for easier mapping. + Both have been mapped in a dict for easier mapping. """ repeat_on = { - "starts_on": get_datetime(start.get("date")) if start.get("date") else parser.parse(start.get("dateTime")).utcnow(), - "ends_on": get_datetime(end.get("date")) if end.get("date") else parser.parse(end.get("dateTime")).utcnow(), + "starts_on": get_datetime(start.get("date")) + if start.get("date") + else parser.parse(start.get("dateTime")).utcnow(), + "ends_on": get_datetime(end.get("date")) + if end.get("date") + else parser.parse(end.get("dateTime")).utcnow(), "all_day": 1 if start.get("date") else 0, "repeat_this_event": 1 if recurrence else 0, "repeat_on": None, @@ -441,7 +560,7 @@ def google_calendar_to_repeat_on(start, end, recurrence=None): repeat_day_week_number = num break - for day in ["MO","TU","WE","TH","FR","SA","SU"]: + for day in ["MO", "TU", "WE", "TH", "FR", "SA", "SU"]: if day in byday: repeat_day_name = google_calendar_days.get(day) break @@ -458,6 +577,7 @@ def google_calendar_to_repeat_on(start, end, recurrence=None): return repeat_on + def format_date_according_to_google_calendar(all_day, starts_on, ends_on=None): if not ends_on: ends_on = starts_on + timedelta(minutes=10) @@ -466,11 +586,11 @@ def format_date_according_to_google_calendar(all_day, starts_on, ends_on=None): "start": { "dateTime": starts_on.isoformat(), "timeZone": get_time_zone(), - }, + }, "end": { "dateTime": ends_on.isoformat(), "timeZone": get_time_zone(), - } + }, } if all_day: @@ -483,9 +603,10 @@ def format_date_according_to_google_calendar(all_day, starts_on, ends_on=None): return date_format + def parse_google_calendar_recurrence_rule(repeat_day_week_number, repeat_day_name): """ - Returns (repeat_on) exact date for combination eg 4TH viz. 4th thursday of a month + Returns (repeat_on) exact date for combination eg 4TH viz. 4th thursday of a month """ if repeat_day_week_number < 0: # Consider a month with 5 weeks and event is to be repeated in last week of every month, google caledar considers @@ -511,9 +632,10 @@ def parse_google_calendar_recurrence_rule(repeat_day_week_number, repeat_day_nam return current_date + def repeat_on_to_google_calendar_recurrence_rule(doc): """ - Returns event (repeat_on) in Google Calendar format ie RRULE:FREQ=WEEKLY;BYDAY=MO,TU,TH + Returns event (repeat_on) in Google Calendar format ie RRULE:FREQ=WEEKLY;BYDAY=MO,TU,TH """ recurrence = framework_frequencies.get(doc.repeat_on) weekdays = get_weekdays() @@ -528,18 +650,21 @@ def repeat_on_to_google_calendar_recurrence_rule(doc): return [recurrence] + def get_week_number(dt): """ - Returns the week number of the month for the specified date. - https://stackoverflow.com/questions/3806473/python-week-number-of-the-month/16804556 + Returns the week number of the month for the specified date. + https://stackoverflow.com/questions/3806473/python-week-number-of-the-month/16804556 """ from math import ceil + first_day = dt.replace(day=1) dom = dt.day adjusted_dom = dom + first_day.weekday() - return int(ceil(adjusted_dom/7.0)) + return int(ceil(adjusted_dom / 7.0)) + def get_recurrence_parameters(recurrence): recurrence = recurrence.split(";") @@ -557,6 +682,7 @@ def get_recurrence_parameters(recurrence): return frequency, until, byday + """API Response { 'kind': 'calendar#events', diff --git a/frappe/integrations/doctype/google_contacts/google_contacts.py b/frappe/integrations/doctype/google_contacts/google_contacts.py index a63b0b6d80..c26366f71a 100644 --- a/frappe/integrations/doctype/google_contacts/google_contacts.py +++ b/frappe/integrations/doctype/google_contacts/google_contacts.py @@ -16,8 +16,8 @@ from frappe.utils import get_request_site_address SCOPES = "https://www.googleapis.com/auth/contacts" -class GoogleContacts(Document): +class GoogleContacts(Document): def validate(self): if not frappe.db.get_single_value("Google Settings", "enable"): frappe.throw(_("Enable Google API in Google Settings.")) @@ -29,7 +29,7 @@ class GoogleContacts(Document): frappe.throw(_("Google Contacts Integration is disabled.")) if not self.refresh_token: - button_label = frappe.bold(_('Allow Google Contacts Access')) + button_label = frappe.bold(_("Allow Google Contacts Access")) raise frappe.ValidationError(_("Click on {0} to generate Refresh Token.").format(button_label)) data = { @@ -37,28 +37,36 @@ class GoogleContacts(Document): "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), "refresh_token": self.get_password(fieldname="refresh_token", raise_exception=False), "grant_type": "refresh_token", - "scope": SCOPES + "scope": SCOPES, } try: r = requests.post(get_auth_url(), data=data).json() except requests.exceptions.HTTPError: - button_label = frappe.bold(_('Allow Google Contacts Access')) - frappe.throw(_("Something went wrong during the token generation. Click on {0} to generate a new one.").format(button_label)) + button_label = frappe.bold(_("Allow Google Contacts Access")) + frappe.throw( + _( + "Something went wrong during the token generation. Click on {0} to generate a new one." + ).format(button_label) + ) return r.get("access_token") + @frappe.whitelist() def authorize_access(g_contact, reauthorize=None): """ - If no Authorization code get it from Google and then request for Refresh Token. - Google Contact Name is set to flags to set_value after Authorization Code is obtained. + If no Authorization code get it from Google and then request for Refresh Token. + Google Contact Name is set to flags to set_value after Authorization Code is obtained. """ google_settings = frappe.get_doc("Google Settings") google_contact = frappe.get_doc("Google Contacts", g_contact) - redirect_uri = get_request_site_address(True) + "?cmd=frappe.integrations.doctype.google_contacts.google_contacts.google_callback" + redirect_uri = ( + get_request_site_address(True) + + "?cmd=frappe.integrations.doctype.google_contacts.google_contacts.google_callback" + ) if not google_contact.authorization_code or reauthorize: frappe.cache().hset("google_contacts", "google_contact", google_contact.name) @@ -68,14 +76,18 @@ def authorize_access(g_contact, reauthorize=None): data = { "code": google_contact.authorization_code, "client_id": google_settings.client_id, - "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), + "client_secret": google_settings.get_password( + fieldname="client_secret", raise_exception=False + ), "redirect_uri": redirect_uri, - "grant_type": "authorization_code" + "grant_type": "authorization_code", } r = requests.post(get_auth_url(), data=data).json() if "refresh_token" in r: - frappe.db.set_value("Google Contacts", google_contact.name, "refresh_token", r.get("refresh_token")) + frappe.db.set_value( + "Google Contacts", google_contact.name, "refresh_token", r.get("refresh_token") + ) frappe.db.commit() frappe.local.response["type"] = "redirect" @@ -85,15 +97,19 @@ def authorize_access(g_contact, reauthorize=None): except Exception as e: frappe.throw(e) + def get_authentication_url(client_id=None, redirect_uri=None): return { - "url": "https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&response_type=code&prompt=consent&client_id={}&include_granted_scopes=true&scope={}&redirect_uri={}".format(client_id, SCOPES, redirect_uri) + "url": "https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&response_type=code&prompt=consent&client_id={}&include_granted_scopes=true&scope={}&redirect_uri={}".format( + client_id, SCOPES, redirect_uri + ) } + @frappe.whitelist() def google_callback(code=None): """ - Authorization code is sent to callback as per the API configuration + Authorization code is sent to callback as per the API configuration """ google_contact = frappe.cache().hget("google_contacts", "google_contact") frappe.db.set_value("Google Contacts", google_contact, "authorization_code", code) @@ -101,9 +117,10 @@ def google_callback(code=None): authorize_access(google_contact) + def get_google_contacts_object(g_contact): """ - Returns an object of Google Calendar along with Google Calendar doc. + Returns an object of Google Calendar along with Google Calendar doc. """ google_settings = frappe.get_doc("Google Settings") account = frappe.get_doc("Google Contacts", g_contact) @@ -114,19 +131,17 @@ def get_google_contacts_object(g_contact): "token_uri": get_auth_url(), "client_id": google_settings.client_id, "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), - "scopes": "https://www.googleapis.com/auth/contacts" + "scopes": "https://www.googleapis.com/auth/contacts", } credentials = google.oauth2.credentials.Credentials(**credentials_dict) google_contacts = build( - serviceName="people", - version="v1", - credentials=credentials, - static_discovery=False + serviceName="people", version="v1", credentials=credentials, static_discovery=False ) return google_contacts, account + @frappe.whitelist() def sync(g_contact=None): filters = {"enable": 1} @@ -139,10 +154,11 @@ def sync(g_contact=None): for g in google_contacts: return sync_contacts_from_google_contacts(g.name) + def sync_contacts_from_google_contacts(g_contact): """ - Syncs Contacts from Google Contacts. - https://developers.google.com/people/api/rest/v1/people.connections/list + Syncs Contacts from Google Contacts. + https://developers.google.com/people/api/rest/v1/people.connections/list """ google_contacts, account = get_google_contacts_object(g_contact) @@ -157,58 +173,90 @@ def sync_contacts_from_google_contacts(g_contact): while True: try: - contacts = google_contacts.people().connections().list(resourceName='people/me', pageToken=contacts.get("nextPageToken"), - syncToken=sync_token, pageSize=2000, requestSyncToken=True, personFields="names,emailAddresses,organizations,phoneNumbers").execute() + contacts = ( + google_contacts.people() + .connections() + .list( + resourceName="people/me", + pageToken=contacts.get("nextPageToken"), + syncToken=sync_token, + pageSize=2000, + requestSyncToken=True, + personFields="names,emailAddresses,organizations,phoneNumbers", + ) + .execute() + ) except HttpError as err: - frappe.throw(_("Google Contacts - Could not sync contacts from Google Contacts {0}, error code {1}.").format(account.name, err.resp.status)) + frappe.throw( + _( + "Google Contacts - Could not sync contacts from Google Contacts {0}, error code {1}." + ).format(account.name, err.resp.status) + ) for contact in contacts.get("connections", []): results.append(contact) if not contacts.get("nextPageToken"): if contacts.get("nextSyncToken"): - frappe.db.set_value("Google Contacts", account.name, "next_sync_token", contacts.get("nextSyncToken")) + frappe.db.set_value( + "Google Contacts", account.name, "next_sync_token", contacts.get("nextSyncToken") + ) frappe.db.commit() break frappe.db.set_value("Google Contacts", account.name, "last_sync_on", frappe.utils.now_datetime()) for idx, connection in enumerate(results): - frappe.publish_realtime('import_google_contacts', dict(progress=idx+1, total=len(results)), user=frappe.session.user) + frappe.publish_realtime( + "import_google_contacts", dict(progress=idx + 1, total=len(results)), user=frappe.session.user + ) for name in connection.get("names"): if name.get("metadata").get("primary"): contacts_updated += 1 - contact = frappe.get_doc({ - "doctype": "Contact", - "first_name": name.get("givenName") or "", - "middle_name": name.get("middleName") or "", - "last_name": name.get("familyName") or "", - "designation": get_indexed_value(connection.get("organizations"), 0, "title"), - "pulled_from_google_contacts": 1, - "google_contacts": account.name, - "company_name": get_indexed_value(connection.get("organizations"), 0, "name") - }) + contact = frappe.get_doc( + { + "doctype": "Contact", + "first_name": name.get("givenName") or "", + "middle_name": name.get("middleName") or "", + "last_name": name.get("familyName") or "", + "designation": get_indexed_value(connection.get("organizations"), 0, "title"), + "pulled_from_google_contacts": 1, + "google_contacts": account.name, + "company_name": get_indexed_value(connection.get("organizations"), 0, "name"), + } + ) for email in connection.get("emailAddresses", []): - contact.add_email(email_id=email.get("value"), is_primary=1 if email.get("metadata").get("primary") else 0) + contact.add_email( + email_id=email.get("value"), is_primary=1 if email.get("metadata").get("primary") else 0 + ) for phone in connection.get("phoneNumbers", []): - contact.add_phone(phone=phone.get("value"), is_primary_phone=1 if phone.get("metadata").get("primary") else 0) + contact.add_phone( + phone=phone.get("value"), is_primary_phone=1 if phone.get("metadata").get("primary") else 0 + ) contact.insert(ignore_permissions=True) - return _("{0} Google Contacts synced.").format(contacts_updated) if contacts_updated > 0 \ + return ( + _("{0} Google Contacts synced.").format(contacts_updated) + if contacts_updated > 0 else _("No new Google Contacts synced.") + ) + def insert_contacts_to_google_contacts(doc, method=None): """ - Syncs Contacts from Google Contacts. - https://developers.google.com/people/api/rest/v1/people/createContact + Syncs Contacts from Google Contacts. + https://developers.google.com/people/api/rest/v1/people/createContact """ - if not frappe.db.exists("Google Contacts", {"name": doc.google_contacts}) or doc.pulled_from_google_contacts \ - or not doc.sync_with_google_contacts: + if ( + not frappe.db.exists("Google Contacts", {"name": doc.google_contacts}) + or doc.pulled_from_google_contacts + or not doc.sync_with_google_contacts + ): return google_contacts, account = get_google_contacts_object(doc.google_contacts) @@ -216,31 +264,40 @@ def insert_contacts_to_google_contacts(doc, method=None): if not account.push_to_google_contacts: return - names = { - "givenName": doc.first_name, - "middleName": doc.middle_name, - "familyName": doc.last_name - } + names = {"givenName": doc.first_name, "middleName": doc.middle_name, "familyName": doc.last_name} phoneNumbers = [{"value": phone_no.phone} for phone_no in doc.phone_nos] emailAddresses = [{"value": email_id.email_id} for email_id in doc.email_ids] try: - contact = google_contacts.people().createContact(body={"names": [names],"phoneNumbers": phoneNumbers, - "emailAddresses": emailAddresses}).execute() + contact = ( + google_contacts.people() + .createContact( + body={"names": [names], "phoneNumbers": phoneNumbers, "emailAddresses": emailAddresses} + ) + .execute() + ) frappe.db.set_value("Contact", doc.name, "google_contacts_id", contact.get("resourceName")) except HttpError as err: - frappe.msgprint(_("Google Calendar - Could not insert contact in Google Contacts {0}, error code {1}.").format(account.name, err.resp.status)) + frappe.msgprint( + _("Google Calendar - Could not insert contact in Google Contacts {0}, error code {1}.").format( + account.name, err.resp.status + ) + ) + def update_contacts_to_google_contacts(doc, method=None): """ - Syncs Contacts from Google Contacts. - https://developers.google.com/people/api/rest/v1/people/updateContact + Syncs Contacts from Google Contacts. + https://developers.google.com/people/api/rest/v1/people/updateContact """ # Workaround to avoid triggering updation when Event is being inserted since # creation and modified are same when inserting doc - if not frappe.db.exists("Google Contacts", {"name": doc.google_contacts}) or doc.modified == doc.creation \ - or not doc.sync_with_google_contacts: + if ( + not frappe.db.exists("Google Contacts", {"name": doc.google_contacts}) + or doc.modified == doc.creation + or not doc.sync_with_google_contacts + ): return if doc.sync_with_google_contacts and not doc.google_contacts_id: @@ -253,29 +310,43 @@ def update_contacts_to_google_contacts(doc, method=None): if not account.push_to_google_contacts: return - names = { - "givenName": doc.first_name, - "middleName": doc.middle_name, - "familyName": doc.last_name - } + names = {"givenName": doc.first_name, "middleName": doc.middle_name, "familyName": doc.last_name} phoneNumbers = [{"value": phone_no.phone} for phone_no in doc.phone_nos] emailAddresses = [{"value": email_id.email_id} for email_id in doc.email_ids] try: - contact = google_contacts.people().get(resourceName=doc.google_contacts_id, \ - personFields="names,emailAddresses,organizations,phoneNumbers").execute() + contact = ( + google_contacts.people() + .get( + resourceName=doc.google_contacts_id, + personFields="names,emailAddresses,organizations,phoneNumbers", + ) + .execute() + ) contact["names"] = [names] contact["phoneNumbers"] = phoneNumbers contact["emailAddresses"] = emailAddresses - google_contacts.people().updateContact(resourceName=doc.google_contacts_id,body={"names":[names], - "phoneNumbers":phoneNumbers,"emailAddresses":emailAddresses,"etag":contact.get("etag")}, - updatePersonFields="names,emailAddresses,organizations,phoneNumbers").execute() + google_contacts.people().updateContact( + resourceName=doc.google_contacts_id, + body={ + "names": [names], + "phoneNumbers": phoneNumbers, + "emailAddresses": emailAddresses, + "etag": contact.get("etag"), + }, + updatePersonFields="names,emailAddresses,organizations,phoneNumbers", + ).execute() frappe.msgprint(_("Contact Synced with Google Contacts.")) except HttpError as err: - frappe.msgprint(_("Google Contacts - Could not update contact in Google Contacts {0}, error code {1}.").format(account.name, err.resp.status)) + frappe.msgprint( + _("Google Contacts - Could not update contact in Google Contacts {0}, error code {1}.").format( + account.name, err.resp.status + ) + ) + def get_indexed_value(d, index, key): if not d: diff --git a/frappe/integrations/doctype/google_drive/google_drive.py b/frappe/integrations/doctype/google_drive/google_drive.py index beac7898a9..bbb1e8485e 100644 --- a/frappe/integrations/doctype/google_drive/google_drive.py +++ b/frappe/integrations/doctype/google_drive/google_drive.py @@ -14,11 +14,13 @@ from googleapiclient.errors import HttpError import frappe from frappe import _ from frappe.integrations.doctype.google_settings.google_settings import get_auth_url -from frappe.integrations.offsite_backup_utils import (get_latest_backup_file, - send_email, validate_file_size) +from frappe.integrations.offsite_backup_utils import ( + get_latest_backup_file, + send_email, + validate_file_size, +) from frappe.model.document import Document -from frappe.utils import (get_backups_path, get_bench_path, - get_request_site_address) +from frappe.utils import get_backups_path, get_bench_path, get_request_site_address from frappe.utils.background_jobs import enqueue from frappe.utils.backups import new_backup @@ -26,11 +28,10 @@ SCOPES = "https://www.googleapis.com/auth/drive" class GoogleDrive(Document): - def validate(self): doc_before_save = self.get_doc_before_save() if doc_before_save and doc_before_save.backup_folder_name != self.backup_folder_name: - self.backup_folder_id = '' + self.backup_folder_id = "" def get_access_token(self): google_settings = frappe.get_doc("Google Settings") @@ -47,28 +48,36 @@ class GoogleDrive(Document): "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), "refresh_token": self.get_password(fieldname="refresh_token", raise_exception=False), "grant_type": "refresh_token", - "scope": SCOPES + "scope": SCOPES, } try: r = requests.post(get_auth_url(), data=data).json() except requests.exceptions.HTTPError: button_label = frappe.bold(_("Allow Google Drive Access")) - frappe.throw(_("Something went wrong during the token generation. Click on {0} to generate a new one.").format(button_label)) + frappe.throw( + _( + "Something went wrong during the token generation. Click on {0} to generate a new one." + ).format(button_label) + ) return r.get("access_token") + @frappe.whitelist() def authorize_access(reauthorize=None): """ - If no Authorization code get it from Google and then request for Refresh Token. - Google Contact Name is set to flags to set_value after Authorization Code is obtained. + If no Authorization code get it from Google and then request for Refresh Token. + Google Contact Name is set to flags to set_value after Authorization Code is obtained. """ google_settings = frappe.get_doc("Google Settings") google_drive = frappe.get_doc("Google Drive") - redirect_uri = get_request_site_address(True) + "?cmd=frappe.integrations.doctype.google_drive.google_drive.google_callback" + redirect_uri = ( + get_request_site_address(True) + + "?cmd=frappe.integrations.doctype.google_drive.google_drive.google_callback" + ) if not google_drive.authorization_code or reauthorize: if reauthorize: @@ -79,9 +88,11 @@ def authorize_access(reauthorize=None): data = { "code": google_drive.authorization_code, "client_id": google_settings.client_id, - "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), + "client_secret": google_settings.get_password( + fieldname="client_secret", raise_exception=False + ), "redirect_uri": redirect_uri, - "grant_type": "authorization_code" + "grant_type": "authorization_code", } r = requests.post(get_auth_url(), data=data).json() @@ -96,24 +107,29 @@ def authorize_access(reauthorize=None): except Exception as e: frappe.throw(e) + def get_authentication_url(client_id, redirect_uri): return { - "url": "https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&response_type=code&prompt=consent&client_id={}&include_granted_scopes=true&scope={}&redirect_uri={}".format(client_id, SCOPES, redirect_uri) + "url": "https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&response_type=code&prompt=consent&client_id={}&include_granted_scopes=true&scope={}&redirect_uri={}".format( + client_id, SCOPES, redirect_uri + ) } + @frappe.whitelist() def google_callback(code=None): """ - Authorization code is sent to callback as per the API configuration + Authorization code is sent to callback as per the API configuration """ frappe.db.set_value("Google Drive", None, "authorization_code", code) frappe.db.commit() authorize_access() + def get_google_drive_object(): """ - Returns an object of Google Drive. + Returns an object of Google Drive. """ google_settings = frappe.get_doc("Google Settings") account = frappe.get_doc("Google Drive") @@ -124,25 +140,24 @@ def get_google_drive_object(): "token_uri": get_auth_url(), "client_id": google_settings.client_id, "client_secret": google_settings.get_password(fieldname="client_secret", raise_exception=False), - "scopes": "https://www.googleapis.com/auth/drive/v3" + "scopes": "https://www.googleapis.com/auth/drive/v3", } credentials = google.oauth2.credentials.Credentials(**credentials_dict) google_drive = build( - serviceName="drive", - version="v3", - credentials=credentials, - static_discovery=False + serviceName="drive", version="v3", credentials=credentials, static_discovery=False ) return google_drive, account + def check_for_folder_in_google_drive(): """Checks if folder exists in Google Drive else create it.""" + def _create_folder_in_google_drive(google_drive, account): file_metadata = { "name": account.backup_folder_name, - "mimeType": "application/vnd.google-apps.folder" + "mimeType": "application/vnd.google-apps.folder", } try: @@ -150,7 +165,9 @@ def check_for_folder_in_google_drive(): frappe.db.set_value("Google Drive", None, "backup_folder_id", folder.get("id")) frappe.db.commit() except HttpError as e: - frappe.throw(_("Google Drive - Could not create folder in Google Drive - Error Code {0}").format(e)) + frappe.throw( + _("Google Drive - Could not create folder in Google Drive - Error Code {0}").format(e) + ) google_drive, account = get_google_drive_object() @@ -160,9 +177,13 @@ def check_for_folder_in_google_drive(): backup_folder_exists = False try: - google_drive_folders = google_drive.files().list(q="mimeType='application/vnd.google-apps.folder'").execute() + google_drive_folders = ( + google_drive.files().list(q="mimeType='application/vnd.google-apps.folder'").execute() + ) except HttpError as e: - frappe.throw(_("Google Drive - Could not find folder in Google Drive - Error Code {0}").format(e)) + frappe.throw( + _("Google Drive - Could not find folder in Google Drive - Error Code {0}").format(e) + ) for f in google_drive_folders.get("files"): if f.get("name") == account.backup_folder_name: @@ -174,15 +195,21 @@ def check_for_folder_in_google_drive(): if not backup_folder_exists: _create_folder_in_google_drive(google_drive, account) + @frappe.whitelist() def take_backup(): """Enqueue longjob for taking backup to Google Drive""" - enqueue("frappe.integrations.doctype.google_drive.google_drive.upload_system_backup_to_google_drive", queue='long', timeout=1500) + enqueue( + "frappe.integrations.doctype.google_drive.google_drive.upload_system_backup_to_google_drive", + queue="long", + timeout=1500, + ) frappe.msgprint(_("Queued for backup. It may take a few minutes to an hour.")) + def upload_system_backup_to_google_drive(): """ - Upload system backup to Google Drive + Upload system backup to Google Drive """ # Get Google Drive Object google_drive, account = get_google_drive_object() @@ -210,13 +237,12 @@ def upload_system_backup_to_google_drive(): if not fileurl: continue - file_metadata = { - "name": fileurl, - "parents": [account.backup_folder_id] - } + file_metadata = {"name": fileurl, "parents": [account.backup_folder_id]} try: - media = MediaFileUpload(get_absolute_path(filename=fileurl), mimetype="application/gzip", resumable=True) + media = MediaFileUpload( + get_absolute_path(filename=fileurl), mimetype="application/gzip", resumable=True + ) except IOError as e: frappe.throw(_("Google Drive - Could not locate - {0}").format(e)) @@ -231,19 +257,27 @@ def upload_system_backup_to_google_drive(): send_email(True, "Google Drive", "Google Drive", "email") return _("Google Drive Backup Successful.") + def daily_backup(): - drive_settings = frappe.db.get_singles_dict('Google Drive') + drive_settings = frappe.db.get_singles_dict("Google Drive") if drive_settings.enable and drive_settings.frequency == "Daily": upload_system_backup_to_google_drive() + def weekly_backup(): - drive_settings = frappe.db.get_singles_dict('Google Drive') + drive_settings = frappe.db.get_singles_dict("Google Drive") if drive_settings.enable and drive_settings.frequency == "Weekly": upload_system_backup_to_google_drive() + def get_absolute_path(filename): file_path = os.path.join(get_backups_path()[2:], os.path.basename(filename)) return "{0}/sites/{1}".format(get_bench_path(), file_path) + def set_progress(progress, message): - frappe.publish_realtime("upload_to_google_drive", dict(progress=progress, total=3, message=message), user=frappe.session.user) + frappe.publish_realtime( + "upload_to_google_drive", + dict(progress=progress, total=3, message=message), + user=frappe.session.user, + ) diff --git a/frappe/integrations/doctype/google_drive/test_google_drive.py b/frappe/integrations/doctype/google_drive/test_google_drive.py index fbd9dce7f4..17f5b152ca 100644 --- a/frappe/integrations/doctype/google_drive/test_google_drive.py +++ b/frappe/integrations/doctype/google_drive/test_google_drive.py @@ -4,5 +4,6 @@ # import frappe import unittest + class TestGoogleDrive(unittest.TestCase): pass diff --git a/frappe/integrations/doctype/google_settings/google_settings.py b/frappe/integrations/doctype/google_settings/google_settings.py index 94df43e69c..0d5f9cb00d 100644 --- a/frappe/integrations/doctype/google_settings/google_settings.py +++ b/frappe/integrations/doctype/google_settings/google_settings.py @@ -5,9 +5,11 @@ import frappe from frappe.model.document import Document + class GoogleSettings(Document): pass + def get_auth_url(): return "https://www.googleapis.com/oauth2/v4/token" @@ -23,5 +25,5 @@ def get_file_picker_settings(): "enabled": True, "appId": google_settings.app_id, "developerKey": google_settings.api_key, - "clientId": google_settings.client_id + "clientId": google_settings.client_id, } diff --git a/frappe/integrations/doctype/google_settings/test_google_settings.py b/frappe/integrations/doctype/google_settings/test_google_settings.py index cddf9f3697..53d59b1be0 100644 --- a/frappe/integrations/doctype/google_settings/test_google_settings.py +++ b/frappe/integrations/doctype/google_settings/test_google_settings.py @@ -3,13 +3,14 @@ # License: MIT. See LICENSE from __future__ import unicode_literals -import frappe import unittest +import frappe + from .google_settings import get_file_picker_settings -class TestGoogleSettings(unittest.TestCase): +class TestGoogleSettings(unittest.TestCase): def setUp(self): settings = frappe.get_single("Google Settings") settings.client_id = "test_client_id" diff --git a/frappe/integrations/doctype/integration_request/integration_request.py b/frappe/integrations/doctype/integration_request/integration_request.py index ae0e024f58..4c99613161 100644 --- a/frappe/integrations/doctype/integration_request/integration_request.py +++ b/frappe/integrations/doctype/integration_request/integration_request.py @@ -2,10 +2,12 @@ # Copyright (c) 2015, Frappe Technologies and contributors # License: MIT. See LICENSE -import frappe -from frappe.model.document import Document import json + +import frappe from frappe.integrations.utils import json_handler +from frappe.model.document import Document + class IntegrationRequest(Document): def autoname(self): @@ -33,4 +35,4 @@ class IntegrationRequest(Document): if isinstance(response, str): response = json.loads(response) self.db_set("status", "Failed") - self.db_set("error", json.dumps(response, default=json_handler)) \ No newline at end of file + self.db_set("error", json.dumps(response, default=json_handler)) diff --git a/frappe/integrations/doctype/integration_request/test_integration_request.py b/frappe/integrations/doctype/integration_request/test_integration_request.py index e26ccabc96..d14af481e8 100644 --- a/frappe/integrations/doctype/integration_request/test_integration_request.py +++ b/frappe/integrations/doctype/integration_request/test_integration_request.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('Integration Request') + class TestIntegrationRequest(unittest.TestCase): pass diff --git a/frappe/integrations/doctype/ldap_group_mapping/ldap_group_mapping.py b/frappe/integrations/doctype/ldap_group_mapping/ldap_group_mapping.py index b9838b996f..f1b242e4bb 100644 --- a/frappe/integrations/doctype/ldap_group_mapping/ldap_group_mapping.py +++ b/frappe/integrations/doctype/ldap_group_mapping/ldap_group_mapping.py @@ -5,5 +5,6 @@ # import frappe from frappe.model.document import Document + class LDAPGroupMapping(Document): pass diff --git a/frappe/integrations/doctype/ldap_settings/ldap_settings.py b/frappe/integrations/doctype/ldap_settings/ldap_settings.py index cfd6e1e133..a14124234f 100644 --- a/frappe/integrations/doctype/ldap_settings/ldap_settings.py +++ b/frappe/integrations/doctype/ldap_settings/ldap_settings.py @@ -5,7 +5,8 @@ import frappe from frappe import _, safe_encode from frappe.model.document import Document -from frappe.twofactor import (should_run_2fa, authenticate_for_2factor,confirm_otp_token) +from frappe.twofactor import authenticate_for_2factor, confirm_otp_token, should_run_2fa + class LDAPSettings(Document): def validate(self): @@ -14,54 +15,74 @@ class LDAPSettings(Document): if not self.flags.ignore_mandatory: - if self.ldap_search_string.count('(') == self.ldap_search_string.count(')') and \ - self.ldap_search_string.startswith('(') and \ - self.ldap_search_string.endswith(')') and \ - self.ldap_search_string and \ - "{0}" in self.ldap_search_string: + if ( + self.ldap_search_string.count("(") == self.ldap_search_string.count(")") + and self.ldap_search_string.startswith("(") + and self.ldap_search_string.endswith(")") + and self.ldap_search_string + and "{0}" in self.ldap_search_string + ): - conn = self.connect_to_ldap(base_dn=self.base_dn, password=self.get_password(raise_exception=False)) + conn = self.connect_to_ldap( + base_dn=self.base_dn, password=self.get_password(raise_exception=False) + ) try: - if conn.result['type'] == 'bindResponse' and self.base_dn: + if conn.result["type"] == "bindResponse" and self.base_dn: import ldap3 conn.search( search_base=self.ldap_search_path_user, search_filter="(objectClass=*)", - attributes=self.get_ldap_attributes()) + attributes=self.get_ldap_attributes(), + ) conn.search( - search_base=self.ldap_search_path_group, - search_filter="(objectClass=*)", - attributes=['cn']) + search_base=self.ldap_search_path_group, search_filter="(objectClass=*)", attributes=["cn"] + ) except ldap3.core.exceptions.LDAPAttributeError as ex: - frappe.throw(_("LDAP settings incorrect. validation response was: {0}").format(ex), - title=_("Misconfigured")) + frappe.throw( + _("LDAP settings incorrect. validation response was: {0}").format(ex), + title=_("Misconfigured"), + ) except ldap3.core.exceptions.LDAPNoSuchObjectResult: - frappe.throw(_("Ensure the user and group search paths are correct."), - title=_("Misconfigured")) + frappe.throw( + _("Ensure the user and group search paths are correct."), title=_("Misconfigured") + ) - if self.ldap_directory_server.lower() == 'custom': + if self.ldap_directory_server.lower() == "custom": if not self.ldap_group_member_attribute or not self.ldap_group_objectclass: - frappe.throw(_("Custom LDAP Directoy Selected, please ensure 'LDAP Group Member attribute' and 'Group Object Class' are entered"), - title=_("Misconfigured")) + frappe.throw( + _( + "Custom LDAP Directoy Selected, please ensure 'LDAP Group Member attribute' and 'Group Object Class' are entered" + ), + title=_("Misconfigured"), + ) if self.ldap_custom_group_search and "{0}" not in self.ldap_custom_group_search: - frappe.throw(_("Custom Group Search if filled needs to contain the user placeholder {0}, eg uid={0},ou=users,dc=example,dc=com"), - title=_("Misconfigured")) + frappe.throw( + _( + "Custom Group Search if filled needs to contain the user placeholder {0}, eg uid={0},ou=users,dc=example,dc=com" + ), + title=_("Misconfigured"), + ) else: - frappe.throw(_("LDAP Search String must be enclosed in '()' and needs to contian the user placeholder {0}, eg sAMAccountName={0}")) + frappe.throw( + _( + "LDAP Search String must be enclosed in '()' and needs to contian the user placeholder {0}, eg sAMAccountName={0}" + ) + ) def connect_to_ldap(self, base_dn, password, read_only=True): try: - import ldap3 import ssl - if self.require_trusted_certificate == 'Yes': + import ldap3 + + if self.require_trusted_certificate == "Yes": tls_configuration = ldap3.Tls(validate=ssl.CERT_REQUIRED, version=ssl.PROTOCOL_TLS_CLIENT) else: tls_configuration = ldap3.Tls(validate=ssl.CERT_NONE, version=ssl.PROTOCOL_TLS_CLIENT) @@ -82,7 +103,8 @@ class LDAPSettings(Document): password=password, auto_bind=bind_type, read_only=read_only, - raise_exceptions=True) + raise_exceptions=True, + ) return conn @@ -97,9 +119,7 @@ class LDAPSettings(Document): @staticmethod def get_ldap_client_settings(): # return the settings to be used on the client side. - result = { - "enabled": False - } + result = {"enabled": False} ldap = frappe.get_doc("LDAP Settings") if ldap.enabled: result["enabled"] = True @@ -109,7 +129,7 @@ class LDAPSettings(Document): @classmethod def update_user_fields(cls, user, user_data): - updatable_data = {key: value for key, value in user_data.items() if key != 'email'} + updatable_data = {key: value for key, value in user_data.items() if key != "email"} for key, value in updatable_data.items(): setattr(user, key, value) @@ -125,7 +145,9 @@ class LDAPSettings(Document): lower_groups = [g.lower() for g in additional_groups or []] all_mapped_roles = {r.erpnext_role for r in self.ldap_groups} - matched_roles = {r.erpnext_role for r in self.ldap_groups if r.ldap_group.lower() in lower_groups} + matched_roles = { + r.erpnext_role for r in self.ldap_groups if r.ldap_group.lower() in lower_groups + } unmatched_roles = all_mapped_roles.difference(matched_roles) needed_roles.update(matched_roles) roles_to_remove = current_roles.intersection(unmatched_roles) @@ -138,20 +160,22 @@ class LDAPSettings(Document): def create_or_update_user(self, user_data, groups=None): user = None - if frappe.db.exists("User", user_data['email']): - user = frappe.get_doc("User", user_data['email']) + if frappe.db.exists("User", user_data["email"]): + user = frappe.get_doc("User", user_data["email"]) LDAPSettings.update_user_fields(user=user, user_data=user_data) else: doc = user_data - doc.update({ - "doctype": "User", - "send_welcome_email": 0, - "language": "", - "user_type": "System User", - # "roles": [{ - # "role": self.default_role - # }] - }) + doc.update( + { + "doctype": "User", + "send_welcome_email": 0, + "language": "", + "user_type": "System User", + # "roles": [{ + # "role": self.default_role + # }] + } + ) user = frappe.get_doc(doc) user.insert(ignore_permissions=True) # always add default role. @@ -180,36 +204,39 @@ class LDAPSettings(Document): return ldap_attributes - def fetch_ldap_groups(self, user, conn): import ldap3 if type(user) is not ldap3.abstract.entry.Entry: - raise TypeError("Invalid type, attribute {0} must be of type '{1}'".format('user', 'ldap3.abstract.entry.Entry')) + raise TypeError( + "Invalid type, attribute {0} must be of type '{1}'".format( + "user", "ldap3.abstract.entry.Entry" + ) + ) if type(conn) is not ldap3.core.connection.Connection: - raise TypeError("Invalid type, attribute {0} must be of type '{1}'".format('conn', 'ldap3.Connection')) + raise TypeError( + "Invalid type, attribute {0} must be of type '{1}'".format("conn", "ldap3.Connection") + ) fetch_ldap_groups = None ldap_object_class = None ldap_group_members_attribute = None + if self.ldap_directory_server.lower() == "active directory": - if self.ldap_directory_server.lower() == 'active directory': - - ldap_object_class = 'Group' - ldap_group_members_attribute = 'member' + ldap_object_class = "Group" + ldap_group_members_attribute = "member" user_search_str = user.entry_dn + elif self.ldap_directory_server.lower() == "openldap": - elif self.ldap_directory_server.lower() == 'openldap': - - ldap_object_class = 'posixgroup' - ldap_group_members_attribute = 'memberuid' + ldap_object_class = "posixgroup" + ldap_group_members_attribute = "memberuid" user_search_str = getattr(user, self.ldap_username_field).value - elif self.ldap_directory_server.lower() == 'custom': + elif self.ldap_directory_server.lower() == "custom": ldap_object_class = self.ldap_group_objectclass ldap_group_members_attribute = self.ldap_group_member_attribute @@ -227,20 +254,20 @@ class LDAPSettings(Document): if ldap_object_class is not None: conn.search( search_base=self.ldap_search_path_group, - search_filter="(&(objectClass={0})({1}={2}))".format(ldap_object_class,ldap_group_members_attribute, user_search_str), - attributes=['cn']) # Build search query + search_filter="(&(objectClass={0})({1}={2}))".format( + ldap_object_class, ldap_group_members_attribute, user_search_str + ), + attributes=["cn"], + ) # Build search query if len(conn.entries) >= 1: fetch_ldap_groups = [] for group in conn.entries: - fetch_ldap_groups.append(group['cn'].value) + fetch_ldap_groups.append(group["cn"].value) return fetch_ldap_groups - - - def authenticate(self, username, password): if not self.enabled: @@ -257,7 +284,8 @@ class LDAPSettings(Document): conn.search( search_base=self.ldap_search_path_user, search_filter="{0}".format(user_filter), - attributes=ldap_attributes) + attributes=ldap_attributes, + ) if len(conn.entries) == 1 and conn.entries[0]: user = conn.entries[0] @@ -269,7 +297,7 @@ class LDAPSettings(Document): return self.create_or_update_user(self.convert_ldap_entry_to_dict(user), groups=groups) - raise ldap3.core.exceptions.LDAPInvalidCredentialsResult # even though nothing foundor failed authentication raise invalid credentials + raise ldap3.core.exceptions.LDAPInvalidCredentialsResult # even though nothing foundor failed authentication raise invalid credentials except ldap3.core.exceptions.LDAPInvalidFilterError: frappe.throw(_("Please use a valid LDAP search filter"), title=_("Misconfigured")) @@ -277,28 +305,29 @@ class LDAPSettings(Document): except ldap3.core.exceptions.LDAPInvalidCredentialsResult: frappe.throw(_("Invalid username or password")) - def reset_password(self, user, password, logout_sessions=False): from ldap3 import HASHED_SALTED_SHA, MODIFY_REPLACE from ldap3.utils.hashed import hashed search_filter = "({0}={1})".format(self.ldap_email_field, user) - conn = self.connect_to_ldap(self.base_dn, self.get_password(raise_exception=False), - read_only=False) + conn = self.connect_to_ldap( + self.base_dn, self.get_password(raise_exception=False), read_only=False + ) if conn.search( search_base=self.ldap_search_path_user, search_filter=search_filter, - attributes=self.get_ldap_attributes() + attributes=self.get_ldap_attributes(), ): if conn.entries and conn.entries[0]: entry_dn = conn.entries[0].entry_dn hashed_password = hashed(HASHED_SALTED_SHA, safe_encode(password)) - changes = {'userPassword': [(MODIFY_REPLACE, [hashed_password])]} + changes = {"userPassword": [(MODIFY_REPLACE, [hashed_password])]} if conn.modify(entry_dn, changes=changes): if logout_sessions: from frappe.sessions import clear_sessions + clear_sessions(user=user, force=True) frappe.msgprint(_("Password changed successfully.")) else: @@ -314,24 +343,24 @@ class LDAPSettings(Document): email = user_entry[self.ldap_email_field] data = { - 'username': user_entry[self.ldap_username_field].value, - 'email': str(email.value[0] if isinstance(email.value, list) else email.value), - 'first_name': user_entry[self.ldap_first_name_field].value + "username": user_entry[self.ldap_username_field].value, + "email": str(email.value[0] if isinstance(email.value, list) else email.value), + "first_name": user_entry[self.ldap_first_name_field].value, } # optional fields if self.ldap_middle_name_field: - data['middle_name'] = user_entry[self.ldap_middle_name_field].value + data["middle_name"] = user_entry[self.ldap_middle_name_field].value if self.ldap_last_name_field: - data['last_name'] = user_entry[self.ldap_last_name_field].value + data["last_name"] = user_entry[self.ldap_last_name_field].value if self.ldap_phone_field: - data['phone'] = user_entry[self.ldap_phone_field].value + data["phone"] = user_entry[self.ldap_phone_field].value if self.ldap_mobile_field: - data['mobile_no'] = user_entry[self.ldap_mobile_field].value + data["mobile_no"] = user_entry[self.ldap_mobile_field].value return data diff --git a/frappe/integrations/doctype/ldap_settings/test_ldap_settings.py b/frappe/integrations/doctype/ldap_settings/test_ldap_settings.py index 41997fb4c7..0651932843 100644 --- a/frappe/integrations/doctype/ldap_settings/test_ldap_settings.py +++ b/frappe/integrations/doctype/ldap_settings/test_ldap_settings.py @@ -1,20 +1,21 @@ # -*- coding: utf-8 -*- # Copyright (c) 2019, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe -import unittest import functools -import ldap3 -import ssl import os - +import ssl +import unittest from unittest import mock + +import ldap3 +from ldap3 import MOCK_SYNC, OFFLINE_AD_2012_R2, OFFLINE_SLAPD_2_4, Connection, Server + +import frappe from frappe.integrations.doctype.ldap_settings.ldap_settings import LDAPSettings -from ldap3 import Server, Connection, MOCK_SYNC, OFFLINE_SLAPD_2_4, OFFLINE_AD_2012_R2 -class LDAP_TestCase(): - TEST_LDAP_SERVER = None # must match the 'LDAP Settings' field option +class LDAP_TestCase: + TEST_LDAP_SERVER = None # must match the 'LDAP Settings' field option TEST_LDAP_SEARCH_STRING = None LDAP_USERNAME_FIELD = None DOCUMENT_GROUP_MAPPINGS = [] @@ -23,11 +24,12 @@ class LDAP_TestCase(): TEST_VALUES_LDAP_COMPLEX_SEARCH_STRING = None def mock_ldap_connection(f): - @functools.wraps(f) def wrapped(self, *args, **kwargs): - with mock.patch('frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.connect_to_ldap') as mock_connection: + with mock.patch( + "frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.connect_to_ldap" + ) as mock_connection: mock_connection.return_value = self.connection self.test_class = LDAPSettings(self.doc) @@ -38,7 +40,6 @@ class LDAP_TestCase(): rv = f(self, *args, **kwargs) - # Clean-up self.test_class = None @@ -47,65 +48,66 @@ class LDAP_TestCase(): return wrapped def clean_test_users(): - try: # clean up test user 1 - frappe.get_doc("User", 'posix.user1@unit.testing').delete() + try: # clean up test user 1 + frappe.get_doc("User", "posix.user1@unit.testing").delete() except Exception: pass - try: # clean up test user 2 - frappe.get_doc("User", 'posix.user2@unit.testing').delete() + try: # clean up test user 2 + frappe.get_doc("User", "posix.user2@unit.testing").delete() except Exception: pass - @classmethod - def setUpClass(self, ldapServer='OpenLDAP'): + def setUpClass(self, ldapServer="OpenLDAP"): self.clean_test_users() # Save user data for restoration in tearDownClass() - self.user_ldap_settings = frappe.get_doc('LDAP Settings') + self.user_ldap_settings = frappe.get_doc("LDAP Settings") # Create test user1 self.user1doc = { - 'username': 'posix.user', - 'email': 'posix.user1@unit.testing', - 'first_name': 'posix' + "username": "posix.user", + "email": "posix.user1@unit.testing", + "first_name": "posix", } - self.user1doc.update({ - "doctype": "User", - "send_welcome_email": 0, - "language": "", - "user_type": "System User", - }) + self.user1doc.update( + { + "doctype": "User", + "send_welcome_email": 0, + "language": "", + "user_type": "System User", + } + ) user = frappe.get_doc(self.user1doc) user.insert(ignore_permissions=True) # Create test user1 self.user2doc = { - 'username': 'posix.user2', - 'email': 'posix.user2@unit.testing', - 'first_name': 'posix' + "username": "posix.user2", + "email": "posix.user2@unit.testing", + "first_name": "posix", } - self.user2doc.update({ - "doctype": "User", - "send_welcome_email": 0, - "language": "", - "user_type": "System User", - }) + self.user2doc.update( + { + "doctype": "User", + "send_welcome_email": 0, + "language": "", + "user_type": "System User", + } + ) user = frappe.get_doc(self.user2doc) user.insert(ignore_permissions=True) - # Setup Mock OpenLDAP Directory - self.ldap_dc_path = 'dc=unit,dc=testing' - self.ldap_user_path = 'ou=users,' + self.ldap_dc_path - self.ldap_group_path = 'ou=groups,' + self.ldap_dc_path - self.base_dn = 'cn=base_dn_user,' + self.ldap_dc_path - self.base_password = 'my_password' - self.ldap_server = 'ldap://my_fake_server:389' - + self.ldap_dc_path = "dc=unit,dc=testing" + self.ldap_user_path = "ou=users," + self.ldap_dc_path + self.ldap_group_path = "ou=groups," + self.ldap_dc_path + self.base_dn = "cn=base_dn_user," + self.ldap_dc_path + self.base_password = "my_password" + self.ldap_server = "ldap://my_fake_server:389" self.doc = { "doctype": "LDAP Settings", @@ -117,25 +119,26 @@ class LDAP_TestCase(): "ldap_search_path_user": self.ldap_user_path, "ldap_search_string": self.TEST_LDAP_SEARCH_STRING, "ldap_search_path_group": self.ldap_group_path, - "ldap_user_creation_and_mapping_section": '', - "ldap_email_field": 'mail', + "ldap_user_creation_and_mapping_section": "", + "ldap_email_field": "mail", "ldap_username_field": self.LDAP_USERNAME_FIELD, - "ldap_first_name_field": 'givenname', - "ldap_middle_name_field": '', - "ldap_last_name_field": 'sn', - "ldap_phone_field": 'telephonenumber', - "ldap_mobile_field": 'mobile', - "ldap_security": '', - "ssl_tls_mode": '', - "require_trusted_certificate": 'No', - "local_private_key_file": '', - "local_server_certificate_file": '', - "local_ca_certs_file": '', - "ldap_group_objectclass": '', - "ldap_group_member_attribute": '', - "default_role": 'Newsletter Manager', + "ldap_first_name_field": "givenname", + "ldap_middle_name_field": "", + "ldap_last_name_field": "sn", + "ldap_phone_field": "telephonenumber", + "ldap_mobile_field": "mobile", + "ldap_security": "", + "ssl_tls_mode": "", + "require_trusted_certificate": "No", + "local_private_key_file": "", + "local_server_certificate_file": "", + "local_ca_certs_file": "", + "ldap_group_objectclass": "", + "ldap_group_member_attribute": "", + "default_role": "Newsletter Manager", "ldap_groups": self.DOCUMENT_GROUP_MAPPINGS, - "ldap_group_field": ''} + "ldap_group_field": "", + } self.server = Server(host=self.ldap_server, port=389, get_info=self.LDAP_SCHEMA) @@ -144,17 +147,19 @@ class LDAP_TestCase(): user=self.base_dn, password=self.base_password, read_only=True, - client_strategy=MOCK_SYNC) + client_strategy=MOCK_SYNC, + ) - self.connection.strategy.entries_from_json(os.path.abspath(os.path.dirname(__file__)) + '/' + self.LDAP_LDIF_JSON) + self.connection.strategy.entries_from_json( + os.path.abspath(os.path.dirname(__file__)) + "/" + self.LDAP_LDIF_JSON + ) self.connection.bind() - @classmethod def tearDownClass(self): try: - frappe.get_doc('LDAP Settings').delete() + frappe.get_doc("LDAP Settings").delete() except Exception: pass @@ -172,78 +177,77 @@ class LDAP_TestCase(): # Clear OpenLDAP connection self.connection = None - @mock_ldap_connection def test_mandatory_fields(self): mandatory_fields = [ - 'ldap_server_url', - 'ldap_directory_server', - 'base_dn', - 'password', - 'ldap_search_path_user', - 'ldap_search_path_group', - 'ldap_search_string', - 'ldap_email_field', - 'ldap_username_field', - 'ldap_first_name_field', - 'require_trusted_certificate', - 'default_role' - ] # fields that are required to have ldap functioning need to be mandatory + "ldap_server_url", + "ldap_directory_server", + "base_dn", + "password", + "ldap_search_path_user", + "ldap_search_path_group", + "ldap_search_string", + "ldap_email_field", + "ldap_username_field", + "ldap_first_name_field", + "require_trusted_certificate", + "default_role", + ] # fields that are required to have ldap functioning need to be mandatory for mandatory_field in mandatory_fields: localdoc = self.doc.copy() - localdoc[mandatory_field] = '' + localdoc[mandatory_field] = "" try: frappe.get_doc(localdoc).save() - self.fail('Document LDAP Settings field [{0}] is not mandatory'.format(mandatory_field)) + self.fail("Document LDAP Settings field [{0}] is not mandatory".format(mandatory_field)) except frappe.exceptions.MandatoryError: pass except frappe.exceptions.ValidationError: - if mandatory_field == 'ldap_search_string': + if mandatory_field == "ldap_search_string": # additional validation is done on this field, pass in this instance pass + for non_mandatory_field in self.doc: # Ensure remaining fields have not been made mandatory - for non_mandatory_field in self.doc: # Ensure remaining fields have not been made mandatory - - if non_mandatory_field == 'doctype' or non_mandatory_field in mandatory_fields: + if non_mandatory_field == "doctype" or non_mandatory_field in mandatory_fields: continue localdoc = self.doc.copy() - localdoc[non_mandatory_field] = '' + localdoc[non_mandatory_field] = "" try: frappe.get_doc(localdoc).save() except frappe.exceptions.MandatoryError: - self.fail('Document LDAP Settings field [{0}] should not be mandatory'.format(non_mandatory_field)) - + self.fail( + "Document LDAP Settings field [{0}] should not be mandatory".format(non_mandatory_field) + ) @mock_ldap_connection def test_validation_ldap_search_string(self): invalid_ldap_search_strings = [ - '', - 'uid={0}', - '(uid={0}', - 'uid={0})', - '(&(objectclass=posixgroup)(uid={0})', - '&(objectclass=posixgroup)(uid={0}))', - '(uid=no_placeholder)' - ] # ldap search string must be enclosed in '()' for ldap search to work for finding user and have the same number of opening and closing brackets. + "", + "uid={0}", + "(uid={0}", + "uid={0})", + "(&(objectclass=posixgroup)(uid={0})", + "&(objectclass=posixgroup)(uid={0}))", + "(uid=no_placeholder)", + ] # ldap search string must be enclosed in '()' for ldap search to work for finding user and have the same number of opening and closing brackets. for invalid_search_string in invalid_ldap_search_strings: localdoc = self.doc.copy() - localdoc['ldap_search_string'] = invalid_search_string + localdoc["ldap_search_string"] = invalid_search_string try: frappe.get_doc(localdoc).save() @@ -253,95 +257,113 @@ class LDAP_TestCase(): except frappe.exceptions.ValidationError: pass - def test_connect_to_ldap(self): # setup a clean doc with ldap disabled so no validation occurs (this is tested seperatly) local_doc = self.doc.copy() - local_doc['enabled'] = False + local_doc["enabled"] = False self.test_class = LDAPSettings(self.doc) - with mock.patch('ldap3.Server') as ldap3_server_method: + with mock.patch("ldap3.Server") as ldap3_server_method: - with mock.patch('ldap3.Connection') as ldap3_connection_method: + with mock.patch("ldap3.Connection") as ldap3_connection_method: ldap3_connection_method.return_value = self.connection - with mock.patch('ldap3.Tls') as ldap3_Tls_method: + with mock.patch("ldap3.Tls") as ldap3_Tls_method: - function_return = self.test_class.connect_to_ldap(base_dn=self.base_dn, password=self.base_password) + function_return = self.test_class.connect_to_ldap( + base_dn=self.base_dn, password=self.base_password + ) args, kwargs = ldap3_connection_method.call_args prevent_connection_parameters = { # prevent these parameters for security or lack of the und user from being able to configure - 'mode': { - 'IP_V4_ONLY': 'Locks the user to IPv4 without frappe providing a way to configure', - 'IP_V6_ONLY': 'Locks the user to IPv6 without frappe providing a way to configure' + "mode": { + "IP_V4_ONLY": "Locks the user to IPv4 without frappe providing a way to configure", + "IP_V6_ONLY": "Locks the user to IPv6 without frappe providing a way to configure", + }, + "auto_bind": { + "NONE": "ldap3.Connection must autobind with base_dn", + "NO_TLS": "ldap3.Connection must have TLS", + "TLS_AFTER_BIND": "[Security] ldap3.Connection TLS bind must occur before bind", }, - 'auto_bind': { - 'NONE': 'ldap3.Connection must autobind with base_dn', - 'NO_TLS': 'ldap3.Connection must have TLS', - 'TLS_AFTER_BIND': '[Security] ldap3.Connection TLS bind must occur before bind' - } } for connection_arg in kwargs: - if connection_arg in prevent_connection_parameters and \ - kwargs[connection_arg] in prevent_connection_parameters[connection_arg]: + if ( + connection_arg in prevent_connection_parameters + and kwargs[connection_arg] in prevent_connection_parameters[connection_arg] + ): - self.fail('ldap3.Connection was called with {0}, failed reason: [{1}]'.format( - kwargs[connection_arg], - prevent_connection_parameters[connection_arg][kwargs[connection_arg]])) + self.fail( + "ldap3.Connection was called with {0}, failed reason: [{1}]".format( + kwargs[connection_arg], + prevent_connection_parameters[connection_arg][kwargs[connection_arg]], + ) + ) - if local_doc['require_trusted_certificate'] == 'Yes': + if local_doc["require_trusted_certificate"] == "Yes": tls_validate = ssl.CERT_REQUIRED tls_version = ssl.PROTOCOL_TLS_CLIENT tls_configuration = ldap3.Tls(validate=tls_validate, version=tls_version) - self.assertTrue(kwargs['auto_bind'] == ldap3.AUTO_BIND_TLS_BEFORE_BIND, - 'Security: [ldap3.Connection] autobind TLS before bind with value ldap3.AUTO_BIND_TLS_BEFORE_BIND') + self.assertTrue( + kwargs["auto_bind"] == ldap3.AUTO_BIND_TLS_BEFORE_BIND, + "Security: [ldap3.Connection] autobind TLS before bind with value ldap3.AUTO_BIND_TLS_BEFORE_BIND", + ) else: tls_validate = ssl.CERT_NONE tls_version = ssl.PROTOCOL_TLS_CLIENT tls_configuration = ldap3.Tls(validate=tls_validate, version=tls_version) - self.assertTrue(kwargs['auto_bind'], - 'ldap3.Connection must autobind') - + self.assertTrue(kwargs["auto_bind"], "ldap3.Connection must autobind") ldap3_Tls_method.assert_called_with(validate=tls_validate, version=tls_version) - ldap3_server_method.assert_called_with(host=self.doc['ldap_server_url'], tls=tls_configuration) + ldap3_server_method.assert_called_with( + host=self.doc["ldap_server_url"], tls=tls_configuration + ) - self.assertTrue(kwargs['password'] == self.base_password, - 'ldap3.Connection password does not match provided password') + self.assertTrue( + kwargs["password"] == self.base_password, + "ldap3.Connection password does not match provided password", + ) - self.assertTrue(kwargs['raise_exceptions'], - 'ldap3.Connection must raise exceptions for error handling') + self.assertTrue( + kwargs["raise_exceptions"], "ldap3.Connection must raise exceptions for error handling" + ) - self.assertTrue(kwargs['user'] == self.base_dn, - 'ldap3.Connection user does not match provided user') + self.assertTrue( + kwargs["user"] == self.base_dn, "ldap3.Connection user does not match provided user" + ) - ldap3_connection_method.assert_called_with(server=ldap3_server_method.return_value, + ldap3_connection_method.assert_called_with( + server=ldap3_server_method.return_value, auto_bind=True, password=self.base_password, raise_exceptions=True, read_only=True, - user=self.base_dn) + user=self.base_dn, + ) - self.assertTrue(type(function_return) is ldap3.core.connection.Connection, - 'The return type must be of ldap3.Connection') + self.assertTrue( + type(function_return) is ldap3.core.connection.Connection, + "The return type must be of ldap3.Connection", + ) - function_return = self.test_class.connect_to_ldap(base_dn=self.base_dn, password=self.base_password, read_only=False) + function_return = self.test_class.connect_to_ldap( + base_dn=self.base_dn, password=self.base_password, read_only=False + ) args, kwargs = ldap3_connection_method.call_args - self.assertFalse(kwargs['read_only'], 'connect_to_ldap() read_only parameter supplied as False but does not match the ldap3.Connection() read_only named parameter') - - - + self.assertFalse( + kwargs["read_only"], + "connect_to_ldap() read_only parameter supplied as False but does not match the ldap3.Connection() read_only named parameter", + ) @mock_ldap_connection def test_get_ldap_client_settings(self): @@ -350,133 +372,173 @@ class LDAP_TestCase(): self.assertIsInstance(result, dict) - self.assertTrue(result['enabled'] == self.doc['enabled']) # settings should match doc + self.assertTrue(result["enabled"] == self.doc["enabled"]) # settings should match doc localdoc = self.doc.copy() - localdoc['enabled'] = False + localdoc["enabled"] = False frappe.get_doc(localdoc).save() result = self.test_class.get_ldap_client_settings() - self.assertFalse(result['enabled']) # must match the edited doc - + self.assertFalse(result["enabled"]) # must match the edited doc @mock_ldap_connection def test_update_user_fields(self): test_user_data = { - 'username': 'posix.user', - 'email': 'posix.user1@unit.testing', - 'first_name': 'posix', - 'middle_name': 'another', - 'last_name': 'user', - 'phone': '08 1234 5678', - 'mobile_no': '0421 123 456' + "username": "posix.user", + "email": "posix.user1@unit.testing", + "first_name": "posix", + "middle_name": "another", + "last_name": "user", + "phone": "08 1234 5678", + "mobile_no": "0421 123 456", } - test_user = frappe.get_doc("User", test_user_data['email']) + test_user = frappe.get_doc("User", test_user_data["email"]) self.test_class.update_user_fields(test_user, test_user_data) - updated_user = frappe.get_doc("User", test_user_data['email']) - - self.assertTrue(updated_user.middle_name == test_user_data['middle_name']) - self.assertTrue(updated_user.last_name == test_user_data['last_name']) - self.assertTrue(updated_user.phone == test_user_data['phone']) - self.assertTrue(updated_user.mobile_no == test_user_data['mobile_no']) + updated_user = frappe.get_doc("User", test_user_data["email"]) + self.assertTrue(updated_user.middle_name == test_user_data["middle_name"]) + self.assertTrue(updated_user.last_name == test_user_data["last_name"]) + self.assertTrue(updated_user.phone == test_user_data["phone"]) + self.assertTrue(updated_user.mobile_no == test_user_data["mobile_no"]) @mock_ldap_connection def test_sync_roles(self): - if self.TEST_LDAP_SERVER.lower() == 'openldap': + if self.TEST_LDAP_SERVER.lower() == "openldap": test_user_data = { - 'posix.user1': ['Users', 'Administrators', 'default_role', 'frappe_default_all','frappe_default_guest'], - 'posix.user2': ['Users', 'Group3', 'default_role', 'frappe_default_all', 'frappe_default_guest'] + "posix.user1": [ + "Users", + "Administrators", + "default_role", + "frappe_default_all", + "frappe_default_guest", + ], + "posix.user2": [ + "Users", + "Group3", + "default_role", + "frappe_default_all", + "frappe_default_guest", + ], } - elif self.TEST_LDAP_SERVER.lower() == 'active directory': + elif self.TEST_LDAP_SERVER.lower() == "active directory": test_user_data = { - 'posix.user1': ['Domain Users', 'Domain Administrators', 'default_role', 'frappe_default_all','frappe_default_guest'], - 'posix.user2': ['Domain Users', 'Enterprise Administrators', 'default_role', 'frappe_default_all', 'frappe_default_guest'] + "posix.user1": [ + "Domain Users", + "Domain Administrators", + "default_role", + "frappe_default_all", + "frappe_default_guest", + ], + "posix.user2": [ + "Domain Users", + "Enterprise Administrators", + "default_role", + "frappe_default_all", + "frappe_default_guest", + ], } - role_to_group_map = { - self.doc['ldap_groups'][0]['erpnext_role']: self.doc['ldap_groups'][0]['ldap_group'], - self.doc['ldap_groups'][1]['erpnext_role']: self.doc['ldap_groups'][1]['ldap_group'], - self.doc['ldap_groups'][2]['erpnext_role']: self.doc['ldap_groups'][2]['ldap_group'], - 'Newsletter Manager': 'default_role', - 'All': 'frappe_default_all', - 'Guest': 'frappe_default_guest', - + self.doc["ldap_groups"][0]["erpnext_role"]: self.doc["ldap_groups"][0]["ldap_group"], + self.doc["ldap_groups"][1]["erpnext_role"]: self.doc["ldap_groups"][1]["ldap_group"], + self.doc["ldap_groups"][2]["erpnext_role"]: self.doc["ldap_groups"][2]["ldap_group"], + "Newsletter Manager": "default_role", + "All": "frappe_default_all", + "Guest": "frappe_default_guest", } # re-create user1 to ensure clean - frappe.get_doc("User", 'posix.user1@unit.testing').delete() + frappe.get_doc("User", "posix.user1@unit.testing").delete() user = frappe.get_doc(self.user1doc) user.insert(ignore_permissions=True) for test_user in test_user_data: - test_user_doc = frappe.get_doc("User", test_user + '@unit.testing') - test_user_roles = frappe.get_roles(test_user + '@unit.testing') + test_user_doc = frappe.get_doc("User", test_user + "@unit.testing") + test_user_roles = frappe.get_roles(test_user + "@unit.testing") - self.assertTrue(len(test_user_roles) == 2, - 'User should only be a part of the All and Guest roles') # check default frappe roles + self.assertTrue( + len(test_user_roles) == 2, "User should only be a part of the All and Guest roles" + ) # check default frappe roles - self.test_class.sync_roles(test_user_doc, test_user_data[test_user]) # update user roles + self.test_class.sync_roles(test_user_doc, test_user_data[test_user]) # update user roles - frappe.get_doc("User", test_user + '@unit.testing') - updated_user_roles = frappe.get_roles(test_user + '@unit.testing') + frappe.get_doc("User", test_user + "@unit.testing") + updated_user_roles = frappe.get_roles(test_user + "@unit.testing") - self.assertTrue(len(updated_user_roles) == len(test_user_data[test_user]), - 'syncing of the user roles failed. {0} != {1} for user {2}'.format(len(updated_user_roles), len(test_user_data[test_user]), test_user)) + self.assertTrue( + len(updated_user_roles) == len(test_user_data[test_user]), + "syncing of the user roles failed. {0} != {1} for user {2}".format( + len(updated_user_roles), len(test_user_data[test_user]), test_user + ), + ) - for user_role in updated_user_roles: # match each users role mapped to ldap groups + for user_role in updated_user_roles: # match each users role mapped to ldap groups - self.assertTrue(role_to_group_map[user_role] in test_user_data[test_user], - 'during sync_roles(), the user was given role {0} which should not have occured'.format(user_role)) + self.assertTrue( + role_to_group_map[user_role] in test_user_data[test_user], + "during sync_roles(), the user was given role {0} which should not have occured".format( + user_role + ), + ) @mock_ldap_connection def test_create_or_update_user(self): test_user_data = { - 'posix.user1': ['Users', 'Administrators', 'default_role', 'frappe_default_all','frappe_default_guest'], + "posix.user1": [ + "Users", + "Administrators", + "default_role", + "frappe_default_all", + "frappe_default_guest", + ], } - test_user = 'posix.user1' + test_user = "posix.user1" - frappe.get_doc("User", test_user + '@unit.testing').delete() # remove user 1 + frappe.get_doc("User", test_user + "@unit.testing").delete() # remove user 1 - with self.assertRaises(frappe.exceptions.DoesNotExistError): # ensure user deleted so function can be tested - frappe.get_doc("User", test_user + '@unit.testing') + with self.assertRaises( + frappe.exceptions.DoesNotExistError + ): # ensure user deleted so function can be tested + frappe.get_doc("User", test_user + "@unit.testing") - - with mock.patch('frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.update_user_fields') \ - as update_user_fields_method: + with mock.patch( + "frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.update_user_fields" + ) as update_user_fields_method: update_user_fields_method.return_value = None - - with mock.patch('frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.sync_roles') as sync_roles_method: + with mock.patch( + "frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.sync_roles" + ) as sync_roles_method: sync_roles_method.return_value = None # New user self.test_class.create_or_update_user(self.user1doc, test_user_data[test_user]) - self.assertTrue(sync_roles_method.called, 'User roles need to be updated for a new user') - self.assertFalse(update_user_fields_method.called, - 'User roles are not required to be updated for a new user, this will occur during logon') - + self.assertTrue(sync_roles_method.called, "User roles need to be updated for a new user") + self.assertFalse( + update_user_fields_method.called, + "User roles are not required to be updated for a new user, this will occur during logon", + ) # Existing user self.test_class.create_or_update_user(self.user1doc, test_user_data[test_user]) - self.assertTrue(sync_roles_method.called, 'User roles need to be updated for an existing user') - self.assertTrue(update_user_fields_method.called, 'User fields need to be updated for an existing user') - + self.assertTrue(sync_roles_method.called, "User roles need to be updated for an existing user") + self.assertTrue( + update_user_fields_method.called, "User fields need to be updated for an existing user" + ) @mock_ldap_connection def test_get_ldap_attributes(self): @@ -485,22 +547,15 @@ class LDAP_TestCase(): self.assertTrue(type(method_return) is list) - - @mock_ldap_connection def test_fetch_ldap_groups(self): - if self.TEST_LDAP_SERVER.lower() == 'openldap': + if self.TEST_LDAP_SERVER.lower() == "openldap": + test_users = {"posix.user": ["Users", "Administrators"], "posix.user2": ["Users", "Group3"]} + elif self.TEST_LDAP_SERVER.lower() == "active directory": test_users = { - 'posix.user': ['Users', 'Administrators'], - 'posix.user2': ['Users', 'Group3'] - - } - elif self.TEST_LDAP_SERVER.lower() == 'active directory': - test_users = { - 'posix.user': ['Domain Users', 'Domain Administrators'], - 'posix.user2': ['Domain Users', 'Enterprise Administrators'] - + "posix.user": ["Domain Users", "Domain Administrators"], + "posix.user2": ["Domain Users", "Enterprise Administrators"], } for test_user in test_users: @@ -508,7 +563,8 @@ class LDAP_TestCase(): self.connection.search( search_base=self.ldap_user_path, search_filter=self.TEST_LDAP_SEARCH_STRING.format(test_user), - attributes=self.test_class.get_ldap_attributes()) + attributes=self.test_class.get_ldap_attributes(), + ) method_return = self.test_class.fetch_ldap_groups(self.connection.entries[0], self.connection) @@ -519,30 +575,31 @@ class LDAP_TestCase(): self.assertTrue(returned_group in test_users[test_user]) - - @mock_ldap_connection def test_authenticate(self): - with mock.patch('frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.fetch_ldap_groups') as \ - fetch_ldap_groups_function: + with mock.patch( + "frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.fetch_ldap_groups" + ) as fetch_ldap_groups_function: fetch_ldap_groups_function.return_value = None - self.assertTrue(self.test_class.authenticate('posix.user', 'posix_user_password')) + self.assertTrue(self.test_class.authenticate("posix.user", "posix_user_password")) - self.assertTrue(fetch_ldap_groups_function.called, - 'As part of authentication function fetch_ldap_groups_function needs to be called') + self.assertTrue( + fetch_ldap_groups_function.called, + "As part of authentication function fetch_ldap_groups_function needs to be called", + ) invalid_users = [ - {'prefix_posix.user': 'posix_user_password'}, - {'posix.user_postfix': 'posix_user_password'}, - {'posix.user': 'posix_user_password_postfix'}, - {'posix.user': 'prefix_posix_user_password'}, - {'posix.user': ''}, - {'': 'posix_user_password'}, - {'': ''} - ] # All invalid users should return 'invalid username or password' + {"prefix_posix.user": "posix_user_password"}, + {"posix.user_postfix": "posix_user_password"}, + {"posix.user": "posix_user_password_postfix"}, + {"posix.user": "prefix_posix_user_password"}, + {"posix.user": ""}, + {"": "posix_user_password"}, + {"": ""}, + ] # All invalid users should return 'invalid username or password' for username, password in enumerate(invalid_users): @@ -550,9 +607,12 @@ class LDAP_TestCase(): self.test_class.authenticate(username, password) - self.assertTrue(str(display_massage.exception).lower() == 'invalid username or password', - 'invalid credentials passed authentication [user: {0}, password: {1}]'.format(username, password)) - + self.assertTrue( + str(display_massage.exception).lower() == "invalid username or password", + "invalid credentials passed authentication [user: {0}, password: {1}]".format( + username, password + ), + ) @mock_ldap_connection def test_complex_ldap_search_filter(self): @@ -563,17 +623,18 @@ class LDAP_TestCase(): self.test_class.ldap_search_string = search_filter - if 'ACCESS:test3' in search_filter: # posix.user does not have str in ldap.description auth should fail + if ( + "ACCESS:test3" in search_filter + ): # posix.user does not have str in ldap.description auth should fail with self.assertRaises(frappe.exceptions.ValidationError) as display_massage: - self.test_class.authenticate('posix.user', 'posix_user_password') + self.test_class.authenticate("posix.user", "posix_user_password") - self.assertTrue(str(display_massage.exception).lower() == 'invalid username or password') + self.assertTrue(str(display_massage.exception).lower() == "invalid username or password") else: - self.assertTrue(self.test_class.authenticate('posix.user', 'posix_user_password')) - + self.assertTrue(self.test_class.authenticate("posix.user", "posix_user_password")) def test_reset_password(self): @@ -582,103 +643,95 @@ class LDAP_TestCase(): # Create a clean doc localdoc = self.doc.copy() - localdoc['enabled'] = False + localdoc["enabled"] = False frappe.get_doc(localdoc).save() - with mock.patch('frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.connect_to_ldap') as connect_to_ldap: + with mock.patch( + "frappe.integrations.doctype.ldap_settings.ldap_settings.LDAPSettings.connect_to_ldap" + ) as connect_to_ldap: connect_to_ldap.return_value = self.connection - with self.assertRaises(frappe.exceptions.ValidationError) as validation: # Fail if username string used - self.test_class.reset_password('posix.user', 'posix_user_password') + with self.assertRaises( + frappe.exceptions.ValidationError + ) as validation: # Fail if username string used + self.test_class.reset_password("posix.user", "posix_user_password") - self.assertTrue(str(validation.exception) == 'No LDAP User found for email: posix.user') + self.assertTrue(str(validation.exception) == "No LDAP User found for email: posix.user") try: - self.test_class.reset_password('posix.user1@unit.testing', 'posix_user_password') # Change Password + self.test_class.reset_password( + "posix.user1@unit.testing", "posix_user_password" + ) # Change Password - except Exception: # An exception from the tested class is ok, as long as the connection to LDAP was made writeable + except Exception: # An exception from the tested class is ok, as long as the connection to LDAP was made writeable pass connect_to_ldap.assert_called_with(self.base_dn, self.base_password, read_only=False) - @mock_ldap_connection def test_convert_ldap_entry_to_dict(self): self.connection.search( - search_base=self.ldap_user_path, - search_filter=self.TEST_LDAP_SEARCH_STRING.format("posix.user"), - attributes=self.test_class.get_ldap_attributes()) + search_base=self.ldap_user_path, + search_filter=self.TEST_LDAP_SEARCH_STRING.format("posix.user"), + attributes=self.test_class.get_ldap_attributes(), + ) test_ldap_entry = self.connection.entries[0] method_return = self.test_class.convert_ldap_entry_to_dict(test_ldap_entry) - self.assertTrue(type(method_return) is dict) # must be dict - self.assertTrue(len(method_return) == 6) # there are 6 fields in mock_ldap for use - + self.assertTrue(type(method_return) is dict) # must be dict + self.assertTrue(len(method_return) == 6) # there are 6 fields in mock_ldap for use class Test_OpenLDAP(LDAP_TestCase, unittest.TestCase): - TEST_LDAP_SERVER = 'OpenLDAP' - TEST_LDAP_SEARCH_STRING = '(uid={0})' + TEST_LDAP_SERVER = "OpenLDAP" + TEST_LDAP_SEARCH_STRING = "(uid={0})" DOCUMENT_GROUP_MAPPINGS = [ - { - "doctype": "LDAP Group Mapping", - "ldap_group": "Administrators", - "erpnext_role": "System Manager" - }, - { - "doctype": "LDAP Group Mapping", - "ldap_group": "Users", - "erpnext_role": "Blogger" - }, - { - "doctype": "LDAP Group Mapping", - "ldap_group": "Group3", - "erpnext_role": "Accounts User" - } + { + "doctype": "LDAP Group Mapping", + "ldap_group": "Administrators", + "erpnext_role": "System Manager", + }, + {"doctype": "LDAP Group Mapping", "ldap_group": "Users", "erpnext_role": "Blogger"}, + {"doctype": "LDAP Group Mapping", "ldap_group": "Group3", "erpnext_role": "Accounts User"}, ] - LDAP_USERNAME_FIELD = 'uid' + LDAP_USERNAME_FIELD = "uid" LDAP_SCHEMA = OFFLINE_SLAPD_2_4 - LDAP_LDIF_JSON = 'test_data_ldif_openldap.json' + LDAP_LDIF_JSON = "test_data_ldif_openldap.json" TEST_VALUES_LDAP_COMPLEX_SEARCH_STRING = [ - '(uid={0})', - '(&(objectclass=posixaccount)(uid={0}))', - '(&(description=*ACCESS:test1*)(uid={0}))', # OpenLDAP has no member of group, use description to filter posix.user has equivilent of AD 'memberOf' - '(&(objectclass=posixaccount)(description=*ACCESS:test3*)(uid={0}))' # OpenLDAP has no member of group, use description to filter posix.user doesn't have. equivilent of AD 'memberOf' + "(uid={0})", + "(&(objectclass=posixaccount)(uid={0}))", + "(&(description=*ACCESS:test1*)(uid={0}))", # OpenLDAP has no member of group, use description to filter posix.user has equivilent of AD 'memberOf' + "(&(objectclass=posixaccount)(description=*ACCESS:test3*)(uid={0}))", # OpenLDAP has no member of group, use description to filter posix.user doesn't have. equivilent of AD 'memberOf' ] class Test_ActiveDirectory(LDAP_TestCase, unittest.TestCase): - TEST_LDAP_SERVER = 'Active Directory' - TEST_LDAP_SEARCH_STRING = '(samaccountname={0})' + TEST_LDAP_SERVER = "Active Directory" + TEST_LDAP_SEARCH_STRING = "(samaccountname={0})" DOCUMENT_GROUP_MAPPINGS = [ - { - "doctype": "LDAP Group Mapping", - "ldap_group": "Domain Administrators", - "erpnext_role": "System Manager" - }, - { - "doctype": "LDAP Group Mapping", - "ldap_group": "Domain Users", - "erpnext_role": "Blogger" - }, - { - "doctype": "LDAP Group Mapping", - "ldap_group": "Enterprise Administrators", - "erpnext_role": "Accounts User" - } + { + "doctype": "LDAP Group Mapping", + "ldap_group": "Domain Administrators", + "erpnext_role": "System Manager", + }, + {"doctype": "LDAP Group Mapping", "ldap_group": "Domain Users", "erpnext_role": "Blogger"}, + { + "doctype": "LDAP Group Mapping", + "ldap_group": "Enterprise Administrators", + "erpnext_role": "Accounts User", + }, ] - LDAP_USERNAME_FIELD = 'samaccountname' + LDAP_USERNAME_FIELD = "samaccountname" LDAP_SCHEMA = OFFLINE_AD_2012_R2 - LDAP_LDIF_JSON = 'test_data_ldif_activedirectory.json' + LDAP_LDIF_JSON = "test_data_ldif_activedirectory.json" TEST_VALUES_LDAP_COMPLEX_SEARCH_STRING = [ - '(samaccountname={0})', - '(&(objectclass=user)(samaccountname={0}))', - '(&(description=*ACCESS:test1*)(samaccountname={0}))', # OpenLDAP has no member of group, use description to filter posix.user has equivilent of AD 'memberOf' - '(&(objectclass=user)(description=*ACCESS:test3*)(samaccountname={0}))' # OpenLDAP has no member of group, use description to filter posix.user doesn't have. equivilent of AD 'memberOf' + "(samaccountname={0})", + "(&(objectclass=user)(samaccountname={0}))", + "(&(description=*ACCESS:test1*)(samaccountname={0}))", # OpenLDAP has no member of group, use description to filter posix.user has equivilent of AD 'memberOf' + "(&(objectclass=user)(description=*ACCESS:test3*)(samaccountname={0}))", # OpenLDAP has no member of group, use description to filter posix.user doesn't have. equivilent of AD 'memberOf' ] - diff --git a/frappe/integrations/doctype/oauth_authorization_code/oauth_authorization_code.py b/frappe/integrations/doctype/oauth_authorization_code/oauth_authorization_code.py index 5a3f380e84..4ef6f65dc7 100644 --- a/frappe/integrations/doctype/oauth_authorization_code/oauth_authorization_code.py +++ b/frappe/integrations/doctype/oauth_authorization_code/oauth_authorization_code.py @@ -5,5 +5,6 @@ import frappe from frappe.model.document import Document + class OAuthAuthorizationCode(Document): pass diff --git a/frappe/integrations/doctype/oauth_authorization_code/test_oauth_authorization_code.py b/frappe/integrations/doctype/oauth_authorization_code/test_oauth_authorization_code.py index bc6d29cbdb..72cb789ebb 100644 --- a/frappe/integrations/doctype/oauth_authorization_code/test_oauth_authorization_code.py +++ b/frappe/integrations/doctype/oauth_authorization_code/test_oauth_authorization_code.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('OAuth Authorization Code') + class TestOAuthAuthorizationCode(unittest.TestCase): pass diff --git a/frappe/integrations/doctype/oauth_bearer_token/oauth_bearer_token.py b/frappe/integrations/doctype/oauth_bearer_token/oauth_bearer_token.py index ff6f96cc4d..515d3d2ba3 100644 --- a/frappe/integrations/doctype/oauth_bearer_token/oauth_bearer_token.py +++ b/frappe/integrations/doctype/oauth_bearer_token/oauth_bearer_token.py @@ -5,8 +5,10 @@ import frappe from frappe.model.document import Document + class OAuthBearerToken(Document): def validate(self): if not self.expiration_time: - self.expiration_time = frappe.utils.datetime.datetime.strptime(self.creation, "%Y-%m-%d %H:%M:%S.%f") + frappe.utils.datetime.timedelta(seconds=self.expires_in) - + self.expiration_time = frappe.utils.datetime.datetime.strptime( + self.creation, "%Y-%m-%d %H:%M:%S.%f" + ) + frappe.utils.datetime.timedelta(seconds=self.expires_in) diff --git a/frappe/integrations/doctype/oauth_bearer_token/test_oauth_bearer_token.py b/frappe/integrations/doctype/oauth_bearer_token/test_oauth_bearer_token.py index 965feb4f78..9dea8f482a 100644 --- a/frappe/integrations/doctype/oauth_bearer_token/test_oauth_bearer_token.py +++ b/frappe/integrations/doctype/oauth_bearer_token/test_oauth_bearer_token.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- # Copyright (c) 2015, Frappe Technologies and Contributors # License: MIT. See LICENSE -import frappe import unittest +import frappe + # test_records = frappe.get_test_records('OAuth Bearer Token') + class TestOAuthBearerToken(unittest.TestCase): pass diff --git a/frappe/integrations/doctype/oauth_client/oauth_client.py b/frappe/integrations/doctype/oauth_client/oauth_client.py index 42fba07ecb..09f6e3aced 100644 --- a/frappe/integrations/doctype/oauth_client/oauth_client.py +++ b/frappe/integrations/doctype/oauth_client/oauth_client.py @@ -6,13 +6,23 @@ import frappe from frappe import _ from frappe.model.document import Document + class OAuthClient(Document): def validate(self): self.client_id = self.name if not self.client_secret: self.client_secret = frappe.generate_hash(length=10) self.validate_grant_and_response() + def validate_grant_and_response(self): - if self.grant_type == "Authorization Code" and self.response_type != "Code" or \ - self.grant_type == "Implicit" and self.response_type != "Token": - frappe.throw(_("Combination of Grant Type ({0}) and Response Type ({1}) not allowed").format(self.grant_type, self.response_type))
+ if (
+ self.grant_type == "Authorization Code"
+ and self.response_type != "Code"
+ or self.grant_type == "Implicit"
+ and self.response_type != "Token"
+ ):
+ frappe.throw(
+ _(
+ "Combination of Grant Type ({0}) and Response Type ({1}) not allowed"
+ ).format(self.grant_type, self.response_type)
+ )
diff --git a/frappe/integrations/doctype/oauth_client/test_oauth_client.py b/frappe/integrations/doctype/oauth_client/test_oauth_client.py
index fa03fa06e7..dd1b25239a 100644
--- a/frappe/integrations/doctype/oauth_client/test_oauth_client.py
+++ b/frappe/integrations/doctype/oauth_client/test_oauth_client.py
@@ -1,10 +1,12 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2015, Frappe Technologies and Contributors
# License: MIT. See LICENSE
-import frappe
import unittest
+import frappe
+
# test_records = frappe.get_test_records('OAuth Client')
+
class TestOAuthClient(unittest.TestCase):
pass
diff --git a/frappe/integrations/doctype/oauth_provider_settings/oauth_provider_settings.py b/frappe/integrations/doctype/oauth_provider_settings/oauth_provider_settings.py
index ec1636659f..2aefd591a1 100644
--- a/frappe/integrations/doctype/oauth_provider_settings/oauth_provider_settings.py
+++ b/frappe/integrations/doctype/oauth_provider_settings/oauth_provider_settings.py
@@ -3,16 +3,20 @@
# License: MIT. See LICENSE
import frappe
-from frappe.model.document import Document
from frappe import _
+from frappe.model.document import Document
+
class OAuthProviderSettings(Document):
pass
+
def get_oauth_settings():
"""Returns oauth settings"""
- out = frappe._dict({
- "skip_authorization" : frappe.db.get_value("OAuth Provider Settings", None, "skip_authorization")
- })
+ out = frappe._dict(
+ {
+ "skip_authorization": frappe.db.get_value("OAuth Provider Settings", None, "skip_authorization")
+ }
+ )
- return out
\ No newline at end of file
+ return out
diff --git a/frappe/integrations/doctype/oauth_scope/oauth_scope.py b/frappe/integrations/doctype/oauth_scope/oauth_scope.py
index cf5fa1f341..a30d087cc0 100644
--- a/frappe/integrations/doctype/oauth_scope/oauth_scope.py
+++ b/frappe/integrations/doctype/oauth_scope/oauth_scope.py
@@ -5,5 +5,6 @@
# import frappe
from frappe.model.document import Document
+
class OAuthScope(Document):
pass
diff --git a/frappe/integrations/doctype/paypal_settings/paypal_settings.py b/frappe/integrations/doctype/paypal_settings/paypal_settings.py
index 30ac905792..ab7512f403 100644
--- a/frappe/integrations/doctype/paypal_settings/paypal_settings.py
+++ b/frappe/integrations/doctype/paypal_settings/paypal_settings.py
@@ -63,21 +63,48 @@ More Details:
"""
-import frappe
import json
+from urllib.parse import urlencode
+
import pytz
+
+import frappe
from frappe import _
-from urllib.parse import urlencode
+from frappe.integrations.utils import create_payment_gateway, create_request_log, make_post_request
from frappe.model.document import Document
-from frappe.integrations.utils import create_request_log, make_post_request, create_payment_gateway
-from frappe.utils import get_url, call_hook_method, cint, get_datetime
+from frappe.utils import call_hook_method, cint, get_datetime, get_url
+api_path = "/api/method/frappe.integrations.doctype.paypal_settings.paypal_settings"
-api_path = '/api/method/frappe.integrations.doctype.paypal_settings.paypal_settings'
class PayPalSettings(Document):
- supported_currencies = ["AUD", "BRL", "CAD", "CZK", "DKK", "EUR", "HKD", "HUF", "ILS", "JPY", "MYR", "MXN",
- "TWD", "NZD", "NOK", "PHP", "PLN", "GBP", "RUB", "SGD", "SEK", "CHF", "THB", "TRY", "USD"]
+ supported_currencies = [
+ "AUD",
+ "BRL",
+ "CAD",
+ "CZK",
+ "DKK",
+ "EUR",
+ "HKD",
+ "HUF",
+ "ILS",
+ "JPY",
+ "MYR",
+ "MXN",
+ "TWD",
+ "NZD",
+ "NOK",
+ "PHP",
+ "PLN",
+ "GBP",
+ "RUB",
+ "SGD",
+ "SEK",
+ "CHF",
+ "THB",
+ "TRY",
+ "USD",
+ ]
def __setup__(self):
setattr(self, "use_sandbox", 0)
@@ -88,7 +115,7 @@ class PayPalSettings(Document):
def validate(self):
create_payment_gateway("PayPal")
- call_hook_method('payment_gateway_enabled', gateway="PayPal")
+ call_hook_method("payment_gateway_enabled", gateway="PayPal")
if not self.flags.ignore_mandatory:
self.validate_paypal_credentails()
@@ -97,7 +124,11 @@ class PayPalSettings(Document):
def validate_transaction_currency(self, currency):
if currency not in self.supported_currencies:
- frappe.throw(_("Please select another payment method. PayPal does not support transactions in currency '{0}'").format(currency))
+ frappe.throw(
+ _(
+ "Please select another payment method. PayPal does not support transactions in currency '{0}'"
+ ).format(currency)
+ )
def get_paypal_params_and_url(self):
params = {
@@ -105,17 +136,23 @@ class PayPalSettings(Document):
"PWD": self.get_password(fieldname="api_password", raise_exception=False),
"SIGNATURE": self.signature,
"VERSION": "98",
- "METHOD": "GetPalDetails"
+ "METHOD": "GetPalDetails",
}
if hasattr(self, "use_sandbox") and self.use_sandbox:
- params.update({
- "USER": frappe.conf.sandbox_api_username,
- "PWD": frappe.conf.sandbox_api_password,
- "SIGNATURE": frappe.conf.sandbox_signature
- })
-
- api_url = "https://api-3t.sandbox.paypal.com/nvp" if (self.paypal_sandbox or self.use_sandbox) else "https://api-3t.paypal.com/nvp"
+ params.update(
+ {
+ "USER": frappe.conf.sandbox_api_username,
+ "PWD": frappe.conf.sandbox_api_password,
+ "SIGNATURE": frappe.conf.sandbox_signature,
+ }
+ )
+
+ api_url = (
+ "https://api-3t.sandbox.paypal.com/nvp"
+ if (self.paypal_sandbox or self.use_sandbox)
+ else "https://api-3t.paypal.com/nvp"
+ )
return params, api_url
@@ -142,27 +179,30 @@ class PayPalSettings(Document):
else:
return_url = "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token={0}"
- kwargs.update({
- "token": response.get("TOKEN")[0],
- "correlation_id": response.get("CORRELATIONID")[0]
- })
- self.integration_request = create_request_log(kwargs, "Remote", "PayPal", response.get("TOKEN")[0])
+ kwargs.update(
+ {"token": response.get("TOKEN")[0], "correlation_id": response.get("CORRELATIONID")[0]}
+ )
+ self.integration_request = create_request_log(
+ kwargs, "Remote", "PayPal", response.get("TOKEN")[0]
+ )
return return_url.format(kwargs["token"])
def execute_set_express_checkout(self, **kwargs):
params, url = self.get_paypal_params_and_url()
- params.update({
- "METHOD": "SetExpressCheckout",
- "returnUrl": get_url("{0}.get_express_checkout_details".format(api_path)),
- "cancelUrl": get_url("/payment-cancel"),
- "PAYMENTREQUEST_0_PAYMENTACTION": "SALE",
- "PAYMENTREQUEST_0_AMT": kwargs['amount'],
- "PAYMENTREQUEST_0_CURRENCYCODE": kwargs['currency'].upper()
- })
-
- if kwargs.get('subscription_details'):
+ params.update(
+ {
+ "METHOD": "SetExpressCheckout",
+ "returnUrl": get_url("{0}.get_express_checkout_details".format(api_path)),
+ "cancelUrl": get_url("/payment-cancel"),
+ "PAYMENTREQUEST_0_PAYMENTACTION": "SALE",
+ "PAYMENTREQUEST_0_AMT": kwargs["amount"],
+ "PAYMENTREQUEST_0_CURRENCYCODE": kwargs["currency"].upper(),
+ }
+ )
+
+ if kwargs.get("subscription_details"):
self.configure_recurring_payments(params, kwargs)
params = urlencode(params)
@@ -175,14 +215,20 @@ class PayPalSettings(Document):
def configure_recurring_payments(self, params, kwargs):
# removing the params as we have to setup rucurring payments
- for param in ('PAYMENTREQUEST_0_PAYMENTACTION', 'PAYMENTREQUEST_0_AMT',
- 'PAYMENTREQUEST_0_CURRENCYCODE'):
+ for param in (
+ "PAYMENTREQUEST_0_PAYMENTACTION",
+ "PAYMENTREQUEST_0_AMT",
+ "PAYMENTREQUEST_0_CURRENCYCODE",
+ ):
del params[param]
- params.update({
- "L_BILLINGTYPE0": "RecurringPayments", #The type of billing agreement
- "L_BILLINGAGREEMENTDESCRIPTION0": kwargs['description']
- })
+ params.update(
+ {
+ "L_BILLINGTYPE0": "RecurringPayments", # The type of billing agreement
+ "L_BILLINGAGREEMENTDESCRIPTION0": kwargs["description"],
+ }
+ )
+
def get_paypal_and_transaction_details(token):
doc = frappe.get_doc("PayPal Settings")
@@ -194,23 +240,25 @@ def get_paypal_and_transaction_details(token):
return data, params, url
+
def setup_redirect(data, redirect_url, custom_redirect_to=None, redirect=True):
- redirect_to = data.get('redirect_to') or None
- redirect_message = data.get('redirect_message') or None
+ redirect_to = data.get("redirect_to") or None
+ redirect_message = data.get("redirect_message") or None
if custom_redirect_to:
redirect_to = custom_redirect_to
if redirect_to:
- redirect_url += '&' + urlencode({'redirect_to': redirect_to})
+ redirect_url += "&" + urlencode({"redirect_to": redirect_to})
if redirect_message:
- redirect_url += '&' + urlencode({'redirect_message': redirect_message})
+ redirect_url += "&" + urlencode({"redirect_message": redirect_message})
# this is done so that functions called via hooks can update flags.redirect_to
if redirect:
frappe.local.response["type"] = "redirect"
frappe.local.response["location"] = get_url(redirect_url)
+
@frappe.whitelist(allow_guest=True, xss_safe=True)
def get_express_checkout_details(token):
try:
@@ -218,26 +266,29 @@ def get_express_checkout_details(token):
doc.setup_sandbox_env(token)
params, url = doc.get_paypal_params_and_url()
- params.update({
- "METHOD": "GetExpressCheckoutDetails",
- "TOKEN": token
- })
+ params.update({"METHOD": "GetExpressCheckoutDetails", "TOKEN": token})
response = make_post_request(url, data=params)
if response.get("ACK")[0] != "Success":
- frappe.respond_as_web_page(_("Something went wrong"),
- _("Looks like something went wrong during the transaction. Since we haven't confirmed the payment, Paypal will automatically refund you this amount. If it doesn't, please send us an email and mention the Correlation ID: {0}.").format(response.get("CORRELATIONID", [None])[0]),
- indicator_color='red',
- http_status_code=frappe.ValidationError.http_status_code)
+ frappe.respond_as_web_page(
+ _("Something went wrong"),
+ _(
+ "Looks like something went wrong during the transaction. Since we haven't confirmed the payment, Paypal will automatically refund you this amount. If it doesn't, please send us an email and mention the Correlation ID: {0}."
+ ).format(response.get("CORRELATIONID", [None])[0]),
+ indicator_color="red",
+ http_status_code=frappe.ValidationError.http_status_code,
+ )
return
doc = frappe.get_doc("Integration Request", token)
- update_integration_request_status(token, {
- "payerid": response.get("PAYERID")[0],
- "payer_email": response.get("EMAIL")[0]
- }, "Authorized", doc=doc)
+ update_integration_request_status(
+ token,
+ {"payerid": response.get("PAYERID")[0], "payer_email": response.get("EMAIL")[0]},
+ "Authorized",
+ doc=doc,
+ )
frappe.local.response["type"] = "redirect"
frappe.local.response["location"] = get_redirect_uri(doc, token, response.get("PAYERID")[0])
@@ -245,35 +296,45 @@ def get_express_checkout_details(token):
except Exception:
frappe.log_error(frappe.get_traceback())
+
@frappe.whitelist(allow_guest=True, xss_safe=True)
def confirm_payment(token):
try:
custom_redirect_to = None
data, params, url = get_paypal_and_transaction_details(token)
- params.update({
- "METHOD": "DoExpressCheckoutPayment",
- "PAYERID": data.get("payerid"),
- "TOKEN": token,
- "PAYMENTREQUEST_0_PAYMENTACTION": "SALE",
- "PAYMENTREQUEST_0_AMT": data.get("amount"),
- "PAYMENTREQUEST_0_CURRENCYCODE": data.get("currency").upper()
- })
+ params.update(
+ {
+ "METHOD": "DoExpressCheckoutPayment",
+ "PAYERID": data.get("payerid"),
+ "TOKEN": token,
+ "PAYMENTREQUEST_0_PAYMENTACTION": "SALE",
+ "PAYMENTREQUEST_0_AMT": data.get("amount"),
+ "PAYMENTREQUEST_0_CURRENCYCODE": data.get("currency").upper(),
+ }
+ )
response = make_post_request(url, data=params)
if response.get("ACK")[0] == "Success":
- update_integration_request_status(token, {
- "transaction_id": response.get("PAYMENTINFO_0_TRANSACTIONID")[0],
- "correlation_id": response.get("CORRELATIONID")[0]
- }, "Completed")
+ update_integration_request_status(
+ token,
+ {
+ "transaction_id": response.get("PAYMENTINFO_0_TRANSACTIONID")[0],
+ "correlation_id": response.get("CORRELATIONID")[0],
+ },
+ "Completed",
+ )
if data.get("reference_doctype") and data.get("reference_docname"):
- custom_redirect_to = frappe.get_doc(data.get("reference_doctype"),
- data.get("reference_docname")).run_method("on_payment_authorized", "Completed")
+ custom_redirect_to = frappe.get_doc(
+ data.get("reference_doctype"), data.get("reference_docname")
+ ).run_method("on_payment_authorized", "Completed")
frappe.db.commit()
- redirect_url = '/integrations/payment-success?doctype={0}&docname={1}'.format(data.get("reference_doctype"), data.get("reference_docname"))
+ redirect_url = "/integrations/payment-success?doctype={0}&docname={1}".format(
+ data.get("reference_doctype"), data.get("reference_docname")
+ )
else:
redirect_url = "/integrations/payment-failed"
@@ -282,6 +343,7 @@ def confirm_payment(token):
except Exception:
frappe.log_error(frappe.get_traceback())
+
@frappe.whitelist(allow_guest=True, xss_safe=True)
def create_recurring_profile(token, payerid):
try:
@@ -292,49 +354,60 @@ def create_recurring_profile(token, payerid):
addons = data.get("addons")
subscription_details = data.get("subscription_details")
- if data.get('subscription_id'):
+ if data.get("subscription_id"):
if addons:
updating = True
- manage_recurring_payment_profile_status(data['subscription_id'], 'Cancel', params, url)
-
- params.update({
- "METHOD": "CreateRecurringPaymentsProfile",
- "PAYERID": payerid,
- "TOKEN": token,
- "DESC": data.get("description"),
- "BILLINGPERIOD": subscription_details.get("billing_period"),
- "BILLINGFREQUENCY": subscription_details.get("billing_frequency"),
- "AMT": data.get("amount") if data.get("subscription_amount") == data.get("amount") else data.get("subscription_amount"),
- "CURRENCYCODE": data.get("currency").upper(),
- "INITAMT": data.get("upfront_amount")
- })
-
- status_changed_to = 'Completed' if data.get("starting_immediately") or updating else 'Verified'
+ manage_recurring_payment_profile_status(data["subscription_id"], "Cancel", params, url)
+
+ params.update(
+ {
+ "METHOD": "CreateRecurringPaymentsProfile",
+ "PAYERID": payerid,
+ "TOKEN": token,
+ "DESC": data.get("description"),
+ "BILLINGPERIOD": subscription_details.get("billing_period"),
+ "BILLINGFREQUENCY": subscription_details.get("billing_frequency"),
+ "AMT": data.get("amount")
+ if data.get("subscription_amount") == data.get("amount")
+ else data.get("subscription_amount"),
+ "CURRENCYCODE": data.get("currency").upper(),
+ "INITAMT": data.get("upfront_amount"),
+ }
+ )
+
+ status_changed_to = "Completed" if data.get("starting_immediately") or updating else "Verified"
starts_at = get_datetime(subscription_details.get("start_date")) or frappe.utils.now_datetime()
- starts_at = starts_at.replace(tzinfo=pytz.timezone(frappe.utils.get_time_zone())).astimezone(pytz.utc)
+ starts_at = starts_at.replace(tzinfo=pytz.timezone(frappe.utils.get_time_zone())).astimezone(
+ pytz.utc
+ )
- #"PROFILESTARTDATE": datetime.utcfromtimestamp(get_timestamp(starts_at)).isoformat()
- params.update({
- "PROFILESTARTDATE": starts_at.isoformat()
- })
+ # "PROFILESTARTDATE": datetime.utcfromtimestamp(get_timestamp(starts_at)).isoformat()
+ params.update({"PROFILESTARTDATE": starts_at.isoformat()})
response = make_post_request(url, data=params)
if response.get("ACK")[0] == "Success":
- update_integration_request_status(token, {
- "profile_id": response.get("PROFILEID")[0],
- }, "Completed")
+ update_integration_request_status(
+ token,
+ {
+ "profile_id": response.get("PROFILEID")[0],
+ },
+ "Completed",
+ )
if data.get("reference_doctype") and data.get("reference_docname"):
- data['subscription_id'] = response.get("PROFILEID")[0]
+ data["subscription_id"] = response.get("PROFILEID")[0]
frappe.flags.data = data
- custom_redirect_to = frappe.get_doc(data.get("reference_doctype"),
- data.get("reference_docname")).run_method("on_payment_authorized", status_changed_to)
+ custom_redirect_to = frappe.get_doc(
+ data.get("reference_doctype"), data.get("reference_docname")
+ ).run_method("on_payment_authorized", status_changed_to)
frappe.db.commit()
- redirect_url = '/integrations/payment-success?doctype={0}&docname={1}'.format(data.get("reference_doctype"), data.get("reference_docname"))
+ redirect_url = "/integrations/payment-success?doctype={0}&docname={1}".format(
+ data.get("reference_doctype"), data.get("reference_docname")
+ )
else:
redirect_url = "/integrations/payment-failed"
@@ -343,26 +416,29 @@ def create_recurring_profile(token, payerid):
except Exception:
frappe.log_error(frappe.get_traceback())
+
def update_integration_request_status(token, data, status, error=False, doc=None):
if not doc:
doc = frappe.get_doc("Integration Request", token)
doc.update_status(data, status)
+
def get_redirect_uri(doc, token, payerid):
data = json.loads(doc.data)
if data.get("subscription_details") or data.get("subscription_id"):
- return get_url("{0}.create_recurring_profile?token={1}&payerid={2}".format(api_path, token, payerid))
+ return get_url(
+ "{0}.create_recurring_profile?token={1}&payerid={2}".format(api_path, token, payerid)
+ )
else:
return get_url("{0}.confirm_payment?token={1}".format(api_path, token))
+
def manage_recurring_payment_profile_status(profile_id, action, args, url):
- args.update({
- "METHOD": "ManageRecurringPaymentsProfileStatus",
- "PROFILEID": profile_id,
- "ACTION": action
- })
+ args.update(
+ {"METHOD": "ManageRecurringPaymentsProfileStatus", "PROFILEID": profile_id, "ACTION": action}
+ )
response = make_post_request(url, data=args)
@@ -370,9 +446,10 @@ def manage_recurring_payment_profile_status(profile_id, action, args, url):
# thus could not cancel the subscription.
# thus raise an exception only if the error code is not equal to 11556
- if response.get("ACK")[0] != "Success" and response.get("L_ERRORCODE0", [])[0] != '11556':
+ if response.get("ACK")[0] != "Success" and response.get("L_ERRORCODE0", [])[0] != "11556":
frappe.throw(_("Failed while amending subscription"))
+
@frappe.whitelist(allow_guest=True)
def ipn_handler():
try:
@@ -380,26 +457,32 @@ def ipn_handler():
validate_ipn_request(data)
- data.update({
- "payment_gateway": "PayPal"
- })
+ data.update({"payment_gateway": "PayPal"})
- doc = frappe.get_doc({
- "data": json.dumps(frappe.local.form_dict),
- "doctype": "Integration Request",
- "integration_type": "Subscription Notification",
- "status": "Queued"
- }).insert(ignore_permissions=True)
+ doc = frappe.get_doc(
+ {
+ "data": json.dumps(frappe.local.form_dict),
+ "doctype": "Integration Request",
+ "integration_type": "Subscription Notification",
+ "status": "Queued",
+ }
+ ).insert(ignore_permissions=True)
frappe.db.commit()
- frappe.enqueue(method='frappe.integrations.doctype.paypal_settings.paypal_settings.handle_subscription_notification',
- queue='long', timeout=600, is_async=True, **{"doctype": "Integration Request", "docname": doc.name})
+ frappe.enqueue(
+ method="frappe.integrations.doctype.paypal_settings.paypal_settings.handle_subscription_notification",
+ queue="long",
+ timeout=600,
+ is_async=True,
+ **{"doctype": "Integration Request", "docname": doc.name}
+ )
except frappe.InvalidStatusError:
pass
except Exception as e:
frappe.log(frappe.log_error(title=e))
+
def validate_ipn_request(data):
def _throw():
frappe.throw(_("In Valid Request"), exc=frappe.InvalidStatusError)
@@ -410,16 +493,16 @@ def validate_ipn_request(data):
doc = frappe.get_doc("PayPal Settings")
params, url = doc.get_paypal_params_and_url()
- params.update({
- "METHOD": "GetRecurringPaymentsProfileDetails",
- "PROFILEID": data.get("recurring_payment_id")
- })
+ params.update(
+ {"METHOD": "GetRecurringPaymentsProfileDetails", "PROFILEID": data.get("recurring_payment_id")}
+ )
params = urlencode(params)
res = make_post_request(url=url, data=params.encode("utf-8"))
- if res['ACK'][0] != 'Success':
+ if res["ACK"][0] != "Success":
_throw()
+
def handle_subscription_notification(doctype, docname):
call_hook_method("handle_subscription_notification", doctype=doctype, docname=docname)
diff --git a/frappe/integrations/doctype/paytm_settings/paytm_settings.py b/frappe/integrations/doctype/paytm_settings/paytm_settings.py
index 5255360242..0888fd35b7 100644
--- a/frappe/integrations/doctype/paytm_settings/paytm_settings.py
+++ b/frappe/integrations/doctype/paytm_settings/paytm_settings.py
@@ -3,112 +3,131 @@
# License: MIT. See LICENSE
import json
-import requests
from urllib.parse import urlencode
+import requests
+from paytmchecksum import generateSignature, verifySignature
+
import frappe
-from frappe.model.document import Document
from frappe import _
-from frappe.utils import get_url, call_hook_method, cint, flt, cstr
-from frappe.integrations.utils import create_request_log, create_payment_gateway
-from frappe.utils import get_request_site_address
-from paytmchecksum import generateSignature, verifySignature
+from frappe.integrations.utils import create_payment_gateway, create_request_log
+from frappe.model.document import Document
+from frappe.utils import call_hook_method, cint, cstr, flt, get_request_site_address, get_url
from frappe.utils.password import get_decrypted_password
+
class PaytmSettings(Document):
supported_currencies = ["INR"]
def validate(self):
- create_payment_gateway('Paytm')
- call_hook_method('payment_gateway_enabled', gateway='Paytm')
+ create_payment_gateway("Paytm")
+ call_hook_method("payment_gateway_enabled", gateway="Paytm")
def validate_transaction_currency(self, currency):
if currency not in self.supported_currencies:
- frappe.throw(_("Please select another payment method. Paytm does not support transactions in currency '{0}'").format(currency))
+ frappe.throw(
+ _(
+ "Please select another payment method. Paytm does not support transactions in currency '{0}'"
+ ).format(currency)
+ )
def get_payment_url(self, **kwargs):
- '''Return payment url with several params'''
+ """Return payment url with several params"""
# create unique order id by making it equal to the integration request
integration_request = create_request_log(kwargs, "Host", "Paytm")
kwargs.update(dict(order_id=integration_request.name))
return get_url("./integrations/paytm_checkout?{0}".format(urlencode(kwargs)))
+
def get_paytm_config():
- ''' Returns paytm config '''
+ """Returns paytm config"""
- paytm_config = frappe.db.get_singles_dict('Paytm Settings')
- paytm_config.update(dict(merchant_key=get_decrypted_password('Paytm Settings', 'Paytm Settings', 'merchant_key')))
+ paytm_config = frappe.db.get_singles_dict("Paytm Settings")
+ paytm_config.update(
+ dict(merchant_key=get_decrypted_password("Paytm Settings", "Paytm Settings", "merchant_key"))
+ )
if cint(paytm_config.staging):
- paytm_config.update(dict(
- website="WEBSTAGING",
- url='https://securegw-stage.paytm.in/order/process',
- transaction_status_url='https://securegw-stage.paytm.in/order/status',
- industry_type_id='RETAIL'
- ))
+ paytm_config.update(
+ dict(
+ website="WEBSTAGING",
+ url="https://securegw-stage.paytm.in/order/process",
+ transaction_status_url="https://securegw-stage.paytm.in/order/status",
+ industry_type_id="RETAIL",
+ )
+ )
else:
- paytm_config.update(dict(
- url='https://securegw.paytm.in/order/process',
- transaction_status_url='https://securegw.paytm.in/order/status',
- ))
+ paytm_config.update(
+ dict(
+ url="https://securegw.paytm.in/order/process",
+ transaction_status_url="https://securegw.paytm.in/order/status",
+ )
+ )
return paytm_config
+
def get_paytm_params(payment_details, order_id, paytm_config):
# initialize a dictionary
paytm_params = dict()
- redirect_uri = get_request_site_address(True) + "/api/method/frappe.integrations.doctype.paytm_settings.paytm_settings.verify_transaction"
-
+ redirect_uri = (
+ get_request_site_address(True)
+ + "/api/method/frappe.integrations.doctype.paytm_settings.paytm_settings.verify_transaction"
+ )
- paytm_params.update({
- "MID" : paytm_config.merchant_id,
- "WEBSITE" : paytm_config.website,
- "INDUSTRY_TYPE_ID" : paytm_config.industry_type_id,
- "CHANNEL_ID" : "WEB",
- "ORDER_ID" : order_id,
- "CUST_ID" : payment_details['payer_email'],
- "EMAIL" : payment_details['payer_email'],
- "TXN_AMOUNT" : cstr(flt(payment_details['amount'], 2)),
- "CALLBACK_URL" : redirect_uri,
- })
+ paytm_params.update(
+ {
+ "MID": paytm_config.merchant_id,
+ "WEBSITE": paytm_config.website,
+ "INDUSTRY_TYPE_ID": paytm_config.industry_type_id,
+ "CHANNEL_ID": "WEB",
+ "ORDER_ID": order_id,
+ "CUST_ID": payment_details["payer_email"],
+ "EMAIL": payment_details["payer_email"],
+ "TXN_AMOUNT": cstr(flt(payment_details["amount"], 2)),
+ "CALLBACK_URL": redirect_uri,
+ }
+ )
checksum = generateSignature(paytm_params, paytm_config.merchant_key)
- paytm_params.update({
- "CHECKSUMHASH" : checksum
- })
+ paytm_params.update({"CHECKSUMHASH": checksum})
return paytm_params
+
@frappe.whitelist(allow_guest=True)
def verify_transaction(**paytm_params):
- '''Verify checksum for received data in the callback and then verify the transaction'''
+ """Verify checksum for received data in the callback and then verify the transaction"""
paytm_config = get_paytm_config()
is_valid_checksum = False
- paytm_params.pop('cmd', None)
- paytm_checksum = paytm_params.pop('CHECKSUMHASH', None)
+ paytm_params.pop("cmd", None)
+ paytm_checksum = paytm_params.pop("CHECKSUMHASH", None)
if paytm_params and paytm_config and paytm_checksum:
# Verify checksum
is_valid_checksum = verifySignature(paytm_params, paytm_config.merchant_key, paytm_checksum)
- if is_valid_checksum and paytm_params.get('RESPCODE') == '01':
- verify_transaction_status(paytm_config, paytm_params['ORDERID'])
+ if is_valid_checksum and paytm_params.get("RESPCODE") == "01":
+ verify_transaction_status(paytm_config, paytm_params["ORDERID"])
else:
- frappe.respond_as_web_page("Payment Failed",
+ frappe.respond_as_web_page(
+ "Payment Failed",
"Transaction failed to complete. In case of any deductions, deducted amount will get refunded to your account.",
- http_status_code=401, indicator_color='red')
- frappe.log_error("Order unsuccessful. Failed Response:"+cstr(paytm_params), 'Paytm Payment Failed')
+ http_status_code=401,
+ indicator_color="red",
+ )
+ frappe.log_error(
+ "Order unsuccessful. Failed Response:" + cstr(paytm_params), "Paytm Payment Failed"
+ )
+
def verify_transaction_status(paytm_config, order_id):
- '''Verify transaction completion after checksum has been verified'''
- paytm_params=dict(
- MID=paytm_config.merchant_id,
- ORDERID= order_id
- )
+ """Verify transaction completion after checksum has been verified"""
+ paytm_params = dict(MID=paytm_config.merchant_id, ORDERID=order_id)
checksum = generateSignature(paytm_params, paytm_config.merchant_key)
paytm_params["CHECKSUMHASH"] = checksum
@@ -116,43 +135,48 @@ def verify_transaction_status(paytm_config, order_id):
post_data = json.dumps(paytm_params)
url = paytm_config.transaction_status_url
- response = requests.post(url, data = post_data, headers = {"Content-type": "application/json"}).json()
+ response = requests.post(url, data=post_data, headers={"Content-type": "application/json"}).json()
finalize_request(order_id, response)
+
def finalize_request(order_id, transaction_response):
- request = frappe.get_doc('Integration Request', order_id)
+ request = frappe.get_doc("Integration Request", order_id)
transaction_data = frappe._dict(json.loads(request.data))
- redirect_to = transaction_data.get('redirect_to') or None
- redirect_message = transaction_data.get('redirect_message') or None
+ redirect_to = transaction_data.get("redirect_to") or None
+ redirect_message = transaction_data.get("redirect_message") or None
- if transaction_response['STATUS'] == "TXN_SUCCESS":
+ if transaction_response["STATUS"] == "TXN_SUCCESS":
if transaction_data.reference_doctype and transaction_data.reference_docname:
custom_redirect_to = None
try:
- custom_redirect_to = frappe.get_doc(transaction_data.reference_doctype,
- transaction_data.reference_docname).run_method("on_payment_authorized", 'Completed')
- request.db_set('status', 'Completed')
+ custom_redirect_to = frappe.get_doc(
+ transaction_data.reference_doctype, transaction_data.reference_docname
+ ).run_method("on_payment_authorized", "Completed")
+ request.db_set("status", "Completed")
except Exception:
- request.db_set('status', 'Failed')
+ request.db_set("status", "Failed")
frappe.log_error(frappe.get_traceback())
if custom_redirect_to:
redirect_to = custom_redirect_to
- redirect_url = '/integrations/payment-success'
+ redirect_url = "/integrations/payment-success"
else:
- request.db_set('status', 'Failed')
- redirect_url = '/integrations/payment-failed'
+ request.db_set("status", "Failed")
+ redirect_url = "/integrations/payment-failed"
if redirect_to:
- redirect_url += '?' + urlencode({'redirect_to': redirect_to})
+ redirect_url += "?" + urlencode({"redirect_to": redirect_to})
if redirect_message:
- redirect_url += '&' + urlencode({'redirect_message': redirect_message})
+ redirect_url += "&" + urlencode({"redirect_message": redirect_message})
+
+ frappe.local.response["type"] = "redirect"
+ frappe.local.response["location"] = redirect_url
- frappe.local.response['type'] = 'redirect'
- frappe.local.response['location'] = redirect_url
def get_gateway_controller(doctype, docname):
reference_doc = frappe.get_doc(doctype, docname)
- gateway_controller = frappe.db.get_value("Payment Gateway", reference_doc.payment_gateway, "gateway_controller")
- return gateway_controller
\ No newline at end of file
+ gateway_controller = frappe.db.get_value(
+ "Payment Gateway", reference_doc.payment_gateway, "gateway_controller"
+ )
+ return gateway_controller
diff --git a/frappe/integrations/doctype/paytm_settings/test_paytm_settings.py b/frappe/integrations/doctype/paytm_settings/test_paytm_settings.py
index 425fc87a3f..d9e72e344c 100644
--- a/frappe/integrations/doctype/paytm_settings/test_paytm_settings.py
+++ b/frappe/integrations/doctype/paytm_settings/test_paytm_settings.py
@@ -4,5 +4,6 @@
# import frappe
import unittest
+
class TestPaytmSettings(unittest.TestCase):
pass
diff --git a/frappe/integrations/doctype/query_parameters/query_parameters.py b/frappe/integrations/doctype/query_parameters/query_parameters.py
index 68e97e9071..09f039a764 100644
--- a/frappe/integrations/doctype/query_parameters/query_parameters.py
+++ b/frappe/integrations/doctype/query_parameters/query_parameters.py
@@ -5,5 +5,6 @@
# import frappe
from frappe.model.document import Document
+
class QueryParameters(Document):
pass
diff --git a/frappe/integrations/doctype/razorpay_settings/razorpay_settings.py b/frappe/integrations/doctype/razorpay_settings/razorpay_settings.py
index 9bbab9db9b..c4ffb74325 100644
--- a/frappe/integrations/doctype/razorpay_settings/razorpay_settings.py
+++ b/frappe/integrations/doctype/razorpay_settings/razorpay_settings.py
@@ -60,17 +60,24 @@ For razorpay payment status is Authorized
"""
-import frappe
-from frappe import _
-import json
-import hmac
-import razorpay
import hashlib
+import hmac
+import json
from urllib.parse import urlencode
+
+import razorpay
+
+import frappe
+from frappe import _
+from frappe.integrations.utils import (
+ create_payment_gateway,
+ create_request_log,
+ make_get_request,
+ make_post_request,
+)
from frappe.model.document import Document
-from frappe.utils import get_url, call_hook_method, cint, get_timestamp
-from frappe.integrations.utils import (make_get_request, make_post_request, create_request_log,
- create_payment_gateway)
+from frappe.utils import call_hook_method, cint, get_timestamp, get_url
+
class RazorpaySettings(Document):
supported_currencies = ["INR"]
@@ -81,37 +88,45 @@ class RazorpaySettings(Document):
self.client = razorpay.Client(auth=(self.api_key, secret))
def validate(self):
- create_payment_gateway('Razorpay')
- call_hook_method('payment_gateway_enabled', gateway='Razorpay')
+ create_payment_gateway("Razorpay")
+ call_hook_method("payment_gateway_enabled", gateway="Razorpay")
if not self.flags.ignore_mandatory:
self.validate_razorpay_credentails()
def validate_razorpay_credentails(self):
if self.api_key and self.api_secret:
try:
- make_get_request(url="https://api.razorpay.com/v1/payments",
- auth=(self.api_key, self.get_password(fieldname="api_secret", raise_exception=False)))
+ make_get_request(
+ url="https://api.razorpay.com/v1/payments",
+ auth=(self.api_key, self.get_password(fieldname="api_secret", raise_exception=False)),
+ )
except Exception:
frappe.throw(_("Seems API Key or API Secret is wrong !!!"))
def validate_transaction_currency(self, currency):
if currency not in self.supported_currencies:
- frappe.throw(_("Please select another payment method. Razorpay does not support transactions in currency '{0}'").format(currency))
+ frappe.throw(
+ _(
+ "Please select another payment method. Razorpay does not support transactions in currency '{0}'"
+ ).format(currency)
+ )
def setup_addon(self, settings, **kwargs):
"""
- Addon template:
- {
- "item": {
- "name": row.upgrade_type,
- "amount": row.amount,
- "currency": currency,
- "description": "add-on description"
- },
- "quantity": 1 (The total amount is calculated as item.amount * quantity)
- }
+ Addon template:
+ {
+ "item": {
+ "name": row.upgrade_type,
+ "amount": row.amount,
+ "currency": currency,
+ "description": "add-on description"
+ },
+ "quantity": 1 (The total amount is calculated as item.amount * quantity)
+ }
"""
- url = "https://api.razorpay.com/v1/subscriptions/{0}/addons".format(kwargs.get('subscription_id'))
+ url = "https://api.razorpay.com/v1/subscriptions/{0}/addons".format(
+ kwargs.get("subscription_id")
+ )
try:
if not frappe.conf.converted_rupee_to_paisa:
@@ -122,52 +137,49 @@ class RazorpaySettings(Document):
url,
auth=(settings.api_key, settings.api_secret),
data=json.dumps(addon),
- headers={
- "content-type": "application/json"
- }
+ headers={"content-type": "application/json"},
)
- if not resp.get('id'):
- frappe.log_error(str(resp), 'Razorpay Failed while creating subscription')
+ if not resp.get("id"):
+ frappe.log_error(str(resp), "Razorpay Failed while creating subscription")
except:
frappe.log_error(frappe.get_traceback())
# failed
pass
def setup_subscription(self, settings, **kwargs):
- start_date = get_timestamp(kwargs.get('subscription_details').get("start_date")) \
- if kwargs.get('subscription_details').get("start_date") else None
+ start_date = (
+ get_timestamp(kwargs.get("subscription_details").get("start_date"))
+ if kwargs.get("subscription_details").get("start_date")
+ else None
+ )
subscription_details = {
- "plan_id": kwargs.get('subscription_details').get("plan_id"),
- "total_count": kwargs.get('subscription_details').get("billing_frequency"),
- "customer_notify": kwargs.get('subscription_details').get("customer_notify")
+ "plan_id": kwargs.get("subscription_details").get("plan_id"),
+ "total_count": kwargs.get("subscription_details").get("billing_frequency"),
+ "customer_notify": kwargs.get("subscription_details").get("customer_notify"),
}
if start_date:
- subscription_details['start_at'] = cint(start_date)
+ subscription_details["start_at"] = cint(start_date)
- if kwargs.get('addons'):
+ if kwargs.get("addons"):
convert_rupee_to_paisa(**kwargs)
- subscription_details.update({
- "addons": kwargs.get('addons')
- })
+ subscription_details.update({"addons": kwargs.get("addons")})
try:
resp = make_post_request(
"https://api.razorpay.com/v1/subscriptions",
auth=(settings.api_key, settings.api_secret),
data=json.dumps(subscription_details),
- headers={
- "content-type": "application/json"
- }
+ headers={"content-type": "application/json"},
)
- if resp.get('status') == 'created':
- kwargs['subscription_id'] = resp.get('id')
- frappe.flags.status = 'created'
+ if resp.get("status") == "created":
+ kwargs["subscription_id"] = resp.get("id")
+ frappe.flags.status = "created"
return kwargs
else:
- frappe.log_error(str(resp), 'Razorpay Failed while creating subscription')
+ frappe.log_error(str(resp), "Razorpay Failed while creating subscription")
except:
frappe.log_error(frappe.get_traceback())
@@ -178,8 +190,8 @@ class RazorpaySettings(Document):
if not kwargs.get("subscription_id"):
kwargs = self.setup_subscription(settings, **kwargs)
- if frappe.flags.status !='created':
- kwargs['subscription_id'] = None
+ if frappe.flags.status != "created":
+ kwargs["subscription_id"] = None
return kwargs
@@ -191,25 +203,27 @@ class RazorpaySettings(Document):
# Creating Orders https://razorpay.com/docs/api/orders/
# convert rupees to paisa
- kwargs['amount'] *= 100
+ kwargs["amount"] *= 100
# Create integration log
integration_request = create_request_log(kwargs, "Host", "Razorpay")
# Setup payment options
payment_options = {
- "amount": kwargs.get('amount'),
- "currency": kwargs.get('currency', 'INR'),
- "receipt": kwargs.get('receipt'),
- "payment_capture": kwargs.get('payment_capture')
+ "amount": kwargs.get("amount"),
+ "currency": kwargs.get("currency", "INR"),
+ "receipt": kwargs.get("receipt"),
+ "payment_capture": kwargs.get("payment_capture"),
}
if self.api_key and self.api_secret:
try:
- order = make_post_request("https://api.razorpay.com/v1/orders",
+ order = make_post_request(
+ "https://api.razorpay.com/v1/orders",
auth=(self.api_key, self.get_password(fieldname="api_secret", raise_exception=False)),
- data=payment_options)
- order['integration_request'] = integration_request.name
- return order # Order returned to be consumed by razorpay.js
+ data=payment_options,
+ )
+ order["integration_request"] = integration_request.name
+ return order # Order returned to be consumed by razorpay.js
except Exception:
frappe.log(frappe.get_traceback())
frappe.throw(_("Could not create razorpay order"))
@@ -219,14 +233,19 @@ class RazorpaySettings(Document):
try:
self.integration_request = frappe.get_doc("Integration Request", self.data.token)
- self.integration_request.update_status(self.data, 'Queued')
+ self.integration_request.update_status(self.data, "Queued")
return self.authorize_payment()
except Exception:
frappe.log_error(frappe.get_traceback())
- return{
- "redirect_to": frappe.redirect_to_message(_('Server Error'), _("Seems issue with server's razorpay config. Don't worry, in case of failure amount will get refunded to your account.")),
- "status": 401
+ return {
+ "redirect_to": frappe.redirect_to_message(
+ _("Server Error"),
+ _(
+ "Seems issue with server's razorpay config. Don't worry, in case of failure amount will get refunded to your account."
+ ),
+ ),
+ "status": 401,
}
def authorize_payment(self):
@@ -239,29 +258,30 @@ class RazorpaySettings(Document):
settings = self.get_settings(data)
try:
- resp = make_get_request("https://api.razorpay.com/v1/payments/{0}"
- .format(self.data.razorpay_payment_id), auth=(settings.api_key,
- settings.api_secret))
+ resp = make_get_request(
+ "https://api.razorpay.com/v1/payments/{0}".format(self.data.razorpay_payment_id),
+ auth=(settings.api_key, settings.api_secret),
+ )
if resp.get("status") == "authorized":
- self.integration_request.update_status(data, 'Authorized')
+ self.integration_request.update_status(data, "Authorized")
self.flags.status_changed_to = "Authorized"
if resp.get("status") == "captured":
- self.integration_request.update_status(data, 'Completed')
+ self.integration_request.update_status(data, "Completed")
self.flags.status_changed_to = "Completed"
- elif data.get('subscription_id'):
+ elif data.get("subscription_id"):
if resp.get("status") == "refunded":
# if subscription start date is in future then
# razorpay refunds the amount after authorizing the card details
# thus changing status to Verified
- self.integration_request.update_status(data, 'Completed')
+ self.integration_request.update_status(data, "Completed")
self.flags.status_changed_to = "Verified"
else:
- frappe.log_error(str(resp), 'Razorpay Payment not authorized')
+ frappe.log_error(str(resp), "Razorpay Payment not authorized")
except:
frappe.log_error(frappe.get_traceback())
@@ -270,15 +290,16 @@ class RazorpaySettings(Document):
status = frappe.flags.integration_request.status_code
- redirect_to = data.get('redirect_to') or None
- redirect_message = data.get('redirect_message') or None
+ redirect_to = data.get("redirect_to") or None
+ redirect_message = data.get("redirect_message") or None
if self.flags.status_changed_to in ("Authorized", "Verified", "Completed"):
if self.data.reference_doctype and self.data.reference_docname:
custom_redirect_to = None
try:
frappe.flags.data = data
- custom_redirect_to = frappe.get_doc(self.data.reference_doctype,
- self.data.reference_docname).run_method("on_payment_authorized", self.flags.status_changed_to)
+ custom_redirect_to = frappe.get_doc(
+ self.data.reference_doctype, self.data.reference_docname
+ ).run_method("on_payment_authorized", self.flags.status_changed_to)
except Exception:
frappe.log_error(frappe.get_traceback())
@@ -286,31 +307,34 @@ class RazorpaySettings(Document):
if custom_redirect_to:
redirect_to = custom_redirect_to
- redirect_url = 'payment-success?doctype={0}&docname={1}'.format(self.data.reference_doctype, self.data.reference_docname)
+ redirect_url = "payment-success?doctype={0}&docname={1}".format(
+ self.data.reference_doctype, self.data.reference_docname
+ )
else:
- redirect_url = 'payment-failed'
+ redirect_url = "payment-failed"
if redirect_to:
- redirect_url += '&' + urlencode({'redirect_to': redirect_to})
+ redirect_url += "&" + urlencode({"redirect_to": redirect_to})
if redirect_message:
- redirect_url += '&' + urlencode({'redirect_message': redirect_message})
+ redirect_url += "&" + urlencode({"redirect_message": redirect_message})
- return {
- "redirect_to": redirect_url,
- "status": status
- }
+ return {"redirect_to": redirect_url, "status": status}
def get_settings(self, data):
- settings = frappe._dict({
- "api_key": self.api_key,
- "api_secret": self.get_password(fieldname="api_secret", raise_exception=False)
- })
+ settings = frappe._dict(
+ {
+ "api_key": self.api_key,
+ "api_secret": self.get_password(fieldname="api_secret", raise_exception=False),
+ }
+ )
- if cint(data.get('notes', {}).get('use_sandbox')) or data.get("use_sandbox"):
- settings.update({
- "api_key": frappe.conf.sandbox_api_key,
- "api_secret": frappe.conf.sandbox_api_secret,
- })
+ if cint(data.get("notes", {}).get("use_sandbox")) or data.get("use_sandbox"):
+ settings.update(
+ {
+ "api_key": frappe.conf.sandbox_api_key,
+ "api_secret": frappe.conf.sandbox_api_secret,
+ }
+ )
return settings
@@ -318,15 +342,16 @@ class RazorpaySettings(Document):
settings = self.get_settings({})
try:
- resp = make_post_request("https://api.razorpay.com/v1/subscriptions/{0}/cancel"
- .format(subscription_id), auth=(settings.api_key,
- settings.api_secret))
+ resp = make_post_request(
+ "https://api.razorpay.com/v1/subscriptions/{0}/cancel".format(subscription_id),
+ auth=(settings.api_key, settings.api_secret),
+ )
except Exception:
frappe.log_error(frappe.get_traceback())
def verify_signature(self, body, signature, key):
- key = bytes(key, 'utf-8')
- body = bytes(body, 'utf-8')
+ key = bytes(key, "utf-8")
+ body = bytes(body, "utf-8")
dig = hmac.new(key=key, msg=body, digestmod=hashlib.sha256)
@@ -334,22 +359,26 @@ class RazorpaySettings(Document):
result = hmac.compare_digest(generated_signature, signature)
if not result:
- frappe.throw(_('Razorpay Signature Verification Failed'), exc=frappe.PermissionError)
+ frappe.throw(_("Razorpay Signature Verification Failed"), exc=frappe.PermissionError)
return result
+
def capture_payment(is_sandbox=False, sanbox_response=None):
"""
- Verifies the purchase as complete by the merchant.
- After capture, the amount is transferred to the merchant within T+3 days
- where T is the day on which payment is captured.
+ Verifies the purchase as complete by the merchant.
+ After capture, the amount is transferred to the merchant within T+3 days
+ where T is the day on which payment is captured.
- Note: Attempting to capture a payment whose status is not authorized will produce an error.
+ Note: Attempting to capture a payment whose status is not authorized will produce an error.
"""
controller = frappe.get_doc("Razorpay Settings")
- for doc in frappe.get_all("Integration Request", filters={"status": "Authorized",
- "integration_request_service": "Razorpay"}, fields=["name", "data"]):
+ for doc in frappe.get_all(
+ "Integration Request",
+ filters={"status": "Authorized", "integration_request_service": "Razorpay"},
+ fields=["name", "data"],
+ ):
try:
if is_sandbox:
resp = sanbox_response
@@ -357,12 +386,18 @@ def capture_payment(is_sandbox=False, sanbox_response=None):
data = json.loads(doc.data)
settings = controller.get_settings(data)
- resp = make_get_request("https://api.razorpay.com/v1/payments/{0}".format(data.get("razorpay_payment_id")),
- auth=(settings.api_key, settings.api_secret), data={"amount": data.get("amount")})
+ resp = make_get_request(
+ "https://api.razorpay.com/v1/payments/{0}".format(data.get("razorpay_payment_id")),
+ auth=(settings.api_key, settings.api_secret),
+ data={"amount": data.get("amount")},
+ )
- if resp.get('status') == "authorized":
- resp = make_post_request("https://api.razorpay.com/v1/payments/{0}/capture".format(data.get("razorpay_payment_id")),
- auth=(settings.api_key, settings.api_secret), data={"amount": data.get("amount")})
+ if resp.get("status") == "authorized":
+ resp = make_post_request(
+ "https://api.razorpay.com/v1/payments/{0}/capture".format(data.get("razorpay_payment_id")),
+ auth=(settings.api_key, settings.api_secret),
+ data={"amount": data.get("amount")},
+ )
if resp.get("status") == "captured":
frappe.db.set_value("Integration Request", doc.name, "status", "Completed")
@@ -372,7 +407,7 @@ def capture_payment(is_sandbox=False, sanbox_response=None):
doc.status = "Failed"
doc.error = frappe.get_traceback()
doc.save()
- frappe.log_error(doc.error, '{0} Failed'.format(doc.name))
+ frappe.log_error(doc.error, "{0} Failed".format(doc.name))
@frappe.whitelist(allow_guest=True)
@@ -380,6 +415,7 @@ def get_api_key():
controller = frappe.get_doc("Razorpay Settings")
return controller.api_key
+
@frappe.whitelist(allow_guest=True)
def get_order(doctype, docname):
# Order returned to be consumed by razorpay.js
@@ -391,6 +427,7 @@ def get_order(doctype, docname):
frappe.log_error(frappe.get_traceback(), _("Controller method get_razorpay_order missing"))
frappe.throw(_("Could not create Razorpay order. Please contact Administrator"))
+
@frappe.whitelist(allow_guest=True)
def order_payment_success(integration_request, params):
"""Called by razorpay.js on order payment success, the params
@@ -398,8 +435,8 @@ def order_payment_success(integration_request, params):
that is updated in the data field of integration request
Args:
- integration_request (string): Name for integration request doc
- params (string): Params to be updated for integration request.
+ integration_request (string): Name for integration request doc
+ params (string): Params to be updated for integration request.
"""
params = json.loads(params)
integration = frappe.get_doc("Integration Request", integration_request)
@@ -418,25 +455,28 @@ def order_payment_success(integration_request, params):
# Authorize payment
controller.authorize_payment()
+
@frappe.whitelist(allow_guest=True)
def order_payment_failure(integration_request, params):
"""Called by razorpay.js on failure
Args:
- integration_request (TYPE): Description
- params (TYPE): error data to be updated
+ integration_request (TYPE): Description
+ params (TYPE): error data to be updated
"""
- frappe.log_error(params, 'Razorpay Payment Failure')
+ frappe.log_error(params, "Razorpay Payment Failure")
params = json.loads(params)
integration = frappe.get_doc("Integration Request", integration_request)
integration.update_status(params, integration.status)
+
def convert_rupee_to_paisa(**kwargs):
- for addon in kwargs.get('addons'):
- addon['item']['amount'] *= 100
+ for addon in kwargs.get("addons"):
+ addon["item"]["amount"] *= 100
frappe.conf.converted_rupee_to_paisa = True
+
@frappe.whitelist(allow_guest=True)
def razorpay_subscription_callback():
try:
@@ -444,44 +484,53 @@ def razorpay_subscription_callback():
validate_payment_callback(data)
- data.update({
- "payment_gateway": "Razorpay"
- })
+ data.update({"payment_gateway": "Razorpay"})
- doc = frappe.get_doc({
- "data": json.dumps(frappe.local.form_dict),
- "doctype": "Integration Request",
- "integration_type": "Subscription Notification",
- "status": "Queued"
- }).insert(ignore_permissions=True)
+ doc = frappe.get_doc(
+ {
+ "data": json.dumps(frappe.local.form_dict),
+ "doctype": "Integration Request",
+ "integration_type": "Subscription Notification",
+ "status": "Queued",
+ }
+ ).insert(ignore_permissions=True)
frappe.db.commit()
- frappe.enqueue(method='frappe.integrations.doctype.razorpay_settings.razorpay_settings.handle_subscription_notification',
- queue='long', timeout=600, is_async=True, **{"doctype": "Integration Request", "docname": doc.name})
+ frappe.enqueue(
+ method="frappe.integrations.doctype.razorpay_settings.razorpay_settings.handle_subscription_notification",
+ queue="long",
+ timeout=600,
+ is_async=True,
+ **{"doctype": "Integration Request", "docname": doc.name}
+ )
except frappe.InvalidStatusError:
pass
except Exception as e:
frappe.log(frappe.log_error(title=e))
+
def validate_payment_callback(data):
def _throw():
frappe.throw(_("Invalid Subscription"), exc=frappe.InvalidStatusError)
- subscription_id = data.get('payload').get("subscription").get("entity").get("id")
+ subscription_id = data.get("payload").get("subscription").get("entity").get("id")
- if not(subscription_id):
+ if not (subscription_id):
_throw()
controller = frappe.get_doc("Razorpay Settings")
settings = controller.get_settings(data)
- resp = make_get_request("https://api.razorpay.com/v1/subscriptions/{0}".format(subscription_id),
- auth=(settings.api_key, settings.api_secret))
+ resp = make_get_request(
+ "https://api.razorpay.com/v1/subscriptions/{0}".format(subscription_id),
+ auth=(settings.api_key, settings.api_secret),
+ )
if resp.get("status") != "active":
_throw()
+
def handle_subscription_notification(doctype, docname):
call_hook_method("handle_subscription_notification", doctype=doctype, docname=docname)
diff --git a/frappe/integrations/doctype/s3_backup_settings/s3_backup_settings.py b/frappe/integrations/doctype/s3_backup_settings/s3_backup_settings.py
index dc824e18b9..015d4f0467 100755
--- a/frappe/integrations/doctype/s3_backup_settings/s3_backup_settings.py
+++ b/frappe/integrations/doctype/s3_backup_settings/s3_backup_settings.py
@@ -3,31 +3,37 @@
# License: MIT. See LICENSE
import os
import os.path
-import frappe
+
import boto3
+from botocore.exceptions import ClientError
+from rq.timeouts import JobTimeoutException
+
+import frappe
from frappe import _
-from frappe.integrations.offsite_backup_utils import get_latest_backup_file, send_email, validate_file_size, generate_files_backup
+from frappe.integrations.offsite_backup_utils import (
+ generate_files_backup,
+ get_latest_backup_file,
+ send_email,
+ validate_file_size,
+)
from frappe.model.document import Document
from frappe.utils import cint
from frappe.utils.background_jobs import enqueue
-from rq.timeouts import JobTimeoutException
-from botocore.exceptions import ClientError
class S3BackupSettings(Document):
-
def validate(self):
if not self.enabled:
return
if not self.endpoint_url:
- self.endpoint_url = 'https://s3.amazonaws.com'
+ self.endpoint_url = "https://s3.amazonaws.com"
conn = boto3.client(
- 's3',
+ "s3",
aws_access_key_id=self.access_key_id,
- aws_secret_access_key=self.get_password('secret_access_key'),
- endpoint_url=self.endpoint_url
+ aws_secret_access_key=self.get_password("secret_access_key"),
+ endpoint_url=self.endpoint_url,
)
try:
@@ -35,11 +41,11 @@ class S3BackupSettings(Document):
# Requires ListBucket permission
conn.head_bucket(Bucket=self.bucket)
except ClientError as e:
- error_code = e.response['Error']['Code']
+ error_code = e.response["Error"]["Code"]
bucket_name = frappe.bold(self.bucket)
- if error_code == '403':
+ if error_code == "403":
msg = _("Do not have permission to access bucket {0}.").format(bucket_name)
- elif error_code == '404':
+ elif error_code == "404":
msg = _("Bucket {0} not found.").format(bucket_name)
else:
msg = e.args[0]
@@ -50,7 +56,11 @@ class S3BackupSettings(Document):
@frappe.whitelist()
def take_backup():
"""Enqueue longjob for taking backup to s3"""
- enqueue("frappe.integrations.doctype.s3_backup_settings.s3_backup_settings.take_backups_s3", queue='long', timeout=1500)
+ enqueue(
+ "frappe.integrations.doctype.s3_backup_settings.s3_backup_settings.take_backups_s3",
+ queue="long",
+ timeout=1500,
+ )
frappe.msgprint(_("Queued for backup. It may take a few minutes to an hour."))
@@ -80,11 +90,13 @@ def take_backups_s3(retry_count=0):
send_email(True, "Amazon S3", "S3 Backup Settings", "notify_email")
except JobTimeoutException:
if retry_count < 2:
- args = {
- "retry_count": retry_count + 1
- }
- enqueue("frappe.integrations.doctype.s3_backup_settings.s3_backup_settings.take_backups_s3",
- queue='long', timeout=1500, **args)
+ args = {"retry_count": retry_count + 1}
+ enqueue(
+ "frappe.integrations.doctype.s3_backup_settings.s3_backup_settings.take_backups_s3",
+ queue="long",
+ timeout=1500,
+ **args
+ )
else:
notify()
except Exception:
@@ -93,44 +105,55 @@ def take_backups_s3(retry_count=0):
def notify():
error_message = frappe.get_traceback()
- send_email(False, 'Amazon S3', "S3 Backup Settings", "notify_email", error_message)
+ send_email(False, "Amazon S3", "S3 Backup Settings", "notify_email", error_message)
def backup_to_s3():
- from frappe.utils.backups import new_backup
from frappe.utils import get_backups_path
+ from frappe.utils.backups import new_backup
doc = frappe.get_single("S3 Backup Settings")
bucket = doc.bucket
backup_files = cint(doc.backup_files)
conn = boto3.client(
- 's3',
- aws_access_key_id=doc.access_key_id,
- aws_secret_access_key=doc.get_password('secret_access_key'),
- endpoint_url=doc.endpoint_url or 'https://s3.amazonaws.com'
- )
+ "s3",
+ aws_access_key_id=doc.access_key_id,
+ aws_secret_access_key=doc.get_password("secret_access_key"),
+ endpoint_url=doc.endpoint_url or "https://s3.amazonaws.com",
+ )
if frappe.flags.create_new_backup:
- backup = new_backup(ignore_files=False, backup_path_db=None,
- backup_path_files=None, backup_path_private_files=None, force=True)
+ backup = new_backup(
+ ignore_files=False,
+ backup_path_db=None,
+ backup_path_files=None,
+ backup_path_private_files=None,
+ force=True,
+ )
db_filename = os.path.join(get_backups_path(), os.path.basename(backup.backup_path_db))
site_config = os.path.join(get_backups_path(), os.path.basename(backup.backup_path_conf))
if backup_files:
files_filename = os.path.join(get_backups_path(), os.path.basename(backup.backup_path_files))
- private_files = os.path.join(get_backups_path(), os.path.basename(backup.backup_path_private_files))
+ private_files = os.path.join(
+ get_backups_path(), os.path.basename(backup.backup_path_private_files)
+ )
else:
if backup_files:
- db_filename, site_config, files_filename, private_files = get_latest_backup_file(with_files=backup_files)
+ db_filename, site_config, files_filename, private_files = get_latest_backup_file(
+ with_files=backup_files
+ )
if not files_filename or not private_files:
generate_files_backup()
- db_filename, site_config, files_filename, private_files = get_latest_backup_file(with_files=backup_files)
+ db_filename, site_config, files_filename, private_files = get_latest_backup_file(
+ with_files=backup_files
+ )
else:
db_filename, site_config = get_latest_backup_file()
- folder = os.path.basename(db_filename)[:15] + '/'
+ folder = os.path.basename(db_filename)[:15] + "/"
# for adding datetime to folder name
upload_file_to_s3(db_filename, folder, conn, bucket)
@@ -148,7 +171,7 @@ def upload_file_to_s3(filename, folder, conn, bucket):
destpath = os.path.join(folder, os.path.basename(filename))
try:
print("Uploading file:", filename)
- conn.upload_file(filename, bucket, destpath) # Requires PutObject permission
+ conn.upload_file(filename, bucket, destpath) # Requires PutObject permission
except Exception as e:
frappe.log_error()
diff --git a/frappe/integrations/doctype/s3_backup_settings/test_s3_backup_settings.py b/frappe/integrations/doctype/s3_backup_settings/test_s3_backup_settings.py
index 2a586c30d4..c6dbee2c20 100755
--- a/frappe/integrations/doctype/s3_backup_settings/test_s3_backup_settings.py
+++ b/frappe/integrations/doctype/s3_backup_settings/test_s3_backup_settings.py
@@ -3,5 +3,6 @@
# License: MIT. See LICENSE
import unittest
+
class TestS3BackupSettings(unittest.TestCase):
pass
diff --git a/frappe/integrations/doctype/slack_webhook_url/slack_webhook_url.py b/frappe/integrations/doctype/slack_webhook_url/slack_webhook_url.py
index a74c0a36ca..cf6a23fb34 100644
--- a/frappe/integrations/doctype/slack_webhook_url/slack_webhook_url.py
+++ b/frappe/integrations/doctype/slack_webhook_url/slack_webhook_url.py
@@ -2,20 +2,21 @@
# Copyright (c) 2018, Frappe Technologies and contributors
# License: MIT. See LICENSE
+import json
+
+import requests
+
import frappe
+from frappe import _
from frappe.model.document import Document
from frappe.utils import get_url_to_form
-from frappe import _
-import requests
-import json
-
error_messages = {
400: "400: Invalid Payload or User not found",
403: "403: Action Prohibited",
404: "404: Channel not found",
410: "410: The Channel is Archived",
- 500: "500: Rollup Error, Slack seems to be down"
+ 500: "500: Rollup Error, Slack seems to be down",
}
@@ -49,7 +50,7 @@ def send_slack_message(webhook_url, message, reference_doctype, reference_name):
if not r.ok:
message = error_messages.get(r.status_code, r.status_code)
- frappe.log_error(message, _('Slack Webhook Error'))
- return 'error'
+ frappe.log_error(message, _("Slack Webhook Error"))
+ return "error"
- return 'success'
+ return "success"
diff --git a/frappe/integrations/doctype/slack_webhook_url/test_slack_webhook_url.py b/frappe/integrations/doctype/slack_webhook_url/test_slack_webhook_url.py
index a256735f81..4bd71033bb 100644
--- a/frappe/integrations/doctype/slack_webhook_url/test_slack_webhook_url.py
+++ b/frappe/integrations/doctype/slack_webhook_url/test_slack_webhook_url.py
@@ -3,5 +3,6 @@
# License: MIT. See LICENSE
import unittest
+
class TestSlackWebhookURL(unittest.TestCase):
pass
diff --git a/frappe/integrations/doctype/social_login_key/social_login_key.py b/frappe/integrations/doctype/social_login_key/social_login_key.py
index 195d6800be..8c19767107 100644
--- a/frappe/integrations/doctype/social_login_key/social_login_key.py
+++ b/frappe/integrations/doctype/social_login_key/social_login_key.py
@@ -2,19 +2,38 @@
# Copyright (c) 2017, Frappe Technologies and contributors
# License: MIT. See LICENSE
-import frappe, json
+import json
+
+import frappe
from frappe import _
from frappe.model.document import Document
-class BaseUrlNotSetError(frappe.ValidationError): pass
-class AuthorizeUrlNotSetError(frappe.ValidationError): pass
-class AccessTokenUrlNotSetError(frappe.ValidationError): pass
-class RedirectUrlNotSetError(frappe.ValidationError): pass
-class ClientIDNotSetError(frappe.ValidationError): pass
-class ClientSecretNotSetError(frappe.ValidationError): pass
-class SocialLoginKey(Document):
+class BaseUrlNotSetError(frappe.ValidationError):
+ pass
+
+
+class AuthorizeUrlNotSetError(frappe.ValidationError):
+ pass
+
+
+class AccessTokenUrlNotSetError(frappe.ValidationError):
+ pass
+
+
+class RedirectUrlNotSetError(frappe.ValidationError):
+ pass
+
+class ClientIDNotSetError(frappe.ValidationError):
+ pass
+
+
+class ClientSecretNotSetError(frappe.ValidationError):
+ pass
+
+
+class SocialLoginKey(Document):
def autoname(self):
self.name = frappe.scrub(self.provider_name)
@@ -29,9 +48,13 @@ class SocialLoginKey(Document):
if not self.redirect_url:
frappe.throw(_("Please enter Redirect URL"), exc=RedirectUrlNotSetError)
if self.enable_social_login and not self.client_id:
- frappe.throw(_("Please enter Client ID before social login is enabled"), exc=ClientIDNotSetError)
+ frappe.throw(
+ _("Please enter Client ID before social login is enabled"), exc=ClientIDNotSetError
+ )
if self.enable_social_login and not self.client_secret:
- frappe.throw(_("Please enter Client Secret before social login is enabled"), exc=ClientSecretNotSetError)
+ frappe.throw(
+ _("Please enter Client Secret before social login is enabled"), exc=ClientSecretNotSetError
+ )
def set_icon(self):
icon_map = {
@@ -41,12 +64,12 @@ class SocialLoginKey(Document):
"Office 365": "office_365.svg",
"GitHub": "github.svg",
"Salesforce": "salesforce.svg",
- "fairlogin": "fair.svg"
+ "fairlogin": "fair.svg",
}
if self.provider_name in icon_map:
icon_file = icon_map[self.provider_name]
- self.icon = '/assets/frappe/icons/social/{0}'.format(icon_file)
+ self.icon = "/assets/frappe/icons/social/{0}".format(icon_file)
@frappe.whitelist()
def get_social_login_provider(self, provider, initialize=False):
@@ -57,32 +80,27 @@ class SocialLoginKey(Document):
"enable_social_login": 1,
"base_url": "https://login.microsoftonline.com",
"custom_base_url": 0,
- "icon":"fa fa-windows",
+ "icon": "fa fa-windows",
"authorize_url": "https://login.microsoftonline.com/common/oauth2/authorize",
"access_token_url": "https://login.microsoftonline.com/common/oauth2/token",
"redirect_url": "/api/method/frappe.integrations.oauth2_logins.login_via_office365",
"api_endpoint": None,
- "api_endpoint_args":None,
- "auth_url_data": json.dumps({
- "response_type": "code",
- "scope":"openid"
- })
+ "api_endpoint_args": None,
+ "auth_url_data": json.dumps({"response_type": "code", "scope": "openid"}),
}
providers["GitHub"] = {
- "provider_name":"GitHub",
+ "provider_name": "GitHub",
"enable_social_login": 1,
- "base_url":"https://api.github.com/",
- "custom_base_url":0,
- "icon":"fa fa-github",
- "authorize_url":"https://github.com/login/oauth/authorize",
- "access_token_url":"https://github.com/login/oauth/access_token",
- "redirect_url":"/api/method/frappe.www.login.login_via_github",
- "api_endpoint":"user",
- "api_endpoint_args":None,
- "auth_url_data": json.dumps({
- "scope": "user:email"
- })
+ "base_url": "https://api.github.com/",
+ "custom_base_url": 0,
+ "icon": "fa fa-github",
+ "authorize_url": "https://github.com/login/oauth/authorize",
+ "access_token_url": "https://github.com/login/oauth/access_token",
+ "redirect_url": "/api/method/frappe.www.login.login_via_github",
+ "api_endpoint": "user",
+ "api_endpoint_args": None,
+ "auth_url_data": json.dumps({"scope": "user:email"}),
}
providers["Google"] = {
@@ -90,16 +108,18 @@ class SocialLoginKey(Document):
"enable_social_login": 1,
"base_url": "https://www.googleapis.com",
"custom_base_url": 0,
- "icon":"fa fa-google",
+ "icon": "fa fa-google",
"authorize_url": "https://accounts.google.com/o/oauth2/auth",
"access_token_url": "https://accounts.google.com/o/oauth2/token",
"redirect_url": "/api/method/frappe.www.login.login_via_google",
"api_endpoint": "oauth2/v2/userinfo",
- "api_endpoint_args":None,
- "auth_url_data": json.dumps({
- "scope": "https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
- "response_type": "code"
- })
+ "api_endpoint_args": None,
+ "auth_url_data": json.dumps(
+ {
+ "scope": "https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
+ "response_type": "code",
+ }
+ ),
}
providers["Facebook"] = {
@@ -112,30 +132,25 @@ class SocialLoginKey(Document):
"access_token_url": "https://graph.facebook.com/oauth/access_token",
"redirect_url": "/api/method/frappe.www.login.login_via_facebook",
"api_endpoint": "/v2.5/me",
- "api_endpoint_args": json.dumps({
- "fields": "first_name,last_name,email,gender,location,verified,picture"
- }),
- "auth_url_data": json.dumps({
- "display": "page",
- "response_type": "code",
- "scope": "email,public_profile"
- })
+ "api_endpoint_args": json.dumps(
+ {"fields": "first_name,last_name,email,gender,location,verified,picture"}
+ ),
+ "auth_url_data": json.dumps(
+ {"display": "page", "response_type": "code", "scope": "email,public_profile"}
+ ),
}
providers["Frappe"] = {
"provider_name": "Frappe",
"enable_social_login": 1,
"custom_base_url": 1,
- "icon":"/assets/frappe/images/frappe-favicon.svg",
+ "icon": "/assets/frappe/images/frappe-favicon.svg",
"redirect_url": "/api/method/frappe.www.login.login_via_frappe",
"api_endpoint": "/api/method/frappe.integrations.oauth2.openid_profile",
- "api_endpoint_args":None,
+ "api_endpoint_args": None,
"authorize_url": "/api/method/frappe.integrations.oauth2.authorize",
"access_token_url": "/api/method/frappe.integrations.oauth2.get_token",
- "auth_url_data": json.dumps({
- "response_type": "code",
- "scope": "openid"
- })
+ "auth_url_data": json.dumps({"response_type": "code", "scope": "openid"}),
}
providers["Salesforce"] = {
@@ -143,16 +158,13 @@ class SocialLoginKey(Document):
"enable_social_login": 1,
"base_url": "https://login.salesforce.com",
"custom_base_url": 0,
- "icon":"fa fa-cloud", #https://github.com/FortAwesome/Font-Awesome/issues/1744
+ "icon": "fa fa-cloud", # https://github.com/FortAwesome/Font-Awesome/issues/1744
"redirect_url": "/api/method/frappe.integrations.oauth2_logins.login_via_salesforce",
"api_endpoint": "https://login.salesforce.com/services/oauth2/userinfo",
- "api_endpoint_args":None,
+ "api_endpoint_args": None,
"authorize_url": "https://login.salesforce.com/services/oauth2/authorize",
"access_token_url": "https://login.salesforce.com/services/oauth2/token",
- "auth_url_data": json.dumps({
- "response_type": "code",
- "scope": "openid"
- })
+ "auth_url_data": json.dumps({"response_type": "code", "scope": "openid"}),
}
providers["fairlogin"] = {
@@ -160,24 +172,20 @@ class SocialLoginKey(Document):
"enable_social_login": 1,
"base_url": "https://id.fairkom.net/auth/realms/fairlogin/",
"custom_base_url": 0,
- "icon":"fa fa-key",
+ "icon": "fa fa-key",
"redirect_url": "/api/method/frappe.integrations.oauth2_logins.login_via_fairlogin",
"api_endpoint": "https://id.fairkom.net/auth/realms/fairlogin/protocol/openid-connect/userinfo",
- "api_endpoint_args":None,
+ "api_endpoint_args": None,
"authorize_url": "https://id.fairkom.net/auth/realms/fairlogin/protocol/openid-connect/auth",
"access_token_url": "https://id.fairkom.net/auth/realms/fairlogin/protocol/openid-connect/token",
- "auth_url_data": json.dumps({
- "response_type": "code",
- "scope": "openid"
- })
+ "auth_url_data": json.dumps({"response_type": "code", "scope": "openid"}),
}
-
# Initialize the doc and return, used in patch
# Or can be used for creating key from controller
if initialize and provider:
for k, v in providers[provider].items():
- setattr(self,k,v)
+ setattr(self, k, v)
return
return providers.get(provider) if provider else providers
diff --git a/frappe/integrations/doctype/social_login_key/test_social_login_key.py b/frappe/integrations/doctype/social_login_key/test_social_login_key.py
index 73e6a072cb..be4c1f7c49 100644
--- a/frappe/integrations/doctype/social_login_key/test_social_login_key.py
+++ b/frappe/integrations/doctype/social_login_key/test_social_login_key.py
@@ -1,22 +1,22 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2017, Frappe Technologies and Contributors
# License: MIT. See LICENSE
-import frappe
-from frappe.integrations.doctype.social_login_key.social_login_key import BaseUrlNotSetError
import unittest
-from frappe.utils.oauth import login_via_oauth2
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
+
from rauth import OAuth2Service
-from frappe.auth import LoginManager, CookieManager
+
+import frappe
+from frappe.auth import CookieManager, LoginManager
+from frappe.integrations.doctype.social_login_key.social_login_key import BaseUrlNotSetError
from frappe.utils import set_request
+from frappe.utils.oauth import login_via_oauth2
class TestSocialLoginKey(unittest.TestCase):
def test_adding_frappe_social_login_provider(self):
provider_name = "Frappe"
- social_login_key = make_social_login_key(
- social_login_provider=provider_name
- )
+ social_login_key = make_social_login_key(social_login_provider=provider_name)
social_login_key.get_social_login_provider(provider_name, initialize=True)
self.assertRaises(BaseUrlNotSetError, social_login_key.insert)
@@ -27,7 +27,7 @@ class TestSocialLoginKey(unittest.TestCase):
mock_session.get.side_effect = github_response_for_private_email
with patch.object(OAuth2Service, "get_auth_session", return_value=mock_session):
- login_via_oauth2("github", "iwriu", {"token": "ewrwerwer"}) # Dummy code and state token
+ login_via_oauth2("github", "iwriu", {"token": "ewrwerwer"}) # Dummy code and state token
def test_github_login_with_public_email(self):
github_social_login_setup()
@@ -36,17 +36,15 @@ class TestSocialLoginKey(unittest.TestCase):
mock_session.get.side_effect = github_response_for_public_email
with patch.object(OAuth2Service, "get_auth_session", return_value=mock_session):
- login_via_oauth2("github", "iwriu", {"token": "ewrwerwer"}) # Dummy code and state token
+ login_via_oauth2("github", "iwriu", {"token": "ewrwerwer"}) # Dummy code and state token
def test_normal_signup_and_github_login(self):
github_social_login_setup()
if not frappe.db.exists("User", "githublogin@example.com"):
- user = frappe.get_doc({
- "doctype": "User",
- "email": "githublogin@example.com",
- "first_name": "GitHub Login"
- })
+ user = frappe.get_doc(
+ {"doctype": "User", "email": "githublogin@example.com", "first_name": "GitHub Login"}
+ )
user.save(ignore_permissions=True)
mock_session = MagicMock()
@@ -55,6 +53,7 @@ class TestSocialLoginKey(unittest.TestCase):
with patch.object(OAuth2Service, "get_auth_session", return_value=mock_session):
login_via_oauth2("github", "iwriu", {"token": "ewrwerwer"})
+
def make_social_login_key(**kwargs):
kwargs["doctype"] = "Social Login Key"
if not "provider_name" in kwargs:
@@ -62,6 +61,7 @@ def make_social_login_key(**kwargs):
doc = frappe.get_doc(kwargs)
return doc
+
def create_or_update_social_login_key():
# used in other tests (connected app, oauth20)
try:
@@ -76,14 +76,13 @@ def create_or_update_social_login_key():
return social_login_key
+
def create_github_social_login_key():
if frappe.db.exists("Social Login Key", "github"):
return frappe.get_doc("Social Login Key", "github")
else:
provider_name = "GitHub"
- social_login_key = make_social_login_key(
- social_login_provider=provider_name
- )
+ social_login_key = make_social_login_key(social_login_provider=provider_name)
social_login_key.get_social_login_provider(provider_name, initialize=True)
# Dummy client_id and client_secret
@@ -92,28 +91,47 @@ def create_github_social_login_key():
social_login_key.insert(ignore_permissions=True)
return social_login_key
+
def github_response_for_private_email(url, *args, **kwargs):
if url == "user":
- return_value = {"login": "dummy_username", "id": "223342", "email": None, "first_name": "Github Private"}
+ return_value = {
+ "login": "dummy_username",
+ "id": "223342",
+ "email": None,
+ "first_name": "Github Private",
+ }
else:
return_value = [{"email": "github@example.com", "primary": True, "verified": True}]
return MagicMock(status_code=200, json=MagicMock(return_value=return_value))
+
def github_response_for_public_email(url, *args, **kwargs):
if url == "user":
- return_value = {"login": "dummy_username", "id": "223343", "email": "github_public@example.com", "first_name": "Github Public"}
+ return_value = {
+ "login": "dummy_username",
+ "id": "223343",
+ "email": "github_public@example.com",
+ "first_name": "Github Public",
+ }
return MagicMock(status_code=200, json=MagicMock(return_value=return_value))
+
def github_response_for_login(url, *args, **kwargs):
if url == "user":
- return_value = {"login": "dummy_username", "id": "223346", "email": None, "first_name": "Github Login"}
+ return_value = {
+ "login": "dummy_username",
+ "id": "223346",
+ "email": None,
+ "first_name": "Github Login",
+ }
else:
return_value = [{"email": "githublogin@example.com", "primary": True, "verified": True}]
return MagicMock(status_code=200, json=MagicMock(return_value=return_value))
+
def github_social_login_setup():
set_request(path="/random")
frappe.local.cookie_manager = CookieManager()
diff --git a/frappe/integrations/doctype/social_login_keys/social_login_keys.py b/frappe/integrations/doctype/social_login_keys/social_login_keys.py
index da9e21cd8e..16d59e9690 100644
--- a/frappe/integrations/doctype/social_login_keys/social_login_keys.py
+++ b/frappe/integrations/doctype/social_login_keys/social_login_keys.py
@@ -1,5 +1,6 @@
# see license
from frappe.model.document import Document
+
class SocialLoginKeys(Document):
pass
diff --git a/frappe/integrations/doctype/stripe_settings/stripe_settings.py b/frappe/integrations/doctype/stripe_settings/stripe_settings.py
index 81e40fa72f..4ebf902e84 100644
--- a/frappe/integrations/doctype/stripe_settings/stripe_settings.py
+++ b/frappe/integrations/doctype/stripe_settings/stripe_settings.py
@@ -2,41 +2,171 @@
# Copyright (c) 2017, Frappe Technologies and contributors
# License: MIT. See LICENSE
+from urllib.parse import urlencode
+
import frappe
-from frappe.model.document import Document
from frappe import _
-from urllib.parse import urlencode
-from frappe.utils import get_url, call_hook_method, cint, flt
-from frappe.integrations.utils import make_get_request, make_post_request, create_request_log, create_payment_gateway
+from frappe.integrations.utils import (
+ create_payment_gateway,
+ create_request_log,
+ make_get_request,
+ make_post_request,
+)
+from frappe.model.document import Document
+from frappe.utils import call_hook_method, cint, flt, get_url
+
class StripeSettings(Document):
supported_currencies = [
- "AED", "ALL", "ANG", "ARS", "AUD", "AWG", "BBD", "BDT", "BIF", "BMD", "BND",
- "BOB", "BRL", "BSD", "BWP", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF",
- "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GIP", "GMD", "GNF", "GTQ", "GYD",
- "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KMF",
- "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "MAD", "MDL", "MNT", "MOP", "MRO", "MUR", "MVR",
- "MWK", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR",
- "PLN", "PYG", "QAR", "RUB", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SOS", "STD", "SVC",
- "SZL", "THB", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST",
- "XAF", "XOF", "XPF", "YER", "ZAR"
+ "AED",
+ "ALL",
+ "ANG",
+ "ARS",
+ "AUD",
+ "AWG",
+ "BBD",
+ "BDT",
+ "BIF",
+ "BMD",
+ "BND",
+ "BOB",
+ "BRL",
+ "BSD",
+ "BWP",
+ "BZD",
+ "CAD",
+ "CHF",
+ "CLP",
+ "CNY",
+ "COP",
+ "CRC",
+ "CVE",
+ "CZK",
+ "DJF",
+ "DKK",
+ "DOP",
+ "DZD",
+ "EGP",
+ "ETB",
+ "EUR",
+ "FJD",
+ "FKP",
+ "GBP",
+ "GIP",
+ "GMD",
+ "GNF",
+ "GTQ",
+ "GYD",
+ "HKD",
+ "HNL",
+ "HRK",
+ "HTG",
+ "HUF",
+ "IDR",
+ "ILS",
+ "INR",
+ "ISK",
+ "JMD",
+ "JPY",
+ "KES",
+ "KHR",
+ "KMF",
+ "KRW",
+ "KYD",
+ "KZT",
+ "LAK",
+ "LBP",
+ "LKR",
+ "LRD",
+ "MAD",
+ "MDL",
+ "MNT",
+ "MOP",
+ "MRO",
+ "MUR",
+ "MVR",
+ "MWK",
+ "MXN",
+ "MYR",
+ "NAD",
+ "NGN",
+ "NIO",
+ "NOK",
+ "NPR",
+ "NZD",
+ "PAB",
+ "PEN",
+ "PGK",
+ "PHP",
+ "PKR",
+ "PLN",
+ "PYG",
+ "QAR",
+ "RUB",
+ "SAR",
+ "SBD",
+ "SCR",
+ "SEK",
+ "SGD",
+ "SHP",
+ "SLL",
+ "SOS",
+ "STD",
+ "SVC",
+ "SZL",
+ "THB",
+ "TOP",
+ "TTD",
+ "TWD",
+ "TZS",
+ "UAH",
+ "UGX",
+ "USD",
+ "UYU",
+ "UZS",
+ "VND",
+ "VUV",
+ "WST",
+ "XAF",
+ "XOF",
+ "XPF",
+ "YER",
+ "ZAR",
]
currency_wise_minimum_charge_amount = {
- 'JPY': 50, 'MXN': 10, 'DKK': 2.50, 'HKD': 4.00, 'NOK': 3.00, 'SEK': 3.00,
- 'USD': 0.50, 'AUD': 0.50, 'BRL': 0.50, 'CAD': 0.50, 'CHF': 0.50, 'EUR': 0.50,
- 'GBP': 0.30, 'NZD': 0.50, 'SGD': 0.50
+ "JPY": 50,
+ "MXN": 10,
+ "DKK": 2.50,
+ "HKD": 4.00,
+ "NOK": 3.00,
+ "SEK": 3.00,
+ "USD": 0.50,
+ "AUD": 0.50,
+ "BRL": 0.50,
+ "CAD": 0.50,
+ "CHF": 0.50,
+ "EUR": 0.50,
+ "GBP": 0.30,
+ "NZD": 0.50,
+ "SGD": 0.50,
}
def on_update(self):
- create_payment_gateway('Stripe-' + self.gateway_name, settings='Stripe Settings', controller=self.gateway_name)
- call_hook_method('payment_gateway_enabled', gateway='Stripe-' + self.gateway_name)
+ create_payment_gateway(
+ "Stripe-" + self.gateway_name, settings="Stripe Settings", controller=self.gateway_name
+ )
+ call_hook_method("payment_gateway_enabled", gateway="Stripe-" + self.gateway_name)
if not self.flags.ignore_mandatory:
self.validate_stripe_credentails()
def validate_stripe_credentails(self):
if self.publishable_key and self.secret_key:
- header = {"Authorization": "Bearer {0}".format(self.get_password(fieldname="secret_key", raise_exception=False))}
+ header = {
+ "Authorization": "Bearer {0}".format(
+ self.get_password(fieldname="secret_key", raise_exception=False)
+ )
+ }
try:
make_get_request(url="https://api.stripe.com/v1/charges", headers=header)
except Exception:
@@ -44,19 +174,27 @@ class StripeSettings(Document):
def validate_transaction_currency(self, currency):
if currency not in self.supported_currencies:
- frappe.throw(_("Please select another payment method. Stripe does not support transactions in currency '{0}'").format(currency))
+ frappe.throw(
+ _(
+ "Please select another payment method. Stripe does not support transactions in currency '{0}'"
+ ).format(currency)
+ )
def validate_minimum_transaction_amount(self, currency, amount):
if currency in self.currency_wise_minimum_charge_amount:
if flt(amount) < self.currency_wise_minimum_charge_amount.get(currency, 0.0):
- frappe.throw(_("For currency {0}, the minimum transaction amount should be {1}").format(currency,
- self.currency_wise_minimum_charge_amount.get(currency, 0.0)))
+ frappe.throw(
+ _("For currency {0}, the minimum transaction amount should be {1}").format(
+ currency, self.currency_wise_minimum_charge_amount.get(currency, 0.0)
+ )
+ )
def get_payment_url(self, **kwargs):
return get_url("./integrations/stripe_checkout?{0}".format(urlencode(kwargs)))
def create_request(self, data):
import stripe
+
self.data = frappe._dict(data)
stripe.api_key = self.get_password(fieldname="secret_key", raise_exception=False)
stripe.default_http_client = stripe.http_client.RequestsClient()
@@ -67,65 +205,77 @@ class StripeSettings(Document):
except Exception:
frappe.log_error(frappe.get_traceback())
- return{
- "redirect_to": frappe.redirect_to_message(_('Server Error'), _("It seems that there is an issue with the server's stripe configuration. In case of failure, the amount will get refunded to your account.")),
- "status": 401
+ return {
+ "redirect_to": frappe.redirect_to_message(
+ _("Server Error"),
+ _(
+ "It seems that there is an issue with the server's stripe configuration. In case of failure, the amount will get refunded to your account."
+ ),
+ ),
+ "status": 401,
}
def create_charge_on_stripe(self):
import stripe
+
try:
- charge = stripe.Charge.create(amount=cint(flt(self.data.amount)*100), currency=self.data.currency, source=self.data.stripe_token_id, description=self.data.description, receipt_email=self.data.payer_email)
+ charge = stripe.Charge.create(
+ amount=cint(flt(self.data.amount) * 100),
+ currency=self.data.currency,
+ source=self.data.stripe_token_id,
+ description=self.data.description,
+ receipt_email=self.data.payer_email,
+ )
if charge.captured == True:
- self.integration_request.db_set('status', 'Completed', update_modified=False)
+ self.integration_request.db_set("status", "Completed", update_modified=False)
self.flags.status_changed_to = "Completed"
else:
- frappe.log_error(charge.failure_message, 'Stripe Payment not completed')
+ frappe.log_error(charge.failure_message, "Stripe Payment not completed")
except Exception:
frappe.log_error(frappe.get_traceback())
return self.finalize_request()
-
def finalize_request(self):
- redirect_to = self.data.get('redirect_to') or None
- redirect_message = self.data.get('redirect_message') or None
+ redirect_to = self.data.get("redirect_to") or None
+ redirect_message = self.data.get("redirect_message") or None
status = self.integration_request.status
if self.flags.status_changed_to == "Completed":
if self.data.reference_doctype and self.data.reference_docname:
custom_redirect_to = None
try:
- custom_redirect_to = frappe.get_doc(self.data.reference_doctype,
- self.data.reference_docname).run_method("on_payment_authorized", self.flags.status_changed_to)
+ custom_redirect_to = frappe.get_doc(
+ self.data.reference_doctype, self.data.reference_docname
+ ).run_method("on_payment_authorized", self.flags.status_changed_to)
except Exception:
frappe.log_error(frappe.get_traceback())
if custom_redirect_to:
redirect_to = custom_redirect_to
- redirect_url = 'payment-success'
+ redirect_url = "payment-success"
if self.redirect_url:
redirect_url = self.redirect_url
redirect_to = None
else:
- redirect_url = 'payment-failed'
+ redirect_url = "payment-failed"
if redirect_to:
- redirect_url += '?' + urlencode({'redirect_to': redirect_to})
+ redirect_url += "?" + urlencode({"redirect_to": redirect_to})
if redirect_message:
- redirect_url += '&' + urlencode({'redirect_message': redirect_message})
+ redirect_url += "&" + urlencode({"redirect_message": redirect_message})
+
+ return {"redirect_to": redirect_url, "status": status}
- return {
- "redirect_to": redirect_url,
- "status": status
- }
def get_gateway_controller(doctype, docname):
reference_doc = frappe.get_doc(doctype, docname)
- gateway_controller = frappe.db.get_value("Payment Gateway", reference_doc.payment_gateway, "gateway_controller")
+ gateway_controller = frappe.db.get_value(
+ "Payment Gateway", reference_doc.payment_gateway, "gateway_controller"
+ )
return gateway_controller
diff --git a/frappe/integrations/doctype/stripe_settings/test_stripe_settings.py b/frappe/integrations/doctype/stripe_settings/test_stripe_settings.py
index e7113d3bd9..e13359fa6d 100644
--- a/frappe/integrations/doctype/stripe_settings/test_stripe_settings.py
+++ b/frappe/integrations/doctype/stripe_settings/test_stripe_settings.py
@@ -3,5 +3,6 @@
# License: MIT. See LICENSE
import unittest
+
class TestStripeSettings(unittest.TestCase):
pass
diff --git a/frappe/integrations/doctype/token_cache/test_token_cache.py b/frappe/integrations/doctype/token_cache/test_token_cache.py
index 5fe648d225..6a3b16e72c 100644
--- a/frappe/integrations/doctype/token_cache/test_token_cache.py
+++ b/frappe/integrations/doctype/token_cache/test_token_cache.py
@@ -2,28 +2,31 @@
# Copyright (c) 2019, Frappe Technologies and contributors
# License: MIT. See LICENSE
import unittest
+
import frappe
-test_dependencies = ['User', 'Connected App', 'Token Cache']
+test_dependencies = ["User", "Connected App", "Token Cache"]
-class TestTokenCache(unittest.TestCase):
+class TestTokenCache(unittest.TestCase):
def setUp(self):
- self.token_cache = frappe.get_last_doc('Token Cache')
- self.token_cache.update({'connected_app': frappe.get_last_doc('Connected App').name})
+ self.token_cache = frappe.get_last_doc("Token Cache")
+ self.token_cache.update({"connected_app": frappe.get_last_doc("Connected App").name})
self.token_cache.save(ignore_permissions=True)
def test_get_auth_header(self):
self.token_cache.get_auth_header()
def test_update_data(self):
- self.token_cache.update_data({
- 'access_token': 'new-access-token',
- 'refresh_token': 'new-refresh-token',
- 'token_type': 'bearer',
- 'expires_in': 2000,
- 'scope': 'new scope'
- })
+ self.token_cache.update_data(
+ {
+ "access_token": "new-access-token",
+ "refresh_token": "new-refresh-token",
+ "token_type": "bearer",
+ "expires_in": 2000,
+ "scope": "new scope",
+ }
+ )
def test_get_expires_in(self):
self.token_cache.get_expires_in()
diff --git a/frappe/integrations/doctype/token_cache/token_cache.py b/frappe/integrations/doctype/token_cache/token_cache.py
index ea86100cc2..7d961fe1cc 100644
--- a/frappe/integrations/doctype/token_cache/token_cache.py
+++ b/frappe/integrations/doctype/token_cache/token_cache.py
@@ -6,14 +6,14 @@ from datetime import datetime, timedelta
import frappe
from frappe import _
-from frappe.utils import cstr, cint
from frappe.model.document import Document
+from frappe.utils import cint, cstr
-class TokenCache(Document):
+class TokenCache(Document):
def get_auth_header(self):
if self.access_token:
- headers = {'Authorization': 'Bearer ' + self.get_password('access_token')}
+ headers = {"Authorization": "Bearer " + self.get_password("access_token")}
return headers
raise frappe.exceptions.DoesNotExistError
@@ -25,25 +25,25 @@ class TokenCache(Document):
Params:
data - Dict with access_token, refresh_token, expires_in and scope.
"""
- token_type = cstr(data.get('token_type', '')).lower()
- if token_type not in ['bearer', 'mac']:
- frappe.throw(_('Received an invalid token type.'))
+ token_type = cstr(data.get("token_type", "")).lower()
+ if token_type not in ["bearer", "mac"]:
+ frappe.throw(_("Received an invalid token type."))
# 'Bearer' or 'MAC'
- token_type = token_type.title() if token_type == 'bearer' else token_type.upper()
+ token_type = token_type.title() if token_type == "bearer" else token_type.upper()
self.token_type = token_type
- self.access_token = cstr(data.get('access_token', ''))
- self.refresh_token = cstr(data.get('refresh_token', ''))
- self.expires_in = cint(data.get('expires_in', 0))
+ self.access_token = cstr(data.get("access_token", ""))
+ self.refresh_token = cstr(data.get("refresh_token", ""))
+ self.expires_in = cint(data.get("expires_in", 0))
- new_scopes = data.get('scope')
+ new_scopes = data.get("scope")
if new_scopes:
if isinstance(new_scopes, str):
- new_scopes = new_scopes.split(' ')
+ new_scopes = new_scopes.split(" ")
if isinstance(new_scopes, list):
self.scopes = None
for scope in new_scopes:
- self.append('scopes', {'scope': scope})
+ self.append("scopes", {"scope": scope})
self.state = None
self.save(ignore_permissions=True)
@@ -59,8 +59,8 @@ class TokenCache(Document):
def get_json(self):
return {
- 'access_token': self.get_password('access_token', ''),
- 'refresh_token': self.get_password('refresh_token', ''),
- 'expires_in': self.get_expires_in(),
- 'token_type': self.token_type
+ "access_token": self.get_password("access_token", ""),
+ "refresh_token": self.get_password("refresh_token", ""),
+ "expires_in": self.get_expires_in(),
+ "token_type": self.token_type,
}
diff --git a/frappe/integrations/doctype/webhook/__init__.py b/frappe/integrations/doctype/webhook/__init__.py
index cb7a9963b7..915d2819ee 100644
--- a/frappe/integrations/doctype/webhook/__init__.py
+++ b/frappe/integrations/doctype/webhook/__init__.py
@@ -6,8 +6,13 @@ import frappe
def run_webhooks(doc, method):
- '''Run webhooks for this method'''
- if frappe.flags.in_import or frappe.flags.in_patch or frappe.flags.in_install or frappe.flags.in_migrate:
+ """Run webhooks for this method"""
+ if (
+ frappe.flags.in_import
+ or frappe.flags.in_patch
+ or frappe.flags.in_install
+ or frappe.flags.in_migrate
+ ):
return
if frappe.flags.webhooks_executed is None:
@@ -15,19 +20,20 @@ def run_webhooks(doc, method):
if frappe.flags.webhooks is None:
# load webhooks from cache
- webhooks = frappe.cache().get_value('webhooks')
+ webhooks = frappe.cache().get_value("webhooks")
if webhooks is None:
# query webhooks
- webhooks_list = frappe.get_all('Webhook',
- fields=["name", "`condition`", "webhook_docevent", "webhook_doctype"],
- filters={"enabled": True}
- )
+ webhooks_list = frappe.get_all(
+ "Webhook",
+ fields=["name", "`condition`", "webhook_docevent", "webhook_doctype"],
+ filters={"enabled": True},
+ )
# make webhooks map for cache
webhooks = {}
for w in webhooks_list:
webhooks.setdefault(w.webhook_doctype, []).append(w)
- frappe.cache().set_value('webhooks', webhooks)
+ frappe.cache().set_value("webhooks", webhooks)
frappe.flags.webhooks = webhooks
@@ -40,8 +46,12 @@ def run_webhooks(doc, method):
def _webhook_request(webhook):
if webhook.name not in frappe.flags.webhooks_executed.get(doc.name, []):
- frappe.enqueue("frappe.integrations.doctype.webhook.webhook.enqueue_webhook",
- enqueue_after_commit=True, doc=doc, webhook=webhook)
+ frappe.enqueue(
+ "frappe.integrations.doctype.webhook.webhook.enqueue_webhook",
+ enqueue_after_commit=True,
+ doc=doc,
+ webhook=webhook,
+ )
# keep list of webhooks executed for this doc in this request
# so that we don't run the same webhook for the same document multiple times
@@ -52,8 +62,8 @@ def run_webhooks(doc, method):
if not doc.flags.in_insert:
# value change is not applicable in insert
- event_list.append('on_change')
- event_list.append('before_update_after_submit')
+ event_list.append("on_change")
+ event_list.append("before_update_after_submit")
from frappe.integrations.doctype.webhook.webhook import get_context
diff --git a/frappe/integrations/doctype/webhook/test_webhook.py b/frappe/integrations/doctype/webhook/test_webhook.py
index a1176aa38b..5386a75573 100644
--- a/frappe/integrations/doctype/webhook/test_webhook.py
+++ b/frappe/integrations/doctype/webhook/test_webhook.py
@@ -4,7 +4,11 @@
import unittest
import frappe
-from frappe.integrations.doctype.webhook.webhook import get_webhook_headers, get_webhook_data, enqueue_webhook
+from frappe.integrations.doctype.webhook.webhook import (
+ enqueue_webhook,
+ get_webhook_data,
+ get_webhook_headers,
+)
class TestWebhook(unittest.TestCase):
@@ -25,15 +29,15 @@ class TestWebhook(unittest.TestCase):
"webhook_docevent": "after_insert",
"request_url": "https://httpbin.org/post",
"condition": "doc.email",
- "enabled": True
+ "enabled": True,
},
{
"webhook_doctype": "User",
"webhook_docevent": "after_insert",
"request_url": "https://httpbin.org/post",
"condition": "doc.first_name",
- "enabled": False
- }
+ "enabled": False,
+ },
]
cls.sample_webhooks = []
@@ -53,7 +57,7 @@ class TestWebhook(unittest.TestCase):
webhook_fields = {
"webhook_doctype": "User",
"webhook_docevent": "after_insert",
- "request_url": "https://httpbin.org/post"
+ "request_url": "https://httpbin.org/post",
}
if frappe.db.exists("Webhook", webhook_fields):
@@ -81,7 +85,7 @@ class TestWebhook(unittest.TestCase):
def test_webhook_trigger_with_enabled_webhooks(self):
"""Test webhook trigger for enabled webhooks"""
- frappe.cache().delete_value('webhooks')
+ frappe.cache().delete_value("webhooks")
frappe.flags.webhooks = None
# Insert the user to db
@@ -89,14 +93,10 @@ class TestWebhook(unittest.TestCase):
self.assertTrue("User" in frappe.flags.webhooks)
# only 1 hook (enabled) must be queued
- self.assertEqual(
- len(frappe.flags.webhooks.get("User")),
- 1
- )
+ self.assertEqual(len(frappe.flags.webhooks.get("User")), 1)
self.assertTrue(self.test_user.email in frappe.flags.webhooks_executed)
self.assertEqual(
- frappe.flags.webhooks_executed.get(self.test_user.email)[0],
- self.sample_webhooks[0].name
+ frappe.flags.webhooks_executed.get(self.test_user.email)[0], self.sample_webhooks[0].name
)
def test_validate_doc_events(self):
@@ -115,18 +115,13 @@ class TestWebhook(unittest.TestCase):
"Test validation for request headers"
# test incomplete headers
- self.webhook.set("webhook_headers", [{
- "key": "Content-Type"
- }])
+ self.webhook.set("webhook_headers", [{"key": "Content-Type"}])
self.webhook.save()
headers = get_webhook_headers(doc=None, webhook=self.webhook)
self.assertEqual(headers, {})
# test complete headers
- self.webhook.set("webhook_headers", [{
- "key": "Content-Type",
- "value": "application/json"
- }])
+ self.webhook.set("webhook_headers", [{"key": "Content-Type", "value": "application/json"}])
self.webhook.save()
headers = get_webhook_headers(doc=None, webhook=self.webhook)
self.assertEqual(headers, {"Content-Type": "application/json"})
@@ -135,10 +130,7 @@ class TestWebhook(unittest.TestCase):
"Test validation of Form URL-Encoded request body"
self.webhook.request_structure = "Form URL-Encoded"
- self.webhook.set("webhook_data", [{
- "fieldname": "name",
- "key": "name"
- }])
+ self.webhook.set("webhook_data", [{"fieldname": "name", "key": "name"}])
self.webhook.webhook_json = """{
"name": "{{ doc.name }}"
}"""
@@ -152,10 +144,7 @@ class TestWebhook(unittest.TestCase):
"Test validation of JSON request body"
self.webhook.request_structure = "JSON"
- self.webhook.set("webhook_data", [{
- "fieldname": "name",
- "key": "name"
- }])
+ self.webhook.set("webhook_data", [{"fieldname": "name", "key": "name"}])
self.webhook.webhook_json = """{
"name": "{{ doc.name }}"
}"""
@@ -166,16 +155,14 @@ class TestWebhook(unittest.TestCase):
self.assertEqual(data, {"name": self.user.name})
def test_webhook_req_log_creation(self):
- if not frappe.db.get_value('User', 'user2@integration.webhooks.test.com'):
- user = frappe.get_doc({
- 'doctype': 'User',
- 'email': 'user2@integration.webhooks.test.com',
- 'first_name': 'user2'
- }).insert()
+ if not frappe.db.get_value("User", "user2@integration.webhooks.test.com"):
+ user = frappe.get_doc(
+ {"doctype": "User", "email": "user2@integration.webhooks.test.com", "first_name": "user2"}
+ ).insert()
else:
- user = frappe.get_doc('User', 'user2@integration.webhooks.test.com')
+ user = frappe.get_doc("User", "user2@integration.webhooks.test.com")
- webhook = frappe.get_doc('Webhook', {'webhook_doctype': 'User'})
+ webhook = frappe.get_doc("Webhook", {"webhook_doctype": "User"})
enqueue_webhook(user, webhook)
- self.assertTrue(frappe.db.get_all('Webhook Request Log', pluck='name'))
\ No newline at end of file
+ self.assertTrue(frappe.db.get_all("Webhook Request Log", pluck="name"))
diff --git a/frappe/integrations/doctype/webhook/webhook.py b/frappe/integrations/doctype/webhook/webhook.py
index 8546a9d2f8..04a1c6c21e 100644
--- a/frappe/integrations/doctype/webhook/webhook.py
+++ b/frappe/integrations/doctype/webhook/webhook.py
@@ -8,9 +8,9 @@ import hashlib
import hmac
import json
from time import sleep
+from urllib.parse import urlparse
import requests
-from urllib.parse import urlparse
import frappe
from frappe import _
@@ -30,12 +30,16 @@ class Webhook(Document):
self.validate_repeating_fields()
def on_update(self):
- frappe.cache().delete_value('webhooks')
+ frappe.cache().delete_value("webhooks")
def validate_docevent(self):
if self.webhook_doctype:
is_submittable = frappe.get_value("DocType", self.webhook_doctype, "is_submittable")
- if not is_submittable and self.webhook_docevent in ["on_submit", "on_cancel", "on_update_after_submit"]:
+ if not is_submittable and self.webhook_docevent in [
+ "on_submit",
+ "on_cancel",
+ "on_update_after_submit",
+ ]:
frappe.throw(_("DocType must be Submittable for the selected Doc Event"))
def validate_condition(self):
@@ -73,7 +77,8 @@ class Webhook(Document):
def get_context(doc):
- return {'doc': doc, 'utils': get_safe_globals().get('frappe').get('utils')}
+ return {"doc": doc, "utils": get_safe_globals().get("frappe").get("utils")}
+
def enqueue_webhook(doc, webhook):
webhook = frappe.get_doc("Webhook", webhook.get("name"))
@@ -82,8 +87,13 @@ def enqueue_webhook(doc, webhook):
for i in range(3):
try:
- r = requests.request(method=webhook.request_method, url=webhook.request_url,
- data=json.dumps(data, default=str), headers=headers, timeout=5)
+ r = requests.request(
+ method=webhook.request_method,
+ url=webhook.request_url,
+ data=json.dumps(data, default=str),
+ headers=headers,
+ timeout=5,
+ )
r.raise_for_status()
frappe.logger().debug({"webhook_success": r.text})
log_request(webhook.request_url, headers, data, r)
@@ -97,18 +107,22 @@ def enqueue_webhook(doc, webhook):
else:
raise e
+
def log_request(url, headers, data, res):
- request_log = frappe.get_doc({
- "doctype": "Webhook Request Log",
- "user": frappe.session.user if frappe.session.user else None,
- "url": url,
- "headers": json.dumps(headers, indent=4) if headers else None,
- "data": json.dumps(data, indent=4) if isinstance(data, dict) else data,
- "response": json.dumps(res.json(), indent=4) if res else None
- })
+ request_log = frappe.get_doc(
+ {
+ "doctype": "Webhook Request Log",
+ "user": frappe.session.user if frappe.session.user else None,
+ "url": url,
+ "headers": json.dumps(headers, indent=4) if headers else None,
+ "data": json.dumps(data, indent=4) if isinstance(data, dict) else data,
+ "response": json.dumps(res.json(), indent=4) if res else None,
+ }
+ )
request_log.save(ignore_permissions=True)
+
def get_webhook_headers(doc, webhook):
headers = {}
@@ -118,7 +132,7 @@ def get_webhook_headers(doc, webhook):
hmac.new(
webhook.get_password("webhook_secret").encode("utf8"),
json.dumps(data).encode("utf8"),
- hashlib.sha256
+ hashlib.sha256,
).digest()
)
headers[WEBHOOK_SECRET_HEADER] = signature
diff --git a/frappe/integrations/doctype/webhook_data/webhook_data.py b/frappe/integrations/doctype/webhook_data/webhook_data.py
index 6037ed5390..1bb0d901df 100644
--- a/frappe/integrations/doctype/webhook_data/webhook_data.py
+++ b/frappe/integrations/doctype/webhook_data/webhook_data.py
@@ -5,5 +5,6 @@
# import frappe
from frappe.model.document import Document
+
class WebhookData(Document):
pass
diff --git a/frappe/integrations/doctype/webhook_header/webhook_header.py b/frappe/integrations/doctype/webhook_header/webhook_header.py
index e1944c84bc..9478d227e4 100644
--- a/frappe/integrations/doctype/webhook_header/webhook_header.py
+++ b/frappe/integrations/doctype/webhook_header/webhook_header.py
@@ -5,5 +5,6 @@
# import frappe
from frappe.model.document import Document
+
class WebhookHeader(Document):
pass
diff --git a/frappe/integrations/doctype/webhook_request_log/test_webhook_request_log.py b/frappe/integrations/doctype/webhook_request_log/test_webhook_request_log.py
index 5de26a35ed..e3ad5a88a4 100644
--- a/frappe/integrations/doctype/webhook_request_log/test_webhook_request_log.py
+++ b/frappe/integrations/doctype/webhook_request_log/test_webhook_request_log.py
@@ -4,5 +4,6 @@
# import frappe
import unittest
+
class TestWebhookRequestLog(unittest.TestCase):
pass
diff --git a/frappe/integrations/doctype/webhook_request_log/webhook_request_log.py b/frappe/integrations/doctype/webhook_request_log/webhook_request_log.py
index 3f0558ce80..8fbc73f5e5 100644
--- a/frappe/integrations/doctype/webhook_request_log/webhook_request_log.py
+++ b/frappe/integrations/doctype/webhook_request_log/webhook_request_log.py
@@ -4,5 +4,6 @@
# import frappe
from frappe.model.document import Document
+
class WebhookRequestLog(Document):
pass
diff --git a/frappe/integrations/frappe_providers/frappecloud.py b/frappe/integrations/frappe_providers/frappecloud.py
index f60344ee8f..0a01989d5e 100644
--- a/frappe/integrations/frappe_providers/frappecloud.py
+++ b/frappe/integrations/frappe_providers/frappecloud.py
@@ -12,15 +12,22 @@ def frappecloud_migrator(local_site):
request = requests.get(request_url)
if request.status_code / 100 != 2:
- print("Request exitted with Status Code: {}\nPayload: {}".format(request.status_code, html2text(request.text)))
- click.secho("Some errors occurred while recovering the migration script. Please contact us @ Frappe Cloud if this issue persists", fg="yellow")
+ print(
+ "Request exitted with Status Code: {}\nPayload: {}".format(
+ request.status_code, html2text(request.text)
+ )
+ )
+ click.secho(
+ "Some errors occurred while recovering the migration script. Please contact us @ Frappe Cloud if this issue persists",
+ fg="yellow",
+ )
return
script_contents = request.json()["message"]
- import tempfile
import os
import sys
+ import tempfile
py = sys.executable
script = tempfile.NamedTemporaryFile(mode="w")
diff --git a/frappe/integrations/oauth2.py b/frappe/integrations/oauth2.py
index 2b227f503d..39f98e2f1b 100644
--- a/frappe/integrations/oauth2.py
+++ b/frappe/integrations/oauth2.py
@@ -1,9 +1,8 @@
import json
from urllib.parse import quote, urlencode
+
from oauthlib.oauth2 import FatalClientError, OAuth2Error
-from oauthlib.openid.connect.core.endpoints.pre_configured import (
- Server as WebApplicationServer,
-)
+from oauthlib.openid.connect.core.endpoints.pre_configured import Server as WebApplicationServer
import frappe
from frappe.integrations.doctype.oauth_provider_settings.oauth_provider_settings import (
@@ -50,10 +49,7 @@ def approve(*args, **kwargs):
r = frappe.request
try:
- (
- scopes,
- frappe.flags.oauth_credentials,
- ) = get_oauth_server().validate_authorization_request(
+ (scopes, frappe.flags.oauth_credentials,) = get_oauth_server().validate_authorization_request(
r.url, r.method, r.get_data(), r.headers
)
@@ -90,10 +86,7 @@ def authorize(**kwargs):
else:
try:
r = frappe.request
- (
- scopes,
- frappe.flags.oauth_credentials,
- ) = get_oauth_server().validate_authorization_request(
+ (scopes, frappe.flags.oauth_credentials,) = get_oauth_server().validate_authorization_request(
r.url, r.method, r.get_data(), r.headers
)
@@ -102,22 +95,16 @@ def authorize(**kwargs):
frappe.flags.oauth_credentials["client_id"],
"skip_authorization",
)
- unrevoked_tokens = frappe.get_all(
- "OAuth Bearer Token", filters={"status": "Active"}
- )
+ unrevoked_tokens = frappe.get_all("OAuth Bearer Token", filters={"status": "Active"})
- if skip_auth or (
- get_oauth_settings().skip_authorization == "Auto" and unrevoked_tokens
- ):
+ if skip_auth or (get_oauth_settings().skip_authorization == "Auto" and unrevoked_tokens):
frappe.local.response["type"] = "redirect"
frappe.local.response["location"] = success_url
else:
# Show Allow/Deny screen.
response_html_params = frappe._dict(
{
- "client_id": frappe.db.get_value(
- "OAuth Client", kwargs["client_id"], "app_name"
- ),
+ "client_id": frappe.db.get_value("OAuth Client", kwargs["client_id"], "app_name"),
"success_url": success_url,
"failure_url": failure_url,
"details": scopes,
@@ -222,9 +209,7 @@ def introspect_token(token=None, token_type_hint=None):
if token_type_hint == "access_token":
bearer_token = frappe.get_doc("OAuth Bearer Token", {"access_token": token})
elif token_type_hint == "refresh_token":
- bearer_token = frappe.get_doc(
- "OAuth Bearer Token", {"refresh_token": token}
- )
+ bearer_token = frappe.get_doc("OAuth Bearer Token", {"refresh_token": token})
client = frappe.get_doc("OAuth Client", bearer_token.client)
diff --git a/frappe/integrations/oauth2_logins.py b/frappe/integrations/oauth2_logins.py
index b187d29b34..c8252b0f70 100644
--- a/frappe/integrations/oauth2_logins.py
+++ b/frappe/integrations/oauth2_logins.py
@@ -1,39 +1,48 @@
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
+import json
+
import frappe
import frappe.utils
from frappe.utils.oauth import login_via_oauth2, login_via_oauth2_id_token
-import json
+
@frappe.whitelist(allow_guest=True)
def login_via_google(code, state):
login_via_oauth2("google", code, state, decoder=decoder_compat)
+
@frappe.whitelist(allow_guest=True)
def login_via_github(code, state):
login_via_oauth2("github", code, state)
+
@frappe.whitelist(allow_guest=True)
def login_via_facebook(code, state):
login_via_oauth2("facebook", code, state, decoder=decoder_compat)
+
@frappe.whitelist(allow_guest=True)
def login_via_frappe(code, state):
login_via_oauth2("frappe", code, state, decoder=decoder_compat)
+
@frappe.whitelist(allow_guest=True)
def login_via_office365(code, state):
login_via_oauth2_id_token("office_365", code, state, decoder=decoder_compat)
+
@frappe.whitelist(allow_guest=True)
def login_via_salesforce(code, state):
login_via_oauth2("salesforce", code, state, decoder=decoder_compat)
+
@frappe.whitelist(allow_guest=True)
def login_via_fairlogin(code, state):
login_via_oauth2("fairlogin", code, state, decoder=decoder_compat)
+
@frappe.whitelist(allow_guest=True)
def custom(code, state):
"""
@@ -48,6 +57,7 @@ def custom(code, state):
if frappe.db.exists("Social Login Key", provider):
login_via_oauth2(provider, code, state, decoder=decoder_compat)
+
def decoder_compat(b):
# https://github.com/litl/rauth/issues/145#issuecomment-31199471
return json.loads(bytes(b).decode("utf-8"))
diff --git a/frappe/integrations/offsite_backup_utils.py b/frappe/integrations/offsite_backup_utils.py
index 4242676d94..307f1525fe 100644
--- a/frappe/integrations/offsite_backup_utils.py
+++ b/frappe/integrations/offsite_backup_utils.py
@@ -2,10 +2,12 @@
# Copyright (c) 2019, Frappe Technologies and contributors
# License: MIT. See LICENSE
-import frappe
import glob
import os
-from frappe.utils import split_emails, cint
+
+import frappe
+from frappe.utils import cint, split_emails
+
def send_email(success, service_name, doctype, email_field, error_status=None):
recipients = get_recipients(doctype, email_field)
@@ -65,7 +67,7 @@ def get_latest_backup_file(with_files=False):
return database, config
-def get_file_size(file_path, unit='MB'):
+def get_file_size(file_path, unit="MB"):
file_size = os.path.getsize(file_path)
memory_size_unit_mapper = {"KB": 1, "MB": 2, "GB": 3, "TB": 4}
@@ -76,10 +78,11 @@ def get_file_size(file_path, unit='MB'):
return file_size
+
def get_chunk_site(file_size):
- ''' this function will return chunk size in megabytes based on file size '''
+ """this function will return chunk size in megabytes based on file size"""
- file_size_in_gb = cint(file_size/1024/1024)
+ file_size_in_gb = cint(file_size / 1024 / 1024)
MB = 1024 * 1024
if file_size_in_gb > 5000:
@@ -93,6 +96,7 @@ def get_chunk_site(file_size):
else:
return 15 * MB
+
def validate_file_size():
frappe.flags.create_new_backup = True
latest_file, site_config = get_latest_backup_file()
@@ -101,12 +105,18 @@ def validate_file_size():
if file_size > 1:
frappe.flags.create_new_backup = False
+
def generate_files_backup():
from frappe.utils.backups import BackupGenerator
- backup = BackupGenerator(frappe.conf.db_name, frappe.conf.db_name,
- frappe.conf.db_password, db_host = frappe.db.host,
- db_type=frappe.conf.db_type, db_port=frappe.conf.db_port)
+ backup = BackupGenerator(
+ frappe.conf.db_name,
+ frappe.conf.db_name,
+ frappe.conf.db_password,
+ db_host=frappe.db.host,
+ db_type=frappe.conf.db_type,
+ db_port=frappe.conf.db_port,
+ )
backup.set_backup_file_name()
backup.zip_files()
diff --git a/frappe/integrations/utils.py b/frappe/integrations/utils.py
index bda45a765d..191cd1f23b 100644
--- a/frappe/integrations/utils.py
+++ b/frappe/integrations/utils.py
@@ -2,14 +2,17 @@
# Copyright (c) 2019, Frappe Technologies and contributors
# License: MIT. See LICENSE
-import frappe
-import json,datetime
+import datetime
+import json
from urllib.parse import parse_qs
-from frappe.utils import get_request_session
+
+import frappe
from frappe import _
+from frappe.utils import get_request_session
+
def make_request(method, url, auth=None, headers=None, data=None):
- auth = auth or ''
+ auth = auth or ""
data = data or {}
headers = headers or {}
@@ -26,14 +29,18 @@ def make_request(method, url, auth=None, headers=None, data=None):
frappe.log_error()
raise exc
+
def make_get_request(url, **kwargs):
- return make_request('GET', url, **kwargs)
+ return make_request("GET", url, **kwargs)
+
def make_post_request(url, **kwargs):
- return make_request('POST', url, **kwargs)
+ return make_request("POST", url, **kwargs)
+
def make_put_request(url, **kwargs):
- return make_request('PUT', url, **kwargs)
+ return make_request("PUT", url, **kwargs)
+
def create_request_log(data, integration_type, service_name, name=None, error=None):
if isinstance(data, str):
@@ -42,15 +49,17 @@ def create_request_log(data, integration_type, service_name, name=None, error=No
if isinstance(error, str):
error = json.loads(error)
- integration_request = frappe.get_doc({
- "doctype": "Integration Request",
- "integration_type": integration_type,
- "integration_request_service": service_name,
- "reference_doctype": data.get("reference_doctype"),
- "reference_docname": data.get("reference_docname"),
- "error": json.dumps(error, default=json_handler),
- "data": json.dumps(data, default=json_handler)
- })
+ integration_request = frappe.get_doc(
+ {
+ "doctype": "Integration Request",
+ "integration_type": integration_type,
+ "integration_request_service": service_name,
+ "reference_doctype": data.get("reference_doctype"),
+ "reference_docname": data.get("reference_docname"),
+ "error": json.dumps(error, default=json_handler),
+ "data": json.dumps(data, default=json_handler),
+ }
+ )
if name:
integration_request.flags._name = name
@@ -60,8 +69,9 @@ def create_request_log(data, integration_type, service_name, name=None, error=No
return integration_request
+
def get_payment_gateway_controller(payment_gateway):
- '''Return payment gateway controller'''
+ """Return payment gateway controller"""
gateway = frappe.get_doc("Payment Gateway", payment_gateway)
if gateway.gateway_controller is None:
try:
@@ -78,28 +88,36 @@ def get_payment_gateway_controller(payment_gateway):
@frappe.whitelist(allow_guest=True, xss_safe=True)
def get_checkout_url(**kwargs):
try:
- if kwargs.get('payment_gateway'):
- doc = frappe.get_doc("{0} Settings".format(kwargs.get('payment_gateway')))
+ if kwargs.get("payment_gateway"):
+ doc = frappe.get_doc("{0} Settings".format(kwargs.get("payment_gateway")))
return doc.get_payment_url(**kwargs)
else:
raise Exception
except Exception:
- frappe.respond_as_web_page(_("Something went wrong"),
- _("Looks like something is wrong with this site's payment gateway configuration. No payment has been made."),
- indicator_color='red',
- http_status_code=frappe.ValidationError.http_status_code)
+ frappe.respond_as_web_page(
+ _("Something went wrong"),
+ _(
+ "Looks like something is wrong with this site's payment gateway configuration. No payment has been made."
+ ),
+ indicator_color="red",
+ http_status_code=frappe.ValidationError.http_status_code,
+ )
+
def create_payment_gateway(gateway, settings=None, controller=None):
# NOTE: we don't translate Payment Gateway name because it is an internal doctype
if not frappe.db.exists("Payment Gateway", gateway):
- payment_gateway = frappe.get_doc({
- "doctype": "Payment Gateway",
- "gateway": gateway,
- "gateway_settings": settings,
- "gateway_controller": controller
- })
+ payment_gateway = frappe.get_doc(
+ {
+ "doctype": "Payment Gateway",
+ "gateway": gateway,
+ "gateway_settings": settings,
+ "gateway_controller": controller,
+ }
+ )
payment_gateway.insert(ignore_permissions=True)
+
def json_handler(obj):
if isinstance(obj, (datetime.date, datetime.timedelta, datetime.datetime)):
return str(obj)
diff --git a/frappe/middlewares.py b/frappe/middlewares.py
index 38cb4cea21..cd47b7210f 100644
--- a/frappe/middlewares.py
+++ b/frappe/middlewares.py
@@ -1,11 +1,13 @@
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
-import frappe
import os
+
from werkzeug.exceptions import NotFound
from werkzeug.middleware.shared_data import SharedDataMiddleware
-from frappe.utils import get_site_name, cstr
+
+import frappe
+from frappe.utils import cstr, get_site_name
class StaticDataMiddleware(SharedDataMiddleware):
@@ -15,8 +17,8 @@ class StaticDataMiddleware(SharedDataMiddleware):
def get_directory_loader(self, directory):
def loader(path):
- site = get_site_name(frappe.app._site or self.environ.get('HTTP_HOST'))
- path = os.path.join(directory, site, 'public', 'files', cstr(path))
+ site = get_site_name(frappe.app._site or self.environ.get("HTTP_HOST"))
+ path = os.path.join(directory, site, "public", "files", cstr(path))
if os.path.isfile(path):
return os.path.basename(path), self._opener(path)
else:
diff --git a/frappe/migrate.py b/frappe/migrate.py
index eabd0ff3e0..bb83fa5b6d 100644
--- a/frappe/migrate.py
+++ b/frappe/migrate.py
@@ -66,8 +66,7 @@ class SiteMigration:
self.skip_search_index = skip_search_index
def setUp(self):
- """Complete setup required for site migration
- """
+ """Complete setup required for site migration"""
frappe.flags.touched_tables = set()
self.touched_tables_file = frappe.get_site_path("touched_tables.json")
add_column(doctype="DocType", column_name="migration_hash", fieldtype="Data")
@@ -99,19 +98,21 @@ class SiteMigration:
@atomic
def pre_schema_updates(self):
- """Executes `before_migrate` hooks
- """
+ """Executes `before_migrate` hooks"""
for app in frappe.get_installed_apps():
for fn in frappe.get_hooks("before_migrate", app_name=app):
frappe.get_attr(fn)()
@atomic
def run_schema_updates(self):
- """Run patches as defined in patches.txt, sync schema changes as defined in the {doctype}.json files
- """
- frappe.modules.patch_handler.run_all(skip_failing=self.skip_failing, patch_type=PatchType.pre_model_sync)
+ """Run patches as defined in patches.txt, sync schema changes as defined in the {doctype}.json files"""
+ frappe.modules.patch_handler.run_all(
+ skip_failing=self.skip_failing, patch_type=PatchType.pre_model_sync
+ )
frappe.model.sync.sync_all()
- frappe.modules.patch_handler.run_all(skip_failing=self.skip_failing, patch_type=PatchType.post_model_sync)
+ frappe.modules.patch_handler.run_all(
+ skip_failing=self.skip_failing, patch_type=PatchType.post_model_sync
+ )
@atomic
def post_schema_updates(self):
diff --git a/frappe/model/__init__.py b/frappe/model/__init__.py
index ab792d90e5..6c9bab2dff 100644
--- a/frappe/model/__init__.py
+++ b/frappe/model/__init__.py
@@ -5,180 +5,163 @@
import frappe
data_fieldtypes = (
- 'Currency',
- 'Int',
- 'Long Int',
- 'Float',
- 'Percent',
- 'Check',
- 'Small Text',
- 'Long Text',
- 'Code',
- 'Text Editor',
- 'Markdown Editor',
- 'HTML Editor',
- 'Date',
- 'Datetime',
- 'Time',
- 'Text',
- 'Data',
- 'Link',
- 'Dynamic Link',
- 'Password',
- 'Select',
- 'Rating',
- 'Read Only',
- 'Attach',
- 'Attach Image',
- 'Signature',
- 'Color',
- 'Barcode',
- 'Geolocation',
- 'Duration',
- 'Icon',
- 'Autocomplete',
+ "Currency",
+ "Int",
+ "Long Int",
+ "Float",
+ "Percent",
+ "Check",
+ "Small Text",
+ "Long Text",
+ "Code",
+ "Text Editor",
+ "Markdown Editor",
+ "HTML Editor",
+ "Date",
+ "Datetime",
+ "Time",
+ "Text",
+ "Data",
+ "Link",
+ "Dynamic Link",
+ "Password",
+ "Select",
+ "Rating",
+ "Read Only",
+ "Attach",
+ "Attach Image",
+ "Signature",
+ "Color",
+ "Barcode",
+ "Geolocation",
+ "Duration",
+ "Icon",
+ "Autocomplete",
)
attachment_fieldtypes = (
- 'Attach',
- 'Attach Image',
+ "Attach",
+ "Attach Image",
)
no_value_fields = (
- 'Section Break',
- 'Column Break',
- 'Tab Break',
- 'HTML',
- 'Table',
- 'Table MultiSelect',
- 'Button',
- 'Image',
- 'Fold',
- 'Heading'
+ "Section Break",
+ "Column Break",
+ "Tab Break",
+ "HTML",
+ "Table",
+ "Table MultiSelect",
+ "Button",
+ "Image",
+ "Fold",
+ "Heading",
)
display_fieldtypes = (
- 'Section Break',
- 'Column Break',
- 'Tab Break',
- 'HTML',
- 'Button',
- 'Image',
- 'Fold',
- 'Heading')
-
-numeric_fieldtypes = (
- 'Currency',
- 'Int',
- 'Long Int',
- 'Float',
- 'Percent',
- 'Check'
+ "Section Break",
+ "Column Break",
+ "Tab Break",
+ "HTML",
+ "Button",
+ "Image",
+ "Fold",
+ "Heading",
)
-data_field_options = (
- 'Email',
- 'Name',
- 'Phone',
- 'URL',
- 'Barcode'
-)
+numeric_fieldtypes = ("Currency", "Int", "Long Int", "Float", "Percent", "Check")
+
+data_field_options = ("Email", "Name", "Phone", "URL", "Barcode")
default_fields = (
- 'doctype',
- 'name',
- 'owner',
- 'creation',
- 'modified',
- 'modified_by',
- 'docstatus',
- 'idx'
+ "doctype",
+ "name",
+ "owner",
+ "creation",
+ "modified",
+ "modified_by",
+ "docstatus",
+ "idx",
)
-child_table_fields = (
- 'parent',
- 'parentfield',
- 'parenttype'
-)
+child_table_fields = ("parent", "parentfield", "parenttype")
-optional_fields = (
- "_user_tags",
- "_comments",
- "_assign",
- "_liked_by",
- "_seen"
-)
+optional_fields = ("_user_tags", "_comments", "_assign", "_liked_by", "_seen")
-table_fields = (
- 'Table',
- 'Table MultiSelect'
-)
+table_fields = ("Table", "Table MultiSelect")
core_doctypes_list = (
- 'DocType',
- 'DocField',
- 'DocPerm',
- 'DocType Action',
- 'DocType Link',
- 'User',
- 'Role',
- 'Has Role',
- 'Page',
- 'Module Def',
- 'Print Format',
- 'Report',
- 'Customize Form',
- 'Customize Form Field',
- 'Property Setter',
- 'Custom Field',
- 'Client Script'
+ "DocType",
+ "DocField",
+ "DocPerm",
+ "DocType Action",
+ "DocType Link",
+ "User",
+ "Role",
+ "Has Role",
+ "Page",
+ "Module Def",
+ "Print Format",
+ "Report",
+ "Customize Form",
+ "Customize Form Field",
+ "Property Setter",
+ "Custom Field",
+ "Client Script",
)
log_types = (
- 'Version',
- 'Error Log',
- 'Scheduled Job Log',
- 'Event Sync Log',
- 'Event Update Log',
- 'Access Log',
- 'View Log',
- 'Activity Log',
- 'Energy Point Log',
- 'Notification Log',
- 'Email Queue',
- 'DocShare',
- 'Document Follow',
- 'Console Log'
+ "Version",
+ "Error Log",
+ "Scheduled Job Log",
+ "Event Sync Log",
+ "Event Update Log",
+ "Access Log",
+ "View Log",
+ "Activity Log",
+ "Energy Point Log",
+ "Notification Log",
+ "Email Queue",
+ "DocShare",
+ "Document Follow",
+ "Console Log",
)
+
def delete_fields(args_dict, delete=0):
"""
- Delete a field.
- * Deletes record from `tabDocField`
- * If not single doctype: Drops column from table
- * If single, deletes record from `tabSingles`
- args_dict = { dt: [field names] }
+ Delete a field.
+ * Deletes record from `tabDocField`
+ * If not single doctype: Drops column from table
+ * If single, deletes record from `tabSingles`
+ args_dict = { dt: [field names] }
"""
import frappe.utils
+
for dt in args_dict:
fields = args_dict[dt]
if not fields:
continue
- frappe.db.delete("DocField", {
- "parent": dt,
- "fieldname": ("in", fields),
- })
+ frappe.db.delete(
+ "DocField",
+ {
+ "parent": dt,
+ "fieldname": ("in", fields),
+ },
+ )
# Delete the data/column only if delete is specified
if not delete:
continue
if frappe.db.get_value("DocType", dt, "issingle"):
- frappe.db.delete("Singles", {
- "doctype": dt,
- "field": ("in", fields),
- })
+ frappe.db.delete(
+ "Singles",
+ {
+ "doctype": dt,
+ "field": ("in", fields),
+ },
+ )
else:
existing_fields = frappe.db.describe(dt)
existing_fields = existing_fields and [e[0] for e in existing_fields] or []
@@ -186,14 +169,15 @@ def delete_fields(args_dict, delete=0):
if not fields_need_to_delete:
continue
- if frappe.db.db_type == 'mariadb':
+ if frappe.db.db_type == "mariadb":
# mariadb implicitly commits before DDL, make it explicit
frappe.db.commit()
- query = "ALTER TABLE `tab%s` " % dt + \
- ", ".join("DROP COLUMN `%s`" % f for f in fields_need_to_delete)
+ query = "ALTER TABLE `tab%s` " % dt + ", ".join(
+ "DROP COLUMN `%s`" % f for f in fields_need_to_delete
+ )
frappe.db.sql(query)
- if frappe.db.db_type == 'postgres':
+ if frappe.db.db_type == "postgres":
# commit the results to db
frappe.db.commit()
diff --git a/frappe/model/base_document.py b/frappe/model/base_document.py
index 57591d01d5..59c631eb95 100644
--- a/frappe/model/base_document.py
+++ b/frappe/model/base_document.py
@@ -5,20 +5,16 @@ import datetime
import frappe
from frappe import _
from frappe.model import child_table_fields, default_fields, display_fieldtypes, table_fields
+from frappe.model.docstatus import DocStatus
from frappe.model.naming import set_new_name
from frappe.model.utils.link_count import notify_link_count
from frappe.modules import load_doctype_module
from frappe.utils import cast_fieldtype, cint, cstr, flt, now, sanitize_html, strip_html
from frappe.utils.html_utils import unescape_html
-from frappe.model.docstatus import DocStatus
-max_positive_value = {
- 'smallint': 2 ** 15,
- 'int': 2 ** 31,
- 'bigint': 2 ** 63
-}
+max_positive_value = {"smallint": 2**15, "int": 2**31, "bigint": 2**63}
-DOCTYPES_FOR_DOCTYPE = ('DocType', 'DocField', 'DocPerm', 'DocType Action', 'DocType Link')
+DOCTYPES_FOR_DOCTYPE = ("DocType", "DocField", "DocPerm", "DocType Action", "DocType Link")
def get_controller(doctype):
@@ -36,18 +32,18 @@ def get_controller(doctype):
) or ("Core", False)
if custom:
- is_tree = frappe.db.get_value(
- "DocType", doctype, "is_tree", ignore=True, cache=True
- )
+ is_tree = frappe.db.get_value("DocType", doctype, "is_tree", ignore=True, cache=True)
_class = NestedSet if is_tree else Document
else:
- class_overrides = frappe.get_hooks('override_doctype_class')
+ class_overrides = frappe.get_hooks("override_doctype_class")
if class_overrides and class_overrides.get(doctype):
import_path = class_overrides[doctype][-1]
- module_path, classname = import_path.rsplit('.', 1)
+ module_path, classname = import_path.rsplit(".", 1)
module = frappe.get_module(module_path)
if not hasattr(module, classname):
- raise ImportError('{0}: {1} does not exist in module {2}'.format(doctype, classname, module_path))
+ raise ImportError(
+ "{0}: {1} does not exist in module {2}".format(doctype, classname, module_path)
+ )
else:
module = load_doctype_module(doctype, module_name)
classname = doctype.replace(" ", "").replace("-", "")
@@ -71,6 +67,7 @@ def get_controller(doctype):
return site_controllers[doctype]
+
class BaseDocument(object):
ignore_in_setter = ("doctype", "_meta", "meta", "_table_fields", "_valid_columns")
@@ -96,13 +93,13 @@ class BaseDocument(object):
return self.__dict__
def update(self, d):
- """ Update multiple fields of a doctype using a dictionary of key-value pairs.
+ """Update multiple fields of a doctype using a dictionary of key-value pairs.
Example:
- doc.update({
- "user": "admin",
- "balance": 42000
- })
+ doc.update({
+ "user": "admin",
+ "balance": 42000
+ })
"""
# set name first, as it is used a reference in child document
@@ -146,9 +143,7 @@ class BaseDocument(object):
else:
value = self.__dict__.get(key, default)
- if value is None and key in (
- d.fieldname for d in self.meta.get_table_fields()
- ):
+ if value is None and key in (d.fieldname for d in self.meta.get_table_fields()):
value = []
self.set(key, value)
@@ -175,17 +170,17 @@ class BaseDocument(object):
del self.__dict__[key]
def append(self, key, value=None):
- """ Append an item to a child table.
+ """Append an item to a child table.
Example:
- doc.append("childtable", {
- "child_table_field": "value",
- "child_table_int_field": 0,
- ...
- })
+ doc.append("childtable", {
+ "child_table_field": "value",
+ "child_table_int_field": 0,
+ ...
+ })
"""
if value is None:
- value={}
+ value = {}
if isinstance(value, (dict, BaseDocument)):
if not self.__dict__.get(key):
self.__dict__[key] = []
@@ -201,13 +196,17 @@ class BaseDocument(object):
# metaclasses may have arbitrary lists
# which we can ignore
- if (getattr(self, '_metaclass', None)
- or self.__class__.__name__ in ('Meta', 'FormMeta', 'DocField')):
+ if getattr(self, "_metaclass", None) or self.__class__.__name__ in (
+ "Meta",
+ "FormMeta",
+ "DocField",
+ ):
return value
raise ValueError(
- 'Document for field "{0}" attached to child table of "{1}" must be a dict or BaseDocument, not {2} ({3})'.format(key,
- self.name, str(type(value))[1:-1], value)
+ 'Document for field "{0}" attached to child table of "{1}" must be a dict or BaseDocument, not {2} ({3})'.format(
+ key, self.name, str(type(value))[1:-1], value
+ )
)
def extend(self, key, value):
@@ -246,11 +245,13 @@ class BaseDocument(object):
value.idx = len(self.get(key) or []) + 1
if not getattr(value, "name", None):
- value.__dict__['__islocal'] = 1
+ value.__dict__["__islocal"] = 1
return value
- def get_valid_dict(self, sanitize=True, convert_dates_to_str=False, ignore_nulls=False, ignore_virtual=False):
+ def get_valid_dict(
+ self, sanitize=True, convert_dates_to_str=False, ignore_nulls=False, ignore_virtual=False
+ ):
d = frappe._dict()
for fieldname in self.meta.get_valid_columns():
d[fieldname] = self.get(fieldname)
@@ -280,31 +281,28 @@ class BaseDocument(object):
if _val and not callable(_val):
d[fieldname] = _val
elif df:
- if df.fieldtype=="Check":
+ if df.fieldtype == "Check":
d[fieldname] = 1 if cint(d[fieldname]) else 0
- elif df.fieldtype=="Int" and not isinstance(d[fieldname], int):
+ elif df.fieldtype == "Int" and not isinstance(d[fieldname], int):
d[fieldname] = cint(d[fieldname])
elif df.fieldtype in ("Currency", "Float", "Percent") and not isinstance(d[fieldname], float):
d[fieldname] = flt(d[fieldname])
- elif df.fieldtype in ("Datetime", "Date", "Time") and d[fieldname]=="":
+ elif df.fieldtype in ("Datetime", "Date", "Time") and d[fieldname] == "":
d[fieldname] = None
- elif df.get("unique") and cstr(d[fieldname]).strip()=="":
+ elif df.get("unique") and cstr(d[fieldname]).strip() == "":
# unique empty field should be set to None
d[fieldname] = None
if isinstance(d[fieldname], list) and df.fieldtype not in table_fields:
- frappe.throw(_('Value for {0} cannot be a list').format(_(df.label)))
-
- if convert_dates_to_str and isinstance(d[fieldname], (
- datetime.datetime,
- datetime.date,
- datetime.time,
- datetime.timedelta
- )):
+ frappe.throw(_("Value for {0} cannot be a list").format(_(df.label)))
+
+ if convert_dates_to_str and isinstance(
+ d[fieldname], (datetime.datetime, datetime.date, datetime.time, datetime.timedelta)
+ ):
d[fieldname] = str(d[fieldname])
if d[fieldname] is None and ignore_nulls:
@@ -331,6 +329,7 @@ class BaseDocument(object):
if self.doctype not in frappe.local.valid_columns:
if self.doctype in DOCTYPES_FOR_DOCTYPE:
from frappe.model.meta import get_table_columns
+
valid = get_table_columns(self.doctype)
else:
valid = self.meta.get_valid_columns()
@@ -350,7 +349,13 @@ class BaseDocument(object):
def docstatus(self, value):
self.__dict__["docstatus"] = DocStatus(cint(value))
- def as_dict(self, no_nulls=False, no_default_fields=False, convert_dates_to_str=False, no_child_table_fields=False):
+ def as_dict(
+ self,
+ no_nulls=False,
+ no_default_fields=False,
+ convert_dates_to_str=False,
+ no_child_table_fields=False,
+ ):
doc = self.get_valid_dict(convert_dates_to_str=convert_dates_to_str)
doc["doctype"] = self.doctype
@@ -361,8 +366,9 @@ class BaseDocument(object):
convert_dates_to_str=convert_dates_to_str,
no_nulls=no_nulls,
no_default_fields=no_default_fields,
- no_child_table_fields=no_child_table_fields
- ) for d in children
+ no_child_table_fields=no_child_table_fields,
+ )
+ for d in children
]
if no_nulls:
@@ -380,7 +386,14 @@ class BaseDocument(object):
if k in child_table_fields:
del doc[k]
- for key in ("_user_tags", "__islocal", "__onload", "_liked_by", "__run_link_triggers", "__unsaved"):
+ for key in (
+ "_user_tags",
+ "__islocal",
+ "__onload",
+ "_liked_by",
+ "__run_link_triggers",
+ "__unsaved",
+ ):
if self.get(key):
doc[key] = self.get(key)
@@ -393,21 +406,23 @@ class BaseDocument(object):
try:
return self.meta.get_field(fieldname).options
except AttributeError:
- if self.doctype == 'DocType':
- return dict(links='DocType Link', actions='DocType Action', states='DocType State').get(fieldname)
+ if self.doctype == "DocType":
+ return dict(links="DocType Link", actions="DocType Action", states="DocType State").get(
+ fieldname
+ )
raise
def get_parentfield_of_doctype(self, doctype):
- fieldname = [df.fieldname for df in self.meta.get_table_fields() if df.options==doctype]
+ fieldname = [df.fieldname for df in self.meta.get_table_fields() if df.options == doctype]
return fieldname[0] if fieldname else None
def db_insert(self, ignore_if_duplicate=False):
"""INSERT the document (with valid columns) in the database.
- args:
- ignore_if_duplicate: ignore primary key collision
- at database level (postgres)
- in python (mariadb)
+ args:
+ ignore_if_duplicate: ignore primary key collision
+ at database level (postgres)
+ in python (mariadb)
"""
if not self.name:
# name will be set by document class in most cases
@@ -432,16 +447,19 @@ class BaseDocument(object):
columns = list(d)
try:
- frappe.db.sql("""INSERT INTO `tab{doctype}` ({columns})
+ frappe.db.sql(
+ """INSERT INTO `tab{doctype}` ({columns})
VALUES ({values}) {conflict_handler}""".format(
doctype=self.doctype,
- columns=", ".join("`"+c+"`" for c in columns),
+ columns=", ".join("`" + c + "`" for c in columns),
values=", ".join(["%s"] * len(columns)),
- conflict_handler=conflict_handler
- ), list(d.values()))
+ conflict_handler=conflict_handler,
+ ),
+ list(d.values()),
+ )
except Exception as e:
if frappe.db.is_primary_key_violation(e):
- if self.meta.autoname=="hash":
+ if self.meta.autoname == "hash":
# hash collision? try again
frappe.flags.retry_count = (frappe.flags.retry_count or 0) + 1
if frappe.flags.retry_count > 5 and not frappe.flags.in_test:
@@ -451,9 +469,11 @@ class BaseDocument(object):
return
if not ignore_if_duplicate:
- frappe.msgprint(_("{0} {1} already exists")
- .format(self.doctype, frappe.bold(self.name)),
- title=_("Duplicate Name"), indicator="red")
+ frappe.msgprint(
+ _("{0} {1} already exists").format(self.doctype, frappe.bold(self.name)),
+ title=_("Duplicate Name"),
+ indicator="red",
+ )
raise frappe.DuplicateEntryError(self.doctype, self.name, e)
elif frappe.db.is_unique_key_violation(e):
@@ -470,20 +490,24 @@ class BaseDocument(object):
self.db_insert()
return
- d = self.get_valid_dict(convert_dates_to_str=True, ignore_nulls = self.doctype in DOCTYPES_FOR_DOCTYPE)
+ d = self.get_valid_dict(
+ convert_dates_to_str=True, ignore_nulls=self.doctype in DOCTYPES_FOR_DOCTYPE
+ )
# don't update name, as case might've been changed
- name = cstr(d['name'])
- del d['name']
+ name = cstr(d["name"])
+ del d["name"]
columns = list(d)
try:
- frappe.db.sql("""UPDATE `tab{doctype}`
+ frappe.db.sql(
+ """UPDATE `tab{doctype}`
SET {values} WHERE `name`=%s""".format(
- doctype = self.doctype,
- values = ", ".join("`"+c+"`=%s" for c in columns)
- ), list(d.values()) + [name])
+ doctype=self.doctype, values=", ".join("`" + c + "`=%s" for c in columns)
+ ),
+ list(d.values()) + [name],
+ )
except Exception as e:
if frappe.db.is_unique_key_violation(e):
self.show_unique_validation_message(e)
@@ -499,7 +523,7 @@ class BaseDocument(object):
doc.db_update()
def show_unique_validation_message(self, e):
- if frappe.db.db_type != 'postgres':
+ if frappe.db.db_type != "postgres":
fieldname = str(e).split("'")[-2]
label = None
@@ -521,15 +545,16 @@ class BaseDocument(object):
This function returns the `column_name` associated with the `key_name` passed
Args:
- key_name (str): The name of the database index.
+ key_name (str): The name of the database index.
Raises:
- IndexError: If the key is not found in the table.
+ IndexError: If the key is not found in the table.
Returns:
- str: The column name associated with the key.
+ str: The column name associated with the key.
"""
- return frappe.db.sql(f"""
+ return frappe.db.sql(
+ f"""
SHOW
INDEX
FROM
@@ -538,16 +563,19 @@ class BaseDocument(object):
key_name=%s
AND
Non_unique=0
- """, key_name, as_dict=True)[0].get("Column_name")
+ """,
+ key_name,
+ as_dict=True,
+ )[0].get("Column_name")
def get_label_from_fieldname(self, fieldname):
"""Returns the associated label for fieldname
Args:
- fieldname (str): The fieldname in the DocType to use to pull the label.
+ fieldname (str): The fieldname in the DocType to use to pull the label.
Returns:
- str: The label associated with the fieldname, if found, otherwise `None`.
+ str: The label associated with the fieldname, if found, otherwise `None`.
"""
df = self.meta.get_field(fieldname)
if df:
@@ -556,7 +584,7 @@ class BaseDocument(object):
def update_modified(self):
"""Update modified timestamp"""
self.set("modified", now())
- frappe.db.set_value(self.doctype, self.name, 'modified', self.modified, update_modified=False)
+ frappe.db.set_value(self.doctype, self.name, "modified", self.modified, update_modified=False)
def _fix_numeric_types(self):
for df in self.meta.get("fields"):
@@ -575,20 +603,27 @@ class BaseDocument(object):
def _get_missing_mandatory_fields(self):
"""Get mandatory fields that do not have any values"""
+
def get_msg(df):
if df.fieldtype in table_fields:
return "{}: {}: {}".format(_("Error"), _("Data missing in table"), _(df.label))
# check if parentfield exists (only applicable for child table doctype)
elif self.get("parentfield"):
- return "{}: {} {} #{}: {}: {}".format(_("Error"), frappe.bold(_(self.doctype)),
- _("Row"), self.idx, _("Value missing for"), _(df.label))
+ return "{}: {} {} #{}: {}: {}".format(
+ _("Error"),
+ frappe.bold(_(self.doctype)),
+ _("Row"),
+ self.idx,
+ _("Value missing for"),
+ _(df.label),
+ )
return _("Error: Value missing for {0}: {1}").format(_(df.parent), _(df.label))
missing = []
- for df in self.meta.get("fields", {"reqd": ('=', 1)}):
+ for df in self.meta.get("fields", {"reqd": ("=", 1)}):
if self.get(df.fieldname) in (None, []) or not strip_html(cstr(self.get(df.fieldname))).strip():
missing.append((df.fieldname, get_msg(df)))
@@ -602,6 +637,7 @@ class BaseDocument(object):
def get_invalid_links(self, is_submittable=False):
"""Returns list of invalid links and also updates fetch values if not set"""
+
def get_msg(df, docname):
# check if parentfield exists (only applicable for child table doctype)
if self.get("parentfield"):
@@ -612,12 +648,13 @@ class BaseDocument(object):
invalid_links = []
cancelled_links = []
- for df in (self.meta.get_link_fields()
- + self.meta.get("fields", {"fieldtype": ('=', "Dynamic Link")})):
+ for df in self.meta.get_link_fields() + self.meta.get(
+ "fields", {"fieldtype": ("=", "Dynamic Link")}
+ ):
docname = self.get(df.fieldname)
if docname:
- if df.fieldtype=="Link":
+ if df.fieldtype == "Link":
doctype = df.options
if not doctype:
frappe.throw(_("Options not set for link field {0}").format(df.fieldname))
@@ -633,28 +670,25 @@ class BaseDocument(object):
# Readonly or Data or Text type fields
fields_to_fetch = [
- _df for _df in self.meta.get_fields_to_fetch(df.fieldname)
- if
- not _df.get('fetch_if_empty')
- or (_df.get('fetch_if_empty') and not self.get(_df.fieldname))
+ _df
+ for _df in self.meta.get_fields_to_fetch(df.fieldname)
+ if not _df.get("fetch_if_empty")
+ or (_df.get("fetch_if_empty") and not self.get(_df.fieldname))
]
- if not frappe.get_meta(doctype).get('is_virtual'):
+ if not frappe.get_meta(doctype).get("is_virtual"):
if not fields_to_fetch:
# cache a single value type
- values = frappe._dict(name=frappe.db.get_value(doctype, docname,
- 'name', cache=True))
+ values = frappe._dict(name=frappe.db.get_value(doctype, docname, "name", cache=True))
else:
- values_to_fetch = ['name'] + [_df.fetch_from.split('.')[-1]
- for _df in fields_to_fetch]
+ values_to_fetch = ["name"] + [_df.fetch_from.split(".")[-1] for _df in fields_to_fetch]
# don't cache if fetching other values too
- values = frappe.db.get_value(doctype, docname,
- values_to_fetch, as_dict=True)
+ values = frappe.db.get_value(doctype, docname, values_to_fetch, as_dict=True)
if frappe.get_meta(doctype).issingle:
values.name = doctype
- if frappe.get_meta(doctype).get('is_virtual'):
+ if frappe.get_meta(doctype).get("is_virtual"):
values = frappe.get_doc(doctype, docname)
if values:
@@ -669,29 +703,35 @@ class BaseDocument(object):
if not values.name:
invalid_links.append((df.fieldname, docname, get_msg(df, docname)))
- elif (df.fieldname != "amended_from"
- and (is_submittable or self.meta.is_submittable) and frappe.get_meta(doctype).is_submittable
- and cint(frappe.db.get_value(doctype, docname, "docstatus")) == DocStatus.cancelled()):
+ elif (
+ df.fieldname != "amended_from"
+ and (is_submittable or self.meta.is_submittable)
+ and frappe.get_meta(doctype).is_submittable
+ and cint(frappe.db.get_value(doctype, docname, "docstatus")) == DocStatus.cancelled()
+ ):
cancelled_links.append((df.fieldname, docname, get_msg(df, docname)))
return invalid_links, cancelled_links
def set_fetch_from_value(self, doctype, df, values):
- fetch_from_fieldname = df.fetch_from.split('.')[-1]
+ fetch_from_fieldname = df.fetch_from.split(".")[-1]
value = values[fetch_from_fieldname]
- if df.fieldtype in ['Small Text', 'Text', 'Data']:
+ if df.fieldtype in ["Small Text", "Text", "Data"]:
from frappe.model.meta import get_default_df
- fetch_from_df = get_default_df(fetch_from_fieldname) or frappe.get_meta(doctype).get_field(fetch_from_fieldname)
+
+ fetch_from_df = get_default_df(fetch_from_fieldname) or frappe.get_meta(doctype).get_field(
+ fetch_from_fieldname
+ )
if not fetch_from_df:
frappe.throw(
_('Please check the value of "Fetch From" set for field {0}').format(frappe.bold(df.label)),
- title = _('Wrong Fetch From value')
+ title=_("Wrong Fetch From value"),
)
- fetch_from_ft = fetch_from_df.get('fieldtype')
- if fetch_from_ft == 'Text Editor' and value:
+ fetch_from_ft = fetch_from_df.get("fieldtype")
+ if fetch_from_ft == "Text Editor" and value:
value = unescape_html(strip_html(value))
setattr(self, df.fieldname, value)
@@ -700,7 +740,7 @@ class BaseDocument(object):
return
for df in self.meta.get_select_fields():
- if df.fieldname=="naming_series" or not (self.get(df.fieldname) and df.options):
+ if df.fieldname == "naming_series" or not (self.get(df.fieldname) and df.options):
continue
options = (df.options or "").split("\n")
@@ -719,8 +759,11 @@ class BaseDocument(object):
label = _(self.meta.get_label(df.fieldname))
comma_options = '", "'.join(_(each) for each in options)
- frappe.throw(_('{0} {1} cannot be "{2}". It should be one of "{3}"').format(prefix, label,
- value, comma_options))
+ frappe.throw(
+ _('{0} {1} cannot be "{2}". It should be one of "{3}"').format(
+ prefix, label, value, comma_options
+ )
+ )
def _validate_data_fields(self):
# data_field options defined in frappe.model.data_field_options
@@ -754,7 +797,7 @@ class BaseDocument(object):
if frappe.flags.in_import or self.is_new() or self.flags.ignore_validate_constants:
return
- constants = [d.fieldname for d in self.meta.get("fields", {"set_only_once": ('=',1)})]
+ constants = [d.fieldname for d in self.meta.get("fields", {"set_only_once": ("=", 1)})]
if constants:
values = frappe.db.get_value(self.doctype, self.name, constants, as_dict=True)
@@ -762,15 +805,17 @@ class BaseDocument(object):
df = self.meta.get_field(fieldname)
# This conversion to string only when fieldtype is Date
- if df.fieldtype == 'Date' or df.fieldtype == 'Datetime':
+ if df.fieldtype == "Date" or df.fieldtype == "Datetime":
value = str(values.get(fieldname))
else:
- value = values.get(fieldname)
+ value = values.get(fieldname)
if self.get(fieldname) != value:
- frappe.throw(_("Value cannot be changed for {0}").format(self.meta.get_label(fieldname)),
- frappe.CannotChangeConstantError)
+ frappe.throw(
+ _("Value cannot be changed for {0}").format(self.meta.get_label(fieldname)),
+ frappe.CannotChangeConstantError,
+ )
def _validate_length(self):
if frappe.flags.in_install:
@@ -785,20 +830,20 @@ class BaseDocument(object):
for fieldname, value in self.get_valid_dict(ignore_virtual=True).items():
df = self.meta.get_field(fieldname)
- if not df or df.fieldtype == 'Check':
+ if not df or df.fieldtype == "Check":
# skip standard fields and Check fields
continue
column_type = type_map[df.fieldtype][0] or None
- if column_type == 'varchar':
+ if column_type == "varchar":
default_column_max_length = type_map[df.fieldtype][1] or None
max_length = cint(df.get("length")) or cint(default_column_max_length)
if len(cstr(value)) > max_length:
self.throw_length_exceeded_error(df, max_length, value)
- elif column_type in ('int', 'bigint', 'smallint'):
+ elif column_type in ("int", "bigint", "smallint"):
max_length = max_positive_value[column_type]
if abs(cint(value)) > max_length:
@@ -830,8 +875,13 @@ class BaseDocument(object):
else:
reference = "{0} {1}".format(_(self.doctype), self.name)
- frappe.throw(_("{0}: '{1}' ({3}) will get truncated, as max characters allowed is {2}")\
- .format(reference, _(df.label), max_length, value), frappe.CharacterLengthExceededError, title=_('Value too big'))
+ frappe.throw(
+ _("{0}: '{1}' ({3}) will get truncated, as max characters allowed is {2}").format(
+ reference, _(df.label), max_length, value
+ ),
+ frappe.CharacterLengthExceededError,
+ title=_("Value too big"),
+ )
def _validate_update_after_submit(self):
# get the full doc with children
@@ -852,15 +902,22 @@ class BaseDocument(object):
self_value = self.get_value(key)
# Postgres stores values as `datetime.time`, MariaDB as `timedelta`
if isinstance(self_value, datetime.timedelta) and isinstance(db_value, datetime.time):
- db_value = datetime.timedelta(hours=db_value.hour, minutes=db_value.minute, seconds=db_value.second, microseconds=db_value.microsecond)
+ db_value = datetime.timedelta(
+ hours=db_value.hour,
+ minutes=db_value.minute,
+ seconds=db_value.second,
+ microseconds=db_value.microsecond,
+ )
if self_value != db_value:
- frappe.throw(_("Not allowed to change {0} after submission").format(df.label),
- frappe.UpdateAfterSubmitError)
+ frappe.throw(
+ _("Not allowed to change {0} after submission").format(df.label),
+ frappe.UpdateAfterSubmitError,
+ )
def _sanitize_content(self):
"""Sanitize HTML and Email in field values. Used to prevent XSS.
- - Ignore if 'Ignore XSS Filter' is checked or fieldtype is 'Code'
+ - Ignore if 'Ignore XSS Filter' is checked or fieldtype is 'Code'
"""
from bs4 import BeautifulSoup
@@ -873,7 +930,7 @@ class BaseDocument(object):
value = frappe.as_unicode(value)
- if (u"<" not in value and u">" not in value):
+ if "<" not in value and ">" not in value:
# doesn't look like html so no need
continue
@@ -884,29 +941,31 @@ class BaseDocument(object):
df = self.meta.get_field(fieldname)
sanitized_value = value
- if df and (df.get("ignore_xss_filter")
- or (df.get("fieldtype") in ("Data", "Small Text", "Text") and df.get("options")=="Email")
+ if df and (
+ df.get("ignore_xss_filter")
+ or (df.get("fieldtype") in ("Data", "Small Text", "Text") and df.get("options") == "Email")
or df.get("fieldtype") in ("Attach", "Attach Image", "Barcode", "Code")
-
# cancelled and submit but not update after submit should be ignored
or self.docstatus.is_cancelled()
- or (self.docstatus.is_submitted() and not df.get("allow_on_submit"))):
+ or (self.docstatus.is_submitted() and not df.get("allow_on_submit"))
+ ):
continue
else:
- sanitized_value = sanitize_html(value, linkify=df and df.fieldtype=='Text Editor')
+ sanitized_value = sanitize_html(value, linkify=df and df.fieldtype == "Text Editor")
self.set(fieldname, sanitized_value)
def _save_passwords(self):
"""Save password field values in __Auth table"""
- from frappe.utils.password import set_encrypted_password, remove_encrypted_password
+ from frappe.utils.password import remove_encrypted_password, set_encrypted_password
if self.flags.ignore_save_passwords is True:
return
- for df in self.meta.get('fields', {'fieldtype': ('=', 'Password')}):
- if self.flags.ignore_save_passwords and df.fieldname in self.flags.ignore_save_passwords: continue
+ for df in self.meta.get("fields", {"fieldtype": ("=", "Password")}):
+ if self.flags.ignore_save_passwords and df.fieldname in self.flags.ignore_save_passwords:
+ continue
new_password = self.get(df.fieldname)
if not new_password:
@@ -917,18 +976,20 @@ class BaseDocument(object):
set_encrypted_password(self.doctype, self.name, new_password, df.fieldname)
# set dummy password like '*****'
- self.set(df.fieldname, '*'*len(new_password))
+ self.set(df.fieldname, "*" * len(new_password))
- def get_password(self, fieldname='password', raise_exception=True):
+ def get_password(self, fieldname="password", raise_exception=True):
from frappe.utils.password import get_decrypted_password
if self.get(fieldname) and not self.is_dummy_password(self.get(fieldname)):
return self.get(fieldname)
- return get_decrypted_password(self.doctype, self.name, fieldname, raise_exception=raise_exception)
+ return get_decrypted_password(
+ self.doctype, self.name, fieldname, raise_exception=raise_exception
+ )
def is_dummy_password(self, pwd):
- return ''.join(set(pwd))=='*'
+ return "".join(set(pwd)) == "*"
def precision(self, fieldname, parentfield=None):
"""Returns float precision for a particular field (or get global default).
@@ -959,13 +1020,15 @@ class BaseDocument(object):
return self._precision[cache_key][fieldname]
-
- def get_formatted(self, fieldname, doc=None, currency=None, absolute_value=False, translated=False, format=None):
+ def get_formatted(
+ self, fieldname, doc=None, currency=None, absolute_value=False, translated=False, format=None
+ ):
from frappe.utils.formatters import format_value
df = self.meta.get_field(fieldname)
if not df:
from frappe.model.meta import get_default_df
+
df = get_default_df(fieldname)
if (
@@ -974,7 +1037,7 @@ class BaseDocument(object):
and (currency_field := df.get("options"))
and (currency_value := self.get(currency_field))
):
- currency = frappe.db.get_value('Currency', currency_value, cache=True)
+ currency = frappe.db.get_value("Currency", currency_value, cache=True)
val = self.get(fieldname)
@@ -984,7 +1047,7 @@ class BaseDocument(object):
if not doc:
doc = getattr(self, "parent_doc", None) or self
- if (absolute_value or doc.get('absolute_value')) and isinstance(val, (int, float)):
+ if (absolute_value or doc.get("absolute_value")) and isinstance(val, (int, float)):
val = abs(self.get(fieldname))
return format_value(val, df=df, doc=doc, currency=currency, format=format)
@@ -995,9 +1058,9 @@ class BaseDocument(object):
Print Hide can be set via the Print Format Builder or in the controller as a list
of hidden fields. Example
- class MyDoc(Document):
- def __setup__(self):
- self.print_hide = ["field1", "field2"]
+ class MyDoc(Document):
+ def __setup__(self):
+ self.print_hide = ["field1", "field2"]
:param fieldname: Fieldname to be checked if hidden.
"""
@@ -1007,8 +1070,8 @@ class BaseDocument(object):
print_hide = 0
- if self.get(fieldname)==0 and not self.meta.istable:
- print_hide = ( df and df.print_hide_if_no_value ) or ( meta_df and meta_df.print_hide_if_no_value )
+ if self.get(fieldname) == 0 and not self.meta.istable:
+ print_hide = (df and df.print_hide_if_no_value) or (meta_df and meta_df.print_hide_if_no_value)
if not print_hide:
if df and df.print_hide is not None:
@@ -1020,7 +1083,7 @@ class BaseDocument(object):
def in_format_data(self, fieldname):
"""Returns True if shown via Print Format::`format_data` property.
- Called from within standard print format."""
+ Called from within standard print format."""
doc = getattr(self, "parent_doc", self)
if hasattr(doc, "format_data_map"):
@@ -1042,7 +1105,7 @@ class BaseDocument(object):
ref_doc = frappe.new_doc(self.doctype)
else:
# get values from old doc
- if self.get('parent_doc'):
+ if self.get("parent_doc"):
parent_doc = self.parent_doc.get_latest()
ref_doc = [d for d in parent_doc.get(self.parentfield) if d.name == self.name][0]
else:
@@ -1062,15 +1125,17 @@ class BaseDocument(object):
def _extract_images_from_text_editor(self):
from frappe.core.doctype.file.file import extract_images_from_doc
+
if self.doctype != "DocType":
- for df in self.meta.get("fields", {"fieldtype": ('=', "Text Editor")}):
+ for df in self.meta.get("fields", {"fieldtype": ("=", "Text Editor")}):
extract_images_from_doc(self, df.fieldname)
+
def _filter(data, filters, limit=None):
"""pass filters as:
- {"key": "val", "key": ["!=", "val"],
- "key": ["in", "val"], "key": ["not in", "val"], "key": "^val",
- "key" : True (exists), "key": False (does not exist) }"""
+ {"key": "val", "key": ["!=", "val"],
+ "key": ["in", "val"], "key": ["not in", "val"], "key": "^val",
+ "key" : True (exists), "key": False (does not exist) }"""
out, _filters = [], {}
diff --git a/frappe/model/create_new.py b/frappe/model/create_new.py
index fff2156a10..8671008f82 100644
--- a/frappe/model/create_new.py
+++ b/frappe/model/create_new.py
@@ -6,14 +6,16 @@ Create a new document with defaults set
"""
import copy
+
import frappe
import frappe.defaults
-from frappe.model import data_fieldtypes
-from frappe.utils import nowdate, nowtime, now_datetime, cstr
from frappe.core.doctype.user_permission.user_permission import get_user_permissions
+from frappe.model import data_fieldtypes
from frappe.permissions import filter_allowed_docs_for_doctype
+from frappe.utils import cstr, now_datetime, nowdate, nowtime
-def get_new_doc(doctype, parent_doc = None, parentfield = None, as_dict=False):
+
+def get_new_doc(doctype, parent_doc=None, parentfield=None, as_dict=False):
if doctype not in frappe.local.new_doc_templates:
# cache a copy of new doc as it is called
# frequently for inserts
@@ -30,13 +32,11 @@ def get_new_doc(doctype, parent_doc = None, parentfield = None, as_dict=False):
else:
return frappe.get_doc(doc)
+
def make_new_doc(doctype):
- doc = frappe.get_doc({
- "doctype": doctype,
- "__islocal": 1,
- "owner": frappe.session.user,
- "docstatus": 0
- })
+ doc = frappe.get_doc(
+ {"doctype": doctype, "__islocal": 1, "owner": frappe.session.user, "docstatus": 0}
+ )
set_user_and_static_default_values(doc)
@@ -50,6 +50,7 @@ def make_new_doc(doctype):
return doc
+
def set_user_and_static_default_values(doc):
user_permissions = get_user_permissions()
defaults = frappe.defaults.get_defaults()
@@ -59,10 +60,13 @@ def set_user_and_static_default_values(doc):
# user permissions for link options
doctype_user_permissions = user_permissions.get(df.options, [])
# Allowed records for the reference doctype (link field) along with default doc
- allowed_records, default_doc = filter_allowed_docs_for_doctype(doctype_user_permissions,
- df.parent, with_default_doc=True)
+ allowed_records, default_doc = filter_allowed_docs_for_doctype(
+ doctype_user_permissions, df.parent, with_default_doc=True
+ )
- user_default_value = get_user_default_value(df, defaults, doctype_user_permissions, allowed_records, default_doc)
+ user_default_value = get_user_default_value(
+ df, defaults, doctype_user_permissions, allowed_records, default_doc
+ )
if user_default_value is not None:
# if fieldtype is link check if doc exists
if not df.fieldtype == "Link" or frappe.db.exists(df.options, user_default_value):
@@ -74,23 +78,26 @@ def set_user_and_static_default_values(doc):
if static_default_value is not None:
doc.set(df.fieldname, static_default_value)
+
def get_user_default_value(df, defaults, doctype_user_permissions, allowed_records, default_doc):
# don't set defaults for "User" link field using User Permissions!
if df.fieldtype == "Link" and df.options != "User":
# If user permission has Is Default enabled or single-user permission has found against respective doctype.
- if (not df.ignore_user_permissions and default_doc):
+ if not df.ignore_user_permissions and default_doc:
return default_doc
# 2 - Look in user defaults
user_default = defaults.get(df.fieldname)
- allowed_by_user_permission = validate_value_via_user_permissions(df, doctype_user_permissions,
- allowed_records, user_default=user_default)
+ allowed_by_user_permission = validate_value_via_user_permissions(
+ df, doctype_user_permissions, allowed_records, user_default=user_default
+ )
# is this user default also allowed as per user permissions?
if user_default and allowed_by_user_permission:
return user_default
+
def get_static_default_value(df, doctype_user_permissions, allowed_records):
# 3 - look in default of docfield
if df.get("default"):
@@ -102,16 +109,20 @@ def get_static_default_value(df, doctype_user_permissions, allowed_records):
elif not cstr(df.default).startswith(":"):
# a simple default value
- is_allowed_default_value = validate_value_via_user_permissions(df, doctype_user_permissions,
- allowed_records)
+ is_allowed_default_value = validate_value_via_user_permissions(
+ df, doctype_user_permissions, allowed_records
+ )
- if df.fieldtype!="Link" or df.options=="User" or is_allowed_default_value:
+ if df.fieldtype != "Link" or df.options == "User" or is_allowed_default_value:
return df.default
- elif (df.fieldtype == "Select" and df.options and df.options not in ("[Select]", "Loading...")):
+ elif df.fieldtype == "Select" and df.options and df.options not in ("[Select]", "Loading..."):
return df.options.split("\n")[0]
-def validate_value_via_user_permissions(df, doctype_user_permissions, allowed_records, user_default=None):
+
+def validate_value_via_user_permissions(
+ df, doctype_user_permissions, allowed_records, user_default=None
+):
is_valid = True
# If User Permission exists and allowed records is empty,
# that means there are User Perms, but none applicable to this new doctype.
@@ -124,6 +135,7 @@ def validate_value_via_user_permissions(df, doctype_user_permissions, allowed_re
return is_valid
+
def set_dynamic_default_values(doc, parent_doc, parentfield):
# these values should not be cached
user_permissions = get_user_permissions()
@@ -148,21 +160,28 @@ def set_dynamic_default_values(doc, parent_doc, parentfield):
if parentfield:
doc["parentfield"] = parentfield
+
def user_permissions_exist(df, doctype_user_permissions):
- return (df.fieldtype=="Link"
+ return (
+ df.fieldtype == "Link"
and not getattr(df, "ignore_user_permissions", False)
- and doctype_user_permissions)
+ and doctype_user_permissions
+ )
+
def get_default_based_on_another_field(df, user_permissions, parent_doc):
# default value based on another document
from frappe.permissions import get_allowed_docs_for_doctype
- ref_doctype = df.default[1:]
+ ref_doctype = df.default[1:]
ref_fieldname = ref_doctype.lower().replace(" ", "_")
- reference_name = parent_doc.get(ref_fieldname) if parent_doc else frappe.db.get_default(ref_fieldname)
+ reference_name = (
+ parent_doc.get(ref_fieldname) if parent_doc else frappe.db.get_default(ref_fieldname)
+ )
default_value = frappe.db.get_value(ref_doctype, reference_name, df.fieldname)
- is_allowed_default_value = (not user_permissions_exist(df, user_permissions.get(df.options)) or
- (default_value in get_allowed_docs_for_doctype(user_permissions[df.options], df.parent)))
+ is_allowed_default_value = not user_permissions_exist(df, user_permissions.get(df.options)) or (
+ default_value in get_allowed_docs_for_doctype(user_permissions[df.options], df.parent)
+ )
# is this allowed as per user permissions
if is_allowed_default_value:
diff --git a/frappe/model/db_query.py b/frappe/model/db_query.py
index 16056d382a..a7d9536ebc 100644
--- a/frappe/model/db_query.py
+++ b/frappe/model/db_query.py
@@ -2,19 +2,33 @@
# License: MIT. See LICENSE
"""build query for doclistview and return results"""
+import copy
+import json
+import re
+from datetime import datetime
from typing import List
+
+import frappe
import frappe.defaults
-from frappe.query_builder.utils import Column
+import frappe.permissions
import frappe.share
from frappe import _
-import frappe.permissions
-from datetime import datetime
-import frappe, json, copy, re
+from frappe.core.doctype.server_script.server_script_utils import get_server_script_map
from frappe.model import optional_fields
-from frappe.model.utils.user_settings import get_user_settings, update_user_settings
-from frappe.utils import flt, cint, get_time, make_filter_tuple, get_filter, add_to_date, cstr, get_timespan_date_range
from frappe.model.meta import get_table_columns
-from frappe.core.doctype.server_script.server_script_utils import get_server_script_map
+from frappe.model.utils.user_settings import get_user_settings, update_user_settings
+from frappe.query_builder.utils import Column
+from frappe.utils import (
+ add_to_date,
+ cint,
+ cstr,
+ flt,
+ get_filter,
+ get_time,
+ get_timespan_date_range,
+ make_filter_tuple,
+)
+
class DatabaseQuery(object):
def __init__(self, doctype, user=None):
@@ -28,49 +42,74 @@ class DatabaseQuery(object):
self.flags = frappe._dict()
self.reference_doctype = None
- def execute(self, fields=None, filters=None, or_filters=None,
- docstatus=None, group_by=None, order_by="KEEP_DEFAULT_ORDERING", limit_start=False,
- limit_page_length=None, as_list=False, with_childnames=False, debug=False,
- ignore_permissions=False, user=None, with_comment_count=False,
- join='left join', distinct=False, start=None, page_length=None, limit=None,
- ignore_ifnull=False, save_user_settings=False, save_user_settings_fields=False,
- update=None, add_total_row=None, user_settings=None, reference_doctype=None,
- run=True, strict=True, pluck=None, ignore_ddl=False, parent_doctype=None) -> List:
+ def execute(
+ self,
+ fields=None,
+ filters=None,
+ or_filters=None,
+ docstatus=None,
+ group_by=None,
+ order_by="KEEP_DEFAULT_ORDERING",
+ limit_start=False,
+ limit_page_length=None,
+ as_list=False,
+ with_childnames=False,
+ debug=False,
+ ignore_permissions=False,
+ user=None,
+ with_comment_count=False,
+ join="left join",
+ distinct=False,
+ start=None,
+ page_length=None,
+ limit=None,
+ ignore_ifnull=False,
+ save_user_settings=False,
+ save_user_settings_fields=False,
+ update=None,
+ add_total_row=None,
+ user_settings=None,
+ reference_doctype=None,
+ run=True,
+ strict=True,
+ pluck=None,
+ ignore_ddl=False,
+ parent_doctype=None,
+ ) -> List:
if (
not ignore_permissions
and not frappe.has_permission(self.doctype, "select", user=user, parent_doctype=parent_doctype)
and not frappe.has_permission(self.doctype, "read", user=user, parent_doctype=parent_doctype)
):
- frappe.flags.error_message = _('Insufficient Permission for {0}').format(frappe.bold(self.doctype))
+ frappe.flags.error_message = _("Insufficient Permission for {0}").format(
+ frappe.bold(self.doctype)
+ )
raise frappe.PermissionError(self.doctype)
# filters and fields swappable
# its hard to remember what comes first
- if (
- isinstance(fields, dict)
- or (
- fields
- and isinstance(fields, list)
- and isinstance(fields[0], list)
- )
+ if isinstance(fields, dict) or (
+ fields and isinstance(fields, list) and isinstance(fields[0], list)
):
# if fields is given as dict/list of list, its probably filters
filters, fields = fields, filters
- elif fields and isinstance(filters, list) \
- and len(filters) > 1 and isinstance(filters[0], str):
+ elif fields and isinstance(filters, list) and len(filters) > 1 and isinstance(filters[0], str):
# if `filters` is a list of strings, its probably fields
filters, fields = fields, filters
if fields:
self.fields = fields
else:
- self.fields = [f"`tab{self.doctype}`.`{pluck or 'name'}`"]
+ self.fields = [f"`tab{self.doctype}`.`{pluck or 'name'}`"]
- if start: limit_start = start
- if page_length: limit_page_length = page_length
- if limit: limit_page_length = limit
+ if start:
+ limit_start = start
+ if page_length:
+ limit_page_length = page_length
+ if limit:
+ limit_page_length = limit
self.filters = filters or []
self.or_filters = or_filters or []
@@ -103,7 +142,8 @@ class DatabaseQuery(object):
self.columns = self.get_table_columns()
# no table & ignore_ddl, return
- if not self.columns: return []
+ if not self.columns:
+ return []
result = self.build_and_run()
@@ -127,23 +167,32 @@ class DatabaseQuery(object):
args.conditions = "where " + args.conditions
if self.distinct:
- args.fields = 'distinct ' + args.fields
- args.order_by = '' # TODO: recheck for alternative
+ args.fields = "distinct " + args.fields
+ args.order_by = "" # TODO: recheck for alternative
# Postgres requires any field that appears in the select clause to also
# appear in the order by and group by clause
- if frappe.db.db_type == 'postgres' and args.order_by and args.group_by:
+ if frappe.db.db_type == "postgres" and args.order_by and args.group_by:
args = self.prepare_select_args(args)
- query = """select %(fields)s
+ query = (
+ """select %(fields)s
from %(tables)s
%(conditions)s
%(group_by)s
%(order_by)s
- %(limit)s""" % args
-
- return frappe.db.sql(query, as_dict=not self.as_list, debug=self.debug,
- update=self.update, ignore_ddl=self.ignore_ddl, run=self.run)
+ %(limit)s"""
+ % args
+ )
+
+ return frappe.db.sql(
+ query,
+ as_dict=not self.as_list,
+ debug=self.debug,
+ update=self.update,
+ ignore_ddl=self.ignore_ddl,
+ run=self.run,
+ )
def prepare_args(self):
self.parse_args()
@@ -170,11 +219,10 @@ class DatabaseQuery(object):
if self.grouped_or_conditions:
self.conditions.append(f"({' or '.join(self.grouped_or_conditions)})")
- args.conditions = ' and '.join(self.conditions)
+ args.conditions = " and ".join(self.conditions)
if self.or_conditions:
- args.conditions += (' or ' if args.conditions else "") + \
- ' or '.join(self.or_conditions)
+ args.conditions += (" or " if args.conditions else "") + " or ".join(self.or_conditions)
self.set_field_tables()
@@ -184,11 +232,13 @@ class DatabaseQuery(object):
# TODO: Add support for wrapping fields with sql functions and distinct keyword
for field in self.fields:
stripped_field = field.strip().lower()
- skip_wrapping = any([
- stripped_field.startswith(("`", "*", '"', "'")),
- "(" in stripped_field,
- "distinct" in stripped_field,
- ])
+ skip_wrapping = any(
+ [
+ stripped_field.startswith(("`", "*", '"', "'")),
+ "(" in stripped_field,
+ "distinct" in stripped_field,
+ ]
+ )
if skip_wrapping:
fields.append(field)
elif "as" in field.lower().split(" "):
@@ -249,30 +299,46 @@ class DatabaseQuery(object):
setattr(self, filter_name, filters)
def sanitize_fields(self):
- '''
- regex : ^.*[,();].*
- purpose : The regex will look for malicious patterns like `,`, '(', ')', '@', ;' in each
- field which may leads to sql injection.
- example :
- field = "`DocType`.`issingle`, version()"
- As field contains `,` and mysql function `version()`, with the help of regex
- the system will filter out this field.
- '''
+ """
+ regex : ^.*[,();].*
+ purpose : The regex will look for malicious patterns like `,`, '(', ')', '@', ;' in each
+ field which may leads to sql injection.
+ example :
+ field = "`DocType`.`issingle`, version()"
+ As field contains `,` and mysql function `version()`, with the help of regex
+ the system will filter out this field.
+ """
sub_query_regex = re.compile("^.*[,();@].*")
- blacklisted_keywords = ['select', 'create', 'insert', 'delete', 'drop', 'update', 'case', 'show']
- blacklisted_functions = ['concat', 'concat_ws', 'if', 'ifnull', 'nullif', 'coalesce',
- 'connection_id', 'current_user', 'database', 'last_insert_id', 'session_user',
- 'system_user', 'user', 'version', 'global']
+ blacklisted_keywords = ["select", "create", "insert", "delete", "drop", "update", "case", "show"]
+ blacklisted_functions = [
+ "concat",
+ "concat_ws",
+ "if",
+ "ifnull",
+ "nullif",
+ "coalesce",
+ "connection_id",
+ "current_user",
+ "database",
+ "last_insert_id",
+ "session_user",
+ "system_user",
+ "user",
+ "version",
+ "global",
+ ]
def _raise_exception():
- frappe.throw(_('Use of sub-query or function is restricted'), frappe.DataError)
+ frappe.throw(_("Use of sub-query or function is restricted"), frappe.DataError)
def _is_query(field):
if re.compile(r"^(select|delete|update|drop|create)\s").match(field):
_raise_exception()
- elif re.compile(r"\s*[0-9a-zA-z]*\s*( from | group by | order by | where | join )").match(field):
+ elif re.compile(r"\s*[0-9a-zA-z]*\s*( from | group by | order by | where | join )").match(
+ field
+ ):
_raise_exception()
for field in self.fields:
@@ -286,7 +352,7 @@ class DatabaseQuery(object):
if any(f"{keyword}(" in field.lower() for keyword in blacklisted_functions):
_raise_exception()
- if '@' in field.lower():
+ if "@" in field.lower():
# prevent access to global variables
_raise_exception()
@@ -300,10 +366,10 @@ class DatabaseQuery(object):
if self.strict:
if re.compile(r".*/\*.*").match(field):
- frappe.throw(_('Illegal SQL Query'))
+ frappe.throw(_("Illegal SQL Query"))
if re.compile(r".*\s(union).*\s").match(field.lower()):
- frappe.throw(_('Illegal SQL Query'))
+ frappe.throw(_("Illegal SQL Query"))
def extract_tables(self):
"""extract tables from fields"""
@@ -331,16 +397,20 @@ class DatabaseQuery(object):
if func_found or not ("tab" in field and "." in field):
continue
- table_name = field.split('.')[0]
+ table_name = field.split(".")[0]
- if table_name.lower().startswith('group_concat('):
+ if table_name.lower().startswith("group_concat("):
table_name = table_name[13:]
- if not table_name[0]=='`':
+ if not table_name[0] == "`":
table_name = f"`{table_name}`"
if table_name not in self.tables:
self.append_table(table_name)
- def cast_name(self, column: str, sql_function: str = "",) -> str:
+ def cast_name(
+ self,
+ column: str,
+ sql_function: str = "",
+ ) -> str:
if frappe.db.db_type == "postgres":
if "name" in column.lower():
if "cast(" not in column.lower() or "::" not in column:
@@ -349,50 +419,47 @@ class DatabaseQuery(object):
elif sql_function == "locate(":
return re.sub(
- r'locate\(([^,]+),([^)]+)\)',
- r'locate(\1, cast(\2 as varchar))',
+ r"locate\(([^,]+),([^)]+)\)",
+ r"locate(\1, cast(\2 as varchar))",
column,
- flags=re.IGNORECASE
+ flags=re.IGNORECASE,
)
elif sql_function == "strpos(":
return re.sub(
- r'strpos\(([^,]+),([^)]+)\)',
- r'strpos(cast(\1 as varchar), \2)',
+ r"strpos\(([^,]+),([^)]+)\)",
+ r"strpos(cast(\1 as varchar), \2)",
column,
- flags=re.IGNORECASE
+ flags=re.IGNORECASE,
)
elif sql_function == "ifnull(":
- return re.sub(
- r"ifnull\(([^,]+)",
- r"ifnull(cast(\1 as varchar)",
- column,
- flags=re.IGNORECASE
- )
+ return re.sub(r"ifnull\(([^,]+)", r"ifnull(cast(\1 as varchar)", column, flags=re.IGNORECASE)
return column
def append_table(self, table_name):
self.tables.append(table_name)
doctype = table_name[4:-1]
- ptype = 'select' if frappe.only_has_select_perm(doctype) else 'read'
+ ptype = "select" if frappe.only_has_select_perm(doctype) else "read"
- if not self.flags.ignore_permissions and \
- not frappe.has_permission(doctype, ptype=ptype, parent_doctype=self.doctype):
- frappe.flags.error_message = _('Insufficient Permission for {0}').format(frappe.bold(doctype))
+ if not self.flags.ignore_permissions and not frappe.has_permission(
+ doctype, ptype=ptype, parent_doctype=self.doctype
+ ):
+ frappe.flags.error_message = _("Insufficient Permission for {0}").format(frappe.bold(doctype))
raise frappe.PermissionError(doctype)
def set_field_tables(self):
- '''If there are more than one table, the fieldname must not be ambiguous.
- If the fieldname is not explicitly mentioned, set the default table'''
+ """If there are more than one table, the fieldname must not be ambiguous.
+ If the fieldname is not explicitly mentioned, set the default table"""
+
def _in_standard_sql_methods(field):
- methods = ('count(', 'avg(', 'sum(', 'extract(', 'dayofyear(')
+ methods = ("count(", "avg(", "sum(", "extract(", "dayofyear(")
return field.lower().startswith(methods)
if len(self.tables) > 1:
for idx, field in enumerate(self.fields):
- if '.' not in field and not _in_standard_sql_methods(field):
+ if "." not in field and not _in_standard_sql_methods(field):
self.fields[idx] = f"{self.tables[0]}.{field}"
def get_table_columns(self):
@@ -460,23 +527,24 @@ class DatabaseQuery(object):
def prepare_filter_condition(self, f):
"""Returns a filter condition in the format:
- ifnull(`tabDocType`.`fieldname`, fallback) operator "value"
+ ifnull(`tabDocType`.`fieldname`, fallback) operator "value"
"""
# TODO: refactor
from frappe.boot import get_additional_filters_from_hooks
+
additional_filters_config = get_additional_filters_from_hooks()
f = get_filter(self.doctype, f, additional_filters_config)
- tname = ('`tab' + f.doctype + '`')
+ tname = "`tab" + f.doctype + "`"
if tname not in self.tables:
self.append_table(tname)
- if 'ifnull(' in f.fieldname:
+ if "ifnull(" in f.fieldname:
column_name = self.cast_name(f.fieldname, "ifnull(")
else:
- column_name = self.cast_name(f"{tname}.{f.fieldname}")
+ column_name = self.cast_name(f"{tname}.`{f.fieldname}`")
if f.operator.lower() in additional_filters_config:
f.update(get_additional_filter_field(additional_filters_config, f, f.value))
@@ -485,8 +553,13 @@ class DatabaseQuery(object):
can_be_null = True
# prepare in condition
- if f.operator.lower() in ('ancestors of', 'descendants of', 'not ancestors of', 'not descendants of'):
- values = f.value or ''
+ if f.operator.lower() in (
+ "ancestors of",
+ "descendants of",
+ "not ancestors of",
+ "not descendants of",
+ ):
+ values = f.value or ""
# TODO: handle list and tuple
# if not isinstance(values, (list, tuple)):
@@ -495,25 +568,23 @@ class DatabaseQuery(object):
field = meta.get_field(f.fieldname)
ref_doctype = field.options if field else f.doctype
- lft, rgt = '', ''
+ lft, rgt = "", ""
if f.value:
lft, rgt = frappe.db.get_value(ref_doctype, f.value, ["lft", "rgt"])
# Get descendants elements of a DocType with a tree structure
- if f.operator.lower() in ('descendants of', 'not descendants of') :
- result = frappe.get_all(ref_doctype, filters={
- 'lft': ['>', lft],
- 'rgt': ['<', rgt]
- }, order_by='`lft` ASC')
- else :
+ if f.operator.lower() in ("descendants of", "not descendants of"):
+ result = frappe.get_all(
+ ref_doctype, filters={"lft": [">", lft], "rgt": ["<", rgt]}, order_by="`lft` ASC"
+ )
+ else:
# Get ancestor elements of a DocType with a tree structure
- result = frappe.get_all(ref_doctype, filters={
- 'lft': ['<', lft],
- 'rgt': ['>', rgt]
- }, order_by='`lft` DESC')
+ result = frappe.get_all(
+ ref_doctype, filters={"lft": ["<", lft], "rgt": [">", rgt]}, order_by="`lft` DESC"
+ )
fallback = "''"
- value = [frappe.db.escape((cstr(v.name) or '').strip(), percent=False) for v in result]
+ value = [frappe.db.escape((cstr(v.name) or "").strip(), percent=False) for v in result]
if len(value):
value = f"({', '.join(value)})"
else:
@@ -521,15 +592,17 @@ class DatabaseQuery(object):
# changing operator to IN as the above code fetches all the parent / child values and convert into tuple
# which can be directly used with IN operator to query.
- f.operator = 'not in' if f.operator.lower() in ('not ancestors of', 'not descendants of') else 'in'
+ f.operator = (
+ "not in" if f.operator.lower() in ("not ancestors of", "not descendants of") else "in"
+ )
- elif f.operator.lower() in ('in', 'not in'):
- values = f.value or ''
+ elif f.operator.lower() in ("in", "not in"):
+ values = f.value or ""
if isinstance(values, str):
values = values.split(",")
fallback = "''"
- value = [frappe.db.escape((cstr(v) or '').strip(), percent=False) for v in values]
+ value = [frappe.db.escape((cstr(v) or "").strip(), percent=False) for v in values]
if len(value):
value = f"({', '.join(value)})"
else:
@@ -542,62 +615,67 @@ class DatabaseQuery(object):
if df and df.fieldtype in ("Check", "Float", "Int", "Currency", "Percent"):
can_be_null = False
- if f.operator.lower() in ('previous', 'next', 'timespan'):
+ if f.operator.lower() in ("previous", "next", "timespan"):
date_range = get_date_range(f.operator.lower(), f.value)
f.operator = "Between"
f.value = date_range
fallback = "'0001-01-01 00:00:00'"
- if f.operator in ('>', '<') and (f.fieldname in ('creation', 'modified')):
+ if f.operator in (">", "<") and (f.fieldname in ("creation", "modified")):
value = cstr(f.value)
fallback = "'0001-01-01 00:00:00'"
- elif f.operator.lower() in ('between') and \
- (f.fieldname in ('creation', 'modified') or
- (df and (df.fieldtype=="Date" or df.fieldtype=="Datetime"))):
+ elif f.operator.lower() in ("between") and (
+ f.fieldname in ("creation", "modified")
+ or (df and (df.fieldtype == "Date" or df.fieldtype == "Datetime"))
+ ):
value = get_between_date_filter(f.value, df)
fallback = "'0001-01-01 00:00:00'"
elif f.operator.lower() == "is":
- if f.value == 'set':
- f.operator = '!='
- elif f.value == 'not set':
- f.operator = '='
+ if f.value == "set":
+ f.operator = "!="
+ elif f.value == "not set":
+ f.operator = "="
value = ""
fallback = "''"
can_be_null = True
- if 'ifnull' not in column_name.lower():
- column_name = f'ifnull({column_name}, {fallback})'
+ if "ifnull" not in column_name.lower():
+ column_name = f"ifnull({column_name}, {fallback})"
- elif df and df.fieldtype=="Date":
+ elif df and df.fieldtype == "Date":
value = frappe.db.format_date(f.value)
fallback = "'0001-01-01'"
- elif (df and df.fieldtype=="Datetime") or isinstance(f.value, datetime):
+ elif (df and df.fieldtype == "Datetime") or isinstance(f.value, datetime):
value = frappe.db.format_datetime(f.value)
fallback = "'0001-01-01 00:00:00'"
- elif df and df.fieldtype=="Time":
+ elif df and df.fieldtype == "Time":
value = get_time(f.value).strftime("%H:%M:%S.%f")
fallback = "'00:00:00'"
- elif f.operator.lower() in ("like", "not like") or (isinstance(f.value, str) and
- (not df or df.fieldtype not in ["Float", "Int", "Currency", "Percent", "Check"])):
- value = "" if f.value is None else f.value
- fallback = "''"
+ elif f.operator.lower() in ("like", "not like") or (
+ isinstance(f.value, str)
+ and (not df or df.fieldtype not in ["Float", "Int", "Currency", "Percent", "Check"])
+ ):
+ value = "" if f.value is None else f.value
+ fallback = "''"
- if f.operator.lower() in ("like", "not like") and isinstance(value, str):
- # because "like" uses backslash (\) for escaping
- value = value.replace("\\", "\\\\").replace("%", "%%")
+ if f.operator.lower() in ("like", "not like") and isinstance(value, str):
+ # because "like" uses backslash (\) for escaping
+ value = value.replace("\\", "\\\\").replace("%", "%%")
- elif f.operator == '=' and df and df.fieldtype in ['Link', 'Data']: # TODO: Refactor if possible
+ elif (
+ f.operator == "=" and df and df.fieldtype in ["Link", "Data"]
+ ): # TODO: Refactor if possible
value = f.value or "''"
fallback = "''"
- elif f.fieldname == 'name':
+ elif f.fieldname == "name":
value = f.value or "''"
fallback = "''"
@@ -606,25 +684,25 @@ class DatabaseQuery(object):
fallback = 0
if isinstance(f.value, Column):
- can_be_null = False # added to avoid the ifnull/coalesce addition
- quote = '"' if frappe.conf.db_type == 'postgres' else "`"
+ can_be_null = False # added to avoid the ifnull/coalesce addition
+ quote = '"' if frappe.conf.db_type == "postgres" else "`"
value = f"{tname}.{quote}{f.value.name}{quote}"
# escape value
- elif isinstance(value, str) and f.operator.lower() != 'between':
+ elif isinstance(value, str) and f.operator.lower() != "between":
value = f"{frappe.db.escape(value, percent=False)}"
if (
self.ignore_ifnull
or not can_be_null
- or (f.value and f.operator.lower() in ('=', 'like'))
- or 'ifnull(' in column_name.lower()
+ or (f.value and f.operator.lower() in ("=", "like"))
+ or "ifnull(" in column_name.lower()
):
- if f.operator.lower() == 'like' and frappe.conf.get('db_type') == 'postgres':
- f.operator = 'ilike'
- condition = f'{column_name} {f.operator} {value}'
+ if f.operator.lower() == "like" and frappe.conf.get("db_type") == "postgres":
+ f.operator = "ilike"
+ condition = f"{column_name} {f.operator} {value}"
else:
- condition = f'ifnull({column_name}, {fallback}) {f.operator} {value}'
+ condition = f"ifnull({column_name}, {fallback}) {f.operator} {value}"
return condition
@@ -636,17 +714,18 @@ class DatabaseQuery(object):
if not self.user:
self.user = frappe.session.user
- if not self.tables: self.extract_tables()
+ if not self.tables:
+ self.extract_tables()
meta = frappe.get_meta(self.doctype)
role_permissions = frappe.permissions.get_role_permissions(meta, user=self.user)
self.shared = frappe.share.get_shared(self.doctype, self.user)
if (
- not meta.istable and
- not (role_permissions.get("select") or role_permissions.get("read")) and
- not self.flags.ignore_permissions and
- not has_any_user_permission_for_doctype(self.doctype, self.user, self.reference_doctype)
+ not meta.istable
+ and not (role_permissions.get("select") or role_permissions.get("read"))
+ and not self.flags.ignore_permissions
+ and not has_any_user_permission_for_doctype(self.doctype, self.user, self.reference_doctype)
):
only_if_shared = True
if not self.shared:
@@ -675,11 +754,11 @@ class DatabaseQuery(object):
doctype_conditions = self.get_permission_query_conditions()
if doctype_conditions:
- conditions += (' and ' + doctype_conditions) if conditions else doctype_conditions
+ conditions += (" and " + doctype_conditions) if conditions else doctype_conditions
# share is an OR condition, if there is a role permission
if not only_if_shared and self.shared and conditions:
- conditions = f"({conditions}) or ({self.get_share_condition()})"
+ conditions = f"({conditions}) or ({self.get_share_condition()})"
return conditions
@@ -695,17 +774,20 @@ class DatabaseQuery(object):
doctype_link_fields = meta.get_link_fields()
# append current doctype with fieldname as 'name' as first link field
- doctype_link_fields.append(dict(
- options=self.doctype,
- fieldname='name',
- ))
+ doctype_link_fields.append(
+ dict(
+ options=self.doctype,
+ fieldname="name",
+ )
+ )
match_filters = {}
match_conditions = []
for df in doctype_link_fields:
- if df.get('ignore_user_permissions'): continue
+ if df.get("ignore_user_permissions"):
+ continue
- user_permission_values = user_permissions.get(df.get('options'), {})
+ user_permission_values = user_permissions.get(df.get("options"), {})
if user_permission_values:
docs = []
@@ -716,26 +798,26 @@ class DatabaseQuery(object):
condition = empty_value_condition + " or "
for permission in user_permission_values:
- if not permission.get('applicable_for'):
- docs.append(permission.get('doc'))
+ if not permission.get("applicable_for"):
+ docs.append(permission.get("doc"))
# append docs based on user permission applicable on reference doctype
# this is useful when getting list of docs from a link field
# in this case parent doctype of the link
# will be the reference doctype
- elif df.get('fieldname') == 'name' and self.reference_doctype:
- if permission.get('applicable_for') == self.reference_doctype:
- docs.append(permission.get('doc'))
+ elif df.get("fieldname") == "name" and self.reference_doctype:
+ if permission.get("applicable_for") == self.reference_doctype:
+ docs.append(permission.get("doc"))
- elif permission.get('applicable_for') == self.doctype:
- docs.append(permission.get('doc'))
+ elif permission.get("applicable_for") == self.doctype:
+ docs.append(permission.get("doc"))
if docs:
values = ", ".join(frappe.db.escape(doc, percent=False) for doc in docs)
condition += f"`tab{self.doctype}`.`{df.get('fieldname')}` in ({values})"
match_conditions.append(f"({condition})")
- match_filters[df.get('options')] = docs
+ match_filters[df.get("options")] = docs
if match_conditions:
self.match_conditions.append(" and ".join(match_conditions))
@@ -770,31 +852,36 @@ class DatabaseQuery(object):
args.order_by = ""
# don't add order by from meta if a mysql group function is used without group by clause
- group_function_without_group_by = (len(self.fields)==1 and
- ( self.fields[0].lower().startswith("count(")
+ group_function_without_group_by = (
+ len(self.fields) == 1
+ and (
+ self.fields[0].lower().startswith("count(")
or self.fields[0].lower().startswith("min(")
or self.fields[0].lower().startswith("max(")
- ) and not self.group_by)
+ )
+ and not self.group_by
+ )
if not group_function_without_group_by:
sort_field = sort_order = None
- if meta.sort_field and ',' in meta.sort_field:
+ if meta.sort_field and "," in meta.sort_field:
# multiple sort given in doctype definition
# Example:
# `idx desc, modified desc`
# will covert to
# `tabItem`.`idx` desc, `tabItem`.`modified` desc
- args.order_by = ', '.join(
- f"`tab{self.doctype}`.`{f.split()[0].strip()}` {f.split()[1].strip()}" for f in meta.sort_field.split(',')
+ args.order_by = ", ".join(
+ f"`tab{self.doctype}`.`{f.split()[0].strip()}` {f.split()[1].strip()}"
+ for f in meta.sort_field.split(",")
)
else:
- sort_field = meta.sort_field or 'modified'
- sort_order = (meta.sort_field and meta.sort_order) or 'desc'
+ sort_field = meta.sort_field or "modified"
+ sort_order = (meta.sort_field and meta.sort_order) or "desc"
if self.order_by:
args.order_by = f"`tab{self.doctype}`.`{sort_field or 'modified'}` {sort_order or 'desc'}"
# draft docs always on top
- if hasattr(meta, 'is_submittable') and meta.is_submittable:
+ if hasattr(meta, "is_submittable") and meta.is_submittable:
if self.order_by:
args.order_by = f"`tab{self.doctype}`.docstatus asc, {args.order_by}"
@@ -804,25 +891,25 @@ class DatabaseQuery(object):
return
_lower = parameters.lower()
- if 'select' in _lower and 'from' in _lower:
- frappe.throw(_('Cannot use sub-query in order by'))
+ if "select" in _lower and "from" in _lower:
+ frappe.throw(_("Cannot use sub-query in order by"))
if re.compile(r".*[^a-z0-9-_ ,`'\"\.\(\)].*").match(_lower):
- frappe.throw(_('Illegal SQL Query'))
+ frappe.throw(_("Illegal SQL Query"))
for field in parameters.split(","):
if "." in field and field.strip().startswith("`tab"):
- tbl = field.strip().split('.')[0]
+ tbl = field.strip().split(".")[0]
if tbl not in self.tables:
- if tbl.startswith('`'):
+ if tbl.startswith("`"):
tbl = tbl[4:-1]
frappe.throw(_("Please select atleast 1 column from {0} to sort/group").format(tbl))
def add_limit(self):
if self.limit_page_length:
- return 'limit %s offset %s' % (self.limit_page_length, self.limit_start)
+ return "limit %s offset %s" % (self.limit_page_length, self.limit_start)
else:
- return ''
+ return ""
def add_comment_count(self, result):
for r in result:
@@ -837,20 +924,21 @@ class DatabaseQuery(object):
# update user settings if new search
user_settings = json.loads(get_user_settings(self.doctype))
- if hasattr(self, 'user_settings'):
+ if hasattr(self, "user_settings"):
user_settings.update(self.user_settings)
if self.save_user_settings_fields:
- user_settings['fields'] = self.user_settings_fields
+ user_settings["fields"] = self.user_settings_fields
update_user_settings(self.doctype, user_settings)
+
def check_parent_permission(parent, child_doctype):
if parent:
# User may pass fake parent and get the information from the child table
if child_doctype and not (
- frappe.db.exists('DocField', {'parent': parent, 'options': child_doctype})
- or frappe.db.exists('Custom Field', {'dt': parent, 'options': child_doctype})
+ frappe.db.exists("DocField", {"parent": parent, "options": child_doctype})
+ or frappe.db.exists("Custom Field", {"dt": parent, "options": child_doctype})
):
raise frappe.PermissionError
@@ -860,21 +948,25 @@ def check_parent_permission(parent, child_doctype):
# Either parent not passed or the user doesn't have permission on parent doctype of child table!
raise frappe.PermissionError
+
def get_order_by(doctype, meta):
order_by = ""
sort_field = sort_order = None
- if meta.sort_field and ',' in meta.sort_field:
+ if meta.sort_field and "," in meta.sort_field:
# multiple sort given in doctype definition
# Example:
# `idx desc, modified desc`
# will covert to
# `tabItem`.`idx` desc, `tabItem`.`modified` desc
- order_by = ', '.join(f"`tab{doctype}`.`{f.split()[0].strip()}` {f.split()[1].strip()}" for f in meta.sort_field.split(','))
+ order_by = ", ".join(
+ f"`tab{doctype}`.`{f.split()[0].strip()}` {f.split()[1].strip()}"
+ for f in meta.sort_field.split(",")
+ )
else:
- sort_field = meta.sort_field or 'modified'
- sort_order = (meta.sort_field and meta.sort_order) or 'desc'
+ sort_field = meta.sort_field or "modified"
+ sort_order = (meta.sort_field and meta.sort_order) or "desc"
order_by = f"`tab{doctype}`.`{sort_field or 'modified'}` {sort_order or 'desc'}"
# draft docs always on top
@@ -883,19 +975,21 @@ def get_order_by(doctype, meta):
return order_by
+
def is_parent_only_filter(doctype, filters):
- #check if filters contains only parent doctype
+ # check if filters contains only parent doctype
only_parent_doctype = True
if isinstance(filters, list):
for flt in filters:
if doctype not in flt:
only_parent_doctype = False
- if 'Between' in flt:
+ if "Between" in flt:
flt[3] = get_between_date_filter(flt[3])
return only_parent_doctype
+
def has_any_user_permission_for_doctype(doctype, user, applicable_for):
user_permissions = frappe.permissions.get_user_permissions(user=user)
doctype_user_permissions = user_permissions.get(doctype, [])
@@ -906,35 +1000,38 @@ def has_any_user_permission_for_doctype(doctype, user, applicable_for):
return False
+
def get_between_date_filter(value, df=None):
- '''
- return the formattted date as per the given example
- [u'2017-11-01', u'2017-11-03'] => '2017-11-01 00:00:00.000000' AND '2017-11-04 00:00:00.000000'
- '''
+ """
+ return the formattted date as per the given example
+ [u'2017-11-01', u'2017-11-03'] => '2017-11-01 00:00:00.000000' AND '2017-11-04 00:00:00.000000'
+ """
from_date = frappe.utils.nowdate()
to_date = frappe.utils.nowdate()
if value and isinstance(value, (list, tuple)):
- if len(value) >= 1: from_date = value[0]
- if len(value) >= 2: to_date = value[1]
+ if len(value) >= 1:
+ from_date = value[0]
+ if len(value) >= 2:
+ to_date = value[1]
- if not df or (df and df.fieldtype == 'Datetime'):
+ if not df or (df and df.fieldtype == "Datetime"):
to_date = add_to_date(to_date, days=1)
- if df and df.fieldtype == 'Datetime':
+ if df and df.fieldtype == "Datetime":
data = "'%s' AND '%s'" % (
frappe.db.format_datetime(from_date),
- frappe.db.format_datetime(to_date))
+ frappe.db.format_datetime(to_date),
+ )
else:
- data = "'%s' AND '%s'" % (
- frappe.db.format_date(from_date),
- frappe.db.format_date(to_date))
+ data = "'%s' AND '%s'" % (frappe.db.format_date(from_date), frappe.db.format_date(to_date))
return data
+
def get_additional_filter_field(additional_filters_config, f, value):
additional_filter = additional_filters_config[f.operator.lower()]
- f = frappe._dict(frappe.get_attr(additional_filter['get_field'])())
+ f = frappe._dict(frappe.get_attr(additional_filter["get_field"])())
if f.query_value:
for option in f.options:
option = frappe._dict(option)
@@ -942,23 +1039,25 @@ def get_additional_filter_field(additional_filters_config, f, value):
f.value = option.query_value
return f
+
def get_date_range(operator, value):
timespan_map = {
- '1 week': 'week',
- '1 month': 'month',
- '3 months': 'quarter',
- '6 months': '6 months',
- '1 year': 'year',
+ "1 week": "week",
+ "1 month": "month",
+ "3 months": "quarter",
+ "6 months": "6 months",
+ "1 year": "year",
}
period_map = {
- 'previous': 'last',
- 'next': 'next',
+ "previous": "last",
+ "next": "next",
}
- timespan = period_map[operator] + ' ' + timespan_map[value] if operator != 'timespan' else value
+ timespan = period_map[operator] + " " + timespan_map[value] if operator != "timespan" else value
return get_timespan_date_range(timespan)
+
def requires_owner_constraint(role_permissions):
"""Returns True if "select" or "read" isn't available without being creator."""
diff --git a/frappe/model/delete_doc.py b/frappe/model/delete_doc.py
index f055cd79d0..733e8ca367 100644
--- a/frappe/model/delete_doc.py
+++ b/frappe/model/delete_doc.py
@@ -7,30 +7,53 @@ import shutil
import frappe
import frappe.defaults
import frappe.model.meta
-from frappe import _
-from frappe import get_module_path
+from frappe import _, get_module_path
+from frappe.desk.doctype.tag.tag import delete_tags_for_document
from frappe.model.dynamic_links import get_dynamic_link_map
-from frappe.utils.file_manager import remove_all
-from frappe.utils.password import delete_all_passwords_for
from frappe.model.naming import revert_series_if_last
+from frappe.utils.file_manager import remove_all
from frappe.utils.global_search import delete_for_document
-from frappe.desk.doctype.tag.tag import delete_tags_for_document
-
-
-doctypes_to_skip = ("Communication", "ToDo", "DocShare", "Email Unsubscribe", "Activity Log", "File",
- "Version", "Document Follow", "Comment" , "View Log", "Tag Link", "Notification Log", "Email Queue")
+from frappe.utils.password import delete_all_passwords_for
-def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reload=False, ignore_permissions=False,
- flags=None, ignore_on_trash=False, ignore_missing=True, delete_permanently=False):
+doctypes_to_skip = (
+ "Communication",
+ "ToDo",
+ "DocShare",
+ "Email Unsubscribe",
+ "Activity Log",
+ "File",
+ "Version",
+ "Document Follow",
+ "Comment",
+ "View Log",
+ "Tag Link",
+ "Notification Log",
+ "Email Queue",
+)
+
+
+def delete_doc(
+ doctype=None,
+ name=None,
+ force=0,
+ ignore_doctypes=None,
+ for_reload=False,
+ ignore_permissions=False,
+ flags=None,
+ ignore_on_trash=False,
+ ignore_missing=True,
+ delete_permanently=False,
+):
"""
- Deletes a doc(dt, dn) and validates if it is not submitted and not linked in a live record
+ Deletes a doc(dt, dn) and validates if it is not submitted and not linked in a live record
"""
- if not ignore_doctypes: ignore_doctypes = []
+ if not ignore_doctypes:
+ ignore_doctypes = []
# get from form
if not doctype:
- doctype = frappe.form_dict.get('dt')
- name = frappe.form_dict.get('dn')
+ doctype = frappe.form_dict.get("dt")
+ name = frappe.form_dict.get("dn")
names = name
if isinstance(name, str) or isinstance(name, int):
@@ -49,7 +72,7 @@ def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reloa
delete_all_passwords_for(doctype, name)
doc = None
- if doctype=="DocType":
+ if doctype == "DocType":
if for_reload:
try:
@@ -74,11 +97,12 @@ def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reloa
delete_from_table(doctype, name, ignore_doctypes, None)
- if frappe.conf.developer_mode and not doc.custom and not (
- for_reload
- or frappe.flags.in_migrate
- or frappe.flags.in_install
- or frappe.flags.in_uninstall
+ if (
+ frappe.conf.developer_mode
+ and not doc.custom
+ and not (
+ for_reload or frappe.flags.in_migrate or frappe.flags.in_install or frappe.flags.in_uninstall
+ )
):
try:
delete_controllers(name, doc.module)
@@ -96,7 +120,7 @@ def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reloa
if not ignore_on_trash:
doc.run_method("on_trash")
doc.flags.in_delete = True
- doc.run_method('on_change')
+ doc.run_method("on_change")
# check if links exist
if not force:
@@ -113,9 +137,12 @@ def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reloa
if not for_reload:
# Enqueued at the end, because it gets committed
# All the linked docs should be checked beforehand
- frappe.enqueue('frappe.model.delete_doc.delete_dynamic_links',
- doctype=doc.doctype, name=doc.name,
- now=frappe.flags.in_test)
+ frappe.enqueue(
+ "frappe.model.delete_doc.delete_dynamic_links",
+ doctype=doc.doctype,
+ name=doc.name,
+ now=frappe.flags.in_test,
+ )
# clear cache for Document
doc.clear_cache()
@@ -141,28 +168,32 @@ def delete_doc(doctype=None, name=None, force=0, ignore_doctypes=None, for_reloa
# delete user_permissions
frappe.defaults.clear_default(parenttype="User Permission", key=doctype, value=name)
+
def add_to_deleted_document(doc):
- '''Add this document to Deleted Document table. Called after delete'''
- if doc.doctype != 'Deleted Document' and frappe.flags.in_install != 'frappe':
- frappe.get_doc(dict(
- doctype='Deleted Document',
- deleted_doctype=doc.doctype,
- deleted_name=doc.name,
- data=doc.as_json(),
- owner=frappe.session.user
- )).db_insert()
+ """Add this document to Deleted Document table. Called after delete"""
+ if doc.doctype != "Deleted Document" and frappe.flags.in_install != "frappe":
+ frappe.get_doc(
+ dict(
+ doctype="Deleted Document",
+ deleted_doctype=doc.doctype,
+ deleted_name=doc.name,
+ data=doc.as_json(),
+ owner=frappe.session.user,
+ )
+ ).db_insert()
+
def update_naming_series(doc):
if doc.meta.autoname:
- if doc.meta.autoname.startswith("naming_series:") \
- and getattr(doc, "naming_series", None):
+ if doc.meta.autoname.startswith("naming_series:") and getattr(doc, "naming_series", None):
revert_series_if_last(doc.naming_series, doc.name, doc)
elif doc.meta.autoname.split(":")[0] not in ("Prompt", "field", "hash", "autoincrement"):
revert_series_if_last(doc.meta.autoname, doc.name, doc)
+
def delete_from_table(doctype, name, ignore_doctypes, doc):
- if doctype!="DocType" and doctype==name:
+ if doctype != "DocType" and doctype == name:
frappe.db.delete("Singles", {"doctype": name})
else:
frappe.db.delete(doctype, {"name": name})
@@ -171,21 +202,23 @@ def delete_from_table(doctype, name, ignore_doctypes, doc):
tables = [d.options for d in doc.meta.get_table_fields()]
else:
+
def get_table_fields(field_doctype):
- if field_doctype == 'Custom Field':
+ if field_doctype == "Custom Field":
return []
- return [r[0] for r in frappe.get_all(field_doctype,
- fields='options',
- filters={
- 'fieldtype': ['in', frappe.model.table_fields],
- 'parent': doctype
- },
- as_list=1
- )]
+ return [
+ r[0]
+ for r in frappe.get_all(
+ field_doctype,
+ fields="options",
+ filters={"fieldtype": ["in", frappe.model.table_fields], "parent": doctype},
+ as_list=1,
+ )
+ ]
tables = get_table_fields("DocField")
- if not frappe.flags.in_install=="frappe":
+ if not frappe.flags.in_install == "frappe":
tables += get_table_fields("Custom Field")
# delete from child tables
@@ -193,51 +226,67 @@ def delete_from_table(doctype, name, ignore_doctypes, doc):
if t not in ignore_doctypes:
frappe.db.delete(t, {"parenttype": doctype, "parent": name})
+
def update_flags(doc, flags=None, ignore_permissions=False):
if ignore_permissions:
- if not flags: flags = {}
+ if not flags:
+ flags = {}
flags["ignore_permissions"] = ignore_permissions
if flags:
doc.flags.update(flags)
+
def check_permission_and_not_submitted(doc):
# permission
- if (not doc.flags.ignore_permissions
- and frappe.session.user!="Administrator"
- and (
- not doc.has_permission("delete")
- or (doc.doctype=="DocType" and not doc.custom))):
- frappe.msgprint(_("User not allowed to delete {0}: {1}")
- .format(doc.doctype, doc.name), raise_exception=frappe.PermissionError)
+ if (
+ not doc.flags.ignore_permissions
+ and frappe.session.user != "Administrator"
+ and (not doc.has_permission("delete") or (doc.doctype == "DocType" and not doc.custom))
+ ):
+ frappe.msgprint(
+ _("User not allowed to delete {0}: {1}").format(doc.doctype, doc.name),
+ raise_exception=frappe.PermissionError,
+ )
# check if submitted
if doc.docstatus.is_submitted():
- frappe.msgprint(_("{0} {1}: Submitted Record cannot be deleted. You must {2} Cancel {3} it first.").format(_(doc.doctype), doc.name, "", ""),
- raise_exception=True)
+ frappe.msgprint(
+ _("{0} {1}: Submitted Record cannot be deleted. You must {2} Cancel {3} it first.").format(
+ _(doc.doctype),
+ doc.name,
+ "",
+ "",
+ ),
+ raise_exception=True,
+ )
+
def check_if_doc_is_linked(doc, method="Delete"):
"""
- Raises excption if the given doc(dt, dn) is linked in another record.
+ Raises excption if the given doc(dt, dn) is linked in another record.
"""
from frappe.model.rename_doc import get_link_fields
+
link_fields = get_link_fields(doc.doctype)
- ignore_linked_doctypes = doc.get('ignore_linked_doctypes') or []
+ ignore_linked_doctypes = doc.get("ignore_linked_doctypes") or []
for lf in link_fields:
- link_dt, link_field, issingle = lf['parent'], lf['fieldname'], lf['issingle']
+ link_dt, link_field, issingle = lf["parent"], lf["fieldname"], lf["issingle"]
if not issingle:
fields = ["name", "docstatus"]
if frappe.get_meta(link_dt).istable:
fields.extend(["parent", "parenttype"])
- for item in frappe.db.get_values(link_dt, {link_field:doc.name}, fields , as_dict=True):
+ for item in frappe.db.get_values(link_dt, {link_field: doc.name}, fields, as_dict=True):
# available only in child table cases
item_parent = getattr(item, "parent", None)
linked_doctype = item.parenttype if item_parent else link_dt
- if linked_doctype in doctypes_to_skip or (linked_doctype in ignore_linked_doctypes and method == 'Cancel'):
+ if linked_doctype in doctypes_to_skip or (
+ linked_doctype in ignore_linked_doctypes and method == "Cancel"
+ ):
# don't check for communication and todo!
continue
@@ -257,13 +306,14 @@ def check_if_doc_is_linked(doc, method="Delete"):
if frappe.db.get_value(link_dt, None, link_field) == doc.name:
raise_link_exists_exception(doc, link_dt, link_dt)
+
def check_if_doc_is_dynamically_linked(doc, method="Delete"):
- '''Raise `frappe.LinkExistsError` if the document is dynamically linked'''
+ """Raise `frappe.LinkExistsError` if the document is dynamically linked"""
for df in get_dynamic_link_map().get(doc.doctype, []):
- ignore_linked_doctypes = doc.get('ignore_linked_doctypes') or []
+ ignore_linked_doctypes = doc.get("ignore_linked_doctypes") or []
- if df.parent in doctypes_to_skip or (df.parent in ignore_linked_doctypes and method == 'Cancel'):
+ if df.parent in doctypes_to_skip or (df.parent in ignore_linked_doctypes and method == "Cancel"):
# don't check for communication and todo!
continue
@@ -271,11 +321,14 @@ def check_if_doc_is_dynamically_linked(doc, method="Delete"):
if meta.issingle:
# dynamic link in single doc
refdoc = frappe.db.get_singles_dict(df.parent)
- if (refdoc.get(df.options)==doc.doctype
- and refdoc.get(df.fieldname)==doc.name
- and ((method=="Delete" and refdoc.docstatus < 2)
- or (method=="Cancel" and refdoc.docstatus==1))
- ):
+ if (
+ refdoc.get(df.options) == doc.doctype
+ and refdoc.get(df.fieldname) == doc.name
+ and (
+ (method == "Delete" and refdoc.docstatus < 2)
+ or (method == "Cancel" and refdoc.docstatus == 1)
+ )
+ ):
# raise exception only if
# linked to an non-cancelled doc when deleting
# or linked to a submitted doc when cancelling
@@ -283,10 +336,18 @@ def check_if_doc_is_dynamically_linked(doc, method="Delete"):
else:
# dynamic link in table
df["table"] = ", `parent`, `parenttype`, `idx`" if meta.istable else ""
- for refdoc in frappe.db.sql("""select `name`, `docstatus` {table} from `tab{parent}` where
- {options}=%s and {fieldname}=%s""".format(**df), (doc.doctype, doc.name), as_dict=True):
+ for refdoc in frappe.db.sql(
+ """select `name`, `docstatus` {table} from `tab{parent}` where
+ {options}=%s and {fieldname}=%s""".format(
+ **df
+ ),
+ (doc.doctype, doc.name),
+ as_dict=True,
+ ):
- if ((method=="Delete" and refdoc.docstatus < 2) or (method=="Cancel" and refdoc.docstatus==1)):
+ if (method == "Delete" and refdoc.docstatus < 2) or (
+ method == "Cancel" and refdoc.docstatus == 1
+ ):
# raise exception only if
# linked to an non-cancelled doc when deleting
# or linked to a submitted doc when cancelling
@@ -297,56 +358,78 @@ def check_if_doc_is_dynamically_linked(doc, method="Delete"):
raise_link_exists_exception(doc, reference_doctype, reference_docname, at_position)
-def raise_link_exists_exception(doc, reference_doctype, reference_docname, row=''):
+
+def raise_link_exists_exception(doc, reference_doctype, reference_docname, row=""):
doc_link = '{1}'.format(doc.doctype, doc.name)
- reference_link = '{1}'.format(reference_doctype, reference_docname)
+ reference_link = '{1}'.format(
+ reference_doctype, reference_docname
+ )
- #hack to display Single doctype only once in message
+ # hack to display Single doctype only once in message
if reference_doctype == reference_docname:
- reference_doctype = ''
+ reference_doctype = ""
+
+ frappe.throw(
+ _("Cannot delete or cancel because {0} {1} is linked with {2} {3} {4}").format(
+ doc.doctype, doc_link, reference_doctype, reference_link, row
+ ),
+ frappe.LinkExistsError,
+ )
- frappe.throw(_('Cannot delete or cancel because {0} {1} is linked with {2} {3} {4}')
- .format(doc.doctype, doc_link, reference_doctype, reference_link, row), frappe.LinkExistsError)
def delete_dynamic_links(doctype, name):
- delete_references('ToDo', doctype, name, 'reference_type')
- delete_references('Email Unsubscribe', doctype, name)
- delete_references('DocShare', doctype, name, 'share_doctype', 'share_name')
- delete_references('Version', doctype, name, 'ref_doctype', 'docname')
- delete_references('Comment', doctype, name)
- delete_references('View Log', doctype, name)
- delete_references('Document Follow', doctype, name, 'ref_doctype', 'ref_docname')
- delete_references('Notification Log', doctype, name, 'document_type', 'document_name')
+ delete_references("ToDo", doctype, name, "reference_type")
+ delete_references("Email Unsubscribe", doctype, name)
+ delete_references("DocShare", doctype, name, "share_doctype", "share_name")
+ delete_references("Version", doctype, name, "ref_doctype", "docname")
+ delete_references("Comment", doctype, name)
+ delete_references("View Log", doctype, name)
+ delete_references("Document Follow", doctype, name, "ref_doctype", "ref_docname")
+ delete_references("Notification Log", doctype, name, "document_type", "document_name")
# unlink communications
clear_timeline_references(doctype, name)
- clear_references('Communication', doctype, name)
-
- clear_references('Activity Log', doctype, name)
- clear_references('Activity Log', doctype, name, 'timeline_doctype', 'timeline_name')
-
-def delete_references(doctype, reference_doctype, reference_name,
- reference_doctype_field = 'reference_doctype', reference_name_field = 'reference_name'):
- frappe.db.delete(doctype, {
- reference_doctype_field: reference_doctype,
- reference_name_field: reference_name
- })
-
-def clear_references(doctype, reference_doctype, reference_name,
- reference_doctype_field = 'reference_doctype', reference_name_field = 'reference_name'):
- frappe.db.sql('''update
+ clear_references("Communication", doctype, name)
+
+ clear_references("Activity Log", doctype, name)
+ clear_references("Activity Log", doctype, name, "timeline_doctype", "timeline_name")
+
+
+def delete_references(
+ doctype,
+ reference_doctype,
+ reference_name,
+ reference_doctype_field="reference_doctype",
+ reference_name_field="reference_name",
+):
+ frappe.db.delete(
+ doctype, {reference_doctype_field: reference_doctype, reference_name_field: reference_name}
+ )
+
+
+def clear_references(
+ doctype,
+ reference_doctype,
+ reference_name,
+ reference_doctype_field="reference_doctype",
+ reference_name_field="reference_name",
+):
+ frappe.db.sql(
+ """update
`tab{0}`
set
{1}=NULL, {2}=NULL
where
- {1}=%s and {2}=%s'''.format(doctype, reference_doctype_field, reference_name_field), # nosec
- (reference_doctype, reference_name))
+ {1}=%s and {2}=%s""".format(
+ doctype, reference_doctype_field, reference_name_field
+ ), # nosec
+ (reference_doctype, reference_name),
+ )
+
def clear_timeline_references(link_doctype, link_name):
- frappe.db.delete("Communication Link", {
- "link_doctype": link_doctype,
- "link_name": link_name
- })
+ frappe.db.delete("Communication Link", {"link_doctype": link_doctype, "link_name": link_name})
+
def insert_feed(doc):
if (
@@ -359,13 +442,15 @@ def insert_feed(doc):
from frappe.utils import get_fullname
- frappe.get_doc({
- "doctype": "Comment",
- "comment_type": "Deleted",
- "reference_doctype": doc.doctype,
- "subject": "{0} {1}".format(_(doc.doctype), doc.name),
- "full_name": get_fullname(doc.owner),
- }).insert(ignore_permissions=True)
+ frappe.get_doc(
+ {
+ "doctype": "Comment",
+ "comment_type": "Deleted",
+ "reference_doctype": doc.doctype,
+ "subject": "{0} {1}".format(_(doc.doctype), doc.name),
+ "full_name": get_fullname(doc.owner),
+ }
+ ).insert(ignore_permissions=True)
def delete_controllers(doctype, module):
@@ -373,6 +458,6 @@ def delete_controllers(doctype, module):
Delete controller code in the doctype folder
"""
module_path = get_module_path(module)
- dir_path = os.path.join(module_path, 'doctype', frappe.scrub(doctype))
+ dir_path = os.path.join(module_path, "doctype", frappe.scrub(doctype))
shutil.rmtree(dir_path)
diff --git a/frappe/model/docfield.py b/frappe/model/docfield.py
index c173561b1e..195385a2e1 100644
--- a/frappe/model/docfield.py
+++ b/frappe/model/docfield.py
@@ -5,49 +5,59 @@
import frappe
+
def rename(doctype, fieldname, newname):
"""rename docfield"""
- df = frappe.db.sql("""select * from tabDocField where parent=%s and fieldname=%s""",
- (doctype, fieldname), as_dict=1)
+ df = frappe.db.sql(
+ """select * from tabDocField where parent=%s and fieldname=%s""", (doctype, fieldname), as_dict=1
+ )
if not df:
return
df = df[0]
- if frappe.db.get_value('DocType', doctype, 'issingle'):
+ if frappe.db.get_value("DocType", doctype, "issingle"):
update_single(df, newname)
else:
update_table(df, newname)
update_parent_field(df, newname)
+
def update_single(f, new):
"""update in tabSingles"""
frappe.db.begin()
- frappe.db.sql("""update tabSingles set field=%s where doctype=%s and field=%s""",
- (new, f['parent'], f['fieldname']))
+ frappe.db.sql(
+ """update tabSingles set field=%s where doctype=%s and field=%s""",
+ (new, f["parent"], f["fieldname"]),
+ )
frappe.db.commit()
+
def update_table(f, new):
"""update table"""
query = get_change_column_query(f, new)
if query:
frappe.db.sql(query)
+
def update_parent_field(f, new):
"""update 'parentfield' in tables"""
- if f['fieldtype'] in frappe.model.table_fields:
+ if f["fieldtype"] in frappe.model.table_fields:
frappe.db.begin()
- frappe.db.sql("""update `tab%s` set parentfield=%s where parentfield=%s""" \
- % (f['options'], '%s', '%s'), (new, f['fieldname']))
+ frappe.db.sql(
+ """update `tab%s` set parentfield=%s where parentfield=%s""" % (f["options"], "%s", "%s"),
+ (new, f["fieldname"]),
+ )
frappe.db.commit()
+
def get_change_column_query(f, new):
"""generate change fieldname query"""
- desc = frappe.db.sql("desc `tab%s`" % f['parent'])
+ desc = frappe.db.sql("desc `tab%s`" % f["parent"])
for d in desc:
- if d[0]== f['fieldname']:
- return 'alter table `tab%s` change `%s` `%s` %s' % \
- (f['parent'], f['fieldname'], new, d[1])
+ if d[0] == f["fieldname"]:
+ return "alter table `tab%s` change `%s` `%s` %s" % (f["parent"], f["fieldname"], new, d[1])
+
def supports_translation(fieldtype):
- return fieldtype in ["Data", "Select", "Text", "Small Text", "Text Editor"]
\ No newline at end of file
+ return fieldtype in ["Data", "Select", "Text", "Small Text", "Text Editor"]
diff --git a/frappe/model/document.py b/frappe/model/document.py
index 15e9c28d83..ef2aa9a6dc 100644
--- a/frappe/model/document.py
+++ b/frappe/model/document.py
@@ -3,27 +3,27 @@
import hashlib
import json
import time
+
from werkzeug.exceptions import NotFound
import frappe
-from frappe import _, msgprint, is_whitelisted
-from frappe.utils import flt, cstr, now, get_datetime_str, file_lock, date_diff
+from frappe import _, is_whitelisted, msgprint
+from frappe.core.doctype.server_script.server_script_utils import run_server_script_for_doc_event
+from frappe.desk.form.document_follow import follow_document
+from frappe.integrations.doctype.webhook import run_webhooks
+from frappe.model import optional_fields, table_fields
from frappe.model.base_document import BaseDocument, get_controller
-from frappe.model.naming import set_new_name, validate_name
from frappe.model.docstatus import DocStatus
-from frappe.model import optional_fields, table_fields
-from frappe.model.workflow import validate_workflow
-from frappe.model.workflow import set_workflow_state_on_action
-from frappe.utils.global_search import update_global_search
-from frappe.integrations.doctype.webhook import run_webhooks
-from frappe.desk.form.document_follow import follow_document
-from frappe.core.doctype.server_script.server_script_utils import run_server_script_for_doc_event
+from frappe.model.naming import set_new_name, validate_name
+from frappe.model.workflow import set_workflow_state_on_action, validate_workflow
+from frappe.utils import cstr, date_diff, file_lock, flt, get_datetime_str, now
from frappe.utils.data import get_absolute_url
-
+from frappe.utils.global_search import update_global_search
# once_only validation
# methods
+
def get_doc(*args, **kwargs):
"""returns a frappe.model.Document object.
@@ -33,23 +33,23 @@ def get_doc(*args, **kwargs):
There are multiple ways to call `get_doc`
- # will fetch the latest user object (with child table) from the database
- user = get_doc("User", "test@example.com")
+ # will fetch the latest user object (with child table) from the database
+ user = get_doc("User", "test@example.com")
- # create a new object
- user = get_doc({
- "doctype":"User"
- "email_id": "test@example.com",
- "roles: [
- {"role": "System Manager"}
- ]
- })
+ # create a new object
+ user = get_doc({
+ "doctype":"User"
+ "email_id": "test@example.com",
+ "roles: [
+ {"role": "System Manager"}
+ ]
+ })
- # create new object with keyword arguments
- user = get_doc(doctype='User', email_id='test@example.com')
+ # create new object with keyword arguments
+ user = get_doc(doctype='User', email_id='test@example.com')
- # select a document for update
- user = get_doc("User", "test@example.com", for_update=True)
+ # select a document for update
+ user = get_doc("User", "test@example.com", for_update=True)
"""
if args:
if isinstance(args[0], BaseDocument):
@@ -63,11 +63,11 @@ def get_doc(*args, **kwargs):
kwargs = args[0]
else:
- raise ValueError('First non keyword argument must be a string or dict')
+ raise ValueError("First non keyword argument must be a string or dict")
if len(args) < 2 and kwargs:
- if 'doctype' in kwargs:
- doctype = kwargs['doctype']
+ if "doctype" in kwargs:
+ doctype = kwargs["doctype"]
else:
raise ValueError('"doctype" is a required key')
@@ -77,8 +77,10 @@ def get_doc(*args, **kwargs):
raise ImportError(doctype)
+
class Document(BaseDocument):
"""All controllers inherit from `Document`."""
+
def __init__(self, *args, **kwargs):
"""Constructor.
@@ -117,7 +119,7 @@ class Document(BaseDocument):
else:
# incorrect arguments. let's not proceed.
- raise ValueError('Illegal arguments')
+ raise ValueError("Illegal arguments")
@staticmethod
def whitelist(fn):
@@ -129,9 +131,7 @@ class Document(BaseDocument):
"""Load document and children from database and create properties
from fields"""
if not getattr(self, "_metaclass", False) and self.meta.issingle:
- single_doc = frappe.db.get_singles_dict(
- self.doctype, for_update=self.flags.for_update
- )
+ single_doc = frappe.db.get_singles_dict(self.doctype, for_update=self.flags.for_update)
if not single_doc:
single_doc = frappe.new_doc(self.doctype, as_dict=True)
single_doc["name"] = self.doctype
@@ -142,22 +142,31 @@ class Document(BaseDocument):
self._fix_numeric_types()
else:
- d = frappe.db.get_value(self.doctype, self.name, "*", as_dict=1, for_update=self.flags.for_update)
+ d = frappe.db.get_value(
+ self.doctype, self.name, "*", as_dict=1, for_update=self.flags.for_update
+ )
if not d:
- frappe.throw(_("{0} {1} not found").format(_(self.doctype), self.name), frappe.DoesNotExistError)
+ frappe.throw(
+ _("{0} {1} not found").format(_(self.doctype), self.name), frappe.DoesNotExistError
+ )
super(Document, self).__init__(d)
- if self.name=="DocType" and self.doctype=="DocType":
+ if self.name == "DocType" and self.doctype == "DocType":
from frappe.model.meta import DOCTYPE_TABLE_FIELDS
+
table_fields = DOCTYPE_TABLE_FIELDS
else:
table_fields = self.meta.get_table_fields()
for df in table_fields:
- children = frappe.db.get_values(df.options,
+ children = frappe.db.get_values(
+ df.options,
{"parent": self.name, "parenttype": self.doctype, "parentfield": df.fieldname},
- "*", as_dict=True, order_by="idx asc")
+ "*",
+ as_dict=True,
+ order_by="idx asc",
+ )
if children:
self.set(df.fieldname, children)
else:
@@ -174,7 +183,7 @@ class Document(BaseDocument):
self.latest = frappe.get_doc(self.doctype, self.name)
return self.latest
- def check_permission(self, permtype='read', permlevel=None):
+ def check_permission(self, permtype="read", permlevel=None):
"""Raise `frappe.PermissionError` if not permitted"""
if not self.has_permission(permtype):
self.raise_no_permission_to(permlevel or permtype)
@@ -192,11 +201,18 @@ class Document(BaseDocument):
def raise_no_permission_to(self, perm_type):
"""Raise `frappe.PermissionError`."""
- frappe.flags.error_message = _('Insufficient Permission for {0}').format(self.doctype)
+ frappe.flags.error_message = _("Insufficient Permission for {0}").format(self.doctype)
raise frappe.PermissionError
- def insert(self, ignore_permissions=None, ignore_links=None, ignore_if_duplicate=False,
- ignore_mandatory=None, set_name=None, set_child_names=True):
+ def insert(
+ self,
+ ignore_permissions=None,
+ ignore_links=None,
+ ignore_if_duplicate=False,
+ ignore_mandatory=None,
+ set_name=None,
+ set_child_names=True,
+ ):
"""Insert the document in the database (as a new document).
This will check for user permissions and execute `before_insert`,
`validate`, `on_update`, `after_insert` methods if they are written.
@@ -267,7 +283,9 @@ class Document(BaseDocument):
if hasattr(self, "__unsaved"):
delattr(self, "__unsaved")
- if not (frappe.flags.in_migrate or frappe.local.flags.in_install or frappe.flags.in_setup_wizard):
+ if not (
+ frappe.flags.in_migrate or frappe.local.flags.in_install or frappe.flags.in_setup_wizard
+ ):
if frappe.get_cached_value("User", frappe.session.user, "follow_created_documents"):
follow_document(self.doctype, self.name, frappe.session.user)
return self
@@ -337,20 +355,22 @@ class Document(BaseDocument):
"""Copy attachments from `amended_from`"""
from frappe.desk.form.load import get_attachments
- #loop through attachments
+ # loop through attachments
for attach_item in get_attachments(self.doctype, self.amended_from):
- #save attachments to new doc
- _file = frappe.get_doc({
- "doctype": "File",
- "file_url": attach_item.file_url,
- "file_name": attach_item.file_name,
- "attached_to_name": self.name,
- "attached_to_doctype": self.doctype,
- "folder": "Home/Attachments"})
+ # save attachments to new doc
+ _file = frappe.get_doc(
+ {
+ "doctype": "File",
+ "file_url": attach_item.file_url,
+ "file_name": attach_item.file_name,
+ "attached_to_name": self.name,
+ "attached_to_doctype": self.doctype,
+ "folder": "Home/Attachments",
+ }
+ )
_file.save()
-
def update_children(self):
"""update child tables"""
for df in self.meta.get_table_fields():
@@ -373,29 +393,31 @@ class Document(BaseDocument):
if rows:
# select rows that do not match the ones in the document
- deleted_rows = frappe.db.sql("""select name from `tab{0}` where parent=%s
+ deleted_rows = frappe.db.sql(
+ """select name from `tab{0}` where parent=%s
and parenttype=%s and parentfield=%s
- and name not in ({1})""".format(df.options, ','.join(['%s'] * len(rows))),
- [self.name, self.doctype, fieldname] + rows)
+ and name not in ({1})""".format(
+ df.options, ",".join(["%s"] * len(rows))
+ ),
+ [self.name, self.doctype, fieldname] + rows,
+ )
if len(deleted_rows) > 0:
# delete rows that do not match the ones in the document
frappe.db.delete(df.options, {"name": ("in", tuple(row[0] for row in deleted_rows))})
else:
# no rows found, delete all rows
- frappe.db.delete(df.options, {
- "parent": self.name,
- "parenttype": self.doctype,
- "parentfield": fieldname
- })
+ frappe.db.delete(
+ df.options, {"parent": self.name, "parenttype": self.doctype, "parentfield": fieldname}
+ )
def get_doc_before_save(self):
- return getattr(self, '_doc_before_save', None)
+ return getattr(self, "_doc_before_save", None)
def has_value_changed(self, fieldname):
- '''Returns true if value is changed before and after saving'''
+ """Returns true if value is changed before and after saving"""
previous = self.get_doc_before_save()
- return previous.get(fieldname)!=self.get(fieldname) if previous else True
+ return previous.get(fieldname) != self.get(fieldname) if previous else True
def set_new_name(self, force=False, set_name=None, set_child_names=True):
"""Calls `frappe.naming.set_new_name` for parent and child docs."""
@@ -427,6 +449,7 @@ class Document(BaseDocument):
def set_title_field(self):
"""Set title field based on template"""
+
def get_values():
values = self.as_dict()
# format values
@@ -435,7 +458,7 @@ class Document(BaseDocument):
values[key] = ""
return values
- if self.meta.get("title_field")=="title":
+ if self.meta.get("title_field") == "title":
df = self.meta.get_field(self.meta.title_field)
if df.options:
@@ -446,13 +469,14 @@ class Document(BaseDocument):
def update_single(self, d):
"""Updates values for Single type Document in `tabSingles`."""
- frappe.db.delete("Singles", {
- "doctype": self.doctype
- })
+ frappe.db.delete("Singles", {"doctype": self.doctype})
for field, value in d.items():
if field != "doctype":
- frappe.db.sql("""insert into `tabSingles` (doctype, field, value)
- values (%s, %s, %s)""", (self.doctype, field, value))
+ frappe.db.sql(
+ """insert into `tabSingles` (doctype, field, value)
+ values (%s, %s, %s)""",
+ (self.doctype, field, value),
+ )
if self.doctype in frappe.db.value_cache:
del frappe.db.value_cache[self.doctype]
@@ -464,7 +488,9 @@ class Document(BaseDocument):
# We'd probably want the creation and owner to be set via API
# or Data import at some point, that'd have to be handled here
- if self.is_new() and not (frappe.flags.in_install or frappe.flags.in_patch or frappe.flags.in_migrate):
+ if self.is_new() and not (
+ frappe.flags.in_install or frappe.flags.in_patch or frappe.flags.in_migrate
+ ):
self.creation = self.modified
self.owner = self.modified_by
@@ -518,13 +544,21 @@ class Document(BaseDocument):
def _validate_non_negative(self):
def get_msg(df):
if self.get("parentfield"):
- return "{} {} #{}: {} {}".format(frappe.bold(_(self.doctype)),
- _("Row"), self.idx, _("Value cannot be negative for"), frappe.bold(_(df.label)))
+ return "{} {} #{}: {} {}".format(
+ frappe.bold(_(self.doctype)),
+ _("Row"),
+ self.idx,
+ _("Value cannot be negative for"),
+ frappe.bold(_(df.label)),
+ )
else:
- return _("Value cannot be negative for {0}: {1}").format(_(df.parent), frappe.bold(_(df.label)))
+ return _("Value cannot be negative for {0}: {1}").format(
+ _(df.parent), frappe.bold(_(df.label))
+ )
- for df in self.meta.get('fields', {'non_negative': ('=', 1),
- 'fieldtype': ('in', ['Int', 'Float', 'Currency'])}):
+ for df in self.meta.get(
+ "fields", {"non_negative": ("=", 1), "fieldtype": ("in", ["Int", "Float", "Currency"])}
+ ):
if flt(self.get(df.fieldname)) < 0:
msg = get_msg(df)
@@ -532,11 +566,12 @@ class Document(BaseDocument):
def validate_workflow(self):
"""Validate if the workflow transition is valid"""
- if frappe.flags.in_install == 'frappe': return
+ if frappe.flags.in_install == "frappe":
+ return
workflow = self.meta.get_workflow()
if workflow:
validate_workflow(self)
- if not self._action == 'save':
+ if not self._action == "save":
set_workflow_state_on_action(self, workflow, self._action)
def validate_set_only_once(self):
@@ -552,7 +587,7 @@ class Document(BaseDocument):
if field.fieldtype in table_fields:
fail = not self.is_child_table_same(field.fieldname)
- elif field.fieldtype in ('Date', 'Datetime', 'Time'):
+ elif field.fieldtype in ("Date", "Datetime", "Time"):
fail = str(value) != str(original_value)
else:
fail = value != original_value
@@ -562,7 +597,7 @@ class Document(BaseDocument):
_("Value cannot be changed for {0}").format(
frappe.bold(self.meta.get_label(field.fieldname))
),
- exc=frappe.CannotChangeConstantError
+ exc=frappe.CannotChangeConstantError,
)
return False
@@ -578,11 +613,11 @@ class Document(BaseDocument):
else:
# check all child entries
for i, d in enumerate(original_value):
- new_child = value[i].as_dict(convert_dates_to_str = True)
- original_child = d.as_dict(convert_dates_to_str = True)
+ new_child = value[i].as_dict(convert_dates_to_str=True)
+ original_child = d.as_dict(convert_dates_to_str=True)
# all fields must be same other than modified and modified_by
- for key in ('modified', 'modified_by', 'creation'):
+ for key in ("modified", "modified_by", "creation"):
del new_child[key]
del original_child[key]
@@ -612,7 +647,7 @@ class Document(BaseDocument):
if not has_higher_permlevel:
return
- has_access_to = self.get_permlevel_access('read')
+ has_access_to = self.get_permlevel_access("read")
for df in self.meta.fields:
if df.permlevel and not df.permlevel in has_access_to:
@@ -639,7 +674,8 @@ class Document(BaseDocument):
self.reset_values_if_no_permlevel_access(has_access_to, high_permlevel_fields)
# If new record then don't reset the values for child table
- if self.is_new(): return
+ if self.is_new():
+ return
# check for child tables
for df in self.meta.get_table_fields():
@@ -648,7 +684,7 @@ class Document(BaseDocument):
for d in self.get(df.fieldname):
d.reset_values_if_no_permlevel_access(has_access_to, high_permlevel_fields)
- def get_permlevel_access(self, permission_type='write'):
+ def get_permlevel_access(self, permission_type="write"):
if not hasattr(self, "_has_access_to"):
self._has_access_to = {}
@@ -661,7 +697,7 @@ class Document(BaseDocument):
return self._has_access_to[permission_type]
- def has_permlevel_access_to(self, fieldname, df=None, permission_type='read'):
+ def has_permlevel_access_to(self, fieldname, df=None, permission_type="read"):
if not df:
df = self.meta.get_field(fieldname)
@@ -701,16 +737,25 @@ class Document(BaseDocument):
`self.check_docstatus_transition`."""
conflict = False
self._action = "save"
- if not self.get('__islocal') and not self.meta.get('is_virtual'):
+ if not self.get("__islocal") and not self.meta.get("is_virtual"):
if self.meta.issingle:
- modified = frappe.db.sql("""select value from tabSingles
- where doctype=%s and field='modified' for update""", self.doctype)
+ modified = frappe.db.sql(
+ """select value from tabSingles
+ where doctype=%s and field='modified' for update""",
+ self.doctype,
+ )
modified = modified and modified[0][0]
if modified and modified != cstr(self._original_modified):
conflict = True
else:
- tmp = frappe.db.sql("""select modified, docstatus from `tab{0}`
- where name = %s for update""".format(self.doctype), self.name, as_dict=True)
+ tmp = frappe.db.sql(
+ """select modified, docstatus from `tab{0}`
+ where name = %s for update""".format(
+ self.doctype
+ ),
+ self.name,
+ as_dict=True,
+ )
if not tmp:
frappe.throw(_("Record does not exist"))
@@ -725,10 +770,12 @@ class Document(BaseDocument):
self.check_docstatus_transition(tmp.docstatus)
if conflict:
- frappe.msgprint(_("Error: Document has been modified after you have opened it") \
- + (" (%s, %s). " % (modified, self.modified)) \
- + _("Please refresh to get the latest document."),
- raise_exception=frappe.TimestampMismatchError)
+ frappe.msgprint(
+ _("Error: Document has been modified after you have opened it")
+ + (" (%s, %s). " % (modified, self.modified))
+ + _("Please refresh to get the latest document."),
+ raise_exception=frappe.TimestampMismatchError,
+ )
else:
self.check_docstatus_transition(0)
@@ -752,7 +799,9 @@ class Document(BaseDocument):
self._action = "submit"
self.check_permission("submit")
elif self.docstatus.is_cancelled():
- raise frappe.DocstatusTransitionError(_("Cannot change docstatus from 0 (Draft) to 2 (Cancelled)"))
+ raise frappe.DocstatusTransitionError(
+ _("Cannot change docstatus from 0 (Draft) to 2 (Cancelled)")
+ )
else:
raise frappe.ValidationError(_("Invalid docstatus"), self.docstatus)
@@ -764,7 +813,9 @@ class Document(BaseDocument):
self._action = "cancel"
self.check_permission("cancel")
elif self.docstatus.is_draft():
- raise frappe.DocstatusTransitionError(_("Cannot change docstatus from 1 (Submitted) to 0 (Draft)"))
+ raise frappe.DocstatusTransitionError(
+ _("Cannot change docstatus from 1 (Submitted) to 0 (Draft)")
+ )
else:
raise frappe.ValidationError(_("Invalid docstatus"), self.docstatus)
@@ -814,10 +865,11 @@ class Document(BaseDocument):
if frappe.flags.print_messages:
print(self.as_json().encode("utf-8"))
- raise frappe.MandatoryError('[{doctype}, {name}]: {fields}'.format(
- fields=", ".join((each[0] for each in missing)),
- doctype=self.doctype,
- name=self.name))
+ raise frappe.MandatoryError(
+ "[{doctype}, {name}]: {fields}".format(
+ fields=", ".join((each[0] for each in missing)), doctype=self.doctype, name=self.name
+ )
+ )
def _validate_links(self):
if self.flags.ignore_links or self._action == "cancel":
@@ -832,13 +884,11 @@ class Document(BaseDocument):
if invalid_links:
msg = ", ".join((each[2] for each in invalid_links))
- frappe.throw(_("Could not find {0}").format(msg),
- frappe.LinkValidationError)
+ frappe.throw(_("Could not find {0}").format(msg), frappe.LinkValidationError)
if cancelled_links:
msg = ", ".join((each[2] for each in cancelled_links))
- frappe.throw(_("Cannot link cancelled document: {0}").format(msg),
- frappe.CancelledLinkError)
+ frappe.throw(_("Cannot link cancelled document: {0}").format(msg), frappe.CancelledLinkError)
def get_all_children(self, parenttype=None):
"""Returns all children documents from **Table** type fields in a list."""
@@ -880,7 +930,11 @@ class Document(BaseDocument):
def run_notifications(self, method):
"""Run notifications for this method"""
- if (frappe.flags.in_import and frappe.flags.mute_emails) or frappe.flags.in_patch or frappe.flags.in_install:
+ if (
+ (frappe.flags.in_import and frappe.flags.mute_emails)
+ or frappe.flags.in_patch
+ or frappe.flags.in_install
+ ):
return
if self.flags.notifications_executed is None:
@@ -889,11 +943,14 @@ class Document(BaseDocument):
from frappe.email.doctype.notification.notification import evaluate_alert
if self.flags.notifications is None:
- alerts = frappe.cache().hget('notifications', self.doctype)
+ alerts = frappe.cache().hget("notifications", self.doctype)
if alerts is None:
- alerts = frappe.get_all('Notification', fields=['name', 'event', 'method'],
- filters={'enabled': 1, 'document_type': self.doctype})
- frappe.cache().hset('notifications', self.doctype, alerts)
+ alerts = frappe.get_all(
+ "Notification",
+ fields=["name", "event", "method"],
+ filters={"enabled": 1, "document_type": self.doctype},
+ )
+ frappe.cache().hset("notifications", self.doctype, alerts)
self.flags.notifications = alerts
if not self.flags.notifications:
@@ -908,18 +965,18 @@ class Document(BaseDocument):
"on_update": "Save",
"after_insert": "New",
"on_submit": "Submit",
- "on_cancel": "Cancel"
+ "on_cancel": "Cancel",
}
if not self.flags.in_insert:
# value change is not applicable in insert
- event_map['on_change'] = 'Value Change'
+ event_map["on_change"] = "Value Change"
for alert in self.flags.notifications:
event = event_map.get(method, None)
if event and alert.event == event:
_evaluate_alert(alert)
- elif alert.event=='Method' and method == alert.method:
+ elif alert.event == "Method" and method == alert.method:
_evaluate_alert(alert)
@whitelist.__func__
@@ -930,8 +987,7 @@ class Document(BaseDocument):
@whitelist.__func__
def _cancel(self):
- """Cancel the document. Sets `docstatus` = 2, then saves.
- """
+ """Cancel the document. Sets `docstatus` = 2, then saves."""
self.docstatus = DocStatus.cancelled()
return self.save()
@@ -947,7 +1003,9 @@ class Document(BaseDocument):
def delete(self, ignore_permissions=False):
"""Delete document."""
- frappe.delete_doc(self.doctype, self.name, ignore_permissions = ignore_permissions, flags=self.flags)
+ frappe.delete_doc(
+ self.doctype, self.name, ignore_permissions=ignore_permissions, flags=self.flags
+ )
def run_before_save_methods(self):
"""Run standard methods before `INSERT` or `UPDATE`. Standard Methods are:
@@ -969,15 +1027,15 @@ class Document(BaseDocument):
if self.flags.ignore_validate:
return
- if self._action=="save":
+ if self._action == "save":
self.run_method("validate")
self.run_method("before_save")
- elif self._action=="submit":
+ elif self._action == "submit":
self.run_method("validate")
self.run_method("before_submit")
- elif self._action=="cancel":
+ elif self._action == "cancel":
self.run_method("before_cancel")
- elif self._action=="update_after_submit":
+ elif self._action == "update_after_submit":
self.run_method("before_update_after_submit")
self.set_title_field()
@@ -1000,18 +1058,17 @@ class Document(BaseDocument):
- `on_cancel` for **Cancel**
- `update_after_submit` for **Update after Submit**"""
- if self._action=="save":
+ if self._action == "save":
self.run_method("on_update")
- elif self._action=="submit":
+ elif self._action == "submit":
self.run_method("on_update")
self.run_method("on_submit")
- elif self._action=="cancel":
+ elif self._action == "cancel":
self.run_method("on_cancel")
self.check_no_back_links_exist()
- elif self._action=="update_after_submit":
+ elif self._action == "update_after_submit":
self.run_method("on_update_after_submit")
-
self.clear_cache()
self.notify_update()
@@ -1019,7 +1076,7 @@ class Document(BaseDocument):
self.save_version()
- self.run_method('on_change')
+ self.run_method("on_change")
if (self.doctype, self.name) in frappe.flags.currently_saving:
frappe.flags.currently_saving.remove((self.doctype, self.name))
@@ -1031,23 +1088,30 @@ class Document(BaseDocument):
def reset_seen(self):
"""Clear _seen property and set current user as seen"""
- if getattr(self.meta, 'track_seen', False):
- frappe.db.set_value(self.doctype, self.name, "_seen", json.dumps([frappe.session.user]), update_modified=False)
+ if getattr(self.meta, "track_seen", False):
+ frappe.db.set_value(
+ self.doctype, self.name, "_seen", json.dumps([frappe.session.user]), update_modified=False
+ )
def notify_update(self):
"""Publish realtime that the current document is modified"""
- if frappe.flags.in_patch: return
-
- frappe.publish_realtime("doc_update", {"modified": self.modified, "doctype": self.doctype, "name": self.name},
- doctype=self.doctype, docname=self.name, after_commit=True)
+ if frappe.flags.in_patch:
+ return
- if not self.meta.get("read_only") and not self.meta.get("issingle") and \
- not self.meta.get("istable"):
- data = {
- "doctype": self.doctype,
- "name": self.name,
- "user": frappe.session.user
- }
+ frappe.publish_realtime(
+ "doc_update",
+ {"modified": self.modified, "doctype": self.doctype, "name": self.name},
+ doctype=self.doctype,
+ docname=self.name,
+ after_commit=True,
+ )
+
+ if (
+ not self.meta.get("read_only")
+ and not self.meta.get("issingle")
+ and not self.meta.get("istable")
+ ):
+ data = {"doctype": self.doctype, "name": self.name, "user": frappe.session.user}
frappe.publish_realtime("list_update", data, after_commit=True)
def db_set(self, fieldname, value=None, update_modified=True, notify=False, commit=False):
@@ -1078,12 +1142,19 @@ class Document(BaseDocument):
self.load_doc_before_save()
# to trigger notification on value change
- self.run_method('before_change')
+ self.run_method("before_change")
- frappe.db.set_value(self.doctype, self.name, fieldname, value,
- self.modified, self.modified_by, update_modified=update_modified)
+ frappe.db.set_value(
+ self.doctype,
+ self.name,
+ fieldname,
+ value,
+ self.modified,
+ self.modified_by,
+ update_modified=update_modified,
+ )
- self.run_method('on_change')
+ self.run_method("on_change")
if notify:
self.notify_update()
@@ -1098,7 +1169,8 @@ class Document(BaseDocument):
def check_no_back_links_exist(self):
"""Check if document links to any active document before Cancel."""
- from frappe.model.delete_doc import check_if_doc_is_linked, check_if_doc_is_dynamically_linked
+ from frappe.model.delete_doc import check_if_doc_is_dynamically_linked, check_if_doc_is_linked
+
if not self.flags.ignore_links:
check_if_doc_is_linked(self, method="Cancel")
check_if_doc_is_dynamically_linked(self, method="Cancel")
@@ -1107,14 +1179,16 @@ class Document(BaseDocument):
"""Save version info"""
# don't track version under following conditions
- if (not getattr(self.meta, 'track_changes', False)
- or self.doctype == 'Version'
+ if (
+ not getattr(self.meta, "track_changes", False)
+ or self.doctype == "Version"
or self.flags.ignore_version
or frappe.flags.in_install
- or (not self._doc_before_save and frappe.flags.in_patch)):
+ or (not self._doc_before_save and frappe.flags.in_patch)
+ ):
return
- version = frappe.new_doc('Version')
+ version = frappe.new_doc("Version")
if not self._doc_before_save:
version.for_insert(self)
version.insert(ignore_permissions=True)
@@ -1132,6 +1206,7 @@ class Document(BaseDocument):
Note: If each hooked method returns a value (dict), then all returns are
collated in one dict and returned. Ideally, don't return values in hookable
methods, set properties in the document."""
+
def add_to_return_value(self, new_return_value):
if new_return_value is None:
self._return_value = self.get("_return_value")
@@ -1158,8 +1233,9 @@ class Document(BaseDocument):
hooks = []
method = f.__name__
doc_events = frappe.get_doc_hooks()
- for handler in doc_events.get(self.doctype, {}).get(method, []) \
- + doc_events.get("*", {}).get(method, []):
+ for handler in doc_events.get(self.doctype, {}).get(method, []) + doc_events.get("*", {}).get(
+ method, []
+ ):
hooks.append(frappe.get_attr(handler))
composed = compose(f, *hooks)
@@ -1172,11 +1248,11 @@ class Document(BaseDocument):
if not method:
raise NotFound("Method {0} not found".format(method_name))
- is_whitelisted(getattr(method, '__func__', method))
+ is_whitelisted(getattr(method, "__func__", method))
def validate_value(self, fieldname, condition, val2, doc=None, raise_exception=None):
"""Check that value of fieldname should be 'condition' val2
- else throw Exception."""
+ else throw Exception."""
error_condition_map = {
"in": _("one of"),
"not in": _("none of"),
@@ -1195,7 +1271,9 @@ class Document(BaseDocument):
label = doc.meta.get_label(fieldname)
condition_str = error_condition_map.get(condition, condition)
if doc.get("parentfield"):
- msg = _("Incorrect value in row {0}: {1} must be {2} {3}").format(doc.idx, label, condition_str, val2)
+ msg = _("Incorrect value in row {0}: {1} must be {2} {3}").format(
+ doc.idx, label, condition_str, val2
+ )
else:
msg = _("Incorrect value: {0} must be {1} {2}").format(label, condition_str, val2)
@@ -1206,7 +1284,9 @@ class Document(BaseDocument):
"""Raise exception if Table field is empty."""
if not (isinstance(self.get(parentfield), list) and len(self.get(parentfield)) > 0):
label = self.meta.get_label(parentfield)
- frappe.throw(_("Table {0} cannot be empty").format(label), raise_exception or frappe.EmptyTableError)
+ frappe.throw(
+ _("Table {0} cannot be empty").format(label), raise_exception or frappe.EmptyTableError
+ )
def round_floats_in(self, doc, fieldnames=None):
"""Round floats for all `Currency`, `Float`, `Percent` fields for the given doc.
@@ -1214,8 +1294,10 @@ class Document(BaseDocument):
:param doc: Document whose numeric properties are to be rounded.
:param fieldnames: [Optional] List of fields to be rounded."""
if not fieldnames:
- fieldnames = (df.fieldname for df in
- doc.meta.get("fields", {"fieldtype": ["in", ["Currency", "Float", "Percent"]]}))
+ fieldnames = (
+ df.fieldname
+ for df in doc.meta.get("fields", {"fieldtype": ["in", ["Currency", "Float", "Percent"]]})
+ )
for fieldname in fieldnames:
doc.set(fieldname, flt(doc.get(fieldname), self.precision(fieldname, doc.get("parentfield"))))
@@ -1224,22 +1306,32 @@ class Document(BaseDocument):
"""Returns Desk URL for this document."""
return get_absolute_url(self.doctype, self.name)
- def add_comment(self, comment_type='Comment', text=None, comment_email=None, link_doctype=None, link_name=None, comment_by=None):
+ def add_comment(
+ self,
+ comment_type="Comment",
+ text=None,
+ comment_email=None,
+ link_doctype=None,
+ link_name=None,
+ comment_by=None,
+ ):
"""Add a comment to this document.
:param comment_type: e.g. `Comment`. See Communication for more info."""
- out = frappe.get_doc({
- "doctype":"Comment",
- 'comment_type': comment_type,
- "comment_email": comment_email or frappe.session.user,
- "comment_by": comment_by,
- "reference_doctype": self.doctype,
- "reference_name": self.name,
- "content": text or comment_type,
- "link_doctype": link_doctype,
- "link_name": link_name
- }).insert(ignore_permissions=True)
+ out = frappe.get_doc(
+ {
+ "doctype": "Comment",
+ "comment_type": comment_type,
+ "comment_email": comment_email or frappe.session.user,
+ "comment_by": comment_by,
+ "reference_doctype": self.doctype,
+ "reference_name": self.name,
+ "content": text or comment_type,
+ "link_doctype": link_doctype,
+ "link_name": link_name,
+ }
+ ).insert(ignore_permissions=True)
return out
def add_seen(self, user=None):
@@ -1248,12 +1340,12 @@ class Document(BaseDocument):
user = frappe.session.user
if self.meta.track_seen:
- _seen = self.get('_seen') or []
+ _seen = self.get("_seen") or []
_seen = frappe.parse_json(_seen)
if user not in _seen:
_seen.append(user)
- frappe.db.set_value(self.doctype, self.name, '_seen', json.dumps(_seen), update_modified=False)
+ frappe.db.set_value(self.doctype, self.name, "_seen", json.dumps(_seen), update_modified=False)
frappe.local.flags.commit = True
def add_viewed(self, user=None):
@@ -1261,13 +1353,15 @@ class Document(BaseDocument):
if not user:
user = frappe.session.user
- if hasattr(self.meta, 'track_views') and self.meta.track_views:
- frappe.get_doc({
- "doctype": "View Log",
- "viewed_by": frappe.session.user,
- "reference_doctype": self.doctype,
- "reference_name": self.name,
- }).insert(ignore_permissions=True)
+ if hasattr(self.meta, "track_views") and self.meta.track_views:
+ frappe.get_doc(
+ {
+ "doctype": "View Log",
+ "viewed_by": frappe.session.user,
+ "reference_doctype": self.doctype,
+ "reference_name": self.name,
+ }
+ ).insert(ignore_permissions=True)
frappe.local.flags.commit = True
def get_signature(self):
@@ -1290,7 +1384,7 @@ class Document(BaseDocument):
if not key:
return self.get("__onload", frappe._dict())
- return self.get('__onload')[key]
+ return self.get("__onload")[key]
def queue_action(self, action, **kwargs):
"""Run an action in background. If the action has an inner function,
@@ -1300,16 +1394,23 @@ class Document(BaseDocument):
# See: Stock Reconciliation
from frappe.utils.background_jobs import enqueue
- if hasattr(self, '_' + action):
- action = '_' + action
+ if hasattr(self, "_" + action):
+ action = "_" + action
if file_lock.lock_exists(self.get_signature()):
- frappe.throw(_('This document is currently queued for execution. Please try again'),
- title=_('Document Queued'))
+ frappe.throw(
+ _("This document is currently queued for execution. Please try again"),
+ title=_("Document Queued"),
+ )
self.lock()
- enqueue('frappe.model.document.execute_action', doctype=self.doctype, name=self.name,
- action=action, **kwargs)
+ enqueue(
+ "frappe.model.document.execute_action",
+ doctype=self.doctype,
+ name=self.name,
+ action=action,
+ **kwargs,
+ )
def lock(self, timeout=None):
"""Creates a lock file for the given document. If timeout is set,
@@ -1339,19 +1440,25 @@ class Document(BaseDocument):
Generic validation to verify date sequence
"""
if date_diff(self.get(to_date_field), self.get(from_date_field)) < 0:
- frappe.throw(_('{0} must be after {1}').format(
- frappe.bold(self.meta.get_label(to_date_field)),
- frappe.bold(self.meta.get_label(from_date_field)),
- ), frappe.exceptions.InvalidDates)
+ frappe.throw(
+ _("{0} must be after {1}").format(
+ frappe.bold(self.meta.get_label(to_date_field)),
+ frappe.bold(self.meta.get_label(from_date_field)),
+ ),
+ frappe.exceptions.InvalidDates,
+ )
def get_assigned_users(self):
- assigned_users = frappe.get_all('ToDo',
- fields=['allocated_to'],
+ assigned_users = frappe.get_all(
+ "ToDo",
+ fields=["allocated_to"],
filters={
- 'reference_type': self.doctype,
- 'reference_name': self.name,
- 'status': ('!=', 'Cancelled'),
- }, pluck='allocated_to')
+ "reference_type": self.doctype,
+ "reference_name": self.name,
+ "status": ("!=", "Cancelled"),
+ },
+ pluck="allocated_to",
+ )
users = set(assigned_users)
return users
@@ -1359,11 +1466,13 @@ class Document(BaseDocument):
def add_tag(self, tag):
"""Add a Tag to this document"""
from frappe.desk.doctype.tag.tag import DocTags
+
DocTags(self.doctype).add(self.name, tag)
def get_tags(self):
"""Return a list of Tags attached to this document"""
from frappe.desk.doctype.tag.tag import DocTags
+
return DocTags(self.doctype).get_tags(self.name).split(",")[1:]
def __repr__(self):
@@ -1393,12 +1502,9 @@ def execute_action(doctype, name, action, **kwargs):
# add a comment (?)
if frappe.local.message_log:
- msg = json.loads(frappe.local.message_log[-1]).get('message')
+ msg = json.loads(frappe.local.message_log[-1]).get("message")
else:
- msg = '' + frappe.get_traceback() + '" + frappe.get_traceback() + "' + msg) + doc.add_comment("Comment", _("Action Failed") + "
" + msg) doc.notify_update() - - - diff --git a/frappe/model/dynamic_links.py b/frappe/model/dynamic_links.py index 03f616ef60..523d587389 100644 --- a/frappe/model/dynamic_links.py +++ b/frappe/model/dynamic_links.py @@ -7,7 +7,7 @@ import frappe # the validation message shows the user-facing doctype first. # For example Journal Entry should be validated before GL Entry (which is an internal doctype) -dynamic_link_queries = [ +dynamic_link_queries = [ """select `tabDocField`.parent, `tabDocType`.read_only, `tabDocType`.in_create, `tabDocField`.fieldname, `tabDocField`.options @@ -15,7 +15,6 @@ dynamic_link_queries = [ where `tabDocField`.fieldtype='Dynamic Link' and `tabDocType`.`name`=`tabDocField`.parent order by `tabDocType`.read_only, `tabDocType`.in_create""", - """select `tabCustom Field`.dt as parent, `tabDocType`.read_only, `tabDocType`.in_create, `tabCustom Field`.fieldname, `tabCustom Field`.options @@ -25,14 +24,15 @@ dynamic_link_queries = [ order by `tabDocType`.read_only, `tabDocType`.in_create""", ] + def get_dynamic_link_map(for_delete=False): - '''Build a map of all dynamically linked tables. For example, - if Note is dynamically linked to ToDo, the function will return - `{"Note": ["ToDo"], "Sales Invoice": ["Journal Entry Detail"]}` + """Build a map of all dynamically linked tables. For example, + if Note is dynamically linked to ToDo, the function will return + `{"Note": ["ToDo"], "Sales Invoice": ["Journal Entry Detail"]}` Note: Will not map single doctypes - ''' - if getattr(frappe.local, 'dynamic_link_map', None) is None or frappe.flags.in_test: + """ + if getattr(frappe.local, "dynamic_link_map", None) is None or frappe.flags.in_test: # Build from scratch dynamic_link_map = {} for df in get_dynamic_links(): @@ -45,15 +45,16 @@ def get_dynamic_link_map(for_delete=False): links = frappe.db.sql_list("""select distinct {options} from `tab{parent}`""".format(**df)) for doctype in links: dynamic_link_map.setdefault(doctype, []).append(df) - except frappe.db.TableMissingError: # noqa: E722 + except frappe.db.TableMissingError: # noqa: E722 pass frappe.local.dynamic_link_map = dynamic_link_map return frappe.local.dynamic_link_map + def get_dynamic_links(): - '''Return list of dynamic link fields as DocField. - Uses cache if possible''' + """Return list of dynamic link fields as DocField. + Uses cache if possible""" df = [] for query in dynamic_link_queries: df += frappe.db.sql(query, as_dict=True) diff --git a/frappe/model/mapper.py b/frappe/model/mapper.py index f40a43bb73..6a6522ad07 100644 --- a/frappe/model/mapper.py +++ b/frappe/model/mapper.py @@ -4,16 +4,16 @@ import json import frappe from frappe import _ -from frappe.model import default_fields, table_fields, child_table_fields +from frappe.model import child_table_fields, default_fields, table_fields from frappe.utils import cstr @frappe.whitelist() def make_mapped_doc(method, source_name, selected_children=None, args=None): - '''Returns the mapped document calling the given mapper method. + """Returns the mapped document calling the given mapper method. Sets selected_children as flags for the `get_mapped_doc` method. - Called from `open_mapped_doc` from create_new.js''' + Called from `open_mapped_doc` from create_new.js""" for hook in frappe.get_hooks("override_whitelisted_methods", {}).get(method, []): # override using the first hook @@ -35,13 +35,14 @@ def make_mapped_doc(method, source_name, selected_children=None, args=None): return method(source_name) + @frappe.whitelist() def map_docs(method, source_names, target_doc, args=None): - ''' Returns the mapped document calling the given mapper method + '''Returns the mapped document calling the given mapper method with each of the given source docs on the target doc :param args: Args as string to pass to the mapper method - E.g. args: "{ 'supplier': 'XYZ' }" ''' + E.g. args: "{ 'supplier': 'XYZ' }"''' method = frappe.get_attr(method) if method not in frappe.whitelisted: @@ -52,8 +53,16 @@ def map_docs(method, source_names, target_doc, args=None): target_doc = method(*_args) return target_doc -def get_mapped_doc(from_doctype, from_docname, table_maps, target_doc=None, - postprocess=None, ignore_permissions=False, ignore_child_tables=False): + +def get_mapped_doc( + from_doctype, + from_docname, + table_maps, + target_doc=None, + postprocess=None, + ignore_permissions=False, + ignore_child_tables=False, +): apply_strict_user_permissions = frappe.get_system_settings("apply_strict_user_permissions") @@ -63,8 +72,11 @@ def get_mapped_doc(from_doctype, from_docname, table_maps, target_doc=None, elif isinstance(target_doc, str): target_doc = frappe.get_doc(json.loads(target_doc)) - if (not apply_strict_user_permissions - and not ignore_permissions and not target_doc.has_permission("create")): + if ( + not apply_strict_user_permissions + and not ignore_permissions + and not target_doc.has_permission("create") + ): target_doc.raise_no_permission_to("create") source_doc = frappe.get_doc(from_doctype, from_docname) @@ -88,10 +100,13 @@ def get_mapped_doc(from_doctype, from_docname, table_maps, target_doc=None, target_df = target_doc.meta.get_field(df.fieldname) if target_df: target_child_doctype = target_df.options - if target_df and target_child_doctype==source_child_doctype and not df.no_copy and not target_df.no_copy: - table_map = { - "doctype": target_child_doctype - } + if ( + target_df + and target_child_doctype == source_child_doctype + and not df.no_copy + and not target_df.no_copy + ): + table_map = {"doctype": target_child_doctype} if table_map: for source_d in source_doc.get(df.fieldname): @@ -101,9 +116,11 @@ def get_mapped_doc(from_doctype, from_docname, table_maps, target_doc=None, # if children are selected (checked from UI) for this table type, # and this record is not in the selected children, then continue - if (frappe.flags.selected_children + if ( + frappe.flags.selected_children and (df.fieldname in frappe.flags.selected_children) - and source_d.name not in frappe.flags.selected_children[df.fieldname]): + and source_d.name not in frappe.flags.selected_children[df.fieldname] + ): continue target_child_doctype = table_map["doctype"] @@ -111,11 +128,11 @@ def get_mapped_doc(from_doctype, from_docname, table_maps, target_doc=None, # does row exist for a parentfield? if target_parentfield not in row_exists_for_parentfield: - row_exists_for_parentfield[target_parentfield] = (True - if target_doc.get(target_parentfield) else False) + row_exists_for_parentfield[target_parentfield] = ( + True if target_doc.get(target_parentfield) else False + ) - if table_map.get("add_if_empty") and \ - row_exists_for_parentfield.get(target_parentfield): + if table_map.get("add_if_empty") and row_exists_for_parentfield.get(target_parentfield): continue if table_map.get("filter") and table_map.get("filter")(source_d): @@ -128,29 +145,46 @@ def get_mapped_doc(from_doctype, from_docname, table_maps, target_doc=None, target_doc.set_onload("load_after_mapping", True) - if (apply_strict_user_permissions - and not ignore_permissions and not target_doc.has_permission("create")): + if ( + apply_strict_user_permissions + and not ignore_permissions + and not target_doc.has_permission("create") + ): target_doc.raise_no_permission_to("create") return target_doc + def map_doc(source_doc, target_doc, table_map, source_parent=None): if table_map.get("validation"): for key, condition in table_map["validation"].items(): if condition[0] == "=" and source_doc.get(key) != condition[1]: - frappe.throw(_("Cannot map because following condition fails:") + f" {key}={cstr(condition[1])}") + frappe.throw( + _("Cannot map because following condition fails:") + f" {key}={cstr(condition[1])}" + ) map_fields(source_doc, target_doc, table_map, source_parent) if "postprocess" in table_map: table_map["postprocess"](source_doc, target_doc, source_parent) + def map_fields(source_doc, target_doc, table_map, source_parent): - no_copy_fields = set([d.fieldname for d in source_doc.meta.get("fields") if (d.no_copy==1 or d.fieldtype in table_fields)] - + [d.fieldname for d in target_doc.meta.get("fields") if (d.no_copy==1 or d.fieldtype in table_fields)] + no_copy_fields = set( + [ + d.fieldname + for d in source_doc.meta.get("fields") + if (d.no_copy == 1 or d.fieldtype in table_fields) + ] + + [ + d.fieldname + for d in target_doc.meta.get("fields") + if (d.no_copy == 1 or d.fieldtype in table_fields) + ] + list(default_fields) + list(child_table_fields) - + list(table_map.get("field_no_map", []))) + + list(table_map.get("field_no_map", [])) + ) for df in target_doc.meta.get("fields"): if df.fieldname not in no_copy_fields: @@ -192,6 +226,7 @@ def map_fields(source_doc, target_doc, table_map, source_parent): if target_doc.get(df.fieldname): map_fetch_fields(target_doc, df, no_copy_fields) + def map_fetch_fields(target_doc, df, no_copy_fields): linked_doc = None @@ -200,8 +235,9 @@ def map_fetch_fields(target_doc, df, no_copy_fields): if not (fetch_df.fieldtype == "Read Only" or fetch_df.read_only): continue - if ((not target_doc.get(fetch_df.fieldname) or fetch_df.fieldtype == "Read Only") - and fetch_df.fieldname not in no_copy_fields): + if ( + not target_doc.get(fetch_df.fieldname) or fetch_df.fieldtype == "Read Only" + ) and fetch_df.fieldname not in no_copy_fields: source_fieldname = fetch_df.fetch_from.split(".")[1] if not linked_doc: @@ -215,6 +251,7 @@ def map_fetch_fields(target_doc, df, no_copy_fields): if val not in (None, ""): target_doc.set(fetch_df.fieldname, val) + def map_child_doc(source_d, target_parent, table_map, source_parent=None): target_child_doctype = table_map["doctype"] target_parentfield = target_parent.get_parentfield_of_doctype(target_child_doctype) diff --git a/frappe/model/meta.py b/frappe/model/meta.py index a3d167fb9b..c363e63f4f 100644 --- a/frappe/model/meta.py +++ b/frappe/model/meta.py @@ -3,7 +3,7 @@ # metadata -''' +""" Load metadata (DocType) class Example: @@ -13,7 +13,7 @@ Example: print("DocType" table has field "first_name") -''' +""" import json import os from datetime import datetime @@ -45,19 +45,22 @@ def get_meta(doctype, cached=True): meta = Meta(meta) else: meta = Meta(doctype) - frappe.cache().hset('meta', doctype, meta.as_dict()) + frappe.cache().hset("meta", doctype, meta.as_dict()) frappe.local.meta_cache[doctype] = meta return frappe.local.meta_cache[doctype] else: return load_meta(doctype) + def load_meta(doctype): return Meta(doctype) + def get_table_columns(doctype): return frappe.db.get_table_columns(doctype) + def load_doctype_from_file(doctype): fname = frappe.scrub(doctype) with open(frappe.get_app_path("frappe", "core", "doctype", fname, fname + ".json"), "r") as f: @@ -75,10 +78,19 @@ def load_doctype_from_file(doctype): return txt + class Meta(Document): _metaclass = True default_fields = list(default_fields)[1:] - special_doctypes = ("DocField", "DocPerm", "DocType", "Module Def", 'DocType Action', 'DocType Link', 'DocType State') + special_doctypes = ( + "DocField", + "DocPerm", + "DocType", + "Module Def", + "DocType Action", + "DocType Link", + "DocType State", + ) standard_set_once_fields = [ frappe._dict(fieldname="creation", fieldtype="Datetime"), frappe._dict(fieldname="owner", fieldtype="Data"), @@ -101,7 +113,7 @@ class Meta(Document): try: super(Meta, self).load_from_db() except frappe.DoesNotExistError: - if self.doctype=="DocType" and self.name in self.special_doctypes: + if self.doctype == "DocType" and self.name in self.special_doctypes: self.__dict__.update(load_doctype_from_file(self.name)) else: raise @@ -119,21 +131,22 @@ class Meta(Document): self.set_custom_permissions() self.add_custom_links_and_actions() - def as_dict(self, no_nulls = False): + def as_dict(self, no_nulls=False): def serialize(doc): out = {} for key in doc.__dict__: value = doc.__dict__.get(key) if isinstance(value, (list, tuple)): - if len(value) > 0 and hasattr(value[0], '__dict__'): + if len(value) > 0 and hasattr(value[0], "__dict__"): value = [serialize(d) for d in value] else: # non standard list object, skip continue - if (isinstance(value, (str, int, float, datetime, list, tuple)) - or (not no_nulls and value is None)): + if isinstance(value, (str, int, float, datetime, list, tuple)) or ( + not no_nulls and value is None + ): out[key] = value # set empty lists for unset table fields @@ -146,19 +159,20 @@ class Meta(Document): return serialize(self) def get_link_fields(self): - return self.get("fields", {"fieldtype": "Link", "options":["!=", "[Select]"]}) + return self.get("fields", {"fieldtype": "Link", "options": ["!=", "[Select]"]}) def get_data_fields(self): return self.get("fields", {"fieldtype": "Data"}) def get_dynamic_link_fields(self): - if not hasattr(self, '_dynamic_link_fields'): + if not hasattr(self, "_dynamic_link_fields"): self._dynamic_link_fields = self.get("fields", {"fieldtype": "Dynamic Link"}) return self._dynamic_link_fields def get_select_fields(self): - return self.get("fields", {"fieldtype": "Select", "options":["not in", - ["[Select]", "Loading..."]]}) + return self.get( + "fields", {"fieldtype": "Select", "options": ["not in", ["[Select]", "Loading..."]]} + ) def get_image_fields(self): return self.get("fields", {"fieldtype": "Attach Image"}) @@ -167,7 +181,7 @@ class Meta(Document): return self.get("fields", {"fieldtype": "Code"}) def get_set_only_once_fields(self): - '''Return fields with `set_only_once` set''' + """Return fields with `set_only_once` set""" if not hasattr(self, "_set_only_once_fields"): self._set_only_once_fields = self.get("fields", {"set_only_once": 1}) fieldnames = [d.fieldname for d in self._set_only_once_fields] @@ -180,18 +194,18 @@ class Meta(Document): def get_table_fields(self): if not hasattr(self, "_table_fields"): - if self.name!="DocType": - self._table_fields = self.get('fields', {"fieldtype": ['in', table_fields]}) + if self.name != "DocType": + self._table_fields = self.get("fields", {"fieldtype": ["in", table_fields]}) else: self._table_fields = DOCTYPE_TABLE_FIELDS return self._table_fields def get_global_search_fields(self): - '''Returns list of fields with `in_global_search` set and `name` if set''' + """Returns list of fields with `in_global_search` set and `name` if set""" fields = self.get("fields", {"in_global_search": 1, "fieldtype": ["not in", no_value_fields]}) - if getattr(self, 'show_name_in_global_search', None): - fields.append(frappe._dict(fieldtype='Data', fieldname='name', label='Name')) + if getattr(self, "show_name_in_global_search", None): + fields.append(frappe._dict(fieldtype="Data", fieldname="name", label="Name")) return fields @@ -201,8 +215,9 @@ class Meta(Document): if self.name in self.special_doctypes and table_exists: self._valid_columns = get_table_columns(self.name) else: - self._valid_columns = self.default_fields + \ - [df.fieldname for df in self.get("fields") if df.fieldtype in data_fieldtypes] + self._valid_columns = self.default_fields + [ + df.fieldname for df in self.get("fields") if df.fieldtype in data_fieldtypes + ] if self.istable: self._valid_columns += list(child_table_fields) @@ -218,7 +233,7 @@ class Meta(Document): }.get(fieldname) def get_field(self, fieldname): - '''Return docfield from meta''' + """Return docfield from meta""" if not self._fields: for f in self.get("fields"): self._fields[f.fieldname] = f @@ -226,23 +241,23 @@ class Meta(Document): return self._fields.get(fieldname) def has_field(self, fieldname): - '''Returns True if fieldname exists''' + """Returns True if fieldname exists""" return True if self.get_field(fieldname) else False def get_label(self, fieldname): - '''Get label of the given fieldname''' + """Get label of the given fieldname""" df = self.get_field(fieldname) if df: label = df.label else: label = { - 'name': _('ID'), - 'owner': _('Created By'), - 'modified_by': _('Modified By'), - 'creation': _('Created On'), - 'modified': _('Last Modified On'), - '_assign': _('Assigned To') - }.get(fieldname) or _('No Label') + "name": _("ID"), + "owner": _("Created By"), + "modified_by": _("Modified By"), + "creation": _("Created On"), + "modified": _("Last Modified On"), + "_assign": _("Assigned To"), + }.get(fieldname) or _("No Label") return label def get_options(self, fieldname): @@ -269,11 +284,11 @@ class Meta(Document): return search_fields def get_fields_to_fetch(self, link_fieldname=None): - '''Returns a list of docfield objects for fields whose values + """Returns a list of docfield objects for fields whose values are to be fetched and updated for a particular link field These fields are of type Data, Link, Text, Readonly and their - fetch_from property is set as `link_fieldname`.`source_fieldname`''' + fetch_from property is set as `link_fieldname`.`source_fieldname`""" out = [] @@ -281,45 +296,46 @@ class Meta(Document): link_fields = [df.fieldname for df in self.get_link_fields()] for df in self.fields: - if df.fieldtype not in no_value_fields and getattr(df, 'fetch_from', None): + if df.fieldtype not in no_value_fields and getattr(df, "fetch_from", None): if link_fieldname: - if df.fetch_from.startswith(link_fieldname + '.'): + if df.fetch_from.startswith(link_fieldname + "."): out.append(df) else: - if '.' in df.fetch_from: - fieldname = df.fetch_from.split('.', 1)[0] + if "." in df.fetch_from: + fieldname = df.fetch_from.split(".", 1)[0] if fieldname in link_fields: out.append(df) return out def get_list_fields(self): - list_fields = ["name"] + [d.fieldname \ - for d in self.fields if (d.in_list_view and d.fieldtype in data_fieldtypes)] + list_fields = ["name"] + [ + d.fieldname for d in self.fields if (d.in_list_view and d.fieldtype in data_fieldtypes) + ] if self.title_field and self.title_field not in list_fields: list_fields.append(self.title_field) return list_fields def get_custom_fields(self): - return [d for d in self.fields if d.get('is_custom_field')] + return [d for d in self.fields if d.get("is_custom_field")] def get_title_field(self): - '''Return the title field of this doctype, - explict via `title_field`, or `title` or `name`''' - title_field = getattr(self, 'title_field', None) - if not title_field and self.has_field('title'): - title_field = 'title' + """Return the title field of this doctype, + explict via `title_field`, or `title` or `name`""" + title_field = getattr(self, "title_field", None) + if not title_field and self.has_field("title"): + title_field = "title" if not title_field: - title_field = 'name' + title_field = "name" return title_field def get_translatable_fields(self): - '''Return all fields that are translation enabled''' + """Return all fields that are translation enabled""" return [d.fieldname for d in self.fields if d.translatable] def is_translatable(self, fieldname): - '''Return true of false given a field''' + """Return true of false given a field""" field = self.get_field(fieldname) return field and field.translatable @@ -327,13 +343,18 @@ class Meta(Document): return get_workflow_name(self.name) def add_custom_fields(self): - if not frappe.db.table_exists('Custom Field'): + if not frappe.db.table_exists("Custom Field"): return - custom_fields = frappe.db.sql(""" + custom_fields = frappe.db.sql( + """ SELECT * FROM `tabCustom Field` WHERE dt = %s AND docstatus < 2 - """, (self.name,), as_dict=1, update={"is_custom_field": 1}) + """, + (self.name,), + as_dict=1, + update={"is_custom_field": 1}, + ) self.extend("fields", custom_fields) @@ -343,53 +364,64 @@ class Meta(Document): of the doctype or its child properties like fields, links etc. This method applies the customized properties over the standard meta object """ - if not frappe.db.table_exists('Property Setter'): + if not frappe.db.table_exists("Property Setter"): return - property_setters = frappe.db.sql("""select * from `tabProperty Setter` where - doc_type=%s""", (self.name,), as_dict=1) + property_setters = frappe.db.sql( + """select * from `tabProperty Setter` where + doc_type=%s""", + (self.name,), + as_dict=1, + ) - if not property_setters: return + if not property_setters: + return for ps in property_setters: - if ps.doctype_or_field=='DocType': + if ps.doctype_or_field == "DocType": self.set(ps.property, cast(ps.property_type, ps.value)) - elif ps.doctype_or_field=='DocField': + elif ps.doctype_or_field == "DocField": for d in self.fields: if d.fieldname == ps.field_name: d.set(ps.property, cast(ps.property_type, ps.value)) break - elif ps.doctype_or_field=='DocType Link': + elif ps.doctype_or_field == "DocType Link": for d in self.links: if d.name == ps.row_name: d.set(ps.property, cast(ps.property_type, ps.value)) break - elif ps.doctype_or_field=='DocType Action': + elif ps.doctype_or_field == "DocType Action": for d in self.actions: if d.name == ps.row_name: d.set(ps.property, cast(ps.property_type, ps.value)) break - elif ps.doctype_or_field=='DocType State': + elif ps.doctype_or_field == "DocType State": for d in self.states: if d.name == ps.row_name: d.set(ps.property, cast(ps.property_type, ps.value)) break def add_custom_links_and_actions(self): - for doctype, fieldname in (('DocType Link', 'links'), ('DocType Action', 'actions'), ('DocType State', 'states')): + for doctype, fieldname in ( + ("DocType Link", "links"), + ("DocType Action", "actions"), + ("DocType State", "states"), + ): # ignore_ddl because the `custom` column was added later via a patch - for d in frappe.get_all(doctype, fields='*', filters=dict(parent=self.name, custom=1), ignore_ddl=True): + for d in frappe.get_all( + doctype, fields="*", filters=dict(parent=self.name, custom=1), ignore_ddl=True + ): self.append(fieldname, d) # set the fields in order if specified # order is saved as `links_order` - order = json.loads(self.get('{}_order'.format(fieldname)) or '[]') + order = json.loads(self.get("{}_order".format(fieldname)) or "[]") if order: - name_map = {d.name:d for d in self.get(fieldname)} + name_map = {d.name: d for d in self.get(fieldname)} new_list = [] for name in order: if name in name_map: @@ -419,7 +451,7 @@ class Meta(Document): custom_fields.pop(custom_fields.index(c)) # standard fields - newlist += [df for df in self.get('fields') if not df.get('is_custom_field')] + newlist += [df for df in self.get("fields") if not df.get("is_custom_field")] newlist_fieldnames = [df.fieldname for df in newlist] for i in range(2): @@ -444,23 +476,23 @@ class Meta(Document): self.fields = newlist def set_custom_permissions(self): - '''Reset `permissions` with Custom DocPerm if exists''' + """Reset `permissions` with Custom DocPerm if exists""" if frappe.flags.in_patch or frappe.flags.in_install: return - if not self.istable and self.name not in ('DocType', 'DocField', 'DocPerm', - 'Custom DocPerm'): - custom_perms = frappe.get_all('Custom DocPerm', fields='*', - filters=dict(parent=self.name), update=dict(doctype='Custom DocPerm')) + if not self.istable and self.name not in ("DocType", "DocField", "DocPerm", "Custom DocPerm"): + custom_perms = frappe.get_all( + "Custom DocPerm", + fields="*", + filters=dict(parent=self.name), + update=dict(doctype="Custom DocPerm"), + ) if custom_perms: self.permissions = [Document(d) for d in custom_perms] def get_fieldnames_with_value(self, with_field_meta=False): def is_value_field(docfield): - return not ( - docfield.get("is_virtual") - or docfield.fieldtype in no_value_fields - ) + return not (docfield.get("is_virtual") or docfield.fieldtype in no_value_fields) if with_field_meta: return [df for df in self.fields if is_value_field(df)] @@ -468,19 +500,18 @@ class Meta(Document): return [df.fieldname for df in self.fields if is_value_field(df)] def get_fields_to_check_permissions(self, user_permission_doctypes): - fields = self.get("fields", { - "fieldtype":"Link", - "parent": self.name, - "ignore_user_permissions":("!=", 1), - "options":("in", user_permission_doctypes) - }) + fields = self.get( + "fields", + { + "fieldtype": "Link", + "parent": self.name, + "ignore_user_permissions": ("!=", 1), + "options": ("in", user_permission_doctypes), + }, + ) if self.name in user_permission_doctypes: - fields.append(frappe._dict({ - "label":"Name", - "fieldname":"name", - "options": self.name - })) + fields.append(frappe._dict({"label": "Name", "fieldname": "name", "options": self.name})) return fields @@ -494,7 +525,7 @@ class Meta(Document): return self.high_permlevel_fields - def get_permlevel_access(self, permission_type='read', parenttype=None): + def get_permlevel_access(self, permission_type="read", parenttype=None): has_access_to = [] roles = frappe.get_roles() for perm in self.get_permissions(parenttype): @@ -509,22 +540,22 @@ class Meta(Document): # use parent permissions permissions = frappe.get_meta(parenttype).permissions else: - permissions = self.get('permissions', []) + permissions = self.get("permissions", []) return permissions def get_dashboard_data(self): - '''Returns dashboard setup related to this doctype. + """Returns dashboard setup related to this doctype. This method will return the `data` property in the `[doctype]_dashboard.py` file in the doctype's folder, along with any overrides or extensions implemented in other Frappe applications via hooks. - ''' + """ data = frappe._dict() if not self.custom: try: - module = load_doctype_module(self.name, suffix='_dashboard') - if hasattr(module, 'get_data'): + module = load_doctype_module(self.name, suffix="_dashboard") + if hasattr(module, "get_data"): data = frappe._dict(module.get_data()) except ImportError: pass @@ -538,10 +569,10 @@ class Meta(Document): return data def add_doctype_links(self, data): - '''add `links` child table in standard link dashboard format''' + """add `links` child table in standard link dashboard format""" dashboard_links = [] - if getattr(self, 'links', None): + if getattr(self, "links", None): dashboard_links.extend(self.links) if not data.transactions: @@ -566,16 +597,15 @@ class Meta(Document): doctype = link.parent_doctype or link.link_doctype # group found if link.group and _(group.label) == _(link.group): - if doctype not in group.get('items'): - group.get('items').append(doctype) + if doctype not in group.get("items"): + group.get("items").append(doctype) link.added = True if not link.added: # group not found, make a new group - data.transactions.append(dict( - label = link.group, - items = [link.parent_doctype or link.link_doctype] - )) + data.transactions.append( + dict(label=link.group, items=[link.parent_doctype or link.link_doctype]) + ) if not link.is_child_table: if link.link_fieldname != data.fieldname: @@ -588,26 +618,28 @@ class Meta(Document): data.fieldname = link.link_fieldname data.internal_links[link.parent_doctype] = [link.table_fieldname, link.link_fieldname] - def get_row_template(self): - return self.get_web_template(suffix='_row') + return self.get_web_template(suffix="_row") def get_list_template(self): - return self.get_web_template(suffix='_list') + return self.get_web_template(suffix="_list") - def get_web_template(self, suffix=''): - '''Returns the relative path of the row template for this doctype''' + def get_web_template(self, suffix=""): + """Returns the relative path of the row template for this doctype""" module_name = frappe.scrub(self.module) doctype = frappe.scrub(self.name) - template_path = frappe.get_module_path(module_name, 'doctype', - doctype, 'templates', doctype + suffix + '.html') + template_path = frappe.get_module_path( + module_name, "doctype", doctype, "templates", doctype + suffix + ".html" + ) if os.path.exists(template_path): - return '{module_name}/doctype/{doctype_name}/templates/{doctype_name}{suffix}.html'.format( - module_name = module_name, doctype_name = doctype, suffix=suffix) + return "{module_name}/doctype/{doctype_name}/templates/{doctype_name}{suffix}.html".format( + module_name=module_name, doctype_name=doctype, suffix=suffix + ) return None def is_nested_set(self): - return self.has_field('lft') and self.has_field('rgt') + return self.has_field("lft") and self.has_field("rgt") + DOCTYPE_TABLE_FIELDS = [ frappe._dict({"fieldname": "fields", "options": "DocField"}), @@ -619,18 +651,24 @@ DOCTYPE_TABLE_FIELDS = [ ####### + def is_single(doctype): try: return frappe.db.get_value("DocType", doctype, "issingle") except IndexError: - raise Exception('Cannot determine whether %s is single' % doctype) + raise Exception("Cannot determine whether %s is single" % doctype) + def get_parent_dt(dt): - parent_dt = frappe.db.get_all('DocField', 'parent', dict(fieldtype=['in', frappe.model.table_fields], options=dt), limit=1) - return parent_dt and parent_dt[0].parent or '' + parent_dt = frappe.db.get_all( + "DocField", "parent", dict(fieldtype=["in", frappe.model.table_fields], options=dt), limit=1 + ) + return parent_dt and parent_dt[0].parent or "" + def set_fieldname(field_id, fieldname): - frappe.db.set_value('DocField', field_id, 'fieldname', fieldname) + frappe.db.set_value("DocField", field_id, "fieldname", fieldname) + def get_field_currency(df, doc=None): """get currency based on DocField options and fieldvalue in doc""" @@ -645,14 +683,19 @@ def get_field_currency(df, doc=None): if not getattr(frappe.local, "field_currency", None): frappe.local.field_currency = frappe._dict() - if not (frappe.local.field_currency.get((doc.doctype, doc.name), {}).get(df.fieldname) or - (doc.get("parent") and frappe.local.field_currency.get((doc.doctype, doc.parent), {}).get(df.fieldname))): + if not ( + frappe.local.field_currency.get((doc.doctype, doc.name), {}).get(df.fieldname) + or ( + doc.get("parent") + and frappe.local.field_currency.get((doc.doctype, doc.parent), {}).get(df.fieldname) + ) + ): ref_docname = doc.get("parent") or doc.name if ":" in cstr(df.get("options")): split_opts = df.get("options").split(":") - if len(split_opts)==3 and doc.get(split_opts[1]): + if len(split_opts) == 3 and doc.get(split_opts[1]): currency = frappe.get_cached_value(split_opts[0], doc.get(split_opts[1]), split_opts[2]) else: currency = doc.get(df.get("options")) @@ -665,11 +708,15 @@ def get_field_currency(df, doc=None): currency = frappe.db.get_value(doc.parenttype, doc.parent, df.get("options")) if currency: - frappe.local.field_currency.setdefault((doc.doctype, ref_docname), frappe._dict())\ - .setdefault(df.fieldname, currency) + frappe.local.field_currency.setdefault((doc.doctype, ref_docname), frappe._dict()).setdefault( + df.fieldname, currency + ) + + return frappe.local.field_currency.get((doc.doctype, doc.name), {}).get(df.fieldname) or ( + doc.get("parent") + and frappe.local.field_currency.get((doc.doctype, doc.parent), {}).get(df.fieldname) + ) - return frappe.local.field_currency.get((doc.doctype, doc.name), {}).get(df.fieldname) or \ - (doc.get("parent") and frappe.local.field_currency.get((doc.doctype, doc.parent), {}).get(df.fieldname)) def get_field_precision(df, doc=None, currency=None): """get precision based on DocField options and fieldvalue in doc""" @@ -692,21 +739,12 @@ def get_field_precision(df, doc=None, currency=None): def get_default_df(fieldname): if fieldname in (default_fields + child_table_fields): if fieldname in ("creation", "modified"): - return frappe._dict( - fieldname = fieldname, - fieldtype = "Datetime" - ) + return frappe._dict(fieldname=fieldname, fieldtype="Datetime") elif fieldname in ("idx", "docstatus"): - return frappe._dict( - fieldname = fieldname, - fieldtype = "Int" - ) + return frappe._dict(fieldname=fieldname, fieldtype="Int") - return frappe._dict( - fieldname = fieldname, - fieldtype = "Data" - ) + return frappe._dict(fieldname=fieldname, fieldtype="Data") def trim_tables(doctype=None, dry_run=False, quiet=False): @@ -729,7 +767,9 @@ def trim_tables(doctype=None, dry_run=False, quiet=False): if quiet: continue click.secho(f"Ignoring missing table for DocType: {doctype}", fg="yellow", err=True) - click.secho(f"Consider removing record in the DocType table for {doctype}", fg="yellow", err=True) + click.secho( + f"Consider removing record in the DocType table for {doctype}", fg="yellow", err=True + ) except Exception as e: if quiet: continue @@ -739,14 +779,12 @@ def trim_tables(doctype=None, dry_run=False, quiet=False): def trim_table(doctype, dry_run=True): - frappe.cache().hdel('table_columns', f"tab{doctype}") + frappe.cache().hdel("table_columns", f"tab{doctype}") ignore_fields = default_fields + optional_fields + child_table_fields columns = frappe.db.get_table_columns(doctype) fields = frappe.get_meta(doctype, cached=False).get_fieldnames_with_value() is_internal = lambda f: f not in ignore_fields and not f.startswith("_") - columns_to_remove = [ - f for f in list(set(columns) - set(fields)) if is_internal(f) - ] + columns_to_remove = [f for f in list(set(columns) - set(fields)) if is_internal(f)] DROPPED_COLUMNS = columns_to_remove[:] if columns_to_remove and not dry_run: diff --git a/frappe/model/naming.py b/frappe/model/naming.py index 013e5a19db..eb755851fb 100644 --- a/frappe/model/naming.py +++ b/frappe/model/naming.py @@ -1,14 +1,15 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -from typing import Optional, TYPE_CHECKING, Union +import re +from typing import TYPE_CHECKING, Optional, Union + import frappe from frappe import _ from frappe.database.sequence import get_next_val, set_next_val -from frappe.utils import now_datetime, cint, cstr -import re from frappe.model import log_types from frappe.query_builder import DocType +from frappe.utils import cint, cstr, now_datetime if TYPE_CHECKING: from frappe.model.meta import Meta @@ -70,20 +71,22 @@ def set_new_name(doc): if not doc.name: doc.name = make_autoname("hash", doc.doctype) - doc.name = validate_name( - doc.doctype, - doc.name, - meta.get_field("name_case") - ) + doc.name = validate_name(doc.doctype, doc.name, meta.get_field("name_case")) + def is_autoincremented(doctype: str, meta: "Meta" = None): if doctype in log_types: - if frappe.local.autoincremented_status_map.get(frappe.local.site) is None or \ - frappe.local.autoincremented_status_map[frappe.local.site] == -1: - if frappe.db.sql( - f"""select data_type FROM information_schema.columns + if ( + frappe.local.autoincremented_status_map.get(frappe.local.site) is None + or frappe.local.autoincremented_status_map[frappe.local.site] == -1 + ): + if ( + frappe.db.sql( + f"""select data_type FROM information_schema.columns where column_name = 'name' and table_name = 'tab{doctype}'""" - )[0][0] == "bigint": + )[0][0] + == "bigint" + ): frappe.local.autoincremented_status_map[frappe.local.site] = 1 return True else: @@ -104,6 +107,7 @@ def is_autoincremented(doctype: str, meta: "Meta" = None): return False + def set_name_from_naming_options(autoname, doc): """ Get a name based on the autoname field option @@ -122,20 +126,26 @@ def set_name_from_naming_options(autoname, doc): elif "#" in autoname: doc.name = make_autoname(autoname, doc=doc) + def set_naming_from_document_naming_rule(doc): - ''' + """ Evaluate rules based on "Document Naming Series" doctype - ''' + """ if doc.doctype in log_types: return # ignore_ddl if naming is not yet bootstrapped - for d in frappe.get_all('Document Naming Rule', - dict(document_type=doc.doctype, disabled=0), order_by='priority desc', ignore_ddl=True): - frappe.get_cached_doc('Document Naming Rule', d.name).apply(doc) + for d in frappe.get_all( + "Document Naming Rule", + dict(document_type=doc.doctype, disabled=0), + order_by="priority desc", + ignore_ddl=True, + ): + frappe.get_cached_doc("Document Naming Rule", d.name).apply(doc) if doc.name: break + def set_name_by_naming_series(doc): """Sets name by the `naming_series` property""" if not doc.naming_series: @@ -144,25 +154,26 @@ def set_name_by_naming_series(doc): if not doc.naming_series: frappe.throw(frappe._("Naming Series mandatory")) - doc.name = make_autoname(doc.naming_series+".#####", "", doc) + doc.name = make_autoname(doc.naming_series + ".#####", "", doc) + def make_autoname(key="", doctype="", doc=""): """ - Creates an autoname from the given key: + Creates an autoname from the given key: - **Autoname rules:** + **Autoname rules:** - * The key is separated by '.' - * '####' represents a series. The string before this part becomes the prefix: - Example: ABC.#### creates a series ABC0001, ABC0002 etc - * 'MM' represents the current month - * 'YY' and 'YYYY' represent the current year + * The key is separated by '.' + * '####' represents a series. The string before this part becomes the prefix: + Example: ABC.#### creates a series ABC0001, ABC0002 etc + * 'MM' represents the current month + * 'YY' and 'YYYY' represent the current year - *Example:* + *Example:* - * DE/./.YY./.MM./.##### will create a series like - DE/09/01/0001 where 09 is the year, 01 is the month and 0001 is the series + * DE/./.YY./.MM./.##### will create a series like + DE/09/01/0001 where 09 is the year, 01 is the month and 0001 is the series """ if key == "hash": return frappe.generate_hash(doctype, 10) @@ -176,40 +187,40 @@ def make_autoname(key="", doctype="", doc=""): frappe.throw(error_message) - parts = key.split('.') + parts = key.split(".") n = parse_naming_series(parts, doctype, doc) return n -def parse_naming_series(parts, doctype='', doc=''): - n = '' +def parse_naming_series(parts, doctype="", doc=""): + n = "" if isinstance(parts, str): - parts = parts.split('.') + parts = parts.split(".") series_set = False today = now_datetime() for e in parts: - part = '' - if e.startswith('#'): + part = "" + if e.startswith("#"): if not series_set: digits = len(e) part = getseries(n, digits) series_set = True - elif e == 'YY': - part = today.strftime('%y') - elif e == 'MM': - part = today.strftime('%m') - elif e == 'DD': + elif e == "YY": + part = today.strftime("%y") + elif e == "MM": + part = today.strftime("%m") + elif e == "DD": part = today.strftime("%d") - elif e == 'YYYY': - part = today.strftime('%Y') - elif e == 'WW': + elif e == "YYYY": + part = today.strftime("%Y") + elif e == "WW": part = determine_consecutive_week_number(today) - elif e == 'timestamp': + elif e == "timestamp": part = str(today) - elif e == 'FY': + elif e == "FY": part = frappe.defaults.get_user_default("fiscal_year") - elif e.startswith('{') and doc: - e = e.replace('{', '').replace('}', '') + elif e.startswith("{") and doc: + e = e.replace("{", "").replace("}", "") part = doc.get(e) elif doc and doc.get(e): part = doc.get(e) @@ -226,12 +237,12 @@ def determine_consecutive_week_number(datetime): """Determines the consecutive calendar week""" m = datetime.month # ISO 8601 calandar week - w = datetime.strftime('%V') + w = datetime.strftime("%V") # Ensure consecutiveness for the first and last days of a year if m == 1 and int(w) >= 52: - w = '00' + w = "00" elif m == 12 and int(w) <= 1: - w = '53' + w = "53" return w @@ -239,12 +250,7 @@ def getseries(key, digits): # series created ? # Using frappe.qb as frappe.get_values does not allow order_by=None series = DocType("Series") - current = ( - frappe.qb.from_(series) - .where(series.name == key) - .for_update() - .select("current") - ).run() + current = (frappe.qb.from_(series).where(series.name == key).for_update().select("current")).run() if current and current[0][0] is not None: current = current[0][0] @@ -255,7 +261,7 @@ def getseries(key, digits): # no, create it frappe.db.sql("INSERT INTO `tabSeries` (`name`, `current`) VALUES (%s, 1)", (key,)) current = 1 - return ('%0'+str(digits)+'d') % current + return ("%0" + str(digits) + "d") % current def revert_series_if_last(key, name, doc=None): @@ -273,15 +279,15 @@ def revert_series_if_last(key, name, doc=None): 2. If hash doesn't exit in hashes, we get the hash from prefix, then update name and prefix accordingly. *Example:* - 1. key = SINV-.YYYY.- - * If key doesn't have hash it will add hash at the end - * prefix will be SINV-YYYY based on this will get current index from Series table. - 2. key = SINV-.####.-2021 - * now prefix = SINV-#### and hashes = 2021 (hash doesn't exist) - * will search hash in key then accordingly get prefix = SINV- - 3. key = ####.-2021 - * prefix = #### and hashes = 2021 (hash doesn't exist) - * will search hash in key then accordingly get prefix = "" + 1. key = SINV-.YYYY.- + * If key doesn't have hash it will add hash at the end + * prefix will be SINV-YYYY based on this will get current index from Series table. + 2. key = SINV-.####.-2021 + * now prefix = SINV-#### and hashes = 2021 (hash doesn't exist) + * will search hash in key then accordingly get prefix = SINV- + 3. key = ####.-2021 + * prefix = #### and hashes = 2021 (hash doesn't exist) + * will search hash in key then accordingly get prefix = "" """ if ".#" in key: prefix, hashes = key.rsplit(".", 1) @@ -295,19 +301,16 @@ def revert_series_if_last(key, name, doc=None): else: prefix = key - if '.' in prefix: - prefix = parse_naming_series(prefix.split('.'), doc=doc) + if "." in prefix: + prefix = parse_naming_series(prefix.split("."), doc=doc) count = cint(name.replace(prefix, "")) series = DocType("Series") current = ( - frappe.qb.from_(series) - .where(series.name == prefix) - .for_update() - .select("current") + frappe.qb.from_(series).where(series.name == prefix).for_update().select("current") ).run() - if current and current[0][0]==count: + if current and current[0][0] == count: frappe.db.sql("UPDATE `tabSeries` SET `current` = `current` - 1 WHERE `name`=%s", prefix) @@ -334,8 +337,10 @@ def validate_name(doctype: str, name: Union[int, str], case: Optional[str] = Non frappe.throw(_("Invalid name type (integer) for varchar name column"), frappe.NameError) - if name.startswith("New "+doctype): - frappe.throw(_("There were some errors setting the name, please contact the administrator"), frappe.NameError) + if name.startswith("New " + doctype): + frappe.throw( + _("There were some errors setting the name, please contact the administrator"), frappe.NameError + ) if case == "Title Case": name = name.title() if case == "UPPER CASE": @@ -348,7 +353,9 @@ def validate_name(doctype: str, name: Union[int, str], case: Optional[str] = Non special_characters = "<>" if re.findall("[{0}]+".format(special_characters), name): message = ", ".join("'{0}'".format(c) for c in special_characters) - frappe.throw(_("Name cannot contain special characters like {0}").format(message), frappe.NameError) + frappe.throw( + _("Name cannot contain special characters like {0}").format(message), frappe.NameError + ) return name @@ -362,14 +369,15 @@ def append_number_if_name_exists(doctype, value, fieldname="name", separator="-" regex = "^{value}{separator}\\d+$".format(value=re.escape(value), separator=separator) if exists: - last = frappe.db.sql("""SELECT `{fieldname}` FROM `tab{doctype}` + last = frappe.db.sql( + """SELECT `{fieldname}` FROM `tab{doctype}` WHERE `{fieldname}` {regex_character} %s ORDER BY length({fieldname}) DESC, `{fieldname}` DESC LIMIT 1""".format( - doctype=doctype, - fieldname=fieldname, - regex_character=frappe.db.REGEX_CHARACTER), - regex) + doctype=doctype, fieldname=fieldname, regex_character=frappe.db.REGEX_CHARACTER + ), + regex, + ) if last: count = str(cint(last[0][0].rsplit(separator, 1)[1]) + 1) @@ -401,6 +409,7 @@ def _field_autoname(autoname, doc, skip_slicing=None): name = (cstr(doc.get(fieldname)) or "").strip() return name + def _prompt_autoname(autoname, doc): """ Generate a name using Prompt option. This simply means the user will have to set the name manually. @@ -410,6 +419,7 @@ def _prompt_autoname(autoname, doc): if not doc.name: frappe.throw(_("Please set the document name")) + def _format_autoname(autoname, doc): """ Generate autoname by replacing all instances of braced params (fields, date params ('DD', 'MM', 'YY'), series) @@ -419,7 +429,7 @@ def _format_autoname(autoname, doc): """ first_colon_index = autoname.find(":") - autoname_value = autoname[first_colon_index + 1:] + autoname_value = autoname[first_colon_index + 1 :] def get_param_value_for_match(match): param = match.group() diff --git a/frappe/model/rename_doc.py b/frappe/model/rename_doc.py index b4a53e3131..dee364ae8d 100644 --- a/frappe/model/rename_doc.py +++ b/frappe/model/rename_doc.py @@ -23,10 +23,10 @@ def update_document_title( title: Optional[str] = None, name: Optional[str] = None, merge: bool = False, - **kwargs + **kwargs, ) -> str: """ - Update title from header in form view + Update title from header in form view """ # to maintain backwards API compatibility @@ -43,7 +43,9 @@ def update_document_title( title_field = doc.meta.get_title_field() - title_updated = updated_title and (title_field != "name") and (updated_title != doc.get(title_field)) + title_updated = ( + updated_title and (title_field != "name") and (updated_title != doc.get(title_field)) + ) name_updated = updated_name and (updated_name != doc.name) if name_updated: @@ -64,6 +66,7 @@ def update_document_title( return docname + def rename_doc( doctype: str, old: str, @@ -84,8 +87,10 @@ def rename_doc( frappe.errprint(_("Failed: {0} to {1} because {1} already exists.").format(old, new)) return - if old==new: - frappe.errprint(_("Ignored: {0} to {1} no changes made because old and new name are the same.").format(old, new)) + if old == new: + frappe.errprint( + _("Ignored: {0} to {1} no changes made because old and new name are the same.").format(old, new) + ) return force = cint(force) @@ -112,7 +117,7 @@ def rename_doc( # save the user settings in the db update_user_settings(old, new, link_fields) - if doctype=='DocType': + if doctype == "DocType": rename_doctype(doctype, old, new) update_customizations(old, new) @@ -134,13 +139,18 @@ def rename_doc( rename_password(doctype, old, new) # update user_permissions - frappe.db.sql("""UPDATE `tabDefaultValue` SET `defvalue`=%s WHERE `parenttype`='User Permission' - AND `defkey`=%s AND `defvalue`=%s""", (new, doctype, old)) + frappe.db.sql( + """UPDATE `tabDefaultValue` SET `defvalue`=%s WHERE `parenttype`='User Permission' + AND `defkey`=%s AND `defvalue`=%s""", + (new, doctype, old), + ) if merge: - new_doc.add_comment('Edit', _("merged {0} into {1}").format(frappe.bold(old), frappe.bold(new))) + new_doc.add_comment("Edit", _("merged {0} into {1}").format(frappe.bold(old), frappe.bold(new))) else: - new_doc.add_comment('Edit', _("renamed from {0} to {1}").format(frappe.bold(old), frappe.bold(new))) + new_doc.add_comment( + "Edit", _("renamed from {0} to {1}").format(frappe.bold(old), frappe.bold(new)) + ) if merge: frappe.delete_doc(doctype, old) @@ -148,54 +158,69 @@ def rename_doc( new_doc.clear_cache() frappe.clear_cache() if rebuild_search: - frappe.enqueue('frappe.utils.global_search.rebuild_for_doctype', doctype=doctype) + frappe.enqueue("frappe.utils.global_search.rebuild_for_doctype", doctype=doctype) if show_alert: - frappe.msgprint(_('Document renamed from {0} to {1}').format(bold(old), bold(new)), alert=True, indicator='green') + frappe.msgprint( + _("Document renamed from {0} to {1}").format(bold(old), bold(new)), + alert=True, + indicator="green", + ) return new + def update_assignments(old: str, new: str, doctype: str) -> None: - old_assignments = frappe.parse_json(frappe.db.get_value(doctype, old, '_assign')) or [] - new_assignments = frappe.parse_json(frappe.db.get_value(doctype, new, '_assign')) or [] + old_assignments = frappe.parse_json(frappe.db.get_value(doctype, old, "_assign")) or [] + new_assignments = frappe.parse_json(frappe.db.get_value(doctype, new, "_assign")) or [] common_assignments = list(set(old_assignments).intersection(new_assignments)) for user in common_assignments: # delete todos linked to old doc - todos = frappe.db.get_all('ToDo', + todos = frappe.db.get_all( + "ToDo", { - 'owner': user, - 'reference_type': doctype, - 'reference_name': old, + "owner": user, + "reference_type": doctype, + "reference_name": old, }, - ['name', 'description'] + ["name", "description"], ) for todo in todos: - frappe.delete_doc('ToDo', todo.name) + frappe.delete_doc("ToDo", todo.name) unique_assignments = list(set(old_assignments + new_assignments)) - frappe.db.set_value(doctype, new, '_assign', frappe.as_json(unique_assignments, indent=0)) + frappe.db.set_value(doctype, new, "_assign", frappe.as_json(unique_assignments, indent=0)) + def update_user_settings(old: str, new: str, link_fields: List[Dict]) -> None: - ''' - Update the user settings of all the linked doctypes while renaming. - ''' + """ + Update the user settings of all the linked doctypes while renaming. + """ # store the user settings data from the redis to db sync_user_settings() - if not link_fields: return + if not link_fields: + return # find the user settings for the linked doctypes linked_doctypes = {d.parent for d in link_fields if not d.issingle} - user_settings_details = frappe.db.sql('''SELECT `user`, `doctype`, `data` + user_settings_details = frappe.db.sql( + """SELECT `user`, `doctype`, `data` FROM `__UserSettings` WHERE `data` like %s - AND `doctype` IN ('{doctypes}')'''.format(doctypes="', '".join(linked_doctypes)), (old), as_dict=1) + AND `doctype` IN ('{doctypes}')""".format( + doctypes="', '".join(linked_doctypes) + ), + (old), + as_dict=1, + ) # create the dict using the doctype name as key and values as list of the user settings from collections import defaultdict + user_settings_dict = defaultdict(list) for user_setting in user_settings_details: user_settings_dict[user_setting.doctype].append(user_setting) @@ -209,53 +234,63 @@ def update_user_settings(old: str, new: str, link_fields: List[Dict]) -> None: else: continue + def update_customizations(old: str, new: str) -> None: frappe.db.set_value("Custom DocPerm", {"parent": old}, "parent", new, update_modified=False) + def update_attachments(doctype: str, old: str, new: str) -> None: try: if old != "File Data" and doctype != "DocType": - frappe.db.sql("""update `tabFile` set attached_to_name=%s - where attached_to_name=%s and attached_to_doctype=%s""", (new, old, doctype)) + frappe.db.sql( + """update `tabFile` set attached_to_name=%s + where attached_to_name=%s and attached_to_doctype=%s""", + (new, old, doctype), + ) except frappe.db.ProgrammingError as e: if not frappe.db.is_column_missing(e): raise + def rename_versions(doctype: str, old: str, new: str) -> None: - frappe.db.sql("""UPDATE `tabVersion` SET `docname`=%s WHERE `ref_doctype`=%s AND `docname`=%s""", - (new, doctype, old)) + frappe.db.sql( + """UPDATE `tabVersion` SET `docname`=%s WHERE `ref_doctype`=%s AND `docname`=%s""", + (new, doctype, old), + ) + def rename_eps_records(doctype: str, old: str, new: str) -> None: epl = frappe.qb.DocType("Energy Point Log") - (frappe.qb.update(epl) + ( + frappe.qb.update(epl) .set(epl.reference_name, new) - .where( - (epl.reference_doctype == doctype) - & (epl.reference_name == old) - ) + .where((epl.reference_doctype == doctype) & (epl.reference_name == old)) ).run() + def rename_parent_and_child(doctype: str, old: str, new: str, meta: "Meta") -> None: # rename the doc - frappe.db.sql("UPDATE `tab{0}` SET `name`={1} WHERE `name`={1}".format(doctype, '%s'), (new, old)) + frappe.db.sql("UPDATE `tab{0}` SET `name`={1} WHERE `name`={1}".format(doctype, "%s"), (new, old)) update_autoname_field(doctype, new, meta) update_child_docs(old, new, meta) + def update_autoname_field(doctype: str, new: str, meta: "Meta") -> None: # update the value of the autoname field on rename of the docname - if meta.get('autoname'): - field = meta.get('autoname').split(':') + if meta.get("autoname"): + field = meta.get("autoname").split(":") if field and field[0] == "field": - frappe.db.sql("UPDATE `tab{0}` SET `{1}`={2} WHERE `name`={2}".format(doctype, field[1], '%s'), (new, new)) + frappe.db.sql( + "UPDATE `tab{0}` SET `{1}`={2} WHERE `name`={2}".format(doctype, field[1], "%s"), (new, new) + ) -def validate_rename(doctype: str, new: str, meta: "Meta", merge: bool, force: bool, ignore_permissions: bool) -> str: + +def validate_rename( + doctype: str, new: str, meta: "Meta", merge: bool, force: bool, ignore_permissions: bool +) -> str: # using for update so that it gets locked and someone else cannot edit it while this rename is going on! exists = ( - frappe.qb.from_(doctype) - .where(Field("name") == new) - .for_update() - .select("name") - .run(pluck=True) + frappe.qb.from_(doctype).where(Field("name") == new).for_update().select("name").run(pluck=True) ) exists = exists[0] if exists else None @@ -269,7 +304,9 @@ def validate_rename(doctype: str, new: str, meta: "Meta", merge: bool, force: bo if (not merge) and exists: frappe.throw(_("Another {0} with name {1} exists, select another name").format(doctype, new)) - if not (ignore_permissions or frappe.permissions.has_permission(doctype, "write", raise_exception=False)): + if not ( + ignore_permissions or frappe.permissions.has_permission(doctype, "write", raise_exception=False) + ): frappe.throw(_("You need write permission to rename")) if not (force or ignore_permissions) and not meta.allow_rename: @@ -280,6 +317,7 @@ def validate_rename(doctype: str, new: str, meta: "Meta", merge: bool, force: bo return new + def rename_doctype(doctype: str, old: str, new: str) -> None: # change options for fieldtype Table, Table MultiSelect and Link fields_with_options = ("Link",) + frappe.model.table_fields @@ -295,19 +333,22 @@ def rename_doctype(doctype: str, old: str, new: str) -> None: # change parenttype for fieldtype Table update_parenttype_values(old, new) + def update_child_docs(old: str, new: str, meta: "Meta") -> None: # update "parent" for df in meta.get_table_fields(): - frappe.db.sql("update `tab%s` set parent=%s where parent=%s" \ - % (df.options, '%s', '%s'), (new, old)) + frappe.db.sql( + "update `tab%s` set parent=%s where parent=%s" % (df.options, "%s", "%s"), (new, old) + ) + def update_link_field_values(link_fields: List[Dict], old: str, new: str, doctype: str) -> None: for field in link_fields: - if field['issingle']: + if field["issingle"]: try: - single_doc = frappe.get_doc(field['parent']) - if single_doc.get(field['fieldname'])==old: - single_doc.set(field['fieldname'], new) + single_doc = frappe.get_doc(field["parent"]) + if single_doc.get(field["fieldname"]) == old: + single_doc.set(field["fieldname"], new) # update single docs using ORM rather then query # as single docs also sometimes sets defaults! single_doc.flags.ignore_mandatory = True @@ -317,7 +358,7 @@ def update_link_field_values(link_fields: List[Dict], old: str, new: str, doctyp # or no longer exists pass else: - parent = field['parent'] + parent = field["parent"] docfield = field["fieldname"] # Handles the case where one of the link fields belongs to @@ -333,8 +374,9 @@ def update_link_field_values(link_fields: List[Dict], old: str, new: str, doctyp frappe.db.set_value(parent, {docfield: old}, docfield, new, update_modified=False) # update cached link_fields as per new - if doctype=='DocType' and field['parent'] == old: - field['parent'] = new + if doctype == "DocType" and field["parent"] == old: + field["parent"] = new + def get_link_fields(doctype: str) -> List[Dict]: # get link fields from tabDocField @@ -342,28 +384,37 @@ def get_link_fields(doctype: str) -> List[Dict]: frappe.flags.link_fields = {} if doctype not in frappe.flags.link_fields: - link_fields = frappe.db.sql("""\ + link_fields = frappe.db.sql( + """\ select parent, fieldname, (select issingle from tabDocType dt where dt.name = df.parent) as issingle from tabDocField df where - df.options=%s and df.fieldtype='Link'""", (doctype,), as_dict=1) + df.options=%s and df.fieldtype='Link'""", + (doctype,), + as_dict=1, + ) # get link fields from tabCustom Field - custom_link_fields = frappe.db.sql("""\ + custom_link_fields = frappe.db.sql( + """\ select dt as parent, fieldname, (select issingle from tabDocType dt where dt.name = df.dt) as issingle from `tabCustom Field` df where - df.options=%s and df.fieldtype='Link'""", (doctype,), as_dict=1) + df.options=%s and df.fieldtype='Link'""", + (doctype,), + as_dict=1, + ) # add custom link fields list to link fields list link_fields += custom_link_fields # remove fields whose options have been changed using property setter - property_setter_link_fields = frappe.db.sql("""\ + property_setter_link_fields = frappe.db.sql( + """\ select ps.doc_type as parent, ps.field_name as fieldname, (select issingle from tabDocType dt where dt.name = ps.doc_type) as issingle @@ -371,7 +422,10 @@ def get_link_fields(doctype: str) -> List[Dict]: where ps.property_type='options' and ps.field_name is not null and - ps.value=%s""", (doctype,), as_dict=1) + ps.value=%s""", + (doctype,), + as_dict=1, + ) link_fields += property_setter_link_fields @@ -379,6 +433,7 @@ def get_link_fields(doctype: str) -> List[Dict]: return frappe.flags.link_fields[doctype] + def update_options_for_fieldtype(fieldtype: str, old: str, new: str) -> None: if frappe.conf.developer_mode: for name in frappe.get_all("DocField", filters={"options": old}, pluck="parent"): @@ -391,45 +446,68 @@ def update_options_for_fieldtype(fieldtype: str, old: str, new: str) -> None: if save: doctype.save() else: - frappe.db.sql("""update `tabDocField` set options=%s - where fieldtype=%s and options=%s""", (new, fieldtype, old)) + frappe.db.sql( + """update `tabDocField` set options=%s + where fieldtype=%s and options=%s""", + (new, fieldtype, old), + ) - frappe.db.sql("""update `tabCustom Field` set options=%s - where fieldtype=%s and options=%s""", (new, fieldtype, old)) + frappe.db.sql( + """update `tabCustom Field` set options=%s + where fieldtype=%s and options=%s""", + (new, fieldtype, old), + ) + + frappe.db.sql( + """update `tabProperty Setter` set value=%s + where property='options' and value=%s""", + (new, old), + ) - frappe.db.sql("""update `tabProperty Setter` set value=%s - where property='options' and value=%s""", (new, old)) def get_select_fields(old: str, new: str) -> List[Dict]: """ - get select type fields where doctype's name is hardcoded as - new line separated list + get select type fields where doctype's name is hardcoded as + new line separated list """ # get link fields from tabDocField - select_fields = frappe.db.sql(""" + select_fields = frappe.db.sql( + """ select parent, fieldname, (select issingle from tabDocType dt where dt.name = df.parent) as issingle from tabDocField df where df.parent != %s and df.fieldtype = 'Select' and - df.options like {0} """.format(frappe.db.escape('%' + old + '%')), (new,), as_dict=1) + df.options like {0} """.format( + frappe.db.escape("%" + old + "%") + ), + (new,), + as_dict=1, + ) # get link fields from tabCustom Field - custom_select_fields = frappe.db.sql(""" + custom_select_fields = frappe.db.sql( + """ select dt as parent, fieldname, (select issingle from tabDocType dt where dt.name = df.dt) as issingle from `tabCustom Field` df where df.dt != %s and df.fieldtype = 'Select' and - df.options like {0} """ .format(frappe.db.escape('%' + old + '%')), (new,), as_dict=1) + df.options like {0} """.format( + frappe.db.escape("%" + old + "%") + ), + (new,), + as_dict=1, + ) # add custom link fields list to link fields list select_fields += custom_select_fields # remove fields whose options have been changed using property setter - property_setter_select_fields = frappe.db.sql(""" + property_setter_select_fields = frappe.db.sql( + """ select ps.doc_type as parent, ps.field_name as fieldname, (select issingle from tabDocType dt where dt.name = ps.doc_type) as issingle @@ -438,88 +516,110 @@ def get_select_fields(old: str, new: str) -> List[Dict]: ps.doc_type != %s and ps.property_type='options' and ps.field_name is not null and - ps.value like {0} """.format(frappe.db.escape('%' + old + '%')), (new,), as_dict=1) + ps.value like {0} """.format( + frappe.db.escape("%" + old + "%") + ), + (new,), + as_dict=1, + ) select_fields += property_setter_select_fields return select_fields + def update_select_field_values(old: str, new: str): - frappe.db.sql(""" + frappe.db.sql( + """ update `tabDocField` set options=replace(options, %s, %s) where parent != %s and fieldtype = 'Select' and - (options like {0} or options like {1})""" - .format(frappe.db.escape('%' + '\n' + old + '%'), frappe.db.escape('%' + old + '\n' + '%')), (old, new, new)) + (options like {0} or options like {1})""".format( + frappe.db.escape("%" + "\n" + old + "%"), frappe.db.escape("%" + old + "\n" + "%") + ), + (old, new, new), + ) - frappe.db.sql(""" + frappe.db.sql( + """ update `tabCustom Field` set options=replace(options, %s, %s) where dt != %s and fieldtype = 'Select' and - (options like {0} or options like {1})""" - .format(frappe.db.escape('%' + '\n' + old + '%'), frappe.db.escape('%' + old + '\n' + '%')), (old, new, new)) + (options like {0} or options like {1})""".format( + frappe.db.escape("%" + "\n" + old + "%"), frappe.db.escape("%" + old + "\n" + "%") + ), + (old, new, new), + ) - frappe.db.sql(""" + frappe.db.sql( + """ update `tabProperty Setter` set value=replace(value, %s, %s) where doc_type != %s and field_name is not null and property='options' and - (value like {0} or value like {1})""" - .format(frappe.db.escape('%' + '\n' + old + '%'), frappe.db.escape('%' + old + '\n' + '%')), (old, new, new)) + (value like {0} or value like {1})""".format( + frappe.db.escape("%" + "\n" + old + "%"), frappe.db.escape("%" + old + "\n" + "%") + ), + (old, new, new), + ) + def update_parenttype_values(old: str, new: str): - child_doctypes = frappe.db.get_all('DocField', - fields=['options', 'fieldname'], - filters={ - 'parent': new, - 'fieldtype': ['in', frappe.model.table_fields] - } + child_doctypes = frappe.db.get_all( + "DocField", + fields=["options", "fieldname"], + filters={"parent": new, "fieldtype": ["in", frappe.model.table_fields]}, ) - custom_child_doctypes = frappe.db.get_all('Custom Field', - fields=['options', 'fieldname'], - filters={ - 'dt': new, - 'fieldtype': ['in', frappe.model.table_fields] - } + custom_child_doctypes = frappe.db.get_all( + "Custom Field", + fields=["options", "fieldname"], + filters={"dt": new, "fieldtype": ["in", frappe.model.table_fields]}, ) child_doctypes += custom_child_doctypes - fields = [d['fieldname'] for d in child_doctypes] + fields = [d["fieldname"] for d in child_doctypes] property_setter_child_doctypes = frappe.get_all( "Property Setter", - filters={ - "doc_type": new, - "property": "options", - "field_name": ("in", fields) - }, - pluck="value" + filters={"doc_type": new, "property": "options", "field_name": ("in", fields)}, + pluck="value", ) - child_doctypes = list(d['options'] for d in child_doctypes) + child_doctypes = list(d["options"] for d in child_doctypes) child_doctypes += property_setter_child_doctypes for doctype in child_doctypes: frappe.db.sql(f"update `tab{doctype}` set parenttype=%s where parenttype=%s", (new, old)) + def rename_dynamic_links(doctype: str, old: str, new: str): for df in get_dynamic_link_map().get(doctype, []): # dynamic link in single, just one value to check if frappe.get_meta(df.parent).issingle: refdoc = frappe.db.get_singles_dict(df.parent) - if refdoc.get(df.options)==doctype and refdoc.get(df.fieldname)==old: + if refdoc.get(df.options) == doctype and refdoc.get(df.fieldname) == old: - frappe.db.sql("""update tabSingles set value=%s where - field=%s and value=%s and doctype=%s""", (new, df.fieldname, old, df.parent)) + frappe.db.sql( + """update tabSingles set value=%s where + field=%s and value=%s and doctype=%s""", + (new, df.fieldname, old, df.parent), + ) else: # because the table hasn't been renamed yet! parent = df.parent if df.parent != new else old - frappe.db.sql("""update `tab{parent}` set {fieldname}=%s - where {options}=%s and {fieldname}=%s""".format(parent = parent, - fieldname=df.fieldname, options=df.options), (new, doctype, old)) - -def bulk_rename(doctype: str, rows: Optional[List[List]] = None, via_console: bool = False) -> Optional[List[str]]: + frappe.db.sql( + """update `tab{parent}` set {fieldname}=%s + where {options}=%s and {fieldname}=%s""".format( + parent=parent, fieldname=df.fieldname, options=df.options + ), + (new, doctype, old), + ) + + +def bulk_rename( + doctype: str, rows: Optional[List[List]] = None, via_console: bool = False +) -> Optional[List[str]]: """Bulk rename documents :param doctype: DocType to be renamed @@ -553,13 +653,17 @@ def bulk_rename(doctype: str, rows: Optional[List[List]] = None, via_console: bo else: rename_log.append(msg) - frappe.enqueue('frappe.utils.global_search.rebuild_for_doctype', doctype=doctype) + frappe.enqueue("frappe.utils.global_search.rebuild_for_doctype", doctype=doctype) if not via_console: return rename_log -def update_linked_doctypes(doctype: str, docname: str, linked_to: str, value: str, ignore_doctypes: Optional[List] = None) -> None: + +def update_linked_doctypes( + doctype: str, docname: str, linked_to: str, value: str, ignore_doctypes: Optional[List] = None +) -> None: from frappe.model.utils.rename_doc import update_linked_doctypes + show_deprecation_warning("update_linked_doctypes") return update_linked_doctypes( @@ -571,16 +675,19 @@ def update_linked_doctypes(doctype: str, docname: str, linked_to: str, value: st ) -def get_fetch_fields(doctype: str, linked_to: str, ignore_doctypes: Optional[List] = None) -> List[Dict]: +def get_fetch_fields( + doctype: str, linked_to: str, ignore_doctypes: Optional[List] = None +) -> List[Dict]: from frappe.model.utils.rename_doc import get_fetch_fields + show_deprecation_warning("get_fetch_fields") - return get_fetch_fields( - doctype=doctype, linked_to=linked_to, ignore_doctypes=ignore_doctypes - ) + return get_fetch_fields(doctype=doctype, linked_to=linked_to, ignore_doctypes=ignore_doctypes) + def show_deprecation_warning(funct: str) -> None: from click import secho + message = ( f"Function frappe.model.rename_doc.{funct} has been deprecated and " "moved to the frappe.model.utils.rename_doc" diff --git a/frappe/model/sync.py b/frappe/model/sync.py index 109260d0fe..a56d1f267f 100644 --- a/frappe/model/sync.py +++ b/frappe/model/sync.py @@ -4,8 +4,9 @@ Sync's doctype and docfields from txt files to database perms will get synced only if none exist """ -import frappe import os + +import frappe from frappe.modules.import_file import import_file_by_path from frappe.modules.patch_handler import block_user from frappe.utils import update_progress_bar @@ -30,14 +31,27 @@ def sync_for(app_name, force=0, reset_permissions=False): FRAPPE_PATH = frappe.get_app_path("frappe") - for core_module in ["docfield", "docperm", "doctype_action", "doctype_link", "doctype_state", "role", "has_role", "doctype"]: + for core_module in [ + "docfield", + "docperm", + "doctype_action", + "doctype_link", + "doctype_state", + "role", + "has_role", + "doctype", + ]: files.append(os.path.join(FRAPPE_PATH, "core", "doctype", core_module, f"{core_module}.json")) for custom_module in ["custom_field", "property_setter"]: - files.append(os.path.join(FRAPPE_PATH, "custom", "doctype", custom_module, f"{custom_module}.json")) + files.append( + os.path.join(FRAPPE_PATH, "custom", "doctype", custom_module, f"{custom_module}.json") + ) for website_module in ["web_form", "web_template", "web_form_field", "portal_menu_item"]: - files.append(os.path.join(FRAPPE_PATH, "website", "doctype", website_module, f"{website_module}.json")) + files.append( + os.path.join(FRAPPE_PATH, "website", "doctype", website_module, f"{website_module}.json") + ) for data_migration_module in [ "data_migration_mapping_detail", @@ -45,7 +59,15 @@ def sync_for(app_name, force=0, reset_permissions=False): "data_migration_plan_mapping", "data_migration_plan", ]: - files.append(os.path.join(FRAPPE_PATH, "data_migration", "doctype", data_migration_module, f"{data_migration_module}.json")) + files.append( + os.path.join( + FRAPPE_PATH, + "data_migration", + "doctype", + data_migration_module, + f"{data_migration_module}.json", + ) + ) for desk_module in [ "number_card", @@ -70,7 +92,9 @@ def sync_for(app_name, force=0, reset_permissions=False): if l: for i, doc_path in enumerate(files): - import_file_by_path(doc_path, force=force, ignore_version=True, reset_permissions=reset_permissions) + import_file_by_path( + doc_path, force=force, ignore_version=True, reset_permissions=reset_permissions + ) frappe.db.commit() diff --git a/frappe/model/utils/__init__.py b/frappe/model/utils/__init__.py index 4cdca5e394..a0dd0d89e8 100644 --- a/frappe/model/utils/__init__.py +++ b/frappe/model/utils/__init__.py @@ -1,92 +1,104 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import io +import re + import frappe from frappe import _ -from frappe.utils import cstr from frappe.build import html_to_js_template -import re -import io +from frappe.utils import cstr STANDARD_FIELD_CONVERSION_MAP = { - 'name': 'Link', - 'owner': 'Data', - 'idx': 'Int', - 'creation': 'Data', - 'modified': 'Data', - 'modified_by': 'Data', - '_user_tags': 'Data', - '_liked_by': 'Data', - '_comments': 'Text', - '_assign': 'Text', - 'docstatus': 'Int' + "name": "Link", + "owner": "Data", + "idx": "Int", + "creation": "Data", + "modified": "Data", + "modified_by": "Data", + "_user_tags": "Data", + "_liked_by": "Data", + "_comments": "Text", + "_assign": "Text", + "docstatus": "Int", } """ Model utilities, unclassified functions """ + def set_default(doc, key): """Set is_default property of given doc and unset all others filtered by given key.""" if not doc.is_default: frappe.db.set(doc, "is_default", 1) - frappe.db.sql("""update `tab%s` set `is_default`=0 - where `%s`=%s and name!=%s""" % (doc.doctype, key, "%s", "%s"), - (doc.get(key), doc.name)) + frappe.db.sql( + """update `tab%s` set `is_default`=0 + where `%s`=%s and name!=%s""" + % (doc.doctype, key, "%s", "%s"), + (doc.get(key), doc.name), + ) + def set_field_property(filters, key, value): - '''utility set a property in all fields of a particular type''' - docs = [frappe.get_doc('DocType', d.parent) for d in \ - frappe.get_all("DocField", fields=['parent'], filters=filters)] + """utility set a property in all fields of a particular type""" + docs = [ + frappe.get_doc("DocType", d.parent) + for d in frappe.get_all("DocField", fields=["parent"], filters=filters) + ] for d in docs: - d.get('fields', filters)[0].set(key, value) + d.get("fields", filters)[0].set(key, value) d.save() - print('Updated {0}'.format(d.name)) + print("Updated {0}".format(d.name)) frappe.db.commit() -class InvalidIncludePath(frappe.ValidationError): pass + +class InvalidIncludePath(frappe.ValidationError): + pass + def render_include(content): - '''render {% raw %}{% include "app/path/filename" %}{% endraw %} in js file''' + """render {% raw %}{% include "app/path/filename" %}{% endraw %} in js file""" content = cstr(content) # try 5 levels of includes for i in range(5): if "{% include" in content: - paths = re.findall(r'''{% include\s['"](.*)['"]\s%}''', content) + paths = re.findall(r"""{% include\s['"](.*)['"]\s%}""", content) if not paths: - frappe.throw(_('Invalid include path'), InvalidIncludePath) + frappe.throw(_("Invalid include path"), InvalidIncludePath) for path in paths: - app, app_path = path.split('/', 1) - with io.open(frappe.get_app_path(app, app_path), 'r', encoding = 'utf-8') as f: + app, app_path = path.split("/", 1) + with io.open(frappe.get_app_path(app, app_path), "r", encoding="utf-8") as f: include = f.read() - if path.endswith('.html'): + if path.endswith(".html"): include = html_to_js_template(path, include) - content = re.sub(r'''{{% include\s['"]{0}['"]\s%}}'''.format(path), include, content) + content = re.sub(r"""{{% include\s['"]{0}['"]\s%}}""".format(path), include, content) else: break return content + def get_fetch_values(doctype, fieldname, value): - '''Returns fetch value dict for the given object + """Returns fetch value dict for the given object :param doctype: Target doctype :param fieldname: Link fieldname selected :param value: Value selected - ''' + """ out = {} meta = frappe.get_meta(doctype) link_df = meta.get_field(fieldname) for df in meta.get_fields_to_fetch(fieldname): # example shipping_address.gistin - link_field, source_fieldname = df.fetch_from.split('.', 1) + link_field, source_fieldname = df.fetch_from.split(".", 1) out[df.fieldname] = frappe.db.get_value(link_df.options, value, source_fieldname) return out diff --git a/frappe/model/utils/link_count.py b/frappe/model/utils/link_count.py index 404b6ec855..25dfe58139 100644 --- a/frappe/model/utils/link_count.py +++ b/frappe/model/utils/link_count.py @@ -3,23 +3,24 @@ import frappe -ignore_doctypes = ("DocType", "Print Format", "Role", "Module Def", "Communication", - "ToDo") +ignore_doctypes = ("DocType", "Print Format", "Role", "Module Def", "Communication", "ToDo") + def notify_link_count(doctype, name): - '''updates link count for given document''' - if hasattr(frappe.local, 'link_count'): + """updates link count for given document""" + if hasattr(frappe.local, "link_count"): if (doctype, name) in frappe.local.link_count: frappe.local.link_count[(doctype, name)] += 1 else: frappe.local.link_count[(doctype, name)] = 1 + def flush_local_link_count(): - '''flush from local before ending request''' - if not getattr(frappe.local, 'link_count', None): + """flush from local before ending request""" + if not getattr(frappe.local, "link_count", None): return - link_count = frappe.cache().get_value('_link_count') + link_count = frappe.cache().get_value("_link_count") if not link_count: link_count = {} @@ -29,20 +30,24 @@ def flush_local_link_count(): else: link_count[key] = frappe.local.link_count[key] - frappe.cache().set_value('_link_count', link_count) + frappe.cache().set_value("_link_count", link_count) + def update_link_count(): - '''increment link count in the `idx` column for the given document''' - link_count = frappe.cache().get_value('_link_count') + """increment link count in the `idx` column for the given document""" + link_count = frappe.cache().get_value("_link_count") if link_count: for key, count in link_count.items(): if key[0] not in ignore_doctypes: try: - frappe.db.sql('update `tab{0}` set idx = idx + {1} where name=%s'.format(key[0], count), - key[1], auto_commit=1) + frappe.db.sql( + "update `tab{0}` set idx = idx + {1} where name=%s".format(key[0], count), + key[1], + auto_commit=1, + ) except Exception as e: - if not frappe.db.is_table_missing(e): # table not found, single + if not frappe.db.is_table_missing(e): # table not found, single raise e # reset the count - frappe.cache().delete_value('_link_count') + frappe.cache().delete_value("_link_count") diff --git a/frappe/model/utils/rename_doc.py b/frappe/model/utils/rename_doc.py index f7afbd0cf2..00e2d78d5f 100644 --- a/frappe/model/utils/rename_doc.py +++ b/frappe/model/utils/rename_doc.py @@ -8,7 +8,9 @@ import frappe from frappe.model.rename_doc import get_link_fields -def update_linked_doctypes(doctype: str, docname: str, linked_to: str, value: str, ignore_doctypes: Optional[List] = None): +def update_linked_doctypes( + doctype: str, docname: str, linked_to: str, value: str, ignore_doctypes: Optional[List] = None +): """ linked_doctype_info_list = list formed by get_fetch_fields() function docname = Master DocType's name in which modification are made @@ -20,26 +22,28 @@ def update_linked_doctypes(doctype: str, docname: str, linked_to: str, value: st frappe.db.set_value( d.doctype, { - d.master_fieldname : docname, - d.linked_to_fieldname : ("!=", value), + d.master_fieldname: docname, + d.linked_to_fieldname: ("!=", value), }, d.linked_to_fieldname, value, ) -def get_fetch_fields(doctype: str, linked_to: str, ignore_doctypes: Optional[List] = None) -> List[Dict]: +def get_fetch_fields( + doctype: str, linked_to: str, ignore_doctypes: Optional[List] = None +) -> List[Dict]: """ doctype = Master DocType in which the changes are being made linked_to = DocType name of the field thats being updated in Master This function fetches list of all DocType where both doctype and linked_to is found as link fields. Forms a list of dict in the form - - [{doctype: , master_fieldname: , linked_to_fieldname: ] + [{doctype: , master_fieldname: , linked_to_fieldname: ] where - doctype = DocType where changes need to be made - master_fieldname = Fieldname where options = doctype - linked_to_fieldname = Fieldname where options = linked_to + doctype = DocType where changes need to be made + master_fieldname = Fieldname where options = doctype + linked_to_fieldname = Fieldname where options = linked_to """ out = [] diff --git a/frappe/model/utils/rename_field.py b/frappe/model/utils/rename_field.py index c9c454b7e8..56e69455ef 100644 --- a/frappe/model/utils/rename_field.py +++ b/frappe/model/utils/rename_field.py @@ -1,10 +1,11 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import json + +import frappe from frappe.model import no_value_fields, table_fields +from frappe.model.utils.user_settings import sync_user_settings, update_user_settings_data from frappe.utils.password import rename_password_field -from frappe.model.utils.user_settings import update_user_settings_data, sync_user_settings def rename_field(doctype, old_fieldname, new_fieldname): @@ -23,19 +24,23 @@ def rename_field(doctype, old_fieldname, new_fieldname): if new_field.fieldtype in table_fields: # change parentfield of table mentioned in options - frappe.db.sql("""update `tab%s` set parentfield=%s - where parentfield=%s""" % (new_field.options.split("\n")[0], "%s", "%s"), - (new_fieldname, old_fieldname)) + frappe.db.sql( + """update `tab%s` set parentfield=%s + where parentfield=%s""" + % (new_field.options.split("\n")[0], "%s", "%s"), + (new_fieldname, old_fieldname), + ) elif new_field.fieldtype not in no_value_fields: if meta.issingle: - frappe.db.sql("""update `tabSingles` set field=%s + frappe.db.sql( + """update `tabSingles` set field=%s where doctype=%s and field=%s""", - (new_fieldname, doctype, old_fieldname)) + (new_fieldname, doctype, old_fieldname), + ) else: # copy field value - frappe.db.sql("""update `tab%s` set `%s`=`%s`""" % \ - (doctype, new_fieldname, old_fieldname)) + frappe.db.sql("""update `tab%s` set `%s`=`%s`""" % (doctype, new_fieldname, old_fieldname)) update_reports(doctype, old_fieldname, new_fieldname) update_users_report_view_settings(doctype, old_fieldname, new_fieldname) @@ -43,35 +48,38 @@ def rename_field(doctype, old_fieldname, new_fieldname): if new_field.fieldtype == "Password": rename_password_field(doctype, old_fieldname, new_fieldname) - # update in property setter update_property_setters(doctype, old_fieldname, new_fieldname) # update in user settings update_user_settings(doctype, old_fieldname, new_fieldname) + def update_reports(doctype, old_fieldname, new_fieldname): def _get_new_sort_by(report_dict, report, key): sort_by = report_dict.get(key) or "" if sort_by: sort_by = sort_by.split(".") if len(sort_by) > 1: - if sort_by[0]==doctype and sort_by[1]==old_fieldname: + if sort_by[0] == doctype and sort_by[1] == old_fieldname: sort_by = doctype + "." + new_fieldname report_dict["updated"] = True - elif report.ref_doctype == doctype and sort_by[0]==old_fieldname: + elif report.ref_doctype == doctype and sort_by[0] == old_fieldname: sort_by = doctype + "." + new_fieldname report_dict["updated"] = True if isinstance(sort_by, list): - sort_by = '.'.join(sort_by) + sort_by = ".".join(sort_by) return sort_by - reports = frappe.db.sql("""select name, ref_doctype, json from tabReport + reports = frappe.db.sql( + """select name, ref_doctype, json from tabReport where report_type = 'Report Builder' and ifnull(is_standard, 'No') = 'No' and json like %s and json like %s""", - ('%%%s%%' % old_fieldname , '%%%s%%' % doctype), as_dict=True) + ("%%%s%%" % old_fieldname, "%%%s%%" % doctype), + as_dict=True, + ) for r in reports: report_dict = json.loads(r.json) @@ -101,48 +109,68 @@ def update_reports(doctype, old_fieldname, new_fieldname): new_sort_by_next = _get_new_sort_by(report_dict, r, "sort_by_next") if report_dict.get("updated"): - new_val = json.dumps({ - "filters": new_filters, - "columns": new_columns, - "sort_by": new_sort_by, - "sort_order": report_dict.get("sort_order"), - "sort_by_next": new_sort_by_next, - "sort_order_next": report_dict.get("sort_order_next") - }) + new_val = json.dumps( + { + "filters": new_filters, + "columns": new_columns, + "sort_by": new_sort_by, + "sort_order": report_dict.get("sort_order"), + "sort_by_next": new_sort_by_next, + "sort_order_next": report_dict.get("sort_order_next"), + } + ) frappe.db.sql("""update `tabReport` set `json`=%s where name=%s""", (new_val, r.name)) + def update_users_report_view_settings(doctype, ref_fieldname, new_fieldname): - user_report_cols = frappe.db.sql("""select defkey, defvalue from `tabDefaultValue` where - defkey like '_list_settings:%'""") + user_report_cols = frappe.db.sql( + """select defkey, defvalue from `tabDefaultValue` where + defkey like '_list_settings:%'""" + ) for key, value in user_report_cols: new_columns = [] columns_modified = False for field, field_doctype in json.loads(value): if field == ref_fieldname and field_doctype == doctype: new_columns.append([new_fieldname, field_doctype]) - columns_modified=True + columns_modified = True else: new_columns.append([field, field_doctype]) if columns_modified: - frappe.db.sql("""update `tabDefaultValue` set defvalue=%s - where defkey=%s""" % ('%s', '%s'), (json.dumps(new_columns), key)) + frappe.db.sql( + """update `tabDefaultValue` set defvalue=%s + where defkey=%s""" + % ("%s", "%s"), + (json.dumps(new_columns), key), + ) + def update_property_setters(doctype, old_fieldname, new_fieldname): - frappe.db.sql("""update `tabProperty Setter` set field_name = %s - where doc_type=%s and field_name=%s""", (new_fieldname, doctype, old_fieldname)) + frappe.db.sql( + """update `tabProperty Setter` set field_name = %s + where doc_type=%s and field_name=%s""", + (new_fieldname, doctype, old_fieldname), + ) - frappe.db.sql('''update `tabCustom Field` set insert_after=%s - where insert_after=%s and dt=%s''', (new_fieldname, old_fieldname, doctype)) + frappe.db.sql( + """update `tabCustom Field` set insert_after=%s + where insert_after=%s and dt=%s""", + (new_fieldname, old_fieldname, doctype), + ) def update_user_settings(doctype, old_fieldname, new_fieldname): # store the user settings data from the redis to db sync_user_settings() - user_settings = frappe.db.sql(''' select user, doctype, data from `__UserSettings` - where doctype=%s and data like "%%%s%%"''', (doctype, old_fieldname), as_dict=1) + user_settings = frappe.db.sql( + ''' select user, doctype, data from `__UserSettings` + where doctype=%s and data like "%%%s%%"''', + (doctype, old_fieldname), + as_dict=1, + ) for user_setting in user_settings: update_user_settings_data(user_setting, "docfield", old_fieldname, new_fieldname) diff --git a/frappe/model/utils/user_settings.py b/frappe/model/utils/user_settings.py index ad378ab93f..a6ae1a818e 100644 --- a/frappe/model/utils/user_settings.py +++ b/frappe/model/utils/user_settings.py @@ -1,39 +1,41 @@ - # Settings saved per user basis # such as page_limit, filters, last_view -import frappe, json +import json + +import frappe from frappe import safe_decode # dict for mapping the index and index type for the filters of different views -filter_dict = { - "doctype": 0, - "docfield": 1, - "operator": 2, - "value": 3 -} +filter_dict = {"doctype": 0, "docfield": 1, "operator": 2, "value": 3} + def get_user_settings(doctype, for_update=False): - user_settings = frappe.cache().hget('_user_settings', - '{0}::{1}'.format(doctype, frappe.session.user)) + user_settings = frappe.cache().hget( + "_user_settings", "{0}::{1}".format(doctype, frappe.session.user) + ) if user_settings is None: - user_settings = frappe.db.sql('''select data from `__UserSettings` - where `user`=%s and `doctype`=%s''', (frappe.session.user, doctype)) - user_settings = user_settings and user_settings[0][0] or '{}' + user_settings = frappe.db.sql( + """select data from `__UserSettings` + where `user`=%s and `doctype`=%s""", + (frappe.session.user, doctype), + ) + user_settings = user_settings and user_settings[0][0] or "{}" if not for_update: update_user_settings(doctype, user_settings, True) - return user_settings or '{}' + return user_settings or "{}" + def update_user_settings(doctype, user_settings, for_update=False): - '''update user settings in cache''' + """update user settings in cache""" if for_update: current = json.loads(user_settings) else: - current = json.loads(get_user_settings(doctype, for_update = True)) + current = json.loads(get_user_settings(doctype, for_update=True)) if isinstance(current, str): # corrupt due to old code, remove this in a future release @@ -41,41 +43,50 @@ def update_user_settings(doctype, user_settings, for_update=False): current.update(user_settings) - frappe.cache().hset('_user_settings', '{0}::{1}'.format(doctype, frappe.session.user), - json.dumps(current)) + frappe.cache().hset( + "_user_settings", "{0}::{1}".format(doctype, frappe.session.user), json.dumps(current) + ) + def sync_user_settings(): - '''Sync from cache to database (called asynchronously via the browser)''' - for key, data in frappe.cache().hgetall('_user_settings').items(): + """Sync from cache to database (called asynchronously via the browser)""" + for key, data in frappe.cache().hgetall("_user_settings").items(): key = safe_decode(key) - doctype, user = key.split('::') # WTF? - frappe.db.multisql({ - 'mariadb': """INSERT INTO `__UserSettings`(`user`, `doctype`, `data`) + doctype, user = key.split("::") # WTF? + frappe.db.multisql( + { + "mariadb": """INSERT INTO `__UserSettings`(`user`, `doctype`, `data`) VALUES (%s, %s, %s) ON DUPLICATE key UPDATE `data`=%s""", - 'postgres': """INSERT INTO `__UserSettings` (`user`, `doctype`, `data`) + "postgres": """INSERT INTO `__UserSettings` (`user`, `doctype`, `data`) VALUES (%s, %s, %s) ON CONFLICT ("user", "doctype") DO UPDATE SET `data`=%s""", - }, (user, doctype, data, data), as_dict=1) + }, + (user, doctype, data, data), + as_dict=1, + ) @frappe.whitelist() def save(doctype, user_settings): - user_settings = json.loads(user_settings or '{}') + user_settings = json.loads(user_settings or "{}") update_user_settings(doctype, user_settings) return user_settings + @frappe.whitelist() def get(doctype): return get_user_settings(doctype) -def update_user_settings_data(user_setting, fieldname, old, new, condition_fieldname=None, condition_values=None): +def update_user_settings_data( + user_setting, fieldname, old, new, condition_fieldname=None, condition_values=None +): data = user_setting.get("data") if data: update = False data = json.loads(data) - for view in ['List', 'Gantt', 'Kanban', 'Calendar', 'Image', 'Inbox', 'Report']: + for view in ["List", "Gantt", "Kanban", "Calendar", "Image", "Inbox", "Report"]: view_settings = data.get(view) if view_settings and view_settings.get("filters"): view_filters = view_settings.get("filters") @@ -86,9 +97,12 @@ def update_user_settings_data(user_setting, fieldname, old, new, condition_field view_filter[filter_dict[fieldname]] = new update = True if update: - frappe.db.sql("update __UserSettings set data=%s where doctype=%s and user=%s", - (json.dumps(data), user_setting.doctype, user_setting.user)) + frappe.db.sql( + "update __UserSettings set data=%s where doctype=%s and user=%s", + (json.dumps(data), user_setting.doctype, user_setting.user), + ) # clear that user settings from the redis cache - frappe.cache().hset('_user_settings', '{0}::{1}'.format(user_setting.doctype, - user_setting.user), None) + frappe.cache().hset( + "_user_settings", "{0}::{1}".format(user_setting.doctype, user_setting.user), None + ) diff --git a/frappe/model/workflow.py b/frappe/model/workflow.py index 1b26cc2c3a..0edffaf2fb 100644 --- a/frappe/model/workflow.py +++ b/frappe/model/workflow.py @@ -4,25 +4,36 @@ import json import frappe from frappe import _ -from frappe.utils import cint from frappe.model.docstatus import DocStatus +from frappe.utils import cint + + +class WorkflowStateError(frappe.ValidationError): + pass + + +class WorkflowTransitionError(frappe.ValidationError): + pass + + +class WorkflowPermissionError(frappe.ValidationError): + pass -class WorkflowStateError(frappe.ValidationError): pass -class WorkflowTransitionError(frappe.ValidationError): pass -class WorkflowPermissionError(frappe.ValidationError): pass def get_workflow_name(doctype): - workflow_name = frappe.cache().hget('workflow', doctype) + workflow_name = frappe.cache().hget("workflow", doctype) if workflow_name is None: - workflow_name = frappe.db.get_value("Workflow", {"document_type": doctype, - "is_active": 1}, "name") - frappe.cache().hset('workflow', doctype, workflow_name or '') + workflow_name = frappe.db.get_value( + "Workflow", {"document_type": doctype, "is_active": 1}, "name" + ) + frappe.cache().hset("workflow", doctype, workflow_name or "") return workflow_name + @frappe.whitelist() -def get_transitions(doc, workflow = None, raise_exception=False): - '''Return list of possible transitions for the given doc''' +def get_transitions(doc, workflow=None, raise_exception=False): + """Return list of possible transitions for the given doc""" doc = frappe.get_doc(frappe.parse_json(doc)) if doc.is_new(): @@ -30,7 +41,7 @@ def get_transitions(doc, workflow = None, raise_exception=False): doc.load_from_db() - frappe.has_permission(doc, 'read', throw=True) + frappe.has_permission(doc, "read", throw=True) roles = frappe.get_roles() if not workflow: @@ -41,7 +52,7 @@ def get_transitions(doc, workflow = None, raise_exception=False): if raise_exception: raise WorkflowStateError else: - frappe.throw(_('Workflow State not set'), WorkflowStateError) + frappe.throw(_("Workflow State not set"), WorkflowStateError) transitions = [] for transition in workflow.transitions: @@ -51,6 +62,7 @@ def get_transitions(doc, workflow = None, raise_exception=False): transitions.append(transition.as_dict()) return transitions + def get_workflow_safe_globals(): # access to frappe.db.get_value, frappe.db.get_list, and date time utils. return dict( @@ -66,15 +78,19 @@ def get_workflow_safe_globals(): ) ) + def is_transition_condition_satisfied(transition, doc): if not transition.condition: return True else: - return frappe.safe_eval(transition.condition, get_workflow_safe_globals(), dict(doc=doc.as_dict())) + return frappe.safe_eval( + transition.condition, get_workflow_safe_globals(), dict(doc=doc.as_dict()) + ) + @frappe.whitelist() def apply_workflow(doc, action): - '''Allow workflow action on the current doc''' + """Allow workflow action on the current doc""" doc = frappe.get_doc(frappe.parse_json(doc)) workflow = get_workflow(doc.doctype) transitions = get_transitions(doc, workflow) @@ -112,33 +128,35 @@ def apply_workflow(doc, action): elif doc.docstatus.is_submitted() and new_docstatus == DocStatus.cancelled(): doc.cancel() else: - frappe.throw(_('Illegal Document Status for {0}').format(next_state.state)) + frappe.throw(_("Illegal Document Status for {0}").format(next_state.state)) - doc.add_comment('Workflow', _(next_state.state)) + doc.add_comment("Workflow", _(next_state.state)) return doc + @frappe.whitelist() def can_cancel_document(doctype): workflow = get_workflow(doctype) for state_doc in workflow.states: - if state_doc.doc_status == '2': + if state_doc.doc_status == "2": for transition in workflow.transitions: if transition.next_state == state_doc.state: return False return True return True + def validate_workflow(doc): - '''Validate Workflow State and Transition for the current user. + """Validate Workflow State and Transition for the current user. - Check if user is allowed to edit in current state - Check if user is allowed to transition to the next state (if changed) - ''' + """ workflow = get_workflow(doc.doctype) current_state = None - if getattr(doc, '_doc_before_save', None): + if getattr(doc, "_doc_before_save", None): current_state = doc._doc_before_save.get(workflow.workflow_state_field) next_state = doc.get(workflow.workflow_state_field) @@ -151,7 +169,11 @@ def validate_workflow(doc): state_row = [d for d in workflow.states if d.state == current_state] if not state_row: - frappe.throw(_('{0} is not a valid Workflow State. Please update your Workflow and try again.').format(frappe.bold(current_state))) + frappe.throw( + _("{0} is not a valid Workflow State. Please update your Workflow and try again.").format( + frappe.bold(current_state) + ) + ) state_row = state_row[0] # if transitioning, check if user is allowed to transition @@ -162,36 +184,46 @@ def validate_workflow(doc): if not doc._doc_before_save: # transitioning directly to a state other than the first # e.g from data import - frappe.throw(_('Workflow State transition not allowed from {0} to {1}').format(bold_current, bold_next), - WorkflowPermissionError) + frappe.throw( + _("Workflow State transition not allowed from {0} to {1}").format(bold_current, bold_next), + WorkflowPermissionError, + ) transitions = get_transitions(doc._doc_before_save) transition = [d for d in transitions if d.next_state == next_state] if not transition: - frappe.throw(_('Workflow State transition not allowed from {0} to {1}').format(bold_current, bold_next), - WorkflowPermissionError) + frappe.throw( + _("Workflow State transition not allowed from {0} to {1}").format(bold_current, bold_next), + WorkflowPermissionError, + ) + def get_workflow(doctype): - return frappe.get_doc('Workflow', get_workflow_name(doctype)) + return frappe.get_doc("Workflow", get_workflow_name(doctype)) + def has_approval_access(user, doc, transition): - return (user == 'Administrator' - or transition.get('allow_self_approval') - or user != doc.get('owner')) + return ( + user == "Administrator" or transition.get("allow_self_approval") or user != doc.get("owner") + ) + def get_workflow_state_field(workflow_name): - return get_workflow_field_value(workflow_name, 'workflow_state_field') + return get_workflow_field_value(workflow_name, "workflow_state_field") + def send_email_alert(workflow_name): - return get_workflow_field_value(workflow_name, 'send_email_alert') + return get_workflow_field_value(workflow_name, "send_email_alert") + def get_workflow_field_value(workflow_name, field): - value = frappe.cache().hget('workflow_' + workflow_name, field) + value = frappe.cache().hget("workflow_" + workflow_name, field) if value is None: value = frappe.db.get_value("Workflow", workflow_name, field) - frappe.cache().hset('workflow_' + workflow_name, field, value) + frappe.cache().hset("workflow_" + workflow_name, field, value) return value + @frappe.whitelist() def bulk_workflow_approval(docnames, doctype, action): from collections import defaultdict @@ -208,7 +240,7 @@ def bulk_workflow_approval(docnames, doctype, action): for (idx, docname) in enumerate(docnames, 1): message_dict = {} try: - show_progress(docnames, _('Applying: {0}').format(action), idx, docname) + show_progress(docnames, _("Applying: {0}").format(action), idx, docname) apply_workflow(frappe.get_doc(doctype, docname), action) frappe.db.commit() except Exception as e: @@ -221,7 +253,10 @@ def bulk_workflow_approval(docnames, doctype, action): failed_transactions[docname].append(message_dict) frappe.db.rollback() - frappe.log_error(frappe.get_traceback(), "Workflow {0} threw an error for {1} {2}".format(action, doctype, docname)) + frappe.log_error( + frappe.get_traceback(), + "Workflow {0} threw an error for {1} {2}".format(action, doctype, docname), + ) finally: if not message_dict: if frappe.message_log: @@ -240,13 +275,14 @@ def bulk_workflow_approval(docnames, doctype, action): if failed_transactions and successful_transactions: indicator = "orange" elif failed_transactions: - indicator = "red" + indicator = "red" else: indicator = "green" print_workflow_log(failed_transactions, _("Failed Transactions"), doctype, indicator) print_workflow_log(successful_transactions, _("Successful Transactions"), doctype, indicator) + def print_workflow_log(messages, title, doctype, indicator): if messages.keys(): msg = "
{0}
".format(title) @@ -255,8 +291,10 @@ def print_workflow_log(messages, title, doctype, indicator): if len(messages[doc]): html = "{0}
".format(frappe.utils.get_link_to_form(doctype, doc)) for log in messages[doc]: - if log.get('message'): - html += "{0}
".format(log.get('message'))
+ if log.get("message"):
+ html += "{0}
".format(
+ log.get("message")
+ )
html += "{0}
".format(doc)
@@ -264,6 +302,7 @@ def print_workflow_log(messages, title, doctype, indicator):
frappe.msgprint(msg, title=_("Workflow Status"), indicator=indicator, is_minimizable=True)
+
@frappe.whitelist()
def get_common_transition_actions(docs, doctype):
common_actions = []
@@ -271,10 +310,13 @@ def get_common_transition_actions(docs, doctype):
docs = json.loads(docs)
try:
for (i, doc) in enumerate(docs, 1):
- if not doc.get('doctype'):
- doc['doctype'] = doctype
- actions = [t.get('action') for t in get_transitions(doc, raise_exception=True) \
- if has_approval_access(frappe.session.user, doc, t)]
+ if not doc.get("doctype"):
+ doc["doctype"] = doctype
+ actions = [
+ t.get("action")
+ for t in get_transitions(doc, raise_exception=True)
+ if has_approval_access(frappe.session.user, doc, t)
+ ]
if not actions:
return []
common_actions = actions if i == 1 else set(common_actions).intersection(actions)
@@ -285,17 +327,15 @@ def get_common_transition_actions(docs, doctype):
return list(common_actions)
+
def show_progress(docnames, message, i, description):
n = len(docnames)
if n >= 5:
- frappe.publish_progress(
- float(i) * 100 / n,
- title = message,
- description = description
- )
+ frappe.publish_progress(float(i) * 100 / n, title=message, description=description)
+
def set_workflow_state_on_action(doc, workflow_name, action):
- workflow = frappe.get_doc('Workflow', workflow_name)
+ workflow = frappe.get_doc("Workflow", workflow_name)
workflow_state_field = workflow.workflow_state_field
# If workflow state of doc is already correct, don't set workflow state
@@ -303,11 +343,7 @@ def set_workflow_state_on_action(doc, workflow_name, action):
if state.state == doc.get(workflow_state_field) and doc.docstatus == cint(state.doc_status):
return
- action_map = {
- 'update_after_submit': '1',
- 'submit': '1',
- 'cancel': '2'
- }
+ action_map = {"update_after_submit": "1", "submit": "1", "cancel": "2"}
docstatus = action_map[action]
for state in workflow.states:
if state.doc_status == docstatus:
diff --git a/frappe/modules/__init__.py b/frappe/modules/__init__.py
index 33411f8d74..16281fe0b6 100644
--- a/frappe/modules/__init__.py
+++ b/frappe/modules/__init__.py
@@ -1,2 +1 @@
-
-from .utils import *
\ No newline at end of file
+from .utils import *
diff --git a/frappe/modules/export_file.py b/frappe/modules/export_file.py
index 45e008fa04..8eac7a9229 100644
--- a/frappe/modules/export_file.py
+++ b/frappe/modules/export_file.py
@@ -1,16 +1,20 @@
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
-import frappe, os
+import os
+
+import frappe
import frappe.model
-from frappe.modules import scrub, get_module_path, scrub_dt_dn
+from frappe.modules import get_module_path, scrub, scrub_dt_dn
+
def export_doc(doc):
write_document_file(doc)
+
def export_to_files(record_list=None, record_module=None, verbose=0, create_init=None):
"""
- Export record_list to files. record_list is a list of lists ([doctype, docname, folder name],) ,
+ Export record_list to files. record_list is a list of lists ([doctype, docname, folder name],) ,
"""
if frappe.flags.in_import:
return
@@ -18,7 +22,13 @@ def export_to_files(record_list=None, record_module=None, verbose=0, create_init
if record_list:
for record in record_list:
folder_name = record[2] if len(record) == 3 else None
- write_document_file(frappe.get_doc(record[0], record[1]), record_module, create_init=create_init, folder_name=folder_name)
+ write_document_file(
+ frappe.get_doc(record[0], record[1]),
+ record_module,
+ create_init=create_init,
+ folder_name=folder_name,
+ )
+
def write_document_file(doc, record_module=None, create_init=True, folder_name=None):
doc_export = doc.as_dict(no_nulls=True)
@@ -37,9 +47,10 @@ def write_document_file(doc, record_module=None, create_init=True, folder_name=N
write_code_files(folder, fname, doc, doc_export)
# write the data file
- with open(os.path.join(folder, fname + ".json"), 'w+') as txtfile:
+ with open(os.path.join(folder, fname + ".json"), "w+") as txtfile:
txtfile.write(frappe.as_json(doc_export))
+
def strip_default_fields(doc, doc_export):
# strip out default fields from children
if doc.doctype == "DocType" and doc.migration_hash:
@@ -47,37 +58,40 @@ def strip_default_fields(doc, doc_export):
for df in doc.meta.get_table_fields():
for d in doc_export.get(df.fieldname):
- for fieldname in (frappe.model.default_fields + frappe.model.child_table_fields):
+ for fieldname in frappe.model.default_fields + frappe.model.child_table_fields:
if fieldname in d:
del d[fieldname]
return doc_export
+
def write_code_files(folder, fname, doc, doc_export):
- '''Export code files and strip from values'''
- if hasattr(doc, 'get_code_fields'):
+ """Export code files and strip from values"""
+ if hasattr(doc, "get_code_fields"):
for key, extn in doc.get_code_fields().items():
if doc.get(key):
- with open(os.path.join(folder, fname + "." + extn), 'w+') as txtfile:
+ with open(os.path.join(folder, fname + "." + extn), "w+") as txtfile:
txtfile.write(doc.get(key))
# remove from exporting
del doc_export[key]
+
def get_module_name(doc):
- if doc.doctype == 'Module Def':
+ if doc.doctype == "Module Def":
module = doc.name
- elif doc.doctype=="Workflow":
+ elif doc.doctype == "Workflow":
module = frappe.db.get_value("DocType", doc.document_type, "module")
- elif hasattr(doc, 'module'):
+ elif hasattr(doc, "module"):
module = doc.module
else:
module = frappe.db.get_value("DocType", doc.doctype, "module")
return module
+
def create_folder(module, dt, dn, create_init):
- if frappe.db.get_value('Module Def', module, 'custom'):
+ if frappe.db.get_value("Module Def", module, "custom"):
module_path = get_custom_module_path(module)
else:
module_path = get_module_path(module)
@@ -95,10 +109,11 @@ def create_folder(module, dt, dn, create_init):
return folder
+
def get_custom_module_path(module):
- package = frappe.db.get_value('Module Def', module, 'package')
+ package = frappe.db.get_value("Module Def", module, "package")
if not package:
- frappe.throw('Package must be set for custom Module {module}'.format(module=module))
+ frappe.throw("Package must be set for custom Module {module}".format(module=module))
path = os.path.join(get_package_path(package), scrub(module))
if not os.path.exists(path):
@@ -106,17 +121,21 @@ def get_custom_module_path(module):
return path
+
def get_package_path(package):
- path = os.path.join(frappe.get_site_path('packages'), frappe.db.get_value('Package', package, 'package_name'))
+ path = os.path.join(
+ frappe.get_site_path("packages"), frappe.db.get_value("Package", package, "package_name")
+ )
if not os.path.exists(path):
os.makedirs(path)
return path
+
def create_init_py(module_path, dt, dn):
def create_if_not_exists(path):
- initpy = os.path.join(path, '__init__.py')
+ initpy = os.path.join(path, "__init__.py")
if not os.path.exists(initpy):
- open(initpy, 'w').close()
+ open(initpy, "w").close()
create_if_not_exists(os.path.join(module_path))
create_if_not_exists(os.path.join(module_path, dt))
diff --git a/frappe/modules/import_file.py b/frappe/modules/import_file.py
index f9c7b55a99..9cfbe163a5 100644
--- a/frappe/modules/import_file.py
+++ b/frappe/modules/import_file.py
@@ -15,10 +15,10 @@ def calculate_hash(path: str) -> str:
"""Calculate md5 hash of the file in binary mode
Args:
- path (str): Path to the file to be hashed
+ path (str): Path to the file to be hashed
Returns:
- str: The calculated hash
+ str: The calculated hash
"""
hash_md5 = hashlib.md5()
with open(path, "rb") as f:
@@ -43,16 +43,24 @@ def import_files(module, dt=None, dn=None, force=False, pre_process=None, reset_
if type(module) is list:
out = []
for m in module:
- out.append(import_file(m[0], m[1], m[2], force=force, pre_process=pre_process, reset_permissions=reset_permissions))
+ out.append(
+ import_file(
+ m[0], m[1], m[2], force=force, pre_process=pre_process, reset_permissions=reset_permissions
+ )
+ )
return out
else:
- return import_file(module, dt, dn, force=force, pre_process=pre_process, reset_permissions=reset_permissions)
+ return import_file(
+ module, dt, dn, force=force, pre_process=pre_process, reset_permissions=reset_permissions
+ )
def import_file(module, dt, dn, force=False, pre_process=None, reset_permissions=False):
"""Sync a file from txt if modifed, return false if not updated"""
path = get_file_path(module, dt, dn)
- ret = import_file_by_path(path, force, pre_process=pre_process, reset_permissions=reset_permissions)
+ ret = import_file_by_path(
+ path, force, pre_process=pre_process, reset_permissions=reset_permissions
+ )
return ret
@@ -64,7 +72,14 @@ def get_file_path(module, dt, dn):
return path
-def import_file_by_path(path: str,force: bool = False,data_import: bool = False,pre_process = None,ignore_version: bool = None,reset_permissions: bool = False):
+def import_file_by_path(
+ path: str,
+ force: bool = False,
+ data_import: bool = False,
+ pre_process=None,
+ ignore_version: bool = None,
+ reset_permissions: bool = False,
+):
"""Import file from the given path
Some conditions decide if a file should be imported or not.
@@ -72,9 +87,9 @@ def import_file_by_path(path: str,force: bool = False,data_import: bool = False,
- Check if `force` is true. Import the file. If not, move ahead.
- Get `db_modified_timestamp`(value of the modified field in the database for the file).
- If the return is `none,` this file doesn't exist in the DB, so Import the file. If not, move ahead.
+ If the return is `none,` this file doesn't exist in the DB, so Import the file. If not, move ahead.
- Check if there is a hash in DB for that file. If there is, Calculate the Hash of the file to import and compare it with the one in DB if they are not equal.
- Import the file. If Hash doesn't exist, move ahead.
+ Import the file. If Hash doesn't exist, move ahead.
- Check if `db_modified_timestamp` is older than the timestamp in the file; if it is, we import the file.
If timestamp comparison happens for doctypes, that means the Hash for it doesn't exist.
@@ -82,15 +97,15 @@ def import_file_by_path(path: str,force: bool = False,data_import: bool = False,
So in the subsequent imports, we can use hashes to compare. As a precautionary measure, the timestamp is updated to the current time as well.
Args:
- path (str): Path to the file.
- force (bool, optional): Load the file without checking any conditions. Defaults to False.
- data_import (bool, optional): [description]. Defaults to False.
- pre_process ([type], optional): Any preprocesing that may need to take place on the doc. Defaults to None.
- ignore_version (bool, optional): ignore current version. Defaults to None.
- reset_permissions (bool, optional): reset permissions for the file. Defaults to False.
+ path (str): Path to the file.
+ force (bool, optional): Load the file without checking any conditions. Defaults to False.
+ data_import (bool, optional): [description]. Defaults to False.
+ pre_process ([type], optional): Any preprocesing that may need to take place on the doc. Defaults to None.
+ ignore_version (bool, optional): ignore current version. Defaults to None.
+ reset_permissions (bool, optional): reset permissions for the file. Defaults to False.
Returns:
- [bool]: True if import takes place. False if it wasn't imported.
+ [bool]: True if import takes place. False if it wasn't imported.
"""
frappe.flags.dt = frappe.flags.dt or []
try:
@@ -141,11 +156,7 @@ def import_file_by_path(path: str,force: bool = False,data_import: bool = False,
if doc["doctype"] == "DocType":
doctype_table = DocType("DocType")
- frappe.qb.update(
- doctype_table
- ).set(
- doctype_table.migration_hash, calculated_hash
- ).where(
+ frappe.qb.update(doctype_table).set(doctype_table.migration_hash, calculated_hash).where(
doctype_table.name == doc["name"]
).run()
@@ -187,31 +198,35 @@ def update_modified(original_modified, doc):
if doc["doctype"] == doc["name"] and doc["name"] != "DocType":
singles_table = DocType("Singles")
- frappe.qb.update(
- singles_table
- ).set(
- singles_table.value,original_modified
- ).where(
+ frappe.qb.update(singles_table).set(singles_table.value, original_modified).where(
singles_table["field"] == "modified", # singles_table.field is a method of pypika Selectable
- ).where(
- singles_table.doctype == doc["name"]
- ).run()
+ ).where(singles_table.doctype == doc["name"]).run()
else:
- doctype_table = DocType(doc['doctype'])
+ doctype_table = DocType(doc["doctype"])
- frappe.qb.update(doctype_table
- ).set(
- doctype_table.modified, original_modified
- ).where(
+ frappe.qb.update(doctype_table).set(doctype_table.modified, original_modified).where(
doctype_table.name == doc["name"]
).run()
-def import_doc(docdict, force=False, data_import=False, pre_process=None, ignore_version=None, reset_permissions=False, path=None):
+
+def import_doc(
+ docdict,
+ force=False,
+ data_import=False,
+ pre_process=None,
+ ignore_version=None,
+ reset_permissions=False,
+ path=None,
+):
frappe.flags.in_import = True
docdict["__islocal"] = 1
controller = get_controller(docdict["doctype"])
- if controller and hasattr(controller, "prepare_for_import") and callable(getattr(controller, "prepare_for_import")):
+ if (
+ controller
+ and hasattr(controller, "prepare_for_import")
+ and callable(getattr(controller, "prepare_for_import"))
+ ):
controller.prepare_for_import(docdict)
doc = frappe.get_doc(docdict)
diff --git a/frappe/modules/patch_handler.py b/frappe/modules/patch_handler.py
index 0a23d5b0f4..ae6d9a6de2 100644
--- a/frappe/modules/patch_handler.py
+++ b/frappe/modules/patch_handler.py
@@ -60,14 +60,14 @@ def run_all(skip_failing: bool = False, patch_type: Optional[PatchType] = None)
def run_patch(patch):
try:
- if not run_single(patchmodule = patch):
- print(patch + ': failed: STOPPED')
+ if not run_single(patchmodule=patch):
+ print(patch + ": failed: STOPPED")
raise PatchError(patch)
except Exception:
if not skip_failing:
raise
else:
- print('Failed to execute patch')
+ print("Failed to execute patch")
patches = get_all_patches(patch_type=patch_type)
@@ -77,9 +77,10 @@ def run_all(skip_failing: bool = False, patch_type: Optional[PatchType] = None)
# patches to be run in the end
for patch in frappe.flags.final_patches:
- patch = patch.replace('finally:', '')
+ patch = patch.replace("finally:", "")
run_patch(patch)
+
def get_all_patches(patch_type: Optional[PatchType] = None) -> List[str]:
if patch_type and not isinstance(patch_type, PatchType):
@@ -91,12 +92,13 @@ def get_all_patches(patch_type: Optional[PatchType] = None) -> List[str]:
return patches
+
def get_patches_from_app(app: str, patch_type: Optional[PatchType] = None) -> List[str]:
- """ Get patches from an app's patches.txt
+ """Get patches from an app's patches.txt
- patches.txt can be:
- 1. ini like file with section for different patch_type
- 2. plain text file with each line representing a patch.
+ patches.txt can be:
+ 1. ini like file with section for different patch_type
+ 2. plain text file with each line representing a patch.
"""
patches_txt = frappe.get_pymodule_path(app, "patches.txt")
@@ -115,8 +117,9 @@ def get_patches_from_app(app: str, patch_type: Optional[PatchType] = None) -> Li
return []
if not patch_type:
- return [patch for patch in parser[PatchType.pre_model_sync.value]] + \
- [patch for patch in parser[PatchType.post_model_sync.value]]
+ return [patch for patch in parser[PatchType.pre_model_sync.value]] + [
+ patch for patch in parser[PatchType.post_model_sync.value]
+ ]
if patch_type.value in parser.sections():
return [patch for patch in parser[patch_type.value]]
@@ -131,9 +134,12 @@ def get_patches_from_app(app: str, patch_type: Optional[PatchType] = None) -> Li
return []
+
def reload_doc(args):
import frappe.modules
- run_single(method = frappe.modules.reload_doc, methodargs = args)
+
+ run_single(method=frappe.modules.reload_doc, methodargs=args)
+
def run_single(patchmodule=None, method=None, methodargs=None, force=False):
from frappe import conf
@@ -146,6 +152,7 @@ def run_single(patchmodule=None, method=None, methodargs=None, force=False):
else:
return True
+
def execute_patch(patchmodule, method=None, methodargs=None):
"""execute the patch"""
block_user(True)
@@ -163,7 +170,9 @@ def execute_patch(patchmodule, method=None, methodargs=None):
if docstring:
docstring = "\n" + indent(dedent(docstring), "\t")
- print(f"Executing {patchmodule or methodargs} in {frappe.local.site} ({frappe.db.cur_db_name}){docstring}")
+ print(
+ f"Executing {patchmodule or methodargs} in {frappe.local.site} ({frappe.db.cur_db_name}){docstring}"
+ )
start_time = time.time()
frappe.db.begin()
@@ -194,28 +203,32 @@ def execute_patch(patchmodule, method=None, methodargs=None):
return True
+
def update_patch_log(patchmodule):
"""update patch_file in patch log"""
frappe.get_doc({"doctype": "Patch Log", "patch": patchmodule}).insert(ignore_permissions=True)
+
def executed(patchmodule):
"""return True if is executed"""
- if patchmodule.startswith('finally:'):
+ if patchmodule.startswith("finally:"):
# patches are saved without the finally: tag
- patchmodule = patchmodule.replace('finally:', '')
+ patchmodule = patchmodule.replace("finally:", "")
return frappe.db.get_value("Patch Log", {"patch": patchmodule})
+
def block_user(block, msg=None):
"""stop/start execution till patch is run"""
frappe.local.flags.in_patch = block
frappe.db.begin()
if not msg:
msg = "Patches are being executed in the system. Please try again in a few moments."
- frappe.db.set_global('__session_status', block and 'stop' or None)
- frappe.db.set_global('__session_status_message', block and msg or None)
+ frappe.db.set_global("__session_status", block and "stop" or None)
+ frappe.db.set_global("__session_status_message", block and msg or None)
frappe.db.commit()
+
def check_session_stopped():
- if frappe.db.get_global("__session_status")=='stop':
+ if frappe.db.get_global("__session_status") == "stop":
frappe.msgprint(frappe.db.get_global("__session_status_message"))
- raise frappe.SessionStopped('Session Stopped')
+ raise frappe.SessionStopped("Session Stopped")
diff --git a/frappe/modules/utils.py b/frappe/modules/utils.py
index 4768faff48..60eaefddc5 100644
--- a/frappe/modules/utils.py
+++ b/frappe/modules/utils.py
@@ -3,80 +3,96 @@
"""
Utilities for using modules
"""
-import frappe, os, json
+import json
+import os
+
+import frappe
import frappe.utils
from frappe import _
from frappe.utils import cint
+
def export_module_json(doc, is_standard, module):
"""Make a folder for the given doc and add its json file (make it a standard
- object that will be synced)"""
- if (not frappe.flags.in_import and getattr(frappe.get_conf(),'developer_mode', 0)
- and is_standard):
+ object that will be synced)"""
+ if not frappe.flags.in_import and getattr(frappe.get_conf(), "developer_mode", 0) and is_standard:
from frappe.modules.export_file import export_to_files
# json
- export_to_files(record_list=[[doc.doctype, doc.name]], record_module=module,
- create_init=is_standard)
+ export_to_files(
+ record_list=[[doc.doctype, doc.name]], record_module=module, create_init=is_standard
+ )
- path = os.path.join(frappe.get_module_path(module), scrub(doc.doctype),
- scrub(doc.name), scrub(doc.name))
+ path = os.path.join(
+ frappe.get_module_path(module), scrub(doc.doctype), scrub(doc.name), scrub(doc.name)
+ )
return path
+
def get_doc_module(module, doctype, name):
"""Get custom module for given document"""
module_name = "{app}.{module}.{doctype}.{name}.{name}".format(
- app = frappe.local.module_app[scrub(module)],
- doctype = scrub(doctype),
- module = scrub(module),
- name = scrub(name)
+ app=frappe.local.module_app[scrub(module)],
+ doctype=scrub(doctype),
+ module=scrub(module),
+ name=scrub(name),
)
return frappe.get_module(module_name)
+
@frappe.whitelist()
def export_customizations(module, doctype, sync_on_migrate=0, with_permissions=0):
"""Export Custom Field and Property Setter for the current document to the app folder.
- This will be synced with bench migrate"""
+ This will be synced with bench migrate"""
sync_on_migrate = cint(sync_on_migrate)
with_permissions = cint(with_permissions)
if not frappe.get_conf().developer_mode:
- raise Exception('Not developer mode')
+ raise Exception("Not developer mode")
- custom = {'custom_fields': [], 'property_setters': [], 'custom_perms': [],
- 'doctype': doctype, 'sync_on_migrate': sync_on_migrate}
+ custom = {
+ "custom_fields": [],
+ "property_setters": [],
+ "custom_perms": [],
+ "links": [],
+ "doctype": doctype,
+ "sync_on_migrate": sync_on_migrate,
+ }
def add(_doctype):
- custom['custom_fields'] += frappe.get_all('Custom Field',
- fields='*', filters={'dt': _doctype})
- custom['property_setters'] += frappe.get_all('Property Setter',
- fields='*', filters={'doc_type': _doctype})
+ custom["custom_fields"] += frappe.get_all("Custom Field", fields="*", filters={"dt": _doctype})
+ custom["property_setters"] += frappe.get_all(
+ "Property Setter", fields="*", filters={"doc_type": _doctype}
+ )
+ custom["links"] += frappe.get_all("DocType Link", fields="*", filters={"parent": _doctype})
add(doctype)
if with_permissions:
- custom['custom_perms'] = frappe.get_all('Custom DocPerm',
- fields='*', filters={'parent': doctype})
+ custom["custom_perms"] = frappe.get_all(
+ "Custom DocPerm", fields="*", filters={"parent": doctype}
+ )
# also update the custom fields and property setters for all child tables
for d in frappe.get_meta(doctype).get_table_fields():
export_customizations(module, d.options, sync_on_migrate, with_permissions)
if custom["custom_fields"] or custom["property_setters"] or custom["custom_perms"]:
- folder_path = os.path.join(get_module_path(module), 'custom')
+ folder_path = os.path.join(get_module_path(module), "custom")
if not os.path.exists(folder_path):
os.makedirs(folder_path)
- path = os.path.join(folder_path, scrub(doctype)+ '.json')
- with open(path, 'w') as f:
+ path = os.path.join(folder_path, scrub(doctype) + ".json")
+ with open(path, "w") as f:
f.write(frappe.as_json(custom))
- frappe.msgprint(_('Customizations for {0} exported to:{1}').format(doctype,path)) + frappe.msgprint(_("Customizations for {0} exported to:
{1}").format(doctype, path)) + def sync_customizations(app=None): - '''Sync custom fields and property setters from custom folder in each app module''' + """Sync custom fields and property setters from custom folder in each app module""" if app: apps = [app] @@ -85,21 +101,21 @@ def sync_customizations(app=None): for app_name in apps: for module_name in frappe.local.app_modules.get(app_name) or []: - folder = frappe.get_app_path(app_name, module_name, 'custom') + folder = frappe.get_app_path(app_name, module_name, "custom") if os.path.exists(folder): for fname in os.listdir(folder): - if fname.endswith('.json'): - with open(os.path.join(folder, fname), 'r') as f: + if fname.endswith(".json"): + with open(os.path.join(folder, fname), "r") as f: data = json.loads(f.read()) - if data.get('sync_on_migrate'): + if data.get("sync_on_migrate"): sync_customizations_for_doctype(data, folder) def sync_customizations_for_doctype(data, folder): - '''Sync doctype customzations for a particular data set''' + """Sync doctype customzations for a particular data set""" from frappe.core.doctype.doctype.doctype import validate_fields_for_doctype - doctype = data['doctype'] + doctype = data["doctype"] update_schema = False def sync(key, custom_doctype, doctype_fieldname): @@ -109,11 +125,11 @@ def sync_customizations_for_doctype(data, folder): def sync_single_doctype(doc_type): def _insert(data): if data.get(doctype_fieldname) == doc_type: - data['doctype'] = custom_doctype + data["doctype"] = custom_doctype doc = frappe.get_doc(data) doc.db_insert() - if custom_doctype != 'Custom Field': + if custom_doctype != "Custom Field": frappe.db.delete(custom_doctype, {doctype_fieldname: doc_type}) for d in data[key]: @@ -133,59 +149,76 @@ def sync_customizations_for_doctype(data, folder): for doc_type in doctypes: # only sync the parent doctype and child doctype if there isn't any other child table json file - if doc_type == doctype or not os.path.exists(os.path.join(folder, frappe.scrub(doc_type)+".json")): + if doc_type == doctype or not os.path.exists( + os.path.join(folder, frappe.scrub(doc_type) + ".json") + ): sync_single_doctype(doc_type) - if data['custom_fields']: - sync('custom_fields', 'Custom Field', 'dt') + if data["custom_fields"]: + sync("custom_fields", "Custom Field", "dt") update_schema = True - if data['property_setters']: - sync('property_setters', 'Property Setter', 'doc_type') + if data["property_setters"]: + sync("property_setters", "Property Setter", "doc_type") - if data.get('custom_perms'): - sync('custom_perms', 'Custom DocPerm', 'parent') + if data.get("custom_perms"): + sync("custom_perms", "Custom DocPerm", "parent") - print('Updating customizations for {0}'.format(doctype)) + print("Updating customizations for {0}".format(doctype)) validate_fields_for_doctype(doctype) - if update_schema and not frappe.db.get_value('DocType', doctype, 'issingle'): + if update_schema and not frappe.db.get_value("DocType", doctype, "issingle"): frappe.db.updatedb(doctype) + def scrub(txt): return frappe.scrub(txt) + def scrub_dt_dn(dt, dn): """Returns in lowercase and code friendly names of doctype and name for certain types""" return scrub(dt), scrub(dn) + def get_module_path(module): """Returns path of the given module""" return frappe.get_module_path(module) + def get_doc_path(module, doctype, name): dt, dn = scrub_dt_dn(doctype, name) return os.path.join(get_module_path(module), dt, dn) + def reload_doc(module, dt=None, dn=None, force=False, reset_permissions=False): from frappe.modules.import_file import import_files + return import_files(module, dt, dn, force=force, reset_permissions=reset_permissions) + def export_doc(doctype, name, module=None): """Write a doc to standard path.""" from frappe.modules.export_file import write_document_file + print(doctype, name) - if not module: module = frappe.db.get_value('DocType', name, 'module') + if not module: + module = frappe.db.get_value("DocType", name, "module") write_document_file(frappe.get_doc(doctype, name), module) + def get_doctype_module(doctype): """Returns **Module Def** name of given doctype.""" + def make_modules_dict(): return dict(frappe.db.sql("select name, module from tabDocType")) + return frappe.cache().get_value("doctype_modules", make_modules_dict)[doctype] + doctype_python_modules = {} + + def load_doctype_module(doctype, module=None, prefix="", suffix=""): """Returns the module object for given doctype.""" if not module: @@ -201,21 +234,27 @@ def load_doctype_module(doctype, module=None, prefix="", suffix=""): if key not in doctype_python_modules: doctype_python_modules[key] = frappe.get_module(module_name) except ImportError as e: - raise ImportError('Module import failed for {0} ({1})'.format(doctype, module_name + ' Error: ' + str(e))) + raise ImportError( + "Module import failed for {0} ({1})".format(doctype, module_name + " Error: " + str(e)) + ) return doctype_python_modules[key] + def get_module_name(doctype, module, prefix="", suffix="", app=None): - return '{app}.{module}.doctype.{doctype}.{prefix}{doctype}{suffix}'.format(\ - app = scrub(app or get_module_app(module)), - module = scrub(module), - doctype = scrub(doctype), + return "{app}.{module}.doctype.{doctype}.{prefix}{doctype}{suffix}".format( + app=scrub(app or get_module_app(module)), + module=scrub(module), + doctype=scrub(doctype), prefix=prefix, - suffix=suffix) + suffix=suffix, + ) + def get_module_app(module): return frappe.local.module_app[scrub(module)] + def get_app_publisher(module): app = frappe.local.module_app[scrub(module)] if not app: @@ -223,14 +262,16 @@ def get_app_publisher(module): app_publisher = frappe.get_hooks(hook="app_publisher", app_name=app)[0] return app_publisher + def make_boilerplate(template, doc, opts=None): target_path = get_doc_path(doc.module, doc.doctype, doc.name) template_name = template.replace("controller", scrub(doc.name)) - if template_name.endswith('._py'): - template_name = template_name[:-4] + '.py' + if template_name.endswith("._py"): + template_name = template_name[:-4] + ".py" target_file_path = os.path.join(target_path, template_name) - if not doc: doc = {} + if not doc: + doc = {} app_publisher = get_app_publisher(doc.module) @@ -238,14 +279,14 @@ def make_boilerplate(template, doc, opts=None): if not opts: opts = {} - base_class = 'Document' - base_class_import = 'from frappe.model.document import Document' - if doc.get('is_tree'): - base_class = 'NestedSet' - base_class_import = 'from frappe.utils.nestedset import NestedSet' + base_class = "Document" + base_class_import = "from frappe.model.document import Document" + if doc.get("is_tree"): + base_class = "NestedSet" + base_class_import = "from frappe.utils.nestedset import NestedSet" - custom_controller = 'pass' - if doc.get('is_virtual'): + custom_controller = "pass" + if doc.get("is_virtual"): custom_controller = """ def db_insert(self): pass @@ -265,16 +306,22 @@ def make_boilerplate(template, doc, opts=None): def get_stats(self, args): pass""" - with open(target_file_path, 'w') as target: - with open(os.path.join(get_module_path("core"), "doctype", scrub(doc.doctype), - "boilerplate", template), 'r') as source: - target.write(frappe.as_unicode( - frappe.utils.cstr(source.read()).format( - app_publisher=app_publisher, - year=frappe.utils.nowdate()[:4], - classname=doc.name.replace(" ", "").replace("-", ""), - base_class_import=base_class_import, - base_class=base_class, - doctype=doc.name, **opts, - custom_controller=custom_controller) - )) + with open(target_file_path, "w") as target: + with open( + os.path.join(get_module_path("core"), "doctype", scrub(doc.doctype), "boilerplate", template), + "r", + ) as source: + target.write( + frappe.as_unicode( + frappe.utils.cstr(source.read()).format( + app_publisher=app_publisher, + year=frappe.utils.nowdate()[:4], + classname=doc.name.replace(" ", "").replace("-", ""), + base_class_import=base_class_import, + base_class=base_class, + doctype=doc.name, + **opts, + custom_controller=custom_controller + ) + ) + ) diff --git a/frappe/monitor.py b/frappe/monitor.py index 6bad03dfe9..74f9e06ef3 100644 --- a/frappe/monitor.py +++ b/frappe/monitor.py @@ -2,14 +2,15 @@ # Copyright (c) 2020, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -from datetime import datetime import json -import traceback -import frappe import os +import traceback import uuid +from datetime import datetime + import rq +import frappe MONITOR_REDIS_KEY = "monitor-transactions" MONITOR_MAX_ENTRIES = 1000000 diff --git a/frappe/oauth.py b/frappe/oauth.py index 67d346ad8a..e7fa101bfd 100644 --- a/frappe/oauth.py +++ b/frappe/oauth.py @@ -4,9 +4,11 @@ import hashlib import re from http import cookies from urllib.parse import unquote, urlparse + import jwt import pytz from oauthlib.openid import RequestValidator + import frappe from frappe.auth import LoginManager @@ -27,9 +29,9 @@ class OAuthWebRequestValidator(RequestValidator): # Is the client allowed to use the supplied redirect_uri? i.e. has # the client previously registered this EXACT redirect uri. - redirect_uris = frappe.db.get_value( - "OAuth Client", client_id, "redirect_uris" - ).split(get_url_delimiter()) + redirect_uris = frappe.db.get_value("OAuth Client", client_id, "redirect_uris").split( + get_url_delimiter() + ) if redirect_uri in redirect_uris: return True @@ -40,9 +42,7 @@ class OAuthWebRequestValidator(RequestValidator): # The redirect used if none has been supplied. # Prefer your clients to pre register a redirect uri rather than # supplying one on each authorization request. - redirect_uri = frappe.db.get_value( - "OAuth Client", client_id, "default_redirect_uri" - ) + redirect_uri = frappe.db.get_value("OAuth Client", client_id, "default_redirect_uri") return redirect_uri def validate_scopes(self, client_id, scopes, client, request, *args, **kwargs): @@ -57,9 +57,7 @@ class OAuthWebRequestValidator(RequestValidator): request.scopes = scopes # Apparently this is possible. return scopes - def validate_response_type( - self, client_id, response_type, client, request, *args, **kwargs - ): + def validate_response_type(self, client_id, response_type, client, request, *args, **kwargs): allowed_response_types = [ # From OAuth Client response_type field client.response_type.lower(), @@ -113,9 +111,7 @@ class OAuthWebRequestValidator(RequestValidator): elif "token" in frappe.form_dict: oc = frappe.get_doc( "OAuth Client", - frappe.db.get_value( - "OAuth Bearer Token", frappe.form_dict["token"], "client" - ), + frappe.db.get_value("OAuth Bearer Token", frappe.form_dict["token"], "client"), ) else: oc = frappe.get_doc( @@ -132,11 +128,7 @@ class OAuthWebRequestValidator(RequestValidator): return generate_json_error_response(e) cookie_dict = get_cookie_dict_from_headers(request) - user_id = ( - unquote(cookie_dict.get("user_id").value) - if "user_id" in cookie_dict - else "Guest" - ) + user_id = unquote(cookie_dict.get("user_id").value) if "user_id" in cookie_dict else "Guest" return frappe.session.user == user_id def authenticate_client_id(self, client_id, request, *args, **kwargs): @@ -162,22 +154,18 @@ class OAuthWebRequestValidator(RequestValidator): checkcodes.append(vcode["name"]) if code in checkcodes: - request.scopes = frappe.db.get_value( - "OAuth Authorization Code", code, "scopes" - ).split(get_url_delimiter()) + request.scopes = frappe.db.get_value("OAuth Authorization Code", code, "scopes").split( + get_url_delimiter() + ) request.user = frappe.db.get_value("OAuth Authorization Code", code, "user") code_challenge_method = frappe.db.get_value( "OAuth Authorization Code", code, "code_challenge_method" ) - code_challenge = frappe.db.get_value( - "OAuth Authorization Code", code, "code_challenge" - ) + code_challenge = frappe.db.get_value("OAuth Authorization Code", code, "code_challenge") if code_challenge and not request.code_verifier: if frappe.db.exists("OAuth Authorization Code", code): - frappe.delete_doc( - "OAuth Authorization Code", code, ignore_permissions=True - ) + frappe.delete_doc("OAuth Authorization Code", code, ignore_permissions=True) frappe.db.commit() return False @@ -197,12 +185,8 @@ class OAuthWebRequestValidator(RequestValidator): return False - def confirm_redirect_uri( - self, client_id, code, redirect_uri, client, *args, **kwargs - ): - saved_redirect_uri = frappe.db.get_value( - "OAuth Client", client_id, "default_redirect_uri" - ) + def confirm_redirect_uri(self, client_id, code, redirect_uri, client, *args, **kwargs): + saved_redirect_uri = frappe.db.get_value("OAuth Client", client_id, "default_redirect_uri") redirect_uris = frappe.db.get_value("OAuth Client", client_id, "redirect_uris") @@ -212,9 +196,7 @@ class OAuthWebRequestValidator(RequestValidator): return saved_redirect_uri == redirect_uri - def validate_grant_type( - self, client_id, grant_type, client, request, *args, **kwargs - ): + def validate_grant_type(self, client_id, grant_type, client, request, *args, **kwargs): # Clients should only be allowed to use one type of grant. # In this case, it must be "authorization_code" or "refresh_token" return grant_type in ["authorization_code", "refresh_token", "password"] @@ -270,17 +252,14 @@ class OAuthWebRequestValidator(RequestValidator): ) token_expiration_utc = token_expiration_local.astimezone(pytz.utc) is_token_valid = ( - frappe.utils.datetime.datetime.utcnow().replace(tzinfo=pytz.utc) - < token_expiration_utc + frappe.utils.datetime.datetime.utcnow().replace(tzinfo=pytz.utc) < token_expiration_utc ) and otoken.status != "Revoked" - client_scopes = frappe.db.get_value( - "OAuth Client", otoken.client, "scopes" - ).split(get_url_delimiter()) + client_scopes = frappe.db.get_value("OAuth Client", otoken.client, "scopes").split( + get_url_delimiter() + ) are_scopes_valid = True for scp in scopes: - are_scopes_valid = ( - are_scopes_valid and True if scp in client_scopes else False - ) + are_scopes_valid = are_scopes_valid and True if scp in client_scopes else False return is_token_valid and are_scopes_valid @@ -291,9 +270,7 @@ class OAuthWebRequestValidator(RequestValidator): # return its scopes, these will be passed on to the refreshed # access token if the client did not specify a scope during the # request. - obearer_token = frappe.get_doc( - "OAuth Bearer Token", {"refresh_token": refresh_token} - ) + obearer_token = frappe.get_doc("OAuth Bearer Token", {"refresh_token": refresh_token}) return obearer_token.scopes def revoke_token(self, token, token_type_hint, request, *args, **kwargs): @@ -309,9 +286,7 @@ class OAuthWebRequestValidator(RequestValidator): if token_type_hint == "access_token": frappe.db.set_value("OAuth Bearer Token", token, "status", "Revoked") elif token_type_hint == "refresh_token": - frappe.db.set_value( - "OAuth Bearer Token", {"refresh_token": token}, "status", "Revoked" - ) + frappe.db.set_value("OAuth Bearer Token", {"refresh_token": token}, "status", "Revoked") else: frappe.db.set_value("OAuth Bearer Token", token, "status", "Revoked") frappe.db.commit() @@ -574,9 +549,7 @@ def calculate_at_hash(access_token, hash_alg): def delete_oauth2_data(): # Delete Invalid Authorization Code and Revoked Token commit_code, commit_token = False, False - code_list = frappe.get_all( - "OAuth Authorization Code", filters={"validity": "Invalid"} - ) + code_list = frappe.get_all("OAuth Authorization Code", filters={"validity": "Invalid"}) token_list = frappe.get_all("OAuth Bearer Token", filters={"status": "Revoked"}) if len(code_list) > 0: commit_code = True diff --git a/frappe/parallel_test_runner.py b/frappe/parallel_test_runner.py index 1a6892d30d..f5367e9dc6 100644 --- a/frappe/parallel_test_runner.py +++ b/frappe/parallel_test_runner.py @@ -4,17 +4,20 @@ import re import sys import time import unittest + import click -import frappe import requests -from .test_runner import (SLOW_TEST_THRESHOLD, make_test_records, set_test_email_config) +import frappe + +from .test_runner import SLOW_TEST_THRESHOLD, make_test_records, set_test_email_config click_ctx = click.get_current_context(True) if click_ctx: click_ctx.color = True -class ParallelTestRunner(): + +class ParallelTestRunner: def __init__(self, app, site, build_number=1, total_builds=1): self.app = app self.site = site @@ -39,15 +42,15 @@ class ParallelTestRunner(): for fn in frappe.get_hooks("before_tests", app_name=self.app): frappe.get_attr(fn)() - test_module = frappe.get_module(f'{self.app}.tests') + test_module = frappe.get_module(f"{self.app}.tests") if hasattr(test_module, "global_test_dependencies"): for doctype in test_module.global_test_dependencies: make_test_records(doctype) elapsed = time.time() - start_time - elapsed = click.style(f' ({elapsed:.03}s)', fg='red') - click.echo(f'Before Test {elapsed}') + elapsed = click.style(f" ({elapsed:.03}s)", fg="red") + click.echo(f"Before Test {elapsed}") def run_tests(self): self.test_result = ParallelTestResult(stream=sys.stderr, descriptions=True, verbosity=2) @@ -58,9 +61,10 @@ class ParallelTestRunner(): self.print_result() def run_tests_for_file(self, file_info): - if not file_info: return + if not file_info: + return - frappe.set_user('Administrator') + frappe.set_user("Administrator") path, filename = file_info module = self.get_module(path, filename) self.create_test_dependency_records(module, path, filename) @@ -76,10 +80,10 @@ class ParallelTestRunner(): if os.path.basename(os.path.dirname(path)) == "doctype": # test_data_migration_connector.py > data_migration_connector.json - test_record_filename = re.sub('^test_', '', filename).replace(".py", ".json") + test_record_filename = re.sub("^test_", "", filename).replace(".py", ".json") test_record_file_path = os.path.join(path, test_record_filename) if os.path.exists(test_record_file_path): - with open(test_record_file_path, 'r') as f: + with open(test_record_file_path, "r") as f: doc = json.loads(f.read()) doctype = doc["name"] make_test_records(doctype) @@ -87,12 +91,12 @@ class ParallelTestRunner(): def get_module(self, path, filename): app_path = frappe.get_pymodule_path(self.app) relative_path = os.path.relpath(path, app_path) - if relative_path == '.': + if relative_path == ".": module_name = self.app else: - relative_path = relative_path.replace('/', '.') + relative_path = relative_path.replace("/", ".") module_name = os.path.splitext(filename)[0] - module_name = f'{self.app}.{relative_path}.{module_name}' + module_name = f"{self.app}.{relative_path}.{module_name}" return frappe.get_module(module_name) @@ -100,14 +104,14 @@ class ParallelTestRunner(): self.test_result.printErrors() click.echo(self.test_result) if self.test_result.failures or self.test_result.errors: - if os.environ.get('CI'): + if os.environ.get("CI"): sys.exit(1) def get_test_file_list(self): test_list = get_all_tests(self.app) split_size = frappe.utils.ceil(len(test_list) / self.total_builds) # [1,2,3,4,5,6] to [[1,2], [3,4], [4,6]] if split_size is 2 - test_chunks = [test_list[x:x+split_size] for x in range(0, len(test_list), split_size)] + test_chunks = [test_list[x : x + split_size] for x in range(0, len(test_list), split_size)] return test_chunks[self.build_number - 1] @@ -116,18 +120,18 @@ class ParallelTestResult(unittest.TextTestResult): self._started_at = time.time() super(unittest.TextTestResult, self).startTest(test) test_class = unittest.util.strclass(test.__class__) - if not hasattr(self, 'current_test_class') or self.current_test_class != test_class: + if not hasattr(self, "current_test_class") or self.current_test_class != test_class: click.echo(f"\n{unittest.util.strclass(test.__class__)}") self.current_test_class = test_class def getTestMethodName(self, test): - return test._testMethodName if hasattr(test, '_testMethodName') else str(test) + return test._testMethodName if hasattr(test, "_testMethodName") else str(test) def addSuccess(self, test): super(unittest.TextTestResult, self).addSuccess(test) elapsed = time.time() - self._started_at threshold_passed = elapsed >= SLOW_TEST_THRESHOLD - elapsed = click.style(f' ({elapsed:.03}s)', fg='red') if threshold_passed else '' + elapsed = click.style(f" ({elapsed:.03}s)", fg="red") if threshold_passed else "" click.echo(f" {click.style(' ✔ ', fg='green')} {self.getTestMethodName(test)}{elapsed}") def addError(self, test, err): @@ -151,9 +155,9 @@ class ParallelTestResult(unittest.TextTestResult): click.echo(f" {click.style(' ✔ ', fg='green')} {self.getTestMethodName(test)}") def printErrors(self): - click.echo('\n') - self.printErrorList(' ERROR ', self.errors, 'red') - self.printErrorList(' FAIL ', self.failures, 'red') + click.echo("\n") + self.printErrorList(" ERROR ", self.errors, "red") + self.printErrorList(" FAIL ", self.failures, "red") def printErrorList(self, flavour, errors, color): for test, err in errors: @@ -165,10 +169,11 @@ class ParallelTestResult(unittest.TextTestResult): def __str__(self): return f"Tests: {self.testsRun}, Failing: {len(self.failures)}, Errors: {len(self.errors)}" + def get_all_tests(app): test_file_list = [] for path, folders, files in os.walk(frappe.get_pymodule_path(app)): - for dontwalk in ('locals', '.git', 'public', '__pycache__'): + for dontwalk in ("locals", ".git", "public", "__pycache__"): if dontwalk in folders: folders.remove(dontwalk) @@ -181,61 +186,61 @@ def get_all_tests(app): continue for filename in files: - if filename.startswith("test_") and filename.endswith(".py") \ - and filename != 'test_runner.py': + if filename.startswith("test_") and filename.endswith(".py") and filename != "test_runner.py": test_file_list.append([path, filename]) return test_file_list class ParallelTestWithOrchestrator(ParallelTestRunner): - ''' - This can be used to balance-out test time across multiple instances - This is dependent on external orchestrator which returns next test to run - - orchestrator endpoints - - register-instance (
') - signature = '
' + signature + '
'
- frappe.db.set_value('User', d.get('name'), 'email_signature', signature)
\ No newline at end of file
+ signature = d.get("email_signature")
+ signature = signature.replace("\n", "") + signature = "
" + signature + "
"
+ frappe.db.set_value("User", d.get("name"), "email_signature", signature)
diff --git a/frappe/patches/v11_0/copy_fetch_data_from_options.py b/frappe/patches/v11_0/copy_fetch_data_from_options.py
index e256c7085f..1f141188f9 100644
--- a/frappe/patches/v11_0/copy_fetch_data_from_options.py
+++ b/frappe/patches/v11_0/copy_fetch_data_from_options.py
@@ -1,32 +1,38 @@
-
import frappe
+
def execute():
frappe.reload_doc("core", "doctype", "docfield", force=True)
frappe.reload_doc("custom", "doctype", "custom_field", force=True)
frappe.reload_doc("custom", "doctype", "customize_form_field", force=True)
frappe.reload_doc("custom", "doctype", "property_setter", force=True)
- frappe.db.sql('''
+ frappe.db.sql(
+ """
update `tabDocField`
set fetch_from = options, options=''
where options like '%.%' and (fetch_from is NULL OR fetch_from='')
and fieldtype in ('Data', 'Read Only', 'Text', 'Small Text', 'Text Editor', 'Code', 'Link', 'Check')
and fieldname!='naming_series'
- ''')
+ """
+ )
- frappe.db.sql('''
+ frappe.db.sql(
+ """
update `tabCustom Field`
set fetch_from = options, options=''
where options like '%.%' and (fetch_from is NULL OR fetch_from='')
and fieldtype in ('Data', 'Read Only', 'Text', 'Small Text', 'Text Editor', 'Code', 'Link', 'Check')
and fieldname!='naming_series'
- ''')
+ """
+ )
- frappe.db.sql('''
+ frappe.db.sql(
+ """
update `tabProperty Setter`
set property="fetch_from", name=concat(doc_type, '-', field_name, '-', property)
where property="options" and value like '%.%'
and property_type in ('Data', 'Read Only', 'Text', 'Small Text', 'Text Editor', 'Code', 'Link', 'Check')
and field_name!='naming_series'
- ''')
\ No newline at end of file
+ """
+ )
diff --git a/frappe/patches/v11_0/create_contact_for_user.py b/frappe/patches/v11_0/create_contact_for_user.py
index 5a483b630e..b921787422 100644
--- a/frappe/patches/v11_0/create_contact_for_user.py
+++ b/frappe/patches/v11_0/create_contact_for_user.py
@@ -1,25 +1,28 @@
+import re
import frappe
from frappe.core.doctype.user.user import create_contact
-import re
+
def execute():
- """ Create Contact for each User if not present """
- frappe.reload_doc('integrations', 'doctype', 'google_contacts')
- frappe.reload_doc('contacts', 'doctype', 'contact')
- frappe.reload_doc('core', 'doctype', 'dynamic_link')
+ """Create Contact for each User if not present"""
+ frappe.reload_doc("integrations", "doctype", "google_contacts")
+ frappe.reload_doc("contacts", "doctype", "contact")
+ frappe.reload_doc("core", "doctype", "dynamic_link")
contact_meta = frappe.get_meta("Contact")
if contact_meta.has_field("phone_nos") and contact_meta.has_field("email_ids"):
- frappe.reload_doc('contacts', 'doctype', 'contact_phone')
- frappe.reload_doc('contacts', 'doctype', 'contact_email')
+ frappe.reload_doc("contacts", "doctype", "contact_phone")
+ frappe.reload_doc("contacts", "doctype", "contact_email")
- users = frappe.get_all('User', filters={"name": ('not in', 'Administrator, Guest')}, fields=["*"])
+ users = frappe.get_all("User", filters={"name": ("not in", "Administrator, Guest")}, fields=["*"])
for user in users:
- if frappe.db.exists("Contact", {"email_id": user.email}) or frappe.db.exists("Contact Email", {"email_id": user.email}):
+ if frappe.db.exists("Contact", {"email_id": user.email}) or frappe.db.exists(
+ "Contact Email", {"email_id": user.email}
+ ):
continue
if user.first_name:
- user.first_name = re.sub("[<>]+", '', frappe.safe_decode(user.first_name))
+ user.first_name = re.sub("[<>]+", "", frappe.safe_decode(user.first_name))
if user.last_name:
- user.last_name = re.sub("[<>]+", '', frappe.safe_decode(user.last_name))
+ user.last_name = re.sub("[<>]+", "", frappe.safe_decode(user.last_name))
create_contact(user, ignore_links=True, ignore_mandatory=True)
diff --git a/frappe/patches/v11_0/delete_all_prepared_reports.py b/frappe/patches/v11_0/delete_all_prepared_reports.py
index 77f041e3ee..097be97053 100644
--- a/frappe/patches/v11_0/delete_all_prepared_reports.py
+++ b/frappe/patches/v11_0/delete_all_prepared_reports.py
@@ -1,8 +1,8 @@
-
import frappe
+
def execute():
- if frappe.db.table_exists('Prepared Report'):
+ if frappe.db.table_exists("Prepared Report"):
frappe.reload_doc("core", "doctype", "prepared_report")
prepared_reports = frappe.get_all("Prepared Report")
for report in prepared_reports:
diff --git a/frappe/patches/v11_0/delete_duplicate_user_permissions.py b/frappe/patches/v11_0/delete_duplicate_user_permissions.py
index 518c1f7714..b986c6f825 100644
--- a/frappe/patches/v11_0/delete_duplicate_user_permissions.py
+++ b/frappe/patches/v11_0/delete_duplicate_user_permissions.py
@@ -1,13 +1,20 @@
-
import frappe
+
def execute():
- duplicateRecords = frappe.db.sql("""select count(name) as `count`, allow, user, for_value
+ duplicateRecords = frappe.db.sql(
+ """select count(name) as `count`, allow, user, for_value
from `tabUser Permission`
group by allow, user, for_value
- having count(*) > 1 """, as_dict=1)
+ having count(*) > 1 """,
+ as_dict=1,
+ )
for record in duplicateRecords:
- frappe.db.sql("""delete from `tabUser Permission`
- where allow=%s and user=%s and for_value=%s limit {0}"""
- .format(record.count - 1), (record.allow, record.user, record.for_value))
+ frappe.db.sql(
+ """delete from `tabUser Permission`
+ where allow=%s and user=%s and for_value=%s limit {0}""".format(
+ record.count - 1
+ ),
+ (record.allow, record.user, record.for_value),
+ )
diff --git a/frappe/patches/v11_0/drop_column_apply_user_permissions.py b/frappe/patches/v11_0/drop_column_apply_user_permissions.py
index 629d5a5da4..bfc4aee72c 100644
--- a/frappe/patches/v11_0/drop_column_apply_user_permissions.py
+++ b/frappe/patches/v11_0/drop_column_apply_user_permissions.py
@@ -1,15 +1,14 @@
-
import frappe
+
def execute():
- column = 'apply_user_permissions'
- to_remove = ['DocPerm', 'Custom DocPerm']
+ column = "apply_user_permissions"
+ to_remove = ["DocPerm", "Custom DocPerm"]
for doctype in to_remove:
if frappe.db.table_exists(doctype):
if column in frappe.db.get_table_columns(doctype):
frappe.db.sql("alter table `tab{0}` drop column {1}".format(doctype, column))
- frappe.reload_doc('core', 'doctype', 'docperm', force=True)
- frappe.reload_doc('core', 'doctype', 'custom_docperm', force=True)
-
+ frappe.reload_doc("core", "doctype", "docperm", force=True)
+ frappe.reload_doc("core", "doctype", "custom_docperm", force=True)
diff --git a/frappe/patches/v11_0/fix_order_by_in_reports_json.py b/frappe/patches/v11_0/fix_order_by_in_reports_json.py
index 096e0e7654..3dfec0954f 100644
--- a/frappe/patches/v11_0/fix_order_by_in_reports_json.py
+++ b/frappe/patches/v11_0/fix_order_by_in_reports_json.py
@@ -1,26 +1,35 @@
+import json
+
+import frappe
-import frappe, json
def execute():
- reports_data = frappe.get_all('Report',
- filters={'json': ['not like', '%%%"order_by": "`tab%%%'],
- 'report_type': 'Report Builder', 'is_standard': 'No'}, fields=['name'])
+ reports_data = frappe.get_all(
+ "Report",
+ filters={
+ "json": ["not like", '%%%"order_by": "`tab%%%'],
+ "report_type": "Report Builder",
+ "is_standard": "No",
+ },
+ fields=["name"],
+ )
for d in reports_data:
- doc = frappe.get_doc('Report', d.get('name'))
+ doc = frappe.get_doc("Report", d.get("name"))
- if not doc.get('json'): continue
+ if not doc.get("json"):
+ continue
- json_data = json.loads(doc.get('json'))
+ json_data = json.loads(doc.get("json"))
parts = []
- if ('order_by' in json_data) and ('.' in json_data.get('order_by')):
- parts = json_data.get('order_by').split('.')
+ if ("order_by" in json_data) and ("." in json_data.get("order_by")):
+ parts = json_data.get("order_by").split(".")
- sort_by = parts[1].split(' ')
+ sort_by = parts[1].split(" ")
- json_data['order_by'] = '`tab{0}`.`{1}`'.format(doc.ref_doctype, sort_by[0])
- json_data['order_by'] += ' {0}'.format(sort_by[1]) if len(sort_by) > 1 else ''
+ json_data["order_by"] = "`tab{0}`.`{1}`".format(doc.ref_doctype, sort_by[0])
+ json_data["order_by"] += " {0}".format(sort_by[1]) if len(sort_by) > 1 else ""
doc.json = json.dumps(json_data)
doc.save()
diff --git a/frappe/patches/v11_0/make_all_prepared_report_attachments_private.py b/frappe/patches/v11_0/make_all_prepared_report_attachments_private.py
index a099b89b40..277235ce04 100644
--- a/frappe/patches/v11_0/make_all_prepared_report_attachments_private.py
+++ b/frappe/patches/v11_0/make_all_prepared_report_attachments_private.py
@@ -1,12 +1,18 @@
-
import frappe
def execute():
- if frappe.db.count("File", filters={"attached_to_doctype": "Prepared Report", "is_private": 0}) > 10000:
+ if (
+ frappe.db.count("File", filters={"attached_to_doctype": "Prepared Report", "is_private": 0})
+ > 10000
+ ):
frappe.db.auto_commit_on_many_writes = True
- files = frappe.get_all("File", fields=["name", "attached_to_name"], filters={"attached_to_doctype": "Prepared Report", "is_private": 0})
+ files = frappe.get_all(
+ "File",
+ fields=["name", "attached_to_name"],
+ filters={"attached_to_doctype": "Prepared Report", "is_private": 0},
+ )
for file_dict in files:
# For some reason Prepared Report doc might not exist, check if it exists first
if frappe.db.exists("Prepared Report", file_dict.attached_to_name):
@@ -23,4 +29,3 @@ def execute():
if frappe.db.auto_commit_on_many_writes:
frappe.db.auto_commit_on_many_writes = False
-
diff --git a/frappe/patches/v11_0/migrate_report_settings_for_new_listview.py b/frappe/patches/v11_0/migrate_report_settings_for_new_listview.py
index e5b18368db..c867502fde 100644
--- a/frappe/patches/v11_0/migrate_report_settings_for_new_listview.py
+++ b/frappe/patches/v11_0/migrate_report_settings_for_new_listview.py
@@ -1,34 +1,34 @@
+import json
-import frappe, json
+import frappe
-def execute():
- '''
- Migrate JSON field of Report according to changes in New ListView
- Rename key columns to fields
- Rename key add_total_row to add_totals_row
- Convert sort_by and sort_order to order_by
- '''
-
- reports = frappe.get_all('Report', { 'report_type': 'Report Builder' })
- for report_name in reports:
- settings = frappe.db.get_value('Report', report_name, 'json')
- if not settings:
- continue
+def execute():
+ """
+ Migrate JSON field of Report according to changes in New ListView
+ Rename key columns to fields
+ Rename key add_total_row to add_totals_row
+ Convert sort_by and sort_order to order_by
+ """
- settings = frappe._dict(json.loads(settings))
+ reports = frappe.get_all("Report", {"report_type": "Report Builder"})
- # columns -> fields
- settings.fields = settings.columns or []
- settings.pop('columns', None)
+ for report_name in reports:
+ settings = frappe.db.get_value("Report", report_name, "json")
+ if not settings:
+ continue
- # sort_by + order_by -> order_by
- settings.order_by = (settings.sort_by or 'modified') + ' ' + (settings.order_by or 'desc')
+ settings = frappe._dict(json.loads(settings))
- # add_total_row -> add_totals_row
- settings.add_totals_row = settings.add_total_row
- settings.pop('add_total_row', None)
+ # columns -> fields
+ settings.fields = settings.columns or []
+ settings.pop("columns", None)
- frappe.db.set_value('Report', report_name, 'json', json.dumps(settings))
+ # sort_by + order_by -> order_by
+ settings.order_by = (settings.sort_by or "modified") + " " + (settings.order_by or "desc")
+ # add_total_row -> add_totals_row
+ settings.add_totals_row = settings.add_total_row
+ settings.pop("add_total_row", None)
+ frappe.db.set_value("Report", report_name, "json", json.dumps(settings))
diff --git a/frappe/patches/v11_0/multiple_references_in_events.py b/frappe/patches/v11_0/multiple_references_in_events.py
index 9fa5968d8e..3eddea92bb 100644
--- a/frappe/patches/v11_0/multiple_references_in_events.py
+++ b/frappe/patches/v11_0/multiple_references_in_events.py
@@ -1,19 +1,24 @@
-
import frappe
+
def execute():
- frappe.reload_doctype('Event')
+ frappe.reload_doctype("Event")
# Rename "Cancel" to "Cancelled"
frappe.db.sql("""UPDATE tabEvent set event_type='Cancelled' where event_type='Cancel'""")
# Move references to Participants table
- events = frappe.db.sql("""SELECT name, ref_type, ref_name FROM tabEvent WHERE ref_type!=''""", as_dict=True)
+ events = frappe.db.sql(
+ """SELECT name, ref_type, ref_name FROM tabEvent WHERE ref_type!=''""", as_dict=True
+ )
for event in events:
if event.ref_type and event.ref_name:
try:
- e = frappe.get_doc('Event', event.name)
- e.append('event_participants', {"reference_doctype": event.ref_type, "reference_docname": event.ref_name})
- e.flags.ignore_mandatory = True
+ e = frappe.get_doc("Event", event.name)
+ e.append(
+ "event_participants",
+ {"reference_doctype": event.ref_type, "reference_docname": event.ref_name},
+ )
+ e.flags.ignore_mandatory = True
e.flags.ignore_permissions = True
e.save()
except Exception:
- frappe.log_error(frappe.get_traceback())
\ No newline at end of file
+ frappe.log_error(frappe.get_traceback())
diff --git a/frappe/patches/v11_0/reload_and_rename_view_log.py b/frappe/patches/v11_0/reload_and_rename_view_log.py
index fa0432c4e2..67a18f3a30 100644
--- a/frappe/patches/v11_0/reload_and_rename_view_log.py
+++ b/frappe/patches/v11_0/reload_and_rename_view_log.py
@@ -1,8 +1,8 @@
-
import frappe
+
def execute():
- if frappe.db.table_exists('View log'):
+ if frappe.db.table_exists("View log"):
# for mac users direct renaming would not work since mysql for mac saves table name in lower case
# so while renaming `tabView log` to `tabView Log` we get "Table 'tabView Log' already exists" error
# more info https://stackoverflow.com/a/44753093/5955589 ,
@@ -13,10 +13,10 @@ def execute():
# deleting old View log table
frappe.db.sql("DROP table `tabView log`")
- frappe.delete_doc('DocType', 'View log')
+ frappe.delete_doc("DocType", "View log")
# reloading view log doctype to create `tabView Log` table
- frappe.reload_doc('core', 'doctype', 'view_log')
+ frappe.reload_doc("core", "doctype", "view_log")
# Move the data to newly created `tabView Log` table
frappe.db.sql("INSERT INTO `tabView Log` SELECT * FROM `ViewLogTemp`")
@@ -25,4 +25,4 @@ def execute():
# Delete temporary table
frappe.db.sql("DROP table `ViewLogTemp`")
else:
- frappe.reload_doc('core', 'doctype', 'view_log')
+ frappe.reload_doc("core", "doctype", "view_log")
diff --git a/frappe/patches/v11_0/remove_doctype_user_permissions_for_page_and_report.py b/frappe/patches/v11_0/remove_doctype_user_permissions_for_page_and_report.py
index ff5cf3fc5e..17a2856173 100644
--- a/frappe/patches/v11_0/remove_doctype_user_permissions_for_page_and_report.py
+++ b/frappe/patches/v11_0/remove_doctype_user_permissions_for_page_and_report.py
@@ -3,5 +3,6 @@
import frappe
+
def execute():
- frappe.delete_doc_if_exists("DocType", "User Permission for Page and Report")
\ No newline at end of file
+ frappe.delete_doc_if_exists("DocType", "User Permission for Page and Report")
diff --git a/frappe/patches/v11_0/remove_skip_for_doctype.py b/frappe/patches/v11_0/remove_skip_for_doctype.py
index 6e66c75f68..e7c1d71a0a 100644
--- a/frappe/patches/v11_0/remove_skip_for_doctype.py
+++ b/frappe/patches/v11_0/remove_skip_for_doctype.py
@@ -1,4 +1,3 @@
-
import frappe
from frappe.desk.form.linked_with import get_linked_doctypes
from frappe.patches.v11_0.replicate_old_user_permissions import get_doctypes_to_skip
@@ -13,8 +12,9 @@ from frappe.query_builder import Field
# if the user permission is applicable for all doctypes, then only
# one record is created
+
def execute():
- frappe.reload_doctype('User Permission')
+ frappe.reload_doctype("User Permission")
# to check if we need to migrate from skip_for_doctype
has_skip_for_doctype = frappe.db.has_column("User Permission", "skip_for_doctype")
@@ -24,15 +24,15 @@ def execute():
user_permissions_to_delete = []
- for user_permission in frappe.get_all('User Permission', fields=['*']):
+ for user_permission in frappe.get_all("User Permission", fields=["*"]):
skip_for_doctype = []
# while migrating from v11 -> v11
if has_skip_for_doctype:
if not user_permission.skip_for_doctype:
continue
- skip_for_doctype = user_permission.skip_for_doctype.split('\n')
- else: # while migrating from v10 -> v11
+ skip_for_doctype = user_permission.skip_for_doctype.split("\n")
+ else: # while migrating from v10 -> v11
if skip_for_doctype_map.get((user_permission.allow, user_permission.user)) is None:
skip_for_doctype = get_doctypes_to_skip(user_permission.allow, user_permission.user)
# cache skip for doctype for same user and doctype
@@ -58,27 +58,35 @@ def execute():
for doctype in applicable_for_doctypes:
if doctype:
# Maintain sequence (name, user, allow, for_value, applicable_for, apply_to_all_doctypes, creation, modified)
- new_user_permissions_list.append((
- frappe.generate_hash("", 10),
- user_permission.user,
- user_permission.allow,
- user_permission.for_value,
- doctype,
- 0,
- user_permission.creation,
- user_permission.modified
- ))
+ new_user_permissions_list.append(
+ (
+ frappe.generate_hash("", 10),
+ user_permission.user,
+ user_permission.allow,
+ user_permission.for_value,
+ doctype,
+ 0,
+ user_permission.creation,
+ user_permission.modified,
+ )
+ )
else:
# No skip_for_doctype found! Just update apply_to_all_doctypes.
- frappe.db.set_value('User Permission', user_permission.name, 'apply_to_all_doctypes', 1)
+ frappe.db.set_value("User Permission", user_permission.name, "apply_to_all_doctypes", 1)
if new_user_permissions_list:
frappe.qb.into("User Permission").columns(
- "name", "user", "allow", "for_value", "applicable_for", "apply_to_all_doctypes", "creation", "modified"
+ "name",
+ "user",
+ "allow",
+ "for_value",
+ "applicable_for",
+ "apply_to_all_doctypes",
+ "creation",
+ "modified",
).insert(*new_user_permissions_list).run()
if user_permissions_to_delete:
frappe.db.delete(
- "User Permission",
- filters=(Field("name").isin(tuple(user_permissions_to_delete)))
+ "User Permission", filters=(Field("name").isin(tuple(user_permissions_to_delete)))
)
diff --git a/frappe/patches/v11_0/rename_email_alert_to_notification.py b/frappe/patches/v11_0/rename_email_alert_to_notification.py
index 365b76ea48..7f0032d639 100644
--- a/frappe/patches/v11_0/rename_email_alert_to_notification.py
+++ b/frappe/patches/v11_0/rename_email_alert_to_notification.py
@@ -1,12 +1,14 @@
-
import frappe
from frappe.model.rename_doc import rename_doc
+
def execute():
- if frappe.db.table_exists("Email Alert Recipient") and not frappe.db.table_exists("Notification Recipient"):
- rename_doc('DocType', 'Email Alert Recipient', 'Notification Recipient')
- frappe.reload_doc('email', 'doctype', 'notification_recipient')
+ if frappe.db.table_exists("Email Alert Recipient") and not frappe.db.table_exists(
+ "Notification Recipient"
+ ):
+ rename_doc("DocType", "Email Alert Recipient", "Notification Recipient")
+ frappe.reload_doc("email", "doctype", "notification_recipient")
if frappe.db.table_exists("Email Alert") and not frappe.db.table_exists("Notification"):
- rename_doc('DocType', 'Email Alert', 'Notification')
- frappe.reload_doc('email', 'doctype', 'notification')
+ rename_doc("DocType", "Email Alert", "Notification")
+ frappe.reload_doc("email", "doctype", "notification")
diff --git a/frappe/patches/v11_0/rename_google_maps_doctype.py b/frappe/patches/v11_0/rename_google_maps_doctype.py
index 8091154b9c..354c19a7ed 100644
--- a/frappe/patches/v11_0/rename_google_maps_doctype.py
+++ b/frappe/patches/v11_0/rename_google_maps_doctype.py
@@ -1,7 +1,9 @@
-
import frappe
from frappe.model.rename_doc import rename_doc
+
def execute():
- if frappe.db.exists("DocType","Google Maps") and not frappe.db.exists("DocType","Google Maps Settings"):
- rename_doc('DocType', 'Google Maps', 'Google Maps Settings')
+ if frappe.db.exists("DocType", "Google Maps") and not frappe.db.exists(
+ "DocType", "Google Maps Settings"
+ ):
+ rename_doc("DocType", "Google Maps", "Google Maps Settings")
diff --git a/frappe/patches/v11_0/rename_standard_reply_to_email_template.py b/frappe/patches/v11_0/rename_standard_reply_to_email_template.py
index 2906085738..dabdb96633 100644
--- a/frappe/patches/v11_0/rename_standard_reply_to_email_template.py
+++ b/frappe/patches/v11_0/rename_standard_reply_to_email_template.py
@@ -1,8 +1,8 @@
-
import frappe
from frappe.model.rename_doc import rename_doc
+
def execute():
if frappe.db.table_exists("Standard Reply") and not frappe.db.table_exists("Email Template"):
- rename_doc('DocType', 'Standard Reply', 'Email Template')
- frappe.reload_doc('email', 'doctype', 'email_template')
+ rename_doc("DocType", "Standard Reply", "Email Template")
+ frappe.reload_doc("email", "doctype", "email_template")
diff --git a/frappe/patches/v11_0/rename_workflow_action_to_workflow_action_master.py b/frappe/patches/v11_0/rename_workflow_action_to_workflow_action_master.py
index 9a48104611..b8fa85217a 100644
--- a/frappe/patches/v11_0/rename_workflow_action_to_workflow_action_master.py
+++ b/frappe/patches/v11_0/rename_workflow_action_to_workflow_action_master.py
@@ -1,9 +1,10 @@
-
import frappe
from frappe.model.rename_doc import rename_doc
def execute():
- if frappe.db.table_exists("Workflow Action") and not frappe.db.table_exists("Workflow Action Master"):
- rename_doc('DocType', 'Workflow Action', 'Workflow Action Master')
- frappe.reload_doc('workflow', 'doctype', 'workflow_action_master')
+ if frappe.db.table_exists("Workflow Action") and not frappe.db.table_exists(
+ "Workflow Action Master"
+ ):
+ rename_doc("DocType", "Workflow Action", "Workflow Action Master")
+ frappe.reload_doc("workflow", "doctype", "workflow_action_master")
diff --git a/frappe/patches/v11_0/replicate_old_user_permissions.py b/frappe/patches/v11_0/replicate_old_user_permissions.py
index 50a81b5ce7..999a5d7698 100644
--- a/frappe/patches/v11_0/replicate_old_user_permissions.py
+++ b/frappe/patches/v11_0/replicate_old_user_permissions.py
@@ -1,41 +1,51 @@
+import json
import frappe
-import json
-from frappe.utils import cint
from frappe.permissions import get_valid_perms
+from frappe.utils import cint
+
def execute():
frappe.reload_doctype("User Permission")
- user_permissions = frappe.get_all('User Permission', fields=['allow', 'name', 'user'])
+ user_permissions = frappe.get_all("User Permission", fields=["allow", "name", "user"])
doctype_to_skip_map = {}
for permission in user_permissions:
if (permission.allow, permission.user) not in doctype_to_skip_map:
- doctype_to_skip_map[(permission.allow, permission.user)] = get_doctypes_to_skip(permission.allow, permission.user)
+ doctype_to_skip_map[(permission.allow, permission.user)] = get_doctypes_to_skip(
+ permission.allow, permission.user
+ )
- if not doctype_to_skip_map: return
+ if not doctype_to_skip_map:
+ return
for key, doctype_to_skip in doctype_to_skip_map.items():
- if not doctype_to_skip: continue
- if not frappe.db.has_column("User Permission", "applicable_for") \
- and frappe.db.has_column("User Permission", "skip_for_doctype"):
- doctype_to_skip = '\n'.join(doctype_to_skip)
- frappe.db.sql("""
+ if not doctype_to_skip:
+ continue
+ if not frappe.db.has_column("User Permission", "applicable_for") and frappe.db.has_column(
+ "User Permission", "skip_for_doctype"
+ ):
+ doctype_to_skip = "\n".join(doctype_to_skip)
+ frappe.db.sql(
+ """
update `tabUser Permission`
set skip_for_doctype = %s
where user=%s and allow=%s
- """, (doctype_to_skip, key[1], key[0]))
+ """,
+ (doctype_to_skip, key[1], key[0]),
+ )
def get_doctypes_to_skip(doctype, user):
- ''' Returns doctypes to be skipped from user permission check'''
+ """Returns doctypes to be skipped from user permission check"""
doctypes_to_skip = []
valid_perms = get_user_valid_perms(user) or []
for perm in valid_perms:
parent_doctype = perm.parent
try:
linked_doctypes = get_linked_doctypes(parent_doctype)
- if doctype not in linked_doctypes: continue
+ if doctype not in linked_doctypes:
+ continue
except frappe.DoesNotExistError:
# if doctype not found (may be due to rename) it should not be considered for skip
continue
@@ -44,40 +54,47 @@ def get_doctypes_to_skip(doctype, user):
# add doctype to skip list if any of the perm does not apply user permission
doctypes_to_skip.append(parent_doctype)
-
elif parent_doctype not in doctypes_to_skip:
user_permission_doctypes = get_user_permission_doctypes(perm)
# "No doctypes present" indicates that user permission will be applied to each link field
- if not user_permission_doctypes: continue
+ if not user_permission_doctypes:
+ continue
- elif doctype in user_permission_doctypes: continue
+ elif doctype in user_permission_doctypes:
+ continue
- else: doctypes_to_skip.append(parent_doctype)
+ else:
+ doctypes_to_skip.append(parent_doctype)
# to remove possible duplicates
doctypes_to_skip = list(set(doctypes_to_skip))
return doctypes_to_skip
+
# store user's valid perms to avoid repeated query
user_valid_perm = {}
+
def get_user_valid_perms(user):
if not user_valid_perm.get(user):
user_valid_perm[user] = get_valid_perms(user=user)
return user_valid_perm.get(user)
+
def get_user_permission_doctypes(perm):
try:
- return json.loads(perm.user_permission_doctypes or '[]')
+ return json.loads(perm.user_permission_doctypes or "[]")
except ValueError:
return []
+
def get_linked_doctypes(doctype):
from frappe.permissions import get_linked_doctypes
+
linked_doctypes = get_linked_doctypes(doctype)
child_doctypes = [d.options for d in frappe.get_meta(doctype).get_table_fields()]
for child_dt in child_doctypes:
linked_doctypes += get_linked_doctypes(child_dt)
- return linked_doctypes
\ No newline at end of file
+ return linked_doctypes
diff --git a/frappe/patches/v11_0/set_allow_self_approval_in_workflow.py b/frappe/patches/v11_0/set_allow_self_approval_in_workflow.py
index 63ae5f949f..fc1997bee1 100644
--- a/frappe/patches/v11_0/set_allow_self_approval_in_workflow.py
+++ b/frappe/patches/v11_0/set_allow_self_approval_in_workflow.py
@@ -1,6 +1,6 @@
-
import frappe
+
def execute():
frappe.reload_doc("workflow", "doctype", "workflow_transition")
- frappe.db.sql("update `tabWorkflow Transition` set allow_self_approval=1")
\ No newline at end of file
+ frappe.db.sql("update `tabWorkflow Transition` set allow_self_approval=1")
diff --git a/frappe/patches/v11_0/set_default_letter_head_source.py b/frappe/patches/v11_0/set_default_letter_head_source.py
index 3639524e7d..139d8cdd07 100644
--- a/frappe/patches/v11_0/set_default_letter_head_source.py
+++ b/frappe/patches/v11_0/set_default_letter_head_source.py
@@ -1,7 +1,8 @@
import frappe
+
def execute():
- frappe.reload_doctype('Letter Head')
+ frappe.reload_doctype("Letter Head")
- # source of all existing letter heads must be HTML
- frappe.db.sql("update `tabLetter Head` set source = 'HTML'")
+ # source of all existing letter heads must be HTML
+ frappe.db.sql("update `tabLetter Head` set source = 'HTML'")
diff --git a/frappe/patches/v11_0/set_dropbox_file_backup.py b/frappe/patches/v11_0/set_dropbox_file_backup.py
index 27492b3ab2..c9dec31414 100644
--- a/frappe/patches/v11_0/set_dropbox_file_backup.py
+++ b/frappe/patches/v11_0/set_dropbox_file_backup.py
@@ -1,9 +1,9 @@
-
-from frappe.utils import cint
import frappe
+from frappe.utils import cint
+
def execute():
frappe.reload_doctype("Dropbox Settings")
check_dropbox_enabled = cint(frappe.db.get_value("Dropbox Settings", None, "enabled"))
- if check_dropbox_enabled == 1:
- frappe.db.set_value("Dropbox Settings", None, 'file_backup', 1)
+ if check_dropbox_enabled == 1:
+ frappe.db.set_value("Dropbox Settings", None, "file_backup", 1)
diff --git a/frappe/patches/v11_0/set_missing_creation_and_modified_value_for_user_permissions.py b/frappe/patches/v11_0/set_missing_creation_and_modified_value_for_user_permissions.py
index 84d6d6c994..f6594c3efb 100644
--- a/frappe/patches/v11_0/set_missing_creation_and_modified_value_for_user_permissions.py
+++ b/frappe/patches/v11_0/set_missing_creation_and_modified_value_for_user_permissions.py
@@ -1,6 +1,9 @@
import frappe
+
def execute():
- frappe.db.sql('''UPDATE `tabUser Permission`
+ frappe.db.sql(
+ """UPDATE `tabUser Permission`
SET `modified`=NOW(), `creation`=NOW()
- WHERE `creation` IS NULL''')
\ No newline at end of file
+ WHERE `creation` IS NULL"""
+ )
diff --git a/frappe/patches/v11_0/sync_stripe_settings_before_migrate.py b/frappe/patches/v11_0/sync_stripe_settings_before_migrate.py
index 901ab66bfd..019ecef67c 100644
--- a/frappe/patches/v11_0/sync_stripe_settings_before_migrate.py
+++ b/frappe/patches/v11_0/sync_stripe_settings_before_migrate.py
@@ -1,18 +1,23 @@
-
import frappe
from frappe.utils.password import get_decrypted_password
+
def execute():
- publishable_key = frappe.db.sql("select value from tabSingles where doctype='Stripe Settings' and field='publishable_key'")
+ publishable_key = frappe.db.sql(
+ "select value from tabSingles where doctype='Stripe Settings' and field='publishable_key'"
+ )
if publishable_key:
- secret_key = get_decrypted_password('Stripe Settings', 'Stripe Settings',
- fieldname='secret_key', raise_exception=False)
+ secret_key = get_decrypted_password(
+ "Stripe Settings", "Stripe Settings", fieldname="secret_key", raise_exception=False
+ )
if secret_key:
- frappe.reload_doc('integrations', 'doctype', 'stripe_settings')
+ frappe.reload_doc("integrations", "doctype", "stripe_settings")
frappe.db.commit()
settings = frappe.new_doc("Stripe Settings")
- settings.gateway_name = frappe.db.get_value("Global Defaults", None, "default_company") or "Stripe Settings"
+ settings.gateway_name = (
+ frappe.db.get_value("Global Defaults", None, "default_company") or "Stripe Settings"
+ )
settings.publishable_key = publishable_key
settings.secret_key = secret_key
settings.save(ignore_permissions=True)
diff --git a/frappe/patches/v11_0/update_list_user_settings.py b/frappe/patches/v11_0/update_list_user_settings.py
index 1b179d8cdf..146b29346c 100644
--- a/frappe/patches/v11_0/update_list_user_settings.py
+++ b/frappe/patches/v11_0/update_list_user_settings.py
@@ -1,28 +1,35 @@
+import json
+
+import frappe
+from frappe.model.utils.user_settings import sync_user_settings, update_user_settings
-import frappe, json
-from frappe.model.utils.user_settings import update_user_settings, sync_user_settings
def execute():
- """ Update list_view's order by property from __UserSettings """
+ """Update list_view's order by property from __UserSettings"""
users = frappe.db.sql("select distinct(user) from `__UserSettings`", as_dict=True)
for user in users:
# get user_settings for each user
- settings = frappe.db.sql("select * from `__UserSettings` \
- where user={0}".format(frappe.db.escape(user.user)), as_dict=True)
+ settings = frappe.db.sql(
+ "select * from `__UserSettings` \
+ where user={0}".format(
+ frappe.db.escape(user.user)
+ ),
+ as_dict=True,
+ )
# traverse through each doctype's settings for a user
for d in settings:
- data = json.loads(d['data'])
- if data and ('List' in data) and ('order_by' in data['List']) and data['List']['order_by']:
+ data = json.loads(d["data"])
+ if data and ("List" in data) and ("order_by" in data["List"]) and data["List"]["order_by"]:
# convert order_by to sort_order & sort_by and delete order_by
- order_by = data['List']['order_by']
- if '`' in order_by and '.' in order_by:
- order_by = order_by.replace('`', '').split('.')[1]
+ order_by = data["List"]["order_by"]
+ if "`" in order_by and "." in order_by:
+ order_by = order_by.replace("`", "").split(".")[1]
- data['List']['sort_by'], data['List']['sort_order'] = order_by.split(' ')
- data['List'].pop('order_by')
- update_user_settings(d['doctype'], json.dumps(data), for_update=True)
+ data["List"]["sort_by"], data["List"]["sort_order"] = order_by.split(" ")
+ data["List"].pop("order_by")
+ update_user_settings(d["doctype"], json.dumps(data), for_update=True)
sync_user_settings()
diff --git a/frappe/patches/v12_0/change_existing_dashboard_chart_filters.py b/frappe/patches/v12_0/change_existing_dashboard_chart_filters.py
index dfdab6baf5..19f976084b 100644
--- a/frappe/patches/v12_0/change_existing_dashboard_chart_filters.py
+++ b/frappe/patches/v12_0/change_existing_dashboard_chart_filters.py
@@ -1,13 +1,16 @@
-import frappe
import json
+import frappe
+
+
def execute():
- if not frappe.db.table_exists('Dashboard Chart'):
+ if not frappe.db.table_exists("Dashboard Chart"):
return
- charts_to_modify = frappe.db.get_all('Dashboard Chart',
- fields = ['name', 'filters_json', 'document_type'],
- filters = {'chart_type': ['not in', ['Report', 'Custom']]}
+ charts_to_modify = frappe.db.get_all(
+ "Dashboard Chart",
+ fields=["name", "filters_json", "document_type"],
+ filters={"chart_type": ["not in", ["Report", "Custom"]]},
)
for chart in charts_to_modify:
@@ -22,7 +25,7 @@ def execute():
if isinstance(filter_value, list):
new_filters.append([doctype, key, filter_value[0], filter_value[1], 0])
else:
- new_filters.append([doctype, key, '=', filter_value, 0])
+ new_filters.append([doctype, key, "=", filter_value, 0])
new_filters_json = json.dumps(new_filters)
- frappe.db.set_value('Dashboard Chart', chart.name, 'filters_json', new_filters_json)
\ No newline at end of file
+ frappe.db.set_value("Dashboard Chart", chart.name, "filters_json", new_filters_json)
diff --git a/frappe/patches/v12_0/copy_to_parent_for_tags.py b/frappe/patches/v12_0/copy_to_parent_for_tags.py
index 1135f9076b..ae3702a0d5 100644
--- a/frappe/patches/v12_0/copy_to_parent_for_tags.py
+++ b/frappe/patches/v12_0/copy_to_parent_for_tags.py
@@ -1,6 +1,7 @@
import frappe
+
def execute():
frappe.db.sql("UPDATE `tabTag Link` SET parenttype=document_type")
- frappe.db.sql("UPDATE `tabTag Link` SET parent=document_name")
\ No newline at end of file
+ frappe.db.sql("UPDATE `tabTag Link` SET parent=document_name")
diff --git a/frappe/patches/v12_0/create_notification_settings_for_user.py b/frappe/patches/v12_0/create_notification_settings_for_user.py
index 6edfd88872..eb6858967b 100644
--- a/frappe/patches/v12_0/create_notification_settings_for_user.py
+++ b/frappe/patches/v12_0/create_notification_settings_for_user.py
@@ -1,11 +1,13 @@
-
import frappe
-from frappe.desk.doctype.notification_settings.notification_settings import create_notification_settings
+from frappe.desk.doctype.notification_settings.notification_settings import (
+ create_notification_settings,
+)
+
def execute():
- frappe.reload_doc('desk', 'doctype', 'notification_settings')
- frappe.reload_doc('desk', 'doctype', 'notification_subscribed_document')
+ frappe.reload_doc("desk", "doctype", "notification_settings")
+ frappe.reload_doc("desk", "doctype", "notification_subscribed_document")
- users = frappe.db.get_all('User', fields=['name'])
+ users = frappe.db.get_all("User", fields=["name"])
for user in users:
- create_notification_settings(user.name)
\ No newline at end of file
+ create_notification_settings(user.name)
diff --git a/frappe/patches/v12_0/delete_duplicate_indexes.py b/frappe/patches/v12_0/delete_duplicate_indexes.py
index ea73d49efc..6a6b0b3204 100644
--- a/frappe/patches/v12_0/delete_duplicate_indexes.py
+++ b/frappe/patches/v12_0/delete_duplicate_indexes.py
@@ -1,11 +1,13 @@
-import frappe
from pymysql import InternalError
+import frappe
+
# This patch deletes all the duplicate indexes created for same column
# The patch only checks for indexes with UNIQUE constraints
+
def execute():
- if frappe.db.db_type != 'mariadb':
+ if frappe.db.db_type != "mariadb":
return
all_tables = frappe.db.get_tables()
@@ -14,7 +16,8 @@ def execute():
for table in all_tables:
indexes_to_keep_map = frappe._dict()
indexes_to_delete = []
- index_info = frappe.db.sql("""
+ index_info = frappe.db.sql(
+ """
SELECT
column_name,
index_name,
@@ -24,7 +27,10 @@ def execute():
AND column_name!='name'
AND non_unique=0
ORDER BY index_name;
- """, table, as_dict=1)
+ """,
+ table,
+ as_dict=1,
+ )
for index in index_info:
if not indexes_to_keep_map.get(index.column_name):
diff --git a/frappe/patches/v12_0/delete_feedback_request_if_exists.py b/frappe/patches/v12_0/delete_feedback_request_if_exists.py
index c1bf46b14a..4fecb45b25 100644
--- a/frappe/patches/v12_0/delete_feedback_request_if_exists.py
+++ b/frappe/patches/v12_0/delete_feedback_request_if_exists.py
@@ -1,5 +1,5 @@
-
import frappe
+
def execute():
frappe.db.delete("DocType", {"name": "Feedback Request"})
diff --git a/frappe/patches/v12_0/delete_gsuite_if_exists.py b/frappe/patches/v12_0/delete_gsuite_if_exists.py
index 7379ac9cdf..1fb3a8c2d0 100644
--- a/frappe/patches/v12_0/delete_gsuite_if_exists.py
+++ b/frappe/patches/v12_0/delete_gsuite_if_exists.py
@@ -1,8 +1,9 @@
import frappe
+
def execute():
- '''
- Remove GSuite Template and GSuite Settings
- '''
+ """
+ Remove GSuite Template and GSuite Settings
+ """
frappe.delete_doc_if_exists("DocType", "GSuite Settings")
- frappe.delete_doc_if_exists("DocType", "GSuite Templates")
\ No newline at end of file
+ frappe.delete_doc_if_exists("DocType", "GSuite Templates")
diff --git a/frappe/patches/v12_0/fix_email_id_formatting.py b/frappe/patches/v12_0/fix_email_id_formatting.py
index 03f606e0cc..9cc2f49966 100644
--- a/frappe/patches/v12_0/fix_email_id_formatting.py
+++ b/frappe/patches/v12_0/fix_email_id_formatting.py
@@ -1,44 +1,61 @@
import frappe
+
def execute():
fix_communications()
fix_show_as_cc_email_queue()
fix_email_queue_recipients()
+
def fix_communications():
- for communication in frappe.db.sql('''select name, recipients, cc, bcc from tabCommunication
+ for communication in frappe.db.sql(
+ """select name, recipients, cc, bcc from tabCommunication
where creation > '2020-06-01'
and communication_medium='Email'
and communication_type='Communication'
and (cc like '%<%' or bcc like '%<%' or recipients like '%<%')
- ''', as_dict=1):
+ """,
+ as_dict=1,
+ ):
+
+ communication["recipients"] = format_email_id(communication.recipients)
+ communication["cc"] = format_email_id(communication.cc)
+ communication["bcc"] = format_email_id(communication.bcc)
- communication['recipients'] = format_email_id(communication.recipients)
- communication['cc'] = format_email_id(communication.cc)
- communication['bcc'] = format_email_id(communication.bcc)
+ frappe.db.sql(
+ """update `tabCommunication` set recipients=%s,cc=%s,bcc=%s
+ where name =%s """,
+ (communication["recipients"], communication["cc"], communication["bcc"], communication["name"]),
+ )
- frappe.db.sql('''update `tabCommunication` set recipients=%s,cc=%s,bcc=%s
- where name =%s ''', (communication['recipients'], communication['cc'],
- communication['bcc'], communication['name']))
def fix_show_as_cc_email_queue():
- for queue in frappe.get_all("Email Queue", {'creation': ['>', '2020-06-01'],
- 'status': 'Not Sent', 'show_as_cc': ['like', '%<%']},
- ['name', 'show_as_cc']):
+ for queue in frappe.get_all(
+ "Email Queue",
+ {"creation": [">", "2020-06-01"], "status": "Not Sent", "show_as_cc": ["like", "%<%"]},
+ ["name", "show_as_cc"],
+ ):
+
+ frappe.db.set_value(
+ "Email Queue", queue["name"], "show_as_cc", format_email_id(queue["show_as_cc"])
+ )
- frappe.db.set_value('Email Queue', queue['name'],
- 'show_as_cc', format_email_id(queue['show_as_cc']))
def fix_email_queue_recipients():
- for recipient in frappe.db.sql('''select recipient, name from
+ for recipient in frappe.db.sql(
+ """select recipient, name from
`tabEmail Queue Recipient` where recipient like '%<%'
- and status='Not Sent' and creation > '2020-06-01' ''', as_dict=1):
+ and status='Not Sent' and creation > '2020-06-01' """,
+ as_dict=1,
+ ):
+
+ frappe.db.set_value(
+ "Email Queue Recipient", recipient["name"], "recipient", format_email_id(recipient["recipient"])
+ )
- frappe.db.set_value('Email Queue Recipient', recipient['name'],
- 'recipient', format_email_id(recipient['recipient']))
def format_email_id(email):
- if email and ('<' in email and '>' in email):
- return email.replace('>', '>').replace('<', '<')
+ if email and ("<" in email and ">" in email):
+ return email.replace(">", ">").replace("<", "<")
return email
diff --git a/frappe/patches/v12_0/fix_public_private_files.py b/frappe/patches/v12_0/fix_public_private_files.py
index 065360a78e..e1ad2f1862 100644
--- a/frappe/patches/v12_0/fix_public_private_files.py
+++ b/frappe/patches/v12_0/fix_public_private_files.py
@@ -1,24 +1,26 @@
import frappe
+
def execute():
- files = frappe.get_all('File',
- fields=['is_private', 'file_url', 'name'],
- filters={'is_folder': 0})
+ files = frappe.get_all(
+ "File", fields=["is_private", "file_url", "name"], filters={"is_folder": 0}
+ )
for file in files:
file_url = file.file_url or ""
if file.is_private:
- if not file_url.startswith('/private/files/'):
+ if not file_url.startswith("/private/files/"):
generate_file(file.name)
else:
- if file_url.startswith('/private/files/'):
+ if file_url.startswith("/private/files/"):
generate_file(file.name)
+
def generate_file(file_name):
try:
- file_doc = frappe.get_doc('File', file_name)
+ file_doc = frappe.get_doc("File", file_name)
# private
- new_doc = frappe.new_doc('File')
+ new_doc = frappe.new_doc("File")
new_doc.is_private = file_doc.is_private
new_doc.file_name = file_doc.file_name
# to create copy of file in right location
diff --git a/frappe/patches/v12_0/init_desk_settings.py b/frappe/patches/v12_0/init_desk_settings.py
index fceb44b924..5ec9764e8f 100644
--- a/frappe/patches/v12_0/init_desk_settings.py
+++ b/frappe/patches/v12_0/init_desk_settings.py
@@ -1,8 +1,10 @@
import json
+
import frappe
from frappe.config import get_modules_from_all_apps_for_user
from frappe.desk.moduleview import get_onboard_items
+
def execute():
"""Reset the initial customizations for desk, with modules, indices and links."""
frappe.reload_doc("core", "doctype", "user")
diff --git a/frappe/patches/v12_0/move_email_and_phone_to_child_table.py b/frappe/patches/v12_0/move_email_and_phone_to_child_table.py
index 12680609d5..1a369b4e12 100644
--- a/frappe/patches/v12_0/move_email_and_phone_to_child_table.py
+++ b/frappe/patches/v12_0/move_email_and_phone_to_child_table.py
@@ -1,18 +1,22 @@
import frappe
+
def execute():
frappe.reload_doc("contacts", "doctype", "contact_email")
frappe.reload_doc("contacts", "doctype", "contact_phone")
frappe.reload_doc("contacts", "doctype", "contact")
- contact_details = frappe.db.sql("""
+ contact_details = frappe.db.sql(
+ """
SELECT
`name`, `email_id`, `phone`, `mobile_no`, `modified_by`, `creation`, `modified`
FROM `tabContact`
where not exists (select * from `tabContact Email`
where `tabContact Email`.parent=`tabContact`.name
and `tabContact Email`.email_id=`tabContact`.email_id)
- """, as_dict=True)
+ """,
+ as_dict=True,
+ )
email_values = []
phone_values = []
@@ -20,71 +24,87 @@ def execute():
phone_counter = 1
is_primary = 1
if contact_detail.email_id:
- email_values.append((
- 1,
- frappe.generate_hash(contact_detail.email_id, 10),
- contact_detail.email_id,
- 'email_ids',
- 'Contact',
- contact_detail.name,
- 1,
- contact_detail.creation,
- contact_detail.modified,
- contact_detail.modified_by
- ))
+ email_values.append(
+ (
+ 1,
+ frappe.generate_hash(contact_detail.email_id, 10),
+ contact_detail.email_id,
+ "email_ids",
+ "Contact",
+ contact_detail.name,
+ 1,
+ contact_detail.creation,
+ contact_detail.modified,
+ contact_detail.modified_by,
+ )
+ )
if contact_detail.phone:
is_primary_phone = 1 if phone_counter == 1 else 0
- phone_values.append((
- phone_counter,
- frappe.generate_hash(contact_detail.email_id, 10),
- contact_detail.phone,
- 'phone_nos',
- 'Contact',
- contact_detail.name,
- is_primary_phone,
- 0,
- contact_detail.creation,
- contact_detail.modified,
- contact_detail.modified_by
- ))
+ phone_values.append(
+ (
+ phone_counter,
+ frappe.generate_hash(contact_detail.email_id, 10),
+ contact_detail.phone,
+ "phone_nos",
+ "Contact",
+ contact_detail.name,
+ is_primary_phone,
+ 0,
+ contact_detail.creation,
+ contact_detail.modified,
+ contact_detail.modified_by,
+ )
+ )
phone_counter += 1
if contact_detail.mobile_no:
is_primary_mobile_no = 1 if phone_counter == 1 else 0
- phone_values.append((
- phone_counter,
- frappe.generate_hash(contact_detail.email_id, 10),
- contact_detail.mobile_no,
- 'phone_nos',
- 'Contact',
- contact_detail.name,
- 0,
- is_primary_mobile_no,
- contact_detail.creation,
- contact_detail.modified,
- contact_detail.modified_by
- ))
+ phone_values.append(
+ (
+ phone_counter,
+ frappe.generate_hash(contact_detail.email_id, 10),
+ contact_detail.mobile_no,
+ "phone_nos",
+ "Contact",
+ contact_detail.name,
+ 0,
+ is_primary_mobile_no,
+ contact_detail.creation,
+ contact_detail.modified,
+ contact_detail.modified_by,
+ )
+ )
- if email_values and (count%10000 == 0 or count == len(contact_details)-1):
- frappe.db.sql("""
+ if email_values and (count % 10000 == 0 or count == len(contact_details) - 1):
+ frappe.db.sql(
+ """
INSERT INTO `tabContact Email`
(`idx`, `name`, `email_id`, `parentfield`, `parenttype`, `parent`, `is_primary`, `creation`,
`modified`, `modified_by`)
VALUES {}
- """.format(", ".join(['%s'] * len(email_values))), tuple(email_values))
+ """.format(
+ ", ".join(["%s"] * len(email_values))
+ ),
+ tuple(email_values),
+ )
email_values = []
- if phone_values and (count%10000 == 0 or count == len(contact_details)-1):
- frappe.db.sql("""
+ if phone_values and (count % 10000 == 0 or count == len(contact_details) - 1):
+ frappe.db.sql(
+ """
INSERT INTO `tabContact Phone`
(`idx`, `name`, `phone`, `parentfield`, `parenttype`, `parent`, `is_primary_phone`, `is_primary_mobile_no`, `creation`,
`modified`, `modified_by`)
VALUES {}
- """.format(", ".join(['%s'] * len(phone_values))), tuple(phone_values))
+ """.format(
+ ", ".join(["%s"] * len(phone_values))
+ ),
+ tuple(phone_values),
+ )
phone_values = []
frappe.db.add_index("Contact Phone", ["phone"])
- frappe.db.add_index("Contact Email", ["email_id"])
\ No newline at end of file
+ frappe.db.add_index("Contact Email", ["email_id"])
diff --git a/frappe/patches/v12_0/move_form_attachments_to_attachments_folder.py b/frappe/patches/v12_0/move_form_attachments_to_attachments_folder.py
index c96741cc3b..47154c437a 100644
--- a/frappe/patches/v12_0/move_form_attachments_to_attachments_folder.py
+++ b/frappe/patches/v12_0/move_form_attachments_to_attachments_folder.py
@@ -1,9 +1,12 @@
import frappe
+
def execute():
- frappe.db.sql('''
+ frappe.db.sql(
+ """
UPDATE tabFile
SET folder = 'Home/Attachments'
WHERE ifnull(attached_to_doctype, '') != ''
AND folder = 'Home'
- ''')
+ """
+ )
diff --git a/frappe/patches/v12_0/move_timeline_links_to_dynamic_links.py b/frappe/patches/v12_0/move_timeline_links_to_dynamic_links.py
index 85be3f7feb..2207edd958 100644
--- a/frappe/patches/v12_0/move_timeline_links_to_dynamic_links.py
+++ b/frappe/patches/v12_0/move_timeline_links_to_dynamic_links.py
@@ -1,14 +1,18 @@
import frappe
+
def execute():
- communications = frappe.db.sql("""
+ communications = frappe.db.sql(
+ """
SELECT
`tabCommunication`.name, `tabCommunication`.creation, `tabCommunication`.modified,
`tabCommunication`.modified_by,`tabCommunication`.timeline_doctype, `tabCommunication`.timeline_name,
`tabCommunication`.link_doctype, `tabCommunication`.link_name
FROM `tabCommunication`
WHERE `tabCommunication`.communication_medium='Email'
- """, as_dict=True)
+ """,
+ as_dict=True,
+ )
name = 1000000000
values = []
@@ -17,25 +21,45 @@ def execute():
counter = 1
if communication.timeline_doctype and communication.timeline_name:
name += 1
- values.append("""({0}, "{1}", "timeline_links", "Communication", "{2}", "{3}", "{4}", "{5}", "{6}", "{7}")""".format(
- counter, str(name), frappe.db.escape(communication.name), frappe.db.escape(communication.timeline_doctype),
- frappe.db.escape(communication.timeline_name), communication.creation, communication.modified, communication.modified_by
- ))
+ values.append(
+ """({0}, "{1}", "timeline_links", "Communication", "{2}", "{3}", "{4}", "{5}", "{6}", "{7}")""".format(
+ counter,
+ str(name),
+ frappe.db.escape(communication.name),
+ frappe.db.escape(communication.timeline_doctype),
+ frappe.db.escape(communication.timeline_name),
+ communication.creation,
+ communication.modified,
+ communication.modified_by,
+ )
+ )
counter += 1
if communication.link_doctype and communication.link_name:
name += 1
- values.append("""({0}, "{1}", "timeline_links", "Communication", "{2}", "{3}", "{4}", "{5}", "{6}", "{7}")""".format(
- counter, str(name), frappe.db.escape(communication.name), frappe.db.escape(communication.link_doctype),
- frappe.db.escape(communication.link_name), communication.creation, communication.modified, communication.modified_by
- ))
+ values.append(
+ """({0}, "{1}", "timeline_links", "Communication", "{2}", "{3}", "{4}", "{5}", "{6}", "{7}")""".format(
+ counter,
+ str(name),
+ frappe.db.escape(communication.name),
+ frappe.db.escape(communication.link_doctype),
+ frappe.db.escape(communication.link_name),
+ communication.creation,
+ communication.modified,
+ communication.modified_by,
+ )
+ )
if values and (count % 10000 == 0 or count == len(communications) - 1):
- frappe.db.sql("""
+ frappe.db.sql(
+ """
INSERT INTO `tabCommunication Link`
(`idx`, `name`, `parentfield`, `parenttype`, `parent`, `link_doctype`, `link_name`, `creation`,
`modified`, `modified_by`)
VALUES {0}
- """.format(", ".join([d for d in values])))
+ """.format(
+ ", ".join([d for d in values])
+ )
+ )
values = []
diff --git a/frappe/patches/v12_0/remove_deprecated_fields_from_doctype.py b/frappe/patches/v12_0/remove_deprecated_fields_from_doctype.py
index 9c9a79ccbf..5727ab7b48 100644
--- a/frappe/patches/v12_0/remove_deprecated_fields_from_doctype.py
+++ b/frappe/patches/v12_0/remove_deprecated_fields_from_doctype.py
@@ -1,13 +1,12 @@
import frappe
+
def execute():
- frappe.reload_doc('core', 'doctype', 'doctype_link')
- frappe.reload_doc('core', 'doctype', 'doctype_action')
- frappe.reload_doc('core', 'doctype', 'doctype')
- frappe.model.delete_fields({
- 'DocType': ['hide_heading', 'image_view', 'read_only_onload']
- }, delete=1)
+ frappe.reload_doc("core", "doctype", "doctype_link")
+ frappe.reload_doc("core", "doctype", "doctype_action")
+ frappe.reload_doc("core", "doctype", "doctype")
+ frappe.model.delete_fields(
+ {"DocType": ["hide_heading", "image_view", "read_only_onload"]}, delete=1
+ )
- frappe.db.delete("Property Setter", {
- "property": "read_only_onload"
- })
\ No newline at end of file
+ frappe.db.delete("Property Setter", {"property": "read_only_onload"})
diff --git a/frappe/patches/v12_0/remove_example_email_thread_notify.py b/frappe/patches/v12_0/remove_example_email_thread_notify.py
index 94959b6077..4072065b8f 100644
--- a/frappe/patches/v12_0/remove_example_email_thread_notify.py
+++ b/frappe/patches/v12_0/remove_example_email_thread_notify.py
@@ -3,6 +3,8 @@ import frappe
def execute():
# remove all example.com email user accounts from notifications
- frappe.db.sql("""UPDATE `tabUser`
+ frappe.db.sql(
+ """UPDATE `tabUser`
SET thread_notify=0, send_me_a_copy=0
- WHERE email like '%@example.com'""")
+ WHERE email like '%@example.com'"""
+ )
diff --git a/frappe/patches/v12_0/remove_feedback_rating.py b/frappe/patches/v12_0/remove_feedback_rating.py
index 5184bb7b79..2d9c296efc 100644
--- a/frappe/patches/v12_0/remove_feedback_rating.py
+++ b/frappe/patches/v12_0/remove_feedback_rating.py
@@ -1,9 +1,10 @@
import frappe
+
def execute():
- '''
- Deprecate Feedback Trigger and Rating. This feature was not customizable.
- Now can be achieved via custom Web Forms
- '''
- frappe.delete_doc('DocType', 'Feedback Trigger')
- frappe.delete_doc('DocType', 'Feedback Rating')
+ """
+ Deprecate Feedback Trigger and Rating. This feature was not customizable.
+ Now can be achieved via custom Web Forms
+ """
+ frappe.delete_doc("DocType", "Feedback Trigger")
+ frappe.delete_doc("DocType", "Feedback Rating")
diff --git a/frappe/patches/v12_0/remove_gcalendar_gmaps.py b/frappe/patches/v12_0/remove_gcalendar_gmaps.py
index 84c400f6a8..1177441130 100644
--- a/frappe/patches/v12_0/remove_gcalendar_gmaps.py
+++ b/frappe/patches/v12_0/remove_gcalendar_gmaps.py
@@ -1,10 +1,11 @@
import frappe
+
def execute():
- '''
- Remove GCalendar and GCalendar Settings
- Remove Google Maps Settings as its been merged with Delivery Trips
- '''
- frappe.delete_doc_if_exists('DocType', 'GCalendar Account')
- frappe.delete_doc_if_exists('DocType', 'GCalendar Settings')
- frappe.delete_doc_if_exists('DocType', 'Google Maps Settings')
+ """
+ Remove GCalendar and GCalendar Settings
+ Remove Google Maps Settings as its been merged with Delivery Trips
+ """
+ frappe.delete_doc_if_exists("DocType", "GCalendar Account")
+ frappe.delete_doc_if_exists("DocType", "GCalendar Settings")
+ frappe.delete_doc_if_exists("DocType", "Google Maps Settings")
diff --git a/frappe/patches/v12_0/rename_events_repeat_on.py b/frappe/patches/v12_0/rename_events_repeat_on.py
index b0dface644..5276689a2a 100644
--- a/frappe/patches/v12_0/rename_events_repeat_on.py
+++ b/frappe/patches/v12_0/rename_events_repeat_on.py
@@ -1,18 +1,37 @@
import frappe
from frappe.utils import get_datetime
+
def execute():
weekdays = ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
- weekly_events = frappe.get_list("Event", filters={"repeat_this_event": 1, "repeat_on": "Every Week"}, fields=["name", "starts_on"])
+ weekly_events = frappe.get_list(
+ "Event",
+ filters={"repeat_this_event": 1, "repeat_on": "Every Week"},
+ fields=["name", "starts_on"],
+ )
frappe.reload_doc("desk", "doctype", "event")
# Initially Daily Events had option to choose days, but now Weekly does, so just changing from Daily -> Weekly does the job
- frappe.db.sql("""UPDATE `tabEvent` SET `tabEvent`.repeat_on='Weekly' WHERE `tabEvent`.repeat_on='Every Day'""")
- frappe.db.sql("""UPDATE `tabEvent` SET `tabEvent`.repeat_on='Weekly' WHERE `tabEvent`.repeat_on='Every Week'""")
- frappe.db.sql("""UPDATE `tabEvent` SET `tabEvent`.repeat_on='Monthly' WHERE `tabEvent`.repeat_on='Every Month'""")
- frappe.db.sql("""UPDATE `tabEvent` SET `tabEvent`.repeat_on='Yearly' WHERE `tabEvent`.repeat_on='Every Year'""")
+ frappe.db.sql(
+ """UPDATE `tabEvent` SET `tabEvent`.repeat_on='Weekly' WHERE `tabEvent`.repeat_on='Every Day'"""
+ )
+ frappe.db.sql(
+ """UPDATE `tabEvent` SET `tabEvent`.repeat_on='Weekly' WHERE `tabEvent`.repeat_on='Every Week'"""
+ )
+ frappe.db.sql(
+ """UPDATE `tabEvent` SET `tabEvent`.repeat_on='Monthly' WHERE `tabEvent`.repeat_on='Every Month'"""
+ )
+ frappe.db.sql(
+ """UPDATE `tabEvent` SET `tabEvent`.repeat_on='Yearly' WHERE `tabEvent`.repeat_on='Every Year'"""
+ )
for weekly_event in weekly_events:
# Set WeekDay based on the starts_on so that event can repeat Weekly
- frappe.db.set_value('Event', weekly_event.name, weekdays[get_datetime(weekly_event.starts_on).weekday()], 1, update_modified=False)
+ frappe.db.set_value(
+ "Event",
+ weekly_event.name,
+ weekdays[get_datetime(weekly_event.starts_on).weekday()],
+ 1,
+ update_modified=False,
+ )
diff --git a/frappe/patches/v12_0/rename_uploaded_files_with_proper_name.py b/frappe/patches/v12_0/rename_uploaded_files_with_proper_name.py
index 854a381e1c..5907040b6a 100644
--- a/frappe/patches/v12_0/rename_uploaded_files_with_proper_name.py
+++ b/frappe/patches/v12_0/rename_uploaded_files_with_proper_name.py
@@ -1,14 +1,17 @@
-import frappe
import os
+import frappe
+
+
def execute():
- file_names_with_url = frappe.get_all("File", filters={
- "is_folder": 0,
- "file_name": ["like", "%/%"]
- }, fields=['name', 'file_name', 'file_url'])
+ file_names_with_url = frappe.get_all(
+ "File",
+ filters={"is_folder": 0, "file_name": ["like", "%/%"]},
+ fields=["name", "file_name", "file_url"],
+ )
for f in file_names_with_url:
- filename = f.file_name.rsplit('/', 1)[-1]
+ filename = f.file_name.rsplit("/", 1)[-1]
if not f.file_url:
f.file_url = f.file_name
@@ -16,16 +19,15 @@ def execute():
try:
if not file_exists(f.file_url):
continue
- frappe.db.set_value('File', f.name, {
- "file_name": filename,
- "file_url": f.file_url
- }, update_modified=False)
+ frappe.db.set_value(
+ "File", f.name, {"file_name": filename, "file_url": f.file_url}, update_modified=False
+ )
except Exception:
continue
+
def file_exists(file_path):
file_path = frappe.utils.get_files_path(
- file_path.rsplit('/', 1)[-1],
- is_private=file_path.startswith('/private')
+ file_path.rsplit("/", 1)[-1], is_private=file_path.startswith("/private")
)
return os.path.exists(file_path)
diff --git a/frappe/patches/v12_0/replace_null_values_in_tables.py b/frappe/patches/v12_0/replace_null_values_in_tables.py
index 023a255a6d..1dc8d964a1 100644
--- a/frappe/patches/v12_0/replace_null_values_in_tables.py
+++ b/frappe/patches/v12_0/replace_null_values_in_tables.py
@@ -1,21 +1,30 @@
-import frappe
import re
+import frappe
+
+
def execute():
- fields = frappe.db.sql("""
+ fields = frappe.db.sql(
+ """
SELECT COLUMN_NAME , TABLE_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS
WHERE DATA_TYPE IN ('INT', 'FLOAT', 'DECIMAL') AND IS_NULLABLE = 'YES'
- """, as_dict=1)
+ """,
+ as_dict=1,
+ )
update_column_table_map = {}
for field in fields:
update_column_table_map.setdefault(field.TABLE_NAME, [])
- update_column_table_map[field.TABLE_NAME].append("`{fieldname}`=COALESCE(`{fieldname}`, 0)".format(fieldname=field.COLUMN_NAME))
+ update_column_table_map[field.TABLE_NAME].append(
+ "`{fieldname}`=COALESCE(`{fieldname}`, 0)".format(fieldname=field.COLUMN_NAME)
+ )
for table in frappe.db.get_tables():
- if update_column_table_map.get(table) and frappe.db.exists("DocType", re.sub('^tab', '', table)):
- frappe.db.sql("""UPDATE `{table}` SET {columns}"""
- .format(table=table, columns=", ".join(update_column_table_map.get(table))))
-
+ if update_column_table_map.get(table) and frappe.db.exists("DocType", re.sub("^tab", "", table)):
+ frappe.db.sql(
+ """UPDATE `{table}` SET {columns}""".format(
+ table=table, columns=", ".join(update_column_table_map.get(table))
+ )
+ )
diff --git a/frappe/patches/v12_0/reset_home_settings.py b/frappe/patches/v12_0/reset_home_settings.py
index e4b9de6cb2..c498b8b14b 100644
--- a/frappe/patches/v12_0/reset_home_settings.py
+++ b/frappe/patches/v12_0/reset_home_settings.py
@@ -1,9 +1,12 @@
import frappe
+
def execute():
- frappe.reload_doc('core', 'doctype', 'user')
- frappe.db.sql('''
+ frappe.reload_doc("core", "doctype", "user")
+ frappe.db.sql(
+ """
UPDATE `tabUser`
SET `home_settings` = ''
WHERE `user_type` = 'System User'
- ''')
+ """
+ )
diff --git a/frappe/patches/v12_0/set_correct_assign_value_in_docs.py b/frappe/patches/v12_0/set_correct_assign_value_in_docs.py
index 5aaadd00e8..d06cc04969 100644
--- a/frappe/patches/v12_0/set_correct_assign_value_in_docs.py
+++ b/frappe/patches/v12_0/set_correct_assign_value_in_docs.py
@@ -1,5 +1,6 @@
import frappe
-from frappe.query_builder.functions import GroupConcat, Coalesce
+from frappe.query_builder.functions import Coalesce, GroupConcat
+
def execute():
frappe.reload_doc("desk", "doctype", "todo")
@@ -23,5 +24,5 @@ def execute():
doc.reference_name,
"_assign",
frappe.as_json(assignments),
- update_modified=False
- )
\ No newline at end of file
+ update_modified=False,
+ )
diff --git a/frappe/patches/v12_0/set_correct_url_in_files.py b/frappe/patches/v12_0/set_correct_url_in_files.py
index 4613f88694..dca42a3c04 100644
--- a/frappe/patches/v12_0/set_correct_url_in_files.py
+++ b/frappe/patches/v12_0/set_correct_url_in_files.py
@@ -1,39 +1,41 @@
-import frappe
import os
+import frappe
+
+
def execute():
- files = frappe.get_all('File',
- fields = ['name', 'file_name', 'file_url'],
- filters = {
- 'is_folder': 0,
- 'file_url': ['!=', ''],
- })
+ files = frappe.get_all(
+ "File",
+ fields=["name", "file_name", "file_url"],
+ filters={
+ "is_folder": 0,
+ "file_url": ["!=", ""],
+ },
+ )
- private_file_path = frappe.get_site_path('private', 'files')
- public_file_path = frappe.get_site_path('public', 'files')
+ private_file_path = frappe.get_site_path("private", "files")
+ public_file_path = frappe.get_site_path("public", "files")
for file in files:
file_path = file.file_url
- file_name = file_path.split('/')[-1]
+ file_name = file_path.split("/")[-1]
- if not file_path.startswith(('/private/', '/files/')):
+ if not file_path.startswith(("/private/", "/files/")):
continue
- file_is_private = file_path.startswith('/private/files/')
+ file_is_private = file_path.startswith("/private/files/")
full_path = frappe.utils.get_files_path(file_name, is_private=file_is_private)
if not os.path.exists(full_path):
if file_is_private:
public_file_url = os.path.join(public_file_path, file_name)
if os.path.exists(public_file_url):
- frappe.db.set_value('File', file.name, {
- 'file_url': '/files/{0}'.format(file_name),
- 'is_private': 0
- })
+ frappe.db.set_value(
+ "File", file.name, {"file_url": "/files/{0}".format(file_name), "is_private": 0}
+ )
else:
private_file_url = os.path.join(private_file_path, file_name)
if os.path.exists(private_file_url):
- frappe.db.set_value('File', file.name, {
- 'file_url': '/private/files/{0}'.format(file_name),
- 'is_private': 1
- })
+ frappe.db.set_value(
+ "File", file.name, {"file_url": "/private/files/{0}".format(file_name), "is_private": 1}
+ )
diff --git a/frappe/patches/v12_0/set_default_incoming_email_port.py b/frappe/patches/v12_0/set_default_incoming_email_port.py
index eb225c683d..822ce06f70 100644
--- a/frappe/patches/v12_0/set_default_incoming_email_port.py
+++ b/frappe/patches/v12_0/set_default_incoming_email_port.py
@@ -1,11 +1,12 @@
import frappe
from frappe.email.utils import get_port
+
def execute():
- '''
- 1. Set default incoming email port in email domain
- 2. Set default incoming email port in all email account (for those account where domain is missing)
- '''
+ """
+ 1. Set default incoming email port in email domain
+ 2. Set default incoming email port in all email account (for those account where domain is missing)
+ """
frappe.reload_doc("email", "doctype", "email_domain", force=True)
frappe.reload_doc("email", "doctype", "email_account", force=True)
@@ -14,19 +15,31 @@ def execute():
def setup_incoming_email_port_in_email_domains():
- email_domains = frappe.db.get_all("Email Domain", ['incoming_port', 'use_imap', 'use_ssl', 'name'])
+ email_domains = frappe.db.get_all(
+ "Email Domain", ["incoming_port", "use_imap", "use_ssl", "name"]
+ )
for domain in email_domains:
if not domain.incoming_port:
incoming_port = get_port(domain)
- frappe.db.set_value("Email Domain", domain.name, 'incoming_port', incoming_port, update_modified=False)
+ frappe.db.set_value(
+ "Email Domain", domain.name, "incoming_port", incoming_port, update_modified=False
+ )
+
+ # update incoming email port in all
+ frappe.db.sql(
+ """update `tabEmail Account` set incoming_port=%s where domain = %s""",
+ (domain.incoming_port, domain.name),
+ )
- #update incoming email port in all
- frappe.db.sql('''update `tabEmail Account` set incoming_port=%s where domain = %s''', (domain.incoming_port, domain.name))
def setup_incoming_email_port_in_email_accounts():
- email_accounts = frappe.db.get_all("Email Account", ['incoming_port', 'use_imap', 'use_ssl', 'name', 'enable_incoming'])
+ email_accounts = frappe.db.get_all(
+ "Email Account", ["incoming_port", "use_imap", "use_ssl", "name", "enable_incoming"]
+ )
for account in email_accounts:
if account.enable_incoming and not account.incoming_port:
incoming_port = get_port(account)
- frappe.db.set_value("Email Account", account.name, 'incoming_port', incoming_port, update_modified=False)
+ frappe.db.set_value(
+ "Email Account", account.name, "incoming_port", incoming_port, update_modified=False
+ )
diff --git a/frappe/patches/v12_0/set_default_password_reset_limit.py b/frappe/patches/v12_0/set_default_password_reset_limit.py
index e403b5251e..9e29e75c36 100644
--- a/frappe/patches/v12_0/set_default_password_reset_limit.py
+++ b/frappe/patches/v12_0/set_default_password_reset_limit.py
@@ -6,4 +6,4 @@ import frappe
def execute():
frappe.reload_doc("core", "doctype", "system_settings", force=1)
- frappe.db.set_value('System Settings', None, "password_reset_limit", 3)
+ frappe.db.set_value("System Settings", None, "password_reset_limit", 3)
diff --git a/frappe/patches/v12_0/set_primary_key_in_series.py b/frappe/patches/v12_0/set_primary_key_in_series.py
index 83a903fc2d..488c0da618 100644
--- a/frappe/patches/v12_0/set_primary_key_in_series.py
+++ b/frappe/patches/v12_0/set_primary_key_in_series.py
@@ -1,24 +1,26 @@
import frappe
+
def execute():
- #if current = 0, simply delete the key as it'll be recreated on first entry
+ # if current = 0, simply delete the key as it'll be recreated on first entry
frappe.db.delete("Series", {"current": 0})
- duplicate_keys = frappe.db.sql('''
+ duplicate_keys = frappe.db.sql(
+ """
SELECT name, max(current) as current
from
`tabSeries`
group by
name
having count(name) > 1
- ''', as_dict=True)
+ """,
+ as_dict=True,
+ )
for row in duplicate_keys:
- frappe.db.delete("Series", {
- "name": row.name
- })
+ frappe.db.delete("Series", {"name": row.name})
if row.current:
- frappe.db.sql('insert into `tabSeries`(`name`, `current`) values (%(name)s, %(current)s)', row)
+ frappe.db.sql("insert into `tabSeries`(`name`, `current`) values (%(name)s, %(current)s)", row)
frappe.db.commit()
- frappe.db.sql('ALTER table `tabSeries` ADD PRIMARY KEY IF NOT EXISTS (name)')
+ frappe.db.sql("ALTER table `tabSeries` ADD PRIMARY KEY IF NOT EXISTS (name)")
diff --git a/frappe/patches/v12_0/setup_comments_from_communications.py b/frappe/patches/v12_0/setup_comments_from_communications.py
index 11e02965f1..ad168f7c22 100644
--- a/frappe/patches/v12_0/setup_comments_from_communications.py
+++ b/frappe/patches/v12_0/setup_comments_from_communications.py
@@ -1,15 +1,17 @@
import frappe
+
def execute():
frappe.reload_doctype("Comment")
- if frappe.db.count('Communication', filters = dict(communication_type = 'Comment')) > 20000:
+ if frappe.db.count("Communication", filters=dict(communication_type="Comment")) > 20000:
frappe.db.auto_commit_on_many_writes = True
- for comment in frappe.get_all('Communication', fields = ['*'],
- filters = dict(communication_type = 'Comment')):
+ for comment in frappe.get_all(
+ "Communication", fields=["*"], filters=dict(communication_type="Comment")
+ ):
- new_comment = frappe.new_doc('Comment')
+ new_comment = frappe.new_doc("Comment")
new_comment.comment_type = comment.comment_type
new_comment.comment_email = comment.sender
new_comment.comment_by = comment.sender_full_name
@@ -29,6 +31,4 @@ def execute():
frappe.db.auto_commit_on_many_writes = False
# clean up
- frappe.db.delete("Communication", {
- "communication_type": "Comment"
- })
+ frappe.db.delete("Communication", {"communication_type": "Comment"})
diff --git a/frappe/patches/v12_0/setup_email_linking.py b/frappe/patches/v12_0/setup_email_linking.py
index 9e939e1245..56166f89dc 100644
--- a/frappe/patches/v12_0/setup_email_linking.py
+++ b/frappe/patches/v12_0/setup_email_linking.py
@@ -1,4 +1,5 @@
from frappe.desk.page.setup_wizard.install_fixtures import setup_email_linking
+
def execute():
- setup_email_linking()
\ No newline at end of file
+ setup_email_linking()
diff --git a/frappe/patches/v12_0/setup_tags.py b/frappe/patches/v12_0/setup_tags.py
index d663cb2e0e..46482a102b 100644
--- a/frappe/patches/v12_0/setup_tags.py
+++ b/frappe/patches/v12_0/setup_tags.py
@@ -1,5 +1,6 @@
import frappe
+
def execute():
frappe.delete_doc_if_exists("DocType", "Tag Category")
frappe.delete_doc_if_exists("DocType", "Tag Doc Category")
@@ -15,7 +16,9 @@ def execute():
if not frappe.db.count(doctype.name) or not frappe.db.has_column(doctype.name, "_user_tags"):
continue
- for _user_tags in frappe.db.sql("select `name`, `_user_tags` from `tab{0}`".format(doctype.name), as_dict=True):
+ for _user_tags in frappe.db.sql(
+ "select `name`, `_user_tags` from `tab{0}`".format(doctype.name), as_dict=True
+ ):
if not _user_tags.get("_user_tags"):
continue
@@ -23,11 +26,22 @@ def execute():
if not tag:
continue
- tag_list.append((tag.strip(), time, time, 'Administrator'))
+ tag_list.append((tag.strip(), time, time, "Administrator"))
tag_link_name = frappe.generate_hash(_user_tags.name + tag.strip() + doctype.name, 10)
- tag_links.append((tag_link_name, doctype.name, _user_tags.name, tag.strip(), time, time, 'Administrator'))
-
-
- frappe.db.bulk_insert("Tag", fields=["name", "creation", "modified", "modified_by"], values=set(tag_list), ignore_duplicates=True)
- frappe.db.bulk_insert("Tag Link", fields=["name", "document_type", "document_name", "tag", "creation", "modified", "modified_by"], values=set(tag_links), ignore_duplicates=True)
+ tag_links.append(
+ (tag_link_name, doctype.name, _user_tags.name, tag.strip(), time, time, "Administrator")
+ )
+
+ frappe.db.bulk_insert(
+ "Tag",
+ fields=["name", "creation", "modified", "modified_by"],
+ values=set(tag_list),
+ ignore_duplicates=True,
+ )
+ frappe.db.bulk_insert(
+ "Tag Link",
+ fields=["name", "document_type", "document_name", "tag", "creation", "modified", "modified_by"],
+ values=set(tag_links),
+ ignore_duplicates=True,
+ )
diff --git a/frappe/patches/v12_0/update_auto_repeat_status_and_not_submittable.py b/frappe/patches/v12_0/update_auto_repeat_status_and_not_submittable.py
index 3a3dcec315..55208ee8eb 100644
--- a/frappe/patches/v12_0/update_auto_repeat_status_and_not_submittable.py
+++ b/frappe/patches/v12_0/update_auto_repeat_status_and_not_submittable.py
@@ -1,9 +1,9 @@
-
import frappe
from frappe.custom.doctype.custom_field.custom_field import create_custom_field
+
def execute():
- #auto repeat is not submittable in v12
+ # auto repeat is not submittable in v12
frappe.reload_doc("automation", "doctype", "Auto Repeat")
frappe.db.sql("update `tabDocPerm` set submit=0, cancel=0, amend=0 where parent='Auto Repeat'")
frappe.db.sql("update `tabAuto Repeat` set docstatus=0 where docstatus=1 or docstatus=2")
@@ -11,16 +11,24 @@ def execute():
for entry in frappe.get_all("Auto Repeat"):
doc = frappe.get_doc("Auto Repeat", entry.name)
- #create custom field for allow auto repeat
+ # create custom field for allow auto repeat
fields = frappe.get_meta(doc.reference_doctype).fields
insert_after = fields[len(fields) - 1].fieldname
- df = dict(fieldname="auto_repeat", label="Auto Repeat", fieldtype="Link", insert_after=insert_after,
- options="Auto Repeat", hidden=1, print_hide=1, read_only=1)
+ df = dict(
+ fieldname="auto_repeat",
+ label="Auto Repeat",
+ fieldtype="Link",
+ insert_after=insert_after,
+ options="Auto Repeat",
+ hidden=1,
+ print_hide=1,
+ read_only=1,
+ )
create_custom_field(doc.reference_doctype, df)
if doc.status in ["Draft", "Stopped", "Cancelled"]:
doc.disabled = 1
doc.flags.ignore_links = 1
- #updates current status as Active, Disabled or Completed on validate
- doc.save()
\ No newline at end of file
+ # updates current status as Active, Disabled or Completed on validate
+ doc.save()
diff --git a/frappe/patches/v12_0/update_global_search.py b/frappe/patches/v12_0/update_global_search.py
index 8042a2ee68..2f07322ab9 100644
--- a/frappe/patches/v12_0/update_global_search.py
+++ b/frappe/patches/v12_0/update_global_search.py
@@ -1,7 +1,8 @@
import frappe
from frappe.desk.page.setup_wizard.install_fixtures import update_global_search_doctypes
+
def execute():
frappe.reload_doc("desk", "doctype", "global_search_doctype")
frappe.reload_doc("desk", "doctype", "global_search_settings")
- update_global_search_doctypes()
\ No newline at end of file
+ update_global_search_doctypes()
diff --git a/frappe/patches/v12_0/update_print_format_type.py b/frappe/patches/v12_0/update_print_format_type.py
index 577dc68d94..f85d32ee9a 100644
--- a/frappe/patches/v12_0/update_print_format_type.py
+++ b/frappe/patches/v12_0/update_print_format_type.py
@@ -1,13 +1,18 @@
import frappe
+
def execute():
- frappe.db.sql('''
+ frappe.db.sql(
+ """
UPDATE `tabPrint Format`
SET `print_format_type` = 'Jinja'
WHERE `print_format_type` in ('Server', 'Client')
- ''')
- frappe.db.sql('''
+ """
+ )
+ frappe.db.sql(
+ """
UPDATE `tabPrint Format`
SET `print_format_type` = 'JS'
WHERE `print_format_type` = 'Js'
- ''')
+ """
+ )
diff --git a/frappe/patches/v12_0/webpage_migrate_description_to_meta_tag.py b/frappe/patches/v12_0/webpage_migrate_description_to_meta_tag.py
index cb960e84bb..32473481b8 100644
--- a/frappe/patches/v12_0/webpage_migrate_description_to_meta_tag.py
+++ b/frappe/patches/v12_0/webpage_migrate_description_to_meta_tag.py
@@ -1,14 +1,12 @@
import frappe
+
def execute():
- web_pages = frappe.get_all('Web Page', ['name', 'description'])
+ web_pages = frappe.get_all("Web Page", ["name", "description"])
for web_page in web_pages:
if web_page.description and web_page.route:
- doc = frappe.new_doc('Website Route Meta')
+ doc = frappe.new_doc("Website Route Meta")
doc.name = web_page.route
- doc.append('meta_tags', {
- 'key': 'description',
- 'value': web_page.description
- })
+ doc.append("meta_tags", {"key": "description", "value": web_page.description})
doc.save()
diff --git a/frappe/patches/v12_0/website_meta_tag_parent.py b/frappe/patches/v12_0/website_meta_tag_parent.py
index 7cc84b1283..8920189826 100644
--- a/frappe/patches/v12_0/website_meta_tag_parent.py
+++ b/frappe/patches/v12_0/website_meta_tag_parent.py
@@ -1,9 +1,12 @@
import frappe
+
def execute():
# convert all /path to path
- frappe.db.sql('''
+ frappe.db.sql(
+ """
UPDATE `tabWebsite Meta Tag`
SET parent = SUBSTR(parent, 2)
WHERE parent like '/%'
- ''')
+ """
+ )
diff --git a/frappe/patches/v13_0/add_standard_navbar_items.py b/frappe/patches/v13_0/add_standard_navbar_items.py
index 4473cb8c07..b06494c53a 100644
--- a/frappe/patches/v13_0/add_standard_navbar_items.py
+++ b/frappe/patches/v13_0/add_standard_navbar_items.py
@@ -1,9 +1,9 @@
-
import frappe
from frappe.utils.install import add_standard_navbar_items
+
def execute():
# Add standard navbar items for ERPNext in Navbar Settings
- frappe.reload_doc('core', 'doctype', 'navbar_settings')
- frappe.reload_doc('core', 'doctype', 'navbar_item')
- add_standard_navbar_items()
\ No newline at end of file
+ frappe.reload_doc("core", "doctype", "navbar_settings")
+ frappe.reload_doc("core", "doctype", "navbar_item")
+ add_standard_navbar_items()
diff --git a/frappe/patches/v13_0/add_switch_theme_to_navbar_settings.py b/frappe/patches/v13_0/add_switch_theme_to_navbar_settings.py
index b5542c9c8a..00f5aa23d2 100644
--- a/frappe/patches/v13_0/add_switch_theme_to_navbar_settings.py
+++ b/frappe/patches/v13_0/add_switch_theme_to_navbar_settings.py
@@ -1,21 +1,24 @@
-
import frappe
+
def execute():
navbar_settings = frappe.get_single("Navbar Settings")
- if frappe.db.exists('Navbar Item', {'item_label': 'Toggle Theme'}):
+ if frappe.db.exists("Navbar Item", {"item_label": "Toggle Theme"}):
return
for navbar_item in navbar_settings.settings_dropdown[6:]:
navbar_item.idx = navbar_item.idx + 1
- navbar_settings.append('settings_dropdown', {
- 'item_label': 'Toggle Theme',
- 'item_type': 'Action',
- 'action': 'new frappe.ui.ThemeSwitcher().show()',
- 'is_standard': 1,
- 'idx': 7
- })
+ navbar_settings.append(
+ "settings_dropdown",
+ {
+ "item_label": "Toggle Theme",
+ "item_type": "Action",
+ "action": "new frappe.ui.ThemeSwitcher().show()",
+ "is_standard": 1,
+ "idx": 7,
+ },
+ )
- navbar_settings.save()
\ No newline at end of file
+ navbar_settings.save()
diff --git a/frappe/patches/v13_0/add_toggle_width_in_navbar_settings.py b/frappe/patches/v13_0/add_toggle_width_in_navbar_settings.py
index bd3367377c..f59786dfdf 100644
--- a/frappe/patches/v13_0/add_toggle_width_in_navbar_settings.py
+++ b/frappe/patches/v13_0/add_toggle_width_in_navbar_settings.py
@@ -1,21 +1,24 @@
-
import frappe
+
def execute():
navbar_settings = frappe.get_single("Navbar Settings")
- if frappe.db.exists('Navbar Item', {'item_label': 'Toggle Full Width'}):
+ if frappe.db.exists("Navbar Item", {"item_label": "Toggle Full Width"}):
return
for navbar_item in navbar_settings.settings_dropdown[5:]:
navbar_item.idx = navbar_item.idx + 1
- navbar_settings.append('settings_dropdown', {
- 'item_label': 'Toggle Full Width',
- 'item_type': 'Action',
- 'action': 'frappe.ui.toolbar.toggle_full_width()',
- 'is_standard': 1,
- 'idx': 6
- })
+ navbar_settings.append(
+ "settings_dropdown",
+ {
+ "item_label": "Toggle Full Width",
+ "item_type": "Action",
+ "action": "frappe.ui.toolbar.toggle_full_width()",
+ "is_standard": 1,
+ "idx": 6,
+ },
+ )
- navbar_settings.save()
\ No newline at end of file
+ navbar_settings.save()
diff --git a/frappe/patches/v13_0/cleanup_desk_cards.py b/frappe/patches/v13_0/cleanup_desk_cards.py
index b6fab66475..988e98a647 100644
--- a/frappe/patches/v13_0/cleanup_desk_cards.py
+++ b/frappe/patches/v13_0/cleanup_desk_cards.py
@@ -1,9 +1,11 @@
-import frappe
from json import loads
+
+import frappe
from frappe.desk.doctype.workspace.workspace import get_link_type, get_report_type
+
def execute():
- frappe.reload_doc('desk', 'doctype', 'workspace')
+ frappe.reload_doc("desk", "doctype", "workspace")
pages = frappe.db.sql("Select `name` from `tabDesk Page`")
# pages = frappe.get_all("Workspace", filters={"is_standard": 0}, pluck="name")
@@ -13,6 +15,7 @@ def execute():
frappe.delete_doc("DocType", "Desk Card")
+
def rebuild_links(page):
# Empty links table
@@ -32,36 +35,41 @@ def rebuild_links(page):
else:
links = card.links
- doc.append('links', {
- "label": card.label,
- "type": "Card Break",
- "icon": card.icon,
- "hidden": card.hidden or False
- })
+ doc.append(
+ "links",
+ {"label": card.label, "type": "Card Break", "icon": card.icon, "hidden": card.hidden or False},
+ )
for link in links:
- if not frappe.db.exists(get_link_type(link.get('type')), link.get('name')):
+ if not frappe.db.exists(get_link_type(link.get("type")), link.get("name")):
continue
- doc.append('links', {
- "label": link.get('label') or link.get('name'),
- "type": "Link",
- "link_type": get_link_type(link.get('type')),
- "link_to": link.get('name'),
- "onboard": link.get('onboard'),
- "dependencies": ', '.join(link.get('dependencies', [])),
- "is_query_report": get_report_type(link.get('name')) if link.get('type').lower() == "report" else 0
- })
+ doc.append(
+ "links",
+ {
+ "label": link.get("label") or link.get("name"),
+ "type": "Link",
+ "link_type": get_link_type(link.get("type")),
+ "link_to": link.get("name"),
+ "onboard": link.get("onboard"),
+ "dependencies": ", ".join(link.get("dependencies", [])),
+ "is_query_report": get_report_type(link.get("name"))
+ if link.get("type").lower() == "report"
+ else 0,
+ },
+ )
try:
doc.save(ignore_permissions=True)
except frappe.LinkValidationError:
print(doc.as_dict())
+
def get_doc_from_db(page):
- result = frappe.db.sql("SELECT * FROM `tabDesk Page` WHERE name=%s", [page], as_dict=True)
+ result = frappe.db.sql("SELECT * FROM `tabDesk Page` WHERE name=%s", [page], as_dict=True)
if result:
return result[0].update({"doctype": "Workspace"})
+
def get_all_cards(page):
- return frappe.db.get_all("Desk Card", filters={"parent": page}, fields=['*'], order_by="idx")
\ No newline at end of file
+ return frappe.db.get_all("Desk Card", filters={"parent": page}, fields=["*"], order_by="idx")
diff --git a/frappe/patches/v13_0/create_custom_dashboards_cards_and_charts.py b/frappe/patches/v13_0/create_custom_dashboards_cards_and_charts.py
index 9a075a22cc..4ac6b918b5 100644
--- a/frappe/patches/v13_0/create_custom_dashboards_cards_and_charts.py
+++ b/frappe/patches/v13_0/create_custom_dashboards_cards_and_charts.py
@@ -2,42 +2,45 @@ import frappe
from frappe.model.naming import append_number_if_name_exists
from frappe.utils.dashboard import get_dashboards_with_link
+
def execute():
- if not frappe.db.table_exists('Dashboard Chart')\
- or not frappe.db.table_exists('Number Card')\
- or not frappe.db.table_exists('Dashboard'):
+ if (
+ not frappe.db.table_exists("Dashboard Chart")
+ or not frappe.db.table_exists("Number Card")
+ or not frappe.db.table_exists("Dashboard")
+ ):
return
- frappe.reload_doc('desk', 'doctype', 'dashboard_chart')
- frappe.reload_doc('desk', 'doctype', 'number_card')
- frappe.reload_doc('desk', 'doctype', 'dashboard')
+ frappe.reload_doc("desk", "doctype", "dashboard_chart")
+ frappe.reload_doc("desk", "doctype", "number_card")
+ frappe.reload_doc("desk", "doctype", "dashboard")
- modified_charts = get_modified_docs('Dashboard Chart')
- modified_cards = get_modified_docs('Number Card')
- modified_dashboards = [doc.name for doc in get_modified_docs('Dashboard')]
+ modified_charts = get_modified_docs("Dashboard Chart")
+ modified_cards = get_modified_docs("Number Card")
+ modified_dashboards = [doc.name for doc in get_modified_docs("Dashboard")]
for chart in modified_charts:
- modified_dashboards += get_dashboards_with_link(chart.name, 'Dashboard Chart')
- rename_modified_doc(chart.name, 'Dashboard Chart')
+ modified_dashboards += get_dashboards_with_link(chart.name, "Dashboard Chart")
+ rename_modified_doc(chart.name, "Dashboard Chart")
for card in modified_cards:
- modified_dashboards += get_dashboards_with_link(card.name, 'Number Card')
- rename_modified_doc(card.name, 'Number Card')
+ modified_dashboards += get_dashboards_with_link(card.name, "Number Card")
+ rename_modified_doc(card.name, "Number Card")
modified_dashboards = list(set(modified_dashboards))
for dashboard in modified_dashboards:
- rename_modified_doc(dashboard, 'Dashboard')
+ rename_modified_doc(dashboard, "Dashboard")
+
def get_modified_docs(doctype):
- return frappe.get_all(doctype,
- filters = {
- 'owner': 'Administrator',
- 'modified_by': ['!=', 'Administrator']
- })
+ return frappe.get_all(
+ doctype, filters={"owner": "Administrator", "modified_by": ["!=", "Administrator"]}
+ )
+
def rename_modified_doc(docname, doctype):
- new_name = docname + ' Custom'
+ new_name = docname + " Custom"
try:
frappe.rename_doc(doctype, docname, new_name)
except frappe.ValidationError:
diff --git a/frappe/patches/v13_0/delete_event_producer_and_consumer_keys.py b/frappe/patches/v13_0/delete_event_producer_and_consumer_keys.py
index 2d9e232da5..9cb081e15a 100644
--- a/frappe/patches/v13_0/delete_event_producer_and_consumer_keys.py
+++ b/frappe/patches/v13_0/delete_event_producer_and_consumer_keys.py
@@ -3,6 +3,7 @@
import frappe
+
def execute():
if frappe.db.exists("DocType", "Event Producer"):
frappe.db.sql("""UPDATE `tabEvent Producer` SET api_key='', api_secret=''""")
diff --git a/frappe/patches/v13_0/email_unsubscribe.py b/frappe/patches/v13_0/email_unsubscribe.py
index 69ed1be948..d5fe2ae32e 100644
--- a/frappe/patches/v13_0/email_unsubscribe.py
+++ b/frappe/patches/v13_0/email_unsubscribe.py
@@ -1,13 +1,14 @@
import frappe
+
def execute():
email_unsubscribe = [
{"email": "admin@example.com", "global_unsubscribe": 1},
- {"email": "guest@example.com", "global_unsubscribe": 1}
+ {"email": "guest@example.com", "global_unsubscribe": 1},
]
for unsubscribe in email_unsubscribe:
if not frappe.get_all("Email Unsubscribe", filters=unsubscribe):
doc = frappe.new_doc("Email Unsubscribe")
doc.update(unsubscribe)
- doc.insert(ignore_permissions=True)
\ No newline at end of file
+ doc.insert(ignore_permissions=True)
diff --git a/frappe/patches/v13_0/enable_custom_script.py b/frappe/patches/v13_0/enable_custom_script.py
index de027ab97a..9ff9732a4e 100644
--- a/frappe/patches/v13_0/enable_custom_script.py
+++ b/frappe/patches/v13_0/enable_custom_script.py
@@ -3,9 +3,12 @@
import frappe
+
def execute():
"""Enable all the existing Client script"""
- frappe.db.sql("""
+ frappe.db.sql(
+ """
UPDATE `tabClient Script` SET enabled=1
- """)
\ No newline at end of file
+ """
+ )
diff --git a/frappe/patches/v13_0/generate_theme_files_in_public_folder.py b/frappe/patches/v13_0/generate_theme_files_in_public_folder.py
index 6e8e0d7fc5..9b905a9bbb 100644
--- a/frappe/patches/v13_0/generate_theme_files_in_public_folder.py
+++ b/frappe/patches/v13_0/generate_theme_files_in_public_folder.py
@@ -14,6 +14,6 @@ def execute():
try:
doc.generate_bootstrap_theme()
doc.save()
- except: # noqa: E722
- print('Ignoring....')
+ except: # noqa: E722
+ print("Ignoring....")
print(frappe.get_traceback())
diff --git a/frappe/patches/v13_0/increase_password_length.py b/frappe/patches/v13_0/increase_password_length.py
index deb7d7e98a..8933c99009 100644
--- a/frappe/patches/v13_0/increase_password_length.py
+++ b/frappe/patches/v13_0/increase_password_length.py
@@ -1,4 +1,5 @@
import frappe
+
def execute():
frappe.db.change_column_type("__Auth", column="password", type="TEXT")
diff --git a/frappe/patches/v13_0/jinja_hook.py b/frappe/patches/v13_0/jinja_hook.py
index e1c9175576..b7e0a501ee 100644
--- a/frappe/patches/v13_0/jinja_hook.py
+++ b/frappe/patches/v13_0/jinja_hook.py
@@ -1,12 +1,17 @@
# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
-import frappe
from click import secho
+import frappe
+
+
def execute():
- if frappe.get_hooks('jenv'):
+ if frappe.get_hooks("jenv"):
print()
- secho('WARNING: The hook "jenv" is deprecated. Follow the migration guide to use the new "jinja" hook.', fg='yellow')
- secho('https://github.com/frappe/frappe/wiki/Migrating-to-Version-13', fg='yellow')
+ secho(
+ 'WARNING: The hook "jenv" is deprecated. Follow the migration guide to use the new "jinja" hook.',
+ fg="yellow",
+ )
+ secho("https://github.com/frappe/frappe/wiki/Migrating-to-Version-13", fg="yellow")
print()
diff --git a/frappe/patches/v13_0/make_user_type.py b/frappe/patches/v13_0/make_user_type.py
index 0fd5b98e9d..1e77dd4f54 100644
--- a/frappe/patches/v13_0/make_user_type.py
+++ b/frappe/patches/v13_0/make_user_type.py
@@ -1,12 +1,12 @@
import frappe
from frappe.utils.install import create_user_type
-def execute():
- frappe.reload_doc('core', 'doctype', 'role')
- frappe.reload_doc('core', 'doctype', 'user_document_type')
- frappe.reload_doc('core', 'doctype', 'user_type_module')
- frappe.reload_doc('core', 'doctype', 'user_select_document_type')
- frappe.reload_doc('core', 'doctype', 'user_type')
+def execute():
+ frappe.reload_doc("core", "doctype", "role")
+ frappe.reload_doc("core", "doctype", "user_document_type")
+ frappe.reload_doc("core", "doctype", "user_type_module")
+ frappe.reload_doc("core", "doctype", "user_select_document_type")
+ frappe.reload_doc("core", "doctype", "user_type")
create_user_type()
diff --git a/frappe/patches/v13_0/migrate_translation_column_data.py b/frappe/patches/v13_0/migrate_translation_column_data.py
index 7c83f93081..831c27bc75 100644
--- a/frappe/patches/v13_0/migrate_translation_column_data.py
+++ b/frappe/patches/v13_0/migrate_translation_column_data.py
@@ -1,5 +1,8 @@
import frappe
+
def execute():
- frappe.reload_doctype('Translation')
- frappe.db.sql("UPDATE `tabTranslation` SET `translated_text`=`target_name`, `source_text`=`source_name`, `contributed`=0")
+ frappe.reload_doctype("Translation")
+ frappe.db.sql(
+ "UPDATE `tabTranslation` SET `translated_text`=`target_name`, `source_text`=`source_name`, `contributed`=0"
+ )
diff --git a/frappe/patches/v13_0/queryreport_columns.py b/frappe/patches/v13_0/queryreport_columns.py
index ed22ce4441..3081823db6 100644
--- a/frappe/patches/v13_0/queryreport_columns.py
+++ b/frappe/patches/v13_0/queryreport_columns.py
@@ -1,21 +1,18 @@
# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
-import frappe
import json
+import frappe
+
+
def execute():
"""Convert Query Report json to support other content"""
- records = frappe.get_all('Report',
- filters={
- "json": ["!=", ""]
- },
- fields=["name", "json"]
- )
+ records = frappe.get_all("Report", filters={"json": ["!=", ""]}, fields=["name", "json"])
for record in records:
jstr = record["json"]
data = json.loads(jstr)
if isinstance(data, list):
# double escape braces
jstr = f'{{"columns":{jstr}}}'
- frappe.db.update('Report', record["name"], "json", jstr)
+ frappe.db.update("Report", record["name"], "json", jstr)
diff --git a/frappe/patches/v13_0/remove_chat.py b/frappe/patches/v13_0/remove_chat.py
index 1804c7693f..685df37366 100644
--- a/frappe/patches/v13_0/remove_chat.py
+++ b/frappe/patches/v13_0/remove_chat.py
@@ -1,6 +1,8 @@
-import frappe
import click
+import frappe
+
+
def execute():
frappe.delete_doc_if_exists("DocType", "Chat Message")
frappe.delete_doc_if_exists("DocType", "Chat Message Attachment")
@@ -14,4 +16,4 @@ def execute():
"Chat Module is moved to a separate app and is removed from Frappe in version-13.\n"
"Please install the app to continue using the chat feature: https://github.com/frappe/chat",
fg="yellow",
- )
\ No newline at end of file
+ )
diff --git a/frappe/patches/v13_0/remove_custom_link.py b/frappe/patches/v13_0/remove_custom_link.py
index f38bb642f0..8803b66b98 100644
--- a/frappe/patches/v13_0/remove_custom_link.py
+++ b/frappe/patches/v13_0/remove_custom_link.py
@@ -1,15 +1,18 @@
import frappe
+
def execute():
- '''
+ """
Remove the doctype "Custom Link" that was used to add Custom Links to the
Dashboard since this is now managed by Customize Form.
Update `parent` property to the DocType and delte the doctype
- '''
- frappe.reload_doctype('DocType Link')
- if frappe.db.has_table('Custom Link'):
- for custom_link in frappe.get_all('Custom Link', ['name', 'document_type']):
- frappe.db.sql('update `tabDocType Link` set custom=1, parent=%s where parent=%s',
- (custom_link.document_type, custom_link.name))
+ """
+ frappe.reload_doctype("DocType Link")
+ if frappe.db.has_table("Custom Link"):
+ for custom_link in frappe.get_all("Custom Link", ["name", "document_type"]):
+ frappe.db.sql(
+ "update `tabDocType Link` set custom=1, parent=%s where parent=%s",
+ (custom_link.document_type, custom_link.name),
+ )
- frappe.delete_doc('DocType', 'Custom Link')
\ No newline at end of file
+ frappe.delete_doc("DocType", "Custom Link")
diff --git a/frappe/patches/v13_0/remove_duplicate_navbar_items.py b/frappe/patches/v13_0/remove_duplicate_navbar_items.py
index b6c6033f64..593a529efc 100644
--- a/frappe/patches/v13_0/remove_duplicate_navbar_items.py
+++ b/frappe/patches/v13_0/remove_duplicate_navbar_items.py
@@ -1,12 +1,12 @@
-
import frappe
+
def execute():
navbar_settings = frappe.get_single("Navbar Settings")
duplicate_items = []
for navbar_item in navbar_settings.settings_dropdown:
- if navbar_item.item_label == 'Toggle Full Width':
+ if navbar_item.item_label == "Toggle Full Width":
duplicate_items.append(navbar_item)
if len(duplicate_items) > 1:
diff --git a/frappe/patches/v13_0/remove_invalid_options_for_data_fields.py b/frappe/patches/v13_0/remove_invalid_options_for_data_fields.py
index 90e4b3c5c6..9bddcfe3db 100644
--- a/frappe/patches/v13_0/remove_invalid_options_for_data_fields.py
+++ b/frappe/patches/v13_0/remove_invalid_options_for_data_fields.py
@@ -7,11 +7,9 @@ from frappe.model import data_field_options
def execute():
- custom_field = frappe.qb.DocType('Custom Field')
- (frappe.qb
- .update(custom_field)
+ custom_field = frappe.qb.DocType("Custom Field")
+ (
+ frappe.qb.update(custom_field)
.set(custom_field.options, None)
- .where(
- (custom_field.fieldtype == "Data")
- & (custom_field.options.notin(data_field_options)))
+ .where((custom_field.fieldtype == "Data") & (custom_field.options.notin(data_field_options)))
).run()
diff --git a/frappe/patches/v13_0/remove_tailwind_from_page_builder.py b/frappe/patches/v13_0/remove_tailwind_from_page_builder.py
index b26d2bef4a..44a1f5940a 100644
--- a/frappe/patches/v13_0/remove_tailwind_from_page_builder.py
+++ b/frappe/patches/v13_0/remove_tailwind_from_page_builder.py
@@ -9,4 +9,3 @@ def execute():
# remove unused templates
frappe.delete_doc("Web Template", "Navbar with Links on Right", force=1)
frappe.delete_doc("Web Template", "Footer Horizontal", force=1)
-
diff --git a/frappe/patches/v13_0/remove_twilio_settings.py b/frappe/patches/v13_0/remove_twilio_settings.py
index 826edfb951..ae0fc6552b 100644
--- a/frappe/patches/v13_0/remove_twilio_settings.py
+++ b/frappe/patches/v13_0/remove_twilio_settings.py
@@ -9,14 +9,12 @@ def execute():
While making Twilio as a standaone app, we missed to delete Twilio records from DB through migration. Adding the missing patch.
"""
- frappe.delete_doc_if_exists('DocType', 'Twilio Number Group')
+ frappe.delete_doc_if_exists("DocType", "Twilio Number Group")
if twilio_settings_doctype_in_integrations():
- frappe.delete_doc_if_exists('DocType', 'Twilio Settings')
- frappe.db.delete("Singles", {
- "doctype": "Twilio Settings"
- })
+ frappe.delete_doc_if_exists("DocType", "Twilio Settings")
+ frappe.db.delete("Singles", {"doctype": "Twilio Settings"})
+
def twilio_settings_doctype_in_integrations() -> bool:
- """Check Twilio Settings doctype exists in integrations module or not.
- """
- return frappe.db.exists("DocType", {'name': 'Twilio Settings', 'module': 'Integrations'})
+ """Check Twilio Settings doctype exists in integrations module or not."""
+ return frappe.db.exists("DocType", {"name": "Twilio Settings", "module": "Integrations"})
diff --git a/frappe/patches/v13_0/remove_web_view.py b/frappe/patches/v13_0/remove_web_view.py
index 7c9109fd03..4695c45558 100644
--- a/frappe/patches/v13_0/remove_web_view.py
+++ b/frappe/patches/v13_0/remove_web_view.py
@@ -1,6 +1,7 @@
import frappe
+
def execute():
frappe.delete_doc_if_exists("DocType", "Web View")
frappe.delete_doc_if_exists("DocType", "Web View Component")
- frappe.delete_doc_if_exists("DocType", "CSS Class")
\ No newline at end of file
+ frappe.delete_doc_if_exists("DocType", "CSS Class")
diff --git a/frappe/patches/v13_0/rename_desk_page_to_workspace.py b/frappe/patches/v13_0/rename_desk_page_to_workspace.py
index 6483fc380c..e4d26a5b7a 100644
--- a/frappe/patches/v13_0/rename_desk_page_to_workspace.py
+++ b/frappe/patches/v13_0/rename_desk_page_to_workspace.py
@@ -1,21 +1,22 @@
import frappe
from frappe.model.rename_doc import rename_doc
+
def execute():
if frappe.db.exists("DocType", "Desk Page"):
- if frappe.db.exists('DocType', 'Workspace'):
+ if frappe.db.exists("DocType", "Workspace"):
# this patch was not added initially, so this page might still exist
- frappe.delete_doc('DocType', 'Desk Page')
+ frappe.delete_doc("DocType", "Desk Page")
else:
frappe.flags.ignore_route_conflict_validation = True
- rename_doc('DocType', 'Desk Page', 'Workspace')
+ rename_doc("DocType", "Desk Page", "Workspace")
frappe.flags.ignore_route_conflict_validation = False
- rename_doc('DocType', 'Desk Chart', 'Workspace Chart', ignore_if_exists=True)
- rename_doc('DocType', 'Desk Shortcut', 'Workspace Shortcut', ignore_if_exists=True)
- rename_doc('DocType', 'Desk Link', 'Workspace Link', ignore_if_exists=True)
+ rename_doc("DocType", "Desk Chart", "Workspace Chart", ignore_if_exists=True)
+ rename_doc("DocType", "Desk Shortcut", "Workspace Shortcut", ignore_if_exists=True)
+ rename_doc("DocType", "Desk Link", "Workspace Link", ignore_if_exists=True)
- frappe.reload_doc('desk', 'doctype', 'workspace', force=True)
- frappe.reload_doc('desk', 'doctype', 'workspace_link', force=True)
- frappe.reload_doc('desk', 'doctype', 'workspace_chart', force=True)
- frappe.reload_doc('desk', 'doctype', 'workspace_shortcut', force=True)
+ frappe.reload_doc("desk", "doctype", "workspace", force=True)
+ frappe.reload_doc("desk", "doctype", "workspace_link", force=True)
+ frappe.reload_doc("desk", "doctype", "workspace_chart", force=True)
+ frappe.reload_doc("desk", "doctype", "workspace_shortcut", force=True)
diff --git a/frappe/patches/v13_0/rename_is_custom_field_in_dashboard_chart.py b/frappe/patches/v13_0/rename_is_custom_field_in_dashboard_chart.py
index 4da0f8164a..61f80fdb2f 100644
--- a/frappe/patches/v13_0/rename_is_custom_field_in_dashboard_chart.py
+++ b/frappe/patches/v13_0/rename_is_custom_field_in_dashboard_chart.py
@@ -1,11 +1,12 @@
import frappe
from frappe.model.utils.rename_field import rename_field
+
def execute():
- if not frappe.db.table_exists('Dashboard Chart'):
+ if not frappe.db.table_exists("Dashboard Chart"):
return
- frappe.reload_doc('desk', 'doctype', 'dashboard_chart')
+ frappe.reload_doc("desk", "doctype", "dashboard_chart")
- if frappe.db.has_column('Dashboard Chart', 'is_custom'):
- rename_field('Dashboard Chart', 'is_custom', 'use_report_chart')
\ No newline at end of file
+ if frappe.db.has_column("Dashboard Chart", "is_custom"):
+ rename_field("Dashboard Chart", "is_custom", "use_report_chart")
diff --git a/frappe/patches/v13_0/rename_list_view_setting_to_list_view_settings.py b/frappe/patches/v13_0/rename_list_view_setting_to_list_view_settings.py
index db3ab1b32a..2147a2da94 100644
--- a/frappe/patches/v13_0/rename_list_view_setting_to_list_view_settings.py
+++ b/frappe/patches/v13_0/rename_list_view_setting_to_list_view_settings.py
@@ -5,15 +5,18 @@ import frappe
def execute():
- if frappe.db.table_exists('List View Setting'):
- if not frappe.db.table_exists('List View Settings'):
+ if frappe.db.table_exists("List View Setting"):
+ if not frappe.db.table_exists("List View Settings"):
frappe.reload_doc("desk", "doctype", "List View Settings")
- existing_list_view_settings = frappe.get_all('List View Settings', as_list=True)
- for list_view_setting in frappe.get_all('List View Setting', fields = ['disable_count', 'disable_sidebar_stats', 'disable_auto_refresh', 'name']):
- name = list_view_setting.pop('name')
+ existing_list_view_settings = frappe.get_all("List View Settings", as_list=True)
+ for list_view_setting in frappe.get_all(
+ "List View Setting",
+ fields=["disable_count", "disable_sidebar_stats", "disable_auto_refresh", "name"],
+ ):
+ name = list_view_setting.pop("name")
if name not in [x[0] for x in existing_list_view_settings]:
- list_view_setting['doctype'] = 'List View Settings'
+ list_view_setting["doctype"] = "List View Settings"
list_view_settings = frappe.get_doc(list_view_setting)
# setting name here is necessary because autoname is set as prompt
list_view_settings.name = name
diff --git a/frappe/patches/v13_0/rename_notification_fields.py b/frappe/patches/v13_0/rename_notification_fields.py
index 2f314df9c1..74674eb6f7 100644
--- a/frappe/patches/v13_0/rename_notification_fields.py
+++ b/frappe/patches/v13_0/rename_notification_fields.py
@@ -4,12 +4,13 @@
import frappe
from frappe.model.utils.rename_field import rename_field
+
def execute():
"""
- Change notification recipient fields from email to receiver fields
+ Change notification recipient fields from email to receiver fields
"""
frappe.reload_doc("Email", "doctype", "Notification Recipient")
frappe.reload_doc("Email", "doctype", "Notification")
rename_field("Notification Recipient", "email_by_document_field", "receiver_by_document_field")
- rename_field("Notification Recipient", "email_by_role", "receiver_by_role")
\ No newline at end of file
+ rename_field("Notification Recipient", "email_by_role", "receiver_by_role")
diff --git a/frappe/patches/v13_0/rename_onboarding.py b/frappe/patches/v13_0/rename_onboarding.py
index cd910195ad..f4e8445320 100644
--- a/frappe/patches/v13_0/rename_onboarding.py
+++ b/frappe/patches/v13_0/rename_onboarding.py
@@ -3,7 +3,7 @@
import frappe
+
def execute():
if frappe.db.exists("DocType", "Onboarding"):
frappe.rename_doc("DocType", "Onboarding", "Module Onboarding", ignore_if_exists=True)
-
diff --git a/frappe/patches/v13_0/replace_field_target_with_open_in_new_tab.py b/frappe/patches/v13_0/replace_field_target_with_open_in_new_tab.py
index 21b2d8ef03..a133d7f6fe 100644
--- a/frappe/patches/v13_0/replace_field_target_with_open_in_new_tab.py
+++ b/frappe/patches/v13_0/replace_field_target_with_open_in_new_tab.py
@@ -3,9 +3,8 @@ import frappe
def execute():
doctype = "Top Bar Item"
- if not frappe.db.table_exists(doctype) \
- or not frappe.db.has_column(doctype, "target"):
+ if not frappe.db.table_exists(doctype) or not frappe.db.has_column(doctype, "target"):
return
frappe.reload_doc("website", "doctype", "top_bar_item")
- frappe.db.set_value(doctype, {"target": 'target = "_blank"'}, 'open_in_new_tab', 1)
+ frappe.db.set_value(doctype, {"target": 'target = "_blank"'}, "open_in_new_tab", 1)
diff --git a/frappe/patches/v13_0/replace_old_data_import.py b/frappe/patches/v13_0/replace_old_data_import.py
index 7d2692a433..009c2e4f10 100644
--- a/frappe/patches/v13_0/replace_old_data_import.py
+++ b/frappe/patches/v13_0/replace_old_data_import.py
@@ -5,7 +5,8 @@ import frappe
def execute():
- if not frappe.db.table_exists("Data Import"): return
+ if not frappe.db.table_exists("Data Import"):
+ return
meta = frappe.get_meta("Data Import")
# if Data Import is the new one, return early
diff --git a/frappe/patches/v13_0/set_existing_dashboard_charts_as_public.py b/frappe/patches/v13_0/set_existing_dashboard_charts_as_public.py
index 80c6105440..11015033b9 100644
--- a/frappe/patches/v13_0/set_existing_dashboard_charts_as_public.py
+++ b/frappe/patches/v13_0/set_existing_dashboard_charts_as_public.py
@@ -1,21 +1,21 @@
import frappe
+
def execute():
- frappe.reload_doc('desk', 'doctype', 'dashboard_chart')
+ frappe.reload_doc("desk", "doctype", "dashboard_chart")
- if not frappe.db.table_exists('Dashboard Chart'):
+ if not frappe.db.table_exists("Dashboard Chart"):
return
users_with_permission = frappe.get_all(
"Has Role",
fields=["parent"],
- filters={"role": ['in', ['System Manager', 'Dashboard Manager']], "parenttype": "User"},
+ filters={"role": ["in", ["System Manager", "Dashboard Manager"]], "parenttype": "User"},
distinct=True,
)
users = [item.parent for item in users_with_permission]
- charts = frappe.db.get_all('Dashboard Chart', filters={'owner': ['in', users]})
+ charts = frappe.db.get_all("Dashboard Chart", filters={"owner": ["in", users]})
for chart in charts:
- frappe.db.set_value('Dashboard Chart', chart.name, 'is_public', 1)
-
+ frappe.db.set_value("Dashboard Chart", chart.name, "is_public", 1)
diff --git a/frappe/patches/v13_0/set_first_day_of_the_week.py b/frappe/patches/v13_0/set_first_day_of_the_week.py
index cfb694bbf1..165ec3c42b 100644
--- a/frappe/patches/v13_0/set_first_day_of_the_week.py
+++ b/frappe/patches/v13_0/set_first_day_of_the_week.py
@@ -1,7 +1,8 @@
import frappe
+
def execute():
frappe.reload_doctype("System Settings")
# setting first_day_of_the_week value as "Monday" to avoid breaking change
# because before the configuration was introduced, system used to consider "Monday" as start of the week
- frappe.db.set_value("System Settings", "System Settings", "first_day_of_the_week", "Monday")
\ No newline at end of file
+ frappe.db.set_value("System Settings", "System Settings", "first_day_of_the_week", "Monday")
diff --git a/frappe/patches/v13_0/set_path_for_homepage_in_web_page_view.py b/frappe/patches/v13_0/set_path_for_homepage_in_web_page_view.py
index d4fe2d2f36..a297eeb64c 100644
--- a/frappe/patches/v13_0/set_path_for_homepage_in_web_page_view.py
+++ b/frappe/patches/v13_0/set_path_for_homepage_in_web_page_view.py
@@ -1,5 +1,6 @@
import frappe
+
def execute():
- frappe.reload_doc('website', 'doctype', 'web_page_view', force=True)
+ frappe.reload_doc("website", "doctype", "web_page_view", force=True)
frappe.db.sql("""UPDATE `tabWeb Page View` set path='/' where path=''""")
diff --git a/frappe/patches/v13_0/set_read_times.py b/frappe/patches/v13_0/set_read_times.py
index 6957139372..987ed0f1b9 100644
--- a/frappe/patches/v13_0/set_read_times.py
+++ b/frappe/patches/v13_0/set_read_times.py
@@ -1,13 +1,18 @@
-import frappe
-from frappe.utils import strip_html_tags, markdown
from math import ceil
+import frappe
+from frappe.utils import markdown, strip_html_tags
+
+
def execute():
frappe.reload_doc("website", "doctype", "blog_post")
for blog in frappe.get_all("Blog Post"):
blog = frappe.get_doc("Blog Post", blog.name)
- frappe.db.set_value("Blog Post", blog.name, "read_time", get_read_time(blog), update_modified=False)
+ frappe.db.set_value(
+ "Blog Post", blog.name, "read_time", get_read_time(blog), update_modified=False
+ )
+
def get_read_time(blog):
content = blog.content or blog.content_html
@@ -15,4 +20,4 @@ def get_read_time(blog):
content = markdown(blog.content_md)
total_words = len(strip_html_tags(content or "").split())
- return ceil(total_words/250)
\ No newline at end of file
+ return ceil(total_words / 250)
diff --git a/frappe/patches/v13_0/set_route_for_blog_category.py b/frappe/patches/v13_0/set_route_for_blog_category.py
index 7ea26bc2c0..e9d15e0cc3 100644
--- a/frappe/patches/v13_0/set_route_for_blog_category.py
+++ b/frappe/patches/v13_0/set_route_for_blog_category.py
@@ -1,5 +1,6 @@
import frappe
+
def execute():
categories = frappe.get_list("Blog Category")
for category in categories:
diff --git a/frappe/patches/v13_0/set_social_icons.py b/frappe/patches/v13_0/set_social_icons.py
index b1c63b48e0..25b144ed53 100644
--- a/frappe/patches/v13_0/set_social_icons.py
+++ b/frappe/patches/v13_0/set_social_icons.py
@@ -1,9 +1,10 @@
import frappe
+
def execute():
providers = frappe.get_all("Social Login Key")
for provider in providers:
doc = frappe.get_doc("Social Login Key", provider)
doc.set_icon()
- doc.save()
\ No newline at end of file
+ doc.save()
diff --git a/frappe/patches/v13_0/set_unique_for_page_view.py b/frappe/patches/v13_0/set_unique_for_page_view.py
index 2a084e52e3..1a674f6697 100644
--- a/frappe/patches/v13_0/set_unique_for_page_view.py
+++ b/frappe/patches/v13_0/set_unique_for_page_view.py
@@ -1,6 +1,9 @@
import frappe
+
def execute():
- frappe.reload_doc('website', 'doctype', 'web_page_view', force=True)
+ frappe.reload_doc("website", "doctype", "web_page_view", force=True)
site_url = frappe.utils.get_site_url(frappe.local.site)
- frappe.db.sql("""UPDATE `tabWeb Page View` set is_unique=1 where referrer LIKE '%{0}%'""".format(site_url))
+ frappe.db.sql(
+ """UPDATE `tabWeb Page View` set is_unique=1 where referrer LIKE '%{0}%'""".format(site_url)
+ )
diff --git a/frappe/patches/v13_0/site_wise_logging.py b/frappe/patches/v13_0/site_wise_logging.py
index 6f04e0c9dd..5807a85c33 100644
--- a/frappe/patches/v13_0/site_wise_logging.py
+++ b/frappe/patches/v13_0/site_wise_logging.py
@@ -1,10 +1,11 @@
import os
+
import frappe
def execute():
site = frappe.local.site
- log_folder = os.path.join(site, 'logs')
+ log_folder = os.path.join(site, "logs")
if not os.path.exists(log_folder):
- os.mkdir(log_folder)
\ No newline at end of file
+ os.mkdir(log_folder)
diff --git a/frappe/patches/v13_0/update_date_filters_in_user_settings.py b/frappe/patches/v13_0/update_date_filters_in_user_settings.py
index fa13a6789e..a2ac9e94fb 100644
--- a/frappe/patches/v13_0/update_date_filters_in_user_settings.py
+++ b/frappe/patches/v13_0/update_date_filters_in_user_settings.py
@@ -1,20 +1,27 @@
+import json
+
+import frappe
+from frappe.model.utils.user_settings import sync_user_settings, update_user_settings
-import frappe, json
-from frappe.model.utils.user_settings import update_user_settings, sync_user_settings
def execute():
users = frappe.db.sql("select distinct(user) from `__UserSettings`", as_dict=True)
for user in users:
- user_settings = frappe.db.sql('''
+ user_settings = frappe.db.sql(
+ """
select
* from `__UserSettings`
where
user='{user}'
- '''.format(user = user.user), as_dict=True)
+ """.format(
+ user=user.user
+ ),
+ as_dict=True,
+ )
for setting in user_settings:
- data = frappe.parse_json(setting.get('data'))
+ data = frappe.parse_json(setting.get("data"))
if data:
for key in data:
update_user_setting_filters(data, key, setting)
@@ -24,31 +31,26 @@ def execute():
def update_user_setting_filters(data, key, user_setting):
timespan_map = {
- '1 week': 'week',
- '1 month': 'month',
- '3 months': 'quarter',
- '6 months': '6 months',
- '1 year': 'year',
+ "1 week": "week",
+ "1 month": "month",
+ "3 months": "quarter",
+ "6 months": "6 months",
+ "1 year": "year",
}
- period_map = {
- 'Previous': 'last',
- 'Next': 'next'
- }
+ period_map = {"Previous": "last", "Next": "next"}
if data.get(key):
update = False
if isinstance(data.get(key), dict):
- filters = data.get(key).get('filters')
+ filters = data.get(key).get("filters")
if filters and isinstance(filters, list):
for f in filters:
- if f[2] == 'Next' or f[2] == 'Previous':
+ if f[2] == "Next" or f[2] == "Previous":
update = True
- f[3] = period_map[f[2]] + ' ' + timespan_map[f[3]]
- f[2] = 'Timespan'
+ f[3] = period_map[f[2]] + " " + timespan_map[f[3]]
+ f[2] = "Timespan"
if update:
- data[key]['filters'] = filters
- update_user_settings(user_setting['doctype'], json.dumps(data), for_update=True)
-
-
+ data[key]["filters"] = filters
+ update_user_settings(user_setting["doctype"], json.dumps(data), for_update=True)
diff --git a/frappe/patches/v13_0/update_duration_options.py b/frappe/patches/v13_0/update_duration_options.py
index 48f0dc0969..56ad4fe698 100644
--- a/frappe/patches/v13_0/update_duration_options.py
+++ b/frappe/patches/v13_0/update_duration_options.py
@@ -3,25 +3,30 @@
import frappe
+
def execute():
- frappe.reload_doc('core', 'doctype', 'DocField')
+ frappe.reload_doc("core", "doctype", "DocField")
- if frappe.db.has_column('DocField', 'show_days'):
- frappe.db.sql("""
+ if frappe.db.has_column("DocField", "show_days"):
+ frappe.db.sql(
+ """
UPDATE
tabDocField
SET
hide_days = 1 WHERE show_days = 0
- """)
- frappe.db.sql_ddl('alter table tabDocField drop column show_days')
+ """
+ )
+ frappe.db.sql_ddl("alter table tabDocField drop column show_days")
- if frappe.db.has_column('DocField', 'show_seconds'):
- frappe.db.sql("""
+ if frappe.db.has_column("DocField", "show_seconds"):
+ frappe.db.sql(
+ """
UPDATE
tabDocField
SET
hide_seconds = 1 WHERE show_seconds = 0
- """)
- frappe.db.sql_ddl('alter table tabDocField drop column show_seconds')
+ """
+ )
+ frappe.db.sql_ddl("alter table tabDocField drop column show_seconds")
- frappe.clear_cache(doctype='DocField')
\ No newline at end of file
+ frappe.clear_cache(doctype="DocField")
diff --git a/frappe/patches/v13_0/update_icons_in_customized_desk_pages.py b/frappe/patches/v13_0/update_icons_in_customized_desk_pages.py
index ff58f99c2f..d48fe217c8 100644
--- a/frappe/patches/v13_0/update_icons_in_customized_desk_pages.py
+++ b/frappe/patches/v13_0/update_icons_in_customized_desk_pages.py
@@ -1,10 +1,13 @@
-
import frappe
+
def execute():
- if not frappe.db.exists('Desk Page'): return
+ if not frappe.db.exists("Desk Page"):
+ return
- pages = frappe.get_all("Desk Page", filters={ "is_standard": False }, fields=["name", "extends", "for_user"])
+ pages = frappe.get_all(
+ "Desk Page", filters={"is_standard": False}, fields=["name", "extends", "for_user"]
+ )
default_icon = {}
for page in pages:
if page.extends and page.for_user:
@@ -12,4 +15,4 @@ def execute():
default_icon[page.extends] = frappe.db.get_value("Desk Page", page.extends, "icon")
icon = default_icon.get(page.extends)
- frappe.db.set_value("Desk Page", page.name, "icon", icon)
\ No newline at end of file
+ frappe.db.set_value("Desk Page", page.name, "icon", icon)
diff --git a/frappe/patches/v13_0/update_newsletter_content_type.py b/frappe/patches/v13_0/update_newsletter_content_type.py
index 39758c8257..2004019750 100644
--- a/frappe/patches/v13_0/update_newsletter_content_type.py
+++ b/frappe/patches/v13_0/update_newsletter_content_type.py
@@ -3,9 +3,12 @@
import frappe
+
def execute():
- frappe.reload_doc('email', 'doctype', 'Newsletter')
- frappe.db.sql("""
+ frappe.reload_doc("email", "doctype", "Newsletter")
+ frappe.db.sql(
+ """
UPDATE tabNewsletter
SET content_type = 'Rich Text'
- """)
+ """
+ )
diff --git a/frappe/patches/v13_0/update_notification_channel_if_empty.py b/frappe/patches/v13_0/update_notification_channel_if_empty.py
index 43cf813c74..5ebab68f27 100644
--- a/frappe/patches/v13_0/update_notification_channel_if_empty.py
+++ b/frappe/patches/v13_0/update_notification_channel_if_empty.py
@@ -3,12 +3,15 @@
import frappe
+
def execute():
frappe.reload_doc("Email", "doctype", "Notification")
- notifications = frappe.get_all('Notification', {'is_standard': 1}, {'name', 'channel'})
+ notifications = frappe.get_all("Notification", {"is_standard": 1}, {"name", "channel"})
for notification in notifications:
if not notification.channel:
- frappe.db.set_value("Notification", notification.name, "channel", "Email", update_modified=False)
+ frappe.db.set_value(
+ "Notification", notification.name, "channel", "Email", update_modified=False
+ )
frappe.db.commit()
diff --git a/frappe/patches/v13_0/web_template_set_module.py b/frappe/patches/v13_0/web_template_set_module.py
index d200f4e0da..6fd0f8666f 100644
--- a/frappe/patches/v13_0/web_template_set_module.py
+++ b/frappe/patches/v13_0/web_template_set_module.py
@@ -3,14 +3,15 @@
import frappe
+
def execute():
"""Set default module for standard Web Template, if none."""
- frappe.reload_doc('website', 'doctype', 'Web Template Field')
- frappe.reload_doc('website', 'doctype', 'web_template')
+ frappe.reload_doc("website", "doctype", "Web Template Field")
+ frappe.reload_doc("website", "doctype", "web_template")
- standard_templates = frappe.get_list('Web Template', {'standard': 1})
+ standard_templates = frappe.get_list("Web Template", {"standard": 1})
for template in standard_templates:
- doc = frappe.get_doc('Web Template', template.name)
+ doc = frappe.get_doc("Web Template", template.name)
if not doc.module:
- doc.module = 'Website'
+ doc.module = "Website"
doc.save()
diff --git a/frappe/patches/v13_0/website_theme_custom_scss.py b/frappe/patches/v13_0/website_theme_custom_scss.py
index 2acb73e11a..d1a5e11228 100644
--- a/frappe/patches/v13_0/website_theme_custom_scss.py
+++ b/frappe/patches/v13_0/website_theme_custom_scss.py
@@ -1,13 +1,14 @@
import frappe
+
def execute():
- frappe.reload_doc('website', 'doctype', 'website_theme_ignore_app')
- frappe.reload_doc('website', 'doctype', 'color')
- frappe.reload_doc('website', 'doctype', 'website_theme', force=True)
+ frappe.reload_doc("website", "doctype", "website_theme_ignore_app")
+ frappe.reload_doc("website", "doctype", "color")
+ frappe.reload_doc("website", "doctype", "website_theme", force=True)
- for theme in frappe.get_all('Website Theme'):
- doc = frappe.get_doc('Website Theme', theme.name)
- if not doc.get('custom_scss') and doc.theme_scss:
+ for theme in frappe.get_all("Website Theme"):
+ doc = frappe.get_doc("Website Theme", theme.name)
+ if not doc.get("custom_scss") and doc.theme_scss:
# move old theme to new theme
doc.custom_scss = doc.theme_scss
@@ -16,9 +17,12 @@ def execute():
doc.save()
+
def setup_color_record(color):
- frappe.get_doc({
- "doctype": "Color",
- "__newname": color,
- "color": color,
- }).save()
+ frappe.get_doc(
+ {
+ "doctype": "Color",
+ "__newname": color,
+ "color": color,
+ }
+ ).save()
diff --git a/frappe/patches/v14_0/copy_mail_data.py b/frappe/patches/v14_0/copy_mail_data.py
index 8ef9cfaf1f..6b976ba6fb 100644
--- a/frappe/patches/v14_0/copy_mail_data.py
+++ b/frappe/patches/v14_0/copy_mail_data.py
@@ -1,21 +1,27 @@
from __future__ import unicode_literals
+
import frappe
def execute():
# patch for all Email Account with the flag use_imap
- for email_account in frappe.get_list("Email Account", filters={"enable_incoming": 1, "use_imap": 1}):
+ for email_account in frappe.get_list(
+ "Email Account", filters={"enable_incoming": 1, "use_imap": 1}
+ ):
# get all data from Email Account
doc = frappe.get_doc("Email Account", email_account.name)
imap_list = [folder.folder_name for folder in doc.imap_folder]
# and append the old data to the child table
if doc.uidvalidity or doc.uidnext and "INBOX" not in imap_list:
- doc.append("imap_folder", {
- "folder_name": "INBOX",
- "append_to": doc.append_to,
- "uid_validity": doc.uidvalidity,
- "uidnext": doc.uidnext,
- })
+ doc.append(
+ "imap_folder",
+ {
+ "folder_name": "INBOX",
+ "append_to": doc.append_to,
+ "uid_validity": doc.uidvalidity,
+ "uidnext": doc.uidnext,
+ },
+ )
doc.save()
diff --git a/frappe/patches/v14_0/drop_data_import_legacy.py b/frappe/patches/v14_0/drop_data_import_legacy.py
index 2037930c9f..16d366a845 100644
--- a/frappe/patches/v14_0/drop_data_import_legacy.py
+++ b/frappe/patches/v14_0/drop_data_import_legacy.py
@@ -1,6 +1,7 @@
-import frappe
import click
+import frappe
+
def execute():
doctype = "Data Import Legacy"
diff --git a/frappe/patches/v14_0/remove_db_aggregation.py b/frappe/patches/v14_0/remove_db_aggregation.py
index a8fa5b2ba1..6dc34a784b 100644
--- a/frappe/patches/v14_0/remove_db_aggregation.py
+++ b/frappe/patches/v14_0/remove_db_aggregation.py
@@ -8,20 +8,23 @@ def execute():
"""Replace temporarily available Database Aggregate APIs on frappe (develop)
APIs changed:
- * frappe.db.max => frappe.qb.max
- * frappe.db.min => frappe.qb.min
- * frappe.db.sum => frappe.qb.sum
- * frappe.db.avg => frappe.qb.avg
+ * frappe.db.max => frappe.qb.max
+ * frappe.db.min => frappe.qb.min
+ * frappe.db.sum => frappe.qb.sum
+ * frappe.db.avg => frappe.qb.avg
"""
ServerScript = DocType("Server Script")
- server_scripts = frappe.qb.from_(ServerScript).where(
- ServerScript.script.like("%frappe.db.max(%")
- | ServerScript.script.like("%frappe.db.min(%")
- | ServerScript.script.like("%frappe.db.sum(%")
- | ServerScript.script.like("%frappe.db.avg(%")
- ).select(
- "name", "script"
- ).run(as_dict=True)
+ server_scripts = (
+ frappe.qb.from_(ServerScript)
+ .where(
+ ServerScript.script.like("%frappe.db.max(%")
+ | ServerScript.script.like("%frappe.db.min(%")
+ | ServerScript.script.like("%frappe.db.sum(%")
+ | ServerScript.script.like("%frappe.db.avg(%")
+ )
+ .select("name", "script")
+ .run(as_dict=True)
+ )
for server_script in server_scripts:
name, script = server_script["name"], server_script["script"]
diff --git a/frappe/patches/v14_0/remove_post_and_post_comment.py b/frappe/patches/v14_0/remove_post_and_post_comment.py
index 3a93139961..ee3c41d459 100644
--- a/frappe/patches/v14_0/remove_post_and_post_comment.py
+++ b/frappe/patches/v14_0/remove_post_and_post_comment.py
@@ -1,5 +1,6 @@
import frappe
+
def execute():
frappe.delete_doc_if_exists("DocType", "Post")
frappe.delete_doc_if_exists("DocType", "Post Comment")
diff --git a/frappe/patches/v14_0/reset_creation_datetime.py b/frappe/patches/v14_0/reset_creation_datetime.py
index 54eb6c65af..5ba1bc9529 100644
--- a/frappe/patches/v14_0/reset_creation_datetime.py
+++ b/frappe/patches/v14_0/reset_creation_datetime.py
@@ -1,7 +1,8 @@
import glob
import json
-import frappe
import os
+
+import frappe
from frappe.query_builder import DocType as _DocType
@@ -12,9 +13,7 @@ def execute():
os.path.join("..", "apps", "frappe", "frappe", "**", "doctype", "**", "*.json")
)
- frappe_modules = frappe.get_all(
- "Module Def", filters={"app_name": "frappe"}, pluck="name"
- )
+ frappe_modules = frappe.get_all("Module Def", filters={"app_name": "frappe"}, pluck="name")
site_doctypes = frappe.get_all(
"DocType",
filters={"module": ("in", frappe_modules), "custom": False},
@@ -36,6 +35,6 @@ def execute():
continue
if file_schema.creation != _site_schema[0].creation:
- frappe.qb.update(DocType).set(
- DocType.creation, file_schema.creation
- ).where(DocType.name == file_schema.name).run()
+ frappe.qb.update(DocType).set(DocType.creation, file_schema.creation).where(
+ DocType.name == file_schema.name
+ ).run()
diff --git a/frappe/patches/v14_0/save_ratings_in_fraction.py b/frappe/patches/v14_0/save_ratings_in_fraction.py
index c933179b44..cedaf1b70d 100644
--- a/frappe/patches/v14_0/save_ratings_in_fraction.py
+++ b/frappe/patches/v14_0/save_ratings_in_fraction.py
@@ -31,9 +31,7 @@ def execute():
frappe.db.change_column_type(doctype_name, column=field, type=RATING_FIELD_TYPE, nullable=True)
# update data: int => decimal
- frappe.qb.update(doctype).set(
- doctype[field], doctype[field] / 5
- ).run()
+ frappe.qb.update(doctype).set(doctype[field], doctype[field] / 5).run()
# commit to flush updated rows
frappe.db.commit()
diff --git a/frappe/patches/v14_0/update_auto_account_deletion_duration.py b/frappe/patches/v14_0/update_auto_account_deletion_duration.py
index 74957066e6..6b01816092 100644
--- a/frappe/patches/v14_0/update_auto_account_deletion_duration.py
+++ b/frappe/patches/v14_0/update_auto_account_deletion_duration.py
@@ -1,5 +1,6 @@
import frappe
+
def execute():
days = frappe.db.get_single_value("Website Settings", "auto_account_deletion")
frappe.db.set_value("Website Settings", None, "auto_account_deletion", days * 24)
diff --git a/frappe/patches/v14_0/update_color_names_in_kanban_board_column.py b/frappe/patches/v14_0/update_color_names_in_kanban_board_column.py
index ff03604754..f8d6f236cd 100644
--- a/frappe/patches/v14_0/update_color_names_in_kanban_board_column.py
+++ b/frappe/patches/v14_0/update_color_names_in_kanban_board_column.py
@@ -2,20 +2,22 @@
# MIT License. See license.txt
from __future__ import unicode_literals
+
import frappe
+
def execute():
indicator_map = {
- 'blue': 'Blue',
- 'orange': 'Orange',
- 'red': 'Red',
- 'green': 'Green',
- 'darkgrey': 'Gray',
- 'gray': 'Gray',
- 'purple': 'Purple',
- 'yellow': 'Yellow',
- 'lightblue': 'Light Blue',
+ "blue": "Blue",
+ "orange": "Orange",
+ "red": "Red",
+ "green": "Green",
+ "darkgrey": "Gray",
+ "gray": "Gray",
+ "purple": "Purple",
+ "yellow": "Yellow",
+ "lightblue": "Light Blue",
}
- for d in frappe.db.get_all('Kanban Board Column', fields=['name', 'indicator']):
- color_name = indicator_map.get(d.indicator, 'Gray')
- frappe.db.set_value('Kanban Board Column', d.name, 'indicator', color_name)
+ for d in frappe.db.get_all("Kanban Board Column", fields=["name", "indicator"]):
+ color_name = indicator_map.get(d.indicator, "Gray")
+ frappe.db.set_value("Kanban Board Column", d.name, "indicator", color_name)
diff --git a/frappe/patches/v14_0/update_is_system_generated_flag.py b/frappe/patches/v14_0/update_is_system_generated_flag.py
index 657e02aebc..79ed3f9571 100644
--- a/frappe/patches/v14_0/update_is_system_generated_flag.py
+++ b/frappe/patches/v14_0/update_is_system_generated_flag.py
@@ -1,17 +1,20 @@
import frappe
+
def execute():
# assuming all customization generated by Admin is system generated customization
custom_field = frappe.qb.DocType("Custom Field")
(
frappe.qb.update(custom_field)
.set(custom_field.is_system_generated, True)
- .where(custom_field.owner == 'Administrator').run()
+ .where(custom_field.owner == "Administrator")
+ .run()
)
property_setter = frappe.qb.DocType("Property Setter")
(
frappe.qb.update(property_setter)
.set(property_setter.is_system_generated, True)
- .where(property_setter.owner == 'Administrator').run()
+ .where(property_setter.owner == "Administrator")
+ .run()
)
diff --git a/frappe/patches/v14_0/update_workspace2.py b/frappe/patches/v14_0/update_workspace2.py
index a4b057b989..c6586f46a1 100644
--- a/frappe/patches/v14_0/update_workspace2.py
+++ b/frappe/patches/v14_0/update_workspace2.py
@@ -1,63 +1,77 @@
-import frappe
import json
+
+import frappe
from frappe import _
+
def execute():
- frappe.reload_doc('desk', 'doctype', 'workspace', force=True)
+ frappe.reload_doc("desk", "doctype", "workspace", force=True)
- for seq, workspace in enumerate(frappe.get_all('Workspace', order_by='name asc')):
- doc = frappe.get_doc('Workspace', workspace.name)
+ for seq, workspace in enumerate(frappe.get_all("Workspace", order_by="name asc")):
+ doc = frappe.get_doc("Workspace", workspace.name)
content = create_content(doc)
update_workspace(doc, seq, content)
frappe.db.commit()
+
def create_content(doc):
content = []
if doc.onboarding:
- content.append({"type":"onboarding","data":{"onboarding_name":doc.onboarding,"col":12}})
+ content.append({"type": "onboarding", "data": {"onboarding_name": doc.onboarding, "col": 12}})
if doc.charts:
invalid_links = []
for c in doc.charts:
if c.get_invalid_links()[0]:
invalid_links.append(c)
else:
- content.append({"type":"chart","data":{"chart_name":c.label,"col":12}})
+ content.append({"type": "chart", "data": {"chart_name": c.label, "col": 12}})
for l in invalid_links:
del doc.charts[doc.charts.index(l)]
if doc.shortcuts:
invalid_links = []
if doc.charts:
- content.append({"type":"spacer","data":{"col":12}})
- content.append({"type":"header","data":{"text":doc.shortcuts_label or _("Your Shortcuts"),"level":4,"col":12}})
+ content.append({"type": "spacer", "data": {"col": 12}})
+ content.append(
+ {
+ "type": "header",
+ "data": {"text": doc.shortcuts_label or _("Your Shortcuts"), "level": 4, "col": 12},
+ }
+ )
for s in doc.shortcuts:
if s.get_invalid_links()[0]:
invalid_links.append(s)
else:
- content.append({"type":"shortcut","data":{"shortcut_name":s.label,"col":4}})
+ content.append({"type": "shortcut", "data": {"shortcut_name": s.label, "col": 4}})
for l in invalid_links:
del doc.shortcuts[doc.shortcuts.index(l)]
if doc.links:
invalid_links = []
- content.append({"type":"spacer","data":{"col":12}})
- content.append({"type":"header","data":{"text":doc.cards_label or _("Reports & Masters"),"level":4,"col":12}})
+ content.append({"type": "spacer", "data": {"col": 12}})
+ content.append(
+ {
+ "type": "header",
+ "data": {"text": doc.cards_label or _("Reports & Masters"), "level": 4, "col": 12},
+ }
+ )
for l in doc.links:
- if l.type == 'Card Break':
- content.append({"type":"card","data":{"card_name":l.label,"col":4}})
+ if l.type == "Card Break":
+ content.append({"type": "card", "data": {"card_name": l.label, "col": 4}})
if l.get_invalid_links()[0]:
invalid_links.append(l)
for l in invalid_links:
del doc.links[doc.links.index(l)]
return content
+
def update_workspace(doc, seq, content):
if not doc.title and not doc.content and not doc.is_standard and not doc.public:
doc.sequence_id = seq + 1
doc.content = json.dumps(content)
doc.public = 0 if doc.for_user else 1
doc.title = doc.extends or doc.label
- doc.extends = ''
- doc.category = ''
- doc.onboarding = ''
+ doc.extends = ""
+ doc.category = ""
+ doc.onboarding = ""
doc.extends_another_page = 0
doc.is_default = 0
doc.is_standard = 0
@@ -66,4 +80,4 @@ def update_workspace(doc, seq, content):
doc.pin_to_top = 0
doc.pin_to_bottom = 0
doc.hide_custom = 0
- doc.save(ignore_permissions=True)
\ No newline at end of file
+ doc.save(ignore_permissions=True)
diff --git a/frappe/permissions.py b/frappe/permissions.py
index a6c17fb59f..8980d2e63e 100644
--- a/frappe/permissions.py
+++ b/frappe/permissions.py
@@ -5,44 +5,72 @@ import copy
import frappe
import frappe.share
from frappe import _, msgprint
-from frappe.utils import cint
from frappe.query_builder import DocType
+from frappe.utils import cint
-rights = ("select", "read", "write", "create", "delete", "submit", "cancel", "amend",
- "print", "email", "report", "import", "export", "set_user_permissions", "share")
+rights = (
+ "select",
+ "read",
+ "write",
+ "create",
+ "delete",
+ "submit",
+ "cancel",
+ "amend",
+ "print",
+ "email",
+ "report",
+ "import",
+ "export",
+ "set_user_permissions",
+ "share",
+)
def check_admin_or_system_manager(user=None):
- if not user: user = frappe.session.user
+ if not user:
+ user = frappe.session.user
- if ("System Manager" not in frappe.get_roles(user)) and (user!="Administrator"):
+ if ("System Manager" not in frappe.get_roles(user)) and (user != "Administrator"):
frappe.throw(_("Not permitted"), frappe.PermissionError)
+
def print_has_permission_check_logs(func):
def inner(*args, **kwargs):
- frappe.flags['has_permission_check_logs'] = []
+ frappe.flags["has_permission_check_logs"] = []
result = func(*args, **kwargs)
- self_perm_check = True if not kwargs.get('user') else kwargs.get('user') == frappe.session.user
- raise_exception = False if kwargs.get('raise_exception') is False else True
+ self_perm_check = True if not kwargs.get("user") else kwargs.get("user") == frappe.session.user
+ raise_exception = False if kwargs.get("raise_exception") is False else True
# print only if access denied
# and if user is checking his own permission
if not result and self_perm_check and raise_exception:
- msgprint(('').join(frappe.flags.get('has_permission_check_logs', []))) - frappe.flags.pop('has_permission_check_logs', None) + msgprint(("
").join(frappe.flags.get("has_permission_check_logs", []))) + frappe.flags.pop("has_permission_check_logs", None) return result + return inner + @print_has_permission_check_logs -def has_permission(doctype, ptype="read", doc=None, verbose=False, user=None, raise_exception=True, parent_doctype=None): +def has_permission( + doctype, + ptype="read", + doc=None, + verbose=False, + user=None, + raise_exception=True, + parent_doctype=None, +): """Returns True if user has permission `ptype` for given `doctype`. If `doc` is passed, it also checks user, share and owner permissions. Note: if Table DocType is passed, it always returns True. """ - if not user: user = frappe.session.user + if not user: + user = frappe.session.user - if not doc and hasattr(doctype, 'doctype'): + if not doc and hasattr(doctype, "doctype"): # first argument can be doc or doctype doc = doctype doctype = doc.doctype @@ -51,8 +79,9 @@ def has_permission(doctype, ptype="read", doc=None, verbose=False, user=None, ra return True if frappe.is_table(doctype): - return has_child_table_permission(doctype, ptype, doc, verbose, - user, raise_exception, parent_doctype) + return has_child_table_permission( + doctype, ptype, doc, verbose, user, raise_exception, parent_doctype + ) meta = frappe.get_meta(doctype) @@ -60,13 +89,16 @@ def has_permission(doctype, ptype="read", doc=None, verbose=False, user=None, ra if isinstance(doc, str): doc = frappe.get_doc(meta.name, doc) perm = get_doc_permissions(doc, user=user, ptype=ptype).get(ptype) - if not perm: push_perm_check_log(_('User {0} does not have access to this document').format(frappe.bold(user))) + if not perm: + push_perm_check_log( + _("User {0} does not have access to this document").format(frappe.bold(user)) + ) else: - if ptype=="submit" and not cint(meta.is_submittable): + if ptype == "submit" and not cint(meta.is_submittable): push_perm_check_log(_("Document Type is not submittable")) return False - if ptype=="import" and not cint(meta.allow_import): + if ptype == "import" and not cint(meta.allow_import): push_perm_check_log(_("Document Type is not importable")) return False @@ -74,12 +106,17 @@ def has_permission(doctype, ptype="read", doc=None, verbose=False, user=None, ra perm = role_permissions.get(ptype) if not perm: - push_perm_check_log(_('User {0} does not have doctype access via role permission for document {1}').format(frappe.bold(user), frappe.bold(doctype))) + push_perm_check_log( + _("User {0} does not have doctype access via role permission for document {1}").format( + frappe.bold(user), frappe.bold(doctype) + ) + ) def false_if_not_shared(): if ptype in ("read", "write", "share", "submit", "email", "print"): - shared = frappe.share.get_shared(doctype, user, - ["read" if ptype in ("email", "print") else ptype]) + shared = frappe.share.get_shared( + doctype, user, ["read" if ptype in ("email", "print") else ptype] + ) if doc: doc_name = get_doc_name(doc) @@ -99,11 +136,14 @@ def has_permission(doctype, ptype="read", doc=None, verbose=False, user=None, ra return bool(perm) + def get_doc_permissions(doc, user=None, ptype=None): """Returns a dict of evaluated permissions for given `doc` like `{"read":1, "write":1}`""" - if not user: user = frappe.session.user + if not user: + user = frappe.session.user - if frappe.is_table(doc.doctype): return {"read": 1, "write": 1} + if frappe.is_table(doc.doctype): + return {"read": 1, "write": 1} meta = frappe.get_meta(doc.doctype) @@ -111,7 +151,7 @@ def get_doc_permissions(doc, user=None, ptype=None): return (doc.get("owner") or "").lower() == user.lower() if has_controller_permissions(doc, ptype, user=user) is False: - push_perm_check_log('Not allowed via controller permission check') + push_perm_check_log("Not allowed via controller permission check") return {ptype: 0} permissions = copy.deepcopy(get_role_permissions(meta, user=user, is_owner=is_user_owner())) @@ -123,7 +163,7 @@ def get_doc_permissions(doc, user=None, ptype=None): permissions["import"] = 0 # Override with `if_owner` perms irrespective of user - if permissions.get('has_if_owner_enabled'): + if permissions.get("has_if_owner_enabled"): # apply owner permissions on top of existing permissions # some access might be only for the owner # eg. everyone might have read access but only owner can delete @@ -134,80 +174,86 @@ def get_doc_permissions(doc, user=None, ptype=None): # replace with owner permissions permissions = permissions.get("if_owner", {}) # if_owner does not come with create rights... - permissions['create'] = 0 + permissions["create"] = 0 else: permissions = {} return permissions + def get_role_permissions(doctype_meta, user=None, is_owner=None): """ Returns dict of evaluated role permissions like - { - "read": 1, - "write": 0, - // if "if_owner" is enabled - "if_owner": - { - "read": 1, - "write": 0 - } - } + { + "read": 1, + "write": 0, + // if "if_owner" is enabled + "if_owner": + { + "read": 1, + "write": 0 + } + } """ if isinstance(doctype_meta, str): - doctype_meta = frappe.get_meta(doctype_meta) # assuming doctype name was passed + doctype_meta = frappe.get_meta(doctype_meta) # assuming doctype name was passed - if not user: user = frappe.session.user + if not user: + user = frappe.session.user cache_key = (doctype_meta.name, user) - if user == 'Administrator': + if user == "Administrator": return allow_everything() if not frappe.local.role_permissions.get(cache_key): - perms = frappe._dict( - if_owner={} - ) + perms = frappe._dict(if_owner={}) roles = frappe.get_roles(user) def is_perm_applicable(perm): - return perm.role in roles and cint(perm.permlevel)==0 + return perm.role in roles and cint(perm.permlevel) == 0 def has_permission_without_if_owner_enabled(ptype): - return any(p.get(ptype, 0) and not p.get('if_owner', 0) for p in applicable_permissions) + return any(p.get(ptype, 0) and not p.get("if_owner", 0) for p in applicable_permissions) - applicable_permissions = list(filter(is_perm_applicable, getattr(doctype_meta, 'permissions', []))) - has_if_owner_enabled = any(p.get('if_owner', 0) for p in applicable_permissions) - perms['has_if_owner_enabled'] = has_if_owner_enabled + applicable_permissions = list( + filter(is_perm_applicable, getattr(doctype_meta, "permissions", [])) + ) + has_if_owner_enabled = any(p.get("if_owner", 0) for p in applicable_permissions) + perms["has_if_owner_enabled"] = has_if_owner_enabled for ptype in rights: pvalue = any(p.get(ptype, 0) for p in applicable_permissions) # check if any perm object allows perm type perms[ptype] = cint(pvalue) if ( - pvalue - and has_if_owner_enabled - and not has_permission_without_if_owner_enabled(ptype) - and ptype != 'create' + pvalue + and has_if_owner_enabled + and not has_permission_without_if_owner_enabled(ptype) + and ptype != "create" ): - perms['if_owner'][ptype] = cint(pvalue and is_owner) + perms["if_owner"][ptype] = cint(pvalue and is_owner) # has no access if not owner # only provide select or read access so that user is able to at-least access list # (and the documents will be filtered based on owner sin further checks) - perms[ptype] = 1 if ptype in ('select', 'read') else 0 + perms[ptype] = 1 if ptype in ("select", "read") else 0 frappe.local.role_permissions[cache_key] = perms return frappe.local.role_permissions[cache_key] + def get_user_permissions(user): from frappe.core.doctype.user_permission.user_permission import get_user_permissions + return get_user_permissions(user) + def has_user_permission(doc, user=None): - '''Returns True if User is allowed to view considering User Permissions''' + """Returns True if User is allowed to view considering User Permissions""" from frappe.core.doctype.user_permission.user_permission import get_user_permissions + user_permissions = get_user_permissions(user) if not user_permissions: @@ -215,13 +261,13 @@ def has_user_permission(doc, user=None): return True # user can create own role permissions, so nothing applies - if get_role_permissions('User Permission', user=user).get('write'): + if get_role_permissions("User Permission", user=user).get("write"): return True - apply_strict_user_permissions = frappe.get_system_settings('apply_strict_user_permissions') + apply_strict_user_permissions = frappe.get_system_settings("apply_strict_user_permissions") - doctype = doc.get('doctype') - docname = doc.get('name') + doctype = doc.get("doctype") + docname = doc.get("name") # STEP 1: --------------------- # check user permissions on self @@ -233,7 +279,7 @@ def has_user_permission(doc, user=None): # only check if allowed_docs is not empty if allowed_docs and docname not in allowed_docs: # no user permissions for this doc specified - push_perm_check_log(_('Not allowed for {0}: {1}').format(_(doctype), docname)) + push_perm_check_log(_("Not allowed for {0}: {1}").format(_(doctype), docname)) return False # STEP 2: --------------------------------- @@ -250,7 +296,8 @@ def has_user_permission(doc, user=None): # check all link fields for user permissions for field in meta.get_link_fields(): - if field.ignore_user_permissions: continue + if field.ignore_user_permissions: + continue # empty value, do you still want to apply user permissions? if not d.get(field.fieldname) and not apply_strict_user_permissions: @@ -266,14 +313,16 @@ def has_user_permission(doc, user=None): if allowed_docs and d.get(field.fieldname) not in allowed_docs: # restricted for this link field, and no matching values found # make the right message and exit - if d.get('parentfield'): + if d.get("parentfield"): # "Not allowed for Company = Restricted Company in Row 3. Restricted field: reference_type" - msg = _('Not allowed for {0}: {1} in Row {2}. Restricted field: {3}').format( - _(field.options), d.get(field.fieldname), d.idx, field.fieldname) + msg = _("Not allowed for {0}: {1} in Row {2}. Restricted field: {3}").format( + _(field.options), d.get(field.fieldname), d.idx, field.fieldname + ) else: # "Not allowed for Company = Restricted Company. Restricted field: reference_type" - msg = _('Not allowed for {0}: {1}. Restricted field: {2}').format( - _(field.options), d.get(field.fieldname), field.fieldname) + msg = _("Not allowed for {0}: {1}. Restricted field: {2}").format( + _(field.options), d.get(field.fieldname), field.fieldname + ) push_perm_check_log(msg) @@ -290,9 +339,11 @@ def has_user_permission(doc, user=None): return True + def has_controller_permissions(doc, ptype, user=None): """Returns controller permissions if defined. None if not defined""" - if not user: user = frappe.session.user + if not user: + user = frappe.session.user methods = frappe.get_hooks("has_permission").get(doc.doctype, []) @@ -307,15 +358,19 @@ def has_controller_permissions(doc, ptype, user=None): # controller permissions could not decide on True or False return None + def get_doctypes_with_read(): - return list({p.parent if type(p.parent) == str else p.parent.encode('UTF8') for p in get_valid_perms()}) + return list( + {p.parent if type(p.parent) == str else p.parent.encode("UTF8") for p in get_valid_perms()} + ) + def get_valid_perms(doctype=None, user=None): - '''Get valid permissions for the current user from DocPerm and Custom DocPerm''' + """Get valid permissions for the current user from DocPerm and Custom DocPerm""" roles = get_roles(user) perms = get_perms_for(roles) - custom_perms = get_perms_for(roles, 'Custom DocPerm') + custom_perms = get_perms_for(roles, "Custom DocPerm") doctypes_with_custom_perms = get_doctypes_with_custom_docperms() for p in perms: @@ -327,10 +382,11 @@ def get_valid_perms(doctype=None, user=None): else: return custom_perms + def get_all_perms(role): - '''Returns valid permissions for a given role''' - perms = frappe.get_all('DocPerm', fields='*', filters=dict(role=role)) - custom_perms = frappe.get_all('Custom DocPerm', fields='*', filters=dict(role=role)) + """Returns valid permissions for a given role""" + perms = frappe.get_all("DocPerm", fields="*", filters=dict(role=role)) + custom_perms = frappe.get_all("Custom DocPerm", fields="*", filters=dict(role=role)) doctypes_with_custom_perms = frappe.get_all("Custom DocPerm", pluck="parent", distinct=True) for p in perms: @@ -338,52 +394,56 @@ def get_all_perms(role): custom_perms.append(p) return custom_perms + def get_roles(user=None, with_standard=True): """get roles of current user""" if not user: user = frappe.session.user - if user=='Guest': - return ['Guest'] + if user == "Guest": + return ["Guest"] def get(): - if user == 'Administrator': - return frappe.get_all("Role", pluck="name") # return all available roles + if user == "Administrator": + return frappe.get_all("Role", pluck="name") # return all available roles else: table = DocType("Has Role") - roles = frappe.qb.from_(table).where( - (table.parent == user) & (table.role.notin(["All", "Guest"])) - ).select(table.role).run(pluck=True) - return roles + ['All', 'Guest'] + roles = ( + frappe.qb.from_(table) + .where((table.parent == user) & (table.role.notin(["All", "Guest"]))) + .select(table.role) + .run(pluck=True) + ) + return roles + ["All", "Guest"] roles = frappe.cache().hget("roles", user, get) # filter standard if required if not with_standard: - roles = filter(lambda x: x not in ['All', 'Guest', 'Administrator'], roles) + roles = filter(lambda x: x not in ["All", "Guest", "Administrator"], roles) return roles + def get_doctype_roles(doctype, access_type="read"): """Returns a list of roles that are allowed to access passed doctype.""" meta = frappe.get_meta(doctype) return [d.role for d in meta.get("permissions") if d.get(access_type)] -def get_perms_for(roles, perm_doctype='DocPerm'): - '''Get perms for given roles''' - filters = { - 'permlevel': 0, - 'docstatus': 0, - 'role': ['in', roles] - } - return frappe.db.get_all(perm_doctype, fields=['*'], filters=filters) + +def get_perms_for(roles, perm_doctype="DocPerm"): + """Get perms for given roles""" + filters = {"permlevel": 0, "docstatus": 0, "role": ["in", roles]} + return frappe.db.get_all(perm_doctype, fields=["*"], filters=filters) + def get_doctypes_with_custom_docperms(): - '''Returns all the doctypes with Custom Docperms''' + """Returns all the doctypes with Custom Docperms""" - doctypes = frappe.db.get_all('Custom DocPerm', fields=['parent'], distinct=1) + doctypes = frappe.db.get_all("Custom DocPerm", fields=["parent"], distinct=1) return [d.parent for d in doctypes] + def can_set_user_permissions(doctype, docname=None): # System Manager can always set user permissions if frappe.session.user == "Administrator" or "System Manager" in frappe.get_roles(): @@ -396,46 +456,61 @@ def can_set_user_permissions(doctype, docname=None): return False # check if current user has a role that can set permission - if get_role_permissions(meta).set_user_permissions!=1: + if get_role_permissions(meta).set_user_permissions != 1: return False return True + def set_user_permission_if_allowed(doctype, name, user, with_message=False): - if get_role_permissions(frappe.get_meta(doctype), user).set_user_permissions!=1: + if get_role_permissions(frappe.get_meta(doctype), user).set_user_permissions != 1: add_user_permission(doctype, name, user) -def add_user_permission(doctype, name, user, ignore_permissions=False, applicable_for=None, - is_default=0, hide_descendants=0): - '''Add user permission''' + +def add_user_permission( + doctype, + name, + user, + ignore_permissions=False, + applicable_for=None, + is_default=0, + hide_descendants=0, +): + """Add user permission""" from frappe.core.doctype.user_permission.user_permission import user_permission_exists if not user_permission_exists(user, doctype, name, applicable_for): if not frappe.db.exists(doctype, name): frappe.throw(_("{0} {1} not found").format(_(doctype), name), frappe.DoesNotExistError) - frappe.get_doc(dict( - doctype='User Permission', - user=user, - allow=doctype, - for_value=name, - is_default=is_default, - applicable_for=applicable_for, - hide_descendants=hide_descendants, - )).insert(ignore_permissions=ignore_permissions) + frappe.get_doc( + dict( + doctype="User Permission", + user=user, + allow=doctype, + for_value=name, + is_default=is_default, + applicable_for=applicable_for, + hide_descendants=hide_descendants, + ) + ).insert(ignore_permissions=ignore_permissions) + def remove_user_permission(doctype, name, user): - user_permission_name = frappe.db.get_value('User Permission', - dict(user=user, allow=doctype, for_value=name)) - frappe.delete_doc('User Permission', user_permission_name) + user_permission_name = frappe.db.get_value( + "User Permission", dict(user=user, allow=doctype, for_value=name) + ) + frappe.delete_doc("User Permission", user_permission_name) + def clear_user_permissions_for_doctype(doctype, user=None): - filters = {'allow': doctype} + filters = {"allow": doctype} if user: - filters['user'] = user - user_permissions_for_doctype = frappe.db.get_all('User Permission', filters=filters) + filters["user"] = user + user_permissions_for_doctype = frappe.db.get_all("User Permission", filters=filters) for d in user_permissions_for_doctype: - frappe.delete_doc('User Permission', d.name) + frappe.delete_doc("User Permission", d.name) + def can_import(doctype, raise_exception=False): if not ("System Manager" in frappe.get_roles() or has_permission(doctype, "import")): @@ -445,24 +520,25 @@ def can_import(doctype, raise_exception=False): return False return True + def can_export(doctype, raise_exception=False): if "System Manager" in frappe.get_roles(): return True else: role_permissions = frappe.permissions.get_role_permissions(doctype) - has_access = role_permissions.get('export') or \ - role_permissions.get('if_owner').get('export') + has_access = role_permissions.get("export") or role_permissions.get("if_owner").get("export") if not has_access and raise_exception: raise frappe.PermissionError(_("You are not allowed to export {} doctype").format(doctype)) return has_access + def update_permission_property(doctype, role, permlevel, ptype, value=None, validate=True): - '''Update a property in Custom Perm''' + """Update a property in Custom Perm""" from frappe.core.doctype.doctype.doctype import validate_permissions_for_doctype + out = setup_custom_perms(doctype) - name = frappe.get_value('Custom DocPerm', dict(parent=doctype, role=role, - permlevel=permlevel)) + name = frappe.get_value("Custom DocPerm", dict(parent=doctype, role=role, permlevel=permlevel)) table = DocType("Custom DocPerm") frappe.qb.update(table).set(ptype, value).where(table.name == name).run() @@ -471,127 +547,167 @@ def update_permission_property(doctype, role, permlevel, ptype, value=None, vali return out + def setup_custom_perms(parent): - '''if custom permssions are not setup for the current doctype, set them up''' - if not frappe.db.exists('Custom DocPerm', dict(parent=parent)): + """if custom permssions are not setup for the current doctype, set them up""" + if not frappe.db.exists("Custom DocPerm", dict(parent=parent)): copy_perms(parent) return True + def add_permission(doctype, role, permlevel=0, ptype=None): - '''Add a new permission rule to the given doctype - for the given Role and Permission Level''' + """Add a new permission rule to the given doctype + for the given Role and Permission Level""" from frappe.core.doctype.doctype.doctype import validate_permissions_for_doctype + setup_custom_perms(doctype) - if frappe.db.get_value('Custom DocPerm', dict(parent=doctype, role=role, - permlevel=permlevel, if_owner=0)): + if frappe.db.get_value( + "Custom DocPerm", dict(parent=doctype, role=role, permlevel=permlevel, if_owner=0) + ): return if not ptype: - ptype = 'read' - - custom_docperm = frappe.get_doc({ - "doctype":"Custom DocPerm", - "__islocal": 1, - "parent": doctype, - "parenttype": "DocType", - "parentfield": "permissions", - "role": role, - "permlevel": permlevel, - ptype: 1, - }) + ptype = "read" + + custom_docperm = frappe.get_doc( + { + "doctype": "Custom DocPerm", + "__islocal": 1, + "parent": doctype, + "parenttype": "DocType", + "parentfield": "permissions", + "role": role, + "permlevel": permlevel, + ptype: 1, + } + ) custom_docperm.save() validate_permissions_for_doctype(doctype) return custom_docperm.name + def copy_perms(parent): - '''Copy all DocPerm in to Custom DocPerm for the given document''' - for d in frappe.get_all('DocPerm', fields='*', filters=dict(parent=parent)): - custom_perm = frappe.new_doc('Custom DocPerm') + """Copy all DocPerm in to Custom DocPerm for the given document""" + for d in frappe.get_all("DocPerm", fields="*", filters=dict(parent=parent)): + custom_perm = frappe.new_doc("Custom DocPerm") custom_perm.update(d) custom_perm.insert(ignore_permissions=True) + def reset_perms(doctype): """Reset permissions for given doctype.""" from frappe.desk.notifications import delete_notification_count_for + delete_notification_count_for(doctype) frappe.db.delete("Custom DocPerm", {"parent": doctype}) + def get_linked_doctypes(dt): - return list(set([dt] + [d.options for d in - frappe.get_meta(dt).get("fields", { - "fieldtype":"Link", - "ignore_user_permissions":("!=", 1), - "options": ("!=", "[Select]") - }) - ])) + return list( + set( + [dt] + + [ + d.options + for d in frappe.get_meta(dt).get( + "fields", + {"fieldtype": "Link", "ignore_user_permissions": ("!=", 1), "options": ("!=", "[Select]")}, + ) + ] + ) + ) + def get_doc_name(doc): - if not doc: return None + if not doc: + return None return doc if isinstance(doc, str) else doc.name + def allow_everything(): - ''' + """ returns a dict with access to everything eg. {"read": 1, "write": 1, ...} - ''' + """ perm = {ptype: 1 for ptype in rights} return perm + def get_allowed_docs_for_doctype(user_permissions, doctype): - ''' Returns all the docs from the passed user_permissions that are - allowed under provided doctype ''' + """Returns all the docs from the passed user_permissions that are + allowed under provided doctype""" return filter_allowed_docs_for_doctype(user_permissions, doctype, with_default_doc=False) + def filter_allowed_docs_for_doctype(user_permissions, doctype, with_default_doc=True): - ''' Returns all the docs from the passed user_permissions that are - allowed under provided doctype along with default doc value if with_default_doc is set ''' + """Returns all the docs from the passed user_permissions that are + allowed under provided doctype along with default doc value if with_default_doc is set""" allowed_doc = [] default_doc = None for doc in user_permissions: - if not doc.get('applicable_for') or doc.get('applicable_for') == doctype: - allowed_doc.append(doc.get('doc')) - if doc.get('is_default') or len(user_permissions) == 1 and with_default_doc: - default_doc = doc.get('doc') + if not doc.get("applicable_for") or doc.get("applicable_for") == doctype: + allowed_doc.append(doc.get("doc")) + if doc.get("is_default") or len(user_permissions) == 1 and with_default_doc: + default_doc = doc.get("doc") return (allowed_doc, default_doc) if with_default_doc else allowed_doc + def push_perm_check_log(log): - if frappe.flags.get('has_permission_check_logs') is None: + if frappe.flags.get("has_permission_check_logs") is None: return - frappe.flags.get('has_permission_check_logs').append(_(log)) + frappe.flags.get("has_permission_check_logs").append(_(log)) -def has_child_table_permission(child_doctype, ptype="read", child_doc=None, - verbose=False, user=None, raise_exception=True, parent_doctype=None): + +def has_child_table_permission( + child_doctype, + ptype="read", + child_doc=None, + verbose=False, + user=None, + raise_exception=True, + parent_doctype=None, +): parent_doc = None if child_doc: parent_doctype = child_doc.get("parenttype") - parent_doc = frappe.get_cached_doc({ - "doctype": parent_doctype, - "docname": child_doc.get("parent") - }) + parent_doc = frappe.get_cached_doc( + {"doctype": parent_doctype, "docname": child_doc.get("parent")} + ) if parent_doctype: if not is_parent_valid(child_doctype, parent_doctype): - frappe.throw(_("{0} is not a valid parent DocType for {1}").format( - frappe.bold(parent_doctype), - frappe.bold(child_doctype) - ), title=_("Invalid Parent DocType")) + frappe.throw( + _("{0} is not a valid parent DocType for {1}").format( + frappe.bold(parent_doctype), frappe.bold(child_doctype) + ), + title=_("Invalid Parent DocType"), + ) else: - frappe.throw(_("Please specify a valid parent DocType for {0}").format( - frappe.bold(child_doctype) - ), title=_("Parent DocType Required")) + frappe.throw( + _("Please specify a valid parent DocType for {0}").format(frappe.bold(child_doctype)), + title=_("Parent DocType Required"), + ) - return has_permission(parent_doctype, ptype=ptype, doc=parent_doc, - verbose=verbose, user=user, raise_exception=raise_exception) + return has_permission( + parent_doctype, + ptype=ptype, + doc=parent_doc, + verbose=verbose, + user=user, + raise_exception=raise_exception, + ) def is_parent_valid(child_doctype, parent_doctype): from frappe.core.utils import find + parent_meta = frappe.get_meta(parent_doctype) - child_table_field_exists = find(parent_meta.get_table_fields(), lambda d: d.options == child_doctype) + child_table_field_exists = find( + parent_meta.get_table_fields(), lambda d: d.options == child_doctype + ) return not parent_meta.istable and child_table_field_exists diff --git a/frappe/printing/doctype/letter_head/letter_head.py b/frappe/printing/doctype/letter_head/letter_head.py index 67c0d236e0..98c2fc7c2b 100644 --- a/frappe/printing/doctype/letter_head/letter_head.py +++ b/frappe/printing/doctype/letter_head/letter_head.py @@ -2,14 +2,15 @@ # License: MIT. See LICENSE import frappe -from frappe.utils import is_image, flt -from frappe.model.document import Document from frappe import _ +from frappe.model.document import Document +from frappe.utils import flt, is_image + class LetterHead(Document): def before_insert(self): # for better UX, let user set from attachment - self.source = 'Image' + self.source = "Image" def validate(self): self.set_image() @@ -20,24 +21,26 @@ class LetterHead(Document): frappe.throw(_("Letter Head cannot be both disabled and default")) if not self.is_default and not self.disabled: - if not frappe.db.exists('Letter Head', dict(is_default=1)): + if not frappe.db.exists("Letter Head", dict(is_default=1)): self.is_default = 1 def set_image(self): - if self.source=='Image': + if self.source == "Image": if self.image and is_image(self.image): self.image_width = flt(self.image_width) self.image_height = flt(self.image_height) - dimension = 'width' if self.image_width > self.image_height else 'height' - dimension_value = self.get('image_' + dimension) - self.content = f''' + dimension = "width" if self.image_width > self.image_height else "height" + dimension_value = self.get("image_" + dimension) + self.content = f"""
[\s]*administrator[\s]*
', print_html))
+ self.assertTrue(
+ re.findall(r'[\s]*administrator[\s]*
', print_html)
+ )
return print_html
def test_print_user_standard(self):
print_html = self.test_print_user("Standard")
- self.assertTrue(re.findall(r'\.print-format {[\s]*font-size: 9pt;', print_html))
- self.assertFalse(re.findall(r'th {[\s]*background-color: #eee;[\s]*}', print_html))
+ self.assertTrue(re.findall(r"\.print-format {[\s]*font-size: 9pt;", print_html))
+ self.assertFalse(re.findall(r"th {[\s]*background-color: #eee;[\s]*}", print_html))
self.assertFalse("font-family: serif;" in print_html)
def test_print_user_modern(self):
diff --git a/frappe/printing/doctype/print_format_field_template/print_format_field_template.py b/frappe/printing/doctype/print_format_field_template/print_format_field_template.py
index b66afdb6b1..428979b3ad 100644
--- a/frappe/printing/doctype/print_format_field_template/print_format_field_template.py
+++ b/frappe/printing/doctype/print_format_field_template/print_format_field_template.py
@@ -2,8 +2,8 @@
# For license information, please see license.txt
import frappe
-from frappe.model.document import Document
from frappe import _
+from frappe.model.document import Document
class PrintFormatFieldTemplate(Document):
diff --git a/frappe/printing/doctype/print_format_field_template/test_print_format_field_template.py b/frappe/printing/doctype/print_format_field_template/test_print_format_field_template.py
index f0b1329763..b55a492635 100644
--- a/frappe/printing/doctype/print_format_field_template/test_print_format_field_template.py
+++ b/frappe/printing/doctype/print_format_field_template/test_print_format_field_template.py
@@ -4,5 +4,6 @@
# import frappe
import unittest
+
class TestPrintFormatFieldTemplate(unittest.TestCase):
pass
diff --git a/frappe/printing/doctype/print_heading/print_heading.py b/frappe/printing/doctype/print_heading/print_heading.py
index 39c46ad152..c905e68d47 100644
--- a/frappe/printing/doctype/print_heading/print_heading.py
+++ b/frappe/printing/doctype/print_heading/print_heading.py
@@ -5,5 +5,6 @@
import frappe
from frappe.model.document import Document
+
class PrintHeading(Document):
pass
diff --git a/frappe/printing/doctype/print_heading/test_print_heading.py b/frappe/printing/doctype/print_heading/test_print_heading.py
index 7eaa1bc6ba..02eddb072f 100644
--- a/frappe/printing/doctype/print_heading/test_print_heading.py
+++ b/frappe/printing/doctype/print_heading/test_print_heading.py
@@ -1,8 +1,10 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2017, Frappe Technologies and Contributors
# License: MIT. See LICENSE
-import frappe
import unittest
+import frappe
+
+
class TestPrintHeading(unittest.TestCase):
pass
diff --git a/frappe/printing/doctype/print_settings/print_settings.py b/frappe/printing/doctype/print_settings/print_settings.py
index 3253cea2dc..f52d08e6ec 100644
--- a/frappe/printing/doctype/print_settings/print_settings.py
+++ b/frappe/printing/doctype/print_settings/print_settings.py
@@ -4,16 +4,13 @@
import frappe
from frappe import _
-from frappe.utils import cint
-
from frappe.model.document import Document
+from frappe.utils import cint
class PrintSettings(Document):
def validate(self):
- if self.pdf_page_size == "Custom" and not (
- self.pdf_page_height and self.pdf_page_width
- ):
+ if self.pdf_page_size == "Custom" and not (self.pdf_page_height and self.pdf_page_width):
frappe.throw(_("Page height and width cannot be zero"))
def on_update(self):
diff --git a/frappe/printing/doctype/print_settings/test_print_settings.py b/frappe/printing/doctype/print_settings/test_print_settings.py
index 82883eaee5..ba22df4438 100644
--- a/frappe/printing/doctype/print_settings/test_print_settings.py
+++ b/frappe/printing/doctype/print_settings/test_print_settings.py
@@ -3,5 +3,6 @@
# License: MIT. See LICENSE
import unittest
+
class TestPrintSettings(unittest.TestCase):
pass
diff --git a/frappe/printing/doctype/print_style/print_style.py b/frappe/printing/doctype/print_style/print_style.py
index 7985c006f4..00de829deb 100644
--- a/frappe/printing/doctype/print_style/print_style.py
+++ b/frappe/printing/doctype/print_style/print_style.py
@@ -5,11 +5,14 @@
import frappe
from frappe.model.document import Document
+
class PrintStyle(Document):
def validate(self):
- if (self.standard==1
+ if (
+ self.standard == 1
and not frappe.local.conf.get("developer_mode")
- and not (frappe.flags.in_import or frappe.flags.in_test)):
+ and not (frappe.flags.in_import or frappe.flags.in_test)
+ ):
frappe.throw(frappe._("Standard Print Style cannot be changed. Please duplicate to edit."))
@@ -19,4 +22,5 @@ class PrintStyle(Document):
def export_doc(self):
# export
from frappe.modules.utils import export_module_json
- export_module_json(self, self.standard == 1, 'Printing')
+
+ export_module_json(self, self.standard == 1, "Printing")
diff --git a/frappe/printing/doctype/print_style/test_print_style.py b/frappe/printing/doctype/print_style/test_print_style.py
index cbf5c465d1..ad2b61cc87 100644
--- a/frappe/printing/doctype/print_style/test_print_style.py
+++ b/frappe/printing/doctype/print_style/test_print_style.py
@@ -1,8 +1,10 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2017, Frappe Technologies and Contributors
# License: MIT. See LICENSE
-import frappe
import unittest
+import frappe
+
+
class TestPrintStyle(unittest.TestCase):
pass
diff --git a/frappe/printing/page/print/print.py b/frappe/printing/page/print/print.py
index 7ddf68c30d..82ad22656d 100644
--- a/frappe/printing/page/print/print.py
+++ b/frappe/printing/page/print/print.py
@@ -1,11 +1,12 @@
import frappe
+
@frappe.whitelist()
def get_print_settings_to_show(doctype, docname):
doc = frappe.get_doc(doctype, docname)
- print_settings = frappe.get_single('Print Settings')
+ print_settings = frappe.get_single("Print Settings")
- if hasattr(doc, 'get_print_settings'):
+ if hasattr(doc, "get_print_settings"):
fields = doc.get_print_settings() or []
else:
return []
diff --git a/frappe/printing/page/print_format_builder/print_format_builder.py b/frappe/printing/page/print_format_builder/print_format_builder.py
index fae564d3c3..67273120c2 100644
--- a/frappe/printing/page/print_format_builder/print_format_builder.py
+++ b/frappe/printing/page/print_format_builder/print_format_builder.py
@@ -1,8 +1,9 @@
import frappe
+
@frappe.whitelist()
-def create_custom_format(doctype, name, based_on='Standard', beta=False):
- doc = frappe.new_doc('Print Format')
+def create_custom_format(doctype, name, based_on="Standard", beta=False):
+ doc = frappe.new_doc("Print Format")
doc.doc_type = doctype
doc.name = name
beta = frappe.parse_json(beta)
@@ -11,7 +12,8 @@ def create_custom_format(doctype, name, based_on='Standard', beta=False):
doc.print_format_builder_beta = 1
else:
doc.print_format_builder = 1
- doc.format_data = frappe.db.get_value('Print Format', based_on, 'format_data') \
- if based_on != 'Standard' else None
+ doc.format_data = (
+ frappe.db.get_value("Print Format", based_on, "format_data") if based_on != "Standard" else None
+ )
doc.insert()
- return doc
\ No newline at end of file
+ return doc
diff --git a/frappe/printing/page/print_format_builder_beta/print_format_builder_beta.py b/frappe/printing/page/print_format_builder_beta/print_format_builder_beta.py
index e13412cd07..668be8d05a 100644
--- a/frappe/printing/page/print_format_builder_beta/print_format_builder_beta.py
+++ b/frappe/printing/page/print_format_builder_beta/print_format_builder_beta.py
@@ -2,9 +2,11 @@
# MIT License. See license.txt
from __future__ import unicode_literals
-import frappe
+
import functools
+import frappe
+
@frappe.whitelist()
def get_google_fonts():
diff --git a/frappe/public/js/frappe/desk.js b/frappe/public/js/frappe/desk.js
index 51ada70948..72e8010605 100644
--- a/frappe/public/js/frappe/desk.js
+++ b/frappe/public/js/frappe/desk.js
@@ -59,8 +59,12 @@ frappe.Application = class Application {
shortcut: 'shift+ctrl+g',
description: __('Switch Theme'),
action: () => {
- frappe.theme_switcher = new frappe.ui.ThemeSwitcher();
- frappe.theme_switcher.show();
+ if (frappe.theme_switcher && frappe.theme_switcher.dialog.is_visible) {
+ frappe.theme_switcher.hide();
+ } else {
+ frappe.theme_switcher = new frappe.ui.ThemeSwitcher();
+ frappe.theme_switcher.show();
+ }
}
});
diff --git a/frappe/public/js/frappe/form/controls/base_control.js b/frappe/public/js/frappe/form/controls/base_control.js
index 4ee52d16b8..e22235f60f 100644
--- a/frappe/public/js/frappe/form/controls/base_control.js
+++ b/frappe/public/js/frappe/form/controls/base_control.js
@@ -44,6 +44,8 @@ frappe.ui.form.Control = class BaseControl {
}
if ((!this.doctype && !this.docname) || this.df.parenttype === 'Web Form' || this.df.is_web_form) {
+ let status = "Write";
+
// like in case of a dialog box
if (cint(this.df.hidden)) {
// eslint-disable-next-line
@@ -55,10 +57,10 @@ frappe.ui.form.Control = class BaseControl {
if(explain) console.log("By Hidden Dependency: None"); // eslint-disable-line no-console
return "None";
- } else if (cint(this.df.read_only || this.df.is_virtual)) {
+ } else if (cint(this.df.read_only || this.df.is_virtual || this.df.fieldtype === "Read Only")) {
// eslint-disable-next-line
if (explain) console.log("By Read Only: Read"); // eslint-disable-line no-console
- return "Read";
+ status = "Read";
} else if ((this.grid &&
this.grid.display_status == 'Read') ||
@@ -67,10 +69,16 @@ frappe.ui.form.Control = class BaseControl {
this.layout.grid.display_status == 'Read')) {
// parent grid is read
if (explain) console.log("By Parent Grid Read-only: Read"); // eslint-disable-line no-console
- return "Read";
+ status = "Read";
}
- return "Write";
+ if (
+ status === "Read" &&
+ is_null(this.value) &&
+ !in_list(["HTML", "Image", "Button"], this.df.fieldtype)
+ ) status = "None";
+
+ return status;
}
var status = frappe.perm.get_field_display_status(this.df,
diff --git a/frappe/public/js/frappe/form/controls/control.js b/frappe/public/js/frappe/form/controls/control.js
index bd04938e35..90e8697b1c 100644
--- a/frappe/public/js/frappe/form/controls/control.js
+++ b/frappe/public/js/frappe/form/controls/control.js
@@ -23,7 +23,6 @@ import './table';
import './color';
import './signature';
import './password';
-import './read_only';
import './button';
import './html';
import './markdown_editor';
diff --git a/frappe/public/js/frappe/form/controls/data.js b/frappe/public/js/frappe/form/controls/data.js
index f4c9849528..95abba616a 100644
--- a/frappe/public/js/frappe/form/controls/data.js
+++ b/frappe/public/js/frappe/form/controls/data.js
@@ -262,3 +262,5 @@ frappe.ui.form.ControlData = class ControlData extends frappe.ui.form.ControlInp
return this.grid || this.layout && this.layout.grid;
}
};
+
+frappe.ui.form.ControlReadOnly = frappe.ui.form.ControlData;
diff --git a/frappe/public/js/frappe/form/controls/geolocation.js b/frappe/public/js/frappe/form/controls/geolocation.js
index 280eac3941..688e7da3e0 100644
--- a/frappe/public/js/frappe/form/controls/geolocation.js
+++ b/frappe/public/js/frappe/form/controls/geolocation.js
@@ -58,7 +58,7 @@ frappe.ui.form.ControlGeolocation = class ControlGeolocation extends frappe.ui.f
}));
this.add_non_group_layers(data_layers, this.editableLayers);
try {
- this.map.flyToBounds(this.editableLayers.getBounds(), {
+ this.map.fitBounds(this.editableLayers.getBounds(), {
padding: [50,50]
});
}
@@ -66,10 +66,10 @@ frappe.ui.form.ControlGeolocation = class ControlGeolocation extends frappe.ui.f
// suppress error if layer has a point.
}
this.editableLayers.addTo(this.map);
- this.map._onResize();
- } else if ((value===undefined) || (value == JSON.stringify(new L.FeatureGroup().toGeoJSON()))) {
- this.locate_control.start();
+ } else {
+ this.map.setView(frappe.utils.map_defaults.center, frappe.utils.map_defaults.zoom);
}
+ this.map.invalidateSize();
}
bind_leaflet_map() {
@@ -97,8 +97,7 @@ frappe.ui.form.ControlGeolocation = class ControlGeolocation extends frappe.ui.f
});
L.Icon.Default.imagePath = '/assets/frappe/images/leaflet/';
- this.map = L.map(this.map_id).setView(frappe.utils.map_defaults.center,
- frappe.utils.map_defaults.zoom);
+ this.map = L.map(this.map_id);
L.tileLayer(frappe.utils.map_defaults.tiles,
frappe.utils.map_defaults.options).addTo(this.map);
@@ -146,9 +145,8 @@ frappe.ui.form.ControlGeolocation = class ControlGeolocation extends frappe.ui.f
};
// create control and add to map
- var drawControl = new L.Control.Draw(options);
-
- this.map.addControl(drawControl);
+ this.drawControl = new L.Control.Draw(options);
+ this.map.addControl(this.drawControl);
this.map.on('draw:created', (e) => {
var type = e.layerType,
diff --git a/frappe/public/js/frappe/form/controls/read_only.js b/frappe/public/js/frappe/form/controls/read_only.js
deleted file mode 100644
index 2f1d1a2bca..0000000000
--- a/frappe/public/js/frappe/form/controls/read_only.js
+++ /dev/null
@@ -1,8 +0,0 @@
-frappe.ui.form.ControlReadOnly = class ControlReadOnly extends frappe.ui.form.ControlData {
- get_status(explain) {
- var status = super.get_status(explain);
- if(status==="Write")
- status = "Read";
- return;
- }
-};
diff --git a/frappe/public/js/frappe/form/footer/form_timeline.js b/frappe/public/js/frappe/form/footer/form_timeline.js
index 0070d384d7..203859a144 100644
--- a/frappe/public/js/frappe/form/footer/form_timeline.js
+++ b/frappe/public/js/frappe/form/footer/form_timeline.js
@@ -429,13 +429,13 @@ class FormTimeline extends BaseTimeline {
}
if (this.frm.doctype === "Communication") {
- args.txt = "";
+ args.message = "";
args.last_email = this.frm.doc;
args.recipients = this.frm.doc.sender;
args.subject = __("Re: {0}", [this.frm.doc.subject]);
} else {
const comment_value = frappe.markdown(this.frm.comment_box.get_value());
- args.txt = strip_html(comment_value) ? comment_value : '';
+ args.message = strip_html(comment_value) ? comment_value : '';
}
new frappe.views.CommunicationComposer(args);
diff --git a/frappe/public/js/frappe/model/perm.js b/frappe/public/js/frappe/model/perm.js
index 0eabfdd337..3ea9c6bc95 100644
--- a/frappe/public/js/frappe/model/perm.js
+++ b/frappe/public/js/frappe/model/perm.js
@@ -225,7 +225,10 @@ $.extend(frappe.perm, {
if (explain) console.log("By Workflow:" + status);
// read only field is checked
- if (status === "Write" && cint(df.read_only)) {
+ if (status === "Write" && (
+ cint(df.read_only) ||
+ df.fieldtype === "Read Only"
+ )) {
status = "Read";
}
if (explain) console.log("By Read Only:" + status);
@@ -276,4 +279,4 @@ $.extend(frappe.perm, {
return allowed_docs;
}
}
-});
\ No newline at end of file
+});
diff --git a/frappe/public/js/frappe/ui/field_group.js b/frappe/public/js/frappe/ui/field_group.js
index 1936f5115e..eb3dcc4f89 100644
--- a/frappe/public/js/frappe/ui/field_group.js
+++ b/frappe/public/js/frappe/ui/field_group.js
@@ -22,17 +22,15 @@ frappe.ui.FieldGroup = class FieldGroup extends frappe.ui.form.Layout {
super.make();
this.refresh();
// set default
- $.each(this.fields_list, function(i, field) {
- if (field.df["default"]) {
- let def_value = field.df["default"];
+ $.each(this.fields_list, (_, field) => {
+ if (!is_null(field.df.default)) {
+ let def_value = field.df.default;
- if (def_value == 'Today' && field.df["fieldtype"] == 'Date') {
+ if (def_value === "Today" && field.df.fieldtype === "Date") {
def_value = frappe.datetime.get_today();
}
- field.set_input(def_value);
- // if default and has depends_on, render its fields.
- me.refresh_dependency();
+ this.set_value(field.df.fieldname, def_value);
}
})
@@ -129,6 +127,7 @@ frappe.ui.FieldGroup = class FieldGroup extends frappe.ui.form.Layout {
if (f) {
f.set_value(val).then(() => {
f.set_input(val);
+ f.refresh();
this.refresh_dependency();
resolve();
});
@@ -138,6 +137,10 @@ frappe.ui.FieldGroup = class FieldGroup extends frappe.ui.form.Layout {
});
}
+ has_field(fieldname) {
+ return !!this.fields_dict[fieldname];
+ }
+
set_input(key, val) {
return this.set_value(key, val);
}
diff --git a/frappe/public/js/frappe/ui/theme_switcher.js b/frappe/public/js/frappe/ui/theme_switcher.js
index 16ba16e5d5..d20afae529 100644
--- a/frappe/public/js/frappe/ui/theme_switcher.js
+++ b/frappe/public/js/frappe/ui/theme_switcher.js
@@ -25,6 +25,8 @@ frappe.ui.ThemeSwitcher = class ThemeSwitcher {
increment_by = 1;
} else if (key === "left") {
increment_by = -1;
+ } else if (e.keyCode === 13) { // keycode 13 is for 'enter'
+ this.hide();
} else {
return;
}
diff --git a/frappe/public/js/frappe/ui/toolbar/fuzzy_match.js b/frappe/public/js/frappe/ui/toolbar/fuzzy_match.js
new file mode 100644
index 0000000000..59fccbccc5
--- /dev/null
+++ b/frappe/public/js/frappe/ui/toolbar/fuzzy_match.js
@@ -0,0 +1,191 @@
+// LICENSE
+//
+// This software is dual-licensed to the public domain and under the following
+// license: you are granted a perpetual, irrevocable license to copy, modify,
+// publish, and distribute this file as you see fit.
+//
+// VERSION
+// 0.1.0 (2016-03-28) Initial release
+//
+// AUTHOR
+// Forrest Smith
+//
+// CONTRIBUTORS
+// J�rgen Tjern� - async helper
+// Anurag Awasthi - updated to 0.2.0
+
+const SEQUENTIAL_BONUS = 15; // bonus for adjacent matches
+const SEPARATOR_BONUS = 30; // bonus if match occurs after a separator
+const CAMEL_BONUS = 30; // bonus if match is uppercase and prev is lower
+const FIRST_LETTER_BONUS = 15; // bonus if the first letter is matched
+
+const LEADING_LETTER_PENALTY = -5; // penalty applied for every letter in str before the first match
+const MAX_LEADING_LETTER_PENALTY = -15; // maximum penalty for leading letters
+const UNMATCHED_LETTER_PENALTY = -1;
+
+
+/**
+ * Does a fuzzy search to find pattern inside a string.
+ * @param {*} pattern string pattern to search for
+ * @param {*} str string string which is being searched
+ * @returns [boolean, number] a boolean which tells if pattern was
+ * found or not and a search score
+ */
+export function fuzzy_match(pattern, str) {
+ const recursion_count = 0;
+ const recursion_limit = 10;
+ const matches = [];
+ const max_matches = 256;
+
+ return fuzzy_match_recursive(
+ pattern,
+ str,
+ 0 /* pattern_cur_index */,
+ 0 /* str_curr_index */,
+ null /* src_matches */,
+ matches,
+ max_matches,
+ 0 /* next_match */,
+ recursion_count,
+ recursion_limit
+ );
+}
+
+function fuzzy_match_recursive(
+ pattern,
+ str,
+ pattern_cur_index,
+ str_curr_index,
+ src_matches,
+ matches,
+ max_matches,
+ next_match,
+ recursion_count,
+ recursion_limit
+) {
+ let out_score = 0;
+
+ // Return if recursion limit is reached.
+ if (++recursion_count >= recursion_limit) {
+ return [false, out_score];
+ }
+
+ // Return if we reached ends of strings.
+ if (pattern_cur_index === pattern.length || str_curr_index === str.length) {
+ return [false, out_score];
+ }
+
+ // Recursion params
+ let recursive_match = false;
+ let best_recursive_matches = [];
+ let best_recursive_score = 0;
+
+ // Loop through pattern and str looking for a match.
+ let first_match = true;
+ while (pattern_cur_index < pattern.length && str_curr_index < str.length) {
+ // Match found.
+ if (
+ pattern[pattern_cur_index].toLowerCase() === str[str_curr_index].toLowerCase()
+ ) {
+ if (next_match >= max_matches) {
+ return [false, out_score];
+ }
+
+ if (first_match && src_matches) {
+ matches = [...src_matches];
+ first_match = false;
+ }
+
+ const recursive_matches = [];
+ const [matched, recursive_score] = fuzzy_match_recursive(
+ pattern,
+ str,
+ pattern_cur_index,
+ str_curr_index + 1,
+ matches,
+ recursive_matches,
+ max_matches,
+ next_match,
+ recursion_count,
+ recursion_limit
+ );
+
+ if (matched) {
+ // Pick best recursive score.
+ if (!recursive_match || recursive_score > best_recursive_score) {
+ best_recursive_matches = [...recursive_matches];
+ best_recursive_score = recursive_score;
+ }
+ recursive_match = true;
+ }
+
+ matches[next_match++] = str_curr_index;
+ ++pattern_cur_index;
+ }
+ ++str_curr_index;
+ }
+
+ const matched = pattern_cur_index === pattern.length;
+
+ if (matched) {
+ out_score = 100;
+
+ // Apply leading letter penalty
+ let penalty = LEADING_LETTER_PENALTY * matches[0];
+ penalty =
+ penalty < MAX_LEADING_LETTER_PENALTY
+ ? MAX_LEADING_LETTER_PENALTY
+ : penalty;
+ out_score += penalty;
+
+ //Apply unmatched penalty
+ const unmatched = str.length - next_match;
+ out_score += UNMATCHED_LETTER_PENALTY * unmatched;
+
+ // Apply ordering bonuses
+ for (let i = 0; i < next_match; i++) {
+ const curr_idx = matches[i];
+
+ if (i > 0) {
+ const prev_idx = matches[i - 1];
+ if (curr_idx == prev_idx + 1) {
+ out_score += SEQUENTIAL_BONUS;
+ }
+ }
+
+ // Check for bonuses based on neighbor character value.
+ if (curr_idx > 0) {
+ // Camel case
+ const neighbor = str[curr_idx - 1];
+ const curr = str[curr_idx];
+ if (
+ neighbor !== neighbor.toUpperCase() &&
+ curr !== curr.toLowerCase()
+ ) {
+ out_score += CAMEL_BONUS;
+ }
+ const is_neighbour_separator = neighbor == "_" || neighbor == " ";
+ if (is_neighbour_separator) {
+ out_score += SEPARATOR_BONUS;
+ }
+ } else {
+ // First letter
+ out_score += FIRST_LETTER_BONUS;
+ }
+ }
+
+ // Return best result
+ if (recursive_match && (!matched || best_recursive_score > out_score)) {
+ // Recursive score is better than "this"
+ matches = [...best_recursive_matches];
+ out_score = best_recursive_score;
+ return [true, out_score];
+ } else if (matched) {
+ // "this" score is better than recursive
+ return [true, out_score];
+ } else {
+ return [false, out_score];
+ }
+ }
+ return [false, out_score];
+}
diff --git a/frappe/public/js/frappe/ui/toolbar/search_utils.js b/frappe/public/js/frappe/ui/toolbar/search_utils.js
index 9700276568..1571522489 100644
--- a/frappe/public/js/frappe/ui/toolbar/search_utils.js
+++ b/frappe/public/js/frappe/ui/toolbar/search_utils.js
@@ -1,4 +1,6 @@
frappe.provide('frappe.search');
+import { fuzzy_match } from './fuzzy_match.js';
+
frappe.search.utils = {
setup_recent: function() {
@@ -533,101 +535,46 @@ frappe.search.utils = {
},
fuzzy_search: function(keywords, _item) {
- // Returns 10 for case-perfect contain, 0 for not found
- // 9 for perfect contain,
- // 0 - 6 for fuzzy contain
-
- // **Specific use-case step**
keywords = keywords || '';
var item = __(_item || '');
- var item_without_hyphen = item.replace(/-/g, " ");
-
- var item_length = item.length;
- var query_length = keywords.length;
- var length_ratio = query_length / item_length;
- var max_skips = 3, max_mismatch_len = 2;
-
- if (query_length > item_length) {
- return 0;
- }
-
- // check for perfect string matches or
- // matches that start with the keyword
- if ([item, item_without_hyphen].includes(keywords)
- || [item, item_without_hyphen].some((txt) => txt.toLowerCase().indexOf(keywords) === 0)) {
- return 10 + length_ratio;
- }
-
- if (item.indexOf(keywords) !== -1 && keywords !== keywords.toLowerCase()) {
- return 9 + length_ratio;
- }
-
- item = item.toLowerCase();
- keywords = keywords.toLowerCase();
-
- if (item.indexOf(keywords) !== -1) {
- return 8 + length_ratio;
- }
-
- var skips = 0, mismatches = 0;
- outer: for (var i = 0, j = 0; i < query_length; i++) {
- if (mismatches !== 0) skips++;
- if (skips > max_skips) return 0;
- var k_ch = keywords.charCodeAt(i);
- mismatches = 0;
- while (j < item_length) {
- if (item.charCodeAt(j++) === k_ch) {
- continue outer;
- }
- if(++mismatches > max_mismatch_len) return 0 ;
- }
- return 0;
- }
-
- // Since indexOf didn't pass, there will be atleast 1 skip
- // hence no divide by zero, but just to be safe
- if((skips + mismatches) > 0) {
- return (5 + length_ratio)/(skips + mismatches);
- } else {
- return 0;
- }
+ var match = fuzzy_match(keywords, item);
+ return match[1];
},
bolden_match_part: function(str, subseq) {
- var rendered = "";
- if(this.fuzzy_search(subseq, str) === 0) {
+ if (fuzzy_match(subseq, str)[0] === false) {
return str;
- } else if(this.fuzzy_search(subseq, str) > 6) {
- var regEx = new RegExp("("+ subseq +")", "ig");
- return str.replace(regEx, '$1');
- } else {
- var str_orig = str;
- var str = str.toLowerCase();
- var str_len = str.length;
- var subseq = subseq.toLowerCase();
-
- outer: for(var i = 0, j = 0; i < subseq.length; i++) {
- var sub_ch = subseq.charCodeAt(i);
- while(j < str_len) {
- if(str.charCodeAt(j) === sub_ch) {
- var str_char = str_orig.charAt(j);
- if(str_char === str_char.toLowerCase()) {
- rendered += '' + subseq.charAt(i) + '';
- } else {
- rendered += '' + subseq.charAt(i).toUpperCase() + '';
- }
- j++;
- continue outer;
+ }
+ if (str.indexOf(subseq) == 0) {
+ var tail = str.split(subseq)[1];
+ return '' + subseq + '' + tail;
+ }
+ var rendered = "";
+ var str_orig = str;
+ var str_len = str.length;
+ str = str.toLowerCase();
+ subseq = subseq.toLowerCase();
+
+ outer: for (var i = 0, j = 0; i < subseq.length; i++) {
+ var sub_ch = subseq.charCodeAt(i);
+ while (j < str_len) {
+ if (str.charCodeAt(j) === sub_ch) {
+ var str_char = str_orig.charAt(j);
+ if (str_char === str_char.toLowerCase()) {
+ rendered += '' + subseq.charAt(i) + '';
+ } else {
+ rendered += '' + subseq.charAt(i).toUpperCase() + '';
}
- rendered += str_orig.charAt(j);
j++;
+ continue outer;
}
- return str_orig;
+ rendered += str_orig.charAt(j);
+ j++;
}
- rendered += str_orig.slice(j);
- return rendered;
+ return str_orig;
}
-
+ rendered += str_orig.slice(j);
+ return rendered;
},
get_executables(keywords) {
diff --git a/frappe/public/js/frappe/views/communication.js b/frappe/public/js/frappe/views/communication.js
index 1d219a7044..90d81c10e5 100755
--- a/frappe/public/js/frappe/views/communication.js
+++ b/frappe/public/js/frappe/views/communication.js
@@ -100,6 +100,17 @@ frappe.views.CommunicationComposer = class {
300
)
},
+ {
+ fieldtype: "Button",
+ label: __("Add Signature"),
+ fieldname: 'add_signature',
+ hidden: 1,
+ click: async () => {
+ let sender_email = this.dialog.get_value('sender') || "";
+ this.content_set = false;
+ await this.set_content(sender_email);
+ }
+ },
{ fieldtype: "Section Break" },
{
label: __("Send me a copy"),
@@ -146,14 +157,16 @@ frappe.views.CommunicationComposer = class {
});
if (email_accounts.length) {
+ this.user_email_accounts = email_accounts.map(function(e) {
+ return e.email_id;
+ });
+
fields.unshift({
label: __("From"),
fieldtype: "Select",
reqd: 1,
fieldname: "sender",
- options: email_accounts.map(function(e) {
- return e.email_id;
- })
+ options: this.user_email_accounts
});
}
@@ -177,9 +190,15 @@ frappe.views.CommunicationComposer = class {
this.setup_email();
this.setup_email_template();
this.setup_last_edited_communication();
+ this.setup_add_signature_button();
this.set_values();
}
+ setup_add_signature_button() {
+ let has_sender = this.dialog.has_field('sender');
+ this.dialog.set_df_property('add_signature', 'hidden', !has_sender);
+ }
+
setup_multiselect_queries() {
['recipients', 'cc', 'bcc'].forEach(field => {
this.dialog.fields_dict[field].get_data = () => {
@@ -239,7 +258,9 @@ frappe.views.CommunicationComposer = class {
// some email clients (outlook) may not send the message id to identify
// the thread. So as a backup we use the name of the document as identifier
const identifier = `#${this.frm.doc.name}`;
- if (!this.subject.includes(identifier)) {
+
+ // converting to str for int names
+ if (!cstr(this.subject).includes(identifier)) {
this.subject = `${this.subject} (${identifier})`;
}
}
@@ -350,7 +371,7 @@ frappe.views.CommunicationComposer = class {
}
async set_values_from_last_edited_communication() {
- if (this.txt || this.message) return;
+ if (this.message) return;
const last_edited = this.get_last_edited_communication();
if (!last_edited.content) return;
@@ -709,10 +730,10 @@ frappe.views.CommunicationComposer = class {
}
}
- async set_content() {
+ async set_content(sender_email) {
if (this.content_set) return;
- let message = this.txt || this.message || "";
+ let message = this.message || "";
if (!message && this.frm) {
const { doctype, docname } = this.frm;
message = await localforage.getItem(doctype + docname) || "";
@@ -722,26 +743,41 @@ frappe.views.CommunicationComposer = class {
this.content_set = true;
}
- message += await this.get_signature();
+ message += await this.get_signature(sender_email || null);
- if (this.is_a_reply) {
+ if (this.is_a_reply && !this.reply_set) {
message += this.get_earlier_reply();
}
await this.dialog.set_value("content", message);
}
- async get_signature() {
+ async get_signature(sender_email) {
let signature = frappe.boot.user.email_signature;
if (!signature) {
- const response = await frappe.db.get_value(
- 'Email Account',
- {'default_outgoing': 1, 'add_signature': 1},
- 'signature'
- );
+ let filters = {
+ 'add_signature': 1
+ };
+
+ if (sender_email) {
+ filters['email_id'] = sender_email;
+ } else {
+ filters['default_outgoing'] = 1;
+ }
+
+ const email = await frappe.db.get_list("Email Account", {
+ filters: filters,
+ fields: ['signature', 'email_id'],
+ limit: 1
+ });
+
+ signature = email && email[0].signature;
- signature = response.message.signature;
+ if (this.user_email_accounts &&
+ this.user_email_accounts.includes(email[0].email_id)) {
+ this.dialog.set_value('sender', email[0].email_id);
+ }
}
if (!signature) return "";
@@ -754,6 +790,8 @@ frappe.views.CommunicationComposer = class {
}
get_earlier_reply() {
+ this.reply_set = false;
+
const last_email = (
this.last_email
|| this.frm && this.frm.timeline.get_last_email(true)
@@ -777,6 +815,8 @@ frappe.views.CommunicationComposer = class {
last_email.communication_date || last_email.creation
);
+ this.reply_set = true;
+
return `
{}
'.format(self.reason) if self.reason else None
+ "type": "Energy Point",
+ "document_type": self.reference_doctype,
+ "document_name": self.reference_name,
+ "subject": get_notification_message(self),
+ "from_user": reference_user,
+ "email_content": "{}
".format(self.reason) if self.reason else None,
}
enqueue_create_notification(self.user, notification_doc)
def on_trash(self):
- if self.type == 'Revert':
- reference_log = frappe.get_doc('Energy Point Log', self.revert_of)
+ if self.type == "Revert":
+ reference_log = frappe.get_doc("Energy Point Log", self.revert_of)
reference_log.reverted = 0
reference_log.save()
@frappe.whitelist()
def revert(self, reason, ignore_permissions=False):
if not ignore_permissions:
- frappe.only_for('System Manager')
+ frappe.only_for("System Manager")
- if self.type != 'Auto':
- frappe.throw(_('This document cannot be reverted'))
+ if self.type != "Auto":
+ frappe.throw(_("This document cannot be reverted"))
- if self.get('reverted'):
+ if self.get("reverted"):
return
self.reverted = 1
self.save(ignore_permissions=True)
- revert_log = frappe.get_doc({
- 'doctype': 'Energy Point Log',
- 'points': -(self.points),
- 'type': 'Revert',
- 'user': self.user,
- 'reason': reason,
- 'reference_doctype': self.reference_doctype,
- 'reference_name': self.reference_name,
- 'revert_of': self.name
- }).insert(ignore_permissions=True)
+ revert_log = frappe.get_doc(
+ {
+ "doctype": "Energy Point Log",
+ "points": -(self.points),
+ "type": "Revert",
+ "user": self.user,
+ "reason": reason,
+ "reference_doctype": self.reference_doctype,
+ "reference_name": self.reference_name,
+ "revert_of": self.name,
+ }
+ ).insert(ignore_permissions=True)
return revert_log
+
def get_notification_message(doc):
owner_name = get_fullname(doc.owner)
points = doc.points
title = get_title(doc.reference_doctype, doc.reference_name)
- if doc.type == 'Auto':
- owner_name = frappe.bold('You')
+ if doc.type == "Auto":
+ owner_name = frappe.bold("You")
if points == 1:
- message = _('{0} gained {1} point for {2} {3}')
+ message = _("{0} gained {1} point for {2} {3}")
else:
- message = _('{0} gained {1} points for {2} {3}')
+ message = _("{0} gained {1} points for {2} {3}")
message = message.format(owner_name, frappe.bold(points), doc.rule, get_title_html(title))
- elif doc.type == 'Appreciation':
+ elif doc.type == "Appreciation":
if points == 1:
- message = _('{0} appreciated your work on {1} with {2} point')
+ message = _("{0} appreciated your work on {1} with {2} point")
else:
- message = _('{0} appreciated your work on {1} with {2} points')
+ message = _("{0} appreciated your work on {1} with {2} points")
message = message.format(frappe.bold(owner_name), get_title_html(title), frappe.bold(points))
- elif doc.type == 'Criticism':
+ elif doc.type == "Criticism":
if points == 1:
- message = _('{0} criticized your work on {1} with {2} point')
+ message = _("{0} criticized your work on {1} with {2} point")
else:
- message = _('{0} criticized your work on {1} with {2} points')
+ message = _("{0} criticized your work on {1} with {2} points")
message = message.format(frappe.bold(owner_name), get_title_html(title), frappe.bold(points))
- elif doc.type == 'Revert':
+ elif doc.type == "Revert":
if points == 1:
- message = _('{0} reverted your point on {1}')
+ message = _("{0} reverted your point on {1}")
else:
- message = _('{0} reverted your points on {1}')
+ message = _("{0} reverted your points on {1}")
message = message.format(frappe.bold(owner_name), get_title_html(title))
return message
+
def get_alert_dict(doc):
alert_dict = frappe._dict()
owner_name = get_fullname(doc.owner)
@@ -121,46 +134,38 @@ def get_alert_dict(doc):
doc_link = get_link_to_form(doc.reference_doctype, doc.reference_name)
points = doc.points
bold_points = frappe.bold(doc.points)
- if doc.type == 'Auto':
+ if doc.type == "Auto":
if points == 1:
- message = _('You gained {0} point')
+ message = _("You gained {0} point")
else:
- message = _('You gained {0} points')
+ message = _("You gained {0} points")
alert_dict.message = message.format(bold_points)
- alert_dict.indicator = 'green'
- elif doc.type == 'Appreciation':
+ alert_dict.indicator = "green"
+ elif doc.type == "Appreciation":
if points == 1:
- message = _('{0} appreciated your work on {1} with {2} point')
+ message = _("{0} appreciated your work on {1} with {2} point")
else:
- message = _('{0} appreciated your work on {1} with {2} points')
- alert_dict.message = message.format(
- owner_name,
- doc_link,
- bold_points
- )
- alert_dict.indicator = 'green'
- elif doc.type == 'Criticism':
+ message = _("{0} appreciated your work on {1} with {2} points")
+ alert_dict.message = message.format(owner_name, doc_link, bold_points)
+ alert_dict.indicator = "green"
+ elif doc.type == "Criticism":
if points == 1:
- message = _('{0} criticized your work on {1} with {2} point')
+ message = _("{0} criticized your work on {1} with {2} point")
else:
- message = _('{0} criticized your work on {1} with {2} points')
+ message = _("{0} criticized your work on {1} with {2} points")
- alert_dict.message = message.format(
- owner_name,
- doc_link,
- bold_points
- )
- alert_dict.indicator = 'red'
- elif doc.type == 'Revert':
+ alert_dict.message = message.format(owner_name, doc_link, bold_points)
+ alert_dict.indicator = "red"
+ elif doc.type == "Revert":
if points == 1:
- message = _('{0} reverted your point on {1}')
+ message = _("{0} reverted your point on {1}")
else:
- message = _('{0} reverted your points on {1}')
+ message = _("{0} reverted your points on {1}")
alert_dict.message = message.format(
owner_name,
doc_link,
)
- alert_dict.indicator = 'red'
+ alert_dict.indicator = "red"
return alert_dict
@@ -168,49 +173,53 @@ def get_alert_dict(doc):
def create_energy_points_log(ref_doctype, ref_name, doc, apply_only_once=False):
doc = frappe._dict(doc)
- log_exists = check_if_log_exists(ref_doctype,
- ref_name, doc.rule, None if apply_only_once else doc.user)
+ log_exists = check_if_log_exists(
+ ref_doctype, ref_name, doc.rule, None if apply_only_once else doc.user
+ )
if log_exists:
- return frappe.get_doc('Energy Point Log', log_exists)
+ return frappe.get_doc("Energy Point Log", log_exists)
- new_log = frappe.new_doc('Energy Point Log')
+ new_log = frappe.new_doc("Energy Point Log")
new_log.reference_doctype = ref_doctype
new_log.reference_name = ref_name
new_log.update(doc)
new_log.insert(ignore_permissions=True)
return new_log
+
def check_if_log_exists(ref_doctype, ref_name, rule, user=None):
- ''''Checks if Energy Point Log already exists'''
- filters = frappe._dict({
- 'rule': rule,
- 'reference_doctype': ref_doctype,
- 'reference_name': ref_name,
- 'reverted': 0
- })
+ """'Checks if Energy Point Log already exists"""
+ filters = frappe._dict(
+ {"rule": rule, "reference_doctype": ref_doctype, "reference_name": ref_name, "reverted": 0}
+ )
if user:
filters.user = user
- return frappe.db.exists('Energy Point Log', filters)
+ return frappe.db.exists("Energy Point Log", filters)
+
def create_review_points_log(user, points, reason=None, doctype=None, docname=None):
- return frappe.get_doc({
- 'doctype': 'Energy Point Log',
- 'points': points,
- 'type': 'Review',
- 'user': user,
- 'reason': reason,
- 'reference_doctype': doctype,
- 'reference_name': docname
- }).insert(ignore_permissions=True)
+ return frappe.get_doc(
+ {
+ "doctype": "Energy Point Log",
+ "points": points,
+ "type": "Review",
+ "user": user,
+ "reason": reason,
+ "reference_doctype": doctype,
+ "reference_name": docname,
+ }
+ ).insert(ignore_permissions=True)
+
@frappe.whitelist()
def add_review_points(user, points):
- frappe.only_for('System Manager')
+ frappe.only_for("System Manager")
create_review_points_log(user, points)
+
@frappe.whitelist()
def get_energy_points(user):
# points = frappe.cache().hget('energy_points', user,
@@ -219,21 +228,23 @@ def get_energy_points(user):
points = get_user_energy_and_review_points(user)
return frappe._dict(points.get(user, {}))
+
@frappe.whitelist()
def get_user_energy_and_review_points(user=None, from_date=None, as_dict=True):
- conditions = ''
- given_points_condition = ''
+ conditions = ""
+ given_points_condition = ""
values = frappe._dict()
if user:
- conditions = 'WHERE `user` = %(user)s'
+ conditions = "WHERE `user` = %(user)s"
values.user = user
if from_date:
- conditions += 'WHERE' if not conditions else 'AND'
+ conditions += "WHERE" if not conditions else "AND"
given_points_condition += "AND `creation` >= %(from_date)s"
conditions += " `creation` >= %(from_date)s OR `type`='Review'"
values.from_date = from_date
- points_list = frappe.db.sql("""
+ points_list = frappe.db.sql(
+ """
SELECT
SUM(CASE WHEN `type` != 'Review' THEN `points` ELSE 0 END) AS energy_points,
SUM(CASE WHEN `type` = 'Review' THEN `points` ELSE 0 END) AS review_points,
@@ -248,33 +259,40 @@ def get_user_energy_and_review_points(user=None, from_date=None, as_dict=True):
GROUP BY `user`
ORDER BY `energy_points` DESC
""".format(
- conditions=conditions,
- given_points_condition=given_points_condition
- ), values=values, as_dict=1)
+ conditions=conditions, given_points_condition=given_points_condition
+ ),
+ values=values,
+ as_dict=1,
+ )
if not as_dict:
return points_list
dict_to_return = frappe._dict()
for d in points_list:
- dict_to_return[d.pop('user')] = d
+ dict_to_return[d.pop("user")] = d
return dict_to_return
+
@frappe.whitelist()
-def review(doc, points, to_user, reason, review_type='Appreciation'):
+def review(doc, points, to_user, reason, review_type="Appreciation"):
current_review_points = get_energy_points(frappe.session.user).review_points
- doc = doc.as_dict() if hasattr(doc, 'as_dict') else frappe._dict(json.loads(doc))
+ doc = doc.as_dict() if hasattr(doc, "as_dict") else frappe._dict(json.loads(doc))
points = abs(cint(points))
if current_review_points < points:
- frappe.msgprint(_('You do not have enough review points'))
+ frappe.msgprint(_("You do not have enough review points"))
return
- review_doc = create_energy_points_log(doc.doctype, doc.name, {
- 'type': review_type,
- 'reason': reason,
- 'points': points if review_type == 'Appreciation' else -points,
- 'user': to_user
- })
+ review_doc = create_energy_points_log(
+ doc.doctype,
+ doc.name,
+ {
+ "type": review_type,
+ "reason": reason,
+ "points": points if review_type == "Appreciation" else -points,
+ "user": to_user,
+ },
+ )
# deduct review points from reviewer
create_review_points_log(
@@ -282,66 +300,81 @@ def review(doc, points, to_user, reason, review_type='Appreciation'):
points=-points,
reason=reason,
doctype=review_doc.doctype,
- docname=review_doc.name
+ docname=review_doc.name,
)
return review_doc
+
@frappe.whitelist()
def get_reviews(doctype, docname):
- return frappe.get_all('Energy Point Log', filters={
- 'reference_doctype': doctype,
- 'reference_name': docname,
- 'type': ['in', ('Appreciation', 'Criticism')],
- }, fields=['points', 'owner', 'type', 'user', 'reason', 'creation'])
+ return frappe.get_all(
+ "Energy Point Log",
+ filters={
+ "reference_doctype": doctype,
+ "reference_name": docname,
+ "type": ["in", ("Appreciation", "Criticism")],
+ },
+ fields=["points", "owner", "type", "user", "reason", "creation"],
+ )
+
def send_weekly_summary():
- send_summary('Weekly')
+ send_summary("Weekly")
+
def send_monthly_summary():
- send_summary('Monthly')
+ send_summary("Monthly")
+
def send_summary(timespan):
+ from frappe.social.doctype.energy_point_settings.energy_point_settings import (
+ is_energy_point_enabled,
+ )
from frappe.utils.user import get_enabled_system_users
- from frappe.social.doctype.energy_point_settings.energy_point_settings import is_energy_point_enabled
if not is_energy_point_enabled():
return
- if not is_email_notifications_enabled_for_type(frappe.session.user, 'Energy Point'):
+ if not is_email_notifications_enabled_for_type(frappe.session.user, "Energy Point"):
return
from_date = frappe.utils.add_to_date(None, weeks=-1)
- if timespan == 'Monthly':
+ if timespan == "Monthly":
from_date = frappe.utils.add_to_date(None, months=-1)
user_points = get_user_energy_and_review_points(from_date=from_date, as_dict=False)
# do not send report if no activity found
- if not user_points or not user_points[0].energy_points: return
+ if not user_points or not user_points[0].energy_points:
+ return
from_date = getdate(from_date)
to_date = getdate()
# select only those users that have energy point email notifications enabled
- all_users = [user.email for user in get_enabled_system_users() if
- is_email_notifications_enabled_for_type(user.name, 'Energy Point')]
+ all_users = [
+ user.email
+ for user in get_enabled_system_users()
+ if is_email_notifications_enabled_for_type(user.name, "Energy Point")
+ ]
frappe.sendmail(
- subject = '{} energy points summary'.format(timespan),
- recipients = all_users,
- template = "energy_points_summary",
- args = {
- 'top_performer': user_points[0],
- 'top_reviewer': max(user_points, key=lambda x:x['given_points']),
- 'standings': user_points[:10], # top 10
- 'footer_message': get_footer_message(timespan).format(from_date, to_date),
- },
- with_container = 1
- )
+ subject="{} energy points summary".format(timespan),
+ recipients=all_users,
+ template="energy_points_summary",
+ args={
+ "top_performer": user_points[0],
+ "top_reviewer": max(user_points, key=lambda x: x["given_points"]),
+ "standings": user_points[:10], # top 10
+ "footer_message": get_footer_message(timespan).format(from_date, to_date),
+ },
+ with_container=1,
+ )
+
def get_footer_message(timespan):
- if timespan == 'Monthly':
+ if timespan == "Monthly":
return _("Stats based on last month's performance (from {0} to {1})")
else:
return _("Stats based on last week's performance (from {0} to {1})")
diff --git a/frappe/social/doctype/energy_point_log/test_energy_point_log.py b/frappe/social/doctype/energy_point_log/test_energy_point_log.py
index a7d45ef61f..9a244a0a2c 100644
--- a/frappe/social/doctype/energy_point_log/test_energy_point_log.py
+++ b/frappe/social/doctype/energy_point_log/test_energy_point_log.py
@@ -2,117 +2,122 @@
# Copyright (c) 2019, Frappe Technologies and Contributors
# License: MIT. See LICENSE
import frappe
-
+from frappe.desk.form.assign_to import add as assign_to
from frappe.tests.utils import FrappeTestCase
-from .energy_point_log import get_energy_points as _get_energy_points, create_review_points_log, review
from frappe.utils.testutils import add_custom_field, clear_custom_fields
-from frappe.desk.form.assign_to import add as assign_to
+
+from .energy_point_log import create_review_points_log
+from .energy_point_log import get_energy_points as _get_energy_points
+from .energy_point_log import review
class TestEnergyPointLog(FrappeTestCase):
@classmethod
def setUpClass(cls):
- settings = frappe.get_single('Energy Point Settings')
+ settings = frappe.get_single("Energy Point Settings")
settings.enabled = 1
settings.save()
@classmethod
def tearDownClass(cls):
- settings = frappe.get_single('Energy Point Settings')
+ settings = frappe.get_single("Energy Point Settings")
settings.enabled = 0
settings.save()
def setUp(self):
- frappe.cache().delete_value('energy_point_rule_map')
+ frappe.cache().delete_value("energy_point_rule_map")
def tearDown(self):
- frappe.set_user('Administrator')
+ frappe.set_user("Administrator")
frappe.db.delete("Energy Point Log")
frappe.db.delete("Energy Point Rule")
- frappe.cache().delete_value('energy_point_rule_map')
+ frappe.cache().delete_value("energy_point_rule_map")
def test_user_energy_point(self):
- frappe.set_user('test@example.com')
+ frappe.set_user("test@example.com")
todo_point_rule = create_energy_point_rule_for_todo()
- energy_point_of_user = get_points('test@example.com')
+ energy_point_of_user = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- points_after_closing_todo = get_points('test@example.com')
+ points_after_closing_todo = get_points("test@example.com")
self.assertEqual(points_after_closing_todo, energy_point_of_user + todo_point_rule.points)
created_todo.save()
- points_after_double_save = get_points('test@example.com')
+ points_after_double_save = get_points("test@example.com")
# point should not be awarded more than once for same doc
self.assertEqual(points_after_double_save, energy_point_of_user + todo_point_rule.points)
def test_points_based_on_multiplier_field(self):
- frappe.set_user('test@example.com')
- add_custom_field('ToDo', 'multiplier', 'Float')
+ frappe.set_user("test@example.com")
+ add_custom_field("ToDo", "multiplier", "Float")
multiplier_value = 0.51
- todo_point_rule = create_energy_point_rule_for_todo('multiplier')
- energy_point_of_user = get_points('test@example.com')
+ todo_point_rule = create_energy_point_rule_for_todo("multiplier")
+ energy_point_of_user = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.multiplier = multiplier_value
created_todo.save()
- points_after_closing_todo = get_points('test@example.com')
+ points_after_closing_todo = get_points("test@example.com")
- self.assertEqual(points_after_closing_todo,
- energy_point_of_user + round(todo_point_rule.points * multiplier_value))
+ self.assertEqual(
+ points_after_closing_todo,
+ energy_point_of_user + round(todo_point_rule.points * multiplier_value),
+ )
- clear_custom_fields('ToDo')
+ clear_custom_fields("ToDo")
def test_points_based_on_max_points(self):
- frappe.set_user('test@example.com')
+ frappe.set_user("test@example.com")
# here multiplier is high
# let see if points get capped to max_point limit
multiplier_value = 15
max_points = 50
- add_custom_field('ToDo', 'multiplier', 'Float')
- todo_point_rule = create_energy_point_rule_for_todo('multiplier', max_points=max_points)
- energy_point_of_user = get_points('test@example.com')
+ add_custom_field("ToDo", "multiplier", "Float")
+ todo_point_rule = create_energy_point_rule_for_todo("multiplier", max_points=max_points)
+ energy_point_of_user = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.multiplier = multiplier_value
created_todo.save()
- points_after_closing_todo = get_points('test@example.com')
+ points_after_closing_todo = get_points("test@example.com")
# test max_points cap
- self.assertNotEqual(points_after_closing_todo,
- energy_point_of_user + round(todo_point_rule.points * multiplier_value))
+ self.assertNotEqual(
+ points_after_closing_todo,
+ energy_point_of_user + round(todo_point_rule.points * multiplier_value),
+ )
- self.assertEqual(points_after_closing_todo,
- energy_point_of_user + max_points)
+ self.assertEqual(points_after_closing_todo, energy_point_of_user + max_points)
- clear_custom_fields('ToDo')
+ clear_custom_fields("ToDo")
def test_disabled_energy_points(self):
- settings = frappe.get_single('Energy Point Settings')
+ settings = frappe.get_single("Energy Point Settings")
settings.enabled = 0
settings.save()
- frappe.set_user('test@example.com')
+ frappe.set_user("test@example.com")
create_energy_point_rule_for_todo()
- energy_point_of_user = get_points('test@example.com')
+ energy_point_of_user = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- points_after_closing_todo = get_points('test@example.com')
+ points_after_closing_todo = get_points("test@example.com")
# no change in points
self.assertEqual(points_after_closing_todo, energy_point_of_user)
@@ -123,60 +128,60 @@ class TestEnergyPointLog(FrappeTestCase):
def test_review(self):
created_todo = create_a_todo()
review_points = 20
- create_review_points_log('test2@example.com', review_points)
+ create_review_points_log("test2@example.com", review_points)
# reviewer
- frappe.set_user('test2@example.com')
+ frappe.set_user("test2@example.com")
- review_points_before_review = get_points('test2@example.com', 'review_points')
+ review_points_before_review = get_points("test2@example.com", "review_points")
self.assertEqual(review_points_before_review, review_points)
# for appreciation
appreciation_points = 5
- energy_points_before_review = get_points('test@example.com')
- review(created_todo, appreciation_points, 'test@example.com', 'good job')
- energy_points_after_review = get_points('test@example.com')
- review_points_after_review = get_points('test2@example.com', 'review_points')
+ energy_points_before_review = get_points("test@example.com")
+ review(created_todo, appreciation_points, "test@example.com", "good job")
+ energy_points_after_review = get_points("test@example.com")
+ review_points_after_review = get_points("test2@example.com", "review_points")
self.assertEqual(energy_points_after_review, energy_points_before_review + appreciation_points)
self.assertEqual(review_points_after_review, review_points_before_review - appreciation_points)
# for criticism
criticism_points = 2
- todo = create_a_todo(description='Bad patch')
+ todo = create_a_todo(description="Bad patch")
energy_points_before_review = energy_points_after_review
review_points_before_review = review_points_after_review
- review(todo, criticism_points, 'test@example.com', 'You could have done better.', 'Criticism')
- energy_points_after_review = get_points('test@example.com')
- review_points_after_review = get_points('test2@example.com', 'review_points')
+ review(todo, criticism_points, "test@example.com", "You could have done better.", "Criticism")
+ energy_points_after_review = get_points("test@example.com")
+ review_points_after_review = get_points("test2@example.com", "review_points")
self.assertEqual(energy_points_after_review, energy_points_before_review - criticism_points)
self.assertEqual(review_points_after_review, review_points_before_review - criticism_points)
def test_user_energy_point_as_admin(self):
- frappe.set_user('Administrator')
+ frappe.set_user("Administrator")
create_energy_point_rule_for_todo()
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- points_after_closing_todo = get_points('Administrator')
+ points_after_closing_todo = get_points("Administrator")
# no points for admin
self.assertEqual(points_after_closing_todo, 0)
def test_revert_points_on_cancelled_doc(self):
- frappe.set_user('test@example.com')
+ frappe.set_user("test@example.com")
create_energy_point_rule_for_todo()
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- energy_point_logs = frappe.get_all('Energy Point Log')
+ energy_point_logs = frappe.get_all("Energy Point Log")
self.assertEqual(len(energy_point_logs), 1)
# for submit and cancel permission
- frappe.set_user('Administrator')
+ frappe.set_user("Administrator")
# submit
created_todo.docstatus = 1
created_todo.save()
@@ -185,103 +190,110 @@ class TestEnergyPointLog(FrappeTestCase):
created_todo.docstatus = 2
created_todo.save()
- energy_point_logs = frappe.get_all('Energy Point Log', fields=['reference_name', 'type', 'reverted'])
+ energy_point_logs = frappe.get_all(
+ "Energy Point Log", fields=["reference_name", "type", "reverted"]
+ )
- self.assertListEqual(energy_point_logs, [
- {'reference_name': created_todo.name, 'type': 'Revert', 'reverted': 0},
- {'reference_name': created_todo.name, 'type': 'Auto', 'reverted': 1}
- ])
+ self.assertListEqual(
+ energy_point_logs,
+ [
+ {"reference_name": created_todo.name, "type": "Revert", "reverted": 0},
+ {"reference_name": created_todo.name, "type": "Auto", "reverted": 1},
+ ],
+ )
def test_energy_point_for_new_document_creation(self):
- frappe.set_user('test@example.com')
- todo_point_rule = create_energy_point_rule_for_todo(for_doc_event='New')
+ frappe.set_user("test@example.com")
+ todo_point_rule = create_energy_point_rule_for_todo(for_doc_event="New")
- points_before_todo_creation = get_points('test@example.com')
+ points_before_todo_creation = get_points("test@example.com")
create_a_todo()
- points_after_todo_creation = get_points('test@example.com')
+ points_after_todo_creation = get_points("test@example.com")
- self.assertEqual(points_after_todo_creation,
- points_before_todo_creation + todo_point_rule.points)
+ self.assertEqual(
+ points_after_todo_creation, points_before_todo_creation + todo_point_rule.points
+ )
def test_point_allocation_for_assigned_users(self):
todo = create_a_todo()
- assign_users_to_todo(todo.name, ['test@example.com', 'test2@example.com'])
+ assign_users_to_todo(todo.name, ["test@example.com", "test2@example.com"])
- test_user_before_points = get_points('test@example.com')
- test2_user_before_points = get_points('test2@example.com')
+ test_user_before_points = get_points("test@example.com")
+ test2_user_before_points = get_points("test2@example.com")
rule = create_energy_point_rule_for_todo(for_assigned_users=1)
- todo.status = 'Closed'
+ todo.status = "Closed"
todo.save()
- test_user_after_points = get_points('test@example.com')
- test2_user_after_points = get_points('test2@example.com')
+ test_user_after_points = get_points("test@example.com")
+ test2_user_after_points = get_points("test2@example.com")
- self.assertEqual(test_user_after_points,
- test_user_before_points + rule.points)
+ self.assertEqual(test_user_after_points, test_user_before_points + rule.points)
- self.assertEqual(test2_user_after_points,
- test2_user_before_points + rule.points)
+ self.assertEqual(test2_user_after_points, test2_user_before_points + rule.points)
def test_points_on_field_value_change(self):
- rule = create_energy_point_rule_for_todo(for_doc_event='Value Change',
- field_to_check='description')
+ rule = create_energy_point_rule_for_todo(
+ for_doc_event="Value Change", field_to_check="description"
+ )
- frappe.set_user('test@example.com')
- points_before_todo_creation = get_points('test@example.com')
+ frappe.set_user("test@example.com")
+ points_before_todo_creation = get_points("test@example.com")
todo = create_a_todo()
- todo.status = 'Closed'
+ todo.status = "Closed"
todo.save()
- points_after_closing_todo = get_points('test@example.com')
- self.assertEqual(points_after_closing_todo,
- points_before_todo_creation)
+ points_after_closing_todo = get_points("test@example.com")
+ self.assertEqual(points_after_closing_todo, points_before_todo_creation)
- todo.description = 'This is new todo'
+ todo.description = "This is new todo"
todo.save()
- points_after_changing_todo_description = get_points('test@example.com')
- self.assertEqual(points_after_changing_todo_description,
- points_before_todo_creation + rule.points)
+ points_after_changing_todo_description = get_points("test@example.com")
+ self.assertEqual(
+ points_after_changing_todo_description, points_before_todo_creation + rule.points
+ )
def test_apply_only_once(self):
- frappe.set_user('test@example.com')
- todo_point_rule = create_energy_point_rule_for_todo(apply_once=True, user_field='modified_by')
- first_user_points = get_points('test@example.com')
+ frappe.set_user("test@example.com")
+ todo_point_rule = create_energy_point_rule_for_todo(apply_once=True, user_field="modified_by")
+ first_user_points = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- first_user_points_after_closing_todo = get_points('test@example.com')
+ first_user_points_after_closing_todo = get_points("test@example.com")
- self.assertEqual(first_user_points_after_closing_todo, first_user_points + todo_point_rule.points)
+ self.assertEqual(
+ first_user_points_after_closing_todo, first_user_points + todo_point_rule.points
+ )
- frappe.set_user('test2@example.com')
- second_user_points = get_points('test2@example.com')
+ frappe.set_user("test2@example.com")
+ second_user_points = get_points("test2@example.com")
created_todo.save(ignore_permissions=True)
- second_user_points_after_closing_todo = get_points('test2@example.com')
+ second_user_points_after_closing_todo = get_points("test2@example.com")
# point should not be awarded more than once for same doc (irrespective of user)
self.assertEqual(second_user_points_after_closing_todo, second_user_points)
def test_allow_creation_of_new_log_if_the_previous_log_was_reverted(self):
- frappe.set_user('test@example.com')
+ frappe.set_user("test@example.com")
todo_point_rule = create_energy_point_rule_for_todo()
- energy_point_of_user = get_points('test@example.com')
+ energy_point_of_user = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- points_after_closing_todo = get_points('test@example.com')
+ points_after_closing_todo = get_points("test@example.com")
- log_name = frappe.db.exists('Energy Point Log', {'reference_name': created_todo.name})
- frappe.get_doc('Energy Point Log', log_name).revert('Just for test')
- points_after_reverting_todo = get_points('test@example.com')
+ log_name = frappe.db.exists("Energy Point Log", {"reference_name": created_todo.name})
+ frappe.get_doc("Energy Point Log", log_name).revert("Just for test")
+ points_after_reverting_todo = get_points("test@example.com")
created_todo.save()
- points_after_saving_todo_again = get_points('test@example.com')
+ points_after_saving_todo_again = get_points("test@example.com")
rule_points = todo_point_rule.points
self.assertEqual(points_after_closing_todo, energy_point_of_user + rule_points)
@@ -289,18 +301,18 @@ class TestEnergyPointLog(FrappeTestCase):
self.assertEqual(points_after_saving_todo_again, points_after_reverting_todo + rule_points)
def test_energy_points_disabled_user(self):
- frappe.set_user('test@example.com')
- user = frappe.get_doc('User', 'test@example.com')
+ frappe.set_user("test@example.com")
+ user = frappe.get_doc("User", "test@example.com")
user.enabled = 0
user.save()
todo_point_rule = create_energy_point_rule_for_todo()
- energy_point_of_user = get_points('test@example.com')
+ energy_point_of_user = get_points("test@example.com")
created_todo = create_a_todo()
- created_todo.status = 'Closed'
+ created_todo.status = "Closed"
created_todo.save()
- points_after_closing_todo = get_points('test@example.com')
+ points_after_closing_todo = get_points("test@example.com")
# do not update energy points for disabled user
self.assertEqual(points_after_closing_todo, energy_point_of_user)
@@ -309,49 +321,58 @@ class TestEnergyPointLog(FrappeTestCase):
user.save()
created_todo.save()
- points_after_re_saving_todo = get_points('test@example.com')
+ points_after_re_saving_todo = get_points("test@example.com")
self.assertEqual(points_after_re_saving_todo, energy_point_of_user + todo_point_rule.points)
-def create_energy_point_rule_for_todo(multiplier_field=None, for_doc_event='Custom', max_points=None,
- for_assigned_users=0, field_to_check=None, apply_once=False, user_field='owner'):
- name = 'ToDo Closed'
- point_rule_exists = frappe.db.exists('Energy Point Rule', name)
-
- if point_rule_exists: return frappe.get_doc('Energy Point Rule', name)
-
- return frappe.get_doc({
- 'doctype': 'Energy Point Rule',
- 'rule_name': name,
- 'points': 5,
- 'reference_doctype': 'ToDo',
- 'condition': 'doc.status == "Closed"',
- 'for_doc_event': for_doc_event,
- 'user_field': user_field,
- 'for_assigned_users': for_assigned_users,
- 'multiplier_field': multiplier_field,
- 'max_points': max_points,
- 'field_to_check': field_to_check,
- 'apply_only_once': apply_once
- }).insert(ignore_permissions=1)
+def create_energy_point_rule_for_todo(
+ multiplier_field=None,
+ for_doc_event="Custom",
+ max_points=None,
+ for_assigned_users=0,
+ field_to_check=None,
+ apply_once=False,
+ user_field="owner",
+):
+ name = "ToDo Closed"
+ point_rule_exists = frappe.db.exists("Energy Point Rule", name)
+
+ if point_rule_exists:
+ return frappe.get_doc("Energy Point Rule", name)
+
+ return frappe.get_doc(
+ {
+ "doctype": "Energy Point Rule",
+ "rule_name": name,
+ "points": 5,
+ "reference_doctype": "ToDo",
+ "condition": 'doc.status == "Closed"',
+ "for_doc_event": for_doc_event,
+ "user_field": user_field,
+ "for_assigned_users": for_assigned_users,
+ "multiplier_field": multiplier_field,
+ "max_points": max_points,
+ "field_to_check": field_to_check,
+ "apply_only_once": apply_once,
+ }
+ ).insert(ignore_permissions=1)
def create_a_todo(description=None):
if not description:
- description = 'Fix a bug'
- return frappe.get_doc({
- 'doctype': 'ToDo',
- 'description': description,
- }).insert(ignore_permissions=True)
+ description = "Fix a bug"
+ return frappe.get_doc(
+ {
+ "doctype": "ToDo",
+ "description": description,
+ }
+ ).insert(ignore_permissions=True)
-def get_points(user, point_type='energy_points'):
+def get_points(user, point_type="energy_points"):
return _get_energy_points(user).get(point_type) or 0
+
def assign_users_to_todo(todo_name, users):
for user in users:
- assign_to({
- 'assign_to': [user],
- 'doctype': 'ToDo',
- 'name': todo_name
- })
+ assign_to({"assign_to": [user], "doctype": "ToDo", "name": todo_name})
diff --git a/frappe/social/doctype/energy_point_rule/energy_point_rule.py b/frappe/social/doctype/energy_point_rule/energy_point_rule.py
index 55bf55a3b0..a36581ec4c 100644
--- a/frappe/social/doctype/energy_point_rule/energy_point_rule.py
+++ b/frappe/social/doctype/energy_point_rule/energy_point_rule.py
@@ -3,21 +3,23 @@
# License: MIT. See LICENSE
import frappe
-from frappe import _
import frappe.cache_manager
+from frappe import _
from frappe.core.doctype.user.user import get_enabled_users
from frappe.model import log_types
from frappe.model.document import Document
-from frappe.social.doctype.energy_point_settings.energy_point_settings import is_energy_point_enabled
-from frappe.social.doctype.energy_point_log.energy_point_log import \
- create_energy_points_log
+from frappe.social.doctype.energy_point_log.energy_point_log import create_energy_points_log
+from frappe.social.doctype.energy_point_settings.energy_point_settings import (
+ is_energy_point_enabled,
+)
+
class EnergyPointRule(Document):
def on_update(self):
- frappe.cache_manager.clear_doctype_map('Energy Point Rule', self.reference_doctype)
+ frappe.cache_manager.clear_doctype_map("Energy Point Rule", self.reference_doctype)
def on_trash(self):
- frappe.cache_manager.clear_doctype_map('Energy Point Rule', self.reference_doctype)
+ frappe.cache_manager.clear_doctype_map("Energy Point Rule", self.reference_doctype)
def apply(self, doc):
if self.rule_condition_satisfied(doc):
@@ -41,53 +43,60 @@ class EnergyPointRule(Document):
rule = self.name
# incase of zero as result after roundoff
- if not points: return
+ if not points:
+ return
try:
for user in users:
- if not is_eligible_user(user): continue
- create_energy_points_log(reference_doctype, reference_name, {
- 'points': points,
- 'user': user,
- 'rule': rule
- }, self.apply_only_once)
+ if not is_eligible_user(user):
+ continue
+ create_energy_points_log(
+ reference_doctype,
+ reference_name,
+ {"points": points, "user": user, "rule": rule},
+ self.apply_only_once,
+ )
except Exception as e:
- frappe.log_error(frappe.get_traceback(), 'apply_energy_point')
+ frappe.log_error(frappe.get_traceback(), "apply_energy_point")
def rule_condition_satisfied(self, doc):
- if self.for_doc_event == 'New':
+ if self.for_doc_event == "New":
# indicates that this was a new doc
return doc.get_doc_before_save() is None
- if self.for_doc_event == 'Submit':
+ if self.for_doc_event == "Submit":
return doc.docstatus.is_submitted()
- if self.for_doc_event == 'Cancel':
+ if self.for_doc_event == "Cancel":
return doc.docstatus.is_cancelled()
- if self.for_doc_event == 'Value Change':
+ if self.for_doc_event == "Value Change":
field_to_check = self.field_to_check
- if not field_to_check: return False
+ if not field_to_check:
+ return False
doc_before_save = doc.get_doc_before_save()
# check if the field has been changed
# if condition is set check if it is satisfied
- return doc_before_save \
- and doc_before_save.get(field_to_check) != doc.get(field_to_check) \
+ return (
+ doc_before_save
+ and doc_before_save.get(field_to_check) != doc.get(field_to_check)
and (not self.condition or self.eval_condition(doc))
+ )
- if self.for_doc_event == 'Custom' and self.condition:
+ if self.for_doc_event == "Custom" and self.condition:
return self.eval_condition(doc)
return False
def eval_condition(self, doc):
- return self.condition and frappe.safe_eval(self.condition, None, {
- 'doc': doc.as_dict()
- })
+ return self.condition and frappe.safe_eval(self.condition, None, {"doc": doc.as_dict()})
+
def process_energy_points(doc, state):
- if (frappe.flags.in_patch
+ if (
+ frappe.flags.in_patch
or frappe.flags.in_install
or frappe.flags.in_migrate
or frappe.flags.in_import
or frappe.flags.in_setup_wizard
- or doc.doctype in log_types):
+ or doc.doctype in log_types
+ ):
return
if not is_energy_point_enabled():
@@ -99,29 +108,30 @@ def process_energy_points(doc, state):
if old_doc and old_doc.docstatus.is_submitted() and doc.docstatus.is_cancelled():
return revert_points_for_cancelled_doc(doc)
- for d in frappe.cache_manager.get_doctype_map('Energy Point Rule', doc.doctype,
- dict(reference_doctype = doc.doctype, enabled=1)):
- frappe.get_doc('Energy Point Rule', d.get('name')).apply(doc)
+ for d in frappe.cache_manager.get_doctype_map(
+ "Energy Point Rule", doc.doctype, dict(reference_doctype=doc.doctype, enabled=1)
+ ):
+ frappe.get_doc("Energy Point Rule", d.get("name")).apply(doc)
def revert_points_for_cancelled_doc(doc):
- energy_point_logs = frappe.get_all('Energy Point Log', {
- 'reference_doctype': doc.doctype,
- 'reference_name': doc.name,
- 'type': 'Auto'
- })
+ energy_point_logs = frappe.get_all(
+ "Energy Point Log",
+ {"reference_doctype": doc.doctype, "reference_name": doc.name, "type": "Auto"},
+ )
for log in energy_point_logs:
- reference_log = frappe.get_doc('Energy Point Log', log.name)
- reference_log.revert(_('Reference document has been cancelled'), ignore_permissions=True)
+ reference_log = frappe.get_doc("Energy Point Log", log.name)
+ reference_log.revert(_("Reference document has been cancelled"), ignore_permissions=True)
def get_energy_point_doctypes():
return [
- d.reference_doctype for d in frappe.get_all('Energy Point Rule',
- ['reference_doctype'], {'enabled': 1})
+ d.reference_doctype
+ for d in frappe.get_all("Energy Point Rule", ["reference_doctype"], {"enabled": 1})
]
+
def is_eligible_user(user):
- '''Checks if user is eligible to get energy points'''
+ """Checks if user is eligible to get energy points"""
enabled_users = get_enabled_users()
- return user and user in enabled_users and user != 'Administrator'
+ return user and user in enabled_users and user != "Administrator"
diff --git a/frappe/social/doctype/energy_point_settings/energy_point_settings.py b/frappe/social/doctype/energy_point_settings/energy_point_settings.py
index cac0e0b4a5..c1ff2707af 100644
--- a/frappe/social/doctype/energy_point_settings/energy_point_settings.py
+++ b/frappe/social/doctype/energy_point_settings/energy_point_settings.py
@@ -5,19 +5,23 @@
import frappe
from frappe.model.document import Document
from frappe.social.doctype.energy_point_log.energy_point_log import create_review_points_log
-from frappe.utils import add_to_date, today, getdate
+from frappe.utils import add_to_date, getdate, today
+
class EnergyPointSettings(Document):
pass
+
def is_energy_point_enabled():
- return frappe.db.get_single_value('Energy Point Settings', 'enabled', True)
+ return frappe.db.get_single_value("Energy Point Settings", "enabled", True)
+
def allocate_review_points():
- settings = frappe.get_single('Energy Point Settings')
+ settings = frappe.get_single("Energy Point Settings")
- if not can_allocate_today(settings.last_point_allocation_date,
- settings.point_allocation_periodicity):
+ if not can_allocate_today(
+ settings.last_point_allocation_date, settings.point_allocation_periodicity
+ ):
return
user_point_map = {}
@@ -35,15 +39,12 @@ def allocate_review_points():
settings.last_point_allocation_date = today()
settings.save(ignore_permissions=True)
+
def can_allocate_today(last_date, periodicity):
if not last_date:
return True
- days_to_add = {
- 'Daily': 1,
- 'Weekly': 7,
- 'Monthly': 30
- }.get(periodicity, 1)
+ days_to_add = {"Daily": 1, "Weekly": 7, "Monthly": 30}.get(periodicity, 1)
next_allocation_date = add_to_date(last_date, days=days_to_add)
@@ -51,9 +52,15 @@ def can_allocate_today(last_date, periodicity):
def get_users_with_role(role):
- return [p[0] for p in frappe.db.sql("""SELECT DISTINCT `tabUser`.`name`
+ return [
+ p[0]
+ for p in frappe.db.sql(
+ """SELECT DISTINCT `tabUser`.`name`
FROM `tabHas Role`, `tabUser`
WHERE `tabHas Role`.`role`=%s
AND `tabUser`.`name`!='Administrator'
AND `tabHas Role`.`parent`=`tabUser`.`name`
- AND `tabUser`.`enabled`=1""", role)]
\ No newline at end of file
+ AND `tabUser`.`enabled`=1""",
+ role,
+ )
+ ]
diff --git a/frappe/social/doctype/energy_point_settings/test_energy_point_settings.py b/frappe/social/doctype/energy_point_settings/test_energy_point_settings.py
index 3b0a756878..10416a127b 100644
--- a/frappe/social/doctype/energy_point_settings/test_energy_point_settings.py
+++ b/frappe/social/doctype/energy_point_settings/test_energy_point_settings.py
@@ -4,5 +4,6 @@
# import frappe
import unittest
+
class TestEnergyPointSettings(unittest.TestCase):
pass
diff --git a/frappe/social/doctype/review_level/review_level.py b/frappe/social/doctype/review_level/review_level.py
index 1951233552..b3418e913e 100644
--- a/frappe/social/doctype/review_level/review_level.py
+++ b/frappe/social/doctype/review_level/review_level.py
@@ -5,5 +5,6 @@
# import frappe
from frappe.model.document import Document
+
class ReviewLevel(Document):
pass
diff --git a/frappe/templates/includes/comments/comment.html b/frappe/templates/includes/comments/comment.html
index e0fc1c3c54..4713ee498d 100644
--- a/frappe/templates/includes/comments/comment.html
+++ b/frappe/templates/includes/comments/comment.html
@@ -1,14 +1,18 @@
{% from "frappe/templates/includes/avatar_macro.html" import avatar %}
-
{2}
".format(frappe.utils.get_request_site_address(), - comment.name, - _("View Comment"))) + content = ( + comment.content + + "{2}
".format( + frappe.utils.get_request_site_address(), comment.name, _("View Comment") + ) + ) if doc.doctype == "Blog Post" and not doc.enable_email_notification: pass else: # notify creator frappe.sendmail( - recipients=frappe.db.get_value('User', doc.owner, 'email') or doc.owner, - subject=_('New Comment on {0}: {1}').format(doc.doctype, doc.name), + recipients=frappe.db.get_value("User", doc.owner, "email") or doc.owner, + subject=_("New Comment on {0}: {1}").format(doc.doctype, doc.name), message=content, reference_doctype=doc.doctype, - reference_name=doc.name + reference_name=doc.name, ) # revert with template if all clear (no backlinks) diff --git a/frappe/templates/includes/feedback/feedback.py b/frappe/templates/includes/feedback/feedback.py index 279ff05e6d..4c6a0588f5 100644 --- a/frappe/templates/includes/feedback/feedback.py +++ b/frappe/templates/includes/feedback/feedback.py @@ -3,13 +3,13 @@ from __future__ import unicode_literals import frappe - from frappe import _ from frappe.rate_limiter import rate_limit from frappe.website.doctype.blog_settings.blog_settings import get_feedback_limit + @frappe.whitelist(allow_guest=True) -@rate_limit(key='reference_name', limit=get_feedback_limit, seconds=60*60) +@rate_limit(key="reference_name", limit=get_feedback_limit, seconds=60 * 60) def give_feedback(reference_doctype, reference_name, like): like = frappe.parse_json(like) ref_doc = frappe.get_doc(reference_doctype, reference_name) @@ -19,35 +19,38 @@ def give_feedback(reference_doctype, reference_name, like): filters = { "owner": frappe.session.user, "reference_doctype": reference_doctype, - "reference_name": reference_name + "reference_name": reference_name, } - d = frappe.get_all('Feedback', filters=filters, limit=1) + d = frappe.get_all("Feedback", filters=filters, limit=1) if d: - doc = frappe.get_doc('Feedback', d[0].name) + doc = frappe.get_doc("Feedback", d[0].name) else: - doc = doc = frappe.new_doc('Feedback') + doc = doc = frappe.new_doc("Feedback") doc.reference_doctype = reference_doctype doc.reference_name = reference_name doc.ip_address = frappe.local.request_ip doc.like = like doc.save(ignore_permissions=True) - subject = _('Feedback on {0}: {1}').format(reference_doctype, reference_name) + subject = _("Feedback on {0}: {1}").format(reference_doctype, reference_name) ref_doc.enable_email_notification and send_mail(doc, subject) return doc + def send_mail(feedback, subject): doc = frappe.get_doc(feedback.reference_doctype, feedback.reference_name) if feedback.like: - message = "Hey,
You have received a ❤️ heart on your blog post {0}
".format(feedback.reference_name) + message = "Hey,
You have received a ❤️ heart on your blog post {0}
".format( + feedback.reference_name + ) else: return # notify creator frappe.sendmail( - recipients=frappe.db.get_value('User', doc.owner, 'email') or doc.owner, + recipients=frappe.db.get_value("User", doc.owner, "email") or doc.owner, subject=subject, message=message, reference_doctype=doc.doctype, - reference_name=doc.name + reference_name=doc.name, ) diff --git a/frappe/templates/pages/integrations/braintree_checkout.py b/frappe/templates/pages/integrations/braintree_checkout.py index 26c1d0842a..c4c79ea74f 100644 --- a/frappe/templates/pages/integrations/braintree_checkout.py +++ b/frappe/templates/pages/integrations/braintree_checkout.py @@ -1,16 +1,30 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ +from frappe.integrations.doctype.braintree_settings.braintree_settings import ( + get_client_token, + get_gateway_controller, +) from frappe.utils import flt -import json -from frappe.integrations.doctype.braintree_settings.braintree_settings import get_client_token, get_gateway_controller no_cache = 1 -expected_keys = ('amount', 'title', 'description', 'reference_doctype', 'reference_docname', - 'payer_name', 'payer_email', 'order_id', 'currency') +expected_keys = ( + "amount", + "title", + "description", + "reference_doctype", + "reference_docname", + "payer_name", + "payer_email", + "order_id", + "currency", +) + def get_context(context): context.no_cache = 1 @@ -22,26 +36,29 @@ def get_context(context): context.client_token = get_client_token(context.reference_docname) - context['amount'] = flt(context['amount']) + context["amount"] = flt(context["amount"]) gateway_controller = get_gateway_controller(context.reference_docname) - context['header_img'] = frappe.db.get_value("Braintree Settings", gateway_controller, "header_img") + context["header_img"] = frappe.db.get_value( + "Braintree Settings", gateway_controller, "header_img" + ) else: - frappe.redirect_to_message(_('Some information is missing'), - _('Looks like someone sent you to an incomplete URL. Please ask them to look into it.')) + frappe.redirect_to_message( + _("Some information is missing"), + _("Looks like someone sent you to an incomplete URL. Please ask them to look into it."), + ) frappe.local.flags.redirect_location = frappe.local.response.location raise frappe.Redirect + @frappe.whitelist(allow_guest=True) def make_payment(payload_nonce, data, reference_doctype, reference_docname): data = json.loads(data) - data.update({ - "payload_nonce": payload_nonce - }) + data.update({"payload_nonce": payload_nonce}) gateway_controller = get_gateway_controller(reference_docname) - data = frappe.get_doc("Braintree Settings", gateway_controller).create_payment_request(data) + data = frappe.get_doc("Braintree Settings", gateway_controller).create_payment_request(data) frappe.db.commit() return data diff --git a/frappe/templates/pages/integrations/payment_cancel.py b/frappe/templates/pages/integrations/payment_cancel.py index 9c0b972cb2..cf2a10f8c7 100644 --- a/frappe/templates/pages/integrations/payment_cancel.py +++ b/frappe/templates/pages/integrations/payment_cancel.py @@ -3,6 +3,7 @@ import frappe + def get_context(context): token = frappe.local.form_dict.token diff --git a/frappe/templates/pages/integrations/payment_success.py b/frappe/templates/pages/integrations/payment_success.py index bb584ee577..8985850a81 100644 --- a/frappe/templates/pages/integrations/payment_success.py +++ b/frappe/templates/pages/integrations/payment_success.py @@ -2,13 +2,14 @@ # License: MIT. See LICENSE import frappe + no_cache = True + def get_context(context): - token = frappe.local.form_dict.token - doc = frappe.get_doc(frappe.local.form_dict.doctype, frappe.local.form_dict.docname) + token = frappe.local.form_dict.token + doc = frappe.get_doc(frappe.local.form_dict.doctype, frappe.local.form_dict.docname) - context.payment_message = '' - if hasattr(doc, 'get_payment_success_message'): + context.payment_message = "" + if hasattr(doc, "get_payment_success_message"): context.payment_message = doc.get_payment_success_message() - diff --git a/frappe/templates/pages/integrations/paytm_checkout.py b/frappe/templates/pages/integrations/paytm_checkout.py index c003844157..93097e038b 100644 --- a/frappe/templates/pages/integrations/paytm_checkout.py +++ b/frappe/templates/pages/integrations/paytm_checkout.py @@ -1,16 +1,21 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ -import json -from frappe.integrations.doctype.paytm_settings.paytm_settings import get_paytm_params, get_paytm_config +from frappe.integrations.doctype.paytm_settings.paytm_settings import ( + get_paytm_config, + get_paytm_params, +) + def get_context(context): context.no_cache = 1 paytm_config = get_paytm_config() try: - doc = frappe.get_doc("Integration Request", frappe.form_dict['order_id']) + doc = frappe.get_doc("Integration Request", frappe.form_dict["order_id"]) context.payment_details = get_paytm_params(json.loads(doc.data), doc.name, paytm_config) @@ -18,9 +23,12 @@ def get_context(context): except Exception: frappe.log_error() - frappe.redirect_to_message(_('Invalid Token'), - _('Seems token you are using is invalid!'), - http_status_code=400, indicator_color='red') + frappe.redirect_to_message( + _("Invalid Token"), + _("Seems token you are using is invalid!"), + http_status_code=400, + indicator_color="red", + ) frappe.local.flags.redirect_location = frappe.local.response.location - raise frappe.Redirect \ No newline at end of file + raise frappe.Redirect diff --git a/frappe/templates/pages/integrations/razorpay_checkout.py b/frappe/templates/pages/integrations/razorpay_checkout.py index 51904fca46..aed832119b 100644 --- a/frappe/templates/pages/integrations/razorpay_checkout.py +++ b/frappe/templates/pages/integrations/razorpay_checkout.py @@ -1,39 +1,54 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ -from frappe.utils import flt, cint -import json +from frappe.utils import cint, flt no_cache = 1 -expected_keys = ('amount', 'title', 'description', 'reference_doctype', 'reference_docname', - 'payer_name', 'payer_email', 'order_id') +expected_keys = ( + "amount", + "title", + "description", + "reference_doctype", + "reference_docname", + "payer_name", + "payer_email", + "order_id", +) + def get_context(context): context.no_cache = 1 context.api_key = get_api_key() try: - doc = frappe.get_doc("Integration Request", frappe.form_dict['token']) + doc = frappe.get_doc("Integration Request", frappe.form_dict["token"]) payment_details = json.loads(doc.data) for key in expected_keys: context[key] = payment_details[key] - context['token'] = frappe.form_dict['token'] - context['amount'] = flt(context['amount']) - context['subscription_id'] = payment_details['subscription_id'] \ - if payment_details.get('subscription_id') else '' + context["token"] = frappe.form_dict["token"] + context["amount"] = flt(context["amount"]) + context["subscription_id"] = ( + payment_details["subscription_id"] if payment_details.get("subscription_id") else "" + ) except Exception as e: - frappe.redirect_to_message(_('Invalid Token'), - _('Seems token you are using is invalid!'), - http_status_code=400, indicator_color='red') + frappe.redirect_to_message( + _("Invalid Token"), + _("Seems token you are using is invalid!"), + http_status_code=400, + indicator_color="red", + ) frappe.local.flags.redirect_location = frappe.local.response.location raise frappe.Redirect + def get_api_key(): api_key = frappe.db.get_value("Razorpay Settings", None, "api_key") if cint(frappe.form_dict.get("use_sandbox")): @@ -41,6 +56,7 @@ def get_api_key(): return api_key + @frappe.whitelist(allow_guest=True) def make_payment(razorpay_payment_id, options, reference_doctype, reference_docname, token): data = {} @@ -48,13 +64,15 @@ def make_payment(razorpay_payment_id, options, reference_doctype, reference_docn if isinstance(options, str): data = json.loads(options) - data.update({ - "razorpay_payment_id": razorpay_payment_id, - "reference_docname": reference_docname, - "reference_doctype": reference_doctype, - "token": token - }) + data.update( + { + "razorpay_payment_id": razorpay_payment_id, + "reference_docname": reference_docname, + "reference_doctype": reference_doctype, + "token": token, + } + ) - data = frappe.get_doc("Razorpay Settings").create_request(data) + data = frappe.get_doc("Razorpay Settings").create_request(data) frappe.db.commit() return data diff --git a/frappe/templates/pages/integrations/stripe_checkout.py b/frappe/templates/pages/integrations/stripe_checkout.py index eb9c23ad22..1c0e20c631 100644 --- a/frappe/templates/pages/integrations/stripe_checkout.py +++ b/frappe/templates/pages/integrations/stripe_checkout.py @@ -1,15 +1,26 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE +import json + import frappe from frappe import _ -from frappe.utils import cint, fmt_money -import json from frappe.integrations.doctype.stripe_settings.stripe_settings import get_gateway_controller +from frappe.utils import cint, fmt_money no_cache = 1 -expected_keys = ('amount', 'title', 'description', 'reference_doctype', 'reference_docname', - 'payer_name', 'payer_email', 'order_id', 'currency') +expected_keys = ( + "amount", + "title", + "description", + "reference_doctype", + "reference_docname", + "payer_name", + "payer_email", + "order_id", + "currency", +) + def get_context(context): context.no_cache = 1 @@ -23,20 +34,25 @@ def get_context(context): context.publishable_key = get_api_key(context.reference_docname, gateway_controller) context.image = get_header_image(context.reference_docname, gateway_controller) - context['amount'] = fmt_money(amount=context['amount'], currency=context['currency']) + context["amount"] = fmt_money(amount=context["amount"], currency=context["currency"]) if is_a_subscription(context.reference_doctype, context.reference_docname): - payment_plan = frappe.db.get_value(context.reference_doctype, context.reference_docname, "payment_plan") + payment_plan = frappe.db.get_value( + context.reference_doctype, context.reference_docname, "payment_plan" + ) recurrence = frappe.db.get_value("Payment Plan", payment_plan, "recurrence") - context['amount'] = context['amount'] + " " + _(recurrence) + context["amount"] = context["amount"] + " " + _(recurrence) else: - frappe.redirect_to_message(_('Some information is missing'), - _('Looks like someone sent you to an incomplete URL. Please ask them to look into it.')) + frappe.redirect_to_message( + _("Some information is missing"), + _("Looks like someone sent you to an incomplete URL. Please ask them to look into it."), + ) frappe.local.flags.redirect_location = frappe.local.response.location raise frappe.Redirect + def get_api_key(doc, gateway_controller): publishable_key = frappe.db.get_value("Stripe Settings", gateway_controller, "publishable_key") if cint(frappe.form_dict.get("use_sandbox")): @@ -44,31 +60,32 @@ def get_api_key(doc, gateway_controller): return publishable_key + def get_header_image(doc, gateway_controller): header_image = frappe.db.get_value("Stripe Settings", gateway_controller, "header_img") return header_image + @frappe.whitelist(allow_guest=True) def make_payment(stripe_token_id, data, reference_doctype=None, reference_docname=None): data = json.loads(data) - data.update({ - "stripe_token_id": stripe_token_id - }) + data.update({"stripe_token_id": stripe_token_id}) - gateway_controller = get_gateway_controller(reference_doctype,reference_docname) + gateway_controller = get_gateway_controller(reference_doctype, reference_docname) if is_a_subscription(reference_doctype, reference_docname): reference = frappe.get_doc(reference_doctype, reference_docname) - data = reference.create_subscription("stripe", gateway_controller, data) + data = reference.create_subscription("stripe", gateway_controller, data) else: - data = frappe.get_doc("Stripe Settings", gateway_controller).create_request(data) + data = frappe.get_doc("Stripe Settings", gateway_controller).create_request(data) frappe.db.commit() return data + def is_a_subscription(reference_doctype, reference_docname): - if not frappe.get_meta(reference_doctype).has_field('is_a_subscription'): + if not frappe.get_meta(reference_doctype).has_field("is_a_subscription"): return False - return frappe.db.get_value(reference_doctype, reference_docname, "is_a_subscription") \ No newline at end of file + return frappe.db.get_value(reference_doctype, reference_docname, "is_a_subscription") diff --git a/frappe/test_runner.py b/frappe/test_runner.py index 6c1aae8907..5fa9f60197 100644 --- a/frappe/test_runner.py +++ b/frappe/test_runner.py @@ -1,19 +1,25 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe -import unittest, json, sys, os -import time +import cProfile import importlib -from frappe.modules import load_doctype_module, get_module_name -import frappe.utils.scheduler -import cProfile, pstats -from io import StringIO +import json +import os +import pstats +import sys +import time +import unittest from importlib import reload +from io import StringIO + +import frappe +import frappe.utils.scheduler from frappe.model.naming import revert_series_if_last +from frappe.modules import get_module_name, load_doctype_module unittest_runner = unittest.TextTestRunner SLOW_TEST_THRESHOLD = 2 + def xmlrunner_wrapper(output): """Convenience wrapper to keep method signature unchanged for XMLTestRunner and TextTestRunner""" try: @@ -24,26 +30,42 @@ def xmlrunner_wrapper(output): raise def _runner(*args, **kwargs): - kwargs['output'] = output + kwargs["output"] = output return xmlrunner.XMLTestRunner(*args, **kwargs) + return _runner -def main(app=None, module=None, doctype=None, verbose=False, tests=(), - force=False, profile=False, junit_xml_output=None, ui_tests=False, - doctype_list_path=None, skip_test_records=False, failfast=False, case=None): + +def main( + app=None, + module=None, + doctype=None, + verbose=False, + tests=(), + force=False, + profile=False, + junit_xml_output=None, + ui_tests=False, + doctype_list_path=None, + skip_test_records=False, + failfast=False, + case=None, +): global unittest_runner if doctype_list_path: app, doctype_list_path = doctype_list_path.split(os.path.sep, 1) - with open(frappe.get_app_path(app, doctype_list_path), 'r') as f: + with open(frappe.get_app_path(app, doctype_list_path), "r") as f: doctype = f.read().strip().splitlines() if ui_tests: - print("Selenium testing has been deprecated\nUse bench --site {site_name} run-ui-tests for Cypress tests") + print( + "Selenium testing has been deprecated\nUse bench --site {site_name} run-ui-tests for Cypress tests" + ) xmloutput_fh = None if junit_xml_output: - xmloutput_fh = open(junit_xml_output, 'wb') + xmloutput_fh = open(junit_xml_output, "wb") unittest_runner = xmlrunner_wrapper(xmloutput_fh) else: unittest_runner = unittest.TextTestRunner @@ -62,7 +84,7 @@ def main(app=None, module=None, doctype=None, verbose=False, tests=(), frappe.utils.scheduler.disable_scheduler() set_test_email_config() - frappe.conf.update({'bench_id': 'test_bench', 'use_rq_auth': False}) + frappe.conf.update({"bench_id": "test_bench", "use_rq_auth": False}) if not frappe.flags.skip_before_tests: if verbose: @@ -71,16 +93,29 @@ def main(app=None, module=None, doctype=None, verbose=False, tests=(), frappe.get_attr(fn)() if doctype: - ret = run_tests_for_doctype(doctype, verbose, tests, force, profile, failfast=failfast, junit_xml_output=junit_xml_output) + ret = run_tests_for_doctype( + doctype, verbose, tests, force, profile, failfast=failfast, junit_xml_output=junit_xml_output + ) elif module: - ret = run_tests_for_module(module, verbose, tests, profile, failfast=failfast, junit_xml_output=junit_xml_output, case=case) + ret = run_tests_for_module( + module, + verbose, + tests, + profile, + failfast=failfast, + junit_xml_output=junit_xml_output, + case=case, + ) else: - ret = run_all_tests(app, verbose, profile, ui_tests, failfast=failfast, junit_xml_output=junit_xml_output) + ret = run_all_tests( + app, verbose, profile, ui_tests, failfast=failfast, junit_xml_output=junit_xml_output + ) if not scheduler_disabled_by_user: frappe.utils.scheduler.enable_scheduler() - if frappe.db: frappe.db.commit() + if frappe.db: + frappe.db.commit() # workaround! since there is no separate test db frappe.clear_cache() @@ -93,13 +128,15 @@ def main(app=None, module=None, doctype=None, verbose=False, tests=(), def set_test_email_config(): - frappe.conf.update({ - "auto_email_id": "test@example.com", - "mail_server": "smtp.example.com", - "mail_login": "test@example.com", - "mail_password": "test", - "admin_password": "admin" - }) + frappe.conf.update( + { + "auto_email_id": "test@example.com", + "mail_server": "smtp.example.com", + "mail_login": "test@example.com", + "mail_password": "test", + "admin_password": "admin", + } + ) class TimeLoggingTestResult(unittest.TextTestResult): @@ -115,7 +152,9 @@ class TimeLoggingTestResult(unittest.TextTestResult): super(TimeLoggingTestResult, self).addSuccess(test) -def run_all_tests(app=None, verbose=False, profile=False, ui_tests=False, failfast=False, junit_xml_output=False): +def run_all_tests( + app=None, verbose=False, profile=False, ui_tests=False, failfast=False, junit_xml_output=False +): import os apps = [app] if app else frappe.get_installed_apps() @@ -123,7 +162,7 @@ def run_all_tests(app=None, verbose=False, profile=False, ui_tests=False, failfa test_suite = unittest.TestSuite() for app in apps: for path, folders, files in os.walk(frappe.get_pymodule_path(app)): - for dontwalk in ('locals', '.git', 'public', '__pycache__'): + for dontwalk in ("locals", ".git", "public", "__pycache__"): if dontwalk in folders: folders.remove(dontwalk) @@ -133,16 +172,16 @@ def run_all_tests(app=None, verbose=False, profile=False, ui_tests=False, failfa # print path for filename in files: - if filename.startswith("test_") and filename.endswith(".py")\ - and filename != 'test_runner.py': + if filename.startswith("test_") and filename.endswith(".py") and filename != "test_runner.py": # print filename[:-3] - _add_test(app, path, filename, verbose, - test_suite, ui_tests) + _add_test(app, path, filename, verbose, test_suite, ui_tests) if junit_xml_output: - runner = unittest_runner(verbosity=1+(verbose and 1 or 0), failfast=failfast) + runner = unittest_runner(verbosity=1 + (verbose and 1 or 0), failfast=failfast) else: - runner = unittest_runner(resultclass=TimeLoggingTestResult, verbosity=1+(verbose and 1 or 0), failfast=failfast) + runner = unittest_runner( + resultclass=TimeLoggingTestResult, verbosity=1 + (verbose and 1 or 0), failfast=failfast + ) if profile: pr = cProfile.Profile() @@ -153,13 +192,22 @@ def run_all_tests(app=None, verbose=False, profile=False, ui_tests=False, failfa if profile: pr.disable() s = StringIO() - ps = pstats.Stats(pr, stream=s).sort_stats('cumulative') + ps = pstats.Stats(pr, stream=s).sort_stats("cumulative") ps.print_stats() print(s.getvalue()) return out -def run_tests_for_doctype(doctypes, verbose=False, tests=(), force=False, profile=False, failfast=False, junit_xml_output=False): + +def run_tests_for_doctype( + doctypes, + verbose=False, + tests=(), + force=False, + profile=False, + failfast=False, + junit_xml_output=False, +): modules = [] if not isinstance(doctypes, (list, tuple)): doctypes = [doctypes] @@ -167,7 +215,7 @@ def run_tests_for_doctype(doctypes, verbose=False, tests=(), force=False, profil for doctype in doctypes: module = frappe.db.get_value("DocType", doctype, "module") if not module: - print('Invalid doctype {0}'.format(doctype)) + print("Invalid doctype {0}".format(doctype)) sys.exit(1) test_module = get_module_name(doctype, module, "test_") @@ -177,18 +225,39 @@ def run_tests_for_doctype(doctypes, verbose=False, tests=(), force=False, profil make_test_records(doctype, verbose=verbose, force=force) modules.append(importlib.import_module(test_module)) - return _run_unittest(modules, verbose=verbose, tests=tests, profile=profile, failfast=failfast, junit_xml_output=junit_xml_output) + return _run_unittest( + modules, + verbose=verbose, + tests=tests, + profile=profile, + failfast=failfast, + junit_xml_output=junit_xml_output, + ) -def run_tests_for_module(module, verbose=False, tests=(), profile=False, failfast=False, junit_xml_output=False, case=None): + +def run_tests_for_module( + module, verbose=False, tests=(), profile=False, failfast=False, junit_xml_output=False, case=None +): module = importlib.import_module(module) if hasattr(module, "test_dependencies"): for doctype in module.test_dependencies: make_test_records(doctype, verbose=verbose) frappe.db.commit() - return _run_unittest(module, verbose=verbose, tests=tests, profile=profile, failfast=failfast, junit_xml_output=junit_xml_output, case=case) - -def _run_unittest(modules, verbose=False, tests=(), profile=False, failfast=False, junit_xml_output=False, case=None): + return _run_unittest( + module, + verbose=verbose, + tests=tests, + profile=profile, + failfast=failfast, + junit_xml_output=junit_xml_output, + case=case, + ) + + +def _run_unittest( + modules, verbose=False, tests=(), profile=False, failfast=False, junit_xml_output=False, case=None +): frappe.db.begin() test_suite = unittest.TestSuite() @@ -210,9 +279,11 @@ def _run_unittest(modules, verbose=False, tests=(), profile=False, failfast=Fals test_suite.addTest(module_test_cases) if junit_xml_output: - runner = unittest_runner(verbosity=1+(verbose and 1 or 0), failfast=failfast) + runner = unittest_runner(verbosity=1 + (verbose and 1 or 0), failfast=failfast) else: - runner = unittest_runner(resultclass=TimeLoggingTestResult, verbosity=1+(verbose and 1 or 0), failfast=failfast) + runner = unittest_runner( + resultclass=TimeLoggingTestResult, verbosity=1 + (verbose and 1 or 0), failfast=failfast + ) if profile: pr = cProfile.Profile() @@ -222,16 +293,16 @@ def _run_unittest(modules, verbose=False, tests=(), profile=False, failfast=Fals out = runner.run(test_suite) - if profile: pr.disable() s = StringIO() - ps = pstats.Stats(pr, stream=s).sort_stats('cumulative') + ps = pstats.Stats(pr, stream=s).sort_stats("cumulative") ps.print_stats() print(s.getvalue()) return out + def _add_test(app, path, filename, verbose, test_suite=None, ui_tests=False): import os @@ -241,11 +312,12 @@ def _add_test(app, path, filename, verbose, test_suite=None, ui_tests=False): app_path = frappe.get_pymodule_path(app) relative_path = os.path.relpath(path, app_path) - if relative_path=='.': + if relative_path == ".": module_name = app else: - module_name = '{app}.{relative_path}.{module_name}'.format(app=app, - relative_path=relative_path.replace('/', '.'), module_name=filename[:-3]) + module_name = "{app}.{relative_path}.{module_name}".format( + app=app, relative_path=relative_path.replace("/", "."), module_name=filename[:-3] + ) module = importlib.import_module(module_name) @@ -253,7 +325,7 @@ def _add_test(app, path, filename, verbose, test_suite=None, ui_tests=False): for doctype in module.test_dependencies: make_test_records(doctype, verbose=verbose) - is_ui_test = True if hasattr(module, 'TestDriver') else False + is_ui_test = True if hasattr(module, "TestDriver") else False if is_ui_test != ui_tests: return @@ -261,16 +333,17 @@ def _add_test(app, path, filename, verbose, test_suite=None, ui_tests=False): if not test_suite: test_suite = unittest.TestSuite() - if os.path.basename(os.path.dirname(path))=="doctype": + if os.path.basename(os.path.dirname(path)) == "doctype": txt_file = os.path.join(path, filename[5:].replace(".py", ".json")) if os.path.exists(txt_file): - with open(txt_file, 'r') as f: + with open(txt_file, "r") as f: doc = json.loads(f.read()) doctype = doc["name"] make_test_records(doctype, verbose) test_suite.addTest(unittest.TestLoader().loadTestsFromModule(module)) + def make_test_records(doctype, verbose=0, force=False): if not frappe.db: frappe.connect() @@ -287,6 +360,7 @@ def make_test_records(doctype, verbose=0, force=False): make_test_records(options, verbose, force) make_test_records_for_doctype(options, verbose, force) + def get_modules(doctype): module = frappe.db.get_value("DocType", doctype, "module") try: @@ -298,6 +372,7 @@ def get_modules(doctype): return module, test_module + def get_dependencies(doctype): module, test_module = get_modules(doctype) meta = frappe.get_meta(doctype) @@ -322,6 +397,7 @@ def get_dependencies(doctype): return options_list + def make_test_records_for_doctype(doctype, verbose=0, force=False): if not force and doctype in get_test_record_log(): return @@ -336,9 +412,13 @@ def make_test_records_for_doctype(doctype, verbose=0, force=False): elif hasattr(test_module, "test_records"): if doctype in frappe.local.test_objects: - frappe.local.test_objects[doctype] += make_test_objects(doctype, test_module.test_records, verbose, force) + frappe.local.test_objects[doctype] += make_test_objects( + doctype, test_module.test_records, verbose, force + ) else: - frappe.local.test_objects[doctype] = make_test_objects(doctype, test_module.test_records, verbose, force) + frappe.local.test_objects[doctype] = make_test_objects( + doctype, test_module.test_records, verbose, force + ) else: test_records = frappe.get_test_records(doctype) @@ -350,15 +430,15 @@ def make_test_records_for_doctype(doctype, verbose=0, force=False): add_to_test_record_log(doctype) + def make_test_objects(doctype, test_records=None, verbose=None, reset=False): - '''Make test objects from given list of `test_records` or from `test_records.json`''' + """Make test objects from given list of `test_records` or from `test_records.json`""" records = [] def revert_naming(d): - if getattr(d, 'naming_series', None): + if getattr(d, "naming_series", None): revert_series_if_last(d.naming_series, d.name) - if test_records is None: test_records = frappe.get_test_records(doctype) @@ -372,8 +452,8 @@ def make_test_objects(doctype, test_records=None, verbose=None, reset=False): if not d.naming_series: d.naming_series = "_T-" + d.doctype + "-" - if doc.get('name'): - d.name = doc.get('name') + if doc.get("name"): + d.name = doc.get("name") else: d.set_new_name() @@ -398,7 +478,10 @@ def make_test_objects(doctype, test_records=None, verbose=None, reset=False): revert_naming(d) except Exception as e: - if d.flags.ignore_these_exceptions_in_test and e.__class__ in d.flags.ignore_these_exceptions_in_test: + if ( + d.flags.ignore_these_exceptions_in_test + and e.__class__ in d.flags.ignore_these_exceptions_in_test + ): revert_naming(d) else: raise @@ -408,30 +491,33 @@ def make_test_objects(doctype, test_records=None, verbose=None, reset=False): frappe.db.commit() return records + def print_mandatory_fields(doctype): print("Please setup make_test_records for: " + doctype) print("-" * 60) meta = frappe.get_meta(doctype) print("Autoname: " + (meta.autoname or "")) print("Mandatory Fields: ") - for d in meta.get("fields", {"reqd":1}): + for d in meta.get("fields", {"reqd": 1}): print(d.parent + ":" + d.fieldname + " | " + d.fieldtype + " | " + (d.options or "")) print() + def add_to_test_record_log(doctype): - '''Add `doctype` to site/.test_log - `.test_log` is a cache of all doctypes for which test records are created''' + """Add `doctype` to site/.test_log + `.test_log` is a cache of all doctypes for which test records are created""" test_record_log = get_test_record_log() if doctype not in test_record_log: frappe.flags.test_record_log.append(doctype) - with open(frappe.get_site_path('.test_log'), 'w') as f: - f.write('\n'.join(filter(None, frappe.flags.test_record_log))) + with open(frappe.get_site_path(".test_log"), "w") as f: + f.write("\n".join(filter(None, frappe.flags.test_record_log))) + def get_test_record_log(): - '''Return the list of doctypes for which test records have been created''' - if 'test_record_log' not in frappe.flags: - if os.path.exists(frappe.get_site_path('.test_log')): - with open(frappe.get_site_path('.test_log'), 'r') as f: + """Return the list of doctypes for which test records have been created""" + if "test_record_log" not in frappe.flags: + if os.path.exists(frappe.get_site_path(".test_log")): + with open(frappe.get_site_path(".test_log"), "r") as f: frappe.flags.test_record_log = f.read().splitlines() else: frappe.flags.test_record_log = [] diff --git a/frappe/tests/__init__.py b/frappe/tests/__init__.py index a310864d83..5a44cae5f1 100644 --- a/frappe/tests/__init__.py +++ b/frappe/tests/__init__.py @@ -1,12 +1,15 @@ import frappe + def update_system_settings(args): - doc = frappe.get_doc('System Settings') + doc = frappe.get_doc("System Settings") doc.update(args) doc.flags.ignore_mandatory = 1 doc.save() + def get_system_setting(key): return frappe.db.get_single_value("System Settings", key) -global_test_dependencies = ['User'] + +global_test_dependencies = ["User"] diff --git a/frappe/tests/test_api.py b/frappe/tests/test_api.py index 8d41545c4c..bbb2280578 100644 --- a/frappe/tests/test_api.py +++ b/frappe/tests/test_api.py @@ -20,6 +20,7 @@ except Exception: authorization_token = None + @contextmanager def suppress_stdout(): """Supress stdout for tests which expectedly make noise @@ -31,7 +32,9 @@ def suppress_stdout(): sys.stdout = sys.__stdout__ -def make_request(target: str, args: Optional[Tuple] = None, kwargs: Optional[Dict] = None) -> TestResponse: +def make_request( + target: str, args: Optional[Tuple] = None, kwargs: Optional[Dict] = None +) -> TestResponse: t = ThreadWithReturnValue(target=target, args=args, kwargs=kwargs) t.start() t.join() @@ -78,22 +81,22 @@ class FrappeAPITestCase(unittest.TestCase): set_request(path="/") frappe.local.cookie_manager = CookieManager() frappe.local.login_manager = LoginManager() - frappe.local.login_manager.login_as('Administrator') + frappe.local.login_manager.login_as("Administrator") self._sid = frappe.session.sid return self._sid def get(self, path: str, params: Optional[Dict] = None, **kwargs) -> TestResponse: - return make_request(target=self.TEST_CLIENT.get, args=(path, ), kwargs={"data": params, **kwargs}) + return make_request(target=self.TEST_CLIENT.get, args=(path,), kwargs={"data": params, **kwargs}) def post(self, path, data, **kwargs) -> TestResponse: - return make_request(target=self.TEST_CLIENT.post, args=(path, ), kwargs={"data": data, **kwargs}) + return make_request(target=self.TEST_CLIENT.post, args=(path,), kwargs={"data": data, **kwargs}) def put(self, path, data, **kwargs) -> TestResponse: - return make_request(target=self.TEST_CLIENT.put, args=(path, ), kwargs={"data": data, **kwargs}) + return make_request(target=self.TEST_CLIENT.put, args=(path,), kwargs={"data": data, **kwargs}) def delete(self, path, **kwargs) -> TestResponse: - return make_request(target=self.TEST_CLIENT.delete, args=(path, ), kwargs=kwargs) + return make_request(target=self.TEST_CLIENT.delete, args=(path,), kwargs=kwargs) class TestResourceAPI(FrappeAPITestCase): @@ -103,9 +106,7 @@ class TestResourceAPI(FrappeAPITestCase): @classmethod def setUpClass(cls): for _ in range(10): - doc = frappe.get_doc( - {"doctype": "ToDo", "description": frappe.mock("paragraph")} - ).insert() + doc = frappe.get_doc({"doctype": "ToDo", "description": frappe.mock("paragraph")}).insert() cls.GENERATED_DOCUMENTS.append(doc.name) frappe.db.commit() @@ -157,7 +158,9 @@ class TestResourceAPI(FrappeAPITestCase): def test_get_list_fields(self): # test 6: fetch response with fields - response = self.get(f"/api/resource/{self.DOCTYPE}", {"sid": self.sid, "fields": '["description"]'}) + response = self.get( + f"/api/resource/{self.DOCTYPE}", {"sid": self.sid, "fields": '["description"]'} + ) self.assertEqual(response.status_code, 200) json = frappe._dict(response.json) self.assertIn("description", json.data[0]) @@ -205,10 +208,14 @@ class TestResourceAPI(FrappeAPITestCase): self.assertIn(response.status_code, (403, 200)) if response.status_code == 403: - self.assertTrue(set(response.json.keys()) == {'exc_type', 'exception', 'exc', '_server_messages'}) - self.assertEqual(response.json.get('exc_type'), 'PermissionError') - self.assertEqual(response.json.get('exception'), 'frappe.exceptions.PermissionError: Not permitted') - self.assertIsInstance(response.json.get('exc'), str) + self.assertTrue( + set(response.json.keys()) == {"exc_type", "exception", "exc", "_server_messages"} + ) + self.assertEqual(response.json.get("exc_type"), "PermissionError") + self.assertEqual( + response.json.get("exception"), "frappe.exceptions.PermissionError: Not permitted" + ) + self.assertIsInstance(response.json.get("exc"), str) elif response.status_code == 200: data = response.json.get("data") @@ -222,6 +229,7 @@ class TestMethodAPI(FrappeAPITestCase): def setUp(self): if self._testMethodName == "test_auth_cycle": from frappe.core.doctype.user.user import generate_keys + generate_keys("Administrator") frappe.db.commit() diff --git a/frappe/tests/test_assign.py b/frappe/tests/test_assign.py index 48fe4e04e5..aa646d2827 100644 --- a/frappe/tests/test_assign.py +++ b/frappe/tests/test_assign.py @@ -1,16 +1,19 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest + +import frappe import frappe.desk.form.assign_to -from frappe.desk.listview import get_group_by_count from frappe.automation.doctype.assignment_rule.test_assignment_rule import make_note from frappe.desk.form.load import get_assignments +from frappe.desk.listview import get_group_by_count + class TestAssign(unittest.TestCase): def test_assign(self): - todo = frappe.get_doc({"doctype":"ToDo", "description": "test"}).insert() + todo = frappe.get_doc({"doctype": "ToDo", "description": "test"}).insert() if not frappe.db.exists("User", "test@example.com"): - frappe.get_doc({"doctype":"User", "email":"test@example.com", "first_name":"Test"}).insert() + frappe.get_doc({"doctype": "User", "email": "test@example.com", "first_name": "Test"}).insert() added = assign(todo, "test@example.com") @@ -19,17 +22,31 @@ class TestAssign(unittest.TestCase): removed = frappe.desk.form.assign_to.remove(todo.doctype, todo.name, "test@example.com") # assignment is cleared - assignments = frappe.desk.form.assign_to.get(dict(doctype = todo.doctype, name=todo.name)) + assignments = frappe.desk.form.assign_to.get(dict(doctype=todo.doctype, name=todo.name)) self.assertEqual(len(assignments), 0) def test_assignment_count(self): frappe.db.delete("ToDo") if not frappe.db.exists("User", "test_assign1@example.com"): - frappe.get_doc({"doctype":"User", "email":"test_assign1@example.com", "first_name":"Test", "roles": [{"role": "System Manager"}]}).insert() + frappe.get_doc( + { + "doctype": "User", + "email": "test_assign1@example.com", + "first_name": "Test", + "roles": [{"role": "System Manager"}], + } + ).insert() if not frappe.db.exists("User", "test_assign2@example.com"): - frappe.get_doc({"doctype":"User", "email":"test_assign2@example.com", "first_name":"Test", "roles": [{"role": "System Manager"}]}).insert() + frappe.get_doc( + { + "doctype": "User", + "email": "test_assign2@example.com", + "first_name": "Test", + "roles": [{"role": "System Manager"}], + } + ).insert() note = make_note() assign(note, "test_assign1@example.com") @@ -43,23 +60,23 @@ class TestAssign(unittest.TestCase): note = make_note() assign(note, "test_assign2@example.com") - data = {d.name: d.count for d in get_group_by_count('Note', '[]', 'assigned_to')} + data = {d.name: d.count for d in get_group_by_count("Note", "[]", "assigned_to")} - self.assertTrue('test_assign1@example.com' in data) - self.assertEqual(data['test_assign1@example.com'], 1) - self.assertEqual(data['test_assign2@example.com'], 3) + self.assertTrue("test_assign1@example.com" in data) + self.assertEqual(data["test_assign1@example.com"], 1) + self.assertEqual(data["test_assign2@example.com"], 3) - data = {d.name: d.count for d in get_group_by_count('Note', '[{"public": 1}]', 'assigned_to')} + data = {d.name: d.count for d in get_group_by_count("Note", '[{"public": 1}]', "assigned_to")} - self.assertFalse('test_assign1@example.com' in data) - self.assertEqual(data['test_assign2@example.com'], 2) + self.assertFalse("test_assign1@example.com" in data) + self.assertEqual(data["test_assign2@example.com"], 2) frappe.db.rollback() def test_assignment_removal(self): - todo = frappe.get_doc({"doctype":"ToDo", "description": "test"}).insert() + todo = frappe.get_doc({"doctype": "ToDo", "description": "test"}).insert() if not frappe.db.exists("User", "test@example.com"): - frappe.get_doc({"doctype":"User", "email":"test@example.com", "first_name":"Test"}).insert() + frappe.get_doc({"doctype": "User", "email": "test@example.com", "first_name": "Test"}).insert() new_todo = assign(todo, "test@example.com") @@ -68,10 +85,13 @@ class TestAssign(unittest.TestCase): self.assertFalse(get_assignments("ToDo", todo.name)) + def assign(doc, user): - return frappe.desk.form.assign_to.add({ - "assign_to": [user], - "doctype": doc.doctype, - "name": doc.name, - "description": 'test', - }) + return frappe.desk.form.assign_to.add( + { + "assign_to": [user], + "doctype": doc.doctype, + "name": doc.name, + "description": "test", + } + ) diff --git a/frappe/tests/test_auth.py b/frappe/tests/test_auth.py index ae4f78735b..b9c492715c 100644 --- a/frappe/tests/test_auth.py +++ b/frappe/tests/test_auth.py @@ -6,14 +6,14 @@ import unittest import frappe import frappe.utils from frappe.auth import LoginAttemptTracker -from frappe.frappeclient import FrappeClient, AuthError +from frappe.frappeclient import AuthError, FrappeClient def add_user(email, password, username=None, mobile_no=None): - first_name = email.split('@', 1)[0] + first_name = email.split("@", 1)[0] user = frappe.get_doc( - dict(doctype='User', email=email, first_name=first_name, username=username, mobile_no=mobile_no) - ).insert() + dict(doctype="User", email=email, first_name=first_name, username=username, mobile_no=mobile_no) + ).insert() user.new_password = password user.add_roles("System Manager") frappe.db.commit() @@ -22,22 +22,25 @@ def add_user(email, password, username=None, mobile_no=None): class TestAuth(unittest.TestCase): @classmethod def setUpClass(cls): - cls.HOST_NAME = ( - frappe.get_site_config().host_name - or frappe.utils.get_site_url(frappe.local.site) + cls.HOST_NAME = frappe.get_site_config().host_name or frappe.utils.get_site_url( + frappe.local.site ) - cls.test_user_email = 'test_auth@test.com' - cls.test_user_name = 'test_auth_user' - cls.test_user_mobile = '+911234567890' - cls.test_user_password = 'pwd_012' + cls.test_user_email = "test_auth@test.com" + cls.test_user_name = "test_auth_user" + cls.test_user_mobile = "+911234567890" + cls.test_user_password = "pwd_012" cls.tearDownClass() - add_user(email=cls.test_user_email, password=cls.test_user_password, - username=cls.test_user_name, mobile_no=cls.test_user_mobile) + add_user( + email=cls.test_user_email, + password=cls.test_user_password, + username=cls.test_user_name, + mobile_no=cls.test_user_mobile, + ) @classmethod def tearDownClass(cls): - frappe.delete_doc('User', cls.test_user_email, force=True) + frappe.delete_doc("User", cls.test_user_email, force=True) def set_system_settings(self, k, v): frappe.db.set_value("System Settings", "System Settings", k, v) @@ -45,8 +48,8 @@ class TestAuth(unittest.TestCase): frappe.db.commit() def test_allow_login_using_mobile(self): - self.set_system_settings('allow_login_using_mobile_number', 1) - self.set_system_settings('allow_login_using_user_name', 0) + self.set_system_settings("allow_login_using_mobile_number", 1) + self.set_system_settings("allow_login_using_user_name", 0) # Login by both email and mobile should work FrappeClient(self.HOST_NAME, self.test_user_mobile, self.test_user_password) @@ -57,8 +60,8 @@ class TestAuth(unittest.TestCase): FrappeClient(self.HOST_NAME, self.test_user_name, self.test_user_password) def test_allow_login_using_only_email(self): - self.set_system_settings('allow_login_using_mobile_number', 0) - self.set_system_settings('allow_login_using_user_name', 0) + self.set_system_settings("allow_login_using_mobile_number", 0) + self.set_system_settings("allow_login_using_user_name", 0) # Login by mobile number should fail with self.assertRaises(AuthError): @@ -72,8 +75,8 @@ class TestAuth(unittest.TestCase): FrappeClient(self.HOST_NAME, self.test_user_email, self.test_user_password) def test_allow_login_using_username(self): - self.set_system_settings('allow_login_using_mobile_number', 0) - self.set_system_settings('allow_login_using_user_name', 1) + self.set_system_settings("allow_login_using_mobile_number", 0) + self.set_system_settings("allow_login_using_user_name", 1) # Mobile login should fail with self.assertRaises(AuthError): @@ -84,8 +87,8 @@ class TestAuth(unittest.TestCase): FrappeClient(self.HOST_NAME, self.test_user_name, self.test_user_password) def test_allow_login_using_username_and_mobile(self): - self.set_system_settings('allow_login_using_mobile_number', 1) - self.set_system_settings('allow_login_using_user_name', 1) + self.set_system_settings("allow_login_using_mobile_number", 1) + self.set_system_settings("allow_login_using_user_name", 1) # Both email and username and mobile logins should work FrappeClient(self.HOST_NAME, self.test_user_mobile, self.test_user_password) @@ -93,7 +96,7 @@ class TestAuth(unittest.TestCase): FrappeClient(self.HOST_NAME, self.test_user_name, self.test_user_password) def test_deny_multiple_login(self): - self.set_system_settings('deny_multiple_sessions', 1) + self.set_system_settings("deny_multiple_sessions", 1) first_login = FrappeClient(self.HOST_NAME, self.test_user_email, self.test_user_password) first_login.get_list("ToDo") @@ -113,9 +116,10 @@ class TestAuth(unittest.TestCase): class TestLoginAttemptTracker(unittest.TestCase): def test_account_lock(self): - """Make sure that account locks after `n consecutive failures - """ - tracker = LoginAttemptTracker(user_name='tester', max_consecutive_login_attempts=3, lock_interval=60) + """Make sure that account locks after `n consecutive failures""" + tracker = LoginAttemptTracker( + user_name="tester", max_consecutive_login_attempts=3, lock_interval=60 + ) # Clear the cache by setting attempt as success tracker.add_success_attempt() @@ -132,10 +136,11 @@ class TestLoginAttemptTracker(unittest.TestCase): self.assertFalse(tracker.is_user_allowed()) def test_account_unlock(self): - """Make sure that locked account gets unlocked after lock_interval of time. - """ - lock_interval = 2 # In sec - tracker = LoginAttemptTracker(user_name='tester', max_consecutive_login_attempts=1, lock_interval=lock_interval) + """Make sure that locked account gets unlocked after lock_interval of time.""" + lock_interval = 2 # In sec + tracker = LoginAttemptTracker( + user_name="tester", max_consecutive_login_attempts=1, lock_interval=lock_interval + ) # Clear the cache by setting attempt as success tracker.add_success_attempt() diff --git a/frappe/tests/test_background_jobs.py b/frappe/tests/test_background_jobs.py index 75f6cc8fe3..6c7dda51f1 100644 --- a/frappe/tests/test_background_jobs.py +++ b/frappe/tests/test_background_jobs.py @@ -1,11 +1,11 @@ +import time import unittest from rq import Queue import frappe from frappe.core.page.background_jobs.background_jobs import remove_failed_jobs -from frappe.utils.background_jobs import get_redis_conn, generate_qname -import time +from frappe.utils.background_jobs import generate_qname, get_redis_conn class TestBackgroundJobs(unittest.TestCase): diff --git a/frappe/tests/test_boilerplate.py b/frappe/tests/test_boilerplate.py index 6a9544b2e9..4dfb6e615b 100644 --- a/frappe/tests/test_boilerplate.py +++ b/frappe/tests/test_boilerplate.py @@ -42,7 +42,7 @@ class TestBoilerPlate(unittest.TestCase): "setup.py", "license.txt", cls.git_folder, - cls.gitignore_file + cls.gitignore_file, ] cls.paths_inside_app = [ "__init__.py", @@ -52,7 +52,7 @@ class TestBoilerPlate(unittest.TestCase): "www", "config", "modules.txt", - "public" + "public", ] @classmethod @@ -70,10 +70,7 @@ class TestBoilerPlate(unittest.TestCase): paths = self.get_paths(new_app_dir, self.app_names[0]) for path in paths: - self.assertTrue( - os.path.exists(path), - msg=f"{path} should exist in {self.app_names[0]} app" - ) + self.assertTrue(os.path.exists(path), msg=f"{path} should exist in {self.app_names[0]} app") self.check_parsable_python_files(new_app_dir) @@ -87,14 +84,10 @@ class TestBoilerPlate(unittest.TestCase): for path in paths: if os.path.basename(path) in (self.git_folder, self.gitignore_file): self.assertFalse( - os.path.exists(path), - msg=f"{path} shouldn't exist in {self.app_names[1]} app" + os.path.exists(path), msg=f"{path} shouldn't exist in {self.app_names[1]} app" ) else: - self.assertTrue( - os.path.exists(path), - msg=f"{path} should exist in {self.app_names[1]} app" - ) + self.assertTrue(os.path.exists(path), msg=f"{path} should exist in {self.app_names[1]} app") self.check_parsable_python_files(new_app_dir) diff --git a/frappe/tests/test_bot.py b/frappe/tests/test_bot.py index 9d20895338..222f35b99b 100644 --- a/frappe/tests/test_bot.py +++ b/frappe/tests/test_bot.py @@ -5,5 +5,6 @@ import unittest + class TestBot(unittest.TestCase): pass diff --git a/frappe/tests/test_child_table.py b/frappe/tests/test_child_table.py index 8cdfd08599..eb632eac90 100644 --- a/frappe/tests/test_child_table.py +++ b/frappe/tests/test_child_table.py @@ -1,9 +1,9 @@ -import frappe -from frappe.model import child_table_fields - import unittest from typing import Callable +import frappe +from frappe.model import child_table_fields + class TestChildTable(unittest.TestCase): def tearDown(self) -> None: @@ -13,31 +13,29 @@ class TestChildTable(unittest.TestCase): pass def test_child_table_doctype_creation_and_transitioning(self) -> None: - ''' + """ This method tests the creation of child table doctype as well as it's transitioning from child table to normal and normal to child table doctype - ''' + """ self.doctype_name = "Test Newy Child Table" try: - doc = frappe.get_doc({ - "doctype": "DocType", - "name": self.doctype_name, - "istable": 1, - "custom": 1, - "module": "Integrations", - "fields": [{ - "label": "Some Field", - "fieldname": "some_fieldname", - "fieldtype": "Data", - "reqd": 1 - }] - }).insert(ignore_permissions=True) + doc = frappe.get_doc( + { + "doctype": "DocType", + "name": self.doctype_name, + "istable": 1, + "custom": 1, + "module": "Integrations", + "fields": [ + {"label": "Some Field", "fieldname": "some_fieldname", "fieldtype": "Data", "reqd": 1} + ], + } + ).insert(ignore_permissions=True) except Exception: self.fail("Not able to create Child Table Doctype") - for column in child_table_fields: self.assertTrue(frappe.db.has_column(self.doctype_name, column)) @@ -59,7 +57,6 @@ class TestChildTable(unittest.TestCase): self.check_valid_columns(self.assertTrue) - def check_valid_columns(self, assertion_method: Callable) -> None: valid_columns = frappe.get_meta(self.doctype_name).get_valid_columns() for column in child_table_fields: diff --git a/frappe/tests/test_client.py b/frappe/tests/test_client.py index 40639e4f98..1bb2867665 100644 --- a/frappe/tests/test_client.py +++ b/frappe/tests/test_client.py @@ -1,22 +1,23 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors import unittest + import frappe class TestClient(unittest.TestCase): def test_set_value(self): - todo = frappe.get_doc(dict(doctype='ToDo', description='test')).insert() - frappe.set_value('ToDo', todo.name, 'description', 'test 1') - self.assertEqual(frappe.get_value('ToDo', todo.name, 'description'), 'test 1') + todo = frappe.get_doc(dict(doctype="ToDo", description="test")).insert() + frappe.set_value("ToDo", todo.name, "description", "test 1") + self.assertEqual(frappe.get_value("ToDo", todo.name, "description"), "test 1") - frappe.set_value('ToDo', todo.name, {'description': 'test 2'}) - self.assertEqual(frappe.get_value('ToDo', todo.name, 'description'), 'test 2') + frappe.set_value("ToDo", todo.name, {"description": "test 2"}) + self.assertEqual(frappe.get_value("ToDo", todo.name, "description"), "test 2") def test_delete(self): from frappe.client import delete - todo = frappe.get_doc(dict(doctype='ToDo', description='description')).insert() + todo = frappe.get_doc(dict(doctype="ToDo", description="description")).insert() delete("ToDo", todo.name) self.assertFalse(frappe.db.exists("ToDo", todo.name)) @@ -29,15 +30,14 @@ class TestClient(unittest.TestCase): frappe.set_user("Administrator") frappe.local.request = frappe._dict() - frappe.local.request.method = 'POST' + frappe.local.request.method = "POST" - frappe.local.form_dict = frappe._dict({ - 'doc': dict(doctype='ToDo', description='Valid http method'), - 'cmd': 'frappe.client.save' - }) - todo = execute_cmd('frappe.client.save') + frappe.local.form_dict = frappe._dict( + {"doc": dict(doctype="ToDo", description="Valid http method"), "cmd": "frappe.client.save"} + ) + todo = execute_cmd("frappe.client.save") - self.assertEqual(todo.get('description'), 'Valid http method') + self.assertEqual(todo.get("description"), "Valid http method") delete("ToDo", todo.name) @@ -47,87 +47,85 @@ class TestClient(unittest.TestCase): frappe.set_user("Administrator") frappe.local.request = frappe._dict() - frappe.local.request.method = 'GET' + frappe.local.request.method = "GET" - frappe.local.form_dict = frappe._dict({ - 'doc': dict(doctype='ToDo', description='Invalid http method'), - 'cmd': 'frappe.client.save' - }) + frappe.local.form_dict = frappe._dict( + {"doc": dict(doctype="ToDo", description="Invalid http method"), "cmd": "frappe.client.save"} + ) - self.assertRaises(frappe.PermissionError, execute_cmd, 'frappe.client.save') + self.assertRaises(frappe.PermissionError, execute_cmd, "frappe.client.save") def test_run_doc_method(self): from frappe.handler import execute_cmd - if not frappe.db.exists('Report', 'Test Run Doc Method'): - report = frappe.get_doc({ - 'doctype': 'Report', - 'ref_doctype': 'User', - 'report_name': 'Test Run Doc Method', - 'report_type': 'Query Report', - 'is_standard': 'No', - 'roles': [ - {'role': 'System Manager'} - ] - }).insert() + if not frappe.db.exists("Report", "Test Run Doc Method"): + report = frappe.get_doc( + { + "doctype": "Report", + "ref_doctype": "User", + "report_name": "Test Run Doc Method", + "report_type": "Query Report", + "is_standard": "No", + "roles": [{"role": "System Manager"}], + } + ).insert() else: - report = frappe.get_doc('Report', 'Test Run Doc Method') + report = frappe.get_doc("Report", "Test Run Doc Method") frappe.local.request = frappe._dict() - frappe.local.request.method = 'GET' + frappe.local.request.method = "GET" # Whitelisted, works as expected - frappe.local.form_dict = frappe._dict({ - 'dt': report.doctype, - 'dn': report.name, - 'method': 'toggle_disable', - 'cmd': 'run_doc_method', - 'args': 0 - }) + frappe.local.form_dict = frappe._dict( + { + "dt": report.doctype, + "dn": report.name, + "method": "toggle_disable", + "cmd": "run_doc_method", + "args": 0, + } + ) execute_cmd(frappe.local.form_dict.cmd) # Not whitelisted, throws permission error - frappe.local.form_dict = frappe._dict({ - 'dt': report.doctype, - 'dn': report.name, - 'method': 'create_report_py', - 'cmd': 'run_doc_method', - 'args': 0 - }) - - self.assertRaises( - frappe.PermissionError, - execute_cmd, - frappe.local.form_dict.cmd + frappe.local.form_dict = frappe._dict( + { + "dt": report.doctype, + "dn": report.name, + "method": "create_report_py", + "cmd": "run_doc_method", + "args": 0, + } ) + self.assertRaises(frappe.PermissionError, execute_cmd, frappe.local.form_dict.cmd) + def test_array_values_in_request_args(self): import requests + from frappe.auth import CookieManager, LoginManager frappe.utils.set_request(path="/") frappe.local.cookie_manager = CookieManager() frappe.local.login_manager = LoginManager() - frappe.local.login_manager.login_as('Administrator') + frappe.local.login_manager.login_as("Administrator") params = { - 'doctype': 'DocType', - 'fields': ['name', 'modified'], - 'sid': frappe.session.sid, + "doctype": "DocType", + "fields": ["name", "modified"], + "sid": frappe.session.sid, } headers = { - 'accept': 'application/json', - 'content-type': 'application/json', + "accept": "application/json", + "content-type": "application/json", } - url = f'http://{frappe.local.site}:{frappe.conf.webserver_port}/api/method/frappe.client.get_list' - res = requests.post( - url, - json=params, - headers=headers + url = ( + f"http://{frappe.local.site}:{frappe.conf.webserver_port}/api/method/frappe.client.get_list" ) + res = requests.post(url, json=params, headers=headers) self.assertEqual(res.status_code, 200) data = res.json() - first_item = data['message'][0] - self.assertTrue('name' in first_item) - self.assertTrue('modified' in first_item) + first_item = data["message"][0] + self.assertTrue("name" in first_item) + self.assertTrue("modified" in first_item) frappe.local.login_manager.logout() diff --git a/frappe/tests/test_commands.py b/frappe/tests/test_commands.py index 68605444f1..67de6c6e41 100644 --- a/frappe/tests/test_commands.py +++ b/frappe/tests/test_commands.py @@ -19,8 +19,8 @@ from unittest.mock import patch # imports - third party imports import click -from click.testing import CliRunner, Result from click import Command +from click.testing import CliRunner, Result # imports - module imports import frappe @@ -32,7 +32,7 @@ from frappe.utils import add_to_date, get_bench_path, get_bench_relative_path, n from frappe.utils.backups import fetch_latest_backups _result: Optional[Result] = None -TEST_SITE = "commands-site-O4PN2QKA.test" # added random string tag to avoid collisions +TEST_SITE = "commands-site-O4PN2QKA.test" # added random string tag to avoid collisions CLI_CONTEXT = frappe._dict(sites=[TEST_SITE]) @@ -40,10 +40,10 @@ def clean(value) -> str: """Strips and converts bytes to str Args: - value ([type]): [description] + value ([type]): [description] Returns: - [type]: [description] + [type]: [description] """ if isinstance(value, bytes): value = value.decode() @@ -56,33 +56,28 @@ def missing_in_backup(doctypes: List, file: os.PathLike) -> List: """Returns list of missing doctypes in the backup. Args: - doctypes (list): List of DocTypes to be checked - file (str): Path of the database file + doctypes (list): List of DocTypes to be checked + file (str): Path of the database file Returns: - doctypes(list): doctypes that are missing in backup + doctypes(list): doctypes that are missing in backup """ - predicate = ( - 'COPY public."tab{}"' - if frappe.conf.db_type == "postgres" - else "CREATE TABLE `tab{}`" - ) + predicate = 'COPY public."tab{}"' if frappe.conf.db_type == "postgres" else "CREATE TABLE `tab{}`" with gzip.open(file, "rb") as f: content = f.read().decode("utf8").lower() - return [doctype for doctype in doctypes - if predicate.format(doctype).lower() not in content] + return [doctype for doctype in doctypes if predicate.format(doctype).lower() not in content] def exists_in_backup(doctypes: List, file: os.PathLike) -> bool: """Checks if the list of doctypes exist in the database.sql.gz file supplied Args: - doctypes (list): List of DocTypes to be checked - file (str): Path of the database file + doctypes (list): List of DocTypes to be checked + file (str): Path of the database file Returns: - bool: True if all tables exist + bool: True if all tables exist """ missing_doctypes = missing_in_backup(doctypes, file) return len(missing_doctypes) == 0 @@ -108,6 +103,7 @@ def pass_test_context(f): @wraps(f) def decorated_function(*args, **kwargs): return f(CLI_CONTEXT, *args, **kwargs) + return decorated_function @@ -150,9 +146,7 @@ class BaseTestCommands(unittest.TestCase): cmd_input = kwargs.get("cmd_input", None) if cmd_input: if not isinstance(cmd_input, bytes): - raise Exception( - f"The input should be of type bytes, not {type(cmd_input).__name__}" - ) + raise Exception(f"The input should be of type bytes, not {type(cmd_input).__name__}") del kwargs["cmd_input"] kwargs.update(site) @@ -163,7 +157,9 @@ class BaseTestCommands(unittest.TestCase): click.secho(self.command, fg="bright_black") command = shlex.split(self.command) - self._proc = subprocess.run(command, input=cmd_input, stdout=subprocess.PIPE, stderr=subprocess.PIPE) + self._proc = subprocess.run( + command, input=cmd_input, stdout=subprocess.PIPE, stderr=subprocess.PIPE + ) self.stdout = clean(self._proc.stdout) self.stderr = clean(self._proc.stderr) self.returncode = clean(self._proc.returncode) @@ -178,12 +174,9 @@ class BaseTestCommands(unittest.TestCase): "db_type": frappe.conf.db_type, } - if not os.path.exists( - os.path.join(TEST_SITE, "site_config.json") - ): + if not os.path.exists(os.path.join(TEST_SITE, "site_config.json")): cls.execute( - "bench new-site {test_site} --admin-password {admin_password} --db-type" - " {db_type}", + "bench new-site {test_site} --admin-password {admin_password} --db-type" " {db_type}", cmd_config, ) @@ -201,14 +194,16 @@ class BaseTestCommands(unittest.TestCase): stderr = self.stderr returncode = self.returncode - cmd_execution_summary = "\n".join([ - "-" * 70, - "Last Command Execution Summary:", - "Command: {}".format(command) if command else "", - "Standard Output: {}".format(stdout) if stdout else "", - "Standard Error: {}".format(stderr) if stderr else "", - "Return Code: {}".format(returncode) if returncode else "", - ]).strip() + cmd_execution_summary = "\n".join( + [ + "-" * 70, + "Last Command Execution Summary:", + "Command: {}".format(command) if command else "", + "Standard Output: {}".format(stdout) if stdout else "", + "Standard Error: {}".format(stderr) if stderr else "", + "Return Code: {}".format(returncode) if returncode else "", + ] + ).strip() return "{}\n\n{}".format(output, cmd_execution_summary) @@ -260,8 +255,7 @@ class TestCommands(BaseTestCommands): self.execute("bench --site {test_site} backup --exclude 'ToDo'", site_data) site_data.update({"kw": "\"{'partial':True}\""}) self.execute( - "bench --site {test_site} execute" - " frappe.utils.backups.fetch_latest_backups --kwargs {kw}", + "bench --site {test_site} execute" " frappe.utils.backups.fetch_latest_backups --kwargs {kw}", site_data, ) site_data.update({"database": json.loads(self.stdout)["database"]}) @@ -271,11 +265,13 @@ class TestCommands(BaseTestCommands): def test_partial_restore(self): _now = now() for num in range(10): - frappe.get_doc({ - "doctype": "ToDo", - "date": add_to_date(_now, days=num), - "description": frappe.mock("paragraph") - }).insert() + frappe.get_doc( + { + "doctype": "ToDo", + "date": add_to_date(_now, days=num), + "description": frappe.mock("paragraph"), + } + ).insert() frappe.db.commit() todo_count = frappe.db.count("ToDo") @@ -326,9 +322,7 @@ class TestCommands(BaseTestCommands): # test 2: bare functionality for single site self.execute("bench --site {site} list-apps") self.assertEqual(self.returncode, 0) - list_apps = set( - _x.split()[0] for _x in self.stdout.split("\n") - ) + list_apps = set(_x.split()[0] for _x in self.stdout.split("\n")) doctype = frappe.get_single("Installed Applications").installed_applications if doctype: installed_apps = set(x.app_name for x in doctype) @@ -390,7 +384,7 @@ class TestCommands(BaseTestCommands): os.remove(test2_path) def test_frappe_site_env(self): - os.putenv('FRAPPE_SITE', frappe.local.site) + os.putenv("FRAPPE_SITE", frappe.local.site) self.execute("bench execute frappe.ping") self.assertEqual(self.returncode, 0) self.assertIn("pong", self.stdout) @@ -411,43 +405,39 @@ class TestCommands(BaseTestCommands): self.execute("bench --site {site} set-password Administrator test1") self.assertEqual(self.returncode, 0) - self.assertEqual(check_password('Administrator', 'test1'), 'Administrator') + self.assertEqual(check_password("Administrator", "test1"), "Administrator") # to release the lock taken by check_password frappe.db.commit() self.execute("bench --site {site} set-admin-password test2") self.assertEqual(self.returncode, 0) - self.assertEqual(check_password('Administrator', 'test2'), 'Administrator') + self.assertEqual(check_password("Administrator", "test2"), "Administrator") def test_make_app(self): user_input = [ - b"Test App", # title - b"This app's description contains 'single quotes' and \"double quotes\".", # description - b"Test Publisher", # publisher - b"example@example.org", # email - b"", # icon - b"", # color - b"MIT" # app_license + b"Test App", # title + b"This app's description contains 'single quotes' and \"double quotes\".", # description + b"Test Publisher", # publisher + b"example@example.org", # email + b"", # icon + b"", # color + b"MIT", # app_license ] app_name = "testapp0" apps_path = os.path.join(get_bench_path(), "apps") test_app_path = os.path.join(apps_path, app_name) - self.execute(f"bench make-app {apps_path} {app_name}", {"cmd_input": b'\n'.join(user_input)}) + self.execute(f"bench make-app {apps_path} {app_name}", {"cmd_input": b"\n".join(user_input)}) self.assertEqual(self.returncode, 0) - self.assertTrue( - os.path.exists(test_app_path) - ) + self.assertTrue(os.path.exists(test_app_path)) # cleanup shutil.rmtree(test_app_path) @skipIf( not ( - frappe.conf.root_password - and frappe.conf.admin_password - and frappe.conf.db_type == "mariadb" + frappe.conf.root_password and frappe.conf.admin_password and frappe.conf.db_type == "mariadb" ), - "DB Root password and Admin password not set in config" + "DB Root password and Admin password not set in config", ) def test_bench_drop_site_should_archive_site(self): # TODO: Make this test postgres compatible @@ -465,9 +455,9 @@ class TestCommands(BaseTestCommands): self.assertEqual(self.returncode, 0) bench_path = get_bench_path() - site_directory = os.path.join(bench_path, f'sites/{site}') + site_directory = os.path.join(bench_path, f"sites/{site}") self.assertFalse(os.path.exists(site_directory)) - archive_directory = os.path.join(bench_path, f'archived/sites/{site}') + archive_directory = os.path.join(bench_path, f"archived/sites/{site}") self.assertTrue(os.path.exists(archive_directory)) @@ -479,13 +469,7 @@ class TestBackups(BaseTestCommands): "Note", ] }, - "excludes": { - "excludes": [ - "Activity Log", - "Access Log", - "Error Log" - ] - } + "excludes": {"excludes": ["Activity Log", "Access Log", "Error Log"]}, } home = os.path.expanduser("~") site_backup_path = frappe.utils.get_site_path("private", "backups") @@ -503,8 +487,7 @@ class TestBackups(BaseTestCommands): pass def test_backup_no_options(self): - """Take a backup without any options - """ + """Take a backup without any options""" before_backup = fetch_latest_backups(partial=True) self.execute("bench --site {site} backup") after_backup = fetch_latest_backups(partial=True) @@ -514,8 +497,7 @@ class TestBackups(BaseTestCommands): self.assertNotEqual(before_backup["database"], after_backup["database"]) def test_backup_with_files(self): - """Take a backup with files (--with-files) - """ + """Take a backup with files (--with-files)""" before_backup = fetch_latest_backups() self.execute("bench --site {site} backup --with-files") after_backup = fetch_latest_backups() @@ -528,18 +510,18 @@ class TestBackups(BaseTestCommands): self.assertIsNotNone(after_backup["private"]) def test_backup_with_custom_path(self): - """Backup to a custom path (--backup-path) - """ + """Backup to a custom path (--backup-path)""" backup_path = os.path.join(self.home, "backups") - self.execute("bench --site {site} backup --backup-path {backup_path}", {"backup_path": backup_path}) + self.execute( + "bench --site {site} backup --backup-path {backup_path}", {"backup_path": backup_path} + ) self.assertEqual(self.returncode, 0) self.assertTrue(os.path.exists(backup_path)) self.assertGreaterEqual(len(os.listdir(backup_path)), 2) def test_backup_with_different_file_paths(self): - """Backup with different file paths (--backup-path-db, --backup-path-files, --backup-path-private-files, --backup-path-conf) - """ + """Backup with different file paths (--backup-path-db, --backup-path-files, --backup-path-private-files, --backup-path-conf)""" kwargs = { key: os.path.join(self.home, key, value) for key, value in { @@ -565,22 +547,19 @@ class TestBackups(BaseTestCommands): self.assertTrue(os.path.exists(path)) def test_backup_compress_files(self): - """Take a compressed backup (--compress) - """ + """Take a compressed backup (--compress)""" self.execute("bench --site {site} backup --with-files --compress") self.assertEqual(self.returncode, 0) compressed_files = glob(f"{self.site_backup_path}/*.tgz") self.assertGreater(len(compressed_files), 0) def test_backup_verbose(self): - """Take a verbose backup (--verbose) - """ + """Take a verbose backup (--verbose)""" self.execute("bench --site {site} backup --verbose") self.assertEqual(self.returncode, 0) def test_backup_only_specific_doctypes(self): - """Take a backup with (include) backup options set in the site config `frappe.conf.backup.includes` - """ + """Take a backup with (include) backup options set in the site config `frappe.conf.backup.includes`""" self.execute( "bench --site {site} set-config backup '{includes}' --parse", {"includes": json.dumps(self.backup_map["includes"])}, @@ -591,8 +570,7 @@ class TestBackups(BaseTestCommands): self.assertEqual([], missing_in_backup(self.backup_map["includes"]["includes"], database)) def test_backup_excluding_specific_doctypes(self): - """Take a backup with (exclude) backup options set (`frappe.conf.backup.excludes`, `--exclude`) - """ + """Take a backup with (exclude) backup options set (`frappe.conf.backup.excludes`, `--exclude`)""" # test 1: take a backup with frappe.conf.backup.excludes self.execute( "bench --site {site} set-config backup '{excludes}' --parse", @@ -614,8 +592,7 @@ class TestBackups(BaseTestCommands): self.assertFalse(exists_in_backup(self.backup_map["excludes"]["excludes"], database)) def test_selective_backup_priority_resolution(self): - """Take a backup with conflicting backup options set (`frappe.conf.excludes`, `--include`) - """ + """Take a backup with conflicting backup options set (`frappe.conf.excludes`, `--include`)""" self.execute( "bench --site {site} backup --include '{include}'", {"include": ",".join(self.backup_map["includes"]["includes"])}, @@ -625,8 +602,7 @@ class TestBackups(BaseTestCommands): self.assertEqual([], missing_in_backup(self.backup_map["includes"]["includes"], database)) def test_dont_backup_conf(self): - """Take a backup ignoring frappe.conf.backup settings (with --ignore-backup-conf option) - """ + """Take a backup ignoring frappe.conf.backup settings (with --ignore-backup-conf option)""" self.execute("bench --site {site} backup --ignore-backup-conf") self.assertEqual(self.returncode, 0) database = fetch_latest_backups()["database"] @@ -636,9 +612,9 @@ class TestBackups(BaseTestCommands): class TestRemoveApp(unittest.TestCase): def test_delete_modules(self): from frappe.installer import ( - _delete_doctypes, - _delete_modules, - _get_module_linked_doctype_field_map, + _delete_doctypes, + _delete_modules, + _get_module_linked_doctype_field_map, ) test_module = frappe.new_doc("Module Def") @@ -646,18 +622,17 @@ class TestRemoveApp(unittest.TestCase): test_module.update({"module_name": "RemoveThis", "app_name": "frappe"}) test_module.save() - module_def_linked_doctype = frappe.get_doc({ - "doctype": "DocType", - "name": "Doctype linked with module def", - "module": "RemoveThis", - "custom": 1, - "fields": [{ - "label": "Modulen't", - "fieldname": "notmodule", - "fieldtype": "Link", - "options": "Module Def" - }] - }).insert() + module_def_linked_doctype = frappe.get_doc( + { + "doctype": "DocType", + "name": "Doctype linked with module def", + "module": "RemoveThis", + "custom": 1, + "fields": [ + {"label": "Modulen't", "fieldname": "notmodule", "fieldtype": "Link", "options": "Module Def"} + ], + } + ).insert() doctype_to_link_field_map = _get_module_linked_doctype_field_map() diff --git a/frappe/tests/test_cors.py b/frappe/tests/test_cors.py index 0376531712..723cb7e804 100644 --- a/frappe/tests/test_cors.py +++ b/frappe/tests/test_cors.py @@ -1,55 +1,63 @@ # Copyright (c) 2020, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest + from werkzeug.wrappers import Response + +import frappe from frappe.app import process_response -HEADERS = ('Access-Control-Allow-Origin', 'Access-Control-Allow-Credentials', - 'Access-Control-Allow-Methods', 'Access-Control-Allow-Headers') +HEADERS = ( + "Access-Control-Allow-Origin", + "Access-Control-Allow-Credentials", + "Access-Control-Allow-Methods", + "Access-Control-Allow-Headers", +) + class TestCORS(unittest.TestCase): - def make_request_and_test(self, origin='http://example.com', absent=False): - self.origin = origin + def make_request_and_test(self, origin="http://example.com", absent=False): + self.origin = origin - headers = {} - if origin: - headers = {'Origin': origin} + headers = {} + if origin: + headers = {"Origin": origin} - frappe.utils.set_request(headers=headers) + frappe.utils.set_request(headers=headers) - self.response = Response() - process_response(self.response) + self.response = Response() + process_response(self.response) - for header in HEADERS: - if absent: - self.assertNotIn(header, self.response.headers) - else: - if header == 'Access-Control-Allow-Origin': - self.assertEqual(self.response.headers.get(header), self.origin) - else: - self.assertIn(header, self.response.headers) + for header in HEADERS: + if absent: + self.assertNotIn(header, self.response.headers) + else: + if header == "Access-Control-Allow-Origin": + self.assertEqual(self.response.headers.get(header), self.origin) + else: + self.assertIn(header, self.response.headers) - def test_cors_disabled(self): - frappe.conf.allow_cors = None - self.make_request_and_test('http://example.com', True) + def test_cors_disabled(self): + frappe.conf.allow_cors = None + self.make_request_and_test("http://example.com", True) - def test_request_without_origin(self): - frappe.conf.allow_cors = 'http://example.com' - self.make_request_and_test(None, True) + def test_request_without_origin(self): + frappe.conf.allow_cors = "http://example.com" + self.make_request_and_test(None, True) - def test_valid_origin(self): - frappe.conf.allow_cors = 'http://example.com' - self.make_request_and_test() + def test_valid_origin(self): + frappe.conf.allow_cors = "http://example.com" + self.make_request_and_test() - frappe.conf.allow_cors = "*" - self.make_request_and_test() + frappe.conf.allow_cors = "*" + self.make_request_and_test() - frappe.conf.allow_cors = ['http://example.com', 'https://example.com'] - self.make_request_and_test() + frappe.conf.allow_cors = ["http://example.com", "https://example.com"] + self.make_request_and_test() - def test_invalid_origin(self): - frappe.conf.allow_cors = 'http://example1.com' - self.make_request_and_test(absent=True) + def test_invalid_origin(self): + frappe.conf.allow_cors = "http://example1.com" + self.make_request_and_test(absent=True) - frappe.conf.allow_cors = ['http://example1.com', 'https://example.com'] - self.make_request_and_test(absent=True) + frappe.conf.allow_cors = ["http://example1.com", "https://example.com"] + self.make_request_and_test(absent=True) diff --git a/frappe/tests/test_db.py b/frappe/tests/test_db.py index 33a5006161..624f346716 100644 --- a/frappe/tests/test_db.py +++ b/frappe/tests/test_db.py @@ -14,7 +14,7 @@ from frappe.database.database import Database from frappe.query_builder import Field from frappe.query_builder.functions import Concat_ws from frappe.tests.test_query_builder import db_type_is, run_only_if -from frappe.utils import add_days, now, random_string, cint +from frappe.utils import add_days, cint, now, random_string from frappe.utils.testutils import clear_custom_fields @@ -49,11 +49,15 @@ class TestDB(unittest.TestCase): order_by=None, ), ) - self.assertEqual(frappe.db.sql("""SELECT name FROM `tabUser` WHERE name > 's' ORDER BY MODIFIED DESC""")[0][0], - frappe.db.get_value("User", {"name": [">", "s"]})) + self.assertEqual( + frappe.db.sql("""SELECT name FROM `tabUser` WHERE name > 's' ORDER BY MODIFIED DESC""")[0][0], + frappe.db.get_value("User", {"name": [">", "s"]}), + ) - self.assertEqual(frappe.db.sql("""SELECT name FROM `tabUser` WHERE name >= 't' ORDER BY MODIFIED DESC""")[0][0], - frappe.db.get_value("User", {"name": [">=", "t"]})) + self.assertEqual( + frappe.db.sql("""SELECT name FROM `tabUser` WHERE name >= 't' ORDER BY MODIFIED DESC""")[0][0], + frappe.db.get_value("User", {"name": [">=", "t"]}), + ) self.assertEqual( frappe.db.get_values( "User", @@ -79,9 +83,7 @@ class TestDB(unittest.TestCase): ) self.assertEqual( frappe.db.sql("select email from tabUser where name='Administrator' order by modified DESC"), - frappe.db.get_values( - "User", filters=[["name", "=", "Administrator"]], fieldname="email" - ), + frappe.db.get_values("User", filters=[["name", "=", "Administrator"]], fieldname="email"), ) def test_get_value_limits(self): @@ -96,8 +98,9 @@ class TestDB(unittest.TestCase): self.assertGreaterEqual(2, cint(frappe.db._cursor.rowcount)) # without limits length == count - self.assertEqual(len(frappe.db.get_values("User", filters=filter)), - frappe.db.count("User", filter)) + self.assertEqual( + len(frappe.db.get_values("User", filters=filter)), frappe.db.count("User", filter) + ) frappe.db.get_value("User", filters=filter) self.assertGreaterEqual(1, cint(frappe.db._cursor.rowcount)) @@ -109,7 +112,7 @@ class TestDB(unittest.TestCase): frappe.db.escape("香港濟生堂製藥有限公司 - IT".encode("utf-8")) def test_get_single_value(self): - #setup + # setup values_dict = { "Float": 1.5, "Int": 1, @@ -118,76 +121,150 @@ class TestDB(unittest.TestCase): "Data": "Test", "Date": datetime.datetime.now().date(), "Datetime": datetime.datetime.now(), - "Time": datetime.timedelta(hours=9, minutes=45, seconds=10) + "Time": datetime.timedelta(hours=9, minutes=45, seconds=10), } - test_inputs = [{ - "fieldtype": fieldtype, - "value": value} for fieldtype, value in values_dict.items()] + test_inputs = [ + {"fieldtype": fieldtype, "value": value} for fieldtype, value in values_dict.items() + ] for fieldtype in values_dict.keys(): - create_custom_field("Print Settings", { - "fieldname": f"test_{fieldtype.lower()}", - "label": f"Test {fieldtype}", - "fieldtype": fieldtype, - }) + create_custom_field( + "Print Settings", + { + "fieldname": f"test_{fieldtype.lower()}", + "label": f"Test {fieldtype}", + "fieldtype": fieldtype, + }, + ) - #test + # test for inp in test_inputs: fieldname = f"test_{inp['fieldtype'].lower()}" frappe.db.set_value("Print Settings", "Print Settings", fieldname, inp["value"]) self.assertEqual(frappe.db.get_single_value("Print Settings", fieldname), inp["value"]) - #teardown + # teardown clear_custom_fields("Print Settings") def test_log_touched_tables(self): frappe.flags.in_migrate = True frappe.flags.touched_tables = set() - frappe.db.set_value('System Settings', 'System Settings', 'backup_limit', 5) - self.assertIn('tabSingles', frappe.flags.touched_tables) + frappe.db.set_value("System Settings", "System Settings", "backup_limit", 5) + self.assertIn("tabSingles", frappe.flags.touched_tables) frappe.flags.touched_tables = set() - todo = frappe.get_doc({'doctype': 'ToDo', 'description': 'Random Description'}) + todo = frappe.get_doc({"doctype": "ToDo", "description": "Random Description"}) todo.save() - self.assertIn('tabToDo', frappe.flags.touched_tables) + self.assertIn("tabToDo", frappe.flags.touched_tables) frappe.flags.touched_tables = set() todo.description = "Another Description" todo.save() - self.assertIn('tabToDo', frappe.flags.touched_tables) + self.assertIn("tabToDo", frappe.flags.touched_tables) if frappe.db.db_type != "postgres": frappe.flags.touched_tables = set() frappe.db.sql("UPDATE tabToDo SET description = 'Updated Description'") - self.assertNotIn('tabToDo SET', frappe.flags.touched_tables) - self.assertIn('tabToDo', frappe.flags.touched_tables) + self.assertNotIn("tabToDo SET", frappe.flags.touched_tables) + self.assertIn("tabToDo", frappe.flags.touched_tables) frappe.flags.touched_tables = set() todo.delete() - self.assertIn('tabToDo', frappe.flags.touched_tables) + self.assertIn("tabToDo", frappe.flags.touched_tables) frappe.flags.touched_tables = set() - create_custom_field('ToDo', {'label': 'ToDo Custom Field'}) + create_custom_field("ToDo", {"label": "ToDo Custom Field"}) - self.assertIn('tabToDo', frappe.flags.touched_tables) - self.assertIn('tabCustom Field', frappe.flags.touched_tables) + self.assertIn("tabToDo", frappe.flags.touched_tables) + self.assertIn("tabCustom Field", frappe.flags.touched_tables) frappe.flags.in_migrate = False frappe.flags.touched_tables.clear() - def test_db_keywords_as_fields(self): """Tests if DB keywords work as docfield names. If they're wrapped with grave accents.""" # Using random.choices, picked out a list of 40 keywords for testing all_keywords = { - "mariadb": ["CHARACTER", "DELAYED", "LINES", "EXISTS", "YEAR_MONTH", "LOCALTIME", "BOTH", "MEDIUMINT", - "LEFT", "BINARY", "DEFAULT", "KILL", "WRITE", "SQL_SMALL_RESULT", "CURRENT_TIME", "CROSS", "INHERITS", - "SELECT", "TABLE", "ALTER", "CURRENT_TIMESTAMP", "XOR", "CASE", "ALL", "WHERE", "INT", "TO", "SOME", - "DAY_MINUTE", "ERRORS", "OPTIMIZE", "REPLACE", "HIGH_PRIORITY", "VARBINARY", "HELP", "IS", - "CHAR", "DESCRIBE", "KEY"], - "postgres": ["WORK", "LANCOMPILER", "REAL", "HAVING", "REPEATABLE", "DATA", "USING", "BIT", "DEALLOCATE", - "SERIALIZABLE", "CURSOR", "INHERITS", "ARRAY", "TRUE", "IGNORE", "PARAMETER_MODE", "ROW", "CHECKPOINT", - "SHOW", "BY", "SIZE", "SCALE", "UNENCRYPTED", "WITH", "AND", "CONVERT", "FIRST", "SCOPE", "WRITE", "INTERVAL", - "CHARACTER_SET_SCHEMA", "ADD", "SCROLL", "NULL", "WHEN", "TRANSACTION_ACTIVE", - "INT", "FORTRAN", "STABLE"] + "mariadb": [ + "CHARACTER", + "DELAYED", + "LINES", + "EXISTS", + "YEAR_MONTH", + "LOCALTIME", + "BOTH", + "MEDIUMINT", + "LEFT", + "BINARY", + "DEFAULT", + "KILL", + "WRITE", + "SQL_SMALL_RESULT", + "CURRENT_TIME", + "CROSS", + "INHERITS", + "SELECT", + "TABLE", + "ALTER", + "CURRENT_TIMESTAMP", + "XOR", + "CASE", + "ALL", + "WHERE", + "INT", + "TO", + "SOME", + "DAY_MINUTE", + "ERRORS", + "OPTIMIZE", + "REPLACE", + "HIGH_PRIORITY", + "VARBINARY", + "HELP", + "IS", + "CHAR", + "DESCRIBE", + "KEY", + ], + "postgres": [ + "WORK", + "LANCOMPILER", + "REAL", + "HAVING", + "REPEATABLE", + "DATA", + "USING", + "BIT", + "DEALLOCATE", + "SERIALIZABLE", + "CURSOR", + "INHERITS", + "ARRAY", + "TRUE", + "IGNORE", + "PARAMETER_MODE", + "ROW", + "CHECKPOINT", + "SHOW", + "BY", + "SIZE", + "SCALE", + "UNENCRYPTED", + "WITH", + "AND", + "CONVERT", + "FIRST", + "SCOPE", + "WRITE", + "INTERVAL", + "CHARACTER_SET_SCHEMA", + "ADD", + "SCROLL", + "NULL", + "WHEN", + "TRANSACTION_ACTIVE", + "INT", + "FORTRAN", + "STABLE", + ], } created_docs = [] @@ -197,11 +274,14 @@ class TestDB(unittest.TestCase): test_doctype = "ToDo" def add_custom_field(field): - create_custom_field(test_doctype, { - "fieldname": field.lower(), - "label": field.title(), - "fieldtype": 'Data', - }) + create_custom_field( + test_doctype, + { + "fieldname": field.lower(), + "label": field.title(), + "fieldtype": "Data", + }, + ) # Create custom fields for test_doctype for field in fields: @@ -219,30 +299,40 @@ class TestDB(unittest.TestCase): random_value = random_string(20) # Testing read - self.assertEqual(list(frappe.get_all("ToDo", fields=[random_field], limit=1)[0])[0], random_field) - self.assertEqual(list(frappe.get_all("ToDo", fields=[f"`{random_field}` as total"], limit=1)[0])[0], "total") + self.assertEqual( + list(frappe.get_all("ToDo", fields=[random_field], limit=1)[0])[0], random_field + ) + self.assertEqual( + list(frappe.get_all("ToDo", fields=[f"`{random_field}` as total"], limit=1)[0])[0], "total" + ) # Testing read for distinct and sql functions - self.assertEqual(list( - frappe.get_all("ToDo", - fields=[f"`{random_field}` as total"], - distinct=True, - limit=1, - )[0] - )[0], "total") - self.assertEqual(list( - frappe.get_all("ToDo", - fields=[f"`{random_field}`"], - distinct=True, - limit=1, - )[0] - )[0], random_field) - self.assertEqual(list( - frappe.get_all("ToDo", - fields=[f"count(`{random_field}`)"], - limit=1 - )[0] - )[0], "count" if frappe.conf.db_type == "postgres" else f"count(`{random_field}`)") + self.assertEqual( + list( + frappe.get_all( + "ToDo", + fields=[f"`{random_field}` as total"], + distinct=True, + limit=1, + )[0] + )[0], + "total", + ) + self.assertEqual( + list( + frappe.get_all( + "ToDo", + fields=[f"`{random_field}`"], + distinct=True, + limit=1, + )[0] + )[0], + random_field, + ) + self.assertEqual( + list(frappe.get_all("ToDo", fields=[f"count(`{random_field}`)"], limit=1)[0])[0], + "count" if frappe.conf.db_type == "postgres" else f"count(`{random_field}`)", + ) # Testing update frappe.db.set_value(test_doctype, random_doc, random_field, random_value) @@ -302,6 +392,7 @@ class TestDB(unittest.TestCase): def test_transaction_writes_error(self): from frappe.database.database import Database + frappe.db.rollback() frappe.db.MAX_WRITES_PER_TRANSACTION = 1 @@ -320,11 +411,14 @@ class TestDB(unittest.TestCase): self.assertEqual(1, frappe.db.transaction_writes - writes) writes = frappe.db.transaction_writes - frappe.db.sql(""" + frappe.db.sql( + """ update `tabNote` set content = 'abc' where name = %s - """, note.name) + """, + note.name, + ) self.assertEqual(1, frappe.db.transaction_writes - writes) def test_pk_collision_ignoring(self): @@ -333,7 +427,9 @@ class TestDB(unittest.TestCase): frappe.get_doc(doctype="Note", title="duplicate name").insert(ignore_if_duplicate=True) with savepoint(): - self.assertRaises(frappe.DuplicateEntryError, frappe.get_doc(doctype="Note", title="duplicate name").insert) + self.assertRaises( + frappe.DuplicateEntryError, frappe.get_doc(doctype="Note", title="duplicate name").insert + ) # recover transaction to continue other tests raise Exception @@ -345,9 +441,7 @@ class TestDB(unittest.TestCase): filters = {"doctype": dt, "name": ("like", "Admin%")} self.assertEqual(frappe.db.exists(filters), dn) - self.assertEqual( - filters["doctype"], dt - ) # make sure that doctype was not removed from filters + self.assertEqual(filters["doctype"], dt) # make sure that doctype was not removed from filters self.assertEqual(frappe.db.exists(dt, [["name", "=", dn]]), dn) @@ -420,7 +514,9 @@ class TestDBSetValue(unittest.TestCase): value = frappe.db.get_single_value("System Settings", "deny_multiple_sessions") changed_value = not value - frappe.db.set_value("System Settings", "System Settings", "deny_multiple_sessions", changed_value) + frappe.db.set_value( + "System Settings", "System Settings", "deny_multiple_sessions", changed_value + ) current_value = frappe.db.get_single_value("System Settings", "deny_multiple_sessions") self.assertEqual(current_value, changed_value) @@ -442,40 +538,47 @@ class TestDBSetValue(unittest.TestCase): def test_update_single_row_multiple_columns(self): description, status = "Upated by test_update_single_row_multiple_columns", "Closed" - frappe.db.set_value("ToDo", self.todo1.name, { - "description": description, - "status": status, - }, update_modified=False) + frappe.db.set_value( + "ToDo", + self.todo1.name, + { + "description": description, + "status": status, + }, + update_modified=False, + ) - updated_desciption, updated_status = frappe.db.get_value("ToDo", - filters={"name": self.todo1.name}, - fieldname=["description", "status"] + updated_desciption, updated_status = frappe.db.get_value( + "ToDo", filters={"name": self.todo1.name}, fieldname=["description", "status"] ) self.assertEqual(description, updated_desciption) self.assertEqual(status, updated_status) def test_update_multiple_rows_single_column(self): - frappe.db.set_value("ToDo", {"description": ("like", "%test_set_value%")}, "description", "change 2") + frappe.db.set_value( + "ToDo", {"description": ("like", "%test_set_value%")}, "description", "change 2" + ) self.assertEqual(frappe.db.get_value("ToDo", self.todo1.name, "description"), "change 2") self.assertEqual(frappe.db.get_value("ToDo", self.todo2.name, "description"), "change 2") def test_update_multiple_rows_multiple_columns(self): - todos_to_update = frappe.get_all("ToDo", filters={ - "description": ("like", "%test_set_value%"), - "status": ("!=", "Closed") - }, pluck="name") + todos_to_update = frappe.get_all( + "ToDo", + filters={"description": ("like", "%test_set_value%"), "status": ("!=", "Closed")}, + pluck="name", + ) - frappe.db.set_value("ToDo", { - "description": ("like", "%test_set_value%"), - "status": ("!=", "Closed") - }, { - "status": "Closed", - "priority": "High" - }) + frappe.db.set_value( + "ToDo", + {"description": ("like", "%test_set_value%"), "status": ("!=", "Closed")}, + {"status": "Closed", "priority": "High"}, + ) - test_result = frappe.get_all("ToDo", filters={"name": ("in", todos_to_update)}, fields=["status", "priority"]) + test_result = frappe.get_all( + "ToDo", filters={"name": ("in", todos_to_update)}, fields=["status", "priority"] + ) self.assertTrue(all(x for x in test_result if x["status"] == "Closed")) self.assertTrue(all(x for x in test_result if x["priority"] == "High")) @@ -492,10 +595,17 @@ class TestDBSetValue(unittest.TestCase): self.assertEqual(updated_description, frappe.db.get_value("ToDo", todo.name, "description")) self.assertEqual(todo.modified, frappe.db.get_value("ToDo", todo.name, "modified")) - frappe.db.set_value("ToDo", todo.name, "description", "test_set_value change 1", modified=custom_modified, modified_by=custom_modified_by) + frappe.db.set_value( + "ToDo", + todo.name, + "description", + "test_set_value change 1", + modified=custom_modified, + modified_by=custom_modified_by, + ) self.assertTupleEqual( (custom_modified, custom_modified_by), - frappe.db.get_value("ToDo", todo.name, ["modified", "modified_by"]) + frappe.db.get_value("ToDo", todo.name, ["modified", "modified_by"]), ) def test_for_update(self): @@ -506,7 +616,7 @@ class TestDBSetValue(unittest.TestCase): self.todo1.doctype, self.todo1.name, "description", - f"{self.todo1.description}-edit by `test_for_update`" + f"{self.todo1.description}-edit by `test_for_update`", ) first_query = sql_called.call_args_list[0].args[0] second_query = sql_called.call_args_list[1].args[0] @@ -515,6 +625,7 @@ class TestDBSetValue(unittest.TestCase): self.assertTrue("FOR UPDATE" in first_query) if frappe.conf.db_type == "postgres": from frappe.database.postgres.database import modify_query + self.assertTrue(modify_query("UPDATE `tabToDo` SET") in second_query) if frappe.conf.db_type == "mariadb": self.assertTrue("UPDATE `tabToDo` SET" in second_query) @@ -527,13 +638,19 @@ class TestDBSetValue(unittest.TestCase): self.todo2.doctype, self.todo2.name, "description", - f"{self.todo2.description}-edit by `test_cleared_cache`" + f"{self.todo2.description}-edit by `test_cleared_cache`", ) clear_cache.assert_called() def test_update_alias(self): args = (self.todo1.doctype, self.todo1.name, "description", "Updated by `test_update_alias`") - kwargs = {"for_update": False, "modified": None, "modified_by": None, "update_modified": True, "debug": False} + kwargs = { + "for_update": False, + "modified": None, + "modified_by": None, + "update_modified": True, + "debug": False, + } self.assertTrue("return self.set_value(" in inspect.getsource(frappe.db.update)) @@ -579,9 +696,7 @@ class TestDDLCommandsPost(unittest.TestCase): self.test_table_name = new_table_name def test_describe(self) -> None: - self.assertEqual( - [("id",), ("content",)], frappe.db.describe(self.test_table_name) - ) + self.assertEqual([("id",), ("content",)], frappe.db.describe(self.test_table_name)) def test_change_type(self) -> None: frappe.db.change_column_type(self.test_table_name, "id", "varchar(255)") @@ -619,14 +734,16 @@ class TestDDLCommandsPost(unittest.TestCase): query = "select * from `tabtree b` where lft > 13 and rgt <= 16 and name =1.0 and parent = 4134qrsdc and isgroup = 1.00045" self.assertEqual( - "select * from \"tabtree b\" where lft > \'13\' and rgt <= '16' and name = '1' and parent = 4134qrsdc and isgroup = 1.00045", - modify_query(query) + "select * from \"tabtree b\" where lft > '13' and rgt <= '16' and name = '1' and parent = 4134qrsdc and isgroup = 1.00045", + modify_query(query), ) - query = "select locate(\".io\", \"frappe.io\"), locate(\"3\", cast(3 as varchar)), locate(\"3\", 3::varchar)" + query = ( + 'select locate(".io", "frappe.io"), locate("3", cast(3 as varchar)), locate("3", 3::varchar)' + ) self.assertEqual( - "select strpos( \"frappe.io\", \".io\"), strpos( cast(3 as varchar), \"3\"), strpos( 3::varchar, \"3\")", - modify_query(query) + 'select strpos( "frappe.io", ".io"), strpos( cast(3 as varchar), "3"), strpos( 3::varchar, "3")', + modify_query(query), ) @run_only_if(db_type_is.POSTGRES) @@ -635,12 +752,9 @@ class TestDDLCommandsPost(unittest.TestCase): self.assertEqual( {"abcd": "23", "efgh": "23", "ijkl": 23.0345, "mnop": "wow"}, - modify_values({"abcd": 23, "efgh": 23.0, "ijkl": 23.0345, "mnop": "wow"}) - ) - self.assertEqual( - ["23", "23", 23.00004345, "wow"], - modify_values((23, 23.0, 23.00004345, "wow")) + modify_values({"abcd": 23, "efgh": 23.0, "ijkl": 23.0345, "mnop": "wow"}), ) + self.assertEqual(["23", "23", 23.00004345, "wow"], modify_values((23, 23.0, 23.00004345, "wow"))) def test_sequence_table_creation(self): from frappe.core.doctype.doctype.test_doctype import new_doctype @@ -649,13 +763,17 @@ class TestDDLCommandsPost(unittest.TestCase): if frappe.db.db_type == "postgres": self.assertTrue( - frappe.db.sql("""select sequence_name FROM information_schema.sequences - where sequence_name ilike 'autoinc_dt_seq_test%'""")[0][0] + frappe.db.sql( + """select sequence_name FROM information_schema.sequences + where sequence_name ilike 'autoinc_dt_seq_test%'""" + )[0][0] ) else: self.assertTrue( - frappe.db.sql("""select data_type FROM information_schema.tables - where table_type = 'SEQUENCE' and table_name like 'autoinc_dt_seq_test%'""")[0][0] + frappe.db.sql( + """select data_type FROM information_schema.tables + where table_type = 'SEQUENCE' and table_name like 'autoinc_dt_seq_test%'""" + )[0][0] ) dt.delete(ignore_permissions=True) diff --git a/frappe/tests/test_db_query.py b/frappe/tests/test_db_query.py index b4c7c7cce7..90b047b3cd 100644 --- a/frappe/tests/test_db_query.py +++ b/frappe/tests/test_db_query.py @@ -1,32 +1,31 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe import datetime import unittest -from frappe.model.db_query import DatabaseQuery -from frappe.desk.reportview import get_filters_cond -from frappe.query_builder import Column - -from frappe.core.page.permission_manager.permission_manager import update, reset, add -from frappe.permissions import add_user_permission, clear_user_permissions_for_doctype +import frappe +from frappe.core.page.permission_manager.permission_manager import add, reset, update from frappe.custom.doctype.property_setter.property_setter import make_property_setter +from frappe.desk.reportview import get_filters_cond from frappe.handler import execute_cmd - +from frappe.model.db_query import DatabaseQuery +from frappe.permissions import add_user_permission, clear_user_permissions_for_doctype +from frappe.query_builder import Column from frappe.utils.testutils import add_custom_field, clear_custom_fields -test_dependencies = ['User', 'Blog Post', 'Blog Category', 'Blogger'] +test_dependencies = ["User", "Blog Post", "Blog Category", "Blogger"] + class TestReportview(unittest.TestCase): def setUp(self): frappe.set_user("Administrator") def test_basic(self): - self.assertTrue({"name":"DocType"} in DatabaseQuery("DocType").execute(limit_page_length=None)) + self.assertTrue({"name": "DocType"} in DatabaseQuery("DocType").execute(limit_page_length=None)) def test_extract_tables(self): db_query = DatabaseQuery("DocType") - add_custom_field("DocType", 'test_tab_field', 'Data') + add_custom_field("DocType", "test_tab_field", "Data") db_query.fields = ["tabNote.creation", "test_tab_field", "tabDocType.test_tab_field"] db_query.extract_tables() @@ -37,14 +36,14 @@ class TestReportview(unittest.TestCase): clear_custom_fields("DocType") def test_build_match_conditions(self): - clear_user_permissions_for_doctype('Blog Post', 'test2@example.com') + clear_user_permissions_for_doctype("Blog Post", "test2@example.com") - test2user = frappe.get_doc('User', 'test2@example.com') - test2user.add_roles('Blogger') - frappe.set_user('test2@example.com') + test2user = frappe.get_doc("User", "test2@example.com") + test2user.add_roles("Blogger") + frappe.set_user("test2@example.com") # this will get match conditions for Blog Post - build_match_conditions = DatabaseQuery('Blog Post').build_match_conditions + build_match_conditions = DatabaseQuery("Blog Post").build_match_conditions # Before any user permission is applied # get as filters @@ -52,68 +51,85 @@ class TestReportview(unittest.TestCase): # get as conditions self.assertEqual(build_match_conditions(as_condition=True), "") - add_user_permission('Blog Post', '-test-blog-post', 'test2@example.com', True) - add_user_permission('Blog Post', '-test-blog-post-1', 'test2@example.com', True) + add_user_permission("Blog Post", "-test-blog-post", "test2@example.com", True) + add_user_permission("Blog Post", "-test-blog-post-1", "test2@example.com", True) # After applying user permission # get as filters - self.assertTrue({'Blog Post': ['-test-blog-post-1', '-test-blog-post']} in build_match_conditions(as_condition=False)) + self.assertTrue( + {"Blog Post": ["-test-blog-post-1", "-test-blog-post"]} + in build_match_conditions(as_condition=False) + ) # get as conditions - self.assertEqual(build_match_conditions(as_condition=True), - """(((ifnull(`tabBlog Post`.`name`, '')='' or `tabBlog Post`.`name` in ('-test-blog-post-1', '-test-blog-post'))))""") + self.assertEqual( + build_match_conditions(as_condition=True), + """(((ifnull(`tabBlog Post`.`name`, '')='' or `tabBlog Post`.`name` in ('-test-blog-post-1', '-test-blog-post'))))""", + ) - frappe.set_user('Administrator') + frappe.set_user("Administrator") def test_fields(self): - self.assertTrue({"name":"DocType", "issingle":0} \ - in DatabaseQuery("DocType").execute(fields=["name", "issingle"], limit_page_length=None)) + self.assertTrue( + {"name": "DocType", "issingle": 0} + in DatabaseQuery("DocType").execute(fields=["name", "issingle"], limit_page_length=None) + ) def test_filters_1(self): - self.assertFalse({"name":"DocType"} \ - in DatabaseQuery("DocType").execute(filters=[["DocType", "name", "like", "J%"]])) + self.assertFalse( + {"name": "DocType"} + in DatabaseQuery("DocType").execute(filters=[["DocType", "name", "like", "J%"]]) + ) def test_filters_2(self): - self.assertFalse({"name":"DocType"} \ - in DatabaseQuery("DocType").execute(filters=[{"name": ["like", "J%"]}])) + self.assertFalse( + {"name": "DocType"} in DatabaseQuery("DocType").execute(filters=[{"name": ["like", "J%"]}]) + ) def test_filters_3(self): - self.assertFalse({"name":"DocType"} \ - in DatabaseQuery("DocType").execute(filters={"name": ["like", "J%"]})) + self.assertFalse( + {"name": "DocType"} in DatabaseQuery("DocType").execute(filters={"name": ["like", "J%"]}) + ) def test_filters_4(self): - self.assertTrue({"name":"DocField"} \ - in DatabaseQuery("DocType").execute(filters={"name": "DocField"})) + self.assertTrue( + {"name": "DocField"} in DatabaseQuery("DocType").execute(filters={"name": "DocField"}) + ) def test_in_not_in_filters(self): self.assertFalse(DatabaseQuery("DocType").execute(filters={"name": ["in", None]})) - self.assertTrue({"name":"DocType"} \ - in DatabaseQuery("DocType").execute(filters={"name": ["not in", None]})) + self.assertTrue( + {"name": "DocType"} in DatabaseQuery("DocType").execute(filters={"name": ["not in", None]}) + ) - for result in [{"name":"DocType"}, {"name":"DocField"}]: - self.assertTrue(result - in DatabaseQuery("DocType").execute(filters={"name": ["in", 'DocType,DocField']})) + for result in [{"name": "DocType"}, {"name": "DocField"}]: + self.assertTrue( + result in DatabaseQuery("DocType").execute(filters={"name": ["in", "DocType,DocField"]}) + ) - for result in [{"name":"DocType"}, {"name":"DocField"}]: - self.assertFalse(result - in DatabaseQuery("DocType").execute(filters={"name": ["not in", 'DocType,DocField']})) + for result in [{"name": "DocType"}, {"name": "DocField"}]: + self.assertFalse( + result in DatabaseQuery("DocType").execute(filters={"name": ["not in", "DocType,DocField"]}) + ) def test_none_filter(self): query = frappe.db.query.get_sql("DocType", fields="name", filters={"restrict_to_domain": None}) - sql = str(query).replace('`', '').replace('"', '') - condition = 'restrict_to_domain IS NULL' + sql = str(query).replace("`", "").replace('"', "") + condition = "restrict_to_domain IS NULL" self.assertIn(condition, sql) def test_or_filters(self): data = DatabaseQuery("DocField").execute( - filters={"parent": "DocType"}, fields=["fieldname", "fieldtype"], - or_filters=[{"fieldtype":"Table"}, {"fieldtype":"Select"}]) + filters={"parent": "DocType"}, + fields=["fieldname", "fieldtype"], + or_filters=[{"fieldtype": "Table"}, {"fieldtype": "Select"}], + ) - self.assertTrue({"fieldtype":"Table", "fieldname":"fields"} in data) - self.assertTrue({"fieldtype":"Select", "fieldname":"document_type"} in data) - self.assertFalse({"fieldtype":"Check", "fieldname":"issingle"} in data) + self.assertTrue({"fieldtype": "Table", "fieldname": "fields"} in data) + self.assertTrue({"fieldtype": "Select", "fieldname": "document_type"} in data) + self.assertFalse({"fieldtype": "Check", "fieldname": "issingle"} in data) def test_between_filters(self): - """ test case to check between filter for date fields """ + """test case to check between filter for date fields""" frappe.db.delete("Event") # create events to test the between operator filter @@ -124,177 +140,269 @@ class TestReportview(unittest.TestCase): event4 = create_event(starts_on="2016-07-08 00:00:01") # if the values are not passed in filters then event should be filter as current datetime - data = DatabaseQuery("Event").execute( - filters={"starts_on": ["between", None]}, fields=["name"]) + data = DatabaseQuery("Event").execute(filters={"starts_on": ["between", None]}, fields=["name"]) - self.assertTrue({ "name": event1.name } not in data) + self.assertTrue({"name": event1.name} not in data) # if both from and to_date values are passed data = DatabaseQuery("Event").execute( - filters={"starts_on": ["between", ["2016-07-06", "2016-07-07"]]}, - fields=["name"]) + filters={"starts_on": ["between", ["2016-07-06", "2016-07-07"]]}, fields=["name"] + ) - self.assertTrue({ "name": event2.name } in data) - self.assertTrue({ "name": event3.name } in data) - self.assertTrue({ "name": event1.name } not in data) - self.assertTrue({ "name": event4.name } not in data) + self.assertTrue({"name": event2.name} in data) + self.assertTrue({"name": event3.name} in data) + self.assertTrue({"name": event1.name} not in data) + self.assertTrue({"name": event4.name} not in data) # if only one value is passed in the filter data = DatabaseQuery("Event").execute( - filters={"starts_on": ["between", ["2016-07-07"]]}, - fields=["name"]) + filters={"starts_on": ["between", ["2016-07-07"]]}, fields=["name"] + ) - self.assertTrue({ "name": event3.name } in data) - self.assertTrue({ "name": event4.name } in data) - self.assertTrue({ "name": todays_event.name } in data) - self.assertTrue({ "name": event1.name } not in data) - self.assertTrue({ "name": event2.name } not in data) + self.assertTrue({"name": event3.name} in data) + self.assertTrue({"name": event4.name} in data) + self.assertTrue({"name": todays_event.name} in data) + self.assertTrue({"name": event1.name} not in data) + self.assertTrue({"name": event2.name} not in data) # test between is formatted for creation column data = DatabaseQuery("Event").execute( - filters={"creation": ["between", ["2016-07-06", "2016-07-07"]]}, - fields=["name"]) + filters={"creation": ["between", ["2016-07-06", "2016-07-07"]]}, fields=["name"] + ) def test_ignore_permissions_for_get_filters_cond(self): - frappe.set_user('test2@example.com') - self.assertRaises(frappe.PermissionError, get_filters_cond, 'DocType', dict(istable=1), []) - self.assertTrue(get_filters_cond('DocType', dict(istable=1), [], ignore_permissions=True)) - frappe.set_user('Administrator') + frappe.set_user("test2@example.com") + self.assertRaises(frappe.PermissionError, get_filters_cond, "DocType", dict(istable=1), []) + self.assertTrue(get_filters_cond("DocType", dict(istable=1), [], ignore_permissions=True)) + frappe.set_user("Administrator") def test_query_fields_sanitizer(self): - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "issingle, version()"], limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "issingle, version()"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, fields=["name", "issingle, IF(issingle=1, (select name from tabUser), count(name))"], - limit_start=0, limit_page_length=1) + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, fields=["name", "issingle, (select count(*) from tabSessions)"], - limit_start=0, limit_page_length=1) + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, fields=["name", "issingle, SELECT LOCATE('', `tabUser`.`user`) AS user;"], - limit_start=0, limit_page_length=1) + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, fields=["name", "issingle, IF(issingle=1, (SELECT name from tabUser), count(*))"], - limit_start=0, limit_page_length=1) + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "issingle ''"],limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "issingle ''"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "issingle,'"],limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "issingle,'"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "select * from tabSessions"],limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "select * from tabSessions"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "issingle from --"],limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "issingle from --"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "issingle from tabDocType order by 2 --"],limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "issingle from tabDocType order by 2 --"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name", "1' UNION SELECT * FROM __Auth --"],limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name", "1' UNION SELECT * FROM __Auth --"], + limit_start=0, + limit_page_length=1, + ) - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["@@version"], limit_start=0, limit_page_length=1) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["@@version"], + limit_start=0, + limit_page_length=1, + ) - data = DatabaseQuery("DocType").execute(fields=["count(`name`) as count"], - limit_start=0, limit_page_length=1) - self.assertTrue('count' in data[0]) + data = DatabaseQuery("DocType").execute( + fields=["count(`name`) as count"], limit_start=0, limit_page_length=1 + ) + self.assertTrue("count" in data[0]) - data = DatabaseQuery("DocType").execute(fields=["name", "issingle", "locate('', name) as _relevance"], - limit_start=0, limit_page_length=1) - self.assertTrue('_relevance' in data[0]) + data = DatabaseQuery("DocType").execute( + fields=["name", "issingle", "locate('', name) as _relevance"], + limit_start=0, + limit_page_length=1, + ) + self.assertTrue("_relevance" in data[0]) - data = DatabaseQuery("DocType").execute(fields=["name", "issingle", "date(creation) as creation"], - limit_start=0, limit_page_length=1) - self.assertTrue('creation' in data[0]) + data = DatabaseQuery("DocType").execute( + fields=["name", "issingle", "date(creation) as creation"], limit_start=0, limit_page_length=1 + ) + self.assertTrue("creation" in data[0]) - if frappe.db.db_type != 'postgres': + if frappe.db.db_type != "postgres": # datediff function does not exist in postgres - data = DatabaseQuery("DocType").execute(fields=["name", "issingle", - "datediff(modified, creation) as date_diff"], limit_start=0, limit_page_length=1) - self.assertTrue('date_diff' in data[0]) + data = DatabaseQuery("DocType").execute( + fields=["name", "issingle", "datediff(modified, creation) as date_diff"], + limit_start=0, + limit_page_length=1, + ) + self.assertTrue("date_diff" in data[0]) def test_nested_permission(self): - frappe.set_user('Administrator') + frappe.set_user("Administrator") create_nested_doctype() create_nested_doctype_records() - clear_user_permissions_for_doctype('Nested DocType') + clear_user_permissions_for_doctype("Nested DocType") # user permission for only one root folder - add_user_permission('Nested DocType', 'Level 1 A', 'test2@example.com') + add_user_permission("Nested DocType", "Level 1 A", "test2@example.com") from frappe.core.page.permission_manager.permission_manager import update + # to avoid if_owner filter - update('Nested DocType', 'All', 0, 'if_owner', 0) + update("Nested DocType", "All", 0, "if_owner", 0) - frappe.set_user('test2@example.com') - data = DatabaseQuery('Nested DocType').execute() + frappe.set_user("test2@example.com") + data = DatabaseQuery("Nested DocType").execute() # children of root folder (for which we added user permission) should be accessible - self.assertTrue({'name': 'Level 2 A'} in data) - self.assertTrue({'name': 'Level 2 A'} in data) + self.assertTrue({"name": "Level 2 A"} in data) + self.assertTrue({"name": "Level 2 A"} in data) # other folders should not be accessible - self.assertFalse({'name': 'Level 1 B'} in data) - self.assertFalse({'name': 'Level 2 B'} in data) - update('Nested DocType', 'All', 0, 'if_owner', 1) - frappe.set_user('Administrator') + self.assertFalse({"name": "Level 1 B"} in data) + self.assertFalse({"name": "Level 2 B"} in data) + update("Nested DocType", "All", 0, "if_owner", 1) + frappe.set_user("Administrator") def test_filter_sanitizer(self): - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name"], filters={'istable,': 1}, limit_start=0, limit_page_length=1) - - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name"], filters={'editable_grid,': 1}, or_filters={'istable,': 1}, - limit_start=0, limit_page_length=1) - - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name"], filters={'editable_grid,': 1}, - or_filters=[['DocType', 'istable,', '=', 1]], - limit_start=0, limit_page_length=1) - - self.assertRaises(frappe.DataError, DatabaseQuery("DocType").execute, - fields=["name"], filters={'editable_grid,': 1}, - or_filters=[['DocType', 'istable', '=', 1], ['DocType', 'beta and 1=1', '=', 0]], - limit_start=0, limit_page_length=1) - - out = DatabaseQuery("DocType").execute(fields=["name"], - filters={'editable_grid': 1, 'module': 'Core'}, - or_filters=[['DocType', 'istable', '=', 1]], order_by='creation') - self.assertTrue('DocField' in [d['name'] for d in out]) - - out = DatabaseQuery("DocType").execute(fields=["name"], - filters={'issingle': 1}, or_filters=[['DocType', 'module', '=', 'Core']], - order_by='creation') - self.assertTrue('Role Permission for Page and Report' in [d['name'] for d in out]) - - out = DatabaseQuery("DocType").execute(fields=["name"], - filters={'track_changes': 1, 'module': 'Core'}, - order_by='creation') - self.assertTrue('File' in [d['name'] for d in out]) - - out = DatabaseQuery("DocType").execute(fields=["name"], - filters=[ - ['DocType', 'ifnull(track_changes, 0)', '=', 0], - ['DocType', 'module', '=', 'Core'] - ], order_by='creation') - self.assertTrue('DefaultValue' in [d['name'] for d in out]) + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name"], + filters={"istable,": 1}, + limit_start=0, + limit_page_length=1, + ) + + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name"], + filters={"editable_grid,": 1}, + or_filters={"istable,": 1}, + limit_start=0, + limit_page_length=1, + ) + + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name"], + filters={"editable_grid,": 1}, + or_filters=[["DocType", "istable,", "=", 1]], + limit_start=0, + limit_page_length=1, + ) + + self.assertRaises( + frappe.DataError, + DatabaseQuery("DocType").execute, + fields=["name"], + filters={"editable_grid,": 1}, + or_filters=[["DocType", "istable", "=", 1], ["DocType", "beta and 1=1", "=", 0]], + limit_start=0, + limit_page_length=1, + ) + + out = DatabaseQuery("DocType").execute( + fields=["name"], + filters={"editable_grid": 1, "module": "Core"}, + or_filters=[["DocType", "istable", "=", 1]], + order_by="creation", + ) + self.assertTrue("DocField" in [d["name"] for d in out]) + + out = DatabaseQuery("DocType").execute( + fields=["name"], + filters={"issingle": 1}, + or_filters=[["DocType", "module", "=", "Core"]], + order_by="creation", + ) + self.assertTrue("Role Permission for Page and Report" in [d["name"] for d in out]) + + out = DatabaseQuery("DocType").execute( + fields=["name"], filters={"track_changes": 1, "module": "Core"}, order_by="creation" + ) + self.assertTrue("File" in [d["name"] for d in out]) + + out = DatabaseQuery("DocType").execute( + fields=["name"], + filters=[["DocType", "ifnull(track_changes, 0)", "=", 0], ["DocType", "module", "=", "Core"]], + order_by="creation", + ) + self.assertTrue("DefaultValue" in [d["name"] for d in out]) def test_of_not_of_descendant_ancestors(self): - frappe.set_user('Administrator') - clear_user_permissions_for_doctype('Nested DocType') + frappe.set_user("Administrator") + clear_user_permissions_for_doctype("Nested DocType") # in descendants filter - data = frappe.get_all('Nested DocType', {'name': ('descendants of', 'Level 2 A')}) + data = frappe.get_all("Nested DocType", {"name": ("descendants of", "Level 2 A")}) self.assertTrue({"name": "Level 3 A"} in data) - data = frappe.get_all('Nested DocType', {'name': ('descendants of', 'Level 1 A')}) + data = frappe.get_all("Nested DocType", {"name": ("descendants of", "Level 1 A")}) self.assertTrue({"name": "Level 3 A"} in data) self.assertTrue({"name": "Level 2 A"} in data) self.assertFalse({"name": "Level 2 B"} in data) @@ -303,7 +411,7 @@ class TestReportview(unittest.TestCase): self.assertFalse({"name": "Root"} in data) # in ancestors of filter - data = frappe.get_all('Nested DocType', {'name': ('ancestors of', 'Level 2 A')}) + data = frappe.get_all("Nested DocType", {"name": ("ancestors of", "Level 2 A")}) self.assertFalse({"name": "Level 3 A"} in data) self.assertFalse({"name": "Level 2 A"} in data) self.assertFalse({"name": "Level 2 B"} in data) @@ -311,7 +419,7 @@ class TestReportview(unittest.TestCase): self.assertTrue({"name": "Level 1 A"} in data) self.assertTrue({"name": "Root"} in data) - data = frappe.get_all('Nested DocType', {'name': ('ancestors of', 'Level 1 A')}) + data = frappe.get_all("Nested DocType", {"name": ("ancestors of", "Level 1 A")}) self.assertFalse({"name": "Level 3 A"} in data) self.assertFalse({"name": "Level 2 A"} in data) self.assertFalse({"name": "Level 2 B"} in data) @@ -320,14 +428,14 @@ class TestReportview(unittest.TestCase): self.assertTrue({"name": "Root"} in data) # not descendants filter - data = frappe.get_all('Nested DocType', {'name': ('not descendants of', 'Level 2 A')}) + data = frappe.get_all("Nested DocType", {"name": ("not descendants of", "Level 2 A")}) self.assertFalse({"name": "Level 3 A"} in data) self.assertTrue({"name": "Level 2 A"} in data) self.assertTrue({"name": "Level 2 B"} in data) self.assertTrue({"name": "Level 1 A"} in data) self.assertTrue({"name": "Root"} in data) - data = frappe.get_all('Nested DocType', {'name': ('not descendants of', 'Level 1 A')}) + data = frappe.get_all("Nested DocType", {"name": ("not descendants of", "Level 1 A")}) self.assertFalse({"name": "Level 3 A"} in data) self.assertFalse({"name": "Level 2 A"} in data) self.assertTrue({"name": "Level 2 B"} in data) @@ -336,7 +444,7 @@ class TestReportview(unittest.TestCase): self.assertTrue({"name": "Root"} in data) # not ancestors of filter - data = frappe.get_all('Nested DocType', {'name': ('not ancestors of', 'Level 2 A')}) + data = frappe.get_all("Nested DocType", {"name": ("not ancestors of", "Level 2 A")}) self.assertTrue({"name": "Level 3 A"} in data) self.assertTrue({"name": "Level 2 A"} in data) self.assertTrue({"name": "Level 2 B"} in data) @@ -344,7 +452,7 @@ class TestReportview(unittest.TestCase): self.assertTrue({"name": "Level 1 A"} not in data) self.assertTrue({"name": "Root"} not in data) - data = frappe.get_all('Nested DocType', {'name': ('not ancestors of', 'Level 1 A')}) + data = frappe.get_all("Nested DocType", {"name": ("not ancestors of", "Level 1 A")}) self.assertTrue({"name": "Level 3 A"} in data) self.assertTrue({"name": "Level 2 A"} in data) self.assertTrue({"name": "Level 2 B"} in data) @@ -352,29 +460,33 @@ class TestReportview(unittest.TestCase): self.assertTrue({"name": "Level 1 A"} in data) self.assertFalse({"name": "Root"} in data) - data = frappe.get_all('Nested DocType', {'name': ('ancestors of', 'Root')}) + data = frappe.get_all("Nested DocType", {"name": ("ancestors of", "Root")}) self.assertTrue(len(data) == 0) - self.assertTrue(len(frappe.get_all('Nested DocType', {'name': ('not ancestors of', 'Root')})) == len(frappe.get_all('Nested DocType'))) + self.assertTrue( + len(frappe.get_all("Nested DocType", {"name": ("not ancestors of", "Root")})) + == len(frappe.get_all("Nested DocType")) + ) def test_is_set_is_not_set(self): - res = DatabaseQuery('DocType').execute(filters={'autoname': ['is', 'not set']}) - self.assertTrue({'name': 'Integration Request'} in res) - self.assertTrue({'name': 'User'} in res) - self.assertFalse({'name': 'Blogger'} in res) + res = DatabaseQuery("DocType").execute(filters={"autoname": ["is", "not set"]}) + self.assertTrue({"name": "Integration Request"} in res) + self.assertTrue({"name": "User"} in res) + self.assertFalse({"name": "Blogger"} in res) - res = DatabaseQuery('DocType').execute(filters={'autoname': ['is', 'set']}) - self.assertTrue({'name': 'DocField'} in res) - self.assertTrue({'name': 'Prepared Report'} in res) - self.assertFalse({'name': 'Property Setter'} in res) + res = DatabaseQuery("DocType").execute(filters={"autoname": ["is", "set"]}) + self.assertTrue({"name": "DocField"} in res) + self.assertTrue({"name": "Prepared Report"} in res) + self.assertFalse({"name": "Property Setter"} in res) def test_set_field_tables(self): # Tests _in_standard_sql_methods method in test_set_field_tables # The following query will break if the above method is broken - data = frappe.db.get_list("Web Form", - filters=[['Web Form Field', 'reqd', '=', 1]], - group_by='amount_field', - fields=['count(*) as count', '`amount_field` as name'], - order_by='count desc', + data = frappe.db.get_list( + "Web Form", + filters=[["Web Form Field", "reqd", "=", 1]], + group_by="amount_field", + fields=["count(*) as count", "`amount_field` as name"], + order_by="count desc", limit=50, ) @@ -389,7 +501,8 @@ class TestReportview(unittest.TestCase): def test_prepare_select_args(self): # frappe.get_all inserts modified field into order_by clause # test to make sure this is inserted into select field when postgres - doctypes = frappe.get_all("DocType", + doctypes = frappe.get_all( + "DocType", filters={"docstatus": 0, "document_type": ("!=", "")}, group_by="document_type", fields=["document_type", "sum(is_submittable) as is_submittable"], @@ -403,8 +516,7 @@ class TestReportview(unittest.TestCase): self.assertTrue(isinstance(doctypes[0][2], datetime.datetime)) def test_column_comparison(self): - """Test DatabaseQuery.execute to test column comparison - """ + """Test DatabaseQuery.execute to test column comparison""" users_unedited = frappe.get_all( "User", filters={"creation": Column("modified")}, @@ -439,18 +551,22 @@ class TestReportview(unittest.TestCase): frappe.local.request = frappe._dict() frappe.local.request.method = "POST" - frappe.local.form_dict = frappe._dict({ - "doctype": "Blog Post", - "fields": ["published", "title", "`tabTest Child`.`test_field`"], - }) + frappe.local.form_dict = frappe._dict( + { + "doctype": "Blog Post", + "fields": ["published", "title", "`tabTest Child`.`test_field`"], + } + ) # even if * is passed, fields which are not accessible should be filtered out response = execute_cmd("frappe.desk.reportview.get") self.assertListEqual(response["keys"], ["title"]) - frappe.local.form_dict = frappe._dict({ - "doctype": "Blog Post", - "fields": ["*"], - }) + frappe.local.form_dict = frappe._dict( + { + "doctype": "Blog Post", + "fields": ["*"], + } + ) response = execute_cmd("frappe.desk.reportview.get") self.assertNotIn("published", response["keys"]) @@ -462,13 +578,15 @@ class TestReportview(unittest.TestCase): frappe.set_user("Administrator") # Admin should be able to see access all fields - frappe.local.form_dict = frappe._dict({ - "doctype": "Blog Post", - "fields": ["published", "title", "`tabTest Child`.`test_field`"], - }) + frappe.local.form_dict = frappe._dict( + { + "doctype": "Blog Post", + "fields": ["published", "title", "`tabTest Child`.`test_field`"], + } + ) response = execute_cmd("frappe.desk.reportview.get") - self.assertListEqual(response["keys"], ['published', 'title', 'test_field']) + self.assertListEqual(response["keys"], ["published", "title", "test_field"]) # reset user roles user.remove_roles("Blogger", "Website Manager") @@ -476,23 +594,27 @@ class TestReportview(unittest.TestCase): def test_reportview_get_aggregation(self): # test aggregation based on child table field - frappe.local.form_dict = frappe._dict({ - "doctype": "DocType", - "fields": """["`tabDocField`.`label` as field_label","`tabDocField`.`name` as field_name"]""", - "filters": "[]", - "order_by": "_aggregate_column desc", - "start": 0, - "page_length": 20, - "view": "Report", - "with_comment_count": 0, - "group_by": "field_label, field_name", - "aggregate_on_field": "columns", - "aggregate_on_doctype": "DocField", - "aggregate_function": "sum" - }) + frappe.local.form_dict = frappe._dict( + { + "doctype": "DocType", + "fields": """["`tabDocField`.`label` as field_label","`tabDocField`.`name` as field_name"]""", + "filters": "[]", + "order_by": "_aggregate_column desc", + "start": 0, + "page_length": 20, + "view": "Report", + "with_comment_count": 0, + "group_by": "field_label, field_name", + "aggregate_on_field": "columns", + "aggregate_on_doctype": "DocField", + "aggregate_function": "sum", + } + ) response = execute_cmd("frappe.desk.reportview.get") - self.assertListEqual(response["keys"], ["field_label", "field_name", "_aggregate_column", 'columns']) + self.assertListEqual( + response["keys"], ["field_label", "field_name", "_aggregate_column", "columns"] + ) def test_cast_name(self): from frappe.core.doctype.doctype.test_doctype import new_doctype @@ -502,91 +624,113 @@ class TestReportview(unittest.TestCase): query = DatabaseQuery("autoinc_dt_test").execute( fields=["locate('1', `tabautoinc_dt_test`.`name`)", "`tabautoinc_dt_test`.`name`"], filters={"name": 1}, - run=False + run=False, ) if frappe.db.db_type == "postgres": - self.assertTrue("strpos( cast( \"tabautoinc_dt_test\".\"name\" as varchar), \'1\')" in query) - self.assertTrue("where cast(\"tabautoinc_dt_test\".name as varchar) = \'1\'" in query) + self.assertTrue('strpos( cast( "tabautoinc_dt_test"."name" as varchar), \'1\')' in query) + self.assertTrue('where cast("tabautoinc_dt_test"."name" as varchar) = \'1\'' in query) else: - self.assertTrue("locate(\'1\', `tabautoinc_dt_test`.`name`)" in query) - self.assertTrue("where `tabautoinc_dt_test`.name = 1" in query) + self.assertTrue("locate('1', `tabautoinc_dt_test`.`name`)" in query) + self.assertTrue("where `tabautoinc_dt_test`.`name` = 1" in query) dt.delete(ignore_permissions=True) + def test_fieldname_starting_with_int(self): + from frappe.core.doctype.doctype.test_doctype import new_doctype + + dt = new_doctype( + "dt_with_int_named_fieldname", + fields=[{"label": "1field", "fieldname": "1field", "fieldtype": "Int"}], + ).insert(ignore_permissions=True) + + frappe.get_doc({"doctype": "dt_with_int_named_fieldname", "1field": 10}).insert( + ignore_permissions=True + ) + + query = DatabaseQuery("dt_with_int_named_fieldname") + self.assertTrue(query.execute(filters={"1field": 10})) + self.assertTrue(query.execute(filters={"1field": ["like", "1%"]})) + self.assertTrue(query.execute(filters={"1field": ["in", "1,2,10"]})) + self.assertTrue(query.execute(filters={"1field": ["is", "set"]})) + self.assertFalse(query.execute(filters={"1field": ["not like", "1%"]})) + + dt.delete() + def add_child_table_to_blog_post(): - child_table = frappe.get_doc({ - 'doctype': 'DocType', - 'istable': 1, - 'custom': 1, - 'name': 'Test Child', - 'module': 'Custom', - 'autoname': 'Prompt', - 'fields': [{ - 'fieldname': 'test_field', - 'fieldtype': 'Data', - 'permlevel': 1 - }], - }) + child_table = frappe.get_doc( + { + "doctype": "DocType", + "istable": 1, + "custom": 1, + "name": "Test Child", + "module": "Custom", + "autoname": "Prompt", + "fields": [{"fieldname": "test_field", "fieldtype": "Data", "permlevel": 1}], + } + ) child_table.insert(ignore_permissions=True, ignore_if_duplicate=True) - clear_custom_fields('Blog Post') - add_custom_field('Blog Post', 'child_table', 'Table', child_table.name) + clear_custom_fields("Blog Post") + add_custom_field("Blog Post", "child_table", "Table", child_table.name) + def create_event(subject="_Test Event", starts_on=None): - """ create a test event """ + """create a test event""" from frappe.utils import get_datetime - event = frappe.get_doc({ - "doctype": "Event", - "subject": subject, - "event_type": "Public", - "starts_on": get_datetime(starts_on), - }).insert(ignore_permissions=True) + event = frappe.get_doc( + { + "doctype": "Event", + "subject": subject, + "event_type": "Public", + "starts_on": get_datetime(starts_on), + } + ).insert(ignore_permissions=True) return event + def create_nested_doctype(): - if frappe.db.exists('DocType', 'Nested DocType'): + if frappe.db.exists("DocType", "Nested DocType"): return - frappe.get_doc({ - 'doctype': 'DocType', - 'name': 'Nested DocType', - 'module': 'Custom', - 'is_tree': 1, - 'custom': 1, - 'autoname': 'Prompt', - 'fields': [ - {'label': 'Description', 'fieldname': 'description'} - ], - 'permissions': [ - {'role': 'Blogger'} - ] - }).insert() + frappe.get_doc( + { + "doctype": "DocType", + "name": "Nested DocType", + "module": "Custom", + "is_tree": 1, + "custom": 1, + "autoname": "Prompt", + "fields": [{"label": "Description", "fieldname": "description"}], + "permissions": [{"role": "Blogger"}], + } + ).insert() + def create_nested_doctype_records(): - ''' + """ Create a structure like: - Root - - Level 1 A - - Level 2 A - - Level 3 A - - Level 1 B - - Level 2 B - ''' + - Level 1 A + - Level 2 A + - Level 3 A + - Level 1 B + - Level 2 B + """ records = [ - {'name': 'Root', 'is_group': 1}, - {'name': 'Level 1 A', 'parent_nested_doctype': 'Root', 'is_group': 1}, - {'name': 'Level 2 A', 'parent_nested_doctype': 'Level 1 A', 'is_group': 1}, - {'name': 'Level 3 A', 'parent_nested_doctype': 'Level 2 A'}, - {'name': 'Level 1 B', 'parent_nested_doctype': 'Root', 'is_group': 1}, - {'name': 'Level 2 B', 'parent_nested_doctype': 'Level 1 B'}, + {"name": "Root", "is_group": 1}, + {"name": "Level 1 A", "parent_nested_doctype": "Root", "is_group": 1}, + {"name": "Level 2 A", "parent_nested_doctype": "Level 1 A", "is_group": 1}, + {"name": "Level 3 A", "parent_nested_doctype": "Level 2 A"}, + {"name": "Level 1 B", "parent_nested_doctype": "Root", "is_group": 1}, + {"name": "Level 2 B", "parent_nested_doctype": "Level 1 B"}, ] for r in records: - d = frappe.new_doc('Nested DocType') + d = frappe.new_doc("Nested DocType") d.update(r) d.insert(ignore_permissions=True, ignore_if_duplicate=True) diff --git a/frappe/tests/test_db_update.py b/frappe/tests/test_db_update.py index 66eb05391a..7c615f2df5 100644 --- a/frappe/tests/test_db_update.py +++ b/frappe/tests/test_db_update.py @@ -1,80 +1,82 @@ import unittest -import frappe -from frappe.utils import cstr +import frappe from frappe.core.utils import find from frappe.custom.doctype.property_setter.property_setter import make_property_setter +from frappe.utils import cstr class TestDBUpdate(unittest.TestCase): def test_db_update(self): - doctype = 'User' - frappe.reload_doctype('User', force=True) - frappe.model.meta.trim_tables('User') - make_property_setter(doctype, 'bio', 'fieldtype', 'Text', 'Data') - make_property_setter(doctype, 'middle_name', 'fieldtype', 'Data', 'Text') - make_property_setter(doctype, 'enabled', 'default', '1', 'Int') + doctype = "User" + frappe.reload_doctype("User", force=True) + frappe.model.meta.trim_tables("User") + make_property_setter(doctype, "bio", "fieldtype", "Text", "Data") + make_property_setter(doctype, "middle_name", "fieldtype", "Data", "Text") + make_property_setter(doctype, "enabled", "default", "1", "Int") frappe.db.updatedb(doctype) field_defs = get_field_defs(doctype) - table_columns = frappe.db.get_table_columns_description('tab{}'.format(doctype)) + table_columns = frappe.db.get_table_columns_description("tab{}".format(doctype)) self.assertEqual(len(field_defs), len(table_columns)) for field_def in field_defs: - fieldname = field_def.get('fieldname') - table_column = find(table_columns, lambda d: d.get('name') == fieldname) + fieldname = field_def.get("fieldname") + table_column = find(table_columns, lambda d: d.get("name") == fieldname) fieldtype = get_fieldtype_from_def(field_def) - fallback_default = '0' if field_def.get('fieldtype') in frappe.model.numeric_fieldtypes else 'NULL' + fallback_default = ( + "0" if field_def.get("fieldtype") in frappe.model.numeric_fieldtypes else "NULL" + ) default = field_def.default if field_def.default is not None else fallback_default self.assertEqual(fieldtype, table_column.type) - self.assertIn(cstr(table_column.default) or 'NULL', [cstr(default), "'{}'".format(default)]) + self.assertIn(cstr(table_column.default) or "NULL", [cstr(default), "'{}'".format(default)]) def test_index_and_unique_constraints(self): doctype = "User" - frappe.reload_doctype('User', force=True) - frappe.model.meta.trim_tables('User') + frappe.reload_doctype("User", force=True) + frappe.model.meta.trim_tables("User") - make_property_setter(doctype, 'restrict_ip', 'unique', '1', 'Int') + make_property_setter(doctype, "restrict_ip", "unique", "1", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertTrue(restrict_ip_in_table.unique) - make_property_setter(doctype, 'restrict_ip', 'unique', '0', 'Int') + make_property_setter(doctype, "restrict_ip", "unique", "0", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertFalse(restrict_ip_in_table.unique) - make_property_setter(doctype, 'restrict_ip', 'search_index', '1', 'Int') + make_property_setter(doctype, "restrict_ip", "search_index", "1", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertTrue(restrict_ip_in_table.index) - make_property_setter(doctype, 'restrict_ip', 'search_index', '0', 'Int') + make_property_setter(doctype, "restrict_ip", "search_index", "0", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertFalse(restrict_ip_in_table.index) - make_property_setter(doctype, 'restrict_ip', 'search_index', '1', 'Int') - make_property_setter(doctype, 'restrict_ip', 'unique', '1', 'Int') + make_property_setter(doctype, "restrict_ip", "search_index", "1", "Int") + make_property_setter(doctype, "restrict_ip", "unique", "1", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertTrue(restrict_ip_in_table.index) self.assertTrue(restrict_ip_in_table.unique) - make_property_setter(doctype, 'restrict_ip', 'search_index', '1', 'Int') - make_property_setter(doctype, 'restrict_ip', 'unique', '0', 'Int') + make_property_setter(doctype, "restrict_ip", "search_index", "1", "Int") + make_property_setter(doctype, "restrict_ip", "unique", "0", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertTrue(restrict_ip_in_table.index) self.assertFalse(restrict_ip_in_table.unique) - make_property_setter(doctype, 'restrict_ip', 'search_index', '0', 'Int') - make_property_setter(doctype, 'restrict_ip', 'unique', '1', 'Int') + make_property_setter(doctype, "restrict_ip", "search_index", "0", "Int") + make_property_setter(doctype, "restrict_ip", "unique", "1", "Int") frappe.db.updatedb(doctype) restrict_ip_in_table = get_table_column("User", "restrict_ip") self.assertFalse(restrict_ip_in_table.index) @@ -86,44 +88,51 @@ class TestDBUpdate(unittest.TestCase): email_sig_column = get_table_column("User", "email_signature") self.assertEqual(email_sig_column.index, 1) + def get_fieldtype_from_def(field_def): - fieldtuple = frappe.db.type_map.get(field_def.fieldtype, ('', 0)) + fieldtuple = frappe.db.type_map.get(field_def.fieldtype, ("", 0)) fieldtype = fieldtuple[0] - if fieldtype in ('varchar', 'datetime', 'int'): - fieldtype += '({})'.format(field_def.length or fieldtuple[1]) + if fieldtype in ("varchar", "datetime", "int"): + fieldtype += "({})".format(field_def.length or fieldtuple[1]) return fieldtype + def get_field_defs(doctype): meta = frappe.get_meta(doctype, cached=False) field_defs = meta.get_fieldnames_with_value(True) field_defs += get_other_fields_meta(meta) return field_defs + def get_other_fields_meta(meta): default_fields_map = { - 'name': ('Data', 0), - 'owner': ('Data', 0), - 'modified_by': ('Data', 0), - 'creation': ('Datetime', 0), - 'modified': ('Datetime', 0), - 'idx': ('Int', 8), - 'docstatus': ('Check', 0) + "name": ("Data", 0), + "owner": ("Data", 0), + "modified_by": ("Data", 0), + "creation": ("Datetime", 0), + "modified": ("Datetime", 0), + "idx": ("Int", 8), + "docstatus": ("Check", 0), } optional_fields = frappe.db.OPTIONAL_COLUMNS if meta.track_seen: - optional_fields.append('_seen') + optional_fields.append("_seen") child_table_fields_map = {} if meta.istable: - child_table_fields_map.update({field: ('Data', 0) for field in frappe.db.CHILD_TABLE_COLUMNS}) + child_table_fields_map.update({field: ("Data", 0) for field in frappe.db.CHILD_TABLE_COLUMNS}) - optional_fields_map = {field: ('Text', 0) for field in optional_fields} + optional_fields_map = {field: ("Text", 0) for field in optional_fields} fields = dict(default_fields_map, **optional_fields_map, **child_table_fields_map) - field_map = [frappe._dict({'fieldname': field, 'fieldtype': _type, 'length': _length}) for field, (_type, _length) in fields.items()] + field_map = [ + frappe._dict({"fieldname": field, "fieldtype": _type, "length": _length}) + for field, (_type, _length) in fields.items() + ] return field_map + def get_table_column(doctype, fieldname): - table_columns = frappe.db.get_table_columns_description('tab{}'.format(doctype)) - return find(table_columns, lambda d: d.get('name') == fieldname) + table_columns = frappe.db.get_table_columns_description("tab{}".format(doctype)) + return find(table_columns, lambda d: d.get("name") == fieldname) diff --git a/frappe/tests/test_defaults.py b/frappe/tests/test_defaults.py index 84d482d8ca..3841bde34e 100644 --- a/frappe/tests/test_defaults.py +++ b/frappe/tests/test_defaults.py @@ -1,9 +1,11 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE -import frappe, unittest +import unittest +import frappe from frappe.defaults import * + class TestDefaults(unittest.TestCase): def test_global(self): clear_user_default("key1") @@ -52,19 +54,21 @@ class TestDefaults(unittest.TestCase): self.assertEqual(get_user_default_as_list("language"), ["en"]) old_user = frappe.session.user - user = 'test@example.com' + user = "test@example.com" frappe.set_user(user) - perm_doc = frappe.get_doc(dict( - doctype='User Permission', - user=frappe.session.user, - allow="Language", - for_value="en-GB", - )).insert(ignore_permissions = True) + perm_doc = frappe.get_doc( + dict( + doctype="User Permission", + user=frappe.session.user, + allow="Language", + for_value="en-GB", + ) + ).insert(ignore_permissions=True) self.assertEqual(get_global_default("language"), None) self.assertEqual(get_user_default("language"), None) self.assertEqual(get_user_default_as_list("language"), []) - frappe.delete_doc('User Permission', perm_doc.name) + frappe.delete_doc("User Permission", perm_doc.name) frappe.set_user(old_user) diff --git a/frappe/tests/test_document.py b/frappe/tests/test_document.py index 5caccb167e..40bc8e2d45 100644 --- a/frappe/tests/test_document.py +++ b/frappe/tests/test_document.py @@ -19,7 +19,7 @@ class CustomTestNote(Note): class TestDocument(unittest.TestCase): def test_get_return_empty_list_for_table_field_if_none(self): - d = frappe.get_doc({"doctype":"User"}) + d = frappe.get_doc({"doctype": "User"}) self.assertEqual(d.get("roles"), []) def test_load(self): @@ -29,7 +29,7 @@ class TestDocument(unittest.TestCase): self.assertEqual(d.allow_rename, 1) self.assertTrue(isinstance(d.fields, list)) self.assertTrue(isinstance(d.permissions, list)) - self.assertTrue(filter(lambda d: d.fieldname=="email", d.fields)) + self.assertTrue(filter(lambda d: d.fieldname == "email", d.fields)) def test_load_single(self): d = frappe.get_doc("Website Settings", "Website Settings") @@ -38,32 +38,34 @@ class TestDocument(unittest.TestCase): self.assertTrue(d.disable_signup in (0, 1)) def test_insert(self): - d = frappe.get_doc({ - "doctype":"Event", - "subject":"test-doc-test-event 1", - "starts_on": "2014-01-01", - "event_type": "Public" - }) + d = frappe.get_doc( + { + "doctype": "Event", + "subject": "test-doc-test-event 1", + "starts_on": "2014-01-01", + "event_type": "Public", + } + ) d.insert() self.assertTrue(d.name.startswith("EV")) - self.assertEqual(frappe.db.get_value("Event", d.name, "subject"), - "test-doc-test-event 1") + self.assertEqual(frappe.db.get_value("Event", d.name, "subject"), "test-doc-test-event 1") # test if default values are added self.assertEqual(d.send_reminder, 1) return d def test_insert_with_child(self): - d = frappe.get_doc({ - "doctype":"Event", - "subject":"test-doc-test-event 2", - "starts_on": "2014-01-01", - "event_type": "Public" - }) + d = frappe.get_doc( + { + "doctype": "Event", + "subject": "test-doc-test-event 2", + "starts_on": "2014-01-01", + "event_type": "Public", + } + ) d.insert() self.assertTrue(d.name.startswith("EV")) - self.assertEqual(frappe.db.get_value("Event", d.name, "subject"), - "test-doc-test-event 2") + self.assertEqual(frappe.db.get_value("Event", d.name, "subject"), "test-doc-test-event 2") def test_update(self): d = self.test_insert() @@ -76,17 +78,19 @@ class TestDocument(unittest.TestCase): d = self.test_insert() d.subject = "subject changed again" d.save() - self.assertTrue(d.has_value_changed('subject')) - self.assertFalse(d.has_value_changed('event_type')) + self.assertTrue(d.has_value_changed("subject")) + self.assertFalse(d.has_value_changed("event_type")) def test_mandatory(self): # TODO: recheck if it is OK to force delete frappe.delete_doc_if_exists("User", "test_mandatory@example.com", 1) - d = frappe.get_doc({ - "doctype": "User", - "email": "test_mandatory@example.com", - }) + d = frappe.get_doc( + { + "doctype": "User", + "email": "test_mandatory@example.com", + } + ) self.assertRaises(frappe.MandatoryError, d.insert) d.set("first_name", "Test Mandatory") @@ -123,22 +127,18 @@ class TestDocument(unittest.TestCase): def test_link_validation(self): frappe.delete_doc_if_exists("User", "test_link_validation@example.com", 1) - d = frappe.get_doc({ - "doctype": "User", - "email": "test_link_validation@example.com", - "first_name": "Link Validation", - "roles": [ - { - "role": "ABC" - } - ] - }) + d = frappe.get_doc( + { + "doctype": "User", + "email": "test_link_validation@example.com", + "first_name": "Link Validation", + "roles": [{"role": "ABC"}], + } + ) self.assertRaises(frappe.LinkValidationError, d.insert) d.roles = [] - d.append("roles", { - "role": "System Manager" - }) + d.append("roles", {"role": "System Manager"}) d.insert() self.assertEqual(frappe.db.get_value("User", d.name), d.name) @@ -166,7 +166,7 @@ class TestDocument(unittest.TestCase): def test_varchar_length(self): d = self.test_insert() - d.sender = "abcde"*100 + "@user.com" + d.sender = "abcde" * 100 + "@user.com" self.assertRaises(frappe.CharacterLengthExceededError, d.save) def test_xss_filter(self): @@ -174,7 +174,7 @@ class TestDocument(unittest.TestCase): # script xss = '' - escaped_xss = xss.replace('<', '<').replace('>', '>') + escaped_xss = xss.replace("<", "<").replace(">", ">") d.subject += xss d.save() d.reload() @@ -184,7 +184,7 @@ class TestDocument(unittest.TestCase): # onload xss = 'You have a new message from: John
Hey, wassup!
Hello
Para
''' + + sample = """Hello
Para
""" clean = clean_email_html(sample) - self.assertFalse('", content) self.assertIn("background-color: var(--bg-color);", content) def test_raw_assets_are_loaded(self): - content = get_response_content('/_test/assets/js_asset.min.js') + content = get_response_content("/_test/assets/js_asset.min.js") # minified js files should not be passed through jinja renderer self.assertEqual("//{% if title %} {{title}} {% endif %}\nconsole.log('in');", content) - content = get_response_content('/_test/assets/css_asset.css') + content = get_response_content("/_test/assets/css_asset.css") self.assertEqual("""body{color:red}""", content) def test_breadcrumbs(self): - content = get_response_content('/_test/_test_folder/_test_page') + content = get_response_content("/_test/_test_folder/_test_page") self.assertIn('Test Folder', content) self.assertIn(' Test Page', content) - content = get_response_content('/_test/_test_folder/index') + content = get_response_content("/_test/_test_folder/index") self.assertIn(' Test', content) self.assertIn('Test Folder', content) def test_get_context_without_context_object(self): - content = get_response_content('/_test/_test_no_context') + content = get_response_content("/_test/_test_no_context") self.assertIn("Custom Content", content) def test_caching(self): @@ -287,21 +293,21 @@ class TestWebsite(unittest.TestCase): clear_website_cache() # first response no-cache - response = get_response('/_test/_test_folder/_test_page') - self.assertIn(('X-From-Cache', 'False'), list(response.headers)) + response = get_response("/_test/_test_folder/_test_page") + self.assertIn(("X-From-Cache", "False"), list(response.headers)) # first response returned from cache - response = get_response('/_test/_test_folder/_test_page') - self.assertIn(('X-From-Cache', 'True'), list(response.headers)) + response = get_response("/_test/_test_folder/_test_page") + self.assertIn(("X-From-Cache", "True"), list(response.headers)) frappe.flags.force_website_cache = False def test_safe_render(self): - content = get_response_content('/_test/_test_safe_render_on') + content = get_response_content("/_test/_test_safe_render_on") self.assertNotIn("Safe Render On", content) self.assertIn("frappe.exceptions.ValidationError: Illegal template", content) - content = get_response_content('/_test/_test_safe_render_off') + content = get_response_content("/_test/_test_safe_render_off") self.assertIn("Safe Render Off", content) self.assertIn("test.__test", content) self.assertNotIn("frappe.exceptions.ValidationError: Illegal template", content) @@ -309,22 +315,29 @@ class TestWebsite(unittest.TestCase): def set_home_page_hook(key, value): from frappe import hooks + # reset home_page hooks - for hook in ('get_website_user_home_page','website_user_home_page','role_home_page','home_page'): + for hook in ( + "get_website_user_home_page", + "website_user_home_page", + "role_home_page", + "home_page", + ): if hasattr(hooks, hook): delattr(hooks, hook) setattr(hooks, key, value) - frappe.cache().delete_key('app_hooks') + frappe.cache().delete_key("app_hooks") + -class CustomPageRenderer(): +class CustomPageRenderer: def __init__(self, path, status_code=None): self.path = path # custom status code self.status_code = 3984 def can_render(self): - if self.path in ('new', 'custom'): + if self.path in ("new", "custom"): return True def render(self): diff --git a/frappe/tests/tests_geo_utils.py b/frappe/tests/tests_geo_utils.py index 28b987e21e..2ac03e67e0 100644 --- a/frappe/tests/tests_geo_utils.py +++ b/frappe/tests/tests_geo_utils.py @@ -11,30 +11,46 @@ from frappe.geo.utils import get_coords class TestGeoUtils(unittest.TestCase): def setUp(self): self.todo = frappe.get_doc( - dict(doctype='ToDo', description='Test description', assigned_by='Administrator')).insert() - - self.test_location_dict = {'type': 'FeatureCollection', 'features': [ - {'type': 'Feature', 'properties': {}, "geometry": {'type': 'Point', 'coordinates': [49.20433, 55.753395]}}]} - self.test_location = frappe.get_doc({'name': 'Test Location', 'doctype': 'Location', - 'location': str(self.test_location_dict)}) - - self.test_filter_exists = [['Location', 'name', 'like', '%Test Location%']] - self.test_filter_not_exists = [['Location', 'name', 'like', '%Test Location Not exists%']] - self.test_filter_todo = [['ToDo', 'description', 'like', '%Test description%']] + dict(doctype="ToDo", description="Test description", assigned_by="Administrator") + ).insert() + + self.test_location_dict = { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": {}, + "geometry": {"type": "Point", "coordinates": [49.20433, 55.753395]}, + } + ], + } + self.test_location = frappe.get_doc( + {"name": "Test Location", "doctype": "Location", "location": str(self.test_location_dict)} + ) + + self.test_filter_exists = [["Location", "name", "like", "%Test Location%"]] + self.test_filter_not_exists = [["Location", "name", "like", "%Test Location Not exists%"]] + self.test_filter_todo = [["ToDo", "description", "like", "%Test description%"]] def test_get_coords_location_with_filter_exists(self): - coords = get_coords('Location', self.test_filter_exists, 'location_field') - self.assertEqual(self.test_location_dict['features'][0]['geometry'], coords['features'][0]['geometry']) + coords = get_coords("Location", self.test_filter_exists, "location_field") + self.assertEqual( + self.test_location_dict["features"][0]["geometry"], coords["features"][0]["geometry"] + ) def test_get_coords_location_with_filter_not_exists(self): - coords = get_coords('Location', self.test_filter_not_exists, 'location_field') - self.assertEqual(coords, {'type': 'FeatureCollection', 'features': []}) + coords = get_coords("Location", self.test_filter_not_exists, "location_field") + self.assertEqual(coords, {"type": "FeatureCollection", "features": []}) def test_get_coords_from_not_existable_location(self): - self.assertRaises(frappe.ValidationError, get_coords, 'ToDo', self.test_filter_todo, 'location_field') + self.assertRaises( + frappe.ValidationError, get_coords, "ToDo", self.test_filter_todo, "location_field" + ) def test_get_coords_from_not_existable_coords(self): - self.assertRaises(frappe.ValidationError, get_coords, 'ToDo', self.test_filter_todo, 'coordinates') + self.assertRaises( + frappe.ValidationError, get_coords, "ToDo", self.test_filter_todo, "coordinates" + ) def tearDown(self): self.todo.delete() diff --git a/frappe/tests/ui_test_helpers.py b/frappe/tests/ui_test_helpers.py index 063451825e..4cb3e95a6d 100644 --- a/frappe/tests/ui_test_helpers.py +++ b/frappe/tests/ui_test_helpers.py @@ -2,16 +2,17 @@ import frappe from frappe import _ from frappe.utils import add_to_date, now + @frappe.whitelist() def create_if_not_exists(doc): - '''Create records if they dont exist. + """Create records if they dont exist. Will check for uniqueness by checking if a record exists with these field value pairs :param doc: dict of field value pairs. can be a list of dict for multiple records. - ''' + """ if not frappe.local.dev_server: - frappe.throw(_('This method can only be accessed in development'), frappe.PermissionError) + frappe.throw(_("This method can only be accessed in development"), frappe.PermissionError) doc = frappe.parse_json(doc) @@ -24,7 +25,7 @@ def create_if_not_exists(doc): for doc in docs: doc = frappe._dict(doc) filters = doc.copy() - filters.pop('doctype') + filters.pop("doctype") name = frappe.db.exists(doc.doctype, filters) if not name: d = frappe.get_doc(doc) @@ -37,215 +38,225 @@ def create_if_not_exists(doc): @frappe.whitelist() def create_todo_records(): - if frappe.db.get_all('ToDo', {'description': 'this is first todo'}): + if frappe.db.get_all("ToDo", {"description": "this is first todo"}): return - frappe.get_doc({ - "doctype": "ToDo", - "date": add_to_date(now(), days=7), - "description": "this is first todo" - }).insert() - frappe.get_doc({ - "doctype": "ToDo", - "date": add_to_date(now(), days=-7), - "description": "this is second todo" - }).insert() - frappe.get_doc({ - "doctype": "ToDo", - "date": add_to_date(now(), months=2), - "description": "this is third todo" - }).insert() - frappe.get_doc({ - "doctype": "ToDo", - "date": add_to_date(now(), months=-2), - "description": "this is fourth todo" - }).insert() + frappe.get_doc( + {"doctype": "ToDo", "date": add_to_date(now(), days=7), "description": "this is first todo"} + ).insert() + frappe.get_doc( + {"doctype": "ToDo", "date": add_to_date(now(), days=-7), "description": "this is second todo"} + ).insert() + frappe.get_doc( + {"doctype": "ToDo", "date": add_to_date(now(), months=2), "description": "this is third todo"} + ).insert() + frappe.get_doc( + {"doctype": "ToDo", "date": add_to_date(now(), months=-2), "description": "this is fourth todo"} + ).insert() + @frappe.whitelist() def create_communication_record(): - doc = frappe.get_doc({ - "doctype": "Communication", - "recipients": "test@gmail.com", - "subject": "Test Form Communication 1", - "communication_date": frappe.utils.now_datetime(), - }) + doc = frappe.get_doc( + { + "doctype": "Communication", + "recipients": "test@gmail.com", + "subject": "Test Form Communication 1", + "communication_date": frappe.utils.now_datetime(), + } + ) doc.insert() return doc + @frappe.whitelist() def setup_workflow(): from frappe.workflow.doctype.workflow.test_workflow import create_todo_workflow + create_todo_workflow() create_todo_records() frappe.clear_cache() + @frappe.whitelist() def create_contact_phone_nos_records(): - if frappe.db.get_all('Contact', {'first_name': 'Test Contact'}): + if frappe.db.get_all("Contact", {"first_name": "Test Contact"}): return - doc = frappe.new_doc('Contact') - doc.first_name = 'Test Contact' + doc = frappe.new_doc("Contact") + doc.first_name = "Test Contact" for index in range(1000): - doc.append('phone_nos', {'phone': '123456{}'.format(index)}) + doc.append("phone_nos", {"phone": "123456{}".format(index)}) doc.insert() + @frappe.whitelist() def create_doctype(name, fields): fields = frappe.parse_json(fields) - if frappe.db.exists('DocType', name): + if frappe.db.exists("DocType", name): return - frappe.get_doc({ - "doctype": "DocType", - "module": "Core", - "custom": 1, - "fields": fields, - "permissions": [{ - "role": "System Manager", - "read": 1 - }], - "name": name - }).insert() + frappe.get_doc( + { + "doctype": "DocType", + "module": "Core", + "custom": 1, + "fields": fields, + "permissions": [{"role": "System Manager", "read": 1}], + "name": name, + } + ).insert() + @frappe.whitelist() def create_child_doctype(name, fields): fields = frappe.parse_json(fields) - if frappe.db.exists('DocType', name): + if frappe.db.exists("DocType", name): return - frappe.get_doc({ - "doctype": "DocType", - "module": "Core", - "istable": 1, - "custom": 1, - "fields": fields, - "permissions": [{ - "role": "System Manager", - "read": 1 - }], - "name": name - }).insert() + frappe.get_doc( + { + "doctype": "DocType", + "module": "Core", + "istable": 1, + "custom": 1, + "fields": fields, + "permissions": [{"role": "System Manager", "read": 1}], + "name": name, + } + ).insert() + @frappe.whitelist() def create_contact_records(): - if frappe.db.get_all('Contact', {'first_name': 'Test Form Contact 1'}): + if frappe.db.get_all("Contact", {"first_name": "Test Form Contact 1"}): return - insert_contact('Test Form Contact 1', '12345') - insert_contact('Test Form Contact 2', '54321') - insert_contact('Test Form Contact 3', '12345') + insert_contact("Test Form Contact 1", "12345") + insert_contact("Test Form Contact 2", "54321") + insert_contact("Test Form Contact 3", "12345") + @frappe.whitelist() def create_multiple_todo_records(): values = [] - if frappe.db.get_all('ToDo', {'description': 'Multiple ToDo 1'}): + if frappe.db.get_all("ToDo", {"description": "Multiple ToDo 1"}): return for index in range(1, 1002): - values.append(('100{}'.format(index), 'Multiple ToDo {}'.format(index))) + values.append(("100{}".format(index), "Multiple ToDo {}".format(index))) + + frappe.db.bulk_insert("ToDo", fields=["name", "description"], values=set(values)) - frappe.db.bulk_insert('ToDo', fields=['name', 'description'], values=set(values)) def insert_contact(first_name, phone_number): - doc = frappe.get_doc({ - 'doctype': 'Contact', - 'first_name': first_name - }) - doc.append('phone_nos', {'phone': phone_number}) + doc = frappe.get_doc({"doctype": "Contact", "first_name": first_name}) + doc.append("phone_nos", {"phone": phone_number}) doc.insert() + @frappe.whitelist() def create_form_tour(): - if frappe.db.exists('Form Tour', {'name': 'Test Form Tour'}): + if frappe.db.exists("Form Tour", {"name": "Test Form Tour"}): return - tour = frappe.get_doc({ - 'doctype': 'Form Tour', - 'title': 'Test Form Tour', - 'reference_doctype': 'Contact', - 'save_on_complete': 1, - 'steps': [{ - "title": "Test Title 1", - "description": "Test Description 1", - "has_next_condition": 1, - "next_step_condition": "eval: doc.first_name", - "fieldname": "first_name", - "fieldtype": "Data" - },{ - "title": "Test Title 2", - "description": "Test Description 2", - "has_next_condition": 1, - "next_step_condition": "eval: doc.last_name", - "fieldname": "last_name", - "fieldtype": "Data" - },{ - "title": "Test Title 3", - "description": "Test Description 3", - "fieldname": "phone_nos", - "fieldtype": "Table" - },{ - "title": "Test Title 4", - "description": "Test Description 4", - "is_table_field": 1, - "parent_fieldname": "phone_nos", - "next_step_condition": "eval: doc.phone", - "has_next_condition": 1, - "fieldname": "phone", - "fieldtype": "Data" - }] - }) + tour = frappe.get_doc( + { + "doctype": "Form Tour", + "title": "Test Form Tour", + "reference_doctype": "Contact", + "save_on_complete": 1, + "steps": [ + { + "title": "Test Title 1", + "description": "Test Description 1", + "has_next_condition": 1, + "next_step_condition": "eval: doc.first_name", + "fieldname": "first_name", + "fieldtype": "Data", + }, + { + "title": "Test Title 2", + "description": "Test Description 2", + "has_next_condition": 1, + "next_step_condition": "eval: doc.last_name", + "fieldname": "last_name", + "fieldtype": "Data", + }, + { + "title": "Test Title 3", + "description": "Test Description 3", + "fieldname": "phone_nos", + "fieldtype": "Table", + }, + { + "title": "Test Title 4", + "description": "Test Description 4", + "is_table_field": 1, + "parent_fieldname": "phone_nos", + "next_step_condition": "eval: doc.phone", + "has_next_condition": 1, + "fieldname": "phone", + "fieldtype": "Data", + }, + ], + } + ) tour.insert() + @frappe.whitelist() def create_data_for_discussions(): web_page = create_web_page("Test page for discussions", "test-page-discussions", False) create_topic_and_reply(web_page) create_web_page("Test single thread discussion", "test-single-thread", True) + def create_web_page(title, route, single_thread): web_page = frappe.db.exists("Web Page", {"route": route}) if web_page: return web_page - web_page = frappe.get_doc({ - "doctype": "Web Page", - "title": title, - "route": route, - "published": True - }) + web_page = frappe.get_doc( + {"doctype": "Web Page", "title": title, "route": route, "published": True} + ) web_page.save() - web_page.append("page_blocks", { - "web_template": "Discussions", - "web_template_values": frappe.as_json({ - "title": "Discussions", - "cta_title": "New Discussion", - "docname": web_page.name, - "single_thread": single_thread - }) - }) + web_page.append( + "page_blocks", + { + "web_template": "Discussions", + "web_template_values": frappe.as_json( + { + "title": "Discussions", + "cta_title": "New Discussion", + "docname": web_page.name, + "single_thread": single_thread, + } + ), + }, + ) web_page.save() return web_page.name + def create_topic_and_reply(web_page): - topic = frappe.db.exists("Discussion Topic",{ - "reference_doctype": "Web Page", - "reference_docname": web_page - }) + topic = frappe.db.exists( + "Discussion Topic", {"reference_doctype": "Web Page", "reference_docname": web_page} + ) if not topic: - topic = frappe.get_doc({ - "doctype": "Discussion Topic", - "reference_doctype": "Web Page", - "reference_docname": web_page, - "title": "Test Topic" - }) + topic = frappe.get_doc( + { + "doctype": "Discussion Topic", + "reference_doctype": "Web Page", + "reference_docname": web_page, + "title": "Test Topic", + } + ) topic.save() - reply = frappe.get_doc({ - "doctype": "Discussion Reply", - "topic": topic.name, - "reply": "This is a test reply" - }) + reply = frappe.get_doc( + {"doctype": "Discussion Reply", "topic": topic.name, "reply": "This is a test reply"} + ) reply.save() @@ -261,58 +272,66 @@ def update_webform_to_multistep(): _doc.is_standard = False _doc.save() + @frappe.whitelist() def update_child_table(name): - doc = frappe.get_doc('DocType', name) + doc = frappe.get_doc("DocType", name) if len(doc.fields) == 1: - doc.append('fields', { - 'fieldname': 'doctype_to_link', - 'fieldtype': 'Link', - 'in_list_view': 1, - 'label': 'Doctype to Link', - 'options': 'Doctype to Link' - }) + doc.append( + "fields", + { + "fieldname": "doctype_to_link", + "fieldtype": "Link", + "in_list_view": 1, + "label": "Doctype to Link", + "options": "Doctype to Link", + }, + ) doc.save() + @frappe.whitelist() def insert_doctype_with_child_table_record(name): - if frappe.db.get_all(name, {'title': 'Test Grid Search'}): + if frappe.db.get_all(name, {"title": "Test Grid Search"}): return def insert_child(doc, data, barcode, check, rating, duration, date): - doc.append('child_table_1', { - 'data': data, - 'barcode': barcode, - 'check': check, - 'rating': rating, - 'duration': duration, - 'date': date, - }) + doc.append( + "child_table_1", + { + "data": data, + "barcode": barcode, + "check": check, + "rating": rating, + "duration": duration, + "date": date, + }, + ) doc = frappe.new_doc(name) - doc.title = 'Test Grid Search' - doc.append('child_table', {'title': 'Test Grid Search'}) - - insert_child(doc, 'Data', '09709KJKKH2432', 1, 0.5, 266851, "2022-02-21") - insert_child(doc, 'Test', '09209KJHKH2432', 1, 0.8, 547877, "2021-05-27") - insert_child(doc, 'New', '09709KJHYH1132', 0, 0.1, 3, "2019-03-02") - insert_child(doc, 'Old', '09701KJHKH8750', 0, 0, 127455, "2022-01-11") - insert_child(doc, 'Alpha', '09204KJHKH2432', 0, 0.6, 364, "2019-12-31") - insert_child(doc, 'Delta', '09709KSPIO2432', 1, 0.9, 1242000, "2020-04-21") - insert_child(doc, 'Update', '76989KJLVA2432', 0, 1, 183845, "2022-02-10") - insert_child(doc, 'Delete', '29189KLHVA1432', 0, 0, 365647, "2021-05-07") - insert_child(doc, 'Make', '09689KJHAA2431', 0, 0.3, 24, "2020-11-11") - insert_child(doc, 'Create', '09709KLKKH2432', 1, 0.3, 264851, "2021-02-21") - insert_child(doc, 'Group', '09209KJLKH2432', 1, 0.8, 537877, "2020-03-15") - insert_child(doc, 'Slide', '01909KJHYH1132', 0, 0.5, 9, "2018-03-02") - insert_child(doc, 'Drop', '09701KJHKH8750', 1, 0, 127255, "2018-01-01") - insert_child(doc, 'Beta', '09204QJHKN2432', 0, 0.6, 354, "2017-12-30") - insert_child(doc, 'Flag', '09709KXPIP2432', 1, 0, 1241000, "2021-04-21") - insert_child(doc, 'Upgrade', '75989ZJLVA2432', 0.8, 1, 183645, "2020-08-13") - insert_child(doc, 'Down', '28189KLHRA1432', 1, 0, 362647, "2020-06-17") - insert_child(doc, 'Note', '09689DJHAA2431', 0, 0.1, 29, "2021-09-11") - insert_child(doc, 'Click', '08189DJHAA2431', 1, 0.3, 209, "2020-07-04") - insert_child(doc, 'Drag', '08189DIHAA2981', 0, 0.7, 342628, "2022-05-04") + doc.title = "Test Grid Search" + doc.append("child_table", {"title": "Test Grid Search"}) + + insert_child(doc, "Data", "09709KJKKH2432", 1, 0.5, 266851, "2022-02-21") + insert_child(doc, "Test", "09209KJHKH2432", 1, 0.8, 547877, "2021-05-27") + insert_child(doc, "New", "09709KJHYH1132", 0, 0.1, 3, "2019-03-02") + insert_child(doc, "Old", "09701KJHKH8750", 0, 0, 127455, "2022-01-11") + insert_child(doc, "Alpha", "09204KJHKH2432", 0, 0.6, 364, "2019-12-31") + insert_child(doc, "Delta", "09709KSPIO2432", 1, 0.9, 1242000, "2020-04-21") + insert_child(doc, "Update", "76989KJLVA2432", 0, 1, 183845, "2022-02-10") + insert_child(doc, "Delete", "29189KLHVA1432", 0, 0, 365647, "2021-05-07") + insert_child(doc, "Make", "09689KJHAA2431", 0, 0.3, 24, "2020-11-11") + insert_child(doc, "Create", "09709KLKKH2432", 1, 0.3, 264851, "2021-02-21") + insert_child(doc, "Group", "09209KJLKH2432", 1, 0.8, 537877, "2020-03-15") + insert_child(doc, "Slide", "01909KJHYH1132", 0, 0.5, 9, "2018-03-02") + insert_child(doc, "Drop", "09701KJHKH8750", 1, 0, 127255, "2018-01-01") + insert_child(doc, "Beta", "09204QJHKN2432", 0, 0.6, 354, "2017-12-30") + insert_child(doc, "Flag", "09709KXPIP2432", 1, 0, 1241000, "2021-04-21") + insert_child(doc, "Upgrade", "75989ZJLVA2432", 0.8, 1, 183645, "2020-08-13") + insert_child(doc, "Down", "28189KLHRA1432", 1, 0, 362647, "2020-06-17") + insert_child(doc, "Note", "09689DJHAA2431", 0, 0.1, 29, "2021-09-11") + insert_child(doc, "Click", "08189DJHAA2431", 1, 0.3, 209, "2020-07-04") + insert_child(doc, "Drag", "08189DIHAA2981", 0, 0.7, 342628, "2022-05-04") doc.insert() diff --git a/frappe/tests/utils.py b/frappe/tests/utils.py index 8699a51bf8..bad368afd0 100644 --- a/frappe/tests/utils.py +++ b/frappe/tests/utils.py @@ -8,6 +8,7 @@ import frappe class FrappeTestCase(unittest.TestCase): """Base test class for Frappe tests.""" + @classmethod def setUpClass(cls) -> None: frappe.db.commit() @@ -21,7 +22,7 @@ class FrappeTestCase(unittest.TestCase): @contextmanager def change_settings(doctype, settings_dict): - """ A context manager to ensure that settings are changed before running + """A context manager to ensure that settings are changed before running function and restored after running it regardless of exceptions occured. This is useful in tests where you want to make changes in a function but don't retain those changes. @@ -30,7 +31,7 @@ def change_settings(doctype, settings_dict): example: @change_settings("Print Settings", {"send_print_as_pdf": 1}) def test_case(self): - ... + ... """ try: @@ -46,7 +47,7 @@ def change_settings(doctype, settings_dict): settings.save() # singles are cached by default, clear to avoid flake frappe.db.value_cache[settings] = {} - yield # yield control to calling function + yield # yield control to calling function finally: # restore settings @@ -57,9 +58,10 @@ def change_settings(doctype, settings_dict): def timeout(seconds=30, error_message="Test timed out."): - """ Timeout decorator to ensure a test doesn't run for too long. + """Timeout decorator to ensure a test doesn't run for too long. + + adapted from https://stackoverflow.com/a/2282656""" - adapted from https://stackoverflow.com/a/2282656""" def decorator(func): def _handle_timeout(signum, frame): raise Exception(error_message) @@ -72,5 +74,7 @@ def timeout(seconds=30, error_message="Test timed out."): finally: signal.alarm(0) return result + return wrapper + return decorator diff --git a/frappe/translate.py b/frappe/translate.py index 6e0fefd6fa..d95c8eb3e8 100644 --- a/frappe/translate.py +++ b/frappe/translate.py @@ -7,48 +7,45 @@ Translation tools for frappe """ +import functools import io import itertools import json import operator -import functools import os import re from csv import reader -from typing import List, Union, Tuple +from typing import List, Tuple, Union + +from pypika.terms import PseudoColumn import frappe from frappe.model.utils import InvalidIncludePath, render_include +from frappe.query_builder import DocType, Field from frappe.utils import get_bench_path, is_html, strip, strip_html_tags -from frappe.query_builder import Field, DocType -from pypika.terms import PseudoColumn TRANSLATE_PATTERN = re.compile( r"_\([\s\n]*" # starts with literal `_(`, ignore following whitespace/newlines - # BEGIN: message search r"([\"']{,3})" # start of message string identifier - allows: ', ", """, '''; 1st capture group - r"(?P@@ -237,30 +265,38 @@ def get_email_body_for_2fa(kwargs_dict): body = frappe.render_template(body_template, kwargs_dict) return body + def get_email_subject_for_qr_code(kwargs_dict): - '''Get QRCode email subject.''' - subject_template = _('One Time Password (OTP) Registration Code from {}').format(frappe.db.get_value('System Settings', 'System Settings', 'otp_issuer_name')) + """Get QRCode email subject.""" + subject_template = _("One Time Password (OTP) Registration Code from {}").format( + frappe.db.get_value("System Settings", "System Settings", "otp_issuer_name") + ) subject = frappe.render_template(subject_template, kwargs_dict) return subject + def get_email_body_for_qr_code(kwargs_dict): - '''Get QRCode email body.''' - body_template = 'Please click on the following link and follow the instructions on the page.
{{qrcode_link}}' + """Get QRCode email body.""" + body_template = "Please click on the following link and follow the instructions on the page.
{{qrcode_link}}" body = frappe.render_template(body_template, kwargs_dict) return body + def get_link_for_qrcode(user, totp_uri): - '''Get link to temporary page showing QRCode.''' + """Get link to temporary page showing QRCode.""" key = frappe.generate_hash(length=20) key_user = "{}_user".format(key) key_uri = "{}_uri".format(key) - lifespan = int(frappe.db.get_value('System Settings', 'System Settings', 'lifespan_qrcode_image')) or 240 + lifespan = ( + int(frappe.db.get_value("System Settings", "System Settings", "lifespan_qrcode_image")) or 240 + ) frappe.cache().set_value(key_uri, totp_uri, expires_in_sec=lifespan) frappe.cache().set_value(key_user, user, expires_in_sec=lifespan) - return get_url('/qrcode?k={}'.format(key)) + return get_url("/qrcode?k={}".format(key)) + def send_token_via_sms(otpsecret, token=None, phone_no=None): - '''Send token as sms to user.''' + """Send token as sms to user.""" try: from frappe.core.doctype.sms_settings.sms_settings import send_request except: @@ -269,152 +305,187 @@ def send_token_via_sms(otpsecret, token=None, phone_no=None): if not phone_no: return False - ss = frappe.get_doc('SMS Settings', 'SMS Settings') + ss = frappe.get_doc("SMS Settings", "SMS Settings") if not ss.sms_gateway_url: return False hotp = pyotp.HOTP(otpsecret) - args = { - ss.message_parameter: 'Your verification code is {}'.format(hotp.at(int(token))) - } + args = {ss.message_parameter: "Your verification code is {}".format(hotp.at(int(token)))} for d in ss.get("parameters"): args[d.parameter] = d.value args[ss.receiver_parameter] = phone_no - sms_args = { - 'params': args, - 'gateway_url': ss.sms_gateway_url, - 'use_post': ss.use_post - } - enqueue(method=send_request, queue='short', timeout=300, event=None, - is_async=True, job_name=None, now=False, **sms_args) + sms_args = {"params": args, "gateway_url": ss.sms_gateway_url, "use_post": ss.use_post} + enqueue( + method=send_request, + queue="short", + timeout=300, + event=None, + is_async=True, + job_name=None, + now=False, + **sms_args + ) return True + def send_token_via_email(user, token, otp_secret, otp_issuer, subject=None, message=None): - '''Send token to user as email.''' - user_email = frappe.db.get_value('User', user, 'email') + """Send token to user as email.""" + user_email = frappe.db.get_value("User", user, "email") if not user_email: return False hotp = pyotp.HOTP(otp_secret) otp = hotp.at(int(token)) - template_args = {'otp': otp, 'otp_issuer': otp_issuer} + template_args = {"otp": otp, "otp_issuer": otp_issuer} if not subject: subject = get_email_subject_for_2fa(template_args) if not message: message = get_email_body_for_2fa(template_args) email_args = { - 'recipients': user_email, - 'sender': None, - 'subject': subject, - 'message': message, - 'header': [_('Verfication Code'), 'blue'], - 'delayed': False, - 'retry':3 + "recipients": user_email, + "sender": None, + "subject": subject, + "message": message, + "header": [_("Verfication Code"), "blue"], + "delayed": False, + "retry": 3, } - enqueue(method=frappe.sendmail, queue='short', timeout=300, event=None, - is_async=True, job_name=None, now=False, **email_args) + enqueue( + method=frappe.sendmail, + queue="short", + timeout=300, + event=None, + is_async=True, + job_name=None, + now=False, + **email_args + ) return True + def get_qr_svg_code(totp_uri): - '''Get SVG code to display Qrcode for OTP.''' + """Get SVG code to display Qrcode for OTP.""" url = qrcreate(totp_uri) - svg = '' + svg = "" stream = BytesIO() try: url.svg(stream, scale=4, background="#eee", module_color="#222") - svg = stream.getvalue().decode().replace('\n', '') + svg = stream.getvalue().decode().replace("\n", "") svg = b64encode(svg.encode()) finally: stream.close() return svg + def qrcode_as_png(user, totp_uri): - '''Save temporary Qrcode to server.''' + """Save temporary Qrcode to server.""" folder = create_barcode_folder() - png_file_name = '{}.png'.format(frappe.generate_hash(length=20)) - _file = frappe.get_doc({ - "doctype": "File", - "file_name": png_file_name, - "attached_to_doctype": 'User', - "attached_to_name": user, - "folder": folder, - "content": png_file_name}) + png_file_name = "{}.png".format(frappe.generate_hash(length=20)) + _file = frappe.get_doc( + { + "doctype": "File", + "file_name": png_file_name, + "attached_to_doctype": "User", + "attached_to_name": user, + "folder": folder, + "content": png_file_name, + } + ) _file.save() frappe.db.commit() file_url = get_url(_file.file_url) - file_path = os.path.join(frappe.get_site_path('public', 'files'), _file.file_name) + file_path = os.path.join(frappe.get_site_path("public", "files"), _file.file_name) url = qrcreate(totp_uri) - with open(file_path, 'w') as png_file: - url.png(png_file, scale=8, module_color=[0, 0, 0, 180], background=[0xff, 0xff, 0xcc]) + with open(file_path, "w") as png_file: + url.png(png_file, scale=8, module_color=[0, 0, 0, 180], background=[0xFF, 0xFF, 0xCC]) return file_url + def create_barcode_folder(): - '''Get Barcodes folder.''' - folder_name = 'Barcodes' - folder = frappe.db.exists('File', {'file_name': folder_name}) + """Get Barcodes folder.""" + folder_name = "Barcodes" + folder = frappe.db.exists("File", {"file_name": folder_name}) if folder: return folder - folder = frappe.get_doc({ - 'doctype': 'File', - 'file_name': folder_name, - 'is_folder':1, - 'folder': 'Home' - }) + folder = frappe.get_doc( + {"doctype": "File", "file_name": folder_name, "is_folder": 1, "folder": "Home"} + ) folder.insert(ignore_permissions=True) return folder.name + def delete_qrimage(user, check_expiry=False): - '''Delete Qrimage when user logs in.''' - user_barcodes = frappe.get_all('File', {'attached_to_doctype': 'User', - 'attached_to_name': user, 'folder': 'Home/Barcodes'}) + """Delete Qrimage when user logs in.""" + user_barcodes = frappe.get_all( + "File", {"attached_to_doctype": "User", "attached_to_name": user, "folder": "Home/Barcodes"} + ) for barcode in user_barcodes: if check_expiry and not should_remove_barcode_image(barcode): continue - barcode = frappe.get_doc('File', barcode.name) - frappe.delete_doc('File', barcode.name, ignore_permissions=True) + barcode = frappe.get_doc("File", barcode.name) + frappe.delete_doc("File", barcode.name, ignore_permissions=True) + def delete_all_barcodes_for_users(): - '''Task to delete all barcodes for user.''' + """Task to delete all barcodes for user.""" - users = frappe.get_all('User', {'enabled':1}) + users = frappe.get_all("User", {"enabled": 1}) for user in users: if not two_factor_is_enabled(user=user.name): continue delete_qrimage(user.name, check_expiry=True) + def should_remove_barcode_image(barcode): - '''Check if it's time to delete barcode image from server. ''' + """Check if it's time to delete barcode image from server.""" if isinstance(barcode, str): - barcode = frappe.get_doc('File', barcode) - lifespan = frappe.db.get_value('System Settings', 'System Settings', 'lifespan_qrcode_image') or 240 + barcode = frappe.get_doc("File", barcode) + lifespan = ( + frappe.db.get_value("System Settings", "System Settings", "lifespan_qrcode_image") or 240 + ) if time_diff_in_seconds(get_datetime(), barcode.creation) > int(lifespan): return True return False + def disable(): - frappe.db.set_value('System Settings', None, 'enable_two_factor_auth', 0) + frappe.db.set_value("System Settings", None, "enable_two_factor_auth", 0) + @frappe.whitelist() def reset_otp_secret(user): - otp_issuer = frappe.db.get_value('System Settings', 'System Settings', 'otp_issuer_name') - user_email = frappe.db.get_value('User', user, 'email') - if frappe.session.user in ["Administrator", user] : - frappe.defaults.clear_default(user + '_otplogin') - frappe.defaults.clear_default(user + '_otpsecret') + otp_issuer = frappe.db.get_value("System Settings", "System Settings", "otp_issuer_name") + user_email = frappe.db.get_value("User", user, "email") + if frappe.session.user in ["Administrator", user]: + frappe.defaults.clear_default(user + "_otplogin") + frappe.defaults.clear_default(user + "_otpsecret") email_args = { - 'recipients': user_email, - 'sender': None, - 'subject': _('OTP Secret Reset - {0}').format(otp_issuer or "Frappe Framework"), - 'message': _('
Your OTP secret on {0} has been reset. If you did not perform this reset and did not request it, please contact your System Administrator immediately.
').format(otp_issuer or "Frappe Framework"), - 'delayed':False, - 'retry':3 + "recipients": user_email, + "sender": None, + "subject": _("OTP Secret Reset - {0}").format(otp_issuer or "Frappe Framework"), + "message": _( + "Your OTP secret on {0} has been reset. If you did not perform this reset and did not request it, please contact your System Administrator immediately.
" + ).format(otp_issuer or "Frappe Framework"), + "delayed": False, + "retry": 3, } - enqueue(method=frappe.sendmail, queue='short', timeout=300, event=None, is_async=True, job_name=None, now=False, **email_args) - return frappe.msgprint(_("OTP Secret has been reset. Re-registration will be required on next login.")) + enqueue( + method=frappe.sendmail, + queue="short", + timeout=300, + event=None, + is_async=True, + job_name=None, + now=False, + **email_args + ) + return frappe.msgprint( + _("OTP Secret has been reset. Re-registration will be required on next login.") + ) else: - return frappe.throw(_("OTP secret can only be reset by the Administrator.")) \ No newline at end of file + return frappe.throw(_("OTP secret can only be reset by the Administrator.")) diff --git a/frappe/utils/__init__.py b/frappe/utils/__init__.py index 62b8df40b6..3e62589664 100644 --- a/frappe/utils/__init__.py +++ b/frappe/utils/__init__.py @@ -10,16 +10,18 @@ import re import sys import traceback import typing +from collections.abc import MutableMapping, MutableSequence, Sequence from email.header import decode_header, make_header from email.utils import formataddr, parseaddr from gzip import GzipFile from typing import Generator, Iterable from urllib.parse import quote, urlparse -from werkzeug.test import Client + from redis.exceptions import ConnectionError -from collections.abc import MutableMapping, MutableSequence, Sequence +from werkzeug.test import Client import frappe + # utility functions like cint, int, flt, etc. from frappe.utils.data import * from frappe.utils.html_utils import sanitize_html @@ -36,13 +38,15 @@ def get_fullname(user=None): if not frappe.local.fullnames.get(user): p = frappe.db.get_value("User", user, ["first_name", "last_name"], as_dict=True) if p: - frappe.local.fullnames[user] = " ".join(filter(None, - [p.get('first_name'), p.get('last_name')])) or user + frappe.local.fullnames[user] = ( + " ".join(filter(None, [p.get("first_name"), p.get("last_name")])) or user + ) else: frappe.local.fullnames[user] = user return frappe.local.fullnames.get(user) + def get_email_address(user=None): """get the email address of the user from User""" if not user: @@ -50,10 +54,11 @@ def get_email_address(user=None): return frappe.db.get_value("User", user, "email") + def get_formatted_email(user, mail=None): """get Email Address of user formatted as: `John Doe