Design Document PHP AJAX Coding Details Part 3 - Revision history

Rich at 21:38, 28 August 2020

2020-08-28T21:38:30Z

← Older revision		Revision as of 21:38, 28 August 2020
Line 1:		Line 1:
	{{ReleaseNotice\|2.5}}{{Design Document Index}}		{{ReleaseNotice\|2.6}}{{Design Document Index}}
	This page documents part 3 of the PHP AJAX called programs.		This page documents part 3 of the PHP AJAX called programs.

Rich: /* playerShow.php */ added playerSort.php

2020-08-28T21:38:06Z

playerShow.php: added playerSort.php

← Older revision		Revision as of 21:38, 28 August 2020
Line 59:		Line 59:
	]		]
	}		}
	</pre>		</pre>

			==playerSort.php==
			playerSort.php is the server side code for the AJAX playerSort call.

			It returns a sorted array of records from the players table.

			Input is: sortkey.

			Output is the following stringified JSON data structure.
			{
			"stat":"success\|\|fail\|\|empty",
			"players":
			[
			{
			"login":"aaaaaa",
			"firstname":"bbbbbb",
			"lastname":"cccccc",
			},
			. . . . more players . . . . .
			]
			}

	==playerUpdate.php==		==playerUpdate.php==

Rich: /* statSwap.php */ add link

2020-05-16T19:22:39Z

statSwap.php: add link

← Older revision		Revision as of 19:22, 16 May 2020
Line 128:		Line 128:

	The SESS_UPDATE_COUNTER session variable is used		The SESS_UPDATE_COUNTER session variable is used
	by statSwap.php to support optimistic database		by statSwap.php to support [[optimistic database locking]]. <br>
	locking. <br>This should stop concurrent updates from		This should stop concurrent updates from
	messing up the database. [And do this without		messing up the database. (And do this without
	incurring high overhead.]		incurring high overhead.)

	==tokenCheck.php==		==tokenCheck.php==

Rich: /* tokenRemove.php */ initial contents

2017-08-01T13:21:43Z

tokenRemove.php: initial contents

← Older revision		Revision as of 13:21, 1 August 2017
Line 158:		Line 158:

	==tokenRemove.php==		==tokenRemove.php==
	~~To be provided~~.		tokenRemove.php is the server side code for the AJAX tokenRemove call.

			It deletes from the auth_tokens table any rows that exist for the logged in player.

			This function requires no input parameters.

			Output is the echo return status: "success" or "fail"

	==updateGame.php==		==updateGame.php==

Rich: /* tokenInsert.php */ initial contents

2017-08-01T13:18:40Z

tokenInsert.php: initial contents

← Older revision		Revision as of 13:18, 1 August 2017
Line 149:		Line 149:

	==tokenInsert.php==		==tokenInsert.php==
	~~To be provided~~.		tokenInsert.php is the server side code for the AJAX tokenInsert call.

			It inserts a new row in the auth_tokens table.

			Input is: selector and validator.

			Output is the echo return status: "success" or "fail"

	==tokenRemove.php==		==tokenRemove.php==

Rich: /* tokenCheck.php */ initial contents

2017-08-01T13:12:59Z

tokenCheck.php: initial contents

← Older revision		Revision as of 13:12, 1 August 2017
Line 134:		Line 134:

	==tokenCheck.php==		==tokenCheck.php==
	~~To be provided~~.		tokenCheck.php is the server side code for the AJAX tokenCheck call.

			It deletes from the auth_tokens table any expired rows with
			the given selector. It also checks each such row for a matching
			validator. If it finds one it will return "tokenfound" and it
			will also delete the matching row from the table.

			Input is: selector and validator.

			Output is the echo return status: "tokenfound", "notoken" or "fail"

			Note that this script does not check for a signed on user.
			This is because it is called before any signon has taken place.

	==tokenInsert.php==		==tokenInsert.php==

Rich: /* validateUser.php */

2017-07-31T23:00:07Z

validateUser.php

← Older revision		Revision as of 23:00, 31 July 2017
Line 198:		Line 198:
	"level"		"level"
	"changeit"		"changeit"

			[[Category:Design]]

Rich: initial contents

