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