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