ADD le slap

[euphorik.git] / doc / protocole3.txt

diff --git a/doc/protocole3.txt b/doc/protocole3.txt
index 033c9ab..99776a4 100644 (file)
--- a/doc/protocole3.txt
+++ b/doc/protocole3.txt
@@ -40,45 +40,57 @@ Message ok g
    }
 
 
-=== Login ===
-Le mot de passe est hashé en md5.\r
-L'action 'register' permet de créer un nouvel utilisateur.\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
+      "css" : "css/3/euphorik.css",
+      "nick_format" : "nick" | "login" | "nick_login",\r
       "main_page" : 1,
       "conversations" : [
          {
             "racine" : 123,
             "page" : 1
          }
-      ]\r
+      ],
+      "ek_master" : true | false\r
    }
  \r
  
@@ -97,13 +109,14 @@ c -> s
       "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
+      "css" : "css/3/euphorik.css",
+      "nick_format" : "nick" | "login" | "nick_login",\r
       "main_page" : 1,
       "conversations" : [
          {
-            "racine" : 123,
+            "root" : 123,
             "page" : 1
          }
       ]\r
@@ -117,7 +130,8 @@ ou
 
 === Wait event ===
 Si "last_message_id" est absent alors le client ne possède pas de message.
-Les conversations lié aux trolls sont définies dans le profile.
+Si "main_page" est absent alors est vaut 1.
+"cookie" n'est pas obligatoire.
 
 c -> s\r
    {\r
@@ -126,10 +140,12 @@ c -> s
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "message_count" : 10,
       "last_message_id" : 163,
+      "main_page" : 1
       "conversations" : [
          {
             "racine" : 123,
-            "page" : 1
+            "page" : 1,
+            "last_message_id" : 4 (pas obligatoire)
          }
       ]\r
    }
@@ -145,7 +161,8 @@ Le format de la date n'est pas formel.
             "last_page" : true | false,\r
             "messages" : [
                {\r
-                  "id" : 54,\r
+                  "id" : 54,
+                  "user_id" : 344,\r
                   "date" : "Hier 17:26:54",\r
                   "system" : true | false,\r
                   "owner" : true | false,\r
@@ -155,8 +172,9 @@ Le format de la date n'est pas formel.
                   "login" : "paul_22",\r
                   "content" : "Salut",\r
                   "answer_to" : [\r
-                     { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }\r
+                     { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" }\r
                   ]
+                  "ek_master" : true | false
                }\r
             ]\r
          }
@@ -169,11 +187,8 @@ ou
       "message_id" : 123,\r
       "contenu" : "Salut +++ poulpe"\r
    }
-ou\r
-   {\r
-      "reply" : "error",\r
-      "error_message" : "blabla"\r
-   }
+ou
+   <error>
 \r
 \r
 === Envoie d'un troll ===
@@ -204,12 +219,41 @@ c -> s
       "answer_to" : [ 345, 532, ... ]\r
    }
  
-s -> c\r
-   {\r
-      "reply" : "ok" | "error",\r
-      "error_message" : "blabla"\r
+s -> c
+   <ok>
+ou
+   <error>
+
+
+=== Slapage ===
+
+c -> s
+   {
+      "action" : "slap",
+      "cookie" :  "LKJDLAKSJBFLKASN",
+      "user_id" : 67
    }
- \r
+   
+s -> c
+   <ok>
+ou
+   <error>
+   
+
+=== Bannissement ===
+
+c -> s
+   {
+      "action" : "ban",
+      "cookie" : "LKJDLAKSJBFLKASN",
+      "duration" : 15, // en minute
+      "user_id" : 67
+   }
+   
+s -> c
+   <ok>
+ou
+   <error>\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