3446026555
The license.txt file has been replaced with LICENSE for quite a while now. INAL but it didn't seem accurate to say "hey, checkout license.txt although there's no such file". Apart from this, there were inconsistencies in the headers altogether...this change brings consistency.
133 lines
3.7 KiB
Python
133 lines
3.7 KiB
Python
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
|
|
# License: MIT. See LICENSE
|
|
"""
|
|
Execute Patch Files
|
|
|
|
To run directly
|
|
|
|
python lib/wnf.py patch patch1, patch2 etc
|
|
python lib/wnf.py patch -f patch1, patch2 etc
|
|
|
|
where patch1, patch2 is module name
|
|
"""
|
|
import frappe, frappe.permissions, time
|
|
|
|
class PatchError(Exception): pass
|
|
|
|
def run_all(skip_failing=False):
|
|
"""run all pending patches"""
|
|
executed = [p[0] for p in frappe.db.sql("""select patch from `tabPatch Log`""")]
|
|
|
|
frappe.flags.final_patches = []
|
|
|
|
def run_patch(patch):
|
|
try:
|
|
if not run_single(patchmodule = patch):
|
|
log(patch + ': failed: STOPPED')
|
|
raise PatchError(patch)
|
|
except Exception:
|
|
if not skip_failing:
|
|
raise
|
|
else:
|
|
log('Failed to execute patch')
|
|
|
|
for patch in get_all_patches():
|
|
if patch and (patch not in executed):
|
|
run_patch(patch)
|
|
|
|
# patches to be run in the end
|
|
for patch in frappe.flags.final_patches:
|
|
patch = patch.replace('finally:', '')
|
|
run_patch(patch)
|
|
|
|
def get_all_patches():
|
|
patches = []
|
|
for app in frappe.get_installed_apps():
|
|
if app == "shopping_cart":
|
|
continue
|
|
# 3-to-4 fix
|
|
if app=="webnotes":
|
|
app="frappe"
|
|
patches.extend(frappe.get_file_items(frappe.get_pymodule_path(app, "patches.txt")))
|
|
|
|
return patches
|
|
|
|
def reload_doc(args):
|
|
import frappe.modules
|
|
run_single(method = frappe.modules.reload_doc, methodargs = args)
|
|
|
|
def run_single(patchmodule=None, method=None, methodargs=None, force=False):
|
|
from frappe import conf
|
|
|
|
# don't write txt files
|
|
conf.developer_mode = 0
|
|
|
|
if force or method or not executed(patchmodule):
|
|
return execute_patch(patchmodule, method, methodargs)
|
|
else:
|
|
return True
|
|
|
|
def execute_patch(patchmodule, method=None, methodargs=None):
|
|
"""execute the patch"""
|
|
block_user(True)
|
|
frappe.db.begin()
|
|
start_time = time.time()
|
|
try:
|
|
log('Executing {patch} in {site} ({db})'.format(patch=patchmodule or str(methodargs),
|
|
site=frappe.local.site, db=frappe.db.cur_db_name))
|
|
if patchmodule:
|
|
if patchmodule.startswith("finally:"):
|
|
# run run patch at the end
|
|
frappe.flags.final_patches.append(patchmodule)
|
|
else:
|
|
if patchmodule.startswith("execute:"):
|
|
exec(patchmodule.split("execute:")[1],globals())
|
|
else:
|
|
frappe.get_attr(patchmodule.split()[0] + ".execute")()
|
|
update_patch_log(patchmodule)
|
|
elif method:
|
|
method(**methodargs)
|
|
|
|
except Exception:
|
|
frappe.db.rollback()
|
|
raise
|
|
|
|
else:
|
|
frappe.db.commit()
|
|
end_time = time.time()
|
|
block_user(False)
|
|
log('Success: Done in {time}s'.format(time = round(end_time - start_time, 3)))
|
|
|
|
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:'):
|
|
# patches are saved without the finally: tag
|
|
patchmodule = patchmodule.replace('finally:', '')
|
|
done = frappe.db.get_value("Patch Log", {"patch": patchmodule})
|
|
# if done:
|
|
# print "Patch %s already executed in %s" % (patchmodule, frappe.db.cur_db_name)
|
|
return done
|
|
|
|
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.commit()
|
|
|
|
def check_session_stopped():
|
|
if frappe.db.get_global("__session_status")=='stop':
|
|
frappe.msgprint(frappe.db.get_global("__session_status_message"))
|
|
raise frappe.SessionStopped('Session Stopped')
|
|
|
|
def log(msg):
|
|
print (msg)
|