X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=doc%2Fprotocole3.txt;h=e89b357a793a8b0f4f211cda35ddedb475d288e9;hp=8c8d2539f23e1c8d3f371d375216366e83bcfde8;hb=2424ba818818a6bd0b547fa540742f9b54db990b;hpb=e82b363f65838828948a62ef4452e752743ef661 diff --git a/doc/protocole3.txt b/doc/protocole3.txt index 8c8d253..e89b357 100644 --- a/doc/protocole3.txt +++ b/doc/protocole3.txt @@ -2,38 +2,38 @@ Euphorik - Protocole v3 ----------------------- == 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 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'. - + == 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. +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 soit à l'aide d'un cookie. - * Permet de récupérer les données d'un profile +Authentification: + * L'authentification (login) se fait soit par un couple 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. == 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 : +A toutes les requêtes le serveur peut répondre une erreur : { "reply" : "error", "error_message" : "blabla" } -Message ok générique : +Message ok générique : { "reply" : "ok" @@ -41,9 +41,9 @@ Message ok g === 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. +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 { @@ -72,49 +72,49 @@ s -> c "css" : "css/1/euphorik.css", "main_page" : 1 } -ou +ou { - "reply" : "register" | "authentification", - "status" : "auth_registered", - "cookie" : "LKJDLAKSJBFLKASN", - "id" : 193, - "nick" : "Paul", - "login" : "paul49", - "email" : "paul@pierre.com", + "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, + "view_tooltips" : true | false, // "main_page" : 1, "conversations" : [3, 8], - "ek_master" : true | false + "ek_master" : true | false } - + === Logout === -c -> s - { - "action" : "logout", - "cookie" : "LKJDLAKSJBFLKASN" +c -> s + { + "action" : "logout", + "cookie" : "LKJDLAKSJBFLKASN" } - + === Profile === -c -> s - { - "action" : "set_profile", - "cookie" : "LKJDLAKSJBFLKASN", - "login" : "paul49", - "password" : "IJKJDHHSAD9081238", - "nick" : "Paul", - "email" : "paul@pierre.com", +c -> s + { + "action" : "set_profile", + "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, + "view_tooltips" : true | false, "main_page" : 1, - "conversations" : [3, 8] - } + "conversations" : [3, 8] + } s -> c @@ -123,15 +123,15 @@ ou === Wait event (page = chat) === -Si "last_message_id" est absent alors le client ne possède pas de message. +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. -c -> s - { +c -> s + { "action" : "wait_event", - "page" : "chat" - "cookie" : "LKJDLAKSJBFLKASN", + "page" : "chat" + "cookie" : "LKJDLAKSJBFLKASN", "message_count" : 10, "last_message_id" : 163, "main_page" : 1, @@ -142,46 +142,46 @@ c -> s "page" : 1, "last_message_id" : 4 (pas obligatoire) } - ] + ] } -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, +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, "messages" : [ - { + { "id" : 54, - "user_id" : 344, - "date" : "Hier 17:26:54", - "system" : true | false, - "owner" : true | false, - "answered" : true | false, - "is_a_reply" : true | false, - "nick" : "Paul", - "login" : "paul_22", + "user_id" : 344, + "date" : "Hier 17:26:54", + "system" : true | false, + "owner" : true | false, + "answered" : true | false, + "is_a_reply" : true | false, + "nick" : "Paul", + "login" : "paul_22", "content" : "Salut", - "root" : 453, - "answer_to" : [ - { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" } + "root" : 453, + "answer_to" : [ + { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" } ] "ek_master" : true | false - } - ] + } + ] } - ... - ] + ... + ] } -ou - { - "reply" : "message_updated", - "message_id" : 123, - "content" : "Salut +++ poulpe" +ou + { + "reply" : "message_updated", + "message_id" : 123, + "content" : "Salut +++ poulpe" } ou { @@ -229,19 +229,19 @@ s -> c "troll_id" : 2 } ou -indique de mettre à jour la liste d'ips +indique de mettre à jour la liste d'ips s -> c { "reply" : "banned_ips_refresh" } - - -=== Envoie d'un troll === -c -> s - { - "action" : "put_troll", - "cookie" : "LKJDLAKSJBFLKASN", - "content" : "Un bon troll velu !" + + +=== Envoie d'un troll === +c -> s + { + "action" : "put_troll", + "cookie" : "LKJDLAKSJBFLKASN", + "content" : "Un bon troll velu !" } s -> c @@ -249,7 +249,7 @@ s -> c ou - + === Modification d'un troll === c -> s { @@ -264,7 +264,7 @@ s -> c ou - + === Suppression d'un troll === c -> s { @@ -280,16 +280,16 @@ ou === Envoie message === -Le client envoie un message, le message peut répondre à un certain nombre d'autres messages. -"answer_to" n'est pas obligatoire. +Le client envoie un message, le message peut répondre à un certain nombre d'autres messages. +"answer_to" n'est pas obligatoire. -c -> s - { - "action" : "put_message", - "cookie" : "LKJDLAKSJBFLKASN", - "nick" : "Paul", - "content" : "Bonjour", - "answer_to" : [ 345, 532, ... ] +c -> s + { + "action" : "put_message", + "cookie" : "LKJDLAKSJBFLKASN", + "nick" : "Paul", + "content" : "Bonjour", + "answer_to" : [ 345, 532, ... ] } s -> c @@ -354,7 +354,7 @@ s -> c } -=== Débannissement === +=== Débannissement === c -> s { "action" : "unban", @@ -366,23 +366,23 @@ s -> c ou - - -=== 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 - { - "action" : "correction", - "cookie" : "LKJDLAKSJBFLKASN", - "content" : "Euh non ok, c'est faux" - } - -s -> c - { - "reply" : "correction", - "status" : "ok" | "error", - "message_error" : "blabla" + + +=== 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 + { + "action" : "correction", + "cookie" : "LKJDLAKSJBFLKASN", + "content" : "Euh non ok, c'est faux" + } + +s -> c + { + "reply" : "correction", + "status" : "ok" | "error", + "message_error" : "blabla" }