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 uint &networkid, QObject *parent)
  35   : SyncableObject(parent),
  36     _networkId(networkid),
  37     _initialized(false),
  38     _myNick(QString()),
  39     _networkName(QString()),
  40     _currentServer(QString()),
  41     _prefixes(QString()),
  42     _prefixModes(QString()),
  43     _proxy(0),
  44     _codecForEncoding(0),
  45     _codecForDecoding(0)
  46 {
  47   setObjectName(QString::number(networkid));
  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 uint Network::networkId() const {
  60   return _networkId;
  61 }
  62
  63 bool Network::initialized() const {
  64   return _initialized;
  65 }
  66
  67 SignalProxy *Network::proxy() const {
  68   return _proxy;
  69 }
  70
  71 void Network::setProxy(SignalProxy *proxy) {
  72   _proxy = proxy;
  73   proxy->synchronize(this);
  74 }
  75
  76 bool Network::isMyNick(const QString &nick) const {
  77   return (myNick().toLower() == nick.toLower());
  78 }
  79
  80 bool Network::isMyNick(IrcUser *ircuser) const {
  81   return (ircuser->nick().toLower() == myNick().toLower());
  82 }
  83
  84 bool Network::isChannelName(const QString &channelname) const {
  85   if(channelname.isEmpty())
  86     return false;
  87
  88   if(supports("CHANTYPES"))
  89     return support("CHANTYPES").contains(channelname[0]);
  90   else
  91     return QString("#&!+").contains(channelname[0]);
  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 QStringList Network::nicks() const {
 129   // we don't use _ircUsers.keys() since the keys may be
 130   // not up to date after a nick change
 131   QStringList nicks;
 132   foreach(IrcUser *ircuser, _ircUsers.values()) {
 133     nicks << ircuser->nick();
 134   }
 135   return nicks;
 136 }
 137
 138 QStringList Network::channels() const {
 139   return _ircChannels.keys();
 140 }
 141
 142 QString Network::prefixes() {
 143   if(_prefixes.isNull())
 144     determinePrefixes();
 145
 146   return _prefixes;
 147 }
 148
 149 QString Network::prefixModes() {
 150   if(_prefixModes.isNull())
 151     determinePrefixes();
 152
 153   return _prefixModes;
 154 }
 155
 156 bool Network::supports(const QString &param) const {
 157   return _supports.contains(param);
 158 }
 159
 160 QString Network::support(const QString &param) const {
 161   QString support_ = param.toUpper();
 162   if(_supports.contains(support_))
 163     return _supports[support_];
 164   else
 165     return QString();
 166 }
 167
 168 IrcUser *Network::newIrcUser(const QString &hostmask) {
 169   QString nick(nickFromMask(hostmask).toLower());
 170   if(!_ircUsers.contains(nick)) {
 171     IrcUser *ircuser = new IrcUser(hostmask, this);
 172     // mark IrcUser as already initialized to keep the SignalProxy from requesting initData
 173     if(initialized())
 174       ircuser->setInitialized();
 175     if(proxy())
 176       proxy()->synchronize(ircuser);
 177     else
 178       qWarning() << "unable to synchronize new IrcUser" << hostmask << "forgot to call Network::setProxy(SignalProxy *)?";
 179
 180     connect(ircuser, SIGNAL(nickSet(QString)), this, SLOT(ircUserNickChanged(QString)));
 181     connect(ircuser, SIGNAL(initDone()), this, SIGNAL(ircUserInitDone()));
 182     connect(ircuser, SIGNAL(destroyed()), this, SLOT(ircUserDestroyed()));
 183     _ircUsers[nick] = ircuser;
 184     emit ircUserAdded(hostmask);
 185   }
 186   return _ircUsers[nick];
 187 }
 188
 189 IrcUser *Network::newIrcUser(const QByteArray &hostmask) {
 190   return newIrcUser(decodeString(hostmask));
 191 }
 192
 193 void Network::removeIrcUser(IrcUser *ircuser) {
 194   QString nick = _ircUsers.key(ircuser);
 195   if(nick.isNull())
 196     return;
 197
 198   _ircUsers.remove(nick);
 199   ircuser->deleteLater();
 200   emit ircUserRemoved(nick);
 201 }
 202
 203 void Network::removeIrcUser(QString nick) {
 204   IrcUser *ircuser;
 205   if((ircuser = ircUser(nick)) != 0)
 206     removeIrcUser(ircuser);
 207 }
 208
 209 IrcUser *Network::ircUser(QString nickname) const {
 210   nickname = nickname.toLower();
 211   if(_ircUsers.contains(nickname))
 212     return _ircUsers[nickname];
 213   else
 214     return 0;
 215 }
 216
 217 IrcUser *Network::ircUser(const QByteArray &nickname) const {
 218   return ircUser(decodeString(nickname));
 219 }
 220
 221 QList<IrcUser *> Network::ircUsers() const {
 222   return _ircUsers.values();
 223 }
 224
 225 IrcChannel *Network::newIrcChannel(const QString &channelname) {
 226   if(!_ircChannels.contains(channelname.toLower())) {
 227     IrcChannel *channel = new IrcChannel(channelname, this);
 228     // mark IrcUser as already initialized to keep the SignalProxy from requesting initData
 229     if(initialized())
 230       channel->setInitialized();
 231
 232     if(proxy())
 233       proxy()->synchronize(channel);
 234     else
 235       qWarning() << "unable to synchronize new IrcChannel" << channelname << "forgot to call Network::setProxy(SignalProxy *)?";
 236
 237     connect(channel, SIGNAL(initDone()), this, SIGNAL(ircChannelInitDone()));
 238     connect(channel, SIGNAL(destroyed()), this, SLOT(channelDestroyed()));
 239     _ircChannels[channelname.toLower()] = channel;
 240     emit ircChannelAdded(channelname);
 241   }
 242   return _ircChannels[channelname.toLower()];
 243 }
 244
 245 IrcChannel *Network::newIrcChannel(const QByteArray &channelname) {
 246   return newIrcChannel(decodeString(channelname));
 247 }
 248
 249 IrcChannel *Network::ircChannel(QString channelname) {
 250   channelname = channelname.toLower();
 251   if(_ircChannels.contains(channelname))
 252     return _ircChannels[channelname];
 253   else
 254     return 0;
 255 }
 256
 257 IrcChannel *Network::ircChannel(const QByteArray &channelname) {
 258   return ircChannel(decodeString(channelname));
 259 }
 260
 261
 262 QList<IrcChannel *> Network::ircChannels() const {
 263   return _ircChannels.values();
 264 }
 265
 266 QTextCodec *Network::codecForEncoding() const {
 267   return _codecForEncoding;
 268 }
 269
 270 void Network::setCodecForEncoding(const QString &name) {
 271   setCodecForEncoding(QTextCodec::codecForName(name.toAscii()));
 272 }
 273
 274 void Network::setCodecForEncoding(QTextCodec *codec) {
 275   _codecForEncoding = codec;
 276 }
 277
 278 QTextCodec *Network::codecForDecoding() const {
 279   return _codecForDecoding;
 280 }
 281
 282 void Network::setCodecForDecoding(const QString &name) {
 283   setCodecForDecoding(QTextCodec::codecForName(name.toAscii()));
 284 }
 285
 286 void Network::setCodecForDecoding(QTextCodec *codec) {
 287   _codecForDecoding = codec;
 288 }
 289
 290 QString Network::decodeString(const QByteArray &text) const {
 291   return ::decodeString(text, _codecForDecoding);
 292 }
 293
 294 QByteArray Network::encodeString(const QString string) const {
 295   if(_codecForEncoding) {
 296     return _codecForEncoding->fromUnicode(string);
 297   }
 298   return string.toAscii();
 299 }
 300
 301 // ====================
 302 //  Public Slots:
 303 // ====================
 304 void Network::setNetworkName(const QString &networkName) {
 305   _networkName = networkName;
 306   emit networkNameSet(networkName);
 307 }
 308
 309 void Network::setCurrentServer(const QString &currentServer) {
 310   _currentServer = currentServer;
 311   emit currentServerSet(currentServer);
 312 }
 313
 314 void Network::setMyNick(const QString &nickname) {
 315   _myNick = nickname;
 316   emit myNickSet(nickname);
 317 }
 318
 319 void Network::addSupport(const QString &param, const QString &value) {
 320   if(!_supports.contains(param)) {
 321     _supports[param] = value;
 322     emit supportAdded(param, value);
 323   }
 324 }
 325
 326 void Network::removeSupport(const QString &param) {
 327   if(_supports.contains(param)) {
 328     _supports.remove(param);
 329     emit supportRemoved(param);
 330   }
 331 }
 332
 333 QVariantMap Network::initSupports() const {
 334   QVariantMap supports;
 335   QHashIterator<QString, QString> iter(_supports);
 336   while(iter.hasNext()) {
 337     iter.next();
 338     supports[iter.key()] = iter.value();
 339   }
 340   return supports;
 341 }
 342
 343 QStringList Network::initIrcUsers() const {
 344   QStringList hostmasks;
 345   foreach(IrcUser *ircuser, ircUsers()) {
 346     hostmasks << ircuser->hostmask();
 347   }
 348   return hostmasks;
 349 }
 350
 351 QStringList Network::initIrcChannels() const {
 352   return _ircChannels.keys();
 353 }
 354
 355 void Network::initSetSupports(const QVariantMap &supports) {
 356   QMapIterator<QString, QVariant> iter(supports);
 357   while(iter.hasNext()) {
 358     iter.next();
 359     addSupport(iter.key(), iter.value().toString());
 360   }
 361 }
 362
 363 void Network::initSetIrcUsers(const QStringList &hostmasks) {
 364   if(!_ircUsers.empty())
 365     return;
 366   foreach(QString hostmask, hostmasks) {
 367     newIrcUser(hostmask);
 368   }
 369 }
 370
 371 void Network::initSetChannels(const QStringList &channels) {
 372   if(!_ircChannels.empty())
 373     return;
 374   foreach(QString channel, channels)
 375     newIrcChannel(channel);
 376 }
 377
 378 IrcUser *Network::updateNickFromMask(const QString &mask) {
 379   QString nick(nickFromMask(mask).toLower());
 380   IrcUser *ircuser;
 381
 382   if(_ircUsers.contains(nick)) {
 383     ircuser = _ircUsers[nick];
 384     ircuser->updateHostmask(mask);
 385   } else {
 386     ircuser = newIrcUser(mask);
 387   }
 388   return ircuser;
 389 }
 390
 391 void Network::ircUserNickChanged(QString newnick) {
 392   QString oldnick = _ircUsers.key(qobject_cast<IrcUser*>(sender()));
 393
 394   if(oldnick.isNull())
 395     return;
 396
 397   if(newnick.toLower() != oldnick) _ircUsers[newnick.toLower()] = _ircUsers.take(oldnick);
 398
 399   if(myNick().toLower() == oldnick)
 400     setMyNick(newnick);
 401 }
 402
 403 void Network::ircUserDestroyed() {
 404   IrcUser *ircuser = static_cast<IrcUser *>(sender());
 405   Q_ASSERT(ircuser);
 406   removeIrcUser(ircuser);
 407 }
 408
 409 void Network::channelDestroyed() {
 410   IrcChannel *channel = static_cast<IrcChannel *>(sender());
 411   Q_ASSERT(channel);
 412   _ircChannels.remove(_ircChannels.key(channel));
 413 }
 414
 415 void Network::setInitialized() {
 416   _initialized = true;
 417   emit initDone();
 418 }
 419
 420 // ====================
 421 //  Private:
 422 // ====================
 423 void Network::determinePrefixes() {
 424   // seems like we have to construct them first
 425   QString PREFIX = support("PREFIX");
 426
 427   if(PREFIX.startsWith("(") && PREFIX.contains(")")) {
 428     _prefixes = PREFIX.section(")", 1);
 429     _prefixModes = PREFIX.mid(1).section(")", 0, 0);
 430   } else {
 431     QString defaultPrefixes("~&@%+");
 432     QString defaultPrefixModes("qaohv");
 433
 434     // we just assume that in PREFIX are only prefix chars stored
 435     for(int i = 0; i < defaultPrefixes.size(); i++) {
 436       if(PREFIX.contains(defaultPrefixes[i])) {
 437         _prefixes += defaultPrefixes[i];
 438         _prefixModes += defaultPrefixModes[i];
 439       }
 440     }
 441     // check for success
 442     if(!_prefixes.isNull())
 443       return;
 444
 445     // well... our assumption was obviously wrong...
 446     // check if it's only prefix modes
 447     for(int i = 0; i < defaultPrefixes.size(); i++) {
 448       if(PREFIX.contains(defaultPrefixModes[i])) {
 449         _prefixes += defaultPrefixes[i];
 450         _prefixModes += defaultPrefixModes[i];
 451       }
 452     }
 453     // now we've done all we've could...
 454   }
 455 }
 456