2 % Copyright 2008 Grégory Burri
4 % This file is part of Euphorik.
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.
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.
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/>.
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)
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.
29 -module(euphorik_minichat_conversation
).
33 -include("../include/euphorik_bd.hrl").
34 -include("../include/euphorik_defines.hrl").
35 -include_lib("stdlib/include/qlc.hrl").
36 -import(lists
, [reverse
/1, any
/2, map
/2, sublist
/3, filter
/2]).
37 -import(euphorik_bd
, [resultat_transaction
/1]).
38 -import(qlc
, [e
/2, q
/1]).
39 -import(mnesia
, [table
/1, transaction
/1]).
42 % Renvoie les conversations sous la forme d'une liste de conversation.
43 % Chaque conversation est un tuple {[{Message, Parents}], Plus} où
44 % Message est le message de type #minichat et Parents une liste d'Id.
45 % Plus est un bool. Si Plus vaut true alors il y a encore des messages.
46 % Si il n'y a pas de nouveaux message alors vide est renvoyé.
47 % Chaque racine est un tuple {N, P, D}
48 % N : le nombre de message
49 % D : le dernier message connu, 0 si aucun
50 % P : la page souhaité, la premier est la 1
51 % @spec conversations([{integer(), integer(), integer()}], integer(), integer(), integer()) -> [Conversation()]
52 conversations(Racines
, N
, D
, P
) ->
53 Conversations
= conversations_detailees(Racines
, N
, D
, P
),
54 % si les conversations sont vides alors on attend un nouveau message
59 {_
, [], _
, _
} -> false
;
68 mise_en_forme_conversations(Conversations
)
72 % Mise en forme des conversations pour l'utilisateur du module.
73 % @spec mise_en_forme_conversations([[integer()] | Conversation_detailee()]) -> [Conversation()]
74 mise_en_forme_conversations([]) -> [];
75 mise_en_forme_conversations([{Principale
, Plus_principale
} | Conversations
]) ->
76 [{mise_en_forme_conversation(Principale
), Plus_principale
} | map(fun({_
, Cn
, _
, Plus
}) -> {mise_en_forme_conversation(Cn
), Plus
} end, Conversations
)].
79 % Mise en forme d'une liste d'id de messages : [4, 5, 8, ...] -> [{4, [5, 6]}, ...].
80 % Ajoute les parents de chaque message.
81 % @spec mise_en_forme_conversation([integer()]) -> [{integer(), [integer()]}]
82 mise_en_forme_conversation(Messages
) ->
83 resultat_transaction(mnesia:transaction(
87 case euphorik_bd:message_by_id(Id
) of
89 [{Message
, parents(Id
)} | Acc
];
101 % Renvoie une liste de conversations, le première élément correspond à la conversation principale.
102 % Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
103 % Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
104 % @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[integer()] | Conversation_detailee()]
105 conversations_detailees(Racines
, N
, D
, P
) ->
106 Conversations
= map(fun({Racine
, P_conv
, Dernier
}) -> conversation(Racine
, N
, Dernier
, P_conv
) end, Racines
),
107 Conversation_principale
= resultat_transaction(transaction(fun() ->
108 Curseur
= qlc:cursor(
109 qlc:sort(q([E#minichat
.id
|| E
<- table(minichat
)]), [{order
, descending
}]),
110 [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]
112 {CP
, Plus
} = conversation_principale(Curseur
, Conversations
, N
, P
),
113 qlc:delete_cursor(Curseur
),
114 {[M
|| M
<- CP
, M
> D
], Plus
} % filtre en fonction de D
116 [Conversation_principale
| Conversations
].
119 % Construit la conversation principale en fonction d'un curseur C 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(qlc:QueryCursor(), [Conversation_detailee()], integer(), integer()) -> {[Id], Plus}
124 conversation_principale(C
, 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(C
, lists:flatten(map(fun({C2
, _
, X
, _
}) -> C2
-- X
end, Conversations
)), N
+ 1, (P
- 1) * N
)),
127 Plus
= length(CP
) =:= N
+ 1,
139 % C est le curseur (voir ci 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(qlc:QueryCursor(), [integer()], integer(), integer())
143 conversation_principale2(_
, _
, 0, _
) ->
145 conversation_principale2(C
, Messages
, N
, S
) ->
146 case qlc:next_answers(C
, 1) of
148 [M
] -> % traitement message par message (pas des plus performant :/)
149 Doit_etre_saute
= any(fun(E
) -> E
== M
end, Messages
),
150 if Doit_etre_saute
->
151 conversation_principale2(C
, Messages
, N
, S
); % le message ne fait pas partie de la conversation
153 [M
| conversation_principale2(C
, Messages
, N
- 1, S
)]; % ok : le message fait partie de la conversation
155 conversation_principale2(C
, Messages
, N
, S
- 1) % on n'a pas encore atteint le début de la page
160 % Renvoie un tuple {C, Cn, X, Plus} où
161 % C : La conversation complète
162 % Cn : La conversation tronqué en fonction de N, D et P
163 % X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
164 % Plus : true s'il y a encore des messages après
166 % R : l'id d'un message représentant la racine de la conversation
167 % N : le nombre de message par page
168 % D : Le dernier message connu 0 si aucun de connu
169 % P : La page désirée
170 % @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()
171 conversation(R
, N
, D
, P
) ->
172 {C
, X
} = conversation([], [R
], []),
173 Decalage
= N
* (P
- 1) + 1,
176 if Decalage
> length(C
) ->
181 reverse(sublist(C
, Decalage
, N
))
185 Decalage
+ N
- 1 < length(C
)
189 % 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
190 % Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.
191 % @spec conversation([integer()], [integer()], [integer()]) -> {}
192 conversation(Conv
, [M
| Reste
], X
) ->
193 Est_deja_traite
= any(fun(E
) -> E
=:= M
end, Conv
),
194 if Est_deja_traite
->
195 conversation(Conv
, Reste
, X
);
197 Enfants
= enfants(M
),
198 Parents
= parents(M
),
199 % 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
200 Est_message_externe
= Parents
-- Conv
=/= [] orelse
intersection(Parents
, X
) =/= [],
201 conversation([M
| Conv
], lists:merge(Reste
, Enfants
), if Est_message_externe
-> [M
| X
]; true
-> X
end)
203 conversation(Messages
, [], X
) ->
207 % Renvoie les enfants d'un message M (les messages qui répondent à M)
208 % ordrés du plus petit au plus grand.
209 % @spec enfants(integer()) -> [integer()]
211 resultat_transaction(transaction(fun() ->
214 q([E#reponse_minichat
.repondant
|| E
<- table(reponse_minichat
), E#reponse_minichat
.cible
=:= M
]),
217 [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]
222 % Renvoie les parents d'un message M (les messages auquels répond M)
223 % ordrés du plus petit au plus grand..
224 % @spec parents(integer()) -> [integer()]
226 resultat_transaction(transaction(fun() ->
229 q([E#reponse_minichat
.cible
|| E
<- table(reponse_minichat
), E#reponse_minichat
.repondant
=:= M
]),
232 [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]
237 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
238 % @spec intersection(list(term()), list(term())) -> list(term())
239 intersection(L1
, L2
) ->
240 filter(fun(X
) -> lists:member(X
, L1
) end, L2
).