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