ADD trois mode d'affichage pour les pseudos

[euphorik.git] / doc / protocole3.txt

diff --git a/doc/protocole3.txt b/doc/protocole3.txt
index 2ce1a9e..02051e9 100644 (file)
--- a/doc/protocole3.txt
+++ b/doc/protocole3.txt
@@ -40,43 +40,55 @@ Message ok g
    }
 
 
-=== 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
+   { 
+      "action" : "authentification",
+      "login" : "paul",
+      "password" : "IJKJDHHSAD9081238"
    }
-ou\r
-   {\r
-      "action" : "authentification",\r
-      "cookie" : "LKJDLAKSJBFLKASN"\r
+ou
+   {
+      "action" : "authentification",
+      "cookie" : "LKJDLAKSJBFLKASN"
    }
-ou\r
-   {\r
-      "action" : "register",\r
-      "login" : "Paul",\r
-      "password" : "IJKJDHHSAD9081238"\r
+ou
+   {
+      "action" : "register",
+      "login" : "paul",
+      "password" : "IJKJDHHSAD9081238"
    }
    
-s -> c\r
-   {\r
-      "reply" : "login",\r
-      "status" : "registration_ok" | "authentification_ok",\r
+s -> c
+   {
+      "reply" : "register" | "authentification",
+      "status" : "auth_not_registered",
+      "cookie" : "LKJDLAKSJBFLKASN",
+      "id" : 193,
+      "css" : "css/1/euphorik.css",
+      "main_page" : 1
+   }
+ou\r
+   {
+      "reply" : "register" | "authentification",\r
+      "status" : "auth_registered",\r
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "id" : 193,\r
-      "pseudo" : "Paul",\r
+      "nick" : "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
+      "css" : "css/3/euphorik.css",
+      "nick_format" : "nick" | "login" | "nick_login",\r
+      "main_page" : 1,
+      "conversations" : [
+         {
+            "racine" : 123,
+            "page" : 1
+         }
       ]\r
    }
  \r
@@ -90,22 +102,22 @@ c -> s
  \r
  
 === Profile ===
-
 c -> s\r
    {\r
       "action" : "set_profile",\r
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "login" : "paul49",\r
       "password" : "IJKJDHHSAD9081238",\r
-      "pseudo" : "Paul",\r
+      "nick" : "Paul",\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
+      "css" : "css/3/euphorik.css",
+      "nick_format" : "nick" | "login" | "nick_login",\r
+      "main_page" : 1,
+      "conversations" : [
+         {
+            "root" : 123,
+            "page" : 1
+         }
       ]\r
    }\r
       
@@ -117,18 +129,20 @@ ou
 
 === 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.
+Si "main_page" est absent alors est vaut 1.
+"cookie" n'est pas obligatoire.
 
 c -> s\r
    {\r
-      "action" : "wait_event",\r
+      "action" : "wait_event",
+      "page" : "chat"\r
       "cookie" : "LKJDLAKSJBFLKASN",\r
-      "message_count" : 10,\r
+      "message_count" : 10,
       "last_message_id" : 163,
-      "main_page" : 1,
+      "main_page" : 1
       "conversations" : [
          {
-            "root" : 123,
+            "racine" : 123,
             "page" : 1
          }
       ]\r
@@ -143,21 +157,23 @@ Le format de la date n'est pas formel.
       "conversations" : [\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
+            "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, "nick" : "Pierre", "login" : "pierre_45" }\r
+                  ]
+               }\r
             ]\r
-         }\r
+         }
          ...\r
       ]\r
    }
@@ -174,25 +190,19 @@ ou
    }
 \r
 \r
-=== Envoie d'un troll ===\r
+=== Envoie d'un troll ===
+TODO\r
 c -> s\r
    {\r
       "action" : "put_troll",\r
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "content" : "Un bon troll velu !"\r
    }\r
- \r
-s -> c\r
-   {\r
-      "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
 
 === Envoie message ===
@@ -205,7 +215,6 @@ c -> s
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "nick" : "Paul",\r
       "content" : "Bonjour",\r
-      "Troll" : 45,\r
       "answer_to" : [ 345, 532, ... ]\r
    }