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