Multi-component Page - ประวัติรุ่นแก้ไข

Tenko: ย้อนรุ่นแก้ไข 1937 ของ Tenko (คุย)

2024-07-24T04:33:32Z

ย้อนรุ่นแก้ไข 1937 ของ Tenko (คุย)

@@ บรรทัดที่ 59: / บรรทัดที่ 59: @@
 ==== Beacon Routine Functions ====
-The 2 groups of beacon keys discussed above can be converted into a dict form for ease of use via the Python function '''[[Common Functions#process_beacon_args|process_beacon_args]]'''. And the process of locking/unlocking a document can be automated via another function '''[[Common Functions#process_doclock|process_doclock]]'''.
+The 2 groups of beacon keys discussed above can be converted into a dict form for ease of use via the Python function '''{{code|lang=python|process_beacon_args}}'''.
 ==== Page Permission → Document Lock → Allowed Actions ====

Tenko: /* Beacon Routine Functions */

2024-07-24T04:22:48Z

Beacon Routine Functions

@@ บรรทัดที่ 59: / บรรทัดที่ 59: @@
 ==== Beacon Routine Functions ====
-The 2 groups of beacon keys discussed above can be converted into a dict form for ease of use via the Python function '''{{code|lang=python|process_beacon_args}}'''.
+The 2 groups of beacon keys discussed above can be converted into a dict form for ease of use via the Python function '''[[Common Functions#process_beacon_args|process_beacon_args]]'''. And the process of locking/unlocking a document can be automated via another function '''[[Common Functions#process_doclock|process_doclock]]'''.
 ==== Page Permission → Document Lock → Allowed Actions ====

Tenko: /* HTML Page Pattern */

2024-07-17T06:35:03Z

HTML Page Pattern

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 13:35, 17 กรกฎาคม 2567
บรรทัดที่ 692:		บรรทัดที่ 692:
	=== HTML Page Pattern ===		=== HTML Page Pattern ===
	<syntaxhighlight lang="html" id="process_beacon_args" line="1">		<syntaxhighlight lang="html" id="process_beacon_args" line="1">
			<!-- EXAMPLE FROM ACCOUNTING JOURNAL PAGE -->

	{% import "cunei_forms.html" as CuneiForms %}		{% import "cunei_forms.html" as CuneiForms %}
	{% import "cunei_tables.html" as CuneiTables with context %}		{% import "cunei_tables.html" as CuneiTables with context %}

Tenko: /* Unified Render-Fetch-Submit Route */

2024-07-17T06:15:39Z

Unified Render-Fetch-Submit Route

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 13:15, 17 กรกฎาคม 2567
บรรทัดที่ 378:		บรรทัดที่ 378:
	thisdoc[head_form._id] = dict(...)		thisdoc[head_form._id] = dict(...)
	else: # Found a document		else: # Found a document
	thisdoc[head_form._id] = {col:getattr(thisdoc[head_form._id], col, None) for col in head_form.seq}		thisdoc[head_form._id] = {col:getattr(thisdoc[head_form._id], col, None) \
			for col in head_form.seq}
	# Modify as needed.		# Modify as needed.
	# ...		# ...
บรรทัดที่ 390:		บรรทัดที่ 391:
	# ...		# ...
	# DETERMINE DOCUMENT VERIFICATION STATE and its implication the page-level actions.		# DETERMINE DOCUMENT VERIFICATION STATE and its implication the page-level actions.
	docverify = ~~{"editting":getattr~~(~~thisdoc[head_form~~.~~_id], "editting", ""~~)}		docverify = dict(...)
	if doccount[1] <= 0 or <some_other_conditions>:		if doccount[1] <= 0 or <some_other_conditions>:
	editdisable = ["edit", "del"]		editdisable = ["edit", "del"]

Tenko: /* Unified Render-Fetch-Submit Route */

2024-07-17T06:12:46Z

