From: Greg Burri <greg.burri@gmail.com>
Date: Mon, 3 Mar 2008 14:04:37 +0000 (+0000)
Subject: MOD mise à jour mineur sur la présentation du code
X-Git-Tag: 1.0.0^2~188
X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=commitdiff_plain;h=5527b650d1cb16caa6afc8f44545097ca92b97a2

MOD mise à jour mineur sur la présentation du code
MOD quelques modifs du todo
---

diff --git a/doc/TODO.txt b/doc/TODO.txt
index f0b48ff..f475334 100755
--- a/doc/TODO.txt
+++ b/doc/TODO.txt
@@ -54,14 +54,14 @@
 [ok] Ne pas effacer le message (dans le <input>) si l'on recoit un "pas ok" lors de l'envoie
 
 * Transfert des messages XML (AJAX) en https et le noter dans la faq (même la mafia chinoise ne peut pas sniffer les messages)
-* Problème d'utf-8 avec opera
+* Problème d'utf-8 avec opera
+   * Problème d'utf-8 avec firefox et konqueror (voir peut être du coté de <script charset="utf-8"...)
+* Tester avec des caractères exotiques (jap, coréen, etc..)
 * Utiliser une listbox pour la liste de css
-* Ralentir volontairement le connexion lors d'un mauvais login 
+* Ralentir volontairement le connexion lors d'un mauvais login (ou après n mauvais login)
 * Shift-enter pour ajouter une ligne dans la ligne de saisie (retour à la ligne)
-  * Crée un <br /> XHTML
+   * Crée un <br /> XHTML
 * réduire les pseudo trop long en mettant un ".." à la fin et permettre de le voir en entier lorsque le curseur le survol.
-* Problème d'utf-8 avec firefox et konqueror (voir peut être du coté de <script charset="utf-8"...)
-* Tester avec des caractères exotiques (jap, coréen, etc..)
 * Rendre compatible IE 7
 * Pouvoir switcher entre un affichage "pseudo" ou "pseudo (login)"
 * Faire une page faq et raconter n'importe quoi (entre autre la limitation avec firefox) "pourquoi ce site à des couleurs qui ne veulent rien dire ?"
@@ -80,21 +80,22 @@
    * "interrogation" genre http://forum-images.hardware.fr/icones/confused.gif
    * http://forum-images.hardware.fr/images/perso/dao.gif ou http://forum-images.hardware.fr/icones/redface.gif
    * http://forum-images.hardware.fr/icones/ohwell.gif
-* Cleaner le code et eventuellement profiler un peu (le refresh est lent sous opera)
+* Ajouter un skin "simple" sans images ni fioritures (éventuellement le proposer par défaut)
+* Cleaner le code (erl, js, xhtml, css) et eventuellement profiler un peu (le refresh est lent sous opera)
 * Gestion de l'historique au niveau du navigateur (pouvoir revenir aux pages précédentes)
 * Intégrer les totoz : http://www.totoz.eu/ (avec une limite de 3 par messages par exemple) 
    * avoir une option pour les cacher ou les voir
