ADD trois mode d'affichage pour les pseudos
[euphorik.git] / modules / erl / euphorik_minichat_conversation.erl
index 57c48d6..eb154ee 100755 (executable)
@@ -3,12 +3,18 @@
 % Un message (enfant) peut répondre à des messages (ses parents).
 % Un message (parent) peut avoir plusieurs réponses (enfants)
 % @author G.Burri
+% 
+% @type Message() = {integer(), [integer()]}
+% @type Conversation_detailee() = {[integer()], [integer()], [integer()], bool()}
+% @type Conversation = {[Message()] , bool()} bool() : si true alors il y a encore des messages dans les pages suivantes.
 
 -module(euphorik_minichat_conversation).\r
 -export([\r
    conversations/4\r
 ]).
 
+-compile(export_all).
+
 -include("euphorik_bd.hrl").
 -include_lib("stdlib/include/qlc.hrl").
 
@@ -23,6 +29,7 @@
 % Message est le message de type #minichat et Parents une liste d'Id.
 % Plus est un bool. Si Plus vaut true alors il y a encore des messages.
 % Si il n'y a pas de nouveaux message alors la fonction est bloquante et attend un nouveau message.
+% @spec conversations([{integer(), integer()}], integer(), integer(), integer()) -> [Conversation()]
 conversations(Racines, N, D, P) ->
    % écoute des nouveaux messages
    case subscribe(minichat, 2) of
@@ -31,9 +38,8 @@ conversations(Racines, N, D, P) ->
       _ ->
          % demande des conversations
          Conversations = conversations_detailees(Racines, N, D, P),
-         %io:format("~p~n", [Conversations]),
          % si les conversations sont vides alors on attend un nouveau message
