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 -include("euphorik_bd.hrl").
  16 -include_lib("stdlib/include/qlc.hrl").
  17 -import(lists, [reverse/1, any/2, map/2, sublist/3, filter/2]).
  18 -import(euphorik_bd, [resultat_transaction/1]).
  19 -import(qlc, [e/1, q/1, keysort/3]).
  20 -import(mnesia, [table/1, transaction/1]).
  21
  22
  23 % Renvoie les conversations sous la forme d'une liste de conversation.
  24 % Chaque conversation est un tuple {[{Message, Parents}], Plus} où
  25 % Message est le message de type #minichat et Parents une liste d'Id.
  26 % Plus est un bool. Si Plus vaut true alors il y a encore des messages.
  27 % Si il n'y a pas de nouveaux message alors vide est renvoyé.
  28 % @spec conversations([{integer(), integer(), integer()}], integer(), integer(), integer()) -> [Conversation()]
  29 conversations(Racines, N, D, P) ->
  30       Conversations = conversations_detailees(Racines, N, D, P),
  31       % si les conversations sont vides alors on attend un nouveau message
  32       Vide = not any(
  33          fun(C) ->
  34             case C of
  35                {[], _} -> false;
  36                {_, [], _, _} -> false;
  37                _ -> true
  38             end
  39          end,
  40          Conversations
  41       ),
  42       if Vide ->
  43             vide;
  44          true ->
  45             mise_en_forme_conversations(Conversations)
  46       end.
  47
  48
  49 % Mise en forme des conversations pour l'utilisateur du module.
  50 % @spec mise_en_forme_conversations([[integer()] | Conversation_detailee()]) -> [Conversation()]
  51 mise_en_forme_conversations([]) -> [];
  52 mise_en_forme_conversations([{Principale, Plus_principale} | Conversations]) ->
  53    [{mise_en_forme_conversation(Principale), Plus_principale} | map(fun({_, Cn, _, Plus}) -> {mise_en_forme_conversation(Cn), Plus} end, Conversations)].
  54
  55
  56 % Mise en forme d'une liste d'id de messages : [4, 5, 8, ...] -> [{4, [5, 6]}, ...].
  57 % Ajoute les parents de chaque message.
  58 % @spec mise_en_forme_conversation([integer()]) -> [{integer(), [integer()]}]
  59 mise_en_forme_conversation(Messages) ->
  60    lists:foldr(
  61       fun(Id, Acc) ->
  62          case euphorik_bd:message_by_id(Id) of
  63             {ok, Message} ->
  64                [{Message, parents(Id)} | Acc];
  65             _ ->
  66                Acc
  67          end
  68       end,
  69       [],
  70       Messages
  71    ).
  72
  73
  74 % Renvoie une liste de conversations, le première élément correspond à la conversation principale.
  75 % Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
  76 % Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
  77 % @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[integer()] | Conversation_detailee()]
  78 conversations_detailees(Racines, N, D, P) ->
  79    Conversations = map(fun({Racine, P_conv, Dernier}) -> conversation(Racine, N, Dernier, P_conv) end, Racines),
  80    Conversation_principale = resultat_transaction(transaction(fun() ->
  81       Curseur = qlc:cursor(q([E#minichat.id || E <- qlc:sort(table(minichat), [{order, descending}])])),
  82       {CP, Plus} = conversation_principale(Curseur, Conversations, N, P),
  83       qlc:delete_cursor(Curseur),
  84       {[M || M <- CP, M > D], Plus} % filtre en fonction de D
  85    end)),
  86    [Conversation_principale | Conversations].
  87
  88
  89 % Construit la conversation principale en fonction d'un curseur C initialement placé sur le dernier message
  90 % et la liste de conversations.
  91 % N est le nombre de messages que l'on souhaite.
  92 % P est le numéro de la page (1, 2, 3...)
  93 % @spec conversation_principale(qlc:QueryCursor(), [Conversation_detailee()], integer(), integer()) -> {[Id], Plus}
  94 conversation_principale(C, Conversations, N, P) ->
  95    % on prend en message de plus pour savoir s'il y en a plus que ce que l'on désire
  96    CP = reverse(conversation_principale2(C, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N)),
  97    Plus = length(CP) =:= N + 1,
  98    {
  99       if Plus ->
 100          [_| Suivants] = CP,
 101          Suivants;
 102       true ->
 103          CP
 104       end,
 105       Plus
 106    }.
 107
 108
 109 % C est le curseur (voir ci dessus)
 110 % 'Messages' sont les messages que l'on doit enlever de la conversation
 111 % S est le nombre de messages qu'il faut sauter.
 112 % @spec conversation_principale2(qlc:QueryCursor(), [integer()], integer(), integer())
 113 conversation_principale2(_, _, 0, _) ->
 114    [];
 115 conversation_principale2(C, Messages, N, S) ->
 116    case qlc:next_answers(C, 1) of
 117       [] -> [];
 118       [M] -> % traitement message par message (pas des plus performant :/)
 119          Doit_etre_saute = any(fun(E) -> E == M end, Messages),
 120          if  Doit_etre_saute ->
 121                conversation_principale2(C, Messages, N, S); % le message ne fait pas partie de la conversation
 122             S =:= 0 ->
 123                [M | conversation_principale2(C, Messages, N - 1, S)]; % ok : le message fait partie de la conversation
 124             true ->
 125                conversation_principale2(C, Messages, N, S - 1) % on n'a pas encore atteint le début de la page
 126          end
 127    end.
 128
 129
 130 % Renvoie un tuple {C, Cn, X, Plus} où
 131 % C : La conversation complète
 132 % Cn : La conversation tronqué en fonction de N, D et P
 133 % X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
 134 % Plus : true s'il y a encore des messages après
 135 % Inputs :
 136 % R : l'id d'un message représentant la racine de la conversation
 137 % N : le nombre de message par page
 138 % D : Le dernier message connu 0 si aucun de connu
 139 % P : La page désirée
 140 % @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()
 141 conversation(R, N, D, P) ->
 142    {C, X} = conversation([], [R], []),
 143    Decalage = N * (P - 1) + 1,
 144    {
 145       reverse(C),
 146       if Decalage > length(C) ->
 147             [];
 148          true ->
 149             filter(
 150                fun(E) -> E > D end,
 151                reverse(sublist(C, Decalage, N))
 152             )
 153       end,
 154       reverse(X),
 155       Decalage + N - 1 < length(C)
 156    }.
 157
 158
 159 % 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
 160 % Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.
 161 % @spec conversation([integer()], [integer()], [integer()]) -> {}
 162 conversation(Messages, [M | Reste], X) ->
 163    Est_deja_traite = any(fun(E) -> E =:= M end, Messages),
 164    if  Est_deja_traite ->
 165          conversation(Messages, Reste, X);
 166       true ->
 167          Enfants = enfants(M),
 168          Parents = parents(M),
 169          % 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
 170          Est_message_externe =  Parents -- Messages =/= [] orelse intersection(Parents, X) =/= [],
 171          conversation([M | Messages], lists:merge(Reste, Enfants), if Est_message_externe -> [M | X]; true -> X end)
 172    end;
 173 conversation(Messages, [], X) ->
 174    {Messages, X}.
 175
 176
 177 % Renvoie les enfants d'un message M (les messages qui répondent à M)
 178 % ordrés du plus petit au plus grand.
 179 % @spec enfants(integer()) -> [integer()]
 180 enfants(M) ->
 181    resultat_transaction(transaction(fun() ->
 182       e(q([E#reponse_minichat.repondant || E <- qlc:sort(table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.cible =:= M]))
 183    end)).
 184
 185
 186 % Renvoie les parents d'un message M (les messages auquels répond M)
 187 % ordrés du plus petit au plus grand..
 188 % @spec parents(integer()) -> [integer()]
 189 parents(M) ->
 190    resultat_transaction(transaction(fun() ->
 191       e(q([E#reponse_minichat.cible || E <- keysort(1, table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.repondant =:= M]))
 192    end)).
 193
 194
 195 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
 196 % @spec intersection(list(term()), list(term())) -> list(term())
 197 intersection(L1, L2) ->
 198    filter(fun(X) -> lists:member(X, L1) end, L2).
 199