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
  33 C.1. Login
  34 ----------
  35 Le mot de passe est hashé en md5.\r
  36
  37 c -> s\r
  38    { \r
  39       "action" : "authentification",\r
  40       "login" : "Paul",\r
  41       "password" : "IJKJDHHSAD9081238"\r
  42    }
  43 ou\r
  44    {\r
  45       "action" : "authentification",\r
  46       "cookie" : "LKJDLAKSJBFLKASN"\r
  47    }
  48 ou\r
  49    {\r
  50       "action" : "register",\r
  51       "login" : "Paul",\r
  52       "password" : "IJKJDHHSAD9081238"\r
  53    }
  54
  55 s -> c\r
  56    {\r
  57       "reply" : "login",\r
  58       "status" : "registration_ok" | "authentification_ok" | "error",\r
  59       "cookie" : "LKJDLAKSJBFLKASN",\r
  60       "id" : 193,\r
  61       "pseudo" : "Paul",\r
  62       "login" : "paul49",\r
  63       "email" : "paul@pierre.com",\r
  64       "css" : "css/3/euphorik.css",\r
  65       "main_page" : 1,\r
  66       "conversations" : [\r
  67          {\r
  68             "root" : 123,\r
  69             "page" : 1\r
  70          }\r
  71       ],\r
  72       "error_message" : "blabla"\r
  73    }
  74  \r
  75
  76 C.2. Logout
  77 -----------
  78 c -> s\r
  79    {\r
  80       "action" : "logout",\r
  81       "cookie" : "LKJDLAKSJBFLKASN"\r
  82    }
  83  \r
  84
  85 C.3. Profile
  86 ------------
  87 Modification du profile, seul "cookie" est obligatoire.
  88
  89 c -> s\r
  90    {\r
  91       "action" : "set_profile",\r
  92       "cookie" : "LKJDLAKSJBFLKASN",\r
  93       "login" : "paul49",\r
  94       "password" : "IJKJDHHSAD9081238",\r
  95       "pseudo" : "Paul",\r
  96       "email" : "paul@pierre.com",\r
  97       "css" : "css/3/euphorik.css",\r
  98       "mainPage" : 1,\r
  99       "conversations" : [\r
 100          {\r
 101             "root" : 123,\r
 102             "page" : 1\r
 103          }\r
 104       ]\r
 105    }\r
 106
 107 s -> c\r
 108    {\r
 109       "reply" : "ok" | "error",\r
 110       "error_message" : "blabla"\r
 111    }
 112
 113
 114 C.4. Wait event
 115 ---------------------
 116 Si "last_message_id" est absent alors le client ne possède pas de message.
 117 Les conversations données sont définies dans le profile.
 118
 119 c -> s\r
 120    {\r
 121       "action" : "wait_event",\r
 122       "cookie" : "LKJDLAKSJBFLKASN",\r
 123       "message_count" : 10,\r
 124       "last_message_id" : 163,
 125       "mainPage" : 1,
 126       "conversations" : [
 127          {
 128             "root" : 123,
 129             "page" : 1
 130          }
 131       ]\r
 132    }
 133
 134 s -> c\r
 135 La première conversation est la principale (main).\r
 136 L'ordre des conversation est le même que celui des données de l'utilisateur.\r
 137 Le format de la date n'est pas formel.\r
 138    {\r
 139       "reply" : "new_messages",\r
 140       "conversations" : [\r
 141          "last_page" : true | false,\r
 142          "messages" : [\r
 143             "id" : 54,\r
 144             "date" : "Hier 17:26:54",\r
 145             "system" : true | false,\r
 146             "owner" : true | false,\r
 147             "answered" : true | false,\r
 148             "is_a_reply" : true | false,\r
 149             "nick" : "Paul",\r
 150             "login" : "paul_22",\r
 151             "content" : "Salut",\r
 152             "answer_to" : [\r
 153                { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }\r
 154             ]\r
 155          ]\r
 156       ]\r
 157    }
 158 ou\r
 159    {\r
 160       "reply" : "message_updated",\r
 161       "message_id" : 123,\r
 162       "contenu" : "Salut +++ poulpe"\r
 163    }
 164 ou\r
 165    {\r
 166       "reply" : "error",\r
 167       "error_message" : "blabla"\r
 168    }
 169 \r
 170 \r
 171 C.5. Envoie troll\r
 172 -------------------\r
 173 \r
 174 c -> s\r
 175    {\r
 176       "action" : "put_troll",\r
 177       "cookie" : "LKJDLAKSJBFLKASN",\r
 178       "content" : "Un bon troll velu !"\r
 179    }\r
 180  \r
 181 s -> c\r
 182    {\r
 183       "reply" : "ok" | "error",\r
 184       "error_message" : "blabla"\r
 185    }\r
 186
 187
 188 C.6. Envoie message
 189 -------------------
 190 Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
 191 "answer_to" n'est pas obligatoire.\r
 192
 193 c -> s\r
 194    {\r
 195       "action" : "put_message",\r
 196       "cookie" : "LKJDLAKSJBFLKASN",\r
 197       "nick" : "Paul",\r
 198       "content" : "Bonjour",\r
 199       "Troll" : 45,\r
 200       "answer_to" : [ 345, 532, ... ]\r
 201    }
 202
 203 s -> c\r
 204    {\r
 205       "reply" : "ok" | "error",\r
 206       "error_message" : "blabla"\r
 207    }
 208  \r
 209  \r
 210 C.7. Ajout d'une correction d'un messages\r
 211 ----------------------------------------\r
 212 Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
 213 Le message est appondu avec un " +++ " devant, par exemple :\r
 214 > Gnome c'est mieux que KDE +++ Euh non ok, c'est faux\r
 215 \r
 216 c -> s\r
 217    {\r
 218       "action" : "correction",\r
 219       "cookie" : "LKJDLAKSJBFLKASN",\r
 220       "content" : "Euh non ok, c'est faux"\r
 221    }\r
 222    \r
 223 s -> c\r
 224    {\r
 225       "reply" : "correction",\r
 226       "status" : "ok" | "error",\r
 227       "message_error" : "blabla"\r
 228    }