-   * Cacher systématiquement ceux qui dépassent d'une certaine taille
+   * Masquer systématiquement ceux qui dépassent d'une certaine taille (en pixel?)
    * modifier la syntaxe des smiles actuels (pour pas qu'ils entre en conflit avec totoz)
-* Mettre un icone (genre sablier) lorsque le chat se charge (lors changement d'un changement de page par exemple)
-* traitementComplet() de euphorik.js est très très lent à executer
-* gestin des timezone (fuseaux horaire)
+* Mettre un icone (genre sablier) lorsque le chat se charge (également lors d'un changement de page par exemple)
+* gestion des timezone (fuseaux horaire) :
+   * L'utilisateur peut simplement définit une timezone dans son profil, les 
 * Créer un style "super old school" (couleur 8 bit, pas de smiles/images, font fixe)
 * Un statut "EK" avec plein de privilège à la con. (avoir une petite étoile à coté de son nick ou le nick d'une certaine couleur)
 * Tests de monter en charge coté serveur, analyse de la complexité (regarder du coté des TODO dans le code)
 * Profiling pour améliorer les performances (client et serveur)
+   * traitementComplet() de euphorik.js est très très lent à executer
 * Traiter les tags TODO dans le code
-* Ajouter un skin "simple" sans images ni fioritures
 
 -- Bugs --
 1 : Critique
@@ -109,7 +110,7 @@
 
 [3] Amélioration des requêtes MNESIA, voir : http://mail.google.com/mail/#label/Erlang+mailing-list/117f688280569a58
 [2] Quand on revient en arrière dans firefox le message en rédaction est perdu
-[2] En changeant de page puis en revenant sur la page principale les smiles ne sont plus highlighté lorsque le curseur les survol
+[2] En changeant de page puis en revenant sur la page principale les smiles ne sont plus highlightés lorsque le curseur les survol
 [2] Après un register le pseudo est effacé - le pseudo n'est pas mémorisé dans le profil lors d'un envoie de mess en l'ayant changé
 [3] "Return" ne marche pas sous safari
 [1] Apparement les process liés aux connexions ne sont jamais terminé même quand l'utilisateur coupe la connexion à cause de minichat:attends_nouveau_messages()
@@ -135,17 +136,17 @@
    * Il est possible d'ouvrir plusieurs conversation
    * Les messages faisant partie des conversations ne sont plus visibles dans le flux général
    * (une colonne peut avoir le focus, dans ce cas on répond automatiquement à la dernière personne qui nous a répondu)
-   
 [1] Avoir un thème de discussion affiché en haut des messages genre appellé "troll de la semaine" : "troll de la semaine : linux sera-t-il desktop ready en 2008?"
 [2] Pouvoir cacher les dates
 [4] Pouvoir choisir une couleur pour son pseudo
 [3] Gestion de l'historique (calendrier)
 [4] Créer un gamebot pour lancer des jeux. Par exemple un jeu d'énigmes
-[4] Utiliser XMLRPC ou SOAP ou JSON pour la communication client -> serveur
+[4] Utiliser XMLRPC ou SOAP ou JSON pour la communication client -> serveur (boah, faut pas déconner :))
 [4] Image animée à la http://www.google.co.kr/ cf http://www.google.co.kr//ig/f/AaEyQnOaAr4/intl/ALL_kr/svc_sprite_all.gif
 [4] Bot de traduction
 [4] RSS
 [4] Voir les personnes connectées
+[4] Avoir une liste d'amis
 [4] Restreindre la consultation d'un message posté à un ou plusieurs utilisateurs définis. Les messages de la conversation ne sont alors vus que par cet ensemble d'utilisateurs.
 [4] Plusieurs canaux
 
diff --git a/modules/erl/euphorik_bd.erl b/modules/erl/euphorik_bd.erl
index 56a659a..49bb334 100755
--- a/modules/erl/euphorik_bd.erl
+++ b/modules/erl/euphorik_bd.erl
@@ -1,9 +1,13 @@
 % Module de création de la base de données euphorik.
-% Auteur : G.Burri
-% Date : 14.10.2007
+% @author G.Burri
 
 -module(euphorik_bd).
--export([create/0, create_tables/0, vers_version2/0, vers_version3/0, peupler/0, tester/0]).
+-export([
+   create/0,
+   create_tables/0,
+   vers_version/1,
+   peupler/0
+   ]).
 
 -include("../include/euphorik_bd.hrl").
 
@@ -43,7 +47,7 @@ create_tables() ->
    ]).
 
 
-vers_version2() ->
+vers_version(2) ->
    mnesia:transform_table(
       user,
       fun({user, Id, Cookie, Pseudo, Date_creation, Date_derniere_connexion, Css}) ->
@@ -52,8 +56,9 @@ vers_version2() ->
       record_info(fields, user),
       user
    ).
+
 
-vers_version3() ->
+vers_version(3) ->
    mnesia:transform_table(
       user,
       fun({user, Id, Cookie, Pseudo, Login, Password, Email, Date_creation, Date_derniere_connexion, Css}) ->
@@ -73,7 +78,4 @@ peupler() ->
       end
    ).
 
-
-tester() ->
-   ok.
 
diff --git a/modules/erl/euphorik_deamon.erl b/modules/erl/euphorik_deamon.erl
deleted file mode 100755
index a957475..0000000
--- a/modules/erl/euphorik_deamon.erl
+++ /dev/null
@@ -1,25 +0,0 @@
-% Module tournant en background s'occupant periodiquement de certaines tâches.
-% Auteur : G.Burri
-% Date : 05.11.2007
-
--module(euphorik_deamon).
--export([start/1]).
-
-% L'age max que peut avoir les fichier se trouvant dans le dossier 'tmp' (en second)
--define(AGE_MAX_TMP, 86400). % 24 heures
-
-% Démarre le démon
-start(A) ->
-   loop(A).
-
-
-loop(A) ->
-   verifier_tmp_captcha(),
-   timer:sleep(100000), %  attend 100 secondes
-   loop(A).
-
-
-% Vérifie le repertoire tmp où se trouve les captcha et efface les plus vieux.
-verifier_tmp_captcha() ->
-   ok.
-   
\ No newline at end of file
diff --git a/modules/erl/euphorik_minichat.erl b/modules/erl/euphorik_minichat.erl
index a507027..d45ca1c 100755
--- a/modules/erl/euphorik_minichat.erl
+++ b/modules/erl/euphorik_minichat.erl
@@ -2,8 +2,7 @@
 % Ce module permet de gérer les données persistantes lié au minichat d'euphorik.ch
 % Il permet d'ajouter des message, de demande les messages sur une page donnée, etc..
 % Ce module utilise la base mnesia créée par le module euphorik_bd.
-% Auteur : G.Burri
-% Date : 22.10.2007
+% @author G.Burri
 
 -module(euphorik_minichat).
 -export([
@@ -35,7 +34,8 @@
    nouveau_message/3,
    reset/0,
    % reservé :
-   resultat_transaction/1]).
+   resultat_transaction/1
+]).
 
 -include("../include/euphorik_bd.hrl").
 -include_lib("stdlib/include/qlc.hrl").
