doc/protocole3.txt

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