2017-07-31T22:53:42Z

initial contents

New page

{{ReleaseNotice|2.5}}{{Design Document Index}}
This page documents part 3 of the PHP AJAX called programs.

An oveview discussion of all PHP programs is available
[[Design_Document_Server_Side_Overview|here]].

==playerGet.php==
playerGet.php is the server side code for the AJAX playerGet call.

It returns most fields for a player in the players table.
It also returns a list of the games the player is playing.

Input is: login.

Output is the following stringified JSON data structure.
<pre>
{
"stat":"success||"fail"||"nogames",
"playerid":"nnnnnn",
"login":"aaaaaa",
"firstname":"bbbbbb",
"lastname":"cccccc",
"email":"eeeeee",
"level":"llllll",
"games":
[
{
"gname":"gggggg",
"status":"ssssss"
},
. . . . more games . . . . .
]
}
</pre>

==playerShow.php==
playerShow.php is the server side code for the AJAX playerShow call.

It returns an array of records from the players table.

Input is: blocksz and startrow.

Output is the following stringified JSON data structure.
<pre>
{
"stat":"success||"fail",
"players":
[
{
"login":"aaaaaa",
"firstname":"bbbbbb",
"lastname":"cccccc",
"email":"eeeeee",
"level":"llllll",
"gcount":"nnnnnn"
"acount":"nnnnnn"
},
. . . . more players . . . . .
]
}
</pre>

==playerUpdate.php==
playerUpdate.php is the server side code for the
AJAX playerUpdate call.

It updates a row in the players table.
Unlike updateUser, playerUpdate keys on player_id.

Input consists the following parameters:

player
login
email
fname
lname
level

Output is the echo return status:
"success", "fail", "login", "bademail" or "email xxxx".

==snapShot.php==
This is the server side code for the AJAX snapShot call.

It loads game status updates into the database.

Input is the gameID and the operating or stock round name.

Output is one of these the echo return statuses:
"success"
"failure"
"notplaying"
"collision"

==snapShow.php==
This is the server side code for the AJAX snapShow call.

It returns an array of the game_snap records for this game.

Input is: gameid, blocksz and startrow.

Output is the following stringified JSON data structure.
{
"stat":"success||none||fail",
"snaps":
[
{
"cp_id":"nnnn",
"round":"gggg",
"snaper":"bbbb",
"updater":"vvvv",
"cp_date":"mm/dd/yyyy"
},
. . . . more snaps . . . . .
]
}

==statSwap.php==
statSwap.php is the server side code for the
AJAX statSwap call.

It toggles the game status field in the database.
This status field can contain either "Active" or "Completed".

Input is the gameID.

Output will be "success", "failure" "notplaying" or "collision".

The SESS_UPDATE_COUNTER session variable is used
by statSwap.php to support optimistic database
locking. <br>This should stop concurrent updates from
messing up the database. [And do this without
incurring high overhead.]

==tokenCheck.php==
To be provided.

==tokenInsert.php==
To be provided.

==tokenRemove.php==
To be provided.

==updateGame.php==
updateGame.php is the server side code for the
AJAX updateGame call.

It loads game updates into the database.

Input is the JSON game session data and the gameID.

Output will be "success", "failure" "notplaying" or "collision".

The SESS_UPDATE_COUNTER session variable is used
by updateGame.php to support optimistic database
locking. <br>This should stop concurrent updates from
messing up the database. [And do this without
incurring high overhead.]

==updateUser.php==
updateUser.php is the server side code for the
AJAX updateUser call.

It updates a row in the players table.

Input consists the following parameters:
pname
email
fname
lname
passwrd (optional)

Output is an echo return status of:
"success",
"fail",
"bademail" or
"email ''login''"

==validateUser.php==
validateUser.php is the server side code for the
AJAX validateUser call.

It checks the current players login and password and,
if they are valid, it logs the current player in to BOARD18.

Input consists the following parameters:
login
password

Output will be an array containing at a minimum the named
value "stat" which will be set to "success", "fail" or an
edit failure code. If "stat" = "success" then the array
will also contain values for the following key names:
"id"
"login"
"firstname"
"lastname"
"level"
"changeit"