lifecycle added in the documentation
[brisk.git] / doc / ARCHITECTURE.txt
1 Sparse documentation about Brisk.
2
3 Many things aren't documented at all, but I start with authentication workflow.
4
5
6
7 AUTHENTICATION WORKFLOW
8
9 --- CLI ------------
10 index.php:
11   onsubmit="return j_login_manager(this);" ->
12             sync xhr(index_wr.php?mesg=getchallenge&cli_name=<username>)
13
14 --- SRV ------------
15   GET index_wr.php send the string: "1|<tokens>"
16
17 --- CLI ------------
18   POST index.php with passid_private field equal to calcMD5(tokens[1]+calcMD5(form.elements['passid'].value))
19
20
21
22 ===== Game Lifecycle =====
23
24 -> bin5/index_wr.php + argz[0] == 'logout'
25    - bri->table_wakeup($user)
26      - set users subst to "shutdowner" and "shutdowned"
27      - save this: "gst.st_loc++; the_end=true; window.onbeforeunload = null; \
28                    window.onunload = null; document.location.assign("../index.php");" 
29        in user->comm var for client xhr
30      - set $bri->the_end = TRUE