diff --git a/modules/erl/euphorik_minichat_conversation.erl b/modules/erl/euphorik_minichat_conversation.erl
index 0c762fb..57c48d6 100755
--- a/modules/erl/euphorik_minichat_conversation.erl
+++ b/modules/erl/euphorik_minichat_conversation.erl
@@ -2,10 +2,12 @@
 % Ce module permet la gestion des conversations du minichat d'euphorik.
 % Un message (enfant) peut répondre à des messages (ses parents).
 % Un message (parent) peut avoir plusieurs réponses (enfants)
-% Auteur : G.Burri
-% Date : 09.02.2008
+% @author G.Burri
 
--module(euphorik_minichat_conversation).
+-module(euphorik_minichat_conversation).
+-export([
+   conversations/4
+]).
 
 -include("euphorik_bd.hrl").
 -include_lib("stdlib/include/qlc.hrl").
@@ -14,7 +16,6 @@
 -import(euphorik_minichat, [resultat_transaction/1]).
 -import(qlc, [e/1, q/1, keysort/3]).
 -import(mnesia, [table/1, transaction/1]).
--export([conversations/4]).
   
    
 % Renvoie les conversations sous la forme d'une liste de conversation.
diff --git a/modules/erl/euphorik_protocole.erl b/modules/erl/euphorik_protocole.erl
index 99eb300..2f4a5a3 100755
--- a/modules/erl/euphorik_protocole.erl
+++ b/modules/erl/euphorik_protocole.erl
@@ -1,11 +1,10 @@
 % coding: utf-8
-% Ce module gére les différents message envoyé par le client (javascript)
+% Ce module gére les différents message envoyé par le client (javascript) via AJAX.
 % Par exemple le client peut demander les derniers messages du minichat.
 % Les messages sont au format XML, la plus part des fonctions accepte un xmlDocument() et renvoie un string()
 % qui est la réponse XML.
-% Example XML : http://www.erlang.org/doc/apps/xmerl/xmerl_ug.html
-% Auteur : G.Burri
-% Date : 29.10.2007
+% Example XML : http://www.erlang.org/doc/apps/xmerl/xmerl_ug.html.
+% @author G.Burri
 
 -module(euphorik_protocole).
 -export([
@@ -17,39 +16,43 @@
    profile/1,
    refreshMessage/1,
    message/1
-]).
+]).
+
 -include_lib("xmerl/include/xmerl.hrl").
 -include("../include/euphorik_bd.hrl").
 -include("../include/euphorik_defines.hrl").
 
 
