Euphorik - minichat
-------------------

A. Introduction
---------------

Le minichat utilise AJAX. Tous les messages sont au format XML
Eventuellement utiliser comet comme décrit ici
 : http://www.zeitoun.net/index.php?2007/06/22/46-how-to-implement-comet-with-php


Structure :
-----------

Les objets globaux :
 - Messages (liste des messages actuellement affichés, permet de recupérer les nouveaux messages)
 - Connexion (Information sur la connexion, information sur le user actuel)
 

B. Principe
-----------
Termes : serveur, client, utilisateur

 1 Chargement de la page html.
 2 Le client écoute les derniers messages au serveur (asynchrone).
 3 Le client est initialement déconnecté, il regarde si un cookie existe sur la machine cliente :
  a Si oui : il tente un login avec le cookie, si ok alors le client est connecté sinon il reste dans l'état déconnecté.
  b Si non : il demande au serveur la génération d'un captcha et l'affiche.  
 4 L'utilisateur peut alors envoyer un message. Il doit saisir le captcha s'il l'état et déconnecté.
  a Si le captcha a été saisie le client envoie une requête de login
 5 Le message est posté


Principe concernant le rafraichissement:
 * Le client envoie une demande au serveur avec l'id du dernier message (via XMLHttpRequest ou un méthode de JQuery)
 * Le serveur maintient la connexion bloqué si le client est à jour.
 * Dès que le serveur n'est plus à jours, il envoie les messages manquants.
 
Problème :
 * Comment faire de l'attente passive sur le serveur en écoutant l'arrivée d'un nouveau message au niveau de la bd
  -> en utilisant le "event handling" de mnesia : http://www.erlang.org//doc/apps/mnesia/part_frame.html
     chapitre 5.7 et 5.7.2


C. Protocole
------------
c : client
s : server

C.1. Demande de génération d'un nouveau captcha :
-----------------------------------------------

c -> s
<action name="generationCaptcha">
</action>

s -> c
<reponse name="generationCaptcha">
   <chemin>img/tmp/b1b1b4e72e6f3d00e477cf37cced5851.jpg</chemin>
   <captchaCrypt>b1b1b4e72e6f3d00e477cf37cced5851</captchaCrypt>
</action>

C.2. Login :
------------
le message du client est posté par la méthode POST et se nomme 'action'.

c -> s
(nouveau user) (obsolète)
 <action name="loginCaptcha">
   <captchaCrypt>b1b1b4e72e6f3d00e477cf37cced5851</captchaCrypt>
   <captchaInput>LKJDLA</captchaInput>
 </action>
 
ou
(ne sert pour l'instant qu'a mettre à jour user.date_derniere_connexion)
(si le login est faut, une temporisation est effectuée)
 <action name="login">
   <cookie>LKJDLAKSJBFLKASN</cookie>
 </action>
 
ou 
 <action name="login">
   <login>Paul</login>
   <password>IJKJDHHSAD9081238</password>
 </action>
 
 <action name="login">
   <login>Paul</login>
   <password>IJKJDHHSAD9081238</password>
 </action>
 
ou (login et password peuvent être omis)
 <action name="register">
   <login>Paul</login>
   <password>IJKJDHHSAD9081238</password>
 </action>
   
s -> c
(<information> et <pseudo> pas obligatoire)
 <reponse name="login">
   <statut>enregistre|identifie|erreur</statut>
   <cookie>LKJDLAKSJBFLKASN</cookie>
   <id>7ZS</id> <!-- l'id est en base 36 -->
   <pseudo>Paul</pseudo>
   <login>paul49</login>
   <email>paul@pierre.com</email>
   <css>css/lite.css</css>
   <information>blabla</information>
 </reponse>
 
 
C.3. Logout :
-------------
c -> s
 <action name="logout">
   <cookie>LKJDLAKSJBFLKASN</cookie> 
 </action>
 
C.4. Profile :
--------------
modification du profile, seul 'cookie' est obligatoire

c -> s
 <action name="profile">
   <cookie>LKJDLAKSJBFLKASN</cookie>
   <login>paul49</login>
   <password>IJKJDHHSAD9081238</password>
   <pseudo>Paul</pseudo>
   <email>paul@pierre.com</email>
   <css>css/dark.css</css>
 </action>
 
s -> c
 <reponse name="profile">
   <statut>ok|pas ok</statut>
   <information>balbla></information>
 </reponse>


C.5. Refresh messages :
-----------------------

Si dernierMessageId est absent alors le client ne possède pas de message.
Page peut être omis, il a alors la valeur 1 (première page)
dernierMessageId est en base 36 (l'histoire de rigoler un peu)

c -> s
 <action name="refreshMessages">
  <cookie>LKJDLAKSJBFLKASN</cookie>
  <dernierMessageId>6ZR</dernierMessageId>
  <nombreMessage>10</nombreMessage>
  <page>1</page>
 </action>
 
s -> c
 <reponse name="refreshMessages">
  <nbPage>4</nbPage> <!-- le nombre de page total -->
  <message id="1F5">
   <date>Hier 17:26:54</date>
   <systeme></system> <!-- est-ce un message système ? -->
   <proprietaire></proprietaire> <!-- est-ce que le message appartient à l'utilisateur courant ? "true" ou "false" -->
   <repondu></repondu>  <!-- est-ce que l'utilisateur courant a répondu à ce message ? "true" ou "false" -->
   <reponse></reponse> <!-- est-ce que c'est une réponse à un message de l'utilisateur courant ? "true" ou "false" -->
   <pseudo>Paul</pseudo>
   <login>paul_22</login>
   <contenu>Salut</contenu>
   <repondA>
      <!-- id est l'id d'un message -->
      <id id="DE2" pseudo="Pierre" login="pierre_45"> 
      <!-- [..] -->
   </repondA>
  </message>
  <!-- [..] -->
 </reponse>

ou

 <reponse name="refreshMessages">
  <erreur>raison</erreur>
 </reponse>

C.6. Envoie message :
---------------------

Un client envoie un message, le message peut répondre à un certain nombre d'autres messages.
<reponses> n'est pas obligatoire.
c -> s
 <action name="message">
  <cookie>LKJDLAKSJBFLKASN</cookie>
  <pseudo>Paul</pseudo> <!-- il est possible que la personne change de pseudo -->
  <contenu>Bonjour</contenu>
  <reponses>
   <reponse id="RT5" />
   <reponse id="39K" />
   <!-- [..] -->
  </reponses>
 </action>
 
s -> c
 <reponse name="message">
   <statut>ok|pas ok</statut>
 </reponse>