Newer
Older
backup-commander / file-layout.txt

File Layout
===========

	2024-12-04
	
	This is how the files are laid out. Important notes are the split between web and cli, db and rpc.
	
	Service files, or CLI
	---------------------

		Service Only
			These files should not contain RPC. This is to remove the likelyhood of rpc blocking. Since the main app
			is not able to respond to its own RPC
				
				./svc/main.php
				./svc/db-reads.php
				./svc/db-writes.php
	
		Service Child Process Only
			These files can have both database and RPC. This is because the child has been forked from main and is a legitimate
			separate (child) process. It can invoke RPC to main comfortably.
			
				./svc/backup.php
	
	Shared Files
	------------
	
		These files contain no RPC and no DB. This allows them to be included in any process. They contain code of the most 
		general nature.

			./shd/common.php	(some old code needs to be removed)
			./lib/time.php
			./inc/paths.php	(this will be upgraded and likely split into path-files specific to each section)
	
	Web-server Files
	----------------
	
		These files specialise in handling the GUI, browser interaction using JS and HTML and session life-cycle.
		No DB code allowed here. All calls but go via RPC to main.php.
			
			./inc/bu_list_content.php
			./inc/secure.php
			./inc/pagemap.php	
			./index.php
			./phpinfo.php	
			./post_handler.php
			./inc/new-file-bu.php
			./inc/login.php
			./inc/edit-sh-bu.php
	
	Libraries
		
		(included as required)
		./lib/sysVcom.php