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