doc/protocole3.txt

   1 Euphorik - Protocole v3
   2 -----------------------
   3
   4 == Introduction ==
   5 Ce document a pour but de décrire la communication client-serveur du site euphorik.\r
   6 Les messages échangés sont basés sur le format JSON.
   7 Ce document remplace 'protocole2.txt'.
   8 \r
   9
  10 == Principes ==
  11 Enregistrement:\r
  12  * 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.
  13
  14 Authentification:\r
  15  * L'authentification (login) se fait soit par un couple <login, mot de passe> soit à l'aide d'un cookie.\r
  16  * Permet de récupérer les données d'un profile
  17
  18 Rafraichissement:
  19  * Le client envoie une demande au serveur avec l'id du dernier message (via XMLHttpRequest ou un function de JQuery)
  20  * Le serveur maintient la connexion bloquée si le client est à jour.
  21  * Dès qu'un nouveau message arrive, le serveur débloque la connexion et envoie le ou les messages manquants.
  22
  23
  24 == Protocole ==
  25 c : client
  26 s : server
  27 Les messages client vers serveur sont envoyés par HTTP-POST.
  28
  29 A toutes les requêtes le serveur peut répondre une erreur :
  30 <error>
  31    {
  32       "reply" : "error",
  33       "error_message" : "blabla"
  34    }
  35
  36 Message ok générique :
  37 <ok>
  38    {
  39       "reply" : "ok"
  40    }
  41
  42
  43 === Enregistrement et authentification ===
  44 Permet de créer un nouvel utilisateur.
  45 "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.
  46 Le mot de passe est hashé en md5.
  47
  48 c -> s
  49    {
  50       "action" : "authentification",
  51       "login" : "paul",
  52       "password" : "IJKJDHHSAD9081238"
  53    }
  54 ou
  55    {
  56       "action" : "authentification",
  57       "cookie" : "LKJDLAKSJBFLKASN"
  58    }
  59 ou
  60    {
  61       "action" : "register",
  62       "login" : "paul",
  63       "password" : "IJKJDHHSAD9081238"
  64    }
  65
  66 s -> c
  67    {
  68       "reply" : "register" | "authentification",
  69       "status" : "auth_not_registered",
  70       "cookie" : "LKJDLAKSJBFLKASN",
  71       "id" : 193,
  72       "css" : "css/1/euphorik.css",
  73       "main_page" : 1
  74    }
  75 ou\r
  76    {
  77       "reply" : "register" | "authentification",\r
  78       "status" : "auth_registered",\r
  79       "cookie" : "LKJDLAKSJBFLKASN",\r
  80       "id" : 193,\r
  81       "nick" : "Paul",\r
  82       "login" : "paul49",\r
  83       "email" : "paul@pierre.com",\r
  84       "css" : "css/3/euphorik.css",\r
  85       "main_page" : 1,
  86       "conversations" : [
  87          {
  88             "racine" : 123,
  89             "page" : 1
  90          }
  91       ]\r
  92    }
  93  \r
  94
  95 === Logout ===
  96 c -> s\r
  97    {\r
  98       "action" : "logout",\r
  99       "cookie" : "LKJDLAKSJBFLKASN"\r
 100    }
 101  \r
 102
 103 === Profile ===
 104 c -> s\r
 105    {\r
 106       "action" : "set_profile",\r
 107       "cookie" : "LKJDLAKSJBFLKASN",\r
 108       "login" : "paul49",\r
 109       "password" : "IJKJDHHSAD9081238",\r
 110       "nick" : "Paul",\r
 111       "email" : "paul@pierre.com",\r
 112       "css" : "css/3/euphorik.css",\r
 113       "main_page" : 1,
 114       "conversations" : [
 115          {
 116             "root" : 123,
 117             "page" : 1
 118          }
 119       ]\r
 120    }\r
 121
 122 s -> c
 123    <ok>
 124 ou
 125    <error>
 126
 127
 128 === Wait event ===
 129 Si "last_message_id" est absent alors le client ne possède pas de message.
 130 Si "main_page" est absent alors est vaut 1.
 131 "cookie" n'est pas obligatoire.
 132
 133 c -> s\r
 134    {\r
 135       "action" : "wait_event",
 136       "page" : "chat"\r
 137       "cookie" : "LKJDLAKSJBFLKASN",\r
 138       "message_count" : 10,
 139       "last_message_id" : 163,
 140       "main_page" : 1
 141       "conversations" : [
 142          {
 143             "racine" : 123,
 144             "page" : 1
 145          }
 146       ]\r
 147    }
 148
 149 s -> c\r
 150 La première conversation est la principale (main).\r
 151 L'ordre des conversation est le même que celui des données de l'utilisateur.\r
 152 Le format de la date n'est pas formel.\r
 153    {\r
 154       "reply" : "new_messages",\r
 155       "conversations" : [\r
 156          {\r
 157             "last_page" : true | false,\r
 158             "messages" : [
 159                {\r
 160                   "id" : 54,\r
 161                   "date" : "Hier 17:26:54",\r
 162                   "system" : true | false,\r
 163                   "owner" : true | false,\r
 164                   "answered" : true | false,\r
 165                   "is_a_reply" : true | false,\r
 166                   "nick" : "Paul",\r
 167                   "login" : "paul_22",\r
 168                   "content" : "Salut",\r
 169                   "answer_to" : [\r
 170                      { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" }\r
 171                   ]
 172                }\r
 173             ]\r
 174          }
 175          ...\r
 176       ]\r
 177    }
 178 ou\r
 179    {\r
 180       "reply" : "message_updated",\r
 181       "message_id" : 123,\r
 182       "contenu" : "Salut +++ poulpe"\r
 183    }
 184 ou\r
 185    {\r
 186       "reply" : "error",\r
 187       "error_message" : "blabla"\r
 188    }
 189 \r
 190 \r
 191 === Envoie d'un troll ===
 192 TODO\r
 193 c -> s\r
 194    {\r
 195       "action" : "put_troll",\r
 196       "cookie" : "LKJDLAKSJBFLKASN",\r
 197       "content" : "Un bon troll velu !"\r
 198    }\r
 199 === Modification d'un troll ===\r
 200 TODO\r
 201 === Suppression d'un troll ===\r
 202 TODO\r
 203 === Noter un troll ===\r
 204 TODO
 205
 206 === Envoie message ===
 207 Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
 208 "answer_to" n'est pas obligatoire.\r
 209
 210 c -> s\r
 211    {\r
 212       "action" : "put_message",\r
 213       "cookie" : "LKJDLAKSJBFLKASN",\r
 214       "nick" : "Paul",\r
 215       "content" : "Bonjour",\r
 216       "answer_to" : [ 345, 532, ... ]\r
 217    }
 218
 219 s -> c\r
 220    {\r
 221       "reply" : "ok" | "error",\r
 222       "error_message" : "blabla"\r
 223    }
 224  \r
 225  \r
 226 === Ajout d'une correction d'un messages ===\r
 227 Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
 228 Le message est appondu avec un " +++ " devant, par exemple :\r
 229 > Gnome c'est mieux que KDE +++ Euh non ok, c'est faux\r
 230 \r
 231 c -> s\r
 232    {\r
 233       "action" : "correction",\r
 234       "cookie" : "LKJDLAKSJBFLKASN",\r
 235       "content" : "Euh non ok, c'est faux"\r
 236    }\r
 237    \r
 238 s -> c\r
 239    {\r
 240       "reply" : "correction",\r
 241       "status" : "ok" | "error",\r
 242       "message_error" : "blabla"\r
 243    }