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