Replace some french comments by english ones.
[euphorik.git] / pageMinichat / conversation.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 une conversation.
23 * Une conversation, au niveau XHTML, est formé de deux partie, le titre et les messages.
24 * Le titre comprend la navigation par page, un bouton pour la fermer, un bouton pour la plier, un bouton
25 * pour créer un lien ainsi que le premier message.
26 * @param conversations l'ensemble des conversations
27 * @param num le numéro de la conversation
28 */
29 euphorik.Conversation = function(conversations, num) {
30 this.conversations = conversations;
31
32 // peut changer au cours de la vie de la conversation, n'est pas un id !
33 this.num = num;
34
35 this.id = Math.floor(Math.random() * 1000000).toString(36);
36
37 this.util = this.conversations.util;
38 this.formateur = this.conversations.formateur;
39 this.client = this.conversations.client;
40
41 this.idDernierMessageAffiche = 0;
42 this.racine = undefined;
43
44 this.messages = [];
45 this.messagesParId = {};
46
47 this.nbMessageMax = euphorik.conf.nbMessageAffiche; // Le nombre de message affiché par page
48
49 var messagesXHTML = '<div class="messages"></div>';
50 var messageRacineXHTML = '<div class="messageRacine"></div>';
51 var reverse = this.client.chatOrder === "reverse";
52
53 var XHTML =
54 '<td class="conversation" id="' + this.getId() + '">' +
55 (reverse ? messagesXHTML : "") +
56 '<div class="titre">' +
57 (reverse ? messageRacineXHTML : "") +
58 '<div class="nav">' +
59 (num === 0 ? '' : '<div class="fermer"></div><div class="lien"></div><div class="reduire"></div>') +
60 '<span class="next">&lt;</span><span class="numPage">1</span><span class="prev">&gt;</span>' +
61 '</div>' +
62 (reverse ? "" : messageRacineXHTML) +
63 '</div>' +
64 (reverse ? "" : messagesXHTML) +
65 '</td>';
66
67 $("#conversations tr").append(XHTML);
68
69 this.util.infoBulle("Aller à la première page", $("#" + this.getId() + " .numPage"), euphorik.Util.positionBulleType.haut);
70 if (num !== 0) {
71 this.util.infoBulle("Créer un lien vers la conversation", $("#" + this.getId() + " .lien"));
72 this.util.infoBulle("Fermer la conversation", $("#" + this.getId() + " .fermer"));
73 }
74 };
75
76 /**
77 * @racine un message représentant la racine de la conversation, vaut undefined pour la conversation générale
78 */
79 euphorik.Conversation.prototype.setRacine = function(racineElement) {
80 this.racine = new euphorik.Message(this.client, this.formateur, racineElement);
81 };
82
83 /**
84 * Met à jour la racine, décide de l'afficher ou non.
85 * On l'affiche uniquement si le message racine n'est pas déjà affiché sur la liste des messages.
86 */
87 euphorik.Conversation.prototype.majRacine = function() {
88 if (!this.racine) {
89 return;
90 }
91
92 if (!(this.racine.id in this.messagesParId)) {
93 this.messagesParId[this.racine.id] = this.racine;
94 var element = $(this.racine.XHTML(true, this.getId()));
95 this.attacherEventsSurMessage(element);
96 $("#" + this.getId() + " .titre .messageRacine").html(element);
97 }
98 };
99
100 euphorik.Conversation.prototype.enleverMiseEnEvidence = function() {
101 $("#" + this.getId() + " .message").removeClass("cache");
102 };
103
104 euphorik.Conversation.prototype.colorerEntetes = function() {
105 var thisConversation = this;
106
107 var messagesReponse = "";
108 var messagesRepondu = "";
109 var messagesProprietaire = "";
110 this.messages.each(function(i, mess) {
111 if (mess.appartientAuClient) {
112 messagesProprietaire += "#" + mess.getId(thisConversation.getId()) + ",";
113 } else if (mess.clientARepondu) {
114 messagesRepondu += "#" + mess.getId(thisConversation.getId()) + ",";
115 } else if (mess.estUneReponse) {
116 messagesReponse += "#" + mess.getId(thisConversation.getId()) + ",";
117 }
118 });
119 $(messagesReponse).addClass("reponse");
120 $(messagesRepondu).addClass("repondu");
121 $(messagesProprietaire).addClass("proprietaire");
122 };
123
124 euphorik.Conversation.prototype.decolorerEntetes = function() {
125 $("#" + this.getId() + " .messages .message")
126 .removeClass("reponse")
127 .removeClass("repondu")
128 .removeClass("proprietaire");
129 };
130
131 /**
132 * Défini la page courante et s'il l'on se trouve sur la dernière page.
133 * @pageCourante la page courante
134 * @dernierePage true si c'est la dernière page sinon false
135 */
136 euphorik.Conversation.prototype.setPage = function(pageCourante, dernierePage) {
137 $("#" + this.getId() + " .numPage").text(pageCourante);
138 $("#" + this.getId() + " .next").css("display", pageCourante === 1 ? "none" : "inline");
139 $("#" + this.getId() + " .prev").css("display", dernierePage ? "none" : "inline");
140 };
141
142 /**
143 * Evenement déclanché lors de l'insertion du lien de la conversation dans le message courant.
144 */
145 euphorik.Conversation.prototype.eventLien = function(fun) {
146 var thisConversation = this;
147
148 $("#" + this.getId() + " .titre .lien").click(
149 function() {
150 fun(thisConversation.num);
151 }
152 );
153 };
154
155 /**
156 * Evenement déclanché lors de la fermeture de la conversation.
157 */
158 euphorik.Conversation.prototype.eventFermer = function(fun) {
159 var thisConversation = this;
160
161 $("#" + this.getId() + " .titre .fermer").click(
162 function() {
163 fun(thisConversation.num);
164 }
165 );
166 };
167
168 /**
169 * @funNext appelé lorsque l'on passe à la page suivante (de 2 à 1 par exemple)
170 * @funPrev appelé lorsque l'on passe à la page précédente (de 1 à 2 par exemple)
171 * @funReset appelé lorsque l'on souhaite revenir à la page une
172 */
173 euphorik.Conversation.prototype.setFunPage = function(funNext, funPrev, funReset) {
174 var thisConversation = this;
175
176 $("#" + this.getId() + " .next").click(
177 function() { funNext(thisConversation.num); }
178 );
179 $("#" + this.getId() + " .prev").click(
180 function() { funPrev(thisConversation.num); }
181 );
182 $("#" + this.getId() + " .numPage").click(
183 function() { funReset(thisConversation.num); }
184 );
185 };
186
187 /**
188 * Retourne l'id de la conversation sous la forme (par exemple) "conv3".
189 */
190 euphorik.Conversation.prototype.getId = function() {
191 return "conv" + this.id;
192 };
193
194 euphorik.Conversation.prototype.ajouterMessage = function(message) {
195 this.messages.push(message);
196 this.messagesParId[message.id] = message;
197
198 // enlève les messages exedentaires
199 if (this.messages.length > this.nbMessageMax) {
200 delete this.messagesParId[this.messages.shift().id];
201 }
202 };
203
204 /**
205 * FIXME : méthode très lourde. ne serait-ce pas mieux de virer d'un coup l'élément conversation et d'en remettre un vide ?
206 */
207 euphorik.Conversation.prototype.viderMessages = function() {
208 this.messages = [];
209 this.messagesParId = {};
210 this.idDernierMessageAffiche = 0;
211 $("#" + this.getId() + " .messages .message").remove();
212
213 // enlève également la racine
214 $("#" + this.getId() + " .titre .messageRacine").empty();
215 };
216
217 euphorik.Conversation.prototype.idMessageFromString = function(idString) {
218 return parseInt(idString.substr(4 + this.getId().length), 36);
219 };
220
221 /**
222 * Après l'ajout d'un ou plusieurs message cette méthode est appelée afin
223 * d'afficher les messages non-affichés.
224 * FIXME : méthode super lourde, à optimiser.
225 */
226 euphorik.Conversation.prototype.flush = function() {
227 var thisConversation = this;
228 var reverse = this.client.chatOrder === "reverse";
229
230 // est-ce que le prochain message est pair ? (permet d'alterner le style des messages)
231 var messagePair = (this.idDernierMessageAffiche === 0 ? true :
232 ($("#" + this.getId() + " .messages div:" + (reverse ? "first" : "last")).attr("class").search("messagePair") === -1)
233 );
234
235 // construction de l'XHTML des messages
236 var XHTML = "";
237 this.messages.each(function(i, mess) {
238 if (mess.id > thisConversation.idDernierMessageAffiche) {
239 XHTML += mess.XHTML(messagePair, thisConversation.getId());
240 messagePair = !messagePair;
241 }
242 });
243
244 var DOM = $(XHTML);
245
246 // pour chaque nouveau message au niveau du document on lui assigne ses événements
247 DOM.each(function() { thisConversation.attacherEventsSurMessage(this); });
248
249 if (reverse) {
250 DOM.prependTo("#" + this.getId() + " .messages");
251 } else {
252 DOM.appendTo("#" + this.getId() + " .messages");
253 }
254
255 // enlève les messages exedentaires au niveau du document
256 var nbMessagesAffiche = $("#" + this.getId() + " .messages .message").size();
257 if (nbMessagesAffiche > this.nbMessageMax) {
258 if (reverse) {
259 $("#" + this.getId() + " .messages .message").slice(this.nbMessageMax, nbMessagesAffiche).remove();
260 } else {
261 $("#" + this.getId() + " .messages .message").slice(0, nbMessagesAffiche - this.nbMessageMax).remove();
262 }
263 }
264
265 if (this.messages.length > 0) {
266 this.idDernierMessageAffiche = this.messages[this.messages.length-1].id;
267 }
268
269 // met à jour la racine de la conversation
270 this.majRacine();
271 };
272
273 /**
274 * Attache des événements à un message donné.
275 * @element le message du DOM
276 */
277 euphorik.Conversation.prototype.attacherEventsSurMessage = function(element) {
278 // l'id du message
279 var idMess = this.idMessageFromString($(element).attr("id"));
280
281 this.util.infoBulle("Extraction de la conversation à partir de ce message", $(".extraire", element));
282 this.util.infoBulle("Extraction de la conversation complète", $(".extraireCompletement", element));
283
284 var thisConversation = this;
285 $(".lienConv", element).click(
286 function(event) {
287 // FIXME : ya pas mieux ?
288 var racine = $(event.target).text();
289 thisConversation.conversations.ouvrirConversation(parseInt(racine.substring(1, racine.length - 1), 36));
290 return false;
291 }
292 );
293
294 $(element).click(
295 function(event) {
296 if ($(event.target).is("a") || $(event.target).parents("#outilsBan").length > 0) {
297 return;
298 }
299
300 // extraction d'une conversation
301 if ($(event.target).is(".extraire")) {
302 thisConversation.conversations.ouvrirConversation(idMess);
303 return;
304 }
305
306 if ($(event.target).is(".extraireCompletement")) {
307 thisConversation.conversations.ouvrirConversation(thisConversation.messagesParId[idMess].racineId);
308 return;
309 }
310
311 // met ou enlève la mise en evidence du message
312 thisConversation.conversations.toggleMessageRepond(thisConversation.messagesParId[idMess]);
313
314 // donne le focus à la ligne de saisie
315 $("form input.message").focus();
316 }
317 );
318
319 // mise en évidence de la conversation
320 $(".entete", element).hover(
321 function() {
322 thisConversation.decolorerEntetes();
323 thisConversation.afficherConversation(idMess);
324 },
325 // quand on sort de l'entête du message la mise en évidence est enlevée
326 function() {
327 thisConversation.enleverMiseEnEvidence();
328 thisConversation.decolorerEntetes();
329 thisConversation.colorerEntetes();
330 }
331 );
332
333 // est-ce que l'on affichage la date du message ?
334 if (thisConversation.client.viewTimes) {
335 $(".dateComplete", element).show();
336 } else {
337 $(".dateComplete", element).hide();
338 }
339
340 $("a[@rel*=lightbox]", element).lightBox();
341
342 // les outils de bannissement (uniquement pour les ekMaster)
343 if (thisConversation.client.ekMaster) {
344 $(".pseudo", element).hover(
345 function(e) {
346 var userId = parseInt($(".id", this).text(), 10);
347 var pseudo = $(this);
348 var h = pseudo.outerHeight();
349 var offset = pseudo.offset();
350 // TODO : calculer automatiquement la largeur plutôt que d'inscrire des valeurs en brut'
351 thisConversation.util.outilsBan.css("top", offset.top - 2).css("left", offset.left - 2).height(h < 16 ? 16 : h).width(pseudo.outerWidth() + 16 * 3 + 12 + 64).prependTo(this).show();
352 $("img", thisConversation.util.outilsBan).unbind("click");
353 $("#slap", thisConversation.util.outilsBan).click(
354 function() {
355 thisConversation.client.slap(userId, $("#outilsBan input").val());
356 $("#outilsBan input").val("");
357 $("#outilsBan").hide();
358 }
359 );
360 $("#kick", thisConversation.util.outilsBan).click(
361 function() {
362 thisConversation.client.kick(userId, $("#outilsBan input").val());
363 $("#outilsBan input").val("");
364 $("#outilsBan").hide();
365 }
366 );
367 $("#ban", thisConversation.util.outilsBan).click(
368 function() {
369 thisConversation.client.ban(userId, $("#outilsBan input").val());
370 $("#outilsBan input").val("");
371 $("#outilsBan").hide();
372 }
373 );
374 },
375 function() {
376 $("#outilsBan", this).hide();
377 }
378 );
379 }
380 };
381
382 /**
383 * Etablit une liste des messages à mettre en evidence et des messages à cacher.
384 * Puis applique un plan diabolique.
385 * @param id l'id du message
386 */
387 euphorik.Conversation.prototype.afficherConversation = function(id) {
388 var thisConversation = this;
389
390 var message = this.messagesParId[id];
391 if (!message) {
392 return;
393 }
394
395 var mess = message.getConversation(this);
396
397 // FIXME : cet appel est très lent
398 $("#" + this.getId() + " .messages .message").each(
399 function() {
400 var jq = $(this);
401 var statut = mess[thisConversation.idMessageFromString(jq.attr("id"))];
402 if (!statut) {
403 jq.addClass("cache");
404 } else {
405 jq.removeClass("cache");
406 switch (statut) {
407 // "repondu" et "reponse" sont prioritaitres à "proprietaire"
408 // contrairement à la vue normale (sans mise en évidence d'une conversation)
409 case 3 :
410 jq.addClass("repondu");
411 break;
412 case 2 :
413 jq.addClass("reponse");
414 break;
415 case 1 :
416 jq.addClass("proprietaire");
417 break;
418 }
419 }
420 }
421 );
422 };
423
424 /**
425 * Supprime une conversation.
426 * Ne l'enlève pas du DOM.
427 */
428 euphorik.Conversation.prototype.supprimer = function() {
429 $("#" + this.getId()).remove();
430 };