modules/erl/euphorik_minichat_conversation.erl

   1 % coding: utf-8
   2 % Copyright 2008 Grégory Burri
   3 %
   4 % This file is part of Euphorik.
   5 %
   6 % Euphorik is free software: you can redistribute it and/or modify
   7 % it under the terms of the GNU General Public License as published by
   8 % the Free Software Foundation, either version 3 of the License, or
   9 % (at your option) any later version.
  10 %
  11 % Euphorik is distributed in the hope that it will be useful,
  12 % but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 % GNU General Public License for more details.
  15 %
  16 % You should have received a copy of the GNU General Public License
  17 % along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
  18 %
  19 % Ce module permet la gestion des conversations du minichat d'euphorik.
  20 % Un message (enfant) peut répondre à des messages (ses parents).
  21 % Un message (parent) peut avoir plusieurs réponses (enfants)
  22 % @author G.Burri
  23 %
  24 % @type Message() = {integer(), [integer()]}
  25 % @type Conversation_detailee() = {[integer()], [integer()], [integer()], bool()}
  26 % @type Conversation = {[Message()] , bool()} bool() : si true alors il y a encore des messages dans les pages suivantes.
  27
  28
  29 -module(euphorik_minichat_conversation).
  30 -export([
  31    conversations/4
  32 ]).
  33 -include("euphorik_bd.hrl").
  34 -include_lib("stdlib/include/qlc.hrl").
  35 -import(lists, [reverse/1, any/2, map/2, sublist/3, filter/2]).
  36 -import(euphorik_bd, [resultat_transaction/1]).
  37 -import(qlc, [e/1, q/1, keysort/3]).
  38 -import(mnesia, [table/1, transaction/1]).
  39
  40
  41 % Renvoie les conversations sous la forme d'une liste de conversation.
  42 % Chaque conversation est un tuple {[{Message, Parents}], Plus} où
  43 % Message est le message de type #minichat et Parents une liste d'Id.
  44 % Plus est un bool. Si Plus vaut true alors il y a encore des messages.
  45 % Si il n'y a pas de nouveaux message alors vide est renvoyé.
  46 % @spec conversations([{integer(), integer(), integer()}], integer(), integer(), integer()) -> [Conversation()]
  47 conversations(Racines, N, D, P) ->
  48       Conversations = conversations_detailees(Racines, N, D, P),
  49       % si les conversations sont vides alors on attend un nouveau message
  50       Vide = not any(
  51          fun(C) ->
  52             case C of
  53                {[], _} -> false;
  54                {_, [], _, _} -> false;
  55                _ -> true
  56             end
  57          end,
  58          Conversations
  59       ),
  60       if Vide ->
  61             vide;
  62          true ->
  63             mise_en_forme_conversations(Conversations)
  64       end.
  65
  66
  67 % Mise en forme des conversations pour l'utilisateur du module.
  68 % @spec mise_en_forme_conversations([[integer()] | Conversation_detailee()]) -> [Conversation()]
  69 mise_en_forme_conversations([]) -> [];
  70 mise_en_forme_conversations([{Principale, Plus_principale} | Conversations]) ->
  71    [{mise_en_forme_conversation(Principale), Plus_principale} | map(fun({_, Cn, _, Plus}) -> {mise_en_forme_conversation(Cn), Plus} end, Conversations)].
  72
  73
  74 % Mise en forme d'une liste d'id de messages : [4, 5, 8, ...] -> [{4, [5, 6]}, ...].
  75 % Ajoute les parents de chaque message.
  76 % @spec mise_en_forme_conversation([integer()]) -> [{integer(), [integer()]}]
  77 mise_en_forme_conversation(Messages) ->
  78    resultat_transaction(mnesia:transaction(
  79       fun() ->
  80          lists:foldr(
  81             fun(Id, Acc) ->
  82                case euphorik_bd:message_by_id_sans_transaction(Id) of
  83                   {ok, Message} ->
  84                      [{Message, parents(Id)} | Acc];
  85                   _ ->
  86                      Acc
  87                end
  88             end,
  89             [],
  90             Messages
  91          )
  92       end
  93    )).
  94
  95
  96 % Renvoie une liste de conversations, le première élément correspond à la conversation principale.
  97 % Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
  98 % Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
  99 % @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[integer()] | Conversation_detailee()]
 100 conversations_detailees(Racines, N, D, P) ->
 101    Conversations = map(fun({Racine, P_conv, Dernier}) -> conversation(Racine, N, Dernier, P_conv) end, Racines),
 102    Conversation_principale = resultat_transaction(transaction(fun() ->
 103       Curseur = qlc:cursor(q([E#minichat.id || E <- qlc:sort(table(minichat), [{order, descending}])])),
 104       {CP, Plus} = conversation_principale(Curseur, Conversations, N, P),
 105       qlc:delete_cursor(Curseur),
 106       {[M || M <- CP, M > D], Plus} % filtre en fonction de D
 107    end)),
 108    [Conversation_principale | Conversations].
 109
 110
 111 % Construit la conversation principale en fonction d'un curseur C initialement placé sur le dernier message
 112 % et la liste de conversations.
 113 % N est le nombre de messages que l'on souhaite.
 114 % P est le numéro de la page (1, 2, 3...)
 115 % @spec conversation_principale(qlc:QueryCursor(), [Conversation_detailee()], integer(), integer()) -> {[Id], Plus}
 116 conversation_principale(C, Conversations, N, P) ->
 117    % on prend en message de plus pour savoir s'il y en a plus que ce que l'on désire
 118    CP = reverse(conversation_principale2(C, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N)),
 119    Plus = length(CP) =:= N + 1,
 120    {
 121       if Plus ->
 122          [_| Suivants] = CP,
 123          Suivants;
 124       true ->
 125          CP
 126       end,
 127       Plus
 128    }.
 129
 130
 131 % C est le curseur (voir ci dessus)
 132 % 'Messages' sont les messages que l'on doit enlever de la conversation
 133 % S est le nombre de messages qu'il faut sauter.
 134 % @spec conversation_principale2(qlc:QueryCursor(), [integer()], integer(), integer())
 135 conversation_principale2(_, _, 0, _) ->
 136    [];
 137 conversation_principale2(C, Messages, N, S) ->
 138    case qlc:next_answers(C, 1) of
 139       [] -> [];
 140       [M] -> % traitement message par message (pas des plus performant :/)
 141          Doit_etre_saute = any(fun(E) -> E == M end, Messages),
 142          if  Doit_etre_saute ->
 143                conversation_principale2(C, Messages, N, S); % le message ne fait pas partie de la conversation
 144             S =:= 0 ->
 145                [M | conversation_principale2(C, Messages, N - 1, S)]; % ok : le message fait partie de la conversation
 146             true ->
 147                conversation_principale2(C, Messages, N, S - 1) % on n'a pas encore atteint le début de la page
 148          end
 149    end.
 150
 151
 152 % Renvoie un tuple {C, Cn, X, Plus} où
 153 % C : La conversation complète
 154 % Cn : La conversation tronqué en fonction de N, D et P
 155 % X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
 156 % Plus : true s'il y a encore des messages après
 157 % Inputs :
 158 % R : l'id d'un message représentant la racine de la conversation
 159 % N : le nombre de message par page
 160 % D : Le dernier message connu 0 si aucun de connu
 161 % P : La page désirée
 162 % @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()
 163 conversation(R, N, D, P) ->
 164    {C, X} = conversation([], [R], []),
 165    Decalage = N * (P - 1) + 1,
 166    {
 167       reverse(C),
 168       if Decalage > length(C) ->
 169             [];
 170          true ->
 171             filter(
 172                fun(E) -> E > D end,
 173                reverse(sublist(C, Decalage, N))
 174             )
 175       end,
 176       reverse(X),
 177       Decalage + N - 1 < length(C)
 178    }.
 179
 180
 181 % 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
 182 % Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.
 183 % @spec conversation([integer()], [integer()], [integer()]) -> {}
 184 conversation(Conv, [M | Reste], X) ->
 185    Est_deja_traite = any(fun(E) -> E =:= M end, Conv),
 186    if  Est_deja_traite ->
 187          conversation(Conv, Reste, X);
 188       true ->
 189          Enfants = enfants(M),
 190          Parents = parents(M),
 191          % 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
 192          Est_message_externe =  Parents -- Conv =/= [] orelse intersection(Parents, X) =/= [],
 193          conversation([M | Conv], lists:merge(Reste, Enfants), if Est_message_externe -> [M | X]; true -> X end)
 194    end;
 195 conversation(Messages, [], X) ->
 196    {Messages, X}.
 197
 198
 199 % Renvoie les enfants d'un message M (les messages qui répondent à M)
 200 % ordrés du plus petit au plus grand.
 201 % @spec enfants(integer()) -> [integer()]
 202 enfants(M) ->
 203    resultat_transaction(transaction(fun() ->
 204       e(
 205          qlc:sort(
 206             q([E#reponse_minichat.repondant || E <- table(reponse_minichat), E#reponse_minichat.cible =:= M]),
 207             [{order, ascending}]
 208          )
 209       )
 210    end)).
 211
 212
 213 % Renvoie les parents d'un message M (les messages auquels répond M)
 214 % ordrés du plus petit au plus grand..
 215 % @spec parents(integer()) -> [integer()]
 216 parents(M) ->
 217    resultat_transaction(transaction(fun() ->
 218       e(
 219          qlc:sort(
 220             q([E#reponse_minichat.cible || E <- table(reponse_minichat), E#reponse_minichat.repondant =:= M]),
 221             [{order, ascending}]
 222          )
 223       )
 224    end)).
 225
 226
 227 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
 228 % @spec intersection(list(term()), list(term())) -> list(term())
 229 intersection(L1, L2) ->
 230    filter(fun(X) -> lists:member(X, L1) end, L2).
 231