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