kopete/libkopete/kopetechatsession.cpp

   1 /*
   2     kopetechatsession.cpp - Manages all chats
   3
   4     Copyright (c) 2002      by Duncan Mac-Vicar Prett <duncan@kde.org>
   5     Copyright (c) 2002      by Daniel Stone           <dstone@kde.org>
   6     Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>
   7     Copyright (c) 2002-2004 by Olivier Goffart        <ogoffart@kde.org>
   8     Copyright (c) 2003      by Jason Keirstead        <jason@keirstead.org>
   9     Copyright (c) 2005      by Michaël Larouche       <larouche@kde.org>
  10
  11     Kopete    (c) 2002-2003 by the Kopete developers  <kopete-devel@kde.org>
  12
  13     *************************************************************************
  14     *                                                                       *
  15     * This library is free software; you can redistribute it and/or         *
  16     * modify it under the terms of the GNU Lesser General Public            *
  17     * License as published by the Free Software Foundation; either          *
  18     * version 2 of the License, or (at your option) any later version.      *
  19     *                                                                       *
  20     *************************************************************************
  21 */
  22
  23 #include "kopetechatsession.h"
  24
  25 #include <qapplication.h>
  26 #include <qregexp.h>
  27
  28 #include <kdebug.h>
  29 #include <kdeversion.h>
  30 #include <kglobal.h>
  31 #include <klocale.h>
  32 #include <kmessagebox.h>
  33 #include <knotification.h>
  34
  35 #include "kopeteaccount.h"
  36 #include "kopetebehaviorsettings.h"
  37 #include "kopetecommandhandler.h"
  38 #include "kopetechatsessionmanager.h"
  39 #include "kopetemessagehandlerchain.h"
  40 #include "kopetemetacontact.h"
  41 #include "knotification.h"
  42 #include "kopeteuiglobal.h"
  43 #include "kopeteglobal.h"
  44 #include "kopeteview.h"
  45 #include "kopetecontact.h"
  46
  47 class KMMPrivate
  48 {
  49 public:
  50         Kopete::ContactPtrList mContactList;
  51         const Kopete::Contact *mUser;
  52         QMap<const Kopete::Contact *, Kopete::OnlineStatus> contactStatus;
  53         Kopete::Protocol *mProtocol;
  54         bool isEmpty;
  55         bool mCanBeDeleted;
  56         unsigned int refcount;
  57         bool customDisplayName;
  58         QDateTime awayTime;
  59         QString displayName;
  60         KopeteView *view;
  61         bool mayInvite;
  62         Kopete::MessageHandlerChain::Ptr chains[3];
  63 };
  64
  65 Kopete::ChatSession::ChatSession( const Kopete::Contact *user,
  66         Kopete::ContactPtrList others, Kopete::Protocol *protocol )
  67 : QObject( user->account())
  68 {
  69         int i;
  70
  71         d = new KMMPrivate;
  72         d->mUser = user;
  73         d->mProtocol = protocol;
  74         d->isEmpty = others.isEmpty();
  75         d->mCanBeDeleted = true;
  76         d->refcount = 0;
  77         d->view = 0L;
  78         d->customDisplayName = false;
  79         d->mayInvite = false;
  80
  81         for ( i = 0; others.size() != i; i++ )
  82                 addContact( others[i], true );
  83
  84         connect( user, SIGNAL( onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & ) ), this,
  85                 SLOT( slotOnlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & ) ) );
  86
  87         if( user->metaContact() )
  88                 connect( user->metaContact(), SIGNAL( photoChanged() ), this, SIGNAL( photoChanged() ) );
  89
  90         slotUpdateDisplayName();
  91 }
  92
  93 Kopete::ChatSession::~ChatSession()
  94 {
  95         //for ( Kopete::Contact *c = d->mContactList.first(); c; c = d->mContactList.next() )
  96         //      c->setConversations( c->conversations() - 1 );
  97
  98         if ( !d )
  99                 return;
 100         d->mCanBeDeleted = false; //prevent double deletion
 101         Kopete::ChatSessionManager::self()->removeSession( this );
 102         emit closing( this );
 103         delete d;
 104 }
 105
 106 void Kopete::ChatSession::slotOnlineStatusChanged( Kopete::Contact *c, const Kopete::OnlineStatus &status, const Kopete::OnlineStatus &oldStatus )
 107 {
 108         slotUpdateDisplayName();
 109         emit onlineStatusChanged((Kopete::Contact*)c, status, oldStatus);
 110 }
 111
 112 void Kopete::ChatSession::setContactOnlineStatus( const Kopete::Contact *contact, const Kopete::OnlineStatus &status )
 113 {
 114         Kopete::OnlineStatus oldStatus = d->contactStatus[ contact ];
 115         d->contactStatus[ contact ] = status;
 116         disconnect( contact, SIGNAL( onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & ) ),
 117                 this, SIGNAL( onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus &) ) );
 118         emit onlineStatusChanged( (Kopete::Contact*)contact, status, oldStatus );
 119 }
 120
 121 const Kopete::OnlineStatus Kopete::ChatSession::contactOnlineStatus( const Kopete::Contact *contact ) const
 122 {
 123         if ( d->contactStatus.contains( contact ) )
 124                 return d->contactStatus[ contact ];
 125
 126         return contact->onlineStatus();
 127 }
 128
 129 const QString Kopete::ChatSession::displayName()
 130 {
 131         if ( d->displayName.isNull() )
 132         {
 133                 slotUpdateDisplayName();
 134         }
 135
 136         return d->displayName;
 137 }
 138
 139 void Kopete::ChatSession::setDisplayName( const QString &newName )
 140 {
 141         d->displayName = newName;
 142         d->customDisplayName = true;
 143         emit displayNameChanged();
 144 }
 145
 146 void Kopete::ChatSession::slotUpdateDisplayName()
 147 {
 148         if( d->customDisplayName )
 149                 return;
 150
 151
 152         //If there is no member yet, don't try to update the display name
 153         if ( d->mContactList.isEmpty() )
 154                 return;
 155
 156         d->displayName.clear();
 157         for(int i = 0; i != d->mContactList.size(); i++ )
 158         {
 159                 Kopete::Contact * c = d->mContactList[i];
 160                 if(! d->displayName.isNull() )
 161                         d->displayName.append( QString::fromLatin1( ", " ) ) ;
 162
 163                 if ( c->metaContact() )
 164                         d->displayName.append( c->metaContact()->displayName() );
 165                 else
 166                 {
 167                         QString nick=c->property(Kopete::Global::Properties::self()->nickName()).value().toString();
 168                         d->displayName.append( nick.isEmpty() ? c->contactId() : nick );
 169                 }
 170         }
 171
 172         //If we have only 1 contact, add the status of him
 173         if ( d->mContactList.count() == 1 )
 174         {
 175                 d->displayName.append( QString::fromLatin1( " (%1)" ).arg( d->mContactList.first()->onlineStatus().description() ) );
 176         }
 177
 178         emit displayNameChanged();
 179 }
 180
 181 const Kopete::ContactPtrList& Kopete::ChatSession::members() const
 182 {
 183         return d->mContactList;
 184 }
 185
 186 const Kopete::Contact* Kopete::ChatSession::myself() const
 187 {
 188         return d->mUser;
 189 }
 190
 191 Kopete::Protocol* Kopete::ChatSession::protocol() const
 192 {
 193         return d->mProtocol;
 194 }
 195
 196
 197 #include "kopetemessagehandler.h"
 198 #include "kopetemessageevent.h"
 199
 200 // FIXME: remove this and the friend decl in KMM
 201 class Kopete::TemporaryKMMCallbackAppendMessageHandler : public Kopete::MessageHandler
 202 {
 203         Kopete::ChatSession *manager;
 204 public:
 205         TemporaryKMMCallbackAppendMessageHandler( Kopete::ChatSession *manager )
 206         : manager(manager)
 207         {
 208         }
 209         void handleMessage( Kopete::MessageEvent *event )
 210         {
 211                 Kopete::Message message = event->message();
 212                 emit manager->messageAppended( message, manager );
 213                 delete event;
 214         }
 215 };
 216
 217 class TempFactory : public Kopete::MessageHandlerFactory
 218 {
 219 public:
 220         Kopete::MessageHandler *create( Kopete::ChatSession *manager, Kopete::Message::MessageDirection )
 221         {
 222                 return new Kopete::TemporaryKMMCallbackAppendMessageHandler( manager );
 223         }
 224         int filterPosition( Kopete::ChatSession *, Kopete::Message::MessageDirection )
 225         {
 226                 // FIXME: somewhere after everyone else.
 227                 return 100000;
 228         }
 229 };
 230
 231 Kopete::MessageHandlerChain::Ptr Kopete::ChatSession::chainForDirection( Kopete::Message::MessageDirection dir )
 232 {
 233         if( dir < 0 || dir > 2)
 234                 kFatal(14000) << k_funcinfo << "invalid message direction " << dir << endl;
 235         if( !d->chains[dir] )
 236         {
 237                 TempFactory theTempFactory;
 238                 d->chains[dir] = Kopete::MessageHandlerChain::create( this, dir );
 239         }
 240         return d->chains[dir];
 241 }
 242
 243 void Kopete::ChatSession::sendMessage( Kopete::Message &message )
 244 {
 245         message.setManager( this );
 246         Kopete::Message sentMessage = message;
 247         if ( !Kopete::CommandHandler::commandHandler()->processMessage( message, this ) )
 248         {
 249                 emit messageSent( sentMessage, this );
 250                 if ( !account()->isAway() || Kopete::BehaviorSettings::self()->enableEventsWhileAway() )
 251                 {
 252                         KNotification::event(QString::fromLatin1( "kopete_outgoing" ),  i18n( "Outgoing Message Sent" ) );
 253                 }
 254         }
 255         else
 256         {
 257                 messageSucceeded();
 258         }
 259 }
 260
 261 void Kopete::ChatSession::messageSucceeded()
 262 {
 263         emit messageSuccess();
 264 }
 265
 266 void Kopete::ChatSession::emitNudgeNotification()
 267 {
 268         KNotification::event( QString::fromLatin1("buzz_nudge"), i18n("A contact sent you a buzz/nudge.") );
 269 }
 270
 271 void Kopete::ChatSession::appendMessage( Kopete::Message &msg )
 272 {
 273         msg.setManager( this );
 274
 275         if ( msg.direction() == Kopete::Message::Inbound )
 276         {
 277                 QString nick=myself()->property(Kopete::Global::Properties::self()->nickName()).value().toString();
 278                 if ( Kopete::BehaviorSettings::self()->highlightEnabled() && !nick.isEmpty() &&
 279                         msg.plainBody().contains( QRegExp( QString::fromLatin1( "\\b(%1)\\b" ).arg( nick ), Qt::CaseInsensitive ) ) )
 280                 {
 281                         msg.setImportance( Kopete::Message::Highlight );
 282                 }
 283
 284                 emit messageReceived( msg, this );
 285         }
 286
 287         // outbound messages here are ones the user has sent that are now
 288         // getting reflected back to the chatwindow. they should go down
 289         // the incoming chain.
 290         Kopete::Message::MessageDirection chainDirection = msg.direction();
 291         if( chainDirection == Kopete::Message::Outbound )
 292                 chainDirection = Kopete::Message::Inbound;
 293
 294         chainForDirection( chainDirection )->processMessage( msg );
 295 //      emit messageAppended( msg, this );
 296 }
 297
 298 void Kopete::ChatSession::addContact( const Kopete::Contact *c, const Kopete::OnlineStatus &initialStatus, bool suppress )
 299 {
 300         if( !d->contactStatus.contains(c) )
 301                 d->contactStatus[ c ] = initialStatus;
 302         addContact( c, suppress );
 303 }
 304
 305 void Kopete::ChatSession::addContact( const Kopete::Contact *c, bool suppress )
 306 {
 307         //kDebug( 14010 ) << k_funcinfo << endl;
 308         if ( d->mContactList.contains( (Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)(Kopete::Contact*)c ) )
 309         {
 310                 kDebug( 14010 ) << k_funcinfo << "Contact already exists" <<endl;
 311                 emit contactAdded( c, suppress );
 312         }
 313         else
 314         {
 315                 if ( d->mContactList.count() == 1 && d->isEmpty )
 316                 {
 317                         kDebug( 14010 ) << k_funcinfo << " FUCKER ZONE " << endl;
 318                         /* We have only 1 contact before, so the status of the
 319                            message manager was given from that contact status */
 320                         Kopete::Contact *old = d->mContactList.first();
 321                         d->mContactList.removeAll( old );
 322                         d->mContactList.append( (Kopete::Contact*)c );
 323
 324                         disconnect( old, SIGNAL( onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & ) ),
 325                         this, SLOT( slotOnlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus &) ) );
 326
 327                         if ( old->metaContact() )
 328                         {
 329                                 disconnect( old->metaContact(), SIGNAL( displayNameChanged( const QString &, const QString & ) ), this, SLOT( slotUpdateDisplayName() ) );
 330                                 disconnect( old->metaContact(), SIGNAL( photoChanged() ), this, SIGNAL( photoChanged() ) );
 331                         }
 332                         else
 333                                 disconnect( old, SIGNAL( propertyChanged( Kopete::Contact *, const QString &, const QVariant &, const QVariant & ) ), this, SLOT( slotUpdateDisplayName() ) );
 334                         emit contactAdded( c, suppress );
 335                         emit contactRemoved( old, QString::null );
 336                 }
 337                 else
 338                 {
 339                         d->mContactList.append( (Kopete::Contact*)c );
 340                         emit contactAdded( c, suppress );
 341                 }
 342
 343                 connect( c, SIGNAL( onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & ) ),
 344                         this, SLOT( slotOnlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus &) ) );
 345 ;
 346                 if ( c->metaContact() )
 347                 {
 348                         connect( c->metaContact(), SIGNAL( displayNameChanged( const QString &, const QString & ) ), this, SLOT( slotUpdateDisplayName() ) );
 349                         connect( c->metaContact(), SIGNAL( photoChanged() ), this, SIGNAL( photoChanged() ) );
 350                 }
 351                 else
 352                         connect( c, SIGNAL( propertyChanged( Kopete::Contact *, const QString &, const QVariant &, const QVariant & ) ), this, SLOT( slotUpdateDisplayName() ) );
 353                 connect( c, SIGNAL( contactDestroyed( Kopete::Contact * ) ), this, SLOT( slotContactDestroyed( Kopete::Contact * ) ) );
 354
 355                 slotUpdateDisplayName();
 356         }
 357         d->isEmpty = false;
 358 }
 359
 360 void Kopete::ChatSession::removeContact( const Kopete::Contact *c, const QString& reason, Kopete::Message::MessageFormat format, bool suppressNotification )
 361 {
 362         kDebug( 14010 ) << k_funcinfo << endl;
 363         if ( !c || !d->mContactList.contains( (Kopete::Contact*)c ) )
 364                 return;
 365
 366         if ( d->mContactList.count() == 1 )
 367         {
 368                 kDebug( 14010 ) << k_funcinfo << "Contact not removed. Keep always one contact" << endl;
 369                 d->isEmpty = true;
 370         }
 371         else
 372         {
 373                 d->mContactList.removeAll( (Kopete::Contact*)c );
 374
 375                 disconnect( c, SIGNAL( onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & ) ),
 376                         this, SLOT( slotOnlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus &) ) );
 377
 378                 if ( c->metaContact() )
 379                 {
 380                         disconnect( c->metaContact(), SIGNAL( displayNameChanged( const QString &, const QString & ) ), this, SLOT( slotUpdateDisplayName() ) );
 381                         disconnect( c->metaContact(), SIGNAL( photoChanged() ), this, SIGNAL( photoChanged() ) );
 382                 }
 383                 else
 384                         disconnect( c, SIGNAL( propertyChanged( Kopete::Contact *, const QString &, const QVariant &, const QVariant & ) ), this, SLOT( slotUpdateDisplayName() ) );
 385                 disconnect( c, SIGNAL( contactDestroyed( Kopete::Contact * ) ), this, SLOT( slotContactDestroyed( Kopete::Contact * ) ) );
 386
 387                 slotUpdateDisplayName();
 388         }
 389
 390         d->contactStatus.remove( c );
 391
 392         emit contactRemoved( c, reason, format, suppressNotification );
 393 }
 394
 395 void Kopete::ChatSession::receivedTypingMsg( const Kopete::Contact *c, bool t )
 396 {
 397         emit remoteTyping( c, t );
 398 }
 399
 400 void Kopete::ChatSession::receivedTypingMsg( const QString &contactId, bool t )
 401 {
 402         int i;
 403
 404         // FIXME: this needs better design. We can't iterate through List to find out who got what ID
 405         // hash will be better for that, right ?
 406         for ( i=0; i != d->mContactList.size(); i++ )
 407         {
 408                 if ( (d->mContactList[i])->contactId() == contactId )
 409                 {
 410                         receivedTypingMsg( d->mContactList[i], t );
 411                         return;
 412                 }
 413         }
 414 }
 415
 416 void Kopete::ChatSession::typing( bool t )
 417 {
 418         emit myselfTyping( t );
 419 }
 420
 421 void Kopete::ChatSession::receivedEventNotification( const QString& notificationText)
 422 {
 423         emit eventNotification( notificationText );
 424 }
 425
 426 void Kopete::ChatSession::setCanBeDeleted ( bool b )
 427 {
 428         d->mCanBeDeleted = b;
 429         if (d->refcount < (b?1:0) && !d->view )
 430                 deleteLater();
 431 }
 432
 433 void Kopete::ChatSession::ref ()
 434 {
 435         d->refcount++;
 436 }
 437 void Kopete::ChatSession::deref ()
 438 {
 439         d->refcount--;
 440         if ( d->refcount < 1 && d->mCanBeDeleted && !d->view )
 441                 deleteLater();
 442 }
 443
 444 KopeteView* Kopete::ChatSession::view( bool canCreate, const QString &requestedPlugin )
 445 {
 446         if ( !d->view && canCreate )
 447         {
 448                 d->view = Kopete::ChatSessionManager::self()->createView( this, requestedPlugin );
 449                 if ( d->view )
 450                 {
 451                         connect( d->view->mainWidget(), SIGNAL( closing( KopeteView * ) ), this, SLOT( slotViewDestroyed( ) ) );
 452                 }
 453                 else
 454                 {
 455                         KMessageBox::queuedMessageBox( Kopete::UI::Global::mainWidget(), KMessageBox::Error,
 456                                 i18n( "<qt>An error has occurred while creating a new chat window. The chat window has not been created.</qt>" ),
 457                                 i18n( "Error While Creating Chat Window" ) );
 458                 }
 459         }
 460         return d->view;
 461 }
 462
 463 void Kopete::ChatSession::slotViewDestroyed()
 464 {
 465         d->view = 0L;
 466         if ( d->mCanBeDeleted && d->refcount < 1)
 467                 deleteLater();
 468 }
 469
 470 Kopete::Account *Kopete::ChatSession::account() const
 471 {
 472         return myself()->account();
 473 }
 474
 475 void Kopete::ChatSession::slotContactDestroyed( Kopete::Contact *contact )
 476 {
 477         if(contact == myself())
 478                 deleteLater();
 479
 480         if( !contact || !d->mContactList.contains( contact ) )
 481                 return;
 482
 483         //This is a workaround to prevent crash if the contact get deleted.
 484         // in the best case, we should ask the protocol to recreate a temporary contact.
 485         // (remember: the contact may be deleted when the users removes it from the contactlist, or when closing kopete )
 486         d->mContactList.removeAll( contact );
 487         emit contactRemoved( contact, QString::null );
 488
 489         if ( d->mContactList.isEmpty() )
 490                 deleteLater();
 491 }
 492
 493 bool Kopete::ChatSession::mayInvite() const
 494 {
 495         return d->mayInvite;
 496 }
 497
 498 void Kopete::ChatSession::inviteContact(const QString& )
 499 {
 500         //default implementation do nothing
 501 }
 502
 503 void Kopete::ChatSession::setMayInvite( bool b )
 504 {
 505         d->mayInvite=b;
 506 }
 507
 508 void Kopete::ChatSession::raiseView()
 509 {
 510         KopeteView *v=view(true, Kopete::BehaviorSettings::self()->viewPlugin() );
 511         if(v)
 512                 v->raise(true);
 513 }
 514
 515 #include "kopetechatsession.moc"
 516
 517
 518
 519 // vim: set noet ts=4 sts=4 sw=4:
 520