Fork: 0
johnpearcey / backup-commander
Transfer to URL with SHA Find file
Newer
Older
backup-commander / file-layout.txt
@John P on MM John P on MM on 5 Dec 1 KB Completed and tested. However, still need to convert the main.php into a Linux service
Raw Blame History 
  1.  
  2. File Layout
  3. ===========
  4.  
  5. 	2024-12-04
  6. 	
  7. 	This is how the files are laid out. Important notes are the split between web and cli, db and rpc.
  8. 	
  9. 	Service files, or CLI
  10. 	---------------------
  11.  
  12. 		Service Only
  13. 			These files should not contain RPC. This is to remove the likelyhood of rpc blocking. Since the main app
  14. 			is not able to respond to its own RPC.
  15. 			Files may contain DB code.
  16. 				
  17. 				./svc/main.php
  18. 				./svc/db-reads.php
  19. 				./svc/db-writes.php
  20. 				./svc/file-line-reader.php		- might contain some generally useful file access, may want to extract
  21.  
  22. 	
  23. 		Service Child Process Only
  24. 			These files can have both database and RPC. This is because the child has been forked from main and is a legitimate
  25. 			separate (child) process. It can invoke RPC to main comfortably.
  26. 			
  27. 				./svc/backup.php
  28. 	
  29. 	Shared Files
  30. 	------------
  31. 	
  32. 		These files contain no RPC and no DB. This allows them to be included in any process. They contain code of the most 
  33. 		general nature.
  34.  
  35. 			./shd/common.php	(some old code needs to be removed)
  36. 			./shd/backup-funcs.php
  37. 			./inc/paths.php	(auto-generated file: this will be upgraded and likely split into path-files specific to each section)
  38.  
  39. 	
  40. 	Web-server Files
  41. 	----------------
  42. 	
  43. 		These files specialise in handling the GUI, browser interaction using JS and HTML and session life-cycle.
  44. 		No DB code allowed here. All calls but go via RPC to main.php.
  45. 			
  46. 			./phpinfo.php	
  47. 			./post_handler.php
  48.  
  49. 			./inc/bu_list_content.php
  50. 			./inc/secure.php
  51. 			./inc/pagemap.php	
  52. 			./index.php
  53. 			./inc/new-file-bu.php
  54. 			./inc/login.php
  55. 			./inc/edit-sh-bu.php
  56. 	
  57. 	Libraries
  58. 		
  59. 		(included as required)
  60. 		
  61. 			./lib/sysVcom.php
  62. 			./lib/time.php
  63.  
  64. 		
  65. 	
  66.  
  67. 	
  68.