Design Document PHP Coding Details - Revision history

Rich: /* authajax.php */

2020-10-04T13:44:53Z

authajax.php

← Older revision		Revision as of 13:44, 4 October 2020
Line 28:		Line 28:

	For a better explanation of why this is done see		For a better explanation of why this is done see
	[https://bugs.board18.org/show_bug.cgi?id=197 <span style="color: Green">Comment 7 in Bug 197 in ~~BOAARD18~~ Bugzilla</span>].		[https://bugs.board18.org/show_bug.cgi?id=197 <span style="color: Green">Comment 7 in Bug 197 in BOARD18 Bugzilla</span>].

	==configMail.php==		==configMail.php==

Rich at 21:55, 3 October 2020

2020-10-03T21:55:59Z

← Older revision		Revision as of 21:55, 3 October 2020
Line 1:		Line 1:
	{{ReleaseNotice\|2.5}}{{Design Document Index}}		{{ReleaseNotice\|2.7}}{{Design Document Index}}
	This page has details of all of the PHP files that are included in other PHP code via the REQUIRE command.		This page has details of all of the PHP files that are included in other PHP code via the REQUIRE command.

Rich: /* authajax.php */ added explanatory note

2020-10-03T21:10:43Z

authajax.php: added explanatory note

← Older revision		Revision as of 21:10, 3 October 2020
Line 26:		Line 26:
	If either of these conditions has not been met then authajax.php		If either of these conditions has not been met then authajax.php
	will echo '''<!doctype html>''' and exit to the callback function.		will echo '''<!doctype html>''' and exit to the callback function.

			For a better explanation of why this is done see
			[https://bugs.board18.org/show_bug.cgi?id=197 <span style="color: Green">Comment 7 in Bug 197 in BOAARD18 Bugzilla</span>].

	==configMail.php==		==configMail.php==

Rich: /* auth.php */ complete rewrite and added authajax.php

2020-10-03T20:59:35Z

auth.php: complete rewrite and added authajax.php

← Older revision		Revision as of 20:59, 3 October 2020
Line 8:		Line 8:
	auth.php is included at the start of all password protected pages		auth.php is included at the start of all password protected pages
	and all password protected PHP programs called via AJAX.<br>		and all password protected PHP programs called via AJAX.<br>
	~~It starts~~ a php session and then ~~checks~~ to see that the player is		If the PHP program doing the include was called via AJAX then
	logged in and has been active sometime in the last ~~day~~.		authajax.php will be used instead of auth.php. <br>
			Otherwise auth.php will start a php session and then check to
			see that:
			* The player is logged on and
			* The player has been active sometime in the last 24 hours.
			If either of these conditions has not been met then control will
			be transferred to access-denied.html.

			==authajax.php==
			If auth.php has been included by a program that was called via AJAX
			then it will include authajax.php and leave the work to it.

			authajax.php will start a php session and then check to see that:
			* The player is logged on and
			* The player has been active sometime in the last 24 hours.
			If either of these conditions has not been met then authajax.php
			will echo '''<!doctype html>''' and exit to the callback function.

	==configMail.php==		==configMail.php==

Rich: /* makeTables.php */ remove

2020-08-28T21:41:23Z

makeTables.php: remove

← Older revision		Revision as of 21:41, 28 August 2020
Line 146:		Line 146:
	Output is the echo return status of "success" or "fail".		Output is the echo return status of "success" or "fail".

	~~==makeTables.php==~~
	~~makeTables.php is included via "require_once()" into~~
	~~various board18 PHP pages. It supplies a number of functions~~
	~~for creating the HTML to display various tables on the page.~~
	~~These tables must be displayed on initial creation of these~~
	~~pages. They cannot be updated later by these functions without~~
	~~reloading the entire page. This file contains these functions:~~

	~~showBoxes($conn) - create a table of all game boxes in database.~~
	~~showPlayers($conn) - create a table of all players in database.~~
	~~gamePlayers($gameid, $conn) - create a table of players in game.~~

	~~makeTables.php initializes these variables:~~

	~~$theLink - value returned by mysqli_connect function.~~
	~~$open - set to an empty string if the database connect succeeded.~~
	~~- set to 'fail' if the database connect failed.~~

	[[Category:Design]]		[[Category:Design]]

Rich: /* doLoad() */ added note about rmove

2018-07-17T12:59:52Z

doLoad(): added note about rmove

← Older revision		Revision as of 12:59, 17 July 2018
Line 77:		Line 77:
	Second, BOARD18 has to be able to run in any environment including a Windows environment. This precludes using the PHP exe() command to execute shell script commands to manipulate these directories.		Second, BOARD18 has to be able to run in any environment including a Windows environment. This precludes using the PHP exe() command to execute shell script commands to manipulate these directories.

	To deal with this situation I search the internet and found 3 PHP functions that recursively process directories. These functions are each placed in a file of the same name as the function. The functions are rcopy($src, $dest), rmove($src, $dest) and rm_r($dir). They are documented ~~on their own pages~~ in ~~these design notes~~.		To deal with this situation I search the internet and found 3 PHP functions that recursively process directories. These functions are each placed in a file of the same name as the function. The functions are rcopy($src, $dest), rmove($src, $dest) and rm_r($dir). They are documented below.<br>
			<span style="color: Fuchsia">The final revision of this code turned out not to need the rmove() function. But I retained it in case this
			changed in the future.</span>

	The three directories that can be manipulated by the doLoad() function are:<br>		The three directories that can be manipulated by the doLoad() function are:<br>

Rich: /* doLoad() */ fixed link

2018-07-16T18:36:36Z

doLoad(): fixed link

← Older revision		Revision as of 18:36, 16 July 2018
Line 74:		Line 74:

	The following paragraphs document some concerns with the code in the doload() function in the loadGameBox.php file. The code in question concerns itself with manipulating the directories that contain all of the image files used by a game box. This code is complicated by two considerations. First, the PHP rename() function has a known bug that causes it to fail in certain circumstances. This bug is documented in various places at this time [2018], including		The following paragraphs document some concerns with the code in the doload() function in the loadGameBox.php file. The code in question concerns itself with manipulating the directories that contain all of the image files used by a game box. This code is complicated by two considerations. First, the PHP rename() function has a known bug that causes it to fail in certain circumstances. This bug is documented in various places at this time [2018], including
	https://bugs.launchpad.net/ubuntu/+source/php5/+bug/723330. Second, BOARD18 has to be able to run in any environment including a Windows environment. This precludes using the PHP exe() command to execute shell script commands to manipulate these directories.		[https://bugs.launchpad.net/ubuntu/+source/php5/+bug/723330 this launchpad bug report].
			Second, BOARD18 has to be able to run in any environment including a Windows environment. This precludes using the PHP exe() command to execute shell script commands to manipulate these directories.

	To deal with this situation I search the internet and found 3 PHP functions that recursively process directories. These functions are each placed in a file of the same name as the function. The functions are rcopy($src, $dest), rmove($src, $dest) and rm_r($dir). They are documented on their own pages in these design notes.		To deal with this situation I search the internet and found 3 PHP functions that recursively process directories. These functions are each placed in a file of the same name as the function. The functions are rcopy($src, $dest), rmove($src, $dest) and rm_r($dir). They are documented on their own pages in these design notes.

Rich: /* doLoad() */ Documented design considerations for file manipulation.

2018-07-16T16:49:23Z

doLoad(): Documented design considerations for file manipulation.

← Older revision		Revision as of 16:49, 16 July 2018
Line 72:		Line 72:
	]		]
	}		}

			The following paragraphs document some concerns with the code in the doload() function in the loadGameBox.php file. The code in question concerns itself with manipulating the directories that contain all of the image files used by a game box. This code is complicated by two considerations. First, the PHP rename() function has a known bug that causes it to fail in certain circumstances. This bug is documented in various places at this time [2018], including
			https://bugs.launchpad.net/ubuntu/+source/php5/+bug/723330. Second, BOARD18 has to be able to run in any environment including a Windows environment. This precludes using the PHP exe() command to execute shell script commands to manipulate these directories.

			To deal with this situation I search the internet and found 3 PHP functions that recursively process directories. These functions are each placed in a file of the same name as the function. The functions are rcopy($src, $dest), rmove($src, $dest) and rm_r($dir). They are documented on their own pages in these design notes.

			The three directories that can be manipulated by the doLoad() function are:<br>
			$images - The image directory contained in the zip file.<br>
			$imagedest - The game box directory that will be updated or created in the images directory for this instance of BOARD18.<br>
			$imageback - A backout directory that will contain the current [old] copy of $imagedest if one exists.

	===loadBox()===		===loadBox()===

Rich: Rich moved page Design Document Server Side Coding Details to Design Document PHP Coding Details: Repurposed page

2017-08-01T13:37:45Z

Rich moved page Design Document Server Side Coding Details to Design Document PHP Coding Details: Repurposed page

← Older revision	Revision as of 13:37, 1 August 2017
(No difference)

Rich: removed ajax stuff

2017-07-31T23:11:14Z

removed ajax stuff

Show changes