euphorik.ch

h1. Protocole

h2. Introduction

Ce document a pour but de décrire la communication client-serveur du site euphorik.

Les messages échangés sont basés sur le format JSON.

Ce document remplace 'protocole2.txt'.

h2. Principes

h3. Enregistrement:

* 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.

h3. Authentification:

* L'authentification (login) se fait soit par un couple <login, mot de passe> soit à l'aide d'un cookie.

* Permet de récupérer les données d'un profile

h3. Rafraichissement:

* Le client envoie une demande au serveur avec l'id du dernier message (via XMLHttpRequest ou un function de JQuery)

* Le serveur maintient la connexion bloquée si le client est à jour.

* Dès qu'un nouveau message arrive, le serveur débloque la connexion et envoie le ou les messages manquants.

h2. Messages

<pre>

c : client

s : server

</pre>

Les messages client vers serveur sont envoyés par HTTP-POST.

A toutes les requêtes le serveur peut répondre une erreur :

<pre>

<error>

   { 

      "reply" : "error",

      "no" : 12

      "error_message" : "blabla"

   }

</pre>

Message ok générique :

<pre>

<ok>

   {

      "reply" : "ok"

   }

</pre>

Entête des messages clients :

Si la version du protocole n'est pas similaire du coté serveur la requête est refusée

<pre>

<client_header>

   {

      "action" : <action>,

      "version" : 3

   }

</pre>

h3. Enregistrement et authentification

Permet de créer un nouvel utilisateur.

"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.

Le mot de passe est hashé en md5.

*c -> s*

<pre>

   { 

      "header" : {action : "register", version : 3},

      "login" : "paul",

      "password" : "IJKJDHHSAD9081238",

      "profile" : { .. } // voir <profile>

   }

</pre>

ou

<pre>

   {

      "header" : {action : "authentification", version : 3}

      "cookie" : "LKJDLAKSJBFLKASN"

   }

</pre>

ou

<pre>

   {

      "header" : {action : "authentification", version : 3},

      "login" : "paul",

      "password" : "IJKJDHHSAD9081238"

   }

</pre>

*s -> c*

<pre>

   {

      "reply" : "register" | "authentification",

      "status" : "auth_registered" | "auth_not_registered",

      "cookie" : "LKJDLAKSJBFLKASN",

      "id" : 193,

      "login" : "paul49",

      "ek_master" : true | false,

      "profile" : <profile>

   }

</pre>

h3. Logout

*c -> s*

