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