2 % Ce module permet la gestion des conversations du minichat d'euphorik.
3 % Un message (enfant) peut répondre à des messages (ses parents).
4 % Un message (parent) peut avoir plusieurs réponses (enfants)
7 % @type Message() = {integer(), [integer()]}
8 % @type Conversation_detailee() = {[integer()], [integer()], [integer()], bool()}
9 % @type Conversation = {[Message()] , bool()} bool() : si true alors il y a encore des messages dans les pages suivantes.
11 -module(euphorik_minichat_conversation
).
16 -include("euphorik_bd.hrl").
17 -include_lib("stdlib/include/qlc.hrl").
19 -import(lists
, [reverse
/1, any
/2, map
/2, sublist
/3, filter
/2]).
20 -import(euphorik_minichat
, [resultat_transaction
/1]).
21 -import(qlc
, [e
/1, q
/1, keysort
/3]).
22 -import(mnesia
, [table
/1, transaction
/1]).
25 % Renvoie les conversations sous la forme d'une liste de conversation.
26 % Chaque conversation est un tuple {[{Message, Parents}], Plus} où
27 % Message est le message de type #minichat et Parents une liste d'Id.
28 % Plus est un bool. Si Plus vaut true alors il y a encore des messages.
29 % Si il n'y a pas de nouveaux message alors la fonction est bloquante et attend un nouveau message.
30 % @spec conversations([{integer(), integer()}, integer(), integer(), integer()) -> [Conversation()]
31 conversations(Racines
, N
, D
, P
) ->
32 % écoute des nouveaux messages
33 case subscribe(minichat
, 2) of
37 % demande des conversations
38 Conversations
= conversations_detailees(Racines
, N
, D
, P
),
39 % si les conversations sont vides alors on attend un nouveau message
44 {_
, [], _
, _
} -> false
;
50 Conversations_mises_en_forme
= mise_en_forme_conversations(
52 attend_nouveau_message(),
53 conversations_detailees(Racines
, N
, D
, P
);
58 unsubscribe(minichat
),
59 Conversations_mises_en_forme
63 % Ecoute les événements de modification d'une table.
64 % @spec subscribe(atom(), integer()) -> ok | erreur
65 subscribe(_Table
, 0) ->
67 subscribe(Table
, C
) ->
68 case mnesia:subscribe({table
, Table
, simple
}) of
69 {error
, {not_active_local
, Table
}} ->
70 mnesia:add_table_copy(minichat
, node(), ram_copies
),
71 subscribe(Table
, C
- 1);
79 % Arrête d'écouter les modifications d'une table.
80 % @spec unsubscribe(atom()) -> term()
82 mnesia:unsubscribe({table
, Table
, simple
}).
85 % Attend qu'un nouveau message arrive, function bloquante.
86 % Renvoie le nouveau message.
87 % @spec attend_nouveau_message() -> #minichat | timeout
88 attend_nouveau_message() ->
89 receive % attente d'un post
90 {mnesia_table_event
, {write
, Message
, _
}} ->
94 %~ mnesia:unsubscribe({table, minichat, simple});
96 attend_nouveau_message()
97 % 60 minutes de timeout (le cas ou il n'y a que des consultations et jamais de post)
98 % Après 60 minutes de connexion, le client doit donc reétablir une connexion
99 % TODO : pour être mieux : quand le socket se ferme alors un message devrait être envoyé et débloquer ce receive (demande en cours sur la mailing list de yaws)
100 after 1000 * 60 * 60 ->
105 % Mise en forme des conversations pour l'utilisateur du module.
106 % @spec mise_en_forme_conversations([[integer()] | Conversation_detailee()]) -> [Conversation()]
107 mise_en_forme_conversations([]) -> [];
108 mise_en_forme_conversations([{Principale
, Plus_principale
} | Conversations
]) ->
109 [{mise_en_forme_conversation(Principale
), Plus_principale
} | map(fun({_
, Cn
, _
, Plus
}) -> {mise_en_forme_conversation(Cn
), Plus
} end, Conversations
)].
112 % Mise en forme d'une liste d'id de messages : [4, 5, 8, ...] -> [{4, [5, 6]}, ...].
113 % Ajoute les parents de chaque message.
114 % @spec mise_en_forme_conversation([integer()]) -> [{integer(), [integer()]}]
115 mise_en_forme_conversation(Messages
) ->
118 {ok
, Message
} = euphorik_minichat:message_by_id(Id
),
119 {Message
, parents(Id
)}
125 % Renvoie une liste de conversations, le première élément correspond à la conversation principale.
126 % Les autres éléments sont des tuples {C, Cn, X}, voir conversation/4 pour plus d'infos.
127 % Racines est une liste de tuple {Id, P} des racines des conversations ou P est la page et Id l'id du message.
128 % @spec conversations_detailees([{integer(), integer()}], integer(), integer(), integer()) -> [[integer()] | Conversation_detailee()]
129 conversations_detailees(Racines
, N
, D
, P
) ->
130 Conversations
= map(fun({Racine
, P_conv
}) -> conversation(Racine
, N
, D
, P_conv
) end, Racines
),
131 Conversation_principale
= resultat_transaction(transaction(fun() ->
132 Curseur
= qlc:cursor(q([E#minichat
.id
|| E
<- qlc:sort(table(minichat
), [{order
, descending
}])])),
133 {CP
, Plus
} = conversation_principale(Curseur
, Conversations
, N
, P
),
134 qlc:delete_cursor(Curseur
),
135 {reverse([M
|| M
<- CP
, M
> D
]), Plus
} % filtre en fonction de D
137 [Conversation_principale
| Conversations
].
140 % Construit la conversation principale en fonction d'un curseur C initialement placé sur le dernier message
141 % et la liste de conversations.
142 % N est le nombre de messages que l'on souhaite.
143 % P est le numéro de la page (1, 2, 3...)
144 % Renvoie {[Id], Plus}
145 % @spec conversation_principale(qlc:QueryCursor(), [Conversation_detailee()], integer(), integer())
146 conversation_principale(C
, Conversations
, N
, P
) ->
147 CP
= conversation_principale2(C
, lists:flatten(map(fun({C2
, _
, X
, _
}) -> C2
-- X
end, Conversations
)), N
+ 1, (P
- 1) * N
),
148 Plus
= length(CP
) =:= N
+ 1,
160 % C est le curseur (voir ci dessus)
161 % 'Messages' sont les messages que l'on doit enlever de la conversation
162 % S est le nombre de messages qu'il faut sauter.
163 % @spec conversation_principale2(qlc:QueryCursor(), [integer()], integer(), integer())
164 conversation_principale2(_
, _
, 0, _
) ->
166 conversation_principale2(C
, Messages
, N
, S
) ->
167 case qlc:next_answers(C
, 1) of
169 [M
] -> % traitement message par message (pas des plus performant :/)
170 Doit_etre_saute
= any(fun(E
) -> E
== M
end, Messages
),
171 if Doit_etre_saute
->
172 conversation_principale2(C
, Messages
, N
, S
); % le message ne fait pas partie de la conversation
174 [M
| conversation_principale2(C
, Messages
, N
- 1, S
)]; % ok : le message fait partie de la conversation
176 conversation_principale2(C
, Messages
, N
, S
- 1) % on n'a pas encore atteint le début de la page
181 % Renvoie un tuple {C, Cn, X, Plus} où
182 % C : La conversation complète
183 % Cn : La conversation tronqué en fonction de N, D et P
184 % X : La liste des messages répondant à des mess qui ne font pas partie de la conversation
185 % Plus : true s'il y a encore des messages après
187 % R : l'id d'un message représentant la racine de la conversation
188 % N : le nombre de message par page
189 % D : Le dernier message connu 0 si aucun de connu
190 % P : La page désirée
191 % @spec conversation([integer()], integer(), integer(), integer()) -> Conversation_detailee()
192 conversation(R
, N
, D
, P
) ->
193 {C
, X
} = conversation([], [R
], []),
194 Decalage
= N
*(P
-1)+1,
197 if Decalage
> length(C
) ->
202 sublist(C
, Decalage
, N
)
206 Decalage
+ N
- 1 < length(C
)
210 % 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
211 % Attention : les messages de C et de X sont ordrés du plus grand Id au plus petit.
212 % @spec conversation([integer()], [integer()], [integer()]) -> {}
213 conversation(Messages
, [M
| Reste
], X
) ->
214 Est_deja_traite
= any(fun(E
) -> E
=:= M
end, Messages
),
215 if Est_deja_traite
->
216 conversation(Messages
, Reste
, X
);
218 Enfants
= enfants(M
),
219 Parents
= parents(M
),
220 % un message est dit exiterne si un de ses parent ne fait pas partie de la conversation ou si un de ses parents fait partie de X
221 Est_message_externe
= Parents
-- Messages
=/= [] orelse
intersection(Parents
, X
) =/= [],
222 conversation([M
| Messages
], Reste
++ Enfants
, if Est_message_externe
-> [M
| X
]; true
-> X
end)
224 conversation(Messages
, [], X
) ->
228 % Renvoie les enfants d'un message M (les messages qui répondent à M)
229 % ordrés du plus petit au plus grand.
230 % @spec enfants(integer()) -> [integer()]
232 resultat_transaction(transaction(fun() ->
233 e(q([E#reponse_minichat
.repondant
|| E
<- qlc:sort(table(reponse_minichat
), [{order
, ascending
}]), E#reponse_minichat
.cible
=:= M
]))
237 % Renvoie les parents d'un message M (les messages auquels répond M)
238 % ordrés du plus petit au plus grand..
239 % @spec parents(integer()) -> [integer()]
241 resultat_transaction(transaction(fun() ->
242 e(q([E#reponse_minichat
.cible
|| E
<- keysort(1, table(reponse_minichat
), [{order
, ascending
}]), E#reponse_minichat
.repondant
=:= M
]))
246 % Intersection entre deux listes : [1, 3, 4] n [2, 4, 7] = [4]
247 % @spec intersection(list(term()), list(term())) -> list(term())
248 intersection(L1
, L2
) ->
249 filter(fun(X
) -> lists:member(X
, L1
) end, L2
).