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