From 3d3bb0ea14b30705c2a26a1117374e6568ba59bb Mon Sep 17 00:00:00 2001 From: Greg Burri Date: Tue, 26 Feb 2008 11:35:38 +0000 Subject: [PATCH] =?utf8?q?ADD=20un=20README=20pour=20expliquer=20le=20proj?= =?utf8?q?et=20et=20ses=20fichiers/dossiers=20DEL=20le=20module=20de=20ges?= =?utf8?q?tion=20du=20captcha=20MOD=20mise=20=C3=A0=20jour=20de=20la=20doc?= =?utf8?q?=20d'installation?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- README | 70 +++++ doc/installation.txt | 67 +++-- modules/erl/minichat.erl | 445 ------------------------------ modules/erl/{ => old}/captcha.erl | 0 4 files changed, 118 insertions(+), 464 deletions(-) create mode 100644 README delete mode 100755 modules/erl/minichat.erl rename modules/erl/{ => old}/captcha.erl (100%) diff --git a/README b/README new file mode 100644 index 0000000..7f0a5e1 --- /dev/null +++ b/README @@ -0,0 +1,70 @@ +README - EUPHORIK +----------------- + +Ce document a pour but d'introduire le projet Euphorik, de décrire +sa strucure et son utilisation au niveau du développement et de son +utilisation. + + +-- Description -- +Euphorik est un site web communautaire développer en Erlang pour le serveur Yaws et utilisant la base de données Mnesia. + + +-- Installation +L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données +est décrit dans le fichier /doc/installation.txt. + + +-- Dossiers / Fichiers -- +/index.html + La page principale du site. Elle est statique. + +/mise_en_prod.rb + Script permettant la mise en production du site. + +/BD + Contient les fichiers lié à la base de données, initialement vide. + +/css + Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin. + +/css/common.css + La feuille de style + +/doc + Contient tous les documents de conception (fonctionnel, technique, etc.). + +/img + Contient les images du site avec un séparation des images propres à chaque skin. + Certaines images sont issues de document de conception se trouvant dans /doc/graphiques + +/js + Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js + +/lightbox + Lib JavaScript permettant d'afficher des images sous la forme de pop-up div. + +/modules + Contient la partie serveur. + +/modules/Makefile + Règle de compilation des modules du serveur. + +/modules/ebin + Contient les modules compilées, initialement vide. + +/module/erl + Contient le code sources des différents modules. + +/modules/include + Contient certaines définitions (headers). + +/pages + Contient certaines pages XHTML qui seront chargée via AJAX. + +/sessions + Contient différentes sessions de travail pour le développement avec Scite. + + + + \ No newline at end of file diff --git a/doc/installation.txt b/doc/installation.txt index 4190db1..bc70dae 100644 --- a/doc/installation.txt +++ b/doc/installation.txt @@ -1,4 +1,4 @@ --- Description de l'installation de euphorik -- +-- Description de l'installation de Euphorik -- Voici les différentes étapes décrivant l'installation du site euphorik. Certaines données sont a adaptées en fonction des besoins. L'installation est décrite pour le système d'exploitation Debian. @@ -9,25 +9,54 @@ Voici les diff 1. Installer Yaws - a) $apt-get install yaws + a) $apt-get install yaws 2. Configurer Yaws - a) Ajouter les lignes suivantes dans /etc/yaws/yaws.conf : - - "ebin_dir = /euphorik/modules/ebin" - - "include_dir = /euphorik/modules/include" - b) Le serveur virtuel est définit comme ceci dans /etc/yaws/conf.d/localhost.conf : - - port = 8081 - listen = 0.0.0.0 - docroot = /euphorik - allowed_scripts = [yaws] - appmods = - - c) Editer '/etc/init.d/yaws' et remplacer cette ligne : - script="$DAEMON -I $YAWS_ID $@" - par celle ci : - script="$DAEMON --erlarg \"-smp auto\" --sname yaws --mnesiadir '\"/euphorik/BD\"' -I $YAWS_ID $@" - FIXME : trouver une méthode plus élégante. + a) Ajouter les lignes suivantes dans /etc/yaws/yaws.conf : + - "ebin_dir = /euphorik/modules/ebin" + - "include_dir = /euphorik/modules/include" + b) Le serveur virtuel est définit comme ceci dans /etc/yaws/conf.d/localhost.conf : + + port = 8081 + listen = 0.0.0.0 + docroot = /euphorik + allowed_scripts = [yaws] + appmods = + + c) Editer '/etc/init.d/yaws' et remplacer cette ligne : + script="$DAEMON -I $YAWS_ID $@" + par celle ci : + script="$DAEMON --erlarg \"-smp auto\" --sname yaws --mnesiadir '\"/euphorik/BD\"' -I $YAWS_ID $@" + FIXME : trouver une méthode plus élégante. 3. Créer la base de donnée - TODO + a) Arreter Yaws (en root) : + $/etc/init.s/yaws stop + b) Lancer un noeud Erlang + - Se placer dans le répertoire /euphorik/modules/ebin + - Executer : + $erl -sname yaws -mnesia dir '"/euphorik/BD"' + c) Charger le module : + >l(euphorik_bd). + d) Créer la base : + >euphorik_bd:create(). + e) Démarrer Yaws (en root) : + $/etc/init.s/yaws start + +4. Administrer le site Euphorik + a) Connexion au noeud "yaws" + - Le cookie de Yaws (/var/run/yaws/.erlang.cookie ou /var/cache/yaws/.erlang.cookie) et celui de l'utilisateur courant (~/.erlang.cookie) doit être le même. + (si le cookie de yaws est modifié il faut relancer yaws). + - Se placer dans le répertoire /euphorik/modules/ebin + - Executer : + $erl -sname toto + où "toto" est le nom du noeud (tout sauf "yaws") + - Charger le module du minichat : + >l(euphorik_minichat) + - Se connecter au noeud yaws : + >euphorik_minichat:connect() + la valeur retournée doit être : {ok,[yaws@overnux]} + b) Utiliser les outils des modules + - Par exemple : + >euphorik_minichat:messages(10). + pour voir les 10 derniers messages diff --git a/modules/erl/minichat.erl b/modules/erl/minichat.erl deleted file mode 100755 index 2bc1017..0000000 --- a/modules/erl/minichat.erl +++ /dev/null @@ -1,445 +0,0 @@ -% coding: utf-8 -% 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 - --module(minichat). --export([ - connect/0, - % get : - messages/1, - messages/2, - messages/3, - conversation/2, - reponses/0, - repond_a/1, - get_nb_page/1, - users/0, - get_user_by_cookie/1, - get_user_by_id/1, - get_user_by_login/1, - get_user_by_login_password/2, - possede_message/2, - a_repondu_a_message/2, - est_une_reponse_a_user/2, - % set : - update_pseudo_user/2, - set_profile/6, - update_date_derniere_connexion/1, - nouveau_user/2, - nouveau_user/3, - nouveau_message/3, - % autre : - attends_nouveau_messages/0, - tester/0, - reset/0]). - --include("../include/euphorik_bd.hrl"). --include_lib("stdlib/include/qlc.hrl"). - -% Un message est considéré comme du spam s'il est posté 1 seconde ou moins après le dernier posté --define(DUREE_SPAM, 1000). % ms - -% Lorsque l'indice de spam d'un utilisateur atteind cette valeur alors il ne peut plus poster pendant un moment --define(INDICE_SPAM_MAX, 6). - -% Un utilisateur ayant trop spamé est bloqué pendant ce temps --define(DUREE_BLOCAGE_SPAM, 20000). % ms - - -% Quelques tests du modules. -tester() -> - aplu. - - -% Connexion à la base de données de yaws sur overnux -connect() -> - mnesia:start(), - mnesia:change_config(extra_db_nodes, [yaws@Plop]). - - -% Efface tous les users, minichat_reponse et minichat. -reset() -> - mnesia:clear_table(counter), - mnesia:clear_table(user), - mnesia:clear_table(reponse_minichat), - mnesia:clear_table(minichat), - % crée l'utilisateur root - mnesia:transaction(fun() -> - User = #user{id = 0, pseudo = "Sys", login = "Sys", date_creation = now(), date_derniere_connexion = now()}, - mnesia:write(User), - User - end). - - -% Est-ce qu'un utilisateur existe en fonction de son cookie ? -% Renvoie {ok, User} ou erreur -get_user_by_cookie(Cookie) -> - resultat_transaction(mnesia:transaction( - fun() -> - Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.cookie =:= Cookie])), - case Users of - [User] -> {ok, User}; - _ -> erreur - end - end - )). - - -get_user_by_id(ID) -> - resultat_transaction(mnesia:transaction( - fun() -> - Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.id =:= ID])), - case Users of - [User] -> {ok, User}; - _ -> erreur - end - end - )). - - -get_user_by_login(Login) -> - resultat_transaction(mnesia:transaction( - fun() -> - Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.login =:= Login])), - case Users of - [User] -> {ok, User}; - _ -> erreur - end - end - )). - - -get_user_by_login_password(Login, Password) -> - resultat_transaction(mnesia:transaction( - fun() -> - Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.login =:= Login, E#user.password =:= Password])), - case Users of - [User] -> {ok, User}; - _ -> erreur - end - end - )). - - -% Renvoie l'utilisateur root -get_root() -> - {ok, User} = get_user_by_id(0), - User. - - -% Est-ce que Id_user possède Id_mess ? -possede_message(Id_user, Id_mess) -> - case mnesia:transaction( - fun() -> - qlc:e(qlc:q([E#minichat.auteur_id || E <- mnesia:table(minichat), E#minichat.id =:= Id_mess])) - end - ) of - {atomic, [Id_user | []]} -> true; - _ -> false - end. - - -% Est-ce que Id_user à répondu au message Id_mess -a_repondu_a_message(Id_user, Id_mess) -> - case mnesia:transaction( - fun() -> - qlc:e(qlc:q([ - M#minichat.auteur_id || M <- mnesia:table(minichat), R <- mnesia:table(reponse_minichat), - R#reponse_minichat.cible =:= Id_mess, R#reponse_minichat.repondant =:= M#minichat.id, M#minichat.auteur_id =:= Id_user - ]), [{unique_all, true}]) - end - ) of - {atomic, [_]} -> true; - _ -> false - end. - - -% Est-ce que le message Id_mess est une réponse d'une message de Id_user ? -est_une_reponse_a_user(Id_user, Id_mess) -> - case mnesia:transaction( - fun() -> - qlc:e(qlc:q([ - M#minichat.auteur_id || M <- mnesia:table(minichat), R <- mnesia:table(reponse_minichat), - M#minichat.auteur_id =:= Id_user, M#minichat.id =:= R#reponse_minichat.cible, R#reponse_minichat.repondant =:= Id_mess - ]), [{unique_all, true}]) - end - ) of - {atomic, [_]} -> true; - _ -> false - end. - - -% Met à jour le pseudo du user -update_pseudo_user(UserId, Pseudo) -> - mnesia:transaction( - fun() -> - case mnesia:wread({user, UserId}) of - [User] when User#user.pseudo =/= Pseudo -> - mnesia:write(User#user{pseudo = Pseudo}); - _ -> - mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour") - end - end - ). - - -% Mise à par Cookie les autres peuvent être undefined ce qui veut dire qu'ils ne seront pas modifié. -set_profile(Cookie, Login, Password, Pseudo, Email, Css) -> - resultat_transaction(mnesia:transaction( - fun() -> - case get_user_by_cookie(Cookie) of - {ok, User} -> - case get_user_by_login(Login) of - {ok, U} when U#user.id =/= User#user.id -> - login_deja_pris; - _ -> - User_modifie = User#user{ - login = if is_list(Login) -> Login; true -> User#user.login end, - password = if is_list(Password) -> Password; true -> User#user.password end, - pseudo = if is_list(Pseudo) -> Pseudo; true -> User#user.pseudo end, - email = if is_list(Email) -> Email; true -> User#user.email end, - css = if is_list(Css) -> Css; true -> User#user.css end - }, - mnesia:write(User_modifie), - ok - end; - _ -> erreur - end - end - )). - - -% Met à jour la date de la dernière connexion d'un utilisateur à maintenant -update_date_derniere_connexion(UserId) -> - mnesia:transaction( - fun() -> - case mnesia:wread({user, UserId}) of - [User] -> - mnesia:write(User#user{date_derniere_connexion = now()}); - _ -> - mnesia:abort("update_date_derniere_connexion: User inconnu") - end - end - ). - - -% Ajoute un nouveau user et le renvoie -nouveau_user(Pseudo, Cookie) -> - F = fun() -> - Id = get_nouvel_id(user), - User = #user{id = Id, cookie = Cookie, pseudo = Pseudo, date_creation = now(), date_derniere_connexion = now()}, - mnesia:write(User), - User - end, - resultat_transaction(mnesia:transaction(F)). - - -% Ajoute un nouveau user et le renvoie -nouveau_user(Login, Password, Cookie) -> - F = fun() -> - Id = get_nouvel_id(user), - User = #user{id = Id, cookie = Cookie, pseudo = Login, login = Login, password = Password, date_creation = now(), date_derniere_connexion = now()}, - mnesia:write(User), - User - end, - resultat_transaction(mnesia:transaction(F)). - - -% Ajoute un message. Repond_A est une liste d'id auquel le message répond -% retourne soit l'id du message soit erreur. -nouveau_message(Mess, Auteur_id, Repond_A) -> - % regarde si les id 'Repond_A' existent - F = fun() -> - Nb_id_trouve = length(qlc:e(qlc:q([E#minichat.id || E <- mnesia:table(minichat), lists:member(E#minichat.id, Repond_A)]))), - % est-ce que l'auteur existe ? - Auteur = case qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.id =:= Auteur_id])) of - [A] -> A; - _ -> throw("L'auteur du message est introuvable") - end, - if Nb_id_trouve =/= length(Repond_A) -> throw("Un ou plusieurs messages introuvable"); - true -> ok - end, - Id = get_nouvel_id(minichat), - % compare les dernière - Delta = delta_date_ms(Auteur#user.date_derniere_connexion, now()), - Nouvel_indice_flood = Auteur#user.indice_flood + if Delta =< ?DUREE_SPAM -> 2; true -> -1 end, - Auteur_maj = Auteur#user{ - indice_flood = if Nouvel_indice_flood > ?INDICE_SPAM_MAX -> ?INDICE_SPAM_MAX; Nouvel_indice_flood < 0 -> 0; true -> Nouvel_indice_flood end, - date_derniere_connexion = now() - }, - % est-ce que l'auteur à trop floodé ? - if Auteur#user.indice_flood =/= ?INDICE_SPAM_MAX, Auteur_maj#user.indice_flood =:= ?INDICE_SPAM_MAX, Delta =< ?DUREE_BLOCAGE_SPAM -> - Root = get_root(), - mnesia:write(Auteur#user{indice_flood = Auteur_maj#user.indice_flood}), - mnesia:write(#minichat{id=Id, auteur_id=Root#user.id, date=now(), pseudo=Root#user.pseudo, contenu=Auteur#user.pseudo ++ "(" ++ Auteur#user.login ++ ") est bloqué pour " ++ integer_to_list(trunc(?DUREE_BLOCAGE_SPAM / 1000)) ++ " secondes pour cause de flood.."}), - Id; - Auteur#user.indice_flood =:= ?INDICE_SPAM_MAX, Delta =< ?DUREE_BLOCAGE_SPAM -> - erreur; - true -> - mnesia:write(Auteur_maj), - inserer_reponses(Id, Repond_A), - mnesia:write(#minichat{id=Id, auteur_id=Auteur#user.id, date=now(), pseudo=Auteur#user.pseudo, contenu=Mess}), - Id - end - end, - resultat_transaction(mnesia:transaction(F)). - - -% Retourne la difference entre deux timestamp (erlang:now()) en miliseconde -delta_date_ms(D1, D2) -> - 1000000000 * abs(element(1, D1) - element(1, D2)) + 1000 * abs(element(2, D1) - element(2, D2)) + trunc(abs(element(3, D1) - element(3, D2)) / 1000). - - -% Définit Id_repondant comme étant la réponse à Ids. Ids est une liste d'id. -inserer_reponses(Id_repondant, [Id_mess | Reste]) -> - mnesia:write(#reponse_minichat{repondant = Id_repondant, cible = Id_mess}), - inserer_reponses(Id_repondant, Reste); -inserer_reponses(_, []) -> - ok. - - -% Renvoie un nouvel id pour une table donnée -get_nouvel_id(Table) -> - mnesia:dirty_update_counter(counter, Table, 1). - - -% Attend qu'au moins un nouveau message arrive, function bloquante. -attends_nouveau_messages() -> - case mnesia:subscribe({table, minichat, simple}) of - {error, _} = E -> E; - _ -> - %{ok, F} = file:open("/tmp/log_euphorik_" ++ pid_to_list(self()) ++ ".txt", [write]), - %io:format(F, "Test2~n", []), - attends_nouveau_messages2() - end. -attends_nouveau_messages2() -> - %io:format(F, "En attente d'un message !~n", []), - receive % attente d'un post - {mnesia_table_event, {write, _, _}} -> - mnesia:unsubscribe({table, minichat, simple}); - %io:format(F, "Debloquage !~n", []), - %file:close(F); - %~ {tcp_closed, _} -> - %~ mnesia:unsubscribe({table, minichat, simple}); - _ -> - %io:format(F, "~p~n", [M]), - attends_nouveau_messages2() - % 60 minutes de timeout (le cas ou il n'y a que des consultations et jamais de post) - % Après 60 minutes de connexion, le client doit donc reétablir une connexion - % TODO : pour être mieux : quand le socket se ferme alors un message devrait être envoyé et débloquer ce receive (demande en cours sur la mailing list de yaws) - after 1000 * 60 * 60 -> - mnesia:unsubscribe({table, minichat, simple}) - end. - - -% Renvoie les messages manquants pour la page P en sachant qu'il y a N message -% par page et que le dernier message que l'on possède est Id -messages(Id, N, P) -> - lists:filter(fun (M) -> M#minichat.id > Id end, messages(N, P)). - - -% Renvoie N messages se trouvant sur la page P -messages(N, P) -> - F = fun() -> - C = qlc:cursor(qlc:q([E || E <- qlc:keysort(2, mnesia:table(minichat), [{order, descending}])])), - if P > 1 -> qlc:next_answers(C, N * (P - 1)); - true -> ok - end, - R = qlc:next_answers(C, N), - qlc:delete_cursor(C), - lists:reverse(R) - end, - resultat_transaction(mnesia:transaction(F)). - - -% Renvoie N messages se trouvant sur la première page -messages(N) -> - messages(N, 1). - - -% Renvoie les messages auquels répond M. M est l'id du message. -% La réponse est sous la forme d'un arbre, par exemple : {M, [{3, [{1, []}]},{4, []}]} -% ce qui signifie : M répond à 3 et à 4, 3 répond à 1. -% N est le nombre de message sur une page -conversation(M, N) -> - P = page(M, N), - {M, get_liste_cibles(M, N, P)}. - - -% Renvoie la liste des cibles d'un message M, c'est à dire des messages auquel M répond. N étant le nombre de message par page et -% P la page à laquelle se limite la recherche. -% Voir 'conversation/2' pour plus de détail sur la structure retournée. -get_liste_cibles(M, N, P) -> - resultat_transaction(mnesia:transaction(fun() -> - Cibles = qlc:e(qlc:q([E#reponse_minichat.cible || E <- mnesia:table(reponse_minichat), E#reponse_minichat.repondant =:= M])), - lists:foldl( - fun(E, A) -> - PageE = page(E, N), - if PageE =:= P -> % si E fait partit de la page de l'élément de base alors on le prend - [{E, get_liste_cibles(E, N, P)}| A]; - true -> - A - end - end, [], Cibles) - end)). - - -% Renvoie le nombre de page total en fonction du nombre de message par page N -% TODO : ya pas un moyen moins pourri pour avoir le nombre de record d'une table ? -get_nb_page(N) -> - resultat_transaction(mnesia:transaction(fun() -> - ceiling(length(qlc:e(qlc:q([E#minichat.id || E <- mnesia:table(minichat)]))) / N) - end)). - - -% Renvoie le numéro de la page sur lequel se trouve le message M en sachant qu'il y a N messages par page. -page(M, N) -> - resultat_transaction(mnesia:transaction(fun() -> - ceiling((length(qlc:e(qlc:q([E || E <- mnesia:table(minichat), E#minichat.id >= M])))) / N) - end)). - - -% Bizarre, cette fonction n'existe pas dans la stdlib. -ceiling(X) -> - T = trunc(X), - case (X - T) of - Neg when Neg < 0 -> T; - Pos when Pos > 0 -> T + 1; - _ -> T - end. - - -% Renvoie tous les users. -users() -> - resultat_transaction(mnesia:transaction(fun() -> - qlc:e(qlc:q([E || E <- mnesia:table(user)])) - end)). - - -% Renvoie les reponses (utilisé normalement uniquement pendant le debug). -reponses() -> - F = fun() -> - qlc:e(qlc:q([E || E <- mnesia:table(reponse_minichat)])) - end, - resultat_transaction(mnesia:transaction(F)). - -% Renvoie les messages auquel M_id répond. -repond_a(M_id) -> - resultat_transaction(mnesia:transaction( - fun() -> - qlc:e(qlc:q( - [M || E <- mnesia:table(reponse_minichat), - M <- mnesia:table(minichat), - E#reponse_minichat.repondant =:= M_id, - M#minichat.id =:= E#reponse_minichat.cible])) - end - )). - - -% Renvoie le résultat d'une transaction (en décomposant le tuple fournit) -resultat_transaction({_, T}) -> - T. - \ No newline at end of file diff --git a/modules/erl/captcha.erl b/modules/erl/old/captcha.erl similarity index 100% rename from modules/erl/captcha.erl rename to modules/erl/old/captcha.erl -- 2.45.2