<pre>

   {

      "header" : {action : "logout", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN"

   }

</pre>

h3. Profile

<pre>

<profile>

   {

      "nick" : "Paul",

      "email" : "paul@pierre.com",

      "css" : "css/3/euphorik.css",

      "chat_order" : "chrono" | "reverse",

      "nick_format" : "nick" | "login" | "nick_login",

      "view_times" : true | false,

      "view_tooltips" : true | false,

      "conversations" : [{"root" : 3, "minimized" : true},

      "ostentatious_master" : "invisible" | "light" | "heavy"

   }

</pre>

*c -> s*

<pre>

   {

      "header" : {action : "set_profile", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "login" : "paul49",

      "password" : "IJKJDHHSAD9081238",

      "profile" : <profile>

   }

</pre>

*s -> c*

<pre>

   <ok>

ou

   <error>

</pre>

h3. Wait event (page = chat)

Si "last_message_id" est absent alors le client ne possède pas de message.

Si "main_page" est absent alors est vaut 1.

"cookie" n'est pas obligatoire.

<pre>

<message>

   {

      "id" : 54,

      "user_id" : 344,

      "date" : "Hier 17:26:54",

      "system" : true | false,

      "owner" : true | false,

      "answered" : true | false,

      "is_a_reply" : true | false,

      "nick" : "Paul",

      "login" : "paul_22",

      "content" : "Salut",

      "root" : 453,

      "answer_to" : [

         { "id" : 123, "nick" : "Pierre", "login" : "pierre_45" }

      ],

      "ek_master" : true | false,

      "ostentatious_master" : "invisible" | "light" | "heavy",

      "last_modification" : "Hier 17:26:54"

   }

</pre>

*c -> s*

<pre>

   {

      "header" : {action : "wait_event", version : 3},

      "page" : "chat"

      "cookie" : "LKJDLAKSJBFLKASN",

      "message_count" : 10,

      "last_message_id" : 163,

      "main_page" : 1,

      "troll_id" : 45,

      "conversations" : [

         {

            "root" : 123,

            "page" : 1,

            "last_message_id" : 4 (pas obligatoire)

         }

      ]

   }

</pre>

*s -> c*

La première conversation est la principale (main).

L'ordre des conversation est le même que celui des données de l'utilisateur.

Le format de la date n'est pas formel.

first correpond au premier message de la conversation, vaut 'null' pour la conversation principale ainsi que pour les conversations vides.

<pre>

   {

      "reply" : "new_message",

      "conversations" : [

         {

            "last_page" : true | false,

            "first" : <message> | null,

            "messages" : [ <message>, .. ]

         }

      ]

   }

</pre>

ou

<pre>

   {

      "reply" : "message_updated",

      "message_id" : 123,

      "content" : "Salut poulpe",

      "last_modification" : "Hier 17:26:54"

   }

</pre>

ou

<pre>

   {

      "reply" : "new_troll",

      "troll_id" : 123,

      "message_id" : 12,

      "content" : "Linux sera desktop ready en 2008 ?"

   }

</pre>

ou

<pre>

   <error>

</pre>

h3. Wait event (page = admin)

*c -> s*

<pre>

   {

      "header" : {action : "wait_event", version : 3},

      "page" : "admin",

      "last_troll" : 5

   }

</pre>

*s -> c*

<pre>

   {

      "reply" : "troll_modified",

      "troll_id" : 3,

      "content" : "plop"

   }

</pre>

ou

*s -> c*

<pre>

   {

      "reply" : "troll_added",

      "trolls" :

         [

            {

               "troll_id" : 5,

               "content" : "plop",

               "author" : "<Pseudo>"

               "author_id" : 2

            }

         ]

   }

</pre>

ou

*s -> c*

<pre>

   {

      "reply" : "troll_deleted",

      "troll_id" : 2

   }

</pre>

ou

indique de mettre à jour la liste d'ips

*s -> c*

<pre>

   {

      "reply" : "banned_ips_refresh"

   }

</pre>

h3. Envoie d'un troll

*c -> s*

<pre>

   {

      "header" : {action : "put_troll", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "content" : "Un bon troll velu !"

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Modification d'un troll

*c -> s*

<pre>

   {

      "header" : {action : "mod_troll", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "troll_id" : 3,

      "content" : "Un bon troll velu 2 !"

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Suppression d'un troll

*c -> s*

<pre>

   {

      "header" : {action : "del_troll", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "troll_id" : 3

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Envoie message

Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.

"answer_to" n'est pas obligatoire.

*c -> s*

<pre>

   {

      "header" : {action : "put_message", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "nick" : "Paul",

      "content" : "Bonjour",

      "answer_to" : [ 345, 532, ... ]

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Slapage

*c -> s*

<pre>

   {

      "header" : {action : "slap", version : 3},

      "cookie" :  "LKJDLAKSJBFLKASN",

      "user_id" : 67,

      "reason" : "blablabla"

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Bannissement

*c -> s*

<pre>

   {

      "header" : {action : "ban", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "duration" : 15, // en minute

      "user_id" : 67,

      "reason" : "blablabla"

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Liste des ip bannis

*c -> s*

<pre>

   {

      "header" : {action : "list_banned_ips", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN"

   }

</pre>

*s -> c*

<pre>

   {

      "reply" : "list_banned_ips",

      "list" : [

         {

            ip : "192.168.1.2", 

            remaining_time : "1h23"

            users : [

               {

                  nick : "Pierre" , 

                  login : "pierre" 

               }

            ]

         }

      ]

   }

</pre>

h3. Débannissement

*c -> s*

<pre>

   {

      "header" : {action : "unban", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN"

      "ip" : "192.168.1.2"

   }

</pre>

*s -> c*

<pre>

   <ok>

</pre>

ou

<pre>

   <error>

</pre>

h3. Ajout d'une correction d'un messages

_(non implémenté, améliorer pour la modification complète d'un message)_

Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.

Le message est appondu avec un " +++ " devant, par exemple :

> Gnome c'est mieux que KDE +++ Euh non ok, c'est faux

*c -> s*

<pre>

   {

      "header" : {action : "correction", version : 3},

      "cookie" : "LKJDLAKSJBFLKASN",

      "content" : "Euh non ok, c'est faux"

   }

</pre>   

*s -> c*

<pre>

   {

      "reply" : "correction",

      "status" : "ok" | "error",

      "message_error" : "blabla"

   } 

</pre>