Is my c0de up to date?
A display next to your sheets that tells you whether a new version of c0de or c0de net is out. The program asks c0de.at for the latest releases and compares them with the versions installed on your server.
Functions: HTTP_GET and FROM_JSON of c0de/strings, and the constants C0DE_VERSION and C0DE_NET_VERSION
What you need
The mod c0de net in your game, a trigger block with a button, a display wall of 2 × 1 display blocks and one uninitialized variable item.
The idea
Every program knows the versions it runs on: the constant C0DE_VERSION holds the version of c0de as text, like "0.5.0", and c0de net adds C0DE_NET_VERSION, like "0.3.0". They need no INCLUDE.
The latest released versions are on the web. c0de.at reads them from the releases on GitHub and answers https://c0de.at/api/version with a small JSON object:
{ "c0de": "0.5.0", "c0de_net": "0.3.0" }So the program needs one GET, one FROM_JSON and two comparisons. The request comes from the computer of the player who presses the button, and every player can switch requests off for their own computer. The installed versions, though, are those of the server: the constants tell what the sheet runs on.
The program
PROGRAM versioncheck
NOOP
INCLUDE c0de/strings
INCLUDE c0de_net/http
NOOP
STRUCT releases
BEGIN
c0de STRING
net STRING TAG(json: "c0de_net")
END STRUCT
NOOP
FUNCTION compare
PARAMETER name STRING
PARAMETER installed STRING
PARAMETER latest STRING
RESULT current BOOLEAN
BEGIN
ASSIGN current installed = latest ;
IF current ;
BEGIN
CALL COLOR
PARAMETER foreground COLOR_GREEN ;
CALL PRINT
PARAMETER value name ⊕ " " ⊕ installed ⊕ ": up to date" ;
END
ELSE
BEGIN
CALL COLOR
PARAMETER foreground COLOR_RED ;
CALL PRINT
PARAMETER value name ⊕ " " ⊕ installed ⊕ ": " ⊕ latest ⊕ " is out" ;
END IF
CALL COLOR
PARAMETER foreground COLOR_WHITE ;
END FUNCTION
NOOP
FUNCTION check
RESULT current BOOLEAN
BEGIN
VARIABLE api STRUCT c0de_net/http/HTTP_CONNECTION
VARIABLE answer STRING
VARIABLE latest STRUCT releases
VARIABLE netCurrent BOOLEAN
ASSIGN api.use_ssl TRUE ;
ASSIGN api.server "c0de.at" ;
ASSIGN api.timeout 10 ;
CALL c0de_net/http/HTTP_GET
PARAMETER connection api ;
PARAMETER endpoint "/api/version" ;
RESULT result answer
CALL c0de/strings/FROM_JSON
PARAMETER source answer ;
PARAMETER destination latest ;
CALL CLS
CALL compare
PARAMETER name "c0de" ;
PARAMETER installed C0DE_VERSION ;
PARAMETER latest latest.c0de ;
RESULT current current
CALL compare
PARAMETER name "c0de net" ;
PARAMETER installed C0DE_NET_VERSION ;
PARAMETER latest latest.net ;
RESULT current netCurrent
ASSIGN current current AND netCurrent ;
END FUNCTIONBuilding and running it
- Build the display wall and bind it to
versioncheck/check. - Set the trigger block to
versioncheck/check, put an uninitialized variable item into it, and press the button.
When everything is up to date, the wall shows two green lines, and the result current is TRUE:
c0de 0.5.0: up to date
c0de net 0.3.0: up to date
If a new version is out, its line is red, like c0de 0.3.1: 0.4.0 is out, and current is FALSE.
How it works
- The struct is the answer.
releaseshas one element per key of the answer.c0deis a valid name, because it starts with a letter.c0de_netwould be too, but the element is callednet, andTAG(json: "c0de_net")maps it to the key. comparedoes the work twice. It gets a name, the installed and the latest version, prints one line in green or red, and returns whether the two are equal.=compares two texts character by character.- Colors. COLOR sets the color of the text that follows;
comparesets it back to white at the end, so the next line starts clean. - Both must be current.
currentfrom the first CALL andnetCurrentfrom the second are joined with AND. - Asking is cheap. c0de.at asks GitHub at most once an hour and keeps the answer in between, so you may press the button as often as you like. If GitHub can't be reached and the versions are unknown, the answer is the status 503, and the process crashes with HTTP_STATUS.
Try it yourself
- A version that isn't equal to the latest one isn't always older: a test version of c0de may be newer than the latest release. Write a function that tells if a version is older than another.
Solution
PROGRAM versionorder
NOOP
INCLUDE c0de/strings
NOOP
FUNCTION number
PARAMETER version STRING
RESULT result FLOAT
BEGIN
VARIABLE rest STRING
VARIABLE piece STRING
VARIABLE dot INTEGER
VARIABLE part FLOAT
ASSIGN rest version ⊕ "." ;
FOR i INTEGER 1 ; 3 ;
BEGIN
CALL c0de/strings/INSTR
PARAMETER text rest ;
PARAMETER search "." ;
RESULT result dot
CALL c0de/strings/MID
PARAMETER text rest ;
PARAMETER start 0 ;
PARAMETER length dot ;
RESULT result piece
CALL c0de/strings/VAL
PARAMETER text piece ;
RESULT value part
ASSIGN result result * 1000 + part ;
CALL c0de/strings/MID
PARAMETER text rest ;
PARAMETER start dot + 1 ;
RESULT result rest
END FOR
END FUNCTION
NOOP
FUNCTION outdated
PARAMETER installed STRING
PARAMETER latest STRING
RESULT result BOOLEAN
BEGIN
VARIABLE mine FLOAT
VARIABLE theirs FLOAT
CALL number
PARAMETER version installed ;
RESULT result mine
CALL number
PARAMETER version latest ;
RESULT result theirs
ASSIGN result mine < theirs ;
END FUNCTIONnumber takes the version apart at its dots with INSTR and MID, turns each part into a number with VAL, and joins them into one number: 0.4.0 becomes 4000, 0.10.0 becomes 10000. Comparing the texts would be wrong here: "0.10.0" comes before "0.9.0" in the alphabet, but 0.10.0 is the newer version. To use it in versioncheck, copy both functions above compare and call outdated instead of comparing with =.
- Make the display show
can't checkinstead of crashing when the request fails.
Solution
Add a variable problem of type ERROR to check and put it on the CALL line: CALL c0de_net/http/HTTP_GET problem. Right after it, check IF problem.code ≠ 0 ;, print can't check: with problem.message in its block, and end the function with RETURN. A player without c0de net then sees can't check: … instead of a crash; see When the network fails.
Read more
- HTTP_GET, FROM_JSON and TAG
- Getting started with
C0DE_NET_VERSION, and the constants of every program - COLOR
- The releases of c0de and c0de net