-         Vide = not lists:any(
+         Vide = not any(
             fun(C) ->
                case C of
                   {[], _} -> false;
@@ -57,6 +63,7 @@ conversations(Racines, N, D, P) ->
    
    
 % Ecoute les événements de modification d'une table.
+% @spec subscribe(atom(), integer()) -> ok | erreur
 subscribe(_Table, 0) ->
    erreur;
 subscribe(Table, C) ->
@@ -72,23 +79,22 @@ subscribe(Table, C) ->
    
    
 % Arrête d'écouter les modifications d'une table.
+% @spec unsubscribe(atom()) -> term()
 unsubscribe(Table) -> 
    mnesia:unsubscribe({table, Table, simple}).
  
  
 % Attend qu'un nouveau message arrive, function bloquante.
 % Renvoie le nouveau message.
+% @spec attend_nouveau_message() -> #minichat | timeout
 attend_nouveau_message() ->
-   %io:format(F, "En attente d'un message !~n", []),
    receive % attente d'un post
       {mnesia_table_event, {write, Message, _}} ->
          Message;
-         %io:format(F, "Debloquage !~n", []),
          %file:close(F);
       %~ {tcp_closed, _} ->
          %~ mnesia:unsubscribe({table, minichat, simple});      
       _ ->
-         %io:format(F, "~p~n", [M]),
          attend_nouveau_message()
    % 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
@@ -99,32 +105,41 @@ attend_nouveau_message() ->
      
 
 % Mise en forme des conversations pour l'utilisateur du module.
+% @spec mise_en_forme_conversations([[integer()] | Conversation_detailee()]) -> [Conversation()]
 mise_en_forme_conversations([]) -> [];
 mise_en_forme_conversations([{Principale, Plus_principale} | Conversations]) ->
-   [{mise_en_forme_conversation(Principale), Plus_principale} | lists:map(fun({_, Cn, _, Plus}) -> {mise_en_forme_conversation(Cn), Plus} end, Conversations)].
+   [{mise_en_forme_conversation(Principale), Plus_principale} | map(fun({_, Cn, _, Plus}) -> {mise_en_forme_conversation(Cn), Plus} end, Conversations)].
    
    
-% Mise en forme d'une liste d'id de messages : [4, 5, 8, ...].
+% Mise en forme d'une liste d'id de messages : [4, 5, 8, ...] -> [{4, [5, 6]}, ...].
+% Ajoute les parents de chaque message.
+% @spec mise_en_forme_conversation([integer()]) -> [{integer(), [integer()]}]
 mise_en_forme_conversation(Messages) ->
-   lists:map(
-      fun(Id) ->
-         {ok, Message} = euphorik_minichat:message_by_id(Id),
-         {Message, parents(Id)}
+   lists:foldr(
+      fun(Id, Acc) ->
+         case euphorik_minichat:message_by_id(Id) of
+            {ok, Message} ->
+               [{Message, parents(Id)} | Acc];
+            _ ->
+               Acc
+         end
       end,
+      [],
       Messages
    ).
-   
+      
    
 % 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.
+% @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[integer()] | Conversation_detailee()]
 conversations_detailees(Racines, N, D, P) ->   
    Conversations = map(fun({Racine, P_conv}) -> conversation(Racine, N, D, P_conv) end, Racines),
    Conversation_principale = resultat_transaction(transaction(fun() ->
       Curseur = qlc:cursor(q([E#minichat.id || E <- qlc:sort(table(minichat), [{order, descending}])])),
       {CP, Plus} = conversation_principale(Curseur, Conversations, N, P),
       qlc:delete_cursor(Curseur),
-      {reverse([M || M <- CP, M > D]), Plus} % filtre en fonction de D
+      {[M || M <- CP, M > D], Plus} % filtre en fonction de D
    end)),
    [Conversation_principale | Conversations].
    
@@ -133,9 +148,10 @@ conversations_detailees(Racines, N, D, P) ->
 % 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...)
-% Renvoie {[Id], Plus}
+% @spec conversation_principale(qlc:QueryCursor(), [Conversation_detailee()], integer(), integer()) -> {[Id], Plus}
 conversation_principale(C, Conversations, N, P) ->
-   CP = conversation_principale2(C, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N),
+   % on prend en message de plus pour savoir s'il y en a plus que ce que l'on désire
+   CP = reverse(conversation_principale2(C, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N)),
    Plus = length(CP) =:= N + 1,
    {
       if Plus ->
@@ -150,15 +166,15 @@ conversation_principale(C, Conversations, N, P) ->
       
 % 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
+% S est le nombre de messages qu'il faut sauter.
+% @spec conversation_principale2(qlc:QueryCursor(), [integer()], integer(), integer())
 conversation_principale2(_, _, 0, _) ->
    [];
 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),
+         Doit_etre_saute = any(fun(E) -> E == M end, Messages),
          if  Doit_etre_saute -> 
                conversation_principale2(C, Messages, N, S); % le message ne fait pas partie de la conversation
             S =:= 0 ->
@@ -179,10 +195,11 @@ conversation_principale2(C, Messages, N, S) ->
 % N : le nombre de message par page
 % D : Le dernier message connu 0 si aucun de connu
 % P : La page désirée
+% @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()
 conversation(R, N, D, P) ->
    {C, X} = conversation([], [R], []),
    Decalage = N*(P-1)+1,
-   { 
+   {
       reverse(C),
       if Decalage > length(C) ->
             [];
@@ -207,7 +224,7 @@ conversation(Messages, [M | Reste], X) ->
    true ->
       Enfants = enfants(M),
       Parents = 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
+      % 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
       Est_message_externe =  Parents -- Messages =/= [] orelse intersection(Parents, X) =/= [],
       conversation([M | Messages], Reste ++ Enfants, if Est_message_externe -> [M | X]; true -> X end)
    end;
@@ -236,5 +253,5 @@ parents(M) ->
 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
 % @spec intersection(list(term()), list(term())) -> list(term())
 intersection(L1, L2) ->
-   lists:filter(fun(X) -> lists:member(X, L1) end, L2).
+   filter(fun(X) -> lists:member(X, L1) end, L2).