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