-Euphorik - Protocole v3
+Euphorik - Protocole v3
-----------------------
-A. Introduction
----------------
-Ce document a pour but de décrire la communication client-serveur du site euphorik.\r
-Les messages échangés sont basés sur le format JSON.
+== Introduction ==
+Ce document a pour but de décrire la communication client-serveur du site euphorik.
+Les messages échangés sont basés sur le format JSON.
Ce document remplace 'protocole2.txt'.
-\r
-B. Principes
-------------
-Enregistrement:\r
- * 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.
-Authentification:\r
- * L'authentification (login) se fait soit par un couple <login, mot de passe> soit à l'aide d'un cookie.\r
- * Permet de récupérer les données d'un profile
+== Principes ==
+Enregistrement:
+ * 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.
+
+Authentification:
+ * L'authentification (login) se fait soit par un couple <login, mot de passe> soit à l'aide d'un cookie.
+ * Permet de récupérer les données d'un profile
Rafraichissement:
* Le client envoie une demande au serveur avec l'id du dernier message (via XMLHttpRequest ou un function de JQuery)
- * Le serveur maintient la connexion bloquée si le client est à jour.
- * Dès qu'un nouveau message arrive, le serveur débloque la connexion et envoie le ou les messages manquants.
+ * Le serveur maintient la connexion bloquée si le client est à jour.
+ * Dès qu'un nouveau message arrive, le serveur débloque la connexion et envoie le ou les messages manquants.
-C. Protocole
-------------
+== Protocole ==
c : client
s : server
-Les messages client vers serveur sont envoyés par HTTP-POST.
+Les messages client vers serveur sont envoyés par HTTP-POST.
+
+A toutes les requêtes le serveur peut répondre une erreur :
+<error>
+ {
+ "reply" : "error",
+ "error_message" : "blabla"
+ }
+
+Message ok générique :
+<ok>
+ {
+ "reply" : "ok"
+ }\r
+\r
+Entete des messages clients :\r
+Si la version du protocole n'est pas similaire du coté serveur la requête est refusée\r
+<client_header>\r
+ {\r
+ "action" : <action>,\r
+ "version" : 3\r
+ }
-C.1. Login
-----------
-Le mot de passe est hashé en md5.\r
+=== Enregistrement et authentification ===
+Permet de créer un nouvel utilisateur.
+"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.
+Le mot de passe est hashé en md5.
-c -> s\r
- { \r
- "action" : "authentification",\r
- "login" : "Paul",\r
- "password" : "IJKJDHHSAD9081238"\r
+c -> s
+ {
+ "header" : {action : "authentification", version : 3},
+ "login" : "paul",
+ "password" : "IJKJDHHSAD9081238"
}
-ou\r
- {\r
- "action" : "authentification",\r
- "cookie" : "LKJDLAKSJBFLKASN"\r
+ou
+ {
+ "header" : {action : "authentification", version : 3}
+ "cookie" : "LKJDLAKSJBFLKASN"
}
-ou\r
+ou
{\r
- "action" : "register",\r
- "login" : "Paul",\r
- "password" : "IJKJDHHSAD9081238"\r
+ "header" : {action : "authentification", version : 3},
+ "login" : "paul",
+ "password" : "IJKJDHHSAD9081238"
}
-s -> c\r
- {\r
- "reply" : "login",\r
- "status" : "registration_ok" | "authentification_ok" | "error",\r
- "cookie" : "LKJDLAKSJBFLKASN",\r
- "id" : 193,\r
- "pseudo" : "Paul",\r
- "login" : "paul49",\r
- "email" : "paul@pierre.com",\r
- "css" : "css/3/euphorik.css",\r
- "main_page" : 1,\r
- "conversations" : [\r
- {\r
- "root" : 123,\r
- "page" : 1\r
- }\r
- ],\r
- "error_message" : "blabla"\r
+s -> c
+ {
+ "reply" : "register" | "authentification",
+ "status" : "auth_not_registered",
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "id" : 193,
+ "css" : "css/1/euphorik.css",
+ "main_page" : 1
}
- \r
+ou
+ {
+ "reply" : "register" | "authentification",
+ "status" : "auth_registered",
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "id" : 193,
+ "nick" : "Paul",
+ "login" : "paul49",
+ "email" : "paul@pierre.com",
+ "css" : "css/3/euphorik.css",
+ "nick_format" : "nick" | "login" | "nick_login",
+ "view_times" : true | false,
+ "view_tooltips" : true | false,
+ // "main_page" : 1,
+ "conversations" : [3, 8],
+ "ek_master" : true | false
+ }
+
-C.2. Logout
------------
-c -> s\r
+=== Logout ===
+c -> s
{\r
- "action" : "logout",\r
- "cookie" : "LKJDLAKSJBFLKASN"\r
+ "header" : {action : "logout", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN"
}
- \r
-C.3. Profile
-------------
-Modification du profile, seul "cookie" est obligatoire.
-
-c -> s\r
- {\r
- "action" : "set_profile",\r
- "cookie" : "LKJDLAKSJBFLKASN",\r
- "login" : "paul49",\r
- "password" : "IJKJDHHSAD9081238",\r
- "pseudo" : "Paul",\r
- "email" : "paul@pierre.com",\r
- "css" : "css/3/euphorik.css",\r
- "mainPage" : 1,\r
- "conversations" : [\r
- {\r
- "root" : 123,\r
- "page" : 1\r
- }\r
- ]\r
- }\r
-
-s -> c\r
+
+=== Profile ===
+c -> s
{\r
- "reply" : "ok" | "error",\r
- "error_message" : "blabla"\r
+ "header" : {action : "set_profile", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "login" : "paul49",
+ "password" : "IJKJDHHSAD9081238",
+ "nick" : "Paul",
+ "email" : "paul@pierre.com",
+ "css" : "css/3/euphorik.css",
+ "nick_format" : "nick" | "login" | "nick_login",
+ "view_times" : true | false,
+ "view_tooltips" : true | false,
+ "main_page" : 1,
+ "conversations" : [3, 8]
}
+
+s -> c
+ <ok>
+ou
+ <error>
-C.4. Wait event
----------------------
-Si "last_message_id" est absent alors le client ne possède pas de message.
-Les conversations données sont définies dans le profile.
+=== Wait event (page = chat) ===
+Si "last_message_id" est absent alors le client ne possède pas de message.
+Si "main_page" est absent alors est vaut 1.
+"cookie" n'est pas obligatoire.
+\r
+<message>\r
+ {\r
+ "id" : 54,\r
+ "user_id" : 344,\r
+ "date" : "Hier 17:26:54",\r
+ "system" : true | false,\r
+ "owner" : true | false,\r
+ "answered" : true | false,\r
+ "is_a_reply" : true | false,\r
+ "nick" : "Paul",\r
+ "login" : "paul_22",\r
+ "content" : "Salut",\r
+ "root" : 453,\r
+ "answer_to" : [\r
+ { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" }\r
+ ]\r
+ "ek_master" : true | false\r
+ }\r
-c -> s\r
+c -> s
{\r
- "action" : "wait_event",\r
- "cookie" : "LKJDLAKSJBFLKASN",\r
- "message_count" : 10,\r
+ "header" : {action : "wait_event", version : 3},
+ "page" : "chat"
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "message_count" : 10,
"last_message_id" : 163,
- "mainPage" : 1,
+ "main_page" : 1,
+ "troll_id" : 45,
"conversations" : [
{
"root" : 123,
- "page" : 1
+ "page" : 1,
+ "last_message_id" : 4 (pas obligatoire)
}
- ]\r
+ ]
}
-s -> c\r
-La première conversation est la principale (main).\r
-L'ordre des conversation est le même que celui des données de l'utilisateur.\r
-Le format de la date n'est pas formel.\r
- {\r
- "reply" : "new_messages",\r
- "conversations" : [\r
- "last_page" : true | false,\r
- "messages" : [\r
- "id" : 54,\r
- "date" : "Hier 17:26:54",\r
- "system" : true | false,\r
- "owner" : true | false,\r
- "answered" : true | false,\r
- "is_a_reply" : true | false,\r
- "nick" : "Paul",\r
- "login" : "paul_22",\r
- "content" : "Salut",\r
- "answer_to" : [\r
- { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }\r
- ]\r
- ]\r
- ]\r
+s -> c
+La première conversation est la principale (main).
+L'ordre des conversation est le même que celui des données de l'utilisateur.
+Le format de la date n'est pas formel.
+ {
+ "reply" : "new_message",
+ "conversations" : [
+ {
+ "last_page" : true | false,\r
+ "first" : <message>,
+ "messages" : [ <message>, .. ]
+ }
+ ]
+ }
+ou
+ {
+ "reply" : "message_updated",
+ "message_id" : 123,
+ "content" : "Salut +++ poulpe"
+ }
+ou
+ {
+ "reply" : "new_troll",
+ "troll_id" : 123,
+ "message_id" : 12,
+ "content" : "Linux sera desktop ready en 2008 ?"
}
-ou\r
+ou
+ <error>
+
+
+=== Wait event (page = admin) ===
+c -> s
{\r
- "reply" : "message_updated",\r
- "message_id" : 123,\r
- "contenu" : "Salut +++ poulpe"\r
+ "header" : {action : "wait_event", version : 3},
+ "page" : "admin",
+ "last_troll" : 5
}
-ou\r
+
+s -> c
+ {
+ "reply" : "troll_modified",
+ "troll_id" : 3,
+ "content" : "plop"
+ }
+ou
+s -> c
+ {
+ "reply" : "troll_added",
+ "trolls" :
+ [
+ {
+ "troll_id" : 5,
+ "content" : "plop",
+ "author" : "<Pseudo>"
+ "author_id" : 2
+ }
+ ]
+ }
+ou
+s -> c
+ {
+ "reply" : "troll_deleted",
+ "troll_id" : 2
+ }
+ou
+indique de mettre à jour la liste d'ips
+s -> c
+ {
+ "reply" : "banned_ips_refresh"
+ }
+
+
+=== Envoie d'un troll ===
+c -> s
{\r
- "reply" : "error",\r
- "error_message" : "blabla"\r
+ "header" : {action : "put_troll", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "content" : "Un bon troll velu !"
}
-\r
-\r
-C.5. Envoie troll\r
--------------------\r
-\r
-c -> s\r
+
+s -> c
+ <ok>
+ou
+ <error>
+
+
+=== Modification d'un troll ===
+c -> s
{\r
- "action" : "put_troll",\r
- "cookie" : "LKJDLAKSJBFLKASN",\r
- "content" : "Un bon troll velu !"\r
- }\r
- \r
-s -> c\r
+ "header" : {action : "mod_troll", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "troll_id" : 3,
+ "content" : "Un bon troll velu 2 !"
+ }
+
+s -> c
+ <ok>
+ou
+ <error>
+
+
+=== Suppression d'un troll ===
+c -> s
{\r
- "reply" : "ok" | "error",\r
- "error_message" : "blabla"\r
- }\r
+ "header" : {action : "del_troll", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "troll_id" : 3
+ }
+
+s -> c
+ <ok>
+ou
+ <error>
-C.6. Envoie message
--------------------
-Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
-"answer_to" n'est pas obligatoire.\r
+=== Envoie message ===
+Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
+"answer_to" n'est pas obligatoire.
-c -> s\r
+c -> s
{\r
- "action" : "put_message",\r
- "cookie" : "LKJDLAKSJBFLKASN",\r
- "nick" : "Paul",\r
- "content" : "Bonjour",\r
- "Troll" : 45,\r
- "answer_to" : [ 345, 532, ... ]\r
+ "header" : {action : "put_message", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "nick" : "Paul",
+ "content" : "Bonjour",
+ "answer_to" : [ 345, 532, ... ]
}
-s -> c\r
- {\r
- "reply" : "ok" | "error",\r
- "error_message" : "blabla"\r
- }
- \r
- \r
-C.7. Ajout d'une correction d'un messages\r
-----------------------------------------\r
-Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
-Le message est appondu avec un " +++ " devant, par exemple :\r
-> Gnome c'est mieux que KDE +++ Euh non ok, c'est faux\r
-\r
-c -> s\r
+s -> c
+ <ok>
+ou
+ <error>
+
+
+=== Slapage ===
+c -> s
{\r
- "action" : "correction",\r
- "cookie" : "LKJDLAKSJBFLKASN",\r
- "content" : "Euh non ok, c'est faux"\r
- }\r
- \r
-s -> c\r
+ "header" : {action : "slap", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "user_id" : 67,
+ "reason" : "blablabla"
+ }
+
+s -> c
+ <ok>
+ou
+ <error>
+
+
+=== Bannissement ===
+c -> s
{\r
- "reply" : "correction",\r
- "status" : "ok" | "error",\r
- "message_error" : "blabla"\r
+ "header" : {action : "ban", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "duration" : 15, // en minute
+ "user_id" : 67,
+ "reason" : "blablabla"
+ }
+
+s -> c
+ <ok>
+ou
+ <error>
+
+
+=== Liste des ip bannis ===
+c -> s
+ {\r
+ "header" : {action : "list_banned_ips", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN"
+ }
+
+s -> c
+ {
+ "reply" : "list_banned_ips",
+ "list" : [
+ {
+ ip : "192.168.1.2",
+ remaining_time : "1h23"
+ users : [
+ {
+ nick : "Pierre" ,
+ login : "pierre"
+ }
+ ]
+ }
+ ]
+ }
+
+
+=== Débannissement ===
+c -> s
+ {\r
+ "header" : {action : "unban", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN"
+ "ip" : "192.168.1.2"
+ }
+
+s -> c
+ <ok>
+ou
+ <error>
+
+
+=== Ajout d'une correction d'un messages ===
+Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.
+Le message est appondu avec un " +++ " devant, par exemple :
+> Gnome c'est mieux que KDE +++ Euh non ok, c'est faux
+
+c -> s
+ {\r
+ "header" : {action : "correction", version : 3},
+ "cookie" : "LKJDLAKSJBFLKASN",
+ "content" : "Euh non ok, c'est faux"
+ }
+
+s -> c
+ {
+ "reply" : "correction",
+ "status" : "ok" | "error",
+ "message_error" : "blabla"
}
projects / euphorik.git / blobdiff