X-Git-Url: http://git.euphorik.ch/?a=blobdiff_plain;f=doc%2Fprotocole3.txt;h=033c9ab10487c9ea71be5c555cfa409fb0a9e431;hb=2afc392276a411f685088e659292f5691f60abd3;hp=612650214cdd025f406a8257c2746b7222c296f0;hpb=c39e55c505a27e30209fcfb6d837d6ec8a82b990;p=euphorik.git

diff --git a/doc/protocole3.txt b/doc/protocole3.txt
index 6126502..033c9ab 100644
--- 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.
 Les messages échangés sont basés sur le format JSON.
 Ce document remplace 'protocole2.txt'.
 
 
-B. Principes
-------------
+== 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.
 
@@ -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.
+L'action 'register' permet de créer un nouvel utilisateur.
 
 c -> s
    { 
@@ -55,26 +65,24 @@ ou
 s -> c
    {
       "reply" : "login",
-      "status" : "registration_ok" | "authentification_ok" | "error",
+      "status" : "registration_ok" | "authentification_ok",
       "cookie" : "LKJDLAKSJBFLKASN",
       "id" : 193,
       "pseudo" : "Paul",
       "login" : "paul49",
       "email" : "paul@pierre.com",
       "css" : "css/3/euphorik.css",
-      "main_page" : 1,
-      "conversations" : [
-         {
-            "root" : 123,
-            "page" : 1
-         }
-      ],
-      "error_message" : "blabla"
+      "main_page" : 1,
+      "conversations" : [
+         {
+            "racine" : 123,
+            "page" : 1
+         }
+      ]
    }
  
  
-C.2. Logout
------------
+=== Logout ===
 c -> s
    {
       "action" : "logout",
@@ -82,10 +90,7 @@ c -> s
    }
  
  
-C.3. Profile
-------------
-Modification du profile, seul "cookie" est obligatoire.
-
+=== Profile ===
 c -> s
    {
       "action" : "set_profile",
@@ -95,37 +100,35 @@ c -> s
       "pseudo" : "Paul",
       "email" : "paul@pierre.com",
       "css" : "css/3/euphorik.css",
-      "mainPage" : 1,
-      "conversations" : [
-         {
-            "root" : 123,
-            "page" : 1
-         }
+      "main_page" : 1,
+      "conversations" : [
+         {
+            "racine" : 123,
+            "page" : 1
+         }
       ]
    }
       
-s -> c
-   {
-      "reply" : "ok" | "error",
-      "error_message" : "blabla"
-   }
+s -> c
+   <ok>
+ou
+   <error>
 
 
-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.
+Les conversations lié aux trolls sont définies dans le profile.
 
 c -> s
    {
-      "action" : "wait_event",
+      "action" : "wait_event",
+      "page" : "chat"
       "cookie" : "LKJDLAKSJBFLKASN",
-      "message_count" : 10,
+      "message_count" : 10,
       "last_message_id" : 163,
-      "mainPage" : 1,
       "conversations" : [
          {
-            "root" : 123,
+            "racine" : 123,
             "page" : 1
          }
       ]
@@ -138,21 +141,26 @@ Le format de la date n'est pas formel.
    {
       "reply" : "new_messages",
       "conversations" : [
-         "last_page" : true | false,
-         "messages" : [
-            "id" : 54,
-            "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",
-            "answer_to" : [
-               { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }
+         {
+            "last_page" : true | false,
+            "messages" : [
+               {
+                  "id" : 54,
+                  "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",
+                  "answer_to" : [
+                     { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }
+                  ]
+               }
             ]
-         ]
+         }
+         ...
       ]
    }
 ou
@@ -166,10 +174,24 @@ ou
       "reply" : "error",
       "error_message" : "blabla"
    }
+
+
+=== Envoie d'un troll ===
+TODO
+c -> s
+   {
+      "action" : "put_troll",
+      "cookie" : "LKJDLAKSJBFLKASN",
+      "content" : "Un bon troll velu !"
+   }
+=== Modification d'un troll ===
+TODO
+=== Suppression d'un troll ===
+TODO
+=== Noter un troll ===
+TODO
 
-
-C.5. 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.
 
@@ -189,8 +211,7 @@ s -> c
    }
  
  
-C.6 Ajout d'une correction d'un messages
-----------------------------------------
+=== 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