Replace some french comments by english ones.
[euphorik.git] / pageMinichat / conversations.js
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 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
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 /*jslint laxbreak:true */
20
21 /**
22 * Représente l'ensemble des conversations affichés.
23 */
24 euphorik.Conversations = function(client, formateur, util) {
25 this.client = client;
26 this.formateur = formateur;
27 this.util = util;
28
29 // un ensemble des messages (id) auquel l'utilisateur répond (vider après l'envoie du message courant)
30 this.messagesRepond = {};
31
32 this.conversations = []; // les conversations, la première représente la conversation principale
33
34 this.nouvelleConversation(0);
35
36 this.trollIdCourant = 0;
37
38 this.comet = new Comet("chat", euphorik.conf.versionProtocole);
39 };
40
41 // les messages auquels l'utilisateur répond et qui sont insérés dans le document XHTML
42 // ont leur id prefixé par cette valeur, cela permet de les distinguer des "vrais" messages
43 euphorik.Conversations.prototype.prefixIdMessage = "rep";
44
45 /**
46 * Permet de définir un message comme étant ou n'étant plus un message auquel l'utilisateur
47 * répond.
48 */
49 euphorik.Conversations.prototype.toggleMessageRepond = function(mess) {
50 // est-ce que l'on répond déjà à ce message ? si oui alors on l'enlève de la liste
51 if (mess.id in this.messagesRepond) {
52 this.enleverMessageRepond(mess);
53 return;
54 }
55
56 this.ajouterMessageRepond(mess);
57 };
58
59 /**
60 * Enlève tous les messages auquel l'utilisateur souhaite répondre.
61 */
62 euphorik.Conversations.prototype.enleverMessagesRepond = function() {
63 var thisConversations = this;
64
65 objectEach(this.messagesRepond, function(messId, mess) {
66 thisConversations.enleverMessageRepond(mess);
67 });
68
69 // on réinitialise pour être sur que tout est bien enlevé
70 this.messagesRepond = {};
71 $("#conversations .message").removeClass("repondEnEvidence");
72 $("form#posterMessage #repondA .messages").empty();
73 };
74
75 /**
76 * Définit un message comme n'y répondant plus.
77 */
78 euphorik.Conversations.prototype.enleverMessageRepond = function(mess) {
79 $(this.exprIdsPotentiels(mess)).removeClass("repondEnEvidence");
80 $("#" + mess.getId(this.prefixIdMessage)).remove();
81 delete this.messagesRepond[mess.id];
82 this.rafraichireNombreMessagesRepond();
83 };
84
85 /**
86 * Définit un message comme y répondant.
87 */
88 euphorik.Conversations.prototype.ajouterMessageRepond = function(mess) {
89 var thisMessages = this;
90
91 // est-ce que le message fait partie de la même conversation que les autres messages ?
92 // TODO : solution plus élégante pour prendre un mess parmis messagesRepond !?
93 var mess2;
94 for (mess2 in this.messagesRepond) {
95 if (this.messagesRepond.hasOwnProperty(mess2)) {
96 mess2 = this.messagesRepond[mess2];
97 break;
98 }
99 }
100
101 if (mess2 && mess2.racineId !== mess.racineId) {
102 this.util.messageDialogue("Impossible de répondre à deux messages ne faisant pas partie de la même conversation");
103 return;
104 }
105
106 $("form#posterMessage #repondA .messages").append(mess.XHTML(undefined, this.prefixIdMessage));
107 this.messagesRepond[mess.id] = mess;
108
109 // ajout la classe 'repondEnEvidence' au message. comme il peut se trouver potentiellement dans
110 // chaque conversation on construit tous les id potentiels
111 $(mess.getId(this.prefixIdMessage) + ", " + this.exprIdsPotentiels(mess)).addClass("repondEnEvidence");
112
113 $("#" + mess.getId(this.prefixIdMessage)).click(
114 function() {
115 $(this).fadeOut("normal", function() {
116 thisMessages.enleverMessageRepond(mess);
117 $("form#posterMessage #repondA .messages").hide();
118 });
119 }
120 );
121 this.rafraichireNombreMessagesRepond();
122 };
123
124 /**
125 * Construit tous les id potentiels d'un message, renvoie par exemple :
126 * "conv9b28mess1h, conv9b2amess1h, conv9b32mess1h"
127 */
128 euphorik.Conversations.prototype.exprIdsPotentiels = function(mess) {
129 var exprMess = "";
130 this.conversations.each(function(i, conv) {
131 exprMess += (mess !== "" ? ", " : "") + "#" + mess.getId(conv.getId());
132 });
133 return exprMess;
134 };
135
136 /**
137 * Met à jour le nombre qui indique à l'utilisateur à combien de messages il répond.
138 */
139 euphorik.Conversations.prototype.rafraichireNombreMessagesRepond = function() {
140 // TODO : ya pas mieux pour trouver le nombre d'objet ?
141 var nb = objectMemberCount(this.messagesRepond);
142
143 $("#posterMessage #repondA .nb").text(nb);
144
145 var boite = $("#posterMessage #repondA");
146 if (nb > 0) {
147 boite.show();
148 } else {
149 boite.hide();
150 }
151 };
152
153 /**
154 * Affiche les messages auquel l'utilisateur souhaite répondre au sein des messages des conversations.
155 * Utilisé lorsqu'une conversation est extraite.
156 */
157 euphorik.Conversations.prototype.afficherMessagesRepondConversations = function() {
158 var expr = "";
159 objectEach(this.messagesRepond, function(messId, mess) {
160 expr += "#" + mess.getId() + ",";
161 });
162 $(expr).addClass("repondEnEvidence");
163 };
164
165 /**
166 * Crée un message JSON contenant le message demandant un rafraichissement.
167 */
168 euphorik.Conversations.prototype.getJSONrafraichirMessages = function() {
169 var mess = {
170 "message_count" : euphorik.conf.nbMessageAffiche,
171 "main_page" : this.client.pagePrincipale,
172 "conversations" : this.getJSONConversations(),
173 "troll_id" : this.trollIdCourant
174 };
175
176 if (this.client.cookie) {
177 mess.cookie = this.client.cookie;
178 }
179 mess.last_message_id = this.conversations[0].idDernierMessageAffiche;
180
181 return mess;
182 };
183
184 euphorik.Conversations.prototype.getJSONConversations = function() {
185 var thisConversations = this
186 var clientConv = [];
187
188 this.client.conversations.each(function(i, conv) {
189 clientConv.push({
190 root : conv.root,
191 page : conv.page,
192 last_message_id : thisConversations.conversations[i + 1] ? thisConversations.conversations[i + 1].idDernierMessageAffiche : 0
193 });
194 });
195 return clientConv;
196 };
197
198 /**
199 * Ajoute un ensemble de messages puis les affiches.
200 * @param elements un tableau d'éléments JSON représentant les messages, voir protocole.txt
201 * @param numConversation le numéro de la conversation auquel appartiennent les messages
202 * @return true si les messages on été ajoutés, false si la conversation n'existe pas et qu'il n'y a pas de message
203 */
204 euphorik.Conversations.prototype.ajouterMessages = function(elements, numConversation) {
205 if (!elements.messages.length) {
206 return this.conversations[numConversation] !== undefined;
207 }
208
209 for (var i = 0; i < elements.messages.length; i++) {
210 // si une nouvelle conversation a été créée alors on lui donne la racine
211 if (this.ajouterMessage(elements.messages[i], numConversation)) {
212 this.conversations[numConversation].setRacine(elements.first);
213 }
214 }
215
216 this.flush(numConversation);
217
218 // renseigne la conversation sur la page courante et si c'est la dernière
219 this.conversations[numConversation].setPage(
220 numConversation === 0 ? this.client.pagePrincipale : this.client.conversations[numConversation - 1].page,
221 elements.last_page
222 );
223
224 return true;
225 };
226
227 /**
228 * Création d'un nouveau message.
229 * Les message sont données dans l'ordre de leur id.
230 * @param element un element JSON représentant le message
231 * @param numConversation le numéro de la conversation, 0 = principale
232 * @return true si une nouvelle conversation a été créée sinon false
233 */
234 euphorik.Conversations.prototype.ajouterMessage = function(element, numConversation) {
235 var thisMessages = this;
236
237 // pas d'utilisation de jquery pour des raisons de performance
238 var message =
239 new euphorik.Message(
240 this.client,
241 this.formateur,
242 element
243 );
244
245 var nouvelleConversation = false;
246
247 if (!this.conversations[numConversation]) {
248 nouvelleConversation = true;
249 this.nouvelleConversation(
250 numConversation,
251 function(num) { // fermeture de la conversation
252 thisMessages.supprimerConversation(num);
253 },
254 function(num) { // insertion du lien vers la conversation
255 thisPage.util.replaceSelection(
256 $("form#posterMessage input.message")[0],
257 "{" + thisMessages.client.conversations[num-1].root.toString(36) + "}"
258 );
259 }
260 );
261 }
262
263 this.conversations[numConversation].ajouterMessage(message);
264 return nouvelleConversation;
265 };
266
267 euphorik.Conversations.prototype.nouvelleConversation = function(num, funFermer, funLien)
268 {
269 var thisMessages = this;
270
271 this.conversations[num] = new euphorik.Conversation(this, num);
272
273 if (funFermer) {
274 this.conversations[num].eventFermer(funFermer);
275 }
276
277 if (funLien) {
278 this.conversations[num].eventLien(funLien);
279 }
280
281 this.conversations[num].setFunPage(
282 function(num) { // page suivante
283 thisMessages.client.pageSuivante(num - 1);
284 thisMessages.rafraichirMessages(true);
285 },
286 function(num) { // page précédente
287 thisMessages.client.pagePrecedente(num - 1);
288 thisMessages.rafraichirMessages(true);
289 },
290 function(num) { // retour à la page une
291 if (thisMessages.client.goPremierePage(num - 1)) {
292 thisMessages.rafraichirMessages(true);
293 }
294 }
295 );
296
297 this.ajusterLargeurConversations();
298 };
299
300 /**
301 * Enlève une conversation.
302 */
303 euphorik.Conversations.prototype.supprimerConversation = function(num) {
304 if (num <= 0 || num >= this.conversations.length) {
305 return; // la numéro 0 ne peut être supprimé
306 }
307 this.conversations[num].supprimer();
308
309 // décalage TODO : supprimer le dernier élément
310 for (var i = num; i < this.conversations.length - 1; i++) {
311 this.conversations[i] = this.conversations[i+1];
312 this.conversations[i].num -= 1;
313 }
314 this.conversations.pop();
315 this.ajusterLargeurConversations();
316
317 this.client.supprimerConversation(num - 1);
318
319 this.rafraichirMessages(true);
320 };
321
322 /**
323 * Ajuste la largeur des conversations en fonction de leur nombre. modifie l'attribut CSS 'width'.
324 */
325 euphorik.Conversations.prototype.ajusterLargeurConversations = function() {
326 // TODO : trouver mieux !
327 var largeurPourcent = (100 / this.conversations.length);
328 // obsolète !?
329 // le "- 0.01" evite que IE se chie dessus lamentablement et affiche les conversations les unes au dessus des autres
330 //if($.browser["msie"])
331 // largeurPourcent -= 0.05
332
333 $("#conversations td").css("width", largeurPourcent + "%");
334 };
335
336 /**
337 * Demande à toutes les conversations de se flusher (afficher les messages non-affichés).
338 */
339 euphorik.Conversations.prototype.flushAll = function() {
340 for (var i = 0; i < this.conversations.length; i++) {
341 this.flush(i);
342 }
343 };
344
345 /**
346 * Demande à une conversation de se flusher.
347 */
348 euphorik.Conversations.prototype.flush = function(numConv) {
349 this.conversations[numConv].flush();
350 };
351
352 euphorik.Conversations.prototype.ouvrirConversation = function(racine) {
353 if (this.client.ajouterConversation(racine)) {
354 this.rafraichirMessages(true);
355 } else {
356 this.util.messageDialogue("Cette conversation est déjà ouverte");
357 }
358 };
359
360 euphorik.Conversations.prototype.viderMessages = function() {
361 this.conversations.each(function(i, conv) {
362 conv.viderMessages();
363 });
364 };
365
366 /**
367 * Met à jour les messages de manière continue.
368 * (AJAX-Comet-style proof)
369 * @param vider vide tous les messages avant d'afficher les nouveaux
370 */
371 euphorik.Conversations.prototype.rafraichirMessages = function(vider) {
372 var thisMessages = this;
373
374 vider = vider || false;
375
376 if (vider) {
377 this.conversations.each(function(i, conv) {
378 conv.idDernierMessageAffiche = 0;
379 });
380 }
381
382 this.comet.waitEvent(
383 function() { return thisMessages.getJSONrafraichirMessages(); },
384 {
385 "new_troll" :
386 function(data) {
387 thisMessages.trollIdCourant = data.troll_id;
388 $("#trollCourant .troll").html(thisMessages.formateur.traitementComplet(data.content)).unbind("click").click(
389 function() {
390 thisMessages.ouvrirConversation(data.message_id);
391 }
392 );
393
394 $("#trollCourant .troll a[@rel*=lightbox]").lightBox();
395 },
396 "new_messages" :
397 function(data) {
398 if (vider) {
399 thisMessages.viderMessages();
400 }
401
402 // ajoute les messages reçus à leur conversation respective
403 data.conversations.each(function(numConv, conv) {
404 if (!thisMessages.ajouterMessages(conv, numConv)) {
405 thisMessages.util.messageDialogue("La conversation {" + thisMessages.client.conversations[numConv - 1].root.toString(36) + "} n'existe pas");
406 thisMessages.client.supprimerConversation(numConv - 1);
407 }
408 });
409
410 if (vider) {
411 thisMessages.afficherMessagesRepondConversations();
412 }
413
414 vider = false;
415 }
416 }
417 );
418 };