MOD restructuration des skins
[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 % @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 lists:foldr(
79 fun(Id, Acc) ->
80 case euphorik_bd:message_by_id(Id) of
81 {ok, Message} ->
82 [{Message, parents(Id)} | Acc];
83 _ ->
84 Acc
85 end
86 end,
87 [],
88 Messages
89 ).
90
91
92 % Renvoie une liste de conversations, le première élément correspond à la conversation principale.
93 % Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
94 % Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
95 % @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[integer()] | Conversation_detailee()]
96 conversations_detailees(Racines, N, D, P) ->
97 Conversations = map(fun({Racine, P_conv, Dernier}) -> conversation(Racine, N, Dernier, P_conv) end, Racines),
98 Conversation_principale = resultat_transaction(transaction(fun() ->
99 Curseur = qlc:cursor(q([E#minichat.id || E <- qlc:sort(table(minichat), [{order, descending}])])),
100 {CP, Plus} = conversation_principale(Curseur, Conversations, N, P),
101 qlc:delete_cursor(Curseur),
102 {[M || M <- CP, M > D], Plus} % filtre en fonction de D
103 end)),
104 [Conversation_principale | Conversations].
105
106
107 % Construit la conversation principale en fonction d'un curseur C initialement placé sur le dernier message
108 % et la liste de conversations.
109 % N est le nombre de messages que l'on souhaite.
110 % P est le numéro de la page (1, 2, 3...)
111 % @spec conversation_principale(qlc:QueryCursor(), [Conversation_detailee()], integer(), integer()) -> {[Id], Plus}
112 conversation_principale(C, Conversations, N, P) ->
113 % on prend en message de plus pour savoir s'il y en a plus que ce que l'on désire
114 CP = reverse(conversation_principale2(C, lists:flatten(map(fun({C2, _, X, _}) -> C2 -- X end, Conversations)), N + 1, (P - 1) * N)),
115 Plus = length(CP) =:= N + 1,
116 {
117 if Plus ->
118 [_| Suivants] = CP,
119 Suivants;
120 true ->
121 CP
122 end,
123 Plus
124 }.
125
126
127 % C est le curseur (voir ci dessus)
128 % 'Messages' sont les messages que l'on doit enlever de la conversation
129 % S est le nombre de messages qu'il faut sauter.
130 % @spec conversation_principale2(qlc:QueryCursor(), [integer()], integer(), integer())
131 conversation_principale2(_, _, 0, _) ->
132 [];
133 conversation_principale2(C, Messages, N, S) ->
134 case qlc:next_answers(C, 1) of
135 [] -> [];
136 [M] -> % traitement message par message (pas des plus performant :/)
137 Doit_etre_saute = any(fun(E) -> E == M end, Messages),
138 if Doit_etre_saute ->
139 conversation_principale2(C, Messages, N, S); % le message ne fait pas partie de la conversation
140 S =:= 0 ->
141 [M | conversation_principale2(C, Messages, N - 1, S)]; % ok : le message fait partie de la conversation
142 true ->
143 conversation_principale2(C, Messages, N, S - 1) % on n'a pas encore atteint le début de la page
144 end
145 end.
146
147
148 % Renvoie un tuple {C, Cn, X, Plus} où
149 % C : La conversation complète
150 % Cn : La conversation tronqué en fonction de N, D et P
151 % X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
152 % Plus : true s'il y a encore des messages après
153 % Inputs :
154 % R : l'id d'un message représentant la racine de la conversation
155 % N : le nombre de message par page
156 % D : Le dernier message connu 0 si aucun de connu
157 % P : La page désirée
158 % @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()
159 conversation(R, N, D, P) ->
160 {C, X} = conversation([], [R], []),
161 Decalage = N * (P - 1) + 1,
162 {
163 reverse(C),
164 if Decalage > length(C) ->
165 [];
166 true ->
167 filter(
168 fun(E) -> E > D end,
169 reverse(sublist(C, Decalage, N))
170 )
171 end,
172 reverse(X),
173 Decalage + N - 1 < length(C)
174 }.
175
176
177 % 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
178 % Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.
179 % @spec conversation([integer()], [integer()], [integer()]) -> {}
180 conversation(Conv, [M | Reste], X) ->
181 Est_deja_traite = any(fun(E) -> E =:= M end, Conv),
182 if Est_deja_traite ->
183 conversation(Conv, Reste, X);
184 true ->
185 Enfants = enfants(M),
186 Parents = parents(M),
187 % 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
188 Est_message_externe = Parents -- Conv =/= [] orelse intersection(Parents, X) =/= [],
189 conversation([M | Conv], lists:merge(Reste, Enfants), if Est_message_externe -> [M | X]; true -> X end)
190 end;
191 conversation(Messages, [], X) ->
192 {Messages, X}.
193
194
195 % Renvoie les enfants d'un message M (les messages qui répondent à M)
196 % ordrés du plus petit au plus grand.
197 % @spec enfants(integer()) -> [integer()]
198 enfants(M) ->
199 resultat_transaction(transaction(fun() ->
200 e(q([E#reponse_minichat.repondant || E <- qlc:sort(table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.cible =:= M]))
201 end)).
202
203
204 % Renvoie les parents d'un message M (les messages auquels répond M)
205 % ordrés du plus petit au plus grand..
206 % @spec parents(integer()) -> [integer()]
207 parents(M) ->
208 resultat_transaction(transaction(fun() ->
209 e(q([E#reponse_minichat.cible || E <- keysort(1, table(reponse_minichat), [{order, ascending}]), E#reponse_minichat.repondant =:= M]))
210 end)).
211
212
213 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
214 % @spec intersection(list(term()), list(term())) -> list(term())
215 intersection(L1, L2) ->
216 filter(fun(X) -> lists:member(X, L1) end, L2).
217