ADD un README pour expliquer le projet et ses fichiers/dossiers
[euphorik.git] / modules / erl / minichat.erl
diff --git a/modules/erl/minichat.erl b/modules/erl/minichat.erl
deleted file mode 100755 (executable)
index 2bc1017..0000000
+++ /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).\r
--export([
-   connect/0,   
-   % get :
-   messages/1,
-   messages/2,\r
-   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,   \r
-   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 :\r
-   update_pseudo_user/2,
-   set_profile/6,
-   update_date_derniere_connexion/1,
-   nouveau_user/2,
-   nouveau_user/3,
-   nouveau_message/3,
-   % autre :\r
-   attends_nouveau_messages/0,
-   tester/0,
-   reset/0]).\r
-\r
--include("../include/euphorik_bd.hrl").\r
--include_lib("stdlib/include/qlc.hrl").\r
-
-% 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
-\r
-\r
-% Quelques tests du modules.\r
-tester() ->
-   aplu.\r
-   
-
-% 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.\r
-reset() ->\r
-   mnesia:clear_table(counter),\r
-   mnesia:clear_table(user),\r
-   mnesia:clear_table(reponse_minichat),\r
-   mnesia:clear_table(minichat),\r
-   % crée l'utilisateur root\r
-   mnesia:transaction(fun() ->\r
-      User = #user{id = 0, pseudo = "Sys", login = "Sys", date_creation = now(), date_derniere_connexion = now()},\r
-      mnesia:write(User),\r
-      User\r
-   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
-   )).
-   \r
-   \r
-get_user_by_login(Login) ->\r
-   resultat_transaction(mnesia:transaction(\r
-      fun() ->\r
-         Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.login =:= Login])),\r
-         case Users of\r
-            [User] -> {ok, User};\r
-            _ -> erreur\r
-         end\r
-      end\r
-   )).\r
-   
-   
-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
-   )).\r
-   \r
-   \r
-% Renvoie l'utilisateur root\r
-get_root() ->\r
-   {ok, User} = get_user_by_id(0),\r
-   User.
-   
-   \r
-% 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.
-   
-   \r
-% Met à jour le pseudo du user\r
-update_pseudo_user(UserId, Pseudo) ->\r
-   mnesia:transaction(\r
-      fun() ->      \r
-         case mnesia:wread({user, UserId}) of\r
-            [User] when User#user.pseudo =/= Pseudo ->\r
-               mnesia:write(User#user{pseudo = Pseudo});\r
-            _ ->\r
-               mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour")\r
-          end\r
-      end\r
-   ).
-   
-   
-% Mise à par Cookie les autres peuvent être undefined ce qui veut dire qu'ils ne seront pas modifié.\r
-set_profile(Cookie, Login, Password, Pseudo, Email, Css) ->
-   resultat_transaction(mnesia:transaction(
-      fun() ->
-         case get_user_by_cookie(Cookie) of
-            {ok, User} ->               \r
-               case get_user_by_login(Login) of\r
-                  {ok, U} when U#user.id =/= User#user.id ->\r
-                     login_deja_pris;\r
-                  _ ->               \r
-                     User_modifie = User#user{\r
-                        login = if is_list(Login) -> Login; true -> User#user.login end,\r
-                        password = if is_list(Password) -> Password; true -> User#user.password end,\r
-                        pseudo = if is_list(Pseudo) -> Pseudo; true -> User#user.pseudo end,\r
-                        email = if is_list(Email) -> Email; true -> User#user.email end,\r
-                        css = if is_list(Css) -> Css; true -> User#user.css end\r
-                     },\r
-                     mnesia:write(User_modifie),\r
-                     ok\r
-               end;
-            _ -> erreur
-         end
-      end
-   )).
-   
-
-% Met à jour la date de la dernière connexion d'un utilisateur à maintenant
-update_date_derniere_connexion(UserId) ->\r
-   mnesia:transaction(\r
-      fun() ->\r
-         case mnesia:wread({user, UserId}) of\r
-            [User] ->\r
-               mnesia:write(User#user{date_derniere_connexion = now()});\r
-            _ ->\r
-               mnesia:abort("update_date_derniere_connexion: User inconnu")\r
-          end\r
-      end\r
-   ).   
-   \r
-
-% Ajoute un nouveau user et le renvoie\r
-nouveau_user(Pseudo, Cookie) ->\r
-   F = fun() ->\r
-      Id = get_nouvel_id(user),
-      User = #user{id = Id, cookie = Cookie, pseudo = Pseudo, date_creation = now(), date_derniere_connexion = now()},\r
-      mnesia:write(User),\r
-      User\r
-   end,\r
-  resultat_transaction(mnesia:transaction(F)).\r
-
-
-% 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)).
-  \r
-\r
-% Ajoute un message. Repond_A est une liste d'id auquel le message répond
-% retourne soit l'id du message soit erreur.\r
-nouveau_message(Mess, Auteur_id, Repond_A) ->\r
-   % regarde si les id 'Repond_A' existent\r
-   F = fun() ->   \r
-      Nb_id_trouve = length(qlc:e(qlc:q([E#minichat.id || E <- mnesia:table(minichat), lists:member(E#minichat.id, Repond_A)]))),\r
-      % est-ce que l'auteur existe ?\r
-      Auteur = case qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.id =:= Auteur_id])) of\r
-         [A] -> A;\r
-         _ -> throw("L'auteur du message est introuvable")\r
-      end,
-      if Nb_id_trouve =/= length(Repond_A) -> throw("Un ou plusieurs messages introuvable");
-         true -> ok
-      end,\r
-      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 ->\r
-         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\r
-   end,\r
-   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).
-\r
-\r
-% Définit Id_repondant comme étant la réponse à Ids. Ids est une liste d'id.\r
-inserer_reponses(Id_repondant, [Id_mess | Reste]) ->\r
-   mnesia:write(#reponse_minichat{repondant = Id_repondant, cible = Id_mess}),\r
-   inserer_reponses(Id_repondant, Reste);\r
-inserer_reponses(_, []) ->\r
-   ok.
-   \r
-
-% Renvoie un nouvel id pour une table donnée\r
-get_nouvel_id(Table) ->\r
-   mnesia:dirty_update_counter(counter, Table, 1).\r
-   
-
-% Attend qu'au moins un nouveau message arrive, function bloquante.\r
-attends_nouveau_messages() ->
-   case mnesia:subscribe({table, minichat, simple}) of 
-      {error, _} = E -> E;
-      _ ->\r
-         %{ok, F} = file:open("/tmp/log_euphorik_" ++  pid_to_list(self()) ++ ".txt", [write]),\r
-         %io:format(F, "Test2~n", []),\r
-         attends_nouveau_messages2()
-   end.
-attends_nouveau_messages2() ->\r
-   %io:format(F, "En attente d'un message !~n", []),
-   receive % attente d'un post
-      {mnesia_table_event, {write, _, _}} ->
-         mnesia:unsubscribe({table, minichat, simple});\r
-         %io:format(F, "Debloquage !~n", []),\r
-         %file:close(F);\r
-      %~ {tcp_closed, _} ->\r
-         %~ mnesia:unsubscribe({table, minichat, simple});      
-      _ ->\r
-         %io:format(F, "~p~n", [M]),
-         attends_nouveau_messages2()\r
-   % 60 minutes de timeout (le cas ou il n'y a que des consultations et jamais de post)\r
-   % Après 60 minutes de connexion, le client doit donc reétablir une connexion\r
-   % 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)\r
-   after 1000 * 60 * 60 -> \r
-      mnesia:unsubscribe({table, minichat, simple})
-   end.
-   
-   \r
-% Renvoie les messages manquants pour la page P en sachant qu'il y a N message\r
-% par page et que le dernier message que l'on possède est Id\r
-messages(Id, N, P) ->\r
-   lists:filter(fun (M) -> M#minichat.id > Id end, messages(N, P)).\r
-
-\r
-% Renvoie N messages se trouvant sur la page P\r
-messages(N, P) ->  \r
-   F = fun() ->\r
-      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
-      R = qlc:next_answers(C, N),\r
-      qlc:delete_cursor(C),\r
-      lists:reverse(R)\r
-   end,\r
-   resultat_transaction(mnesia:transaction(F)).   
-
-
-% Renvoie N messages se trouvant sur la première page
-messages(N) ->  
-   messages(N, 1).\r
-\r
-
-% Renvoie les messages auquels répond M. M est l'id du message.\r
-% La réponse est sous la forme d'un arbre, par exemple : {M, [{3, [{1, []}]},{4, []}]}\r
-% ce qui signifie : M répond à 3 et à 4, 3 répond à 1.
-% N est le nombre de message sur une page\r
-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)).\r
-   
-   
-% 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.
-
-\r
-% Renvoie tous les users.\r
-users() ->\r
-   resultat_transaction(mnesia:transaction(fun() ->\r
-      qlc:e(qlc:q([E || E <- mnesia:table(user)]))\r
-   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
-   )).\r
-   \r
-   
-% Renvoie le résultat d'une transaction (en décomposant le tuple fournit)\r
-resultat_transaction({_, T}) ->
-   T.\r
-   
\ No newline at end of file