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",
  85       "nick_format" : "nick" | "login" | "nick_login",\r
  86       "main_page" : 1,
  87       "conversations" : [
  88          {
  89             "racine" : 123,
  90             "page" : 1
  91          }
  92       ],
  93       "ek_master" : true | false\r
  94    }
  95  \r
  96
  97 === Logout ===
  98 c -> s\r
  99    {\r
 100       "action" : "logout",\r
 101       "cookie" : "LKJDLAKSJBFLKASN"\r
 102    }
 103  \r
 104
 105 === Profile ===
 106 c -> s\r
 107    {\r
 108       "action" : "set_profile",\r
 109       "cookie" : "LKJDLAKSJBFLKASN",\r
 110       "login" : "paul49",\r
 111       "password" : "IJKJDHHSAD9081238",\r
 112       "nick" : "Paul",\r
 113       "email" : "paul@pierre.com",\r
 114       "css" : "css/3/euphorik.css",
 115       "nick_format" : "nick" | "login" | "nick_login",\r
 116       "main_page" : 1,
 117       "conversations" : [
 118          {
 119             "root" : 123,
 120             "page" : 1
 121          }
 122       ]\r
 123    }\r
 124
 125 s -> c
 126    <ok>
 127 ou
 128    <error>
 129
 130
 131 === Wait event ===
 132 Si "last_message_id" est absent alors le client ne possède pas de message.
 133 Si "main_page" est absent alors est vaut 1.
 134 "cookie" n'est pas obligatoire.
 135
 136 c -> s\r
 137    {\r
 138       "action" : "wait_event",
 139       "page" : "chat"\r
 140       "cookie" : "LKJDLAKSJBFLKASN",\r
 141       "message_count" : 10,
 142       "last_message_id" : 163,
 143       "main_page" : 1
 144       "conversations" : [
 145          {
 146             "racine" : 123,
 147             "page" : 1,
 148             "last_message_id" : 4 (pas obligatoire)
 149          }
 150       ]\r
 151    }
 152
 153 s -> c\r
 154 La première conversation est la principale (main).\r
 155 L'ordre des conversation est le même que celui des données de l'utilisateur.\r
 156 Le format de la date n'est pas formel.\r
 157    {\r
 158       "reply" : "new_messages",\r
 159       "conversations" : [\r
 160          {\r
 161             "last_page" : true | false,\r
 162             "messages" : [
 163                {\r
 164                   "id" : 54,\r
 165                   "date" : "Hier 17:26:54",\r
 166                   "system" : true | false,\r
 167                   "owner" : true | false,\r
 168                   "answered" : true | false,\r
 169                   "is_a_reply" : true | false,\r
 170                   "nick" : "Paul",\r
 171                   "login" : "paul_22",\r
 172                   "content" : "Salut",\r
 173                   "answer_to" : [\r
 174                      { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" }\r
 175                   ]
 176                   "ek_master" : true | false
 177                }\r
 178             ]\r
 179          }
 180          ...\r
 181       ]\r
 182    }
 183 ou\r
 184    {\r
 185       "reply" : "message_updated",\r
 186       "message_id" : 123,\r
 187       "contenu" : "Salut +++ poulpe"\r
 188    }
 189 ou
 190    <error>
 191 \r
 192 \r
 193 === Envoie d'un troll ===
 194 TODO\r
 195 c -> s\r
 196    {\r
 197       "action" : "put_troll",\r
 198       "cookie" : "LKJDLAKSJBFLKASN",\r
 199       "content" : "Un bon troll velu !"\r
 200    }\r
 201 === Modification d'un troll ===\r
 202 TODO\r
 203 === Suppression d'un troll ===\r
 204 TODO\r
 205 === Noter un troll ===\r
 206 TODO
 207
 208 === Envoie message ===
 209 Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
 210 "answer_to" n'est pas obligatoire.\r
 211
 212 c -> s\r
 213    {\r
 214       "action" : "put_message",\r
 215       "cookie" : "LKJDLAKSJBFLKASN",\r
 216       "nick" : "Paul",\r
 217       "content" : "Bonjour",\r
 218       "answer_to" : [ 345, 532, ... ]\r
 219    }
 220
 221 s -> c
 222    <ok>
 223 ou
 224    <error>
 225
 226
 227 === Bannissement ===
 228
 229 c -> s
 230    {
 231       "action" : "ban",
 232       "cookie" : "LKJDLAKSJBFLKASN",
 233       "duration" : 15, // en minute
 234       "user_id" : 67
 235    }
 236
 237 s -> c
 238    <ok>
 239 ou
 240    <error>\r
 241  \r
 242 === Ajout d'une correction d'un messages ===\r
 243 Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
 244 Le message est appondu avec un " +++ " devant, par exemple :\r
 245 > Gnome c'est mieux que KDE +++ Euh non ok, c'est faux\r
 246 \r
 247 c -> s\r
 248    {\r
 249       "action" : "correction",\r
 250       "cookie" : "LKJDLAKSJBFLKASN",\r
 251       "content" : "Euh non ok, c'est faux"\r
 252    }\r
 253    \r
 254 s -> c\r
 255    {\r
 256       "reply" : "correction",\r
 257       "status" : "ok" | "error",\r
 258       "message_error" : "blabla"\r
 259    }