REPORT de la branche 1.1 (459->476)
[euphorik.git] / modules / erl / euphorik_minichat_conversation.erl
index 42412c6..4d0b3a8 100755 (executable)
-% coding: utf-8
-% 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
+% coding: utf-8\r
+% Copyright 2008 Grégory Burri\r
+%\r
+% This file is part of Euphorik.\r
+%\r
+% Euphorik is free software: you can redistribute it and/or modify\r
+% it under the terms of the GNU General Public License as published by\r
+% the Free Software Foundation, either version 3 of the License, or\r
+% (at your option) any later version.\r
+%\r
+% Euphorik is distributed in the hope that it will be useful,\r
+% but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+% GNU General Public License for more details.\r
+%\r
+% You should have received a copy of the GNU General Public License\r
+% along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.\r
+% \r
+% Ce module permet la gestion des conversations du minichat d'euphorik.\r
+% Un message (enfant) peut répondre à des messages (ses parents).\r
+% Un message (parent) peut avoir plusieurs réponses (enfants)\r
+% @author G.Burri\r
+% \r
+% Les conversation se compose d'une liste de tuple comprenant la conversation, du premier message de la conversation,\r
+% et d'un booleen indiquant s'il y a encore des messages\r
+% @type Conversations() = [{Conversation(), Message(), bool()}]\r
+% \r
+% Une conversation est simplement une liste de messages\r
+% @type Conversation() = [Message()]\r
+%\r
+% Un message est un tuple représentant le message et la liste des id\r
+% des messages auquels il répond\r
+% @type Message() = {#minichat, [int()]}\r
 
--module(euphorik_minichat_conversation).
-
--include("euphorik_bd.hrl").
--include_lib("stdlib/include/qlc.hrl").
-
--import(lists, [reverse/1, any/2, map/2, sublist/3, filter/2]).
--import(euphorik_minichat, [resultat_transaction/1]).
--import(qlc, [e/1, q/1, keysort/3]).
--import(mnesia, [table/1, transaction/1]).
--compile(export_all).
-
-  
-% 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)). 
-   
-tester(Racines, N, D, P) ->
-   io:format("~w~n", [conversations(Racines, N, D, P)]).
-   
-
-% Crée un process représentant le minichat, renvoie un tuple {Pid, Conversations}
-start(Racines, N, D, P) ->
-   {mise_en_forme_conversations(loop(conversations(Racines, N, D, P))), conversations(Racines, N, D, P)}.
-   
-% Attend pour d'autres messages.
-wait(Pid) ->
-   Pid ! {wait, self()},
-   receive
-      {nouveau, Message} -> Message
-   end.
-   
-   
-
-% Mise en forme des conversations pour l'utilisateur du module.
-mise_en_forme_conversations([]) -> [];
-mise_en_forme_conversations([Principale | Conversations]) ->
-   [mise_en_forme_conversation(Principale), lists:map(fun({_, Cn, _}) -> mise_en_forme_conversation(Cn) end, Conversations)].
-   
-% Mise en forme d'une liste d'id de message : [4, 5, 8, ...].
-mise_en_forme_conversation(Messages) ->
-   lists:map(fun(M) -> {euphorik_minichat:get_messages_depuis_ids(), get_parents(M)} end, Messages).
-   
-
-loop(Conversations) ->
-   receive
-      {wait, Pid} ->
-         Pid ! {nouveau, attends_nouveaux_messages()}
-   end,
-   loop(Conversations).
-   
-   
-% Renvoie une liste de conversations, le première élément correspond à la conversation principale.
-% Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
-% Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
-conversations(Racines, N, D, P) ->   
-   Conversations = map(fun({Racine, P_conv}) -> conversation(Racine, N, D, P_conv) end, Racines),
+\r
+-module(euphorik_minichat_conversation).\r
+-export([\r
+   conversations/4\r
+]).\r
+-include("../include/euphorik_bd.hrl").\r
+-include("../include/euphorik_defines.hrl").\r
+-import(lists, [reverse/1, any/2, map/2, sublist/3, filter/2]).\r
+-import(euphorik_bd, [resultat_transaction/1]).\r
+-import(mnesia, [table/1, transaction/1]).\r
+  \r
+   \r
+% Renvoie les conversations.\r
+% Chaque racine est un tuple {R, P, D}\r
+% R : l'id de la racine\r
+% N : le nombre de message\r
+% D : le dernier message connu, 0 si aucun\r
+% P : la page souhaité, la premier est la 1\r
+% @spec conversations([{integer(), integer(), integer()}], integer(), integer(), integer()) -> Conversations()\r
+conversations(Racines, N, D, P) ->\r
+      Conversations = conversations_detailees(Racines, N, D, P),\r
+      % si les conversations sont vides alors on attend un nouveau message\r
+      Vide = not any(\r
+         fun(C) ->\r
+            case C of\r
+               {[], _} -> false;\r
+               {_, [], _, _} -> false;\r
+               _ -> true\r
+            end\r
+         end,\r
+         Conversations\r
+      ),\r
+      if Vide ->\r
+            vide;\r
+         true ->\r
+            mise_en_forme_conversations(Conversations)\r
+      end.\r
+     \r
+\r
+% Mise en forme des conversations pour l'utilisateur du module.\r
+% @type Conversation_principale() = {[integer()], bool}\r
+% @type Conversation_detailee() = {[integer()], [integer()], [integer()], bool()}\r
+% @spec mise_en_forme_conversations([Conversation_principal() | Conversation_detailee()]) -> [Conversation()]\r
+mise_en_forme_conversations([]) -> [];\r
+mise_en_forme_conversations([{Principale, Plus_principale} | Conversations]) ->\r
+   [{mise_en_forme_conversation(Principale), Plus_principale} | map(fun({_, Cn, _, Plus}) -> {mise_en_forme_conversation(Cn), Plus} end, Conversations)].\r
+   \r
+   \r
+% Mise en forme d'une liste d'id de messages : [4, 9, 8, ...] -> [{#minichat, [5, 6]}, ...].\r
+% Ajoute les parents de chaque message.\r
+% @spec mise_en_forme_conversation([integer()]) -> [{#minichat, [integer()]}]\r
+mise_en_forme_conversation(Messages) ->\r
+   resultat_transaction(transaction(\r
+      fun() ->\r
+         lists:foldr(\r
+            fun(Id, Acc) ->\r
+               case euphorik_bd:message_by_id(Id) of\r
+                  {ok, Message} ->\r
+                     [{Message, euphorik_bd:parents_id(Id)} | Acc];\r
+                  _ ->\r
+                     Acc\r
+               end\r
+            end,\r
+            [],\r
+            Messages\r
+         )\r
+      end\r
+   )).\r
+\r
+   \r
+% Renvoie une liste de conversations, le première élément correspond à la conversation principale.\r
+% Les autres éléments sont des tuples {C, Cn, X, Plus}, voir conversation/4 pour plus d'infos.\r
+% Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.\r
+% @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[{integer(), bool()}] | Conversation_detailee()]\r
+conversations_detailees(Racines, N, D, P) ->   \r
+   Conversations = map(fun({Racine, P_conv, Dernier}) -> conversation(Racine, N, Dernier, P_conv) end, Racines),\r
    Conversation_principale = resultat_transaction(transaction(fun() ->
-      Curseur = qlc:cursor(q([E#minichat.id || E <- qlc:sort(table(minichat), [{order, descending}])])),
-      CP2 = get_conversation_principale(Curseur, Conversations, N, P),
-      qlc:delete_cursor(Curseur),
-      CP2
-   end)),
-   [reverse(Conversation_principale) | Conversations].
-   
-
-% Construit la conversation principale en fonction d'un curseur C initialement placé sur le dernier message
-% et la liste de conversations.
-% N est le nombre de messages que l'on souhaite.
-% P est le numéro de la page (1, 2, 3...)
-get_conversation_principale(C, Conversations, N, P) ->
-   get_conversation_principale2(C, lists:flatten(map(fun({C2, _, X}) -> C2 -- X end, Conversations)), N, (P - 1) * N).
-% C est le curseur (voir ci dessus)
-% 'Messages' sont les messages que l'on doit enlever de la conversation
-% S est le nombre de messages qu'il faut sauter
-get_conversation_principale2(_, _, 0, _) ->
+      Dernier_id = mnesia:last(minichat),\r
+      {CP, Plus} = conversation_principale(Dernier_id, Conversations, N, P),\r
+      {[M || M <- CP, M > D], Plus} % filtre en fonction de D\r
+   end)),\r
+   [Conversation_principale | Conversations].\r
+   \r
+\r
+% Construit la conversation principale en fonction d'un id de message initialement placé sur le dernier message\r
+% et la liste de conversations.\r
+% N est le nombre de messages que l'on souhaite.\r
+% P est le numéro de la page (1, 2, 3...)\r
+% @spec conversation_principale(integer(), [Conversation_detailee()], integer(), integer()) -> {[integer()], bool()}\r
+conversation_principale(Id, Conversations, N, P) ->\r
+   % on prend en message de plus pour savoir s'il y en a plus que ce que l'on désire\r
+   CP = reverse(conversation_principale2(Id, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N)),\r
+   Plus = length(CP) =:= N + 1,\r
+   {\r
+      if Plus ->\r
+         [_| Suivants] = CP,\r
+         Suivants;\r
+      true ->\r
+         CP\r
+      end,\r
+      Plus\r
+   }.\r
+      \r
+      \r
+% Id est l'id d'un message, voir ce dessus\r
+% 'Messages' sont les messages que l'on doit enlever de la conversation\r
+% S est le nombre de messages qu'il faut sauter.\r
+% @spec conversation_principale2(integer(), [integer()], integer(), integer()) -> [integer()]\r
+conversation_principale2(_, _, 0, _) ->\r
    [];
-get_conversation_principale2(C, Messages, N, S) ->
-   case qlc:next_answers(C, 1) of
-      [] -> [];
-      [M] -> % traitement message par message (pas des plus performant :/)
-         %io:format("M: ~p~n", [M]),
-         Doit_etre_saute = lists:any(fun(E) -> E == M end, Messages),
-         if  Doit_etre_saute -> 
-               get_conversation_principale2(C, Messages, N, S); % le message ne fait pas partie de la conversation
-            S =:= 0 ->
-               [M | get_conversation_principale2(C, Messages, N - 1, S)]; % ok : le message fait partie de la conversation
-            true ->
-               get_conversation_principale2(C, Messages, N, S - 1) % on n'a pas encore atteint le début de la page
-         end
-   end.
-   
-   
-% Renvoie un tuple {C, Cn, X} où
-% C : La conversation complète
-% Cn : La conversation tronqué en fonction de N, D et P
-% X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
-% Inputs :
-% R : l'id d'un message représentant la racine de la conversation
-% N : le nombre de message par page
-% D : Le dernier message connu 0 si aucun de connu
-% P : La page désirée
-conversation(R, N, D, P) ->
-   {C, X} = conversation([], [R], []),
-   {reverse(C), reverse(filter(fun(E) -> E > D end, sublist(C, N*(P-1)+1, N))), reverse(X)}.
-   
-   
-% Renvoie un tuple {C, X} où C est la conversation complète et X les messages répondant à des mess qui ne font pas partie de la conversation
-% Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit
-conversation(Messages, [M | Reste], X) ->
-   Est_deja_traite = any(fun(E) -> E =:= M end, Messages),
-   if  Est_deja_traite ->
-      conversation(Messages, Reste, X);
-   true ->
-      Enfants = get_enfants(M),
-      Parents = get_parents(M),
-      % un message est dit exiterne si un de ses parent ne fait pas partie de la conversation ou si un de ses parents fait partie de X
-      Est_message_externe =  Parents -- Messages =/= [] orelse intersection(Parents, X) =/= [],
-      conversation([M | Messages], Reste ++ Enfants, if Est_message_externe -> [M | X]; true -> X end)
-   end;
-conversation(Messages, [], X) ->
-   {Messages, X}.
-   
-   
-% Renvoie les enfants d'un message M (les messages qui répondent à M)
-% ordrés du plus petit au plus grand.
-get_enfants(M) ->
-   resultat_transaction(transaction(fun() ->
-      e(q([E#reponse_minichat.repondant || E <- qlc:sort(table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.cible =:= M]))
-   end)).
-   
-   
-% Renvoie les parents d'un message M (les messages auquels répond M)
-% ordrés du plus petit au plus grand.
-get_parents(M) ->
-   resultat_transaction(transaction(fun() ->
-      e(q([E#reponse_minichat.cible || E <- keysort(1, table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.repondant =:= M]))
-   end)).
-   
-
-% Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
-intersection(L1, L2) ->
-   lists:filter(fun(X) -> lists:member(X, L1) end, L2).
-% Attend qu'au moins un nouveau message arrive, function bloquante.
-% Renvoie un tuple {C, M} où C est une liste de numéro de conversation auquel appartient M et M l'Id du nouveau message
-attends_nouveaux_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_nouveaux_messages2()
-   end.
-attends_nouveaux_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_nouveaux_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.
\ No newline at end of file
+conversation_principale2('$end_of_table', _, _, _) ->
+   [];\r
+conversation_principale2(Id, Messages, N, S) ->
+   % traitement message par message (pas des plus performant :/)
+   Id_prev = mnesia:prev(minichat, Id),\r
+   Doit_etre_saute = any(fun(E) -> E == Id end, Messages),\r
+   if  Doit_etre_saute -> \r
+         conversation_principale2(Id_prev, Messages, N, S); % le message ne fait pas partie de la conversation\r
+      S =:= 0 ->\r
+         [Id | conversation_principale2(Id_prev, Messages, N - 1, S)]; % ok : le message fait partie de la conversation\r
+      true ->\r
+         conversation_principale2(Id_prev, Messages, N, S - 1) % on n'a pas encore atteint le début de la page\r
+      end.\r
+   \r
+   \r
+% Renvoie un tuple {C, Cn, X, Plus} où\r
+% C : La conversation complète\r
+% Cn : La conversation tronqué en fonction de N, D et P\r
+% X : La liste des messages répondant à des mess qui ne font pas partie de la conversation\r
+% Plus : true s'il y a encore des messages après\r
+% Inputs :\r
+% R : l'id d'un message représentant la racine de la conversation\r
+% N : le nombre de message par page\r
+% D : Le dernier message connu 0 si aucun de connu\r
+% P : La page désirée\r
+% @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()\r
+conversation(R, N, D, P) ->\r
+   {C, X} = conversation([], [R], []),\r
+   Decalage = N * (P - 1) + 1,\r
+   {\r
+      reverse(C),\r
+      if Decalage > length(C) ->\r
+            [];\r
+         true ->\r
+            filter(\r
+               fun(E) -> E > D end,\r
+               reverse(sublist(C, Decalage, N))\r
+            )\r
+      end,\r
+      reverse(X),\r
+      Decalage + N - 1 < length(C) \r
+   }.\r
+   \r
+   \r
+% Renvoie un tuple {C, X} où C est la conversation complète et X les messages répondant à des mess qui ne font pas partie de la conversation\r
+% Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.\r
+% @spec conversation([integer()], [integer()], [integer()]) -> {[int()], [int()]}\r
+conversation(Conv, [M | Reste], X) ->\r
+   Est_deja_traite = any(fun(E) -> E =:= M end, Conv),\r
+   if  Est_deja_traite ->\r
+         conversation(Conv, Reste, X);\r
+      true ->\r
+         Enfants = euphorik_bd:enfants_id(M),\r
+         Parents = euphorik_bd:parents_id(M),\r
+         % un message est dit externe si un de ses parent ne fait pas partie de la conversation ou si un de ses parents fait partie de X\r
+         Est_message_externe =  Parents -- Conv =/= [] orelse intersection(Parents, X) =/= [],\r
+         conversation([M | Conv], lists:merge(Reste, Enfants), if Est_message_externe -> [M | X]; true -> X end)\r
+   end;\r
+conversation(Messages, [], X) ->\r
+   {Messages, X}.\r
+   \r
+\r
+% Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]\r
+% @spec intersection(list(term()), list(term())) -> list(term())\r
+intersection(L1, L2) ->\r
+   filter(fun(X) -> lists:member(X, L1) end, L2).\r
+\r