Unified Render-Fetch-Submit Route

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 13:12, 17 กรกฎาคม 2567
บรรทัดที่ 340:		บรรทัดที่ 340:

	=== Unified Render-Fetch-Submit Route ===		=== Unified Render-Fetch-Submit Route ===
			<syntaxhighlight lang='python' line=1>
			@<blueprint>.route("<unified_route>", methods=["GET", "POST"])
			@login_required
			def <function_name>(*args):

			# CHECK FOR MODULE ACTIVATION
			check_modact_stat(modcode=pr_moddata["code"], mode="menu", response="abort")
			# PERFORM PERMISSION CHECK
			# ...
			# SCREEN OUT THE PAGE-LEVEL SEARCH REQUEST FIRST
			page_search_kw = request.args.get("page_search", None)
			if not(page_search_kw is None):
			goal_id = grab_id(...)
			if goal_id is None:
			return redirect(url_for("<unified_route>"))
			else:
			return redirect(url_for("<unified_route>", id=goal_id))
			# PREPARE THE PAGE'S FORMS AND TABLES.
			# (Depending on the type of the request, seach tables may or may not be created here.)
			# Pack those along with other 'doc_context'.
			# ...
			# ...
			# ...
			# DISTINGUISH THE REQUEST INTO ONE OF FETCH, SUBMIT, OR PAGE-GET
			# ...
			### Cases of fetch and submit usually comes with a form/table pointer.
			### This pointer should be encoded in the populate routes of the object/page.
			fetch_tbfm = request.args.get("tbfm") if request.args.get("tbfm") else None
			if <is_fetch>:
			identifiers = json.loads(request.form.get("identifier"))
			if fetch_tbfm == "_all": # This usually marks a MASS_POPULATE request.
			thisdoc, doccount, flash = grab_whole_doc(...)
			if thisdoc[head_form._id] is None: # No document found
			# Usually just fill all fields of the header with None
			thisdoc[head_form._id] = {col:None for col in head_form.seq}
			elif thisdoc[head_form._id] == "ncol": # Default for new document requested
			thisdoc[head_form._id] = dict(...)
			else: # Found a document
			thisdoc[head_form._id] = {col:getattr(thisdoc[head_form._id], col, None) for col in head_form.seq}
			# Modify as needed.
			# ...
			# It should be noted here that a database fetch returns CuneiModel instances.
			# These instances need to be repackaged into DICT for forms and LIST-OF-LIST for tables.
			# ...
			# temp_dicts = [a.m2d(int_key=["doc"]) for a in thisdoc[<tb>._id]]
			# thisdoc[<tb>._id] = [[a.get(col, None) for col in <tb>.cnames] for a in temp_dicts]
			# ...
			# Some forms/tables are filled with freshly calculated values. Pack those here.
			# ...
			# DETERMINE DOCUMENT VERIFICATION STATE and its implication the page-level actions.
			docverify = {"editting":getattr(thisdoc[head_form._id], "editting", "")}
			if doccount[1] <= 0 or <some_other_conditions>:
			editdisable = ["edit", "del"]
			else:
			editdisable = []
			return jsonify({"data":thisdoc, "doccount":doccount, "docverify":docverify,
			"flash":flash, "editdisable":editdisable})
			# Besides MASS_POPULATE (and properly suppresses), multi-component pages
			# almost exclusively request default data set for each table.
			# ** A table's default is returned in a LIST form.
			elif fetch_tbfm == "<table_marker>":
			if request.form.get("mode") == "ncol":
			return jsonify({"data":[...]})
			elif fetch_tbfm == "<another_table_marker>":
			if request.form.get("mode") == "ncol":
			return jsonify({"data":[...]})
			elif issubmit:
			# CHECK DOCUMENT'S LOCK STATE AND ALLOWED ACTIONS
			head_action_dic = check_doclock(...)
			if isinstance(head_action_dic, int):
			return jsonify(message='Input 403 message here'), head_action_dic
			allowed_action = process_allowed_action(head_action_dic, fetch_tbfm=="head")
			if allowed_action == 409:
			return jsonify(message='Input 409 message here'), 409
			# PERFORM FORM VALIDATION AND DATABASE COMMIT VIA 'GEN_DBCOMMIT_RESP'
			db_mod_code, new_entry, resp_dict = gen_dbcommit_resp(...)
			if resp_dict == 403:
			abort(403)
			# IF 'NEW_ENTRY' IS PRESENT, THE CHANGE WAS COMMITTED TO DATABASE.
			# Modify 'resp_dict' as needed. Only necessary modifications are illustrated below.
			if not(new_entry is None):
			# THE WHOLE DOCUMENT MIGHT OR MIGHT NOT BE RE-FETCHED.
			# _, fetched_doc = prefetch_all_docs(...)
			if fetch_tbfm == "head":
			if db_mod_code == 4: # This is the case of HEADER DELETION.
			resp_dict["repop"] = gen_form_skipper(head_form, {"id":-2})
			resp_dict["del_master"] = True
			else:
			if db_mod_code == 2: # This is the case of NEWLY ADDED HEADER.
			resp_dict["repop"] = gen_form_skipper(head_form, {"id":new_entry.get("id", None)})
			elif fetch_tbfm == "<table_marker>":
			# Data committed to sub-tables is repackaged for the client.
			if isinstance(db_mod_code, int) and db_mod_code < 4:
			resp_dict["entry"] = [new_entry.get(col, None) for col in bill_tb.cnames]
			# Most sub-table commits require re-calculations of sum values shown
			# on the client side as well.
			resp_dict["crossfill"] = {<table_sum_form>._id:dict(...)}
			# POST-COMMIT ROUTINE GOES HERE.
			# ...
			# ...
			return jsonify(resp_dict)
			# NOW ONLY PAGE-GET REQUEST REMAINS!
			# ...
			# This line works solo and along-side the page-level search from above.
			head_form.id.data = request.args.get("id", "")
			# ...
			title = lazy_gettext("...")
			return render_template("<template_file_name>", title=title, greeter=title,
			mass_populate=..., pin_args=[...], perm_to_show=cur_perm,
			doc_context=dict(btn_set=True, doccount=True, docverify=dict(...),
			**mainseq_args))
			</syntaxhighlight>

	=== Beacon Route ===		=== Beacon Route ===

Tenko: /* Document Import Route */