-% Génère un nouveau captchat dans ?DOSSIER_CAPTCHA
-generation_captcha(_) ->
-   {Mot_crypt, Nom_fichier} = captcha:create(5, ?DOSSIER_CAPTCHA),
-   simple_xml_to_string(xml_reponse_generation_captcha(?DOSSIER_CAPTCHA_RELATIF "/" ++ Nom_fichier, Mot_crypt)).
+% Génère un nouveau captchat dans ?DOSSIER_CAPTCHA
+% Obsolète
+%~ generation_captcha(_) ->
+   %~ {Mot_crypt, Nom_fichier} = captcha:create(5, ?DOSSIER_CAPTCHA),
+   %~ simple_xml_to_string(xml_reponse_generation_captcha(?DOSSIER_CAPTCHA_RELATIF "/" ++ Nom_fichier, Mot_crypt)).
    
 
-% Un nouvel utilisateur doit être créé.
+% Un nouvel utilisateur doit être créé.
+% Obolète : le captcha n'existe plus
 % Action est un xmlElement().
-nouveau_user_captcha(Action) ->
-   simple_xml_to_string(
-      case {xmerl_xpath:string("captchaCrypt", Action), xmerl_xpath:string("captchaInput", Action)} of
-         {[#xmlElement{content = [#xmlText{value = C1}]}], [#xmlElement{content = [#xmlText{value = C2}]}]} ->
-            C2_crypt = common:crypt(C2),
-            if C1 =:= C2_crypt ->
-                  Cookie = generer_cookie(),
-                  User = euphorik_minichat:nouveau_user("Paul", Cookie),
-                  xml_reponse_login_ok(User);
-               true ->
-                  xml_reponse_login_pas_ok("Captcha incorrect")
-            end;
-         _ ->
-            xml_reponse_login_pas_ok("XML malformé")
-      end
-   ).
+%~ nouveau_user_captcha(Action) ->
+   %~ simple_xml_to_string(
+      %~ case {xmerl_xpath:string("captchaCrypt", Action), xmerl_xpath:string("captchaInput", Action)} of
+         %~ {[#xmlElement{content = [#xmlText{value = C1}]}], [#xmlElement{content = [#xmlText{value = C2}]}]} ->
+            %~ C2_crypt = common:crypt(C2),
+            %~ if C1 =:= C2_crypt ->
+                  %~ Cookie = generer_cookie(),
+                  %~ User = euphorik_minichat:nouveau_user("Paul", Cookie),
+                  %~ xml_reponse_login_ok(User);
+               %~ true ->
+                  %~ xml_reponse_login_pas_ok("Captcha incorrect")
+            %~ end;
+         %~ _ ->
+            %~ xml_reponse_login_pas_ok("XML malformé")
+      %~ end
+   %~ ).
    
    
-% Une utilisateur s'enregistre avec un tuple {Login, Password}.
+% Une utilisateur s'enregistre avec un tuple {Login, Password}.
+% @spec nouveau_user_login(xmerl:xmlElement()) -> string()
 nouveau_user_login(Action) ->
    {Login, Password, Login_deja_pris} = case {xmerl_xpath:string("login", Action), xmerl_xpath:string("password", Action)} of
       {[#xmlElement{content = [#xmlText{value = L}]}], [#xmlElement{content = [#xmlText{value = P}]}]} ->
@@ -359,14 +362,16 @@ xml_reponse_message(Ok) ->
          ]
       }
    ].
-   
-xml_reponse_generation_captcha(Chemin, Captcha) ->
-   [
-      {reponse, [{name, "generationCaptcha"}],
-         [
-            {chemin, [], [Chemin]},
-            {captchaCrypt, [], [Captcha]}
-         ]
-      }
-   ].
+
+
+% Obsolète
+%~ xml_reponse_generation_captcha(Chemin, Captcha) ->
+   %~ [
+      %~ {reponse, [{name, "generationCaptcha"}],
+         %~ [
+            %~ {chemin, [], [Chemin]},
+            %~ {captchaCrypt, [], [Captcha]}
+         %~ ]
+      %~ }
+   %~ ].
 %%%%%%%%% </réponses XML> %%%%%%%%%
diff --git a/modules/erl/euphorik_requests.erl b/modules/erl/euphorik_requests.erl
index 5b3a6d2..9cec43b 100755
--- a/modules/erl/euphorik_requests.erl
+++ b/modules/erl/euphorik_requests.erl
@@ -1,7 +1,8 @@
 % coding: utf-8
-% Ce module est fait pour répondre à des requêtes 'AJAX'.
-% Auteur : G.Burri
-% Date : 22.10.2007
+% Ce module est fait pour répondre à des requêtes 'AJAX'.
+% Il est définit comme 'appmods' pour l'url "request" dans yaws.
+% Par exemple http://www.euphorik.ch/request abouti sur la fonction out() de ce module.
+% @author G.Burri
 
 -module(euphorik_requests).
 -export([
@@ -58,12 +59,14 @@ traiter_xml(Contenu) ->
    traiter_action(XML#xmlElement.attributes, XML).
 
 
-% un client demande la génération d'un captcha
-traiter_action([#xmlAttribute{value="generationCaptcha"}], XML) ->
-   euphorik_protocole:generation_captcha(XML); 
-% un client se log pour la première fois
-traiter_action([#xmlAttribute{value="loginCaptcha"}], XML) ->
-   euphorik_protocole:nouveau_user_captcha(XML); 
+% un client demande la génération d'un captcha (obsolète)
+%~ traiter_action([#xmlAttribute{value="generationCaptcha"}], XML) ->
+   %~ euphorik_protocole:generation_captcha(XML); 
+% un client se log pour la première fois (obsolète)
+%~ traiter_action([#xmlAttribute{value="loginCaptcha"}], XML) ->
+   %~ euphorik_protocole:nouveau_user_captcha(XML); 
+   
+   
 % un client s'enregistre (pseudo + password)
 traiter_action([#xmlAttribute{value="register"}], XML) ->
    euphorik_protocole:nouveau_user_login(XML); 
@@ -73,10 +76,10 @@ traiter_action([#xmlAttribute{value="login"}], XML) ->
 % modification du profile
 traiter_action([#xmlAttribute{value="profile"}], XML) ->
    euphorik_protocole:profile(XML); 
-% le client désire les messages
+% un utilisateur demande les messages
 traiter_action([#xmlAttribute{value="refreshMessages"}], XML) ->
  euphorik_protocole:refreshMessage(XML); 
-% envoie d'un message
+% un utilisateur envoie un message
 traiter_action([#xmlAttribute{value="message"}], XML) ->
    euphorik_protocole:message(XML).
  
diff --git a/modules/erl/old/euphorik_deamon.erl b/modules/erl/old/euphorik_deamon.erl
new file mode 100755
index 0000000..a957475
--- /dev/null
+++ b/modules/erl/old/euphorik_deamon.erl
@@ -0,0 +1,25 @@
+% Module tournant en background s'occupant periodiquement de certaines tâches.
+% Auteur : G.Burri
+% Date : 05.11.2007
+
+-module(euphorik_deamon).
+-export([start/1]).
+
+% L'age max que peut avoir les fichier se trouvant dans le dossier 'tmp' (en second)
+-define(AGE_MAX_TMP, 86400). % 24 heures
+
+% Démarre le démon
+start(A) ->
+   loop(A).
+
+
+loop(A) ->
+   verifier_tmp_captcha(),
+   timer:sleep(100000), %  attend 100 secondes
+   loop(A).
+
+
+% Vérifie le repertoire tmp où se trouve les captcha et efface les plus vieux.
+verifier_tmp_captcha() ->
+   ok.
+   
\ No newline at end of file
diff --git a/modules/include/euphorik_bd.hrl b/modules/include/euphorik_bd.hrl
index 7ffeae4..e380034 100755
--- a/modules/include/euphorik_bd.hrl
+++ b/modules/include/euphorik_bd.hrl
@@ -1,5 +1,5 @@
-% Auteur : GBurri
-% Version 2
+% @author GBurri
+% Version 3
 
 % Pour générer des id
 -record(counter,
@@ -12,7 +12,7 @@
 -record(minichat,
    {
       id, % integer
-      auteur_id, % -> user.id
+      auteur_id, % -> #user.id
       date, % erlang:now()
       pseudo, % chaine de caractère
       contenu % chaine de caractère
@@ -23,8 +23,8 @@
 % 'repondant' repond à 'cible'
 -record(reponse_minichat,
    {
-      repondant, % -> minichat.id
-      cible % -> minichat.id
+      repondant, % -> #minichat.id
+      cible % -> #minichat.id
    }).