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