2024-07-17T02:48:46Z

Document Import Route

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:48, 17 กรกฎาคม 2567
บรรทัดที่ 539:		บรรทัดที่ 539:
	def <proxy_function>(job_token, imported_file, ...):		def <proxy_function>(job_token, imported_file, ...):
	try:		try:
	~~comp_spec = ["table", "supplier", Supplier, None] if this_bookcode in ("REC", "CAN", "PO") else \~~
	~~["table", "customer", Customer, None]~~
	has_err = docimport_to_db(imported_file, ..., job_token=job_token)		has_err = docimport_to_db(imported_file, ..., job_token=job_token)
	except Exception as e:		except Exception as e:

Tenko: /* Document Import Route */

2024-07-17T02:48:17Z

Document Import Route

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:48, 17 กรกฎาคม 2567
บรรทัดที่ 532:		บรรทัดที่ 532:

	=== Document Import Route ===		=== Document Import Route ===
			<syntaxhighlight lang='python' line=1>
			@<blueprint>.route("<import_route>", methods=["GET", "POST"])
			def <function_name>(*args):

			@copy_current_request_context
			def <proxy_function>(job_token, imported_file, ...):
			try:
			comp_spec = ["table", "supplier", Supplier, None] if this_bookcode in ("REC", "CAN", "PO") else \
			["table", "customer", Customer, None]
			has_err = docimport_to_db(imported_file, ..., job_token=job_token)
			except Exception as e:
			update_task_db(job_token, new_stat="killed", ...)
			remove(imported_file)

			# CHECK FOR MODULE ACTIVATION
			check_modact_stat(modcode=iv_moddata["code"], mode="menu", response="abort")
			# PERFORM PERMISSION CHECK
			# ...
			# RESUS_TOKEN IS PRESENT IN CASE OF A QUEUED OPERATION:
			# Either read the needed data from the form or read from stashed info.
			resus_token = request.args.get("resus_token", None)
			if resus_token is None:
			if not(import_form.validate_on_submit()):
			return jsonify({"err": import_form.errors})
			file_path = prep_imported_file(import_form.filename)
			job_token = gen_random_token(10)
			else:
			file_path = read_resus_import_file(resus_token, will_abort=True)
			job_token = resus_token
			# ATTEMPT TO INITIATE THE OPERATION
			new_task = init_task_db(job_token, 1, "request", suppress_request=False)
			if new_task is None:
			raise current_app.custom_exceptions.default_exceptions[410]()
			# IF THE OPERATION CAN START IMMEDIATELY (NOT QUEUED): Run the routine.
			# IF NOT: Stash necessary info (esp. job_token) for future retrieval.
			if new_task.status_str != "queue":
			job_resuscitation = False
			threading.Thread(target=<proxy_function>, name=job_token, args=[...]).start()
			if not(resus_token is None):
			return "YES"
			else:
			job_resuscitation = url_for("<import_route>", resus_token=job_token, ...)
			update_task_db(job_token, further_action=pjson.dumps({"file_path":file_path}))
			return jsonify({"redirect": url_for("main.import_progress", job_token=job_token,
			job_resuscitation=job_resuscitation, ...)})
			</syntaxhighlight>

	=== HTML Page Pattern ===		=== HTML Page Pattern ===

Tenko: /* Document Export Route */

2024-07-17T02:37:08Z

Document Export Route

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:37, 17 กรกฎาคม 2567
บรรทัดที่ 515:		บรรทัดที่ 515:

	=== Document Export Route ===		=== Document Export Route ===
			<syntaxhighlight lang='python' line=1>
			@<blueprint>.route("<export_route>", methods=["GET", "POST"])
			def <function_name>(*args):
			# CHECK FOR MODULE ACTIVATION
			check_modact_stat(modcode=pr_moddata["code"], mode="menu", response="abort")
			# FETCH THE DOCUMENTS & MODIFY THEM IF NEEDED
			_, thesedocs = prefetch_all_docs(...)
			thesedocs = [] if thesedocs is None else thesedocs
			# ...
			# EXPORT VIA 'GEN_SPREADSHEET'
			ss_path = gen_spreadsheet(...)
			if ss_path is None:
			abort(404)
			return render_template("serve_file.html", file_path=ss_path, dl_name="cunei_export.xlsx")
			</syntaxhighlight>

	=== Document Import Route ===		=== Document Import Route ===

Tenko: /* Unified Print & QR Code Route */

2024-07-17T02:29:06Z

Unified Print & QR Code Route

@@ บรรทัดที่ 451: / บรรทัดที่ 451: @@
 === Unified Print & QR Code Route ===
 <syntaxhighlight lang='python' line=1>
 </syntaxhighlight>

Tenko: /* Unified Print Route */

2024-07-17T02:26:41Z

Unified Print Route

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:26, 17 กรกฎาคม 2567
บรรทัดที่ 449:		บรรทัดที่ 449:
	</syntaxhighlight>		</syntaxhighlight>

	=== Unified Print Route ===		=== Unified Print & QR Code Route ===
	<syntaxhighlight lang='python' line=1>		<syntaxhighlight lang='python' line=1>