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