modules/erl/euphorik_minichat_conversation.erl

   1 % coding: utf-8
   2 % Ce module permet la gestion des conversations du minichat d'euphorik.
   3 % Un message (enfant) peut répondre à des messages (ses parents).
   4 % Un message (parent) peut avoir plusieurs réponses (enfants)
   5 % Auteur : G.Burri
   6 % Date : 09.02.2008
   7
   8 -module(euphorik_minichat_conversation).
   9
  10 -include("euphorik_bd.hrl").
  11 -include_lib("stdlib/include/qlc.hrl").
  12
  13 -import(lists, [reverse/1, any/2, map/2, sublist/3, filter/2]).
  14 -import(euphorik_minichat, [resultat_transaction/1]).
  15 -import(qlc, [e/1, q/1, keysort/3]).
  16 -import(mnesia, [table/1, transaction/1]).
  17 -export([conversations/4]).
  18
  19
  20 % Renvoie les conversations sous la forme d'une liste de conversation.
  21 % Chaque conversation est un tuple {[{Message, Parents}], Plus} où
  22 % Message est le message de type #minichat et Parents une liste d'Id.
  23 % Plus est un bool. Si Plus vaut true alors il y a encore des messages.
  24 % Si il n'y a pas de nouveaux message alors la fonction est bloquante et attend un nouveau message.
  25 conversations(Racines, N, D, P) ->
  26    % écoute des nouveaux messages
  27    case subscribe(minichat, 2) of
  28       erreur = E ->
  29          E;
  30       _ ->
  31          % demande des conversations
  32          Conversations = conversations_detailees(Racines, N, D, P),
  33          %io:format("~p~n", [Conversations]),
  34          % si les conversations sont vides alors on attend un nouveau message
  35          Vide = not lists:any(
  36             fun(C) ->
  37                case C of
  38                   {[], _} -> false;
  39                   {_, [], _, _} -> false;
  40                   _ -> true
  41                end
  42             end,
  43             Conversations
  44          ),
  45          Conversations_mises_en_forme = mise_en_forme_conversations(
  46             if Vide ->
  47                attend_nouveau_message(),
  48                conversations_detailees(Racines, N, D, P);
  49             true ->
  50                Conversations
  51             end
  52          ),
  53          unsubscribe(minichat),
  54          Conversations_mises_en_forme
  55    end.
  56
  57
  58 % Ecoute les événements de modification d'une table.
  59 subscribe(_Table, 0) ->
  60    erreur;
  61 subscribe(Table, C) ->
  62    case mnesia:subscribe({table, Table, simple}) of
  63         {error, {not_active_local, Table}} ->
  64          mnesia:add_table_copy(minichat, node(), ram_copies),
  65          subscribe(Table, C - 1);
  66       {error, _}->
  67          erreur;
  68       _ ->
  69          ok
  70    end.
  71
  72
  73 % Arrête d'écouter les modifications d'une table.
  74 unsubscribe(Table) ->
  75    mnesia:unsubscribe({table, Table, simple}).
  76
  77
  78 % Attend qu'un nouveau message arrive, function bloquante.
  79 % Renvoie le nouveau message.
  80 attend_nouveau_message() ->
  81    %io:format(F, "En attente d'un message !~n", []),
  82    receive % attente d'un post
  83       {mnesia_table_event, {write, Message, _}} ->
  84          Message;
  85          %io:format(F, "Debloquage !~n", []),
  86          %file:close(F);
  87       %~ {tcp_closed, _} ->
  88          %~ mnesia:unsubscribe({table, minichat, simple});
  89       _ ->
  90          %io:format(F, "~p~n", [M]),
  91          attend_nouveau_message()
  92    % 60 minutes de timeout (le cas ou il n'y a que des consultations et jamais de post)
  93    % Après 60 minutes de connexion, le client doit donc reétablir une connexion
  94    % 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)
  95    after 1000 * 60 * 60 ->
  96       timeout
  97    end.
  98
  99
 100 % Mise en forme des conversations pour l'utilisateur du module.
 101 mise_en_forme_conversations([]) -> [];
 102 mise_en_forme_conversations([{Principale, Plus_principale} | Conversations]) ->
 103    [{mise_en_forme_conversation(Principale), Plus_principale} | lists:map(fun({_, Cn, _, Plus}) -> {mise_en_forme_conversation(Cn), Plus} end, Conversations)].
 104
 105
 106 % Mise en forme d'une liste d'id de messages : [4, 5, 8, ...].
 107 mise_en_forme_conversation(Messages) ->
 108    lists:map(
 109       fun(Id) ->
 110          {ok, Message} = euphorik_minichat:message_by_id(Id),
 111          {Message, parents(Id)}
 112       end,
 113       Messages
 114    ).
 115
 116
 117 % Renvoie une liste de conversations, le première élément correspond à la conversation principale.
 118 % Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
 119 % Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
 120 conversations_detailees(Racines, N, D, P) ->
 121    Conversations = map(fun({Racine, P_conv}) -> conversation(Racine, N, D, P_conv) end, Racines),
 122    Conversation_principale = resultat_transaction(transaction(fun() ->
 123       Curseur = qlc:cursor(q([E#minichat.id || E <- qlc:sort(table(minichat), [{order, descending}])])),
 124       {CP, Plus} = conversation_principale(Curseur, Conversations, N, P),
 125       qlc:delete_cursor(Curseur),
 126       {reverse([M || M <- CP, M > D]), Plus} % filtre en fonction de D
 127    end)),
 128    [Conversation_principale | Conversations].
 129
 130
 131 % Construit la conversation principale en fonction d'un curseur C initialement placé sur le dernier message
 132 % et la liste de conversations.
 133 % N est le nombre de messages que l'on souhaite.
 134 % P est le numéro de la page (1, 2, 3...)
 135 % Renvoie {[Id], Plus}
 136 conversation_principale(C, Conversations, N, P) ->
 137    CP = conversation_principale2(C, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N),
 138    Plus = length(CP) =:= N + 1,
 139    {
 140       if Plus ->
 141          [_| Suivants] = CP,
 142          Suivants;
 143       true ->
 144          CP
 145       end,
 146       Plus
 147    }.
 148
 149
 150 % C est le curseur (voir ci dessus)
 151 % 'Messages' sont les messages que l'on doit enlever de la conversation
 152 % S est le nombre de messages qu'il faut sauter
 153 conversation_principale2(_, _, 0, _) ->
 154    [];
 155 conversation_principale2(C, Messages, N, S) ->
 156    case qlc:next_answers(C, 1) of
 157       [] -> [];
 158       [M] -> % traitement message par message (pas des plus performant :/)
 159          %io:format("M: ~p~n", [M]),
 160          Doit_etre_saute = lists:any(fun(E) -> E == M end, Messages),
 161          if  Doit_etre_saute ->
 162                conversation_principale2(C, Messages, N, S); % le message ne fait pas partie de la conversation
 163             S =:= 0 ->
 164                [M | conversation_principale2(C, Messages, N - 1, S)]; % ok : le message fait partie de la conversation
 165             true ->
 166                conversation_principale2(C, Messages, N, S - 1) % on n'a pas encore atteint le début de la page
 167          end
 168    end.
 169
 170
 171 % Renvoie un tuple {C, Cn, X, Plus} où
 172 % C : La conversation complète
 173 % Cn : La conversation tronqué en fonction de N, D et P
 174 % X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
 175 % Plus : true s'il y a encore des messages après
 176 % Inputs :
 177 % R : l'id d'un message représentant la racine de la conversation
 178 % N : le nombre de message par page
 179 % D : Le dernier message connu 0 si aucun de connu
 180 % P : La page désirée
 181 conversation(R, N, D, P) ->
 182    {C, X} = conversation([], [R], []),
 183    Decalage = N*(P-1)+1,
 184    {
 185       reverse(C),
 186       if Decalage > length(C) ->
 187             [];
 188          true ->
 189             reverse(filter(
 190                fun(E) -> E > D end,
 191                sublist(C, Decalage, N)
 192             ))
 193       end,
 194       reverse(X),
 195       Decalage + N - 1 < length(C)
 196    }.
 197
 198
 199 % 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
 200 % Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.
 201 % @spec conversation([integer()], [integer()], [integer()]) -> {}
 202 conversation(Messages, [M | Reste], X) ->
 203    Est_deja_traite = any(fun(E) -> E =:= M end, Messages),
 204    if  Est_deja_traite ->
 205       conversation(Messages, Reste, X);
 206    true ->
 207       Enfants = enfants(M),
 208       Parents = parents(M),
 209       % 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
 210       Est_message_externe =  Parents -- Messages =/= [] orelse intersection(Parents, X) =/= [],
 211       conversation([M | Messages], Reste ++ Enfants, if Est_message_externe -> [M | X]; true -> X end)
 212    end;
 213 conversation(Messages, [], X) ->
 214    {Messages, X}.
 215
 216
 217 % Renvoie les enfants d'un message M (les messages qui répondent à M)
 218 % ordrés du plus petit au plus grand.
 219 % @spec enfants(integer()) -> [integer()]
 220 enfants(M) ->
 221    resultat_transaction(transaction(fun() ->
 222       e(q([E#reponse_minichat.repondant || E <- qlc:sort(table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.cible =:= M]))
 223    end)).
 224
 225
 226 % Renvoie les parents d'un message M (les messages auquels répond M)
 227 % ordrés du plus petit au plus grand..
 228 % @spec parents(integer()) -> [integer()]
 229 parents(M) ->
 230    resultat_transaction(transaction(fun() ->
 231       e(q([E#reponse_minichat.cible || E <- keysort(1, table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.repondant =:= M]))
 232    end)).
 233
 234
 235 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
 236 % @spec intersection(list(term()), list(term())) -> list(term())
 237 intersection(L1, L2) ->
 238    lists:filter(fun(X) -> lists:member(X, L1) end, L2).
 239