1 Euphorik - Protocole v3
2 -----------------------
5 Ce document a pour but de décrire la communication client-serveur du site euphorik.
6 Les messages échangés sont basés sur le format JSON.
7 Ce document remplace 'protocole2.txt'.
12 * Permet de créer un compte, un cookie est donné en retour. Ce cookie doit être stocké par le client pour pouvoir s'authentifier par la suite.
15 * L'authentification (login) se fait soit par un couple <login, mot de passe> soit à l'aide d'un cookie.
16 * Permet de récupérer les données d'un profile
19 * Le client envoie une demande au serveur avec l'id du dernier message (via XMLHttpRequest ou un function de JQuery)
20 * Le serveur maintient la connexion bloquée si le client est à jour.
21 * Dès qu'un nouveau message arrive, le serveur débloque la connexion et envoie le ou les messages manquants.
27 Les messages client vers serveur sont envoyés par HTTP-POST.
29 A toutes les requêtes le serveur peut répondre une erreur :
33 "error_message" : "blabla"
36 Message ok générique :
42 Entete des messages clients :
43 Si la version du protocole n'est pas similaire du coté serveur la requête est refusée
51 === Enregistrement et authentification ===
52 Permet de créer un nouvel utilisateur.
53 "login" et "password" peuvent ne pas être fournis avec un message de type "register", dans ce cas l'utilisateur ne pourra s'authentifier qu'a l'aide de son cookie.
54 Le mot de passe est hashé en md5.
58 "header" : {action : "authentification", version : 3},
60 "password" : "IJKJDHHSAD9081238"
64 "header" : {action : "authentification", version : 3}
65 "cookie" : "LKJDLAKSJBFLKASN"
69 "header" : {action : "authentification", version : 3},
71 "password" : "IJKJDHHSAD9081238"
76 "reply" : "register" | "authentification",
77 "status" : "auth_not_registered",
78 "cookie" : "LKJDLAKSJBFLKASN",
80 "css" : "css/1/euphorik.css",
85 "reply" : "register" | "authentification",
86 "status" : "auth_registered",
87 "cookie" : "LKJDLAKSJBFLKASN",
91 "email" : "paul@pierre.com",
92 "css" : "css/3/euphorik.css",
93 "nick_format" : "nick" | "login" | "nick_login",
94 "view_times" : true | false,
95 "view_tooltips" : true | false,
96 "conversations" : [{"root" : 3, "minimized" : true},
97 "ek_master" : true | false,
98 "ostentatious_master" : "invisible" | "light" | "heavy"
105 "header" : {action : "logout", version : 3},
106 "cookie" : "LKJDLAKSJBFLKASN"
113 "header" : {action : "set_profile", version : 3},
114 "cookie" : "LKJDLAKSJBFLKASN",
116 "password" : "IJKJDHHSAD9081238",
118 "email" : "paul@pierre.com",
119 "css" : "css/3/euphorik.css",
120 "nick_format" : "nick" | "login" | "nick_login",
121 "view_times" : true | false,
122 "view_tooltips" : true | false,
123 "conversations" : [{"root" : 3, "minimized" : true},
124 "ostentatious_master" : "invisible" | "light" | "heavy"
133 === Wait event (page = chat) ===
134 Si "last_message_id" est absent alors le client ne possède pas de message.
135 Si "main_page" est absent alors est vaut 1.
136 "cookie" n'est pas obligatoire.
142 "date" : "Hier 17:26:54",
143 "system" : true | false,
144 "owner" : true | false,
145 "answered" : true | false,
146 "is_a_reply" : true | false,
152 { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" }
154 "ek_master" : true | false,
155 "ostentatious_master" : "invisible" | "light" | "heavy"
160 "header" : {action : "wait_event", version : 3},
162 "cookie" : "LKJDLAKSJBFLKASN",
163 "message_count" : 10,
164 "last_message_id" : 163,
171 "last_message_id" : 4 (pas obligatoire)
177 La première conversation est la principale (main).
178 L'ordre des conversation est le même que celui des données de l'utilisateur.
179 Le format de la date n'est pas formel.
180 first correpond au premier message de la conversation, vaut 'null' pour la conversation principale ainsi que pour les conversations vides.
182 "reply" : "new_message",
185 "last_page" : true | false,
186 "first" : <message> | null,
187 "messages" : [ <message>, .. ]
193 "reply" : "message_updated",
195 "content" : "Salut +++ poulpe"
199 "reply" : "new_troll",
202 "content" : "Linux sera desktop ready en 2008 ?"
208 === Wait event (page = admin) ===
211 "header" : {action : "wait_event", version : 3},
218 "reply" : "troll_modified",
225 "reply" : "troll_added",
231 "author" : "<Pseudo>"
239 "reply" : "troll_deleted",
243 indique de mettre à jour la liste d'ips
246 "reply" : "banned_ips_refresh"
250 === Envoie d'un troll ===
253 "header" : {action : "put_troll", version : 3},
254 "cookie" : "LKJDLAKSJBFLKASN",
255 "content" : "Un bon troll velu !"
264 === Modification d'un troll ===
267 "header" : {action : "mod_troll", version : 3},
268 "cookie" : "LKJDLAKSJBFLKASN",
270 "content" : "Un bon troll velu 2 !"
279 === Suppression d'un troll ===
282 "header" : {action : "del_troll", version : 3},
283 "cookie" : "LKJDLAKSJBFLKASN",
293 === Envoie message ===
294 Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
295 "answer_to" n'est pas obligatoire.
299 "header" : {action : "put_message", version : 3},
300 "cookie" : "LKJDLAKSJBFLKASN",
302 "content" : "Bonjour",
303 "answer_to" : [ 345, 532, ... ]
315 "header" : {action : "slap", version : 3},
316 "cookie" : "LKJDLAKSJBFLKASN",
318 "reason" : "blablabla"
330 "header" : {action : "ban", version : 3},
331 "cookie" : "LKJDLAKSJBFLKASN",
332 "duration" : 15, // en minute
334 "reason" : "blablabla"
343 === Liste des ip bannis ===
346 "header" : {action : "list_banned_ips", version : 3},
347 "cookie" : "LKJDLAKSJBFLKASN"
352 "reply" : "list_banned_ips",
356 remaining_time : "1h23"
368 === Débannissement ===
371 "header" : {action : "unban", version : 3},
372 "cookie" : "LKJDLAKSJBFLKASN"
382 === Ajout d'une correction d'un messages ===
383 Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.
384 Le message est appondu avec un " +++ " devant, par exemple :
385 > Gnome c'est mieux que KDE +++ Euh non ok, c'est faux
389 "header" : {action : "correction", version : 3},
390 "cookie" : "LKJDLAKSJBFLKASN",
391 "content" : "Euh non ok, c'est faux"
396 "reply" : "correction",
397 "status" : "ok" | "error",
398 "message_error" : "blabla"