src/common/network.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #include "network.h"
  21
  22 #include "signalproxy.h"
  23 #include "ircuser.h"
  24 #include "ircchannel.h"
  25
  26 #include <QDebug>
  27 #include <QTextCodec>
  28
  29 #include "util.h"
  30
  31 // ====================
  32 //  Public:
  33 // ====================
  34 Network::Network(const NetworkId &networkid, QObject *parent) : SyncableObject(parent),
  35     _networkId(networkid),
  36     _identity(0),
  37     _myNick(QString()),
  38     _networkName(QString("<not initialized>")),
  39     _currentServer(QString()),
  40     _connected(false),
  41     _prefixes(QString()),
  42     _prefixModes(QString()),
  43     _proxy(0),
  44     _codecForEncoding(0),
  45     _codecForDecoding(0)
  46 {
  47   setObjectName(QString::number(networkid.toInt()));
  48 }
  49
  50 // I think this is unnecessary since IrcUsers have us as their daddy :)
  51 //Network::~Network() {
  52 //   QHashIterator<QString, IrcUser *> ircuser(_ircUsers);
  53 //   while (ircuser.hasNext()) {
  54 //     ircuser.next();
  55 //     delete ircuser.value();
  56 //   }
  57 //}
  58
  59 NetworkId Network::networkId() const {
  60   return _networkId;
  61 }
  62
  63 SignalProxy *Network::proxy() const {
  64   return _proxy;
  65 }
  66
  67 void Network::setProxy(SignalProxy *proxy) {
  68   _proxy = proxy;
  69   //proxy->synchronize(this);  // we should to this explicitly from the outside!
  70 }
  71
  72 bool Network::isMyNick(const QString &nick) const {
  73   return (myNick().toLower() == nick.toLower());
  74 }
  75
  76 bool Network::isMe(IrcUser *ircuser) const {
  77   return (ircuser->nick().toLower() == myNick().toLower());
  78 }
  79
  80 bool Network::isChannelName(const QString &channelname) const {
  81   if(channelname.isEmpty())
  82     return false;
  83
  84   if(supports("CHANTYPES"))
  85     return support("CHANTYPES").contains(channelname[0]);
  86   else
  87     return QString("#&!+").contains(channelname[0]);
  88 }
  89
  90 bool Network::isConnected() const {
  91   return _connected;
  92 }
  93
  94 QString Network::prefixToMode(const QString &prefix) {
  95   if(prefixes().contains(prefix))
  96     return QString(prefixModes()[prefixes().indexOf(prefix)]);
  97   else
  98     return QString();
  99 }
 100
 101 QString Network::prefixToMode(const QCharRef &prefix) {
 102   return prefixToMode(QString(prefix));
 103 }
 104
 105 QString Network::modeToPrefix(const QString &mode) {
 106   if(prefixModes().contains(mode))
 107     return QString(prefixes()[prefixModes().indexOf(mode)]);
 108   else
 109     return QString();
 110 }
 111
 112 QString Network::modeToPrefix(const QCharRef &mode) {
 113   return modeToPrefix(QString(mode));
 114 }
 115
 116 QString Network::networkName() const {
 117   return _networkName;
 118 }
 119
 120 QString Network::currentServer() const {
 121   return _currentServer;
 122 }
 123
 124 QString Network::myNick() const {
 125   return _myNick;
 126 }
 127
 128 IdentityId Network::identity() const {
 129   return _identity;
 130 }
 131
 132 QStringList Network::nicks() const {
 133   // we don't use _ircUsers.keys() since the keys may be
 134   // not up to date after a nick change
 135   QStringList nicks;
 136   foreach(IrcUser *ircuser, _ircUsers.values()) {
 137     nicks << ircuser->nick();
 138   }
 139   return nicks;
 140 }
 141
 142 QStringList Network::channels() const {
 143   return _ircChannels.keys();
 144 }
 145
 146 QList<QVariantMap> Network::serverList() const {
 147   return _serverList;
 148 }
 149
 150 QString Network::prefixes() {
 151   if(_prefixes.isNull())
 152     determinePrefixes();
 153
 154   return _prefixes;
 155 }
 156
 157 QString Network::prefixModes() {
 158   if(_prefixModes.isNull())
 159     determinePrefixes();
 160
 161   return _prefixModes;
 162 }
 163
 164 bool Network::supports(const QString &param) const {
 165   return _supports.contains(param);
 166 }
 167
 168 QString Network::support(const QString &param) const {
 169   QString support_ = param.toUpper();
 170   if(_supports.contains(support_))
 171     return _supports[support_];
 172   else
 173     return QString();
 174 }
 175
 176 IrcUser *Network::newIrcUser(const QString &hostmask) {
 177   QString nick(nickFromMask(hostmask).toLower());
 178   if(!_ircUsers.contains(nick)) {
 179     IrcUser *ircuser = new IrcUser(hostmask, this);
 180     // mark IrcUser as already initialized to keep the SignalProxy from requesting initData
 181     //if(isInitialized())
 182     //  ircuser->setInitialized();
 183     if(proxy())
 184       proxy()->synchronize(ircuser);
 185     else
 186       qWarning() << "unable to synchronize new IrcUser" << hostmask << "forgot to call Network::setProxy(SignalProxy *)?";
 187
 188     connect(ircuser, SIGNAL(nickSet(QString)), this, SLOT(ircUserNickChanged(QString)));
 189     connect(ircuser, SIGNAL(initDone()), this, SLOT(ircUserInitDone()));
 190     connect(ircuser, SIGNAL(destroyed()), this, SLOT(ircUserDestroyed()));
 191     _ircUsers[nick] = ircuser;
 192     emit ircUserAdded(hostmask);
 193     emit ircUserAdded(ircuser);
 194   }
 195   return _ircUsers[nick];
 196 }
 197
 198 IrcUser *Network::newIrcUser(const QByteArray &hostmask) {
 199   return newIrcUser(decodeString(hostmask));
 200 }
 201
 202 void Network::removeIrcUser(IrcUser *ircuser) {
 203   QString nick = _ircUsers.key(ircuser);
 204   if(nick.isNull())
 205     return;
 206
 207   _ircUsers.remove(nick);
 208   emit ircUserRemoved(nick);
 209   emit ircUserRemoved(ircuser);
 210   ircuser->deleteLater();
 211 }
 212
 213 void Network::removeIrcUser(QString nick) {
 214   IrcUser *ircuser;
 215   if((ircuser = ircUser(nick)) != 0)
 216     removeIrcUser(ircuser);
 217 }
 218
 219 IrcUser *Network::ircUser(QString nickname) const {
 220   nickname = nickname.toLower();
 221   if(_ircUsers.contains(nickname))
 222     return _ircUsers[nickname];
 223   else
 224     return 0;
 225 }
 226
 227 IrcUser *Network::ircUser(const QByteArray &nickname) const {
 228   return ircUser(decodeString(nickname));
 229 }
 230
 231 QList<IrcUser *> Network::ircUsers() const {
 232   return _ircUsers.values();
 233 }
 234
 235 quint32 Network::ircUserCount() const {
 236   return _ircUsers.count();
 237 }
 238
 239 IrcChannel *Network::newIrcChannel(const QString &channelname) {
 240   if(!_ircChannels.contains(channelname.toLower())) {
 241     IrcChannel *channel = new IrcChannel(channelname, this);
 242     // mark IrcUser as already initialized to keep the SignalProxy from requesting initData
 243     //if(isInitialized())
 244     //  channel->setInitialized();
 245
 246     if(proxy())
 247       proxy()->synchronize(channel);
 248     else
 249       qWarning() << "unable to synchronize new IrcChannel" << channelname << "forgot to call Network::setProxy(SignalProxy *)?";
 250
 251     connect(channel, SIGNAL(initDone()), this, SLOT(ircChannelInitDone()));
 252     connect(channel, SIGNAL(destroyed()), this, SLOT(channelDestroyed()));
 253     _ircChannels[channelname.toLower()] = channel;
 254     emit ircChannelAdded(channelname);
 255     emit ircChannelAdded(channel);
 256   }
 257   return _ircChannels[channelname.toLower()];
 258 }
 259
 260 IrcChannel *Network::newIrcChannel(const QByteArray &channelname) {
 261   return newIrcChannel(decodeString(channelname));
 262 }
 263
 264 IrcChannel *Network::ircChannel(QString channelname) {
 265   channelname = channelname.toLower();
 266   if(_ircChannels.contains(channelname))
 267     return _ircChannels[channelname];
 268   else
 269     return 0;
 270 }
 271
 272 IrcChannel *Network::ircChannel(const QByteArray &channelname) {
 273   return ircChannel(decodeString(channelname));
 274 }
 275
 276
 277 QList<IrcChannel *> Network::ircChannels() const {
 278   return _ircChannels.values();
 279 }
 280
 281 quint32 Network::ircChannelCount() const {
 282   return _ircChannels.count();
 283 }
 284
 285 QByteArray Network::codecForEncoding() const {
 286   if(_codecForEncoding) return _codecForEncoding->name();
 287   return QByteArray();
 288 }
 289
 290 void Network::setCodecForEncoding(const QByteArray &name) {
 291   setCodecForEncoding(QTextCodec::codecForName(name));
 292 }
 293
 294 void Network::setCodecForEncoding(QTextCodec *codec) {
 295   _codecForEncoding = codec;
 296 }
 297
 298 QByteArray Network::codecForDecoding() const {
 299   if(_codecForDecoding) return _codecForDecoding->name();
 300   else return QByteArray();
 301 }
 302
 303 void Network::setCodecForDecoding(const QByteArray &name) {
 304   setCodecForDecoding(QTextCodec::codecForName(name));
 305 }
 306
 307 void Network::setCodecForDecoding(QTextCodec *codec) {
 308   _codecForDecoding = codec;
 309 }
 310
 311 QString Network::decodeString(const QByteArray &text) const {
 312   return ::decodeString(text, _codecForDecoding);
 313 }
 314
 315 QByteArray Network::encodeString(const QString string) const {
 316   if(_codecForEncoding) {
 317     return _codecForEncoding->fromUnicode(string);
 318   }
 319   return string.toAscii();
 320 }
 321
 322 // ====================
 323 //  Public Slots:
 324 // ====================
 325 void Network::setNetworkName(const QString &networkName) {
 326   _networkName = networkName;
 327   emit networkNameSet(networkName);
 328 }
 329
 330 void Network::setCurrentServer(const QString &currentServer) {
 331   _currentServer = currentServer;
 332   emit currentServerSet(currentServer);
 333 }
 334
 335 void Network::setConnected(bool connected) {
 336   _connected = connected;
 337   emit connectedSet(connected);
 338 }
 339
 340 void Network::setMyNick(const QString &nickname) {
 341   _myNick = nickname;
 342   emit myNickSet(nickname);
 343 }
 344
 345 void Network::setIdentity(IdentityId id) {
 346   _identity = id;
 347   emit identitySet(id);
 348 }
 349
 350 void Network::setServerList(const QList<QVariantMap> &serverList) {
 351   _serverList = serverList;
 352   emit serverListSet(serverList);
 353 }
 354
 355 void Network::addSupport(const QString &param, const QString &value) {
 356   if(!_supports.contains(param)) {
 357     _supports[param] = value;
 358     emit supportAdded(param, value);
 359   }
 360 }
 361
 362 void Network::removeSupport(const QString &param) {
 363   if(_supports.contains(param)) {
 364     _supports.remove(param);
 365     emit supportRemoved(param);
 366   }
 367 }
 368
 369 QVariantMap Network::initSupports() const {
 370   QVariantMap supports;
 371   QHashIterator<QString, QString> iter(_supports);
 372   while(iter.hasNext()) {
 373     iter.next();
 374     supports[iter.key()] = iter.value();
 375   }
 376   return supports;
 377 }
 378
 379 QVariantList Network::initServerList() const {
 380   QList<QVariant> list;
 381   foreach(QVariantMap serverdata, serverList()) list << QVariant(serverdata);
 382   return list;
 383 }
 384
 385 QStringList Network::initIrcUsers() const {
 386   QStringList hostmasks;
 387   foreach(IrcUser *ircuser, ircUsers()) {
 388     hostmasks << ircuser->hostmask();
 389   }
 390   return hostmasks;
 391 }
 392
 393 QStringList Network::initIrcChannels() const {
 394   return _ircChannels.keys();
 395 }
 396
 397 void Network::initSetSupports(const QVariantMap &supports) {
 398   QMapIterator<QString, QVariant> iter(supports);
 399   while(iter.hasNext()) {
 400     iter.next();
 401     addSupport(iter.key(), iter.value().toString());
 402   }
 403 }
 404
 405 void Network::initSetServerList(const QVariantList & serverList) {
 406   QList<QVariantMap> slist;
 407   foreach(QVariant v, serverList) slist << v.toMap();
 408   setServerList(slist);
 409 }
 410
 411 void Network::initSetIrcUsers(const QStringList &hostmasks) {
 412   if(!_ircUsers.empty())
 413     return;
 414   foreach(QString hostmask, hostmasks) {
 415     newIrcUser(hostmask);
 416   }
 417 }
 418
 419 void Network::initSetChannels(const QStringList &channels) {
 420   if(!_ircChannels.empty())
 421     return;
 422   foreach(QString channel, channels)
 423     newIrcChannel(channel);
 424 }
 425
 426 IrcUser *Network::updateNickFromMask(const QString &mask) {
 427   QString nick(nickFromMask(mask).toLower());
 428   IrcUser *ircuser;
 429
 430   if(_ircUsers.contains(nick)) {
 431     ircuser = _ircUsers[nick];
 432     ircuser->updateHostmask(mask);
 433   } else {
 434     ircuser = newIrcUser(mask);
 435   }
 436   return ircuser;
 437 }
 438
 439 void Network::ircUserNickChanged(QString newnick) {
 440   QString oldnick = _ircUsers.key(qobject_cast<IrcUser*>(sender()));
 441
 442   if(oldnick.isNull())
 443     return;
 444
 445   if(newnick.toLower() != oldnick) _ircUsers[newnick.toLower()] = _ircUsers.take(oldnick);
 446
 447   if(myNick().toLower() == oldnick)
 448     setMyNick(newnick);
 449 }
 450
 451 void Network::ircUserInitDone() {
 452   IrcUser *ircuser = static_cast<IrcUser *>(sender());
 453   Q_ASSERT(ircuser);
 454   emit ircUserInitDone(ircuser);
 455 }
 456
 457 void Network::ircChannelInitDone() {
 458   IrcChannel *ircchannel = static_cast<IrcChannel *>(sender());
 459   Q_ASSERT(ircchannel);
 460   emit ircChannelInitDone(ircchannel);
 461 }
 462
 463 void Network::ircUserDestroyed() {
 464   IrcUser *ircuser = static_cast<IrcUser *>(sender());
 465   Q_ASSERT(ircuser);
 466   removeIrcUser(ircuser);
 467 }
 468
 469 void Network::channelDestroyed() {
 470   IrcChannel *channel = static_cast<IrcChannel *>(sender());
 471   Q_ASSERT(channel);
 472   emit ircChannelRemoved(sender());
 473   _ircChannels.remove(_ircChannels.key(channel));
 474 }
 475
 476 void Network::requestConnect() {
 477   if(!proxy()) return;
 478   if(proxy()->proxyMode() == SignalProxy::Client) emit connectRequested(); // on the client this triggers calling this slot on the core
 479   else emit connectRequested(networkId());  // and this is for CoreSession :)
 480 }
 481
 482 // ====================
 483 //  Private:
 484 // ====================
 485 void Network::determinePrefixes() {
 486   // seems like we have to construct them first
 487   QString PREFIX = support("PREFIX");
 488
 489   if(PREFIX.startsWith("(") && PREFIX.contains(")")) {
 490     _prefixes = PREFIX.section(")", 1);
 491     _prefixModes = PREFIX.mid(1).section(")", 0, 0);
 492   } else {
 493     QString defaultPrefixes("~&@%+");
 494     QString defaultPrefixModes("qaohv");
 495
 496     // we just assume that in PREFIX are only prefix chars stored
 497     for(int i = 0; i < defaultPrefixes.size(); i++) {
 498       if(PREFIX.contains(defaultPrefixes[i])) {
 499         _prefixes += defaultPrefixes[i];
 500         _prefixModes += defaultPrefixModes[i];
 501       }
 502     }
 503     // check for success
 504     if(!_prefixes.isNull())
 505       return;
 506
 507     // well... our assumption was obviously wrong...
 508     // check if it's only prefix modes
 509     for(int i = 0; i < defaultPrefixes.size(); i++) {
 510       if(PREFIX.contains(defaultPrefixModes[i])) {
 511         _prefixes += defaultPrefixes[i];
 512         _prefixModes += defaultPrefixModes[i];
 513       }
 514     }
 515     // now we've done all we've could...
 516   }
 517 }
 518