(no commit message)

[euphorik.git] / doc / protocole3.txt

diff --git a/doc/protocole3.txt b/doc/protocole3.txt
index 212794b..c9411c2 100644 (file)
--- a/doc/protocole3.txt
+++ b/doc/protocole3.txt
@@ -1,15 +1,13 @@
 Euphorik - Protocole v3
 -----------------------
 
-A. Introduction
----------------
+== 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.
 Ce document remplace 'protocole2.txt'.
 \r
 
-B. Principes
-------------
+== 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.
 
@@ -23,16 +21,28 @@ Rafraichissement:
  * 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.
 
+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"
+   }
 
-C.1. Login
-----------
+
+=== Login ===
 Le mot de passe est hashé en md5.\r
+L'action 'register' permet de créer un nouvel utilisateur.\r
 
 c -> s\r
    { \r
@@ -55,26 +65,18 @@ ou
 s -> c\r
    {\r
       "reply" : "login",\r
-      "status" : "registration_ok" | "authentification_ok" | "error",\r
+      "status" : "registration_ok" | "authentification_ok",\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
+      "main_page" : 1\r
    }
  \r
  
-C.2. Logout
------------
+=== Logout ===
 c -> s\r
    {\r
       "action" : "logout",\r
@@ -82,10 +84,7 @@ c -> s
    }
  \r
  
-C.3. Profile
-------------
-Modification du profile, seul "cookie" est obligatoire.
-
+=== Profile ===
 c -> s\r
    {\r
       "action" : "set_profile",\r
@@ -95,24 +94,23 @@ c -> s
       "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
+      "main_page" : 1\r
    }\r
       
-s -> c\r
+s -> c
+   <ok>
+ou
+   <error>\r
+\r
+TODO : \r
+c -> s\r
    {\r
-      "reply" : "ok" | "error",\r
-      "error_message" : "blabla"\r
+      "action" : "set_conversation",\r
+      \r
    }
 
 
-C.4. Wait event
----------------------
+=== 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.
 
@@ -121,14 +119,8 @@ c -> s
       "action" : "wait_event",\r
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "message_count" : 10,\r
-      "last_message_id" : 163,
-      "mainPage" : 1,
-      "conversations" : [
-         {
-            "root" : 123,
-            "page" : 1
-         }
-      ]\r
+      "troll" : 45,\r
+      "last_message_id" : 163\r
    }
  
 s -> c\r
@@ -138,21 +130,24 @@ Le format de la date n'est pas formel.
    {\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
+            "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
+         }\r
+         ...\r
       ]\r
    }
 ou\r
@@ -168,9 +163,7 @@ ou
    }
 \r
 \r
-C.5. Envoie troll\r
--------------------\r
-\r
+=== Envoie d'un troll ===\r
 c -> s\r
    {\r
       "action" : "put_troll",\r
@@ -183,10 +176,17 @@ s -> c
       "reply" : "ok" | "error",\r
       "error_message" : "blabla"\r
    }\r
-   
+   \r
+=== Modification d'un troll ===\r
+TODO\r
+=== Demande de trolls ===\r
+TODO\r
+=== Suppression d'un troll ===\r
+TODO\r
+=== Noter un troll ===\r
+TODO
 
-C.6. Envoie message
--------------------
+=== 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
 
@@ -207,8 +207,7 @@ s -> c
    }
  \r
  \r
-C.7. Ajout d'une correction d'un messages\r
-----------------------------------------\r
+=== Ajout d'une correction d'un messages ===\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