== TODO ==\r
\r
-[50%] Conversations : \r
+=== v1.0 ===\r
+[70%] Conversations : \r
[ok] implémenter coté serveur et client la sauvegarde et la restauration des conversations\r
[ok] Supprimer l'envoie de la description des conversations lors du refresh ainsi que modifié la manière de créer les conversations (maj des diagrammes de séquence)\r
- * Navigation vers les pages précédentes\r
+ [ok] Navigation vers les pages précédentes\r
* Mettre à jour l'HTML/CSS de chaque skin\r
- * Url vers conversation(s) + également un bouton sur chaque conversation pour obtenir l'url vers celle ci\r
* Lien vers une conversation dans les messages sou s cette forme {5F}. Le clic dessus ouvre la conversation. Egalement un bouton sur chaque conversation pour insérer son lien dans le message en cours de rédaction\r
+* Remplacer l'XML par du JSON. gain en simplicité et en temps d'execution. Légère modification du potocole : passage \r
+ * Tester sur un prototype : l'authentification\r
+ * Si concluant passage complet à JSON\r
+ * Les id ne sont plus passés en base 36\r
+* Passage du code en anglais (sauf commentaire)\r
* Utiliser une listbox pour la liste des css\r
+* Avoir un thème de discussion affiché en haut des messages genre appellé "troll de la semaine : linux sera-t-il desktop ready en 2008?"\r
+* 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 ?"\r
* Ralentir volontairement le connexion lors d'un mauvais login (ou après n mauvais login)\r
* Pouvoir switcher entre un affichage "pseudo" ou "pseudo (login)"\r
* réduire les pseudo trop long en mettant un ".." à la fin et permettre de le voir en entier lorsque le curseur le survol.\r
-* Problème d'utf-8 avec opera, firefox et konqueror, le prologue (<?xml charset="utf8"...) n'est pas supporté par certains navigateur\r
-* Transfert des messages XML (AJAX) en https et le noter dans la faq (même la mafia chinoise ne peut pas sniffer les messages)\r
+* Mettre un icone (genre sablier) lorsque le chat se charge (également lors d'un changement de page par exemple)\r
* Tester avec des caractères exotiques (jap, coréen, etc..)\r
-* Shift-enter pour ajouter une ligne dans la ligne de saisie (retour à la ligne)\r
- * Crée un <br /> XHTML\r
- * A chaque Shift-enter la textbox s'agrandit d'une ligne\r
* Rendre compatible IE 7\r
-* 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 ?"\r
* Créer un favicon (joli)\r
-* Système de commande /<commande>\r
- * /nick : changer de pseudo\r
- * /me : "*<pseudo> <message>"\r
- * /blam <login> : permet d'envoyer un blame à qqun (uniquement depuis un modo vers un non-modo) \r
- * /+ blabla Pourvoir ajouter du texte (correctif en général) à son dernier message par une commande. Le texte ajouté est mise en évidence. Ceci peut être fait plusieurs fois.\r
-* Ajouter de nouveaux smiles :\r
+* Ajouter dans la FAQ et/ou dans la page d'enregistrement les conditions d'utilisation, genre "chacun est responsable de ses dires" https://linuxfr.org/bouchot/\r
+* Inscrire le nom de l'image dans les les liens vers des images (à la place de simplement [jpg] ou [gif])\r
+* Ajouter de nouveaux smiles et changer la syntax pour eviter le conflit avec totoz :\r
* "slurp" : http://forum-images.hardware.fr/images/perso/huit.gif\r
* "agreed" : http://forum-images.hardware.fr/icones/smilies/jap.gif\r
* "dodo" (tete avec un bonnet de nuit et des ZZZZ)\r
* "interrogation" genre http://forum-images.hardware.fr/icones/confused.gif\r
* http://forum-images.hardware.fr/images/perso/dao.gif ou http://forum-images.hardware.fr/icones/redface.gif\r
* http://forum-images.hardware.fr/icones/ohwell.gif\r
-* Ajouter un skin "simple" sans images ni fioritures (éventuellement le proposer par défaut)\r
+* 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)\r
+* Finir le script de mise en production\r
+ * Compatage des js lors de la mise en production (afin d'optimiser la bande passante lors de l'accès au site), regarder comment fait jQuery.\r
+* Traiter les tags TODO et FIXME dans le code\r
* Cleaner le code (erl, js, xhtml, css) et eventuellement profiler un peu (le refresh est lent sous opera)\r
-* Gestion de l'historique au niveau du navigateur (pouvoir revenir aux pages précédentes)\r
+* Restructurer le code Erlang : déplacer certaines fonctions d'un module à l'autre (ev. créer des modules)\r
+* Choisir une licence et la mettre un peu partout dans les sources\r
+* Créer une page 'about'\r
+=== v1.1 ===\r
+* Tests de monter en charge coté serveur, analyse de la complexité (regarder du coté des TODO dans le code). Utiliser eventuellement Tsung\r
+* Profiling pour améliorer les performances (client et serveur)\r
+ * traitementComplet() de euphorik.js est très très lent à executer\r
+* Pouvoir récupérer son mdp (ou en générer un autre) via son email\r
+=== v1.2 ===\r
* Intégrer les totoz : http://www.totoz.eu/ (avec une limite de 3 par messages par exemple) \r
* avoir une option pour les cacher ou les voir\r
* Masquer systématiquement ceux qui dépassent d'une certaine taille (en pixel?)\r
* modifier la syntaxe des smiles actuels (pour pas qu'ils entre en conflit avec totoz)\r
-* Mettre un icone (genre sablier) lorsque le chat se charge (également lors d'un changement de page par exemple)\r
-* gestion des timezone (fuseaux horaire) :\r
- * L'utilisateur peut simplement définit une timezone dans son profil, les dates sont alors affichées en fonction de sa zone (en option)\r
+=== V1.3 ===\r
+* Shift-enter pour ajouter une ligne dans la ligne de saisie (retour à la ligne)\r
+ * Crée un <br /> XHTML (lf -> br coté client)\r
+ * A chaque Shift-enter la textbox s'agrandit d'une ligne\r
+* Système de commande /<commande>\r
+ * /nick : changer de pseudo\r
+ * /me : "*<pseudo> <message>"\r
+ * /blam <login> : permet d'envoyer un blame à qqun (uniquement depuis un modo vers un non-modo) \r
+ * /+ blabla Pourvoir ajouter du texte (correctif en général) à son dernier message par une commande. Le texte ajouté est mise en évidence. Ceci peut être fait plusieurs fois.\r
+=== V1.4 ===\r
+* Elaborer une stratégie de mise à jour de la structure de la BD quand celle ci est modifiée (voir euphorik_bd:vers_version()) \r
+* Ajouter un skin "simple" sans images ni fioritures (éventuellement le proposer par défaut)\r
* Créer un style "super old school" (couleur 8 bit, pas de smiles/images, font fixe)\r
-* 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)\r
-* Tests de monter en charge coté serveur, analyse de la complexité (regarder du coté des TODO dans le code). Utiliser eventuellement Tsung\r
-* Profiling pour améliorer les performances (client et serveur)\r
- * traitementComplet() de euphorik.js est très très lent à executer\r
-* Traiter les tags TODO dans le code\r
-* Compatage des js lors de la mise en production (afin d'optimiser la bande passante lors de l'accès au site), regarder comment fait jQuery.\r
-* Elaborer une stratégie de mise à jour de la structure de la BD quand celle ci est modifiée (voir euphorik_bd:vers_version())\r
-* Inscrire le nom de l'image dans les les liens vers des images (à la place de simplement [jpg] ou [gif])\r
-* Ajouter dans la FAQ et/ou dans la page d'enregistrement les conditions d'utilisation, genre "chacun est responsable de ses dires" https://linuxfr.org/bouchot/\r
-* Choisir une licence et la mettre un peu partout dans les sources\r
-* Restructurer le code Erlang : déplacer certaines fonctions d'un module à l'autre (ev. créer des modules)\r
+=== V1.5 ===\r
+* Gestion de l'historique au niveau du navigateur (pouvoir revenir aux pages précédentes). Utiliser un plugin jQuery si possible.\r
+* gestion des timezone (fuseaux horaire) :\r
+ * L'utilisateur peut simplement définir une timezone dans son profil, les dates sont alors affichées en fonction de sa zone (en option)\r
+* Transfert des messages XML (AJAX) en https et le noter dans la faq (même la mafia chinoise ne peut pas sniffer les messages). En fait il suffit (sauf erreur) de sécuriser euphorik : https://www.euphorik.ch\r
+* Conversations : url vers conversation(s) + également un bouton sur chaque conversation pour obtenir l'url vers celle ci. (genre google map)\r
+\r
[ok] Réaliser la structure suivante :
* Table minichat : {id, auteur_id, date, pseudo, contenu, reponses_minichat_id} reponses_minichat_id peut être null
1 : Critique
2 : Urgent
3 : Peu grave\r
-
+\r
+[1] Problème d'utf-8 avec opera, firefox et konqueror, le prologue (<?xml charset="utf8"...) n'est pas supporté par certains navigateur
[1] Lors de l'extraction d'une conv il arrive que la conv extracté soit bien créée mais vide, le bouton ne ferme pas la conv (très étrange, bug de firefox?)
[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és lorsque le curseur les survol\r
[ok] 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()\r
-=== Idées ===
+=== Idées ===\r
+Une fois l'idée validée elle est déplacée dans une version à venir.\r
+
1 : A implémenter tout de suite !
2 : A implémenter dans un futur proche
3 : Ca peut attendre
* Chaque colonne possède une entête avec le message d'origine et trois boutons :
* un pour copier l'id de la conversation dans la textbox (voir point suivant)
* un pour fermer la conversation
- * un pour créer une url vers cette conversation (un peu à la manière de google maps)\r
-[1] Avoir un thème de discussion affiché en haut des messages genre appellé "troll de la semaine : linux sera-t-il desktop ready en 2008?"
-[2] Pouvoir insérer des tags qui sont des liens vers des conversations, par exemple : {R4S} =~ /\{\w+\}/
-[2] Raccourcis pour répondre à des messages (genre CTRL+2 pour répondre au deuxième)
-[2] Pouvoir récupérer son mdp (ou en générer un autre) via son email\r
+ * un pour créer une url vers cette conversation (un peu à la manière de google maps)
+[2] Raccourcis pour répondre aux conversations (genre CTRL+2 pour répondre au deuxième)\r
[2] Syntaxe avancée des messagees :\r
* Possibilité d'utiliser les balises <i>, <b>, <code>, <q> (quoted text)
* La balise <hide> pour mettre des spoilers
[4] Plusieurs canaux\r
\r
[A] smiles personnalisés, on peut en ajouter dans la préférence utilisateur.
+[ok] Pouvoir insérer des tags qui sont des liens vers des conversations, par exemple : {R4S} =~ /\{\w+\}/
=== Concurrents ===
--- /dev/null
+Euphorik - Protocole v3
+-----------------------
+
+A. Introduction
+---------------\r
+
+Ce document a pour but de décrire la communication client-serveur du site euphorik.\r
+Les messages échangés sont basés sur le format JSON.
+Ce document remplace 'protocole2.txt'.
+\r
+
+B. Principe
+-----------
+
+Enregistrement:\r
+ * 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.
+
+Authentification:\r
+ * L'authentification (login) se fait soit par un couple <login, mot de passe> soit à l'aide d'un cookie.\r
+ * Permet de récupérer les données d'un profile
+
+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 est envoie le ou les messages manquants.
+
+
+C. Protocole
+------------
+c : client
+s : server
+Les messages client vers serveur sont envoyé par HTTP-POST
+
+
+C.1. Login
+----------
+Le mot de passe est hashé en md5.\r
+
+c -> s\r
+ { \r
+ "action" : "authentification",\r
+ "login" : "Paul",\r
+ "password" : "IJKJDHHSAD9081238"\r
+ }
+ou\r
+ {\r
+ "action" : "authentification",\r
+ "cookie" : "LKJDLAKSJBFLKASN"\r
+ }
+ou\r
+ {\r
+ "action" : "register",\r
+ "login" : "Paul",\r
+ "password" : "IJKJDHHSAD9081238"\r
+ }
+
+s -> c\r
+ {\r
+ "reply" : "login",\r
+ "status" : "registration_ok" | "authentification_ok" | "error",\r
+ "cookie" : "LKJDLAKSJBFLKASN",\r
+ "id" : 193,\r
+ "pseudo" : "Paul",\r
+ "login" : "paul49",\r
+ "email" : "paul@pierre.com",\r
+ "css" : "css/3/euphorik.css",\r
+ "main_page" : 1,\r
+ "conversations" : [\r
+ {\r
+ "racine" : 123,\r
+ "page" : 1\r
+ }\r
+ ],\r
+ "error_message" : "blabla"\r
+ }
+ \r
+
+C.2. Logout
+-----------
+c -> s\r
+ {\r
+ "action" : "logout",\r
+ "cookie" : "LKJDLAKSJBFLKASN"\r
+ }
+ \r
+
+C.3. Profile
+------------
+Modification du profile, seul "cookie" est obligatoire.
+
+c -> s\r
+ {\r
+ "action" : "set_profile",\r
+ "cookie" : "LKJDLAKSJBFLKASN",\r
+ "login" : "paul49",\r
+ "password" : "IJKJDHHSAD9081238",\r
+ "pseudo" : "Paul",\r
+ "email" : "paul@pierre.com",\r
+ "css" : "css/3/euphorik.css",\r
+ "mainPage" : "1",\r
+ "conversations" : [\r
+ {\r
+ "racine" : "4F",\r
+ "page" : 1\r
+ }\r
+ ],\r
+ } \r
+
+s -> c\r
+ {\r
+ "reply" : "ok" | "error",\r
+ "error_message" : "blabla"\r
+ }
+
+
+C.4. Wait event
+---------------------
+Si "last_message_id" est absent alors le client ne possède pas de message.
+Les conversations données sont définies dans le profile.
+
+c -> s\r
+ {\r
+ "action" : "wait_event",\r
+ "cookie" : "LKJDLAKSJBFLKASN",\r
+ "message_count" : 10,\r
+ "last_message_id" : 163\r
+ }
+
+s -> c\r
+La première conversation est la principale (main).\r
+L'ordre des conversation est le même que celui des données de l'utilisateur.\r
+Le format de la date n'est pas formel.\r
+ {\r
+ "reply" : "new_messages",\r
+ "conversations" : [\r
+ "last_page" : true | false,\r
+ "messages" : [\r
+ "id" : 54,\r
+ "date" : "Hier 17:26:54",\r
+ "system" : true | false,\r
+ "owner" : true | false,\r
+ "answered" : true | false,\r
+ "is_a_reply" : true | false,\r
+ "nick" : "Paul",\r
+ "login" : "paul_22",\r
+ "content" : "Salut",\r
+ "answer_to" : [\r
+ { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }\r
+ ]\r
+ ]\r
+ ]\r
+ }
+ou\r
+ {\r
+ "reply" : "message_updated",\r
+ "message_id" : 123,\r
+ "contenu" : "Salut +++ poulpe"\r
+ }
+ou\r
+ {\r
+ "reply" : "error",\r
+ "error_message" : "blabla"\r
+ }
+
+
+C.5. Envoie message
+-------------------
+Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
+"answer_to" n'est pas obligatoire.\r
+
+c -> s\r
+ {\r
+ "action" : "put_message",\r
+ "cookie" : "LKJDLAKSJBFLKASN",\r
+ "nick" : "Paul",\r
+ "content" : "Bonjour",\r
+ "answer_to" : [ 345, 532, ... ]\r
+ }
+
+s -> c\r
+ {\r
+ "reply" : "ok" | "error",\r
+ "error_message" : "blabla"\r
+ }
+ \r
+ \r
+C.6 Ajout d'une correction d'un messages\r
+----------------------------------------\r
+Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
+Le message est appondu avec un " +++ " devant, par exemple :\r
+> Gnome c'est mieux que KDE +++ Euh non ok, c'est faux\r
+\r
+c -> s\r
+ {\r
+ "action" : "correction",\r
+ "cookie" : "LKJDLAKSJBFLKASN",\r
+ "content" : "Euh non ok, c'est faux"\r
+ }\r
+ \r
+s -> c\r
+ {\r
+ "reply" : "correction",\r
+ "status" : "ok" | "error",\r
+ "message_error" : "blabla"\r
+ }
projects / euphorik.git / commitdiff