# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: MIT. See LICENSE 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 def rename_field(doctype, old_fieldname, new_fieldname, validate=True): """This functions assumes that doctype is already synced""" meta = frappe.get_meta(doctype, cached=False) new_field = meta.get_field(new_fieldname) if validate: if not new_field: print("rename_field: " + (new_fieldname) + " not found in " + doctype) return if not meta.issingle and not frappe.db.has_column(doctype, old_fieldname): print("rename_field: " + (old_fieldname) + " not found in table for: " + doctype) # never had the field? return if new_field.fieldtype in table_fields: # change parentfield of table mentioned in options frappe.db.sql( """update `tab{}` set parentfield={} where parentfield={}""".format(new_field.options.split("\n", 1)[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 where doctype=%s and field=%s""", (new_fieldname, doctype, old_fieldname), ) else: # copy field value frappe.db.sql(f"""update `tab{doctype}` set `{new_fieldname}`=`{old_fieldname}`""") update_reports(doctype, old_fieldname, new_fieldname) update_users_report_view_settings(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: sort_by = doctype + "." + new_fieldname report_dict["updated"] = True 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) return sort_by 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, ) for r in reports: report_dict = json.loads(r.json) # update filters new_filters = [] if report_dict.get("filters"): for f in report_dict.get("filters"): if f and len(f) > 1 and f[0] == doctype and f[1] == old_fieldname: new_filters.append([doctype, new_fieldname, f[2], f[3]]) report_dict["updated"] = True else: new_filters.append(f) # update columns new_columns = [] if report_dict.get("columns"): for c in report_dict.get("columns"): if c and len(c) > 1 and c[0] == old_fieldname and c[1] == doctype: new_columns.append([new_fieldname, doctype]) report_dict["updated"] = True else: new_columns.append(c) # update sort by new_sort_by = _get_new_sort_by(report_dict, r, "sort_by") 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"), } ) 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:%'""" ) 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 else: new_columns.append([field, field_doctype]) if columns_modified: frappe.db.sql( """update `tabDefaultValue` set defvalue={} where defkey={}""".format("%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 `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, ) for user_setting in user_settings: update_user_settings_data(user_setting, "docfield", old_fieldname, new_fieldname)