src/common/network.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef NETWORK_H
  22 #define NETWORK_H
  23
  24 #include <QString>
  25 #include <QStringList>
  26 #include <QList>
  27 #include <QNetworkProxy>
  28 #include <QHash>
  29 #include <QVariantMap>
  30 #include <QPointer>
  31 #include <QMutex>
  32 #include <QByteArray>
  33
  34 #include "types.h"
  35 #include "util.h"
  36 #include "syncableobject.h"
  37
  38 #include "signalproxy.h"
  39 #include "ircuser.h"
  40 #include "ircchannel.h"
  41
  42 // IRCv3 capabilities
  43 #include "irccap.h"
  44
  45 // defined below!
  46 struct NetworkInfo;
  47
  48 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
  49
  50 class Network : public SyncableObject
  51 {
  52     SYNCABLE_OBJECT
  53     Q_OBJECT
  54     Q_ENUMS(ConnectionState)
  55
  56     Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName)
  57     Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer)
  58     Q_PROPERTY(QString myNick READ myNick WRITE setMyNick)
  59     Q_PROPERTY(int latency READ latency WRITE setLatency)
  60     Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer)
  61     Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding)
  62     Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding)
  63     Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity)
  64     Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected)
  65     //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState)
  66     Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState)
  67     Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer)
  68     Q_PROPERTY(QStringList perform READ perform WRITE setPerform)
  69     Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify)
  70     Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService)
  71     Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword)
  72     Q_PROPERTY(bool useSasl READ useSasl WRITE setUseSasl)
  73     Q_PROPERTY(QString saslAccount READ saslAccount WRITE setSaslAccount)
  74     Q_PROPERTY(QString saslPassword READ saslPassword WRITE setSaslPassword)
  75     Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect)
  76     Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval)
  77     Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries)
  78     Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries)
  79     Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels)
  80     // Custom rate limiting
  81     Q_PROPERTY(bool useCustomMessageRate READ useCustomMessageRate WRITE setUseCustomMessageRate)
  82     Q_PROPERTY(quint32 msgRateBurstSize READ messageRateBurstSize WRITE setMessageRateBurstSize)
  83     Q_PROPERTY(quint32 msgRateMessageDelay READ messageRateDelay WRITE setMessageRateDelay)
  84     Q_PROPERTY(bool unlimitedMessageRate READ unlimitedMessageRate WRITE setUnlimitedMessageRate)
  85
  86 public :
  87         enum ConnectionState {
  88         Disconnected,
  89         Connecting,
  90         Initializing,
  91         Initialized,
  92         Reconnecting,
  93         Disconnecting
  94     };
  95
  96     // see:
  97     //  http://www.irc.org/tech_docs/005.html
  98     //  http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
  99     enum ChannelModeType {
 100         NOT_A_CHANMODE = 0x00,
 101         A_CHANMODE = 0x01,
 102         B_CHANMODE = 0x02,
 103         C_CHANMODE = 0x04,
 104         D_CHANMODE = 0x08
 105     };
 106
 107     // Default port assignments according to what many IRC networks have settled on.
 108     // Technically not a standard, but it's fairly widespread.
 109     // See https://freenode.net/news/port-6697-irc-via-tlsssl
 110     enum PortDefaults {
 111         PORT_PLAINTEXT = 6667, /// Default port for unencrypted connections
 112         PORT_SSL = 6697        /// Default port for encrypted connections
 113     };
 114
 115     struct Server {
 116         QString host;
 117         uint port;
 118         QString password;
 119         bool useSsl;
 120         bool sslVerify;     /// If true, validate SSL certificates
 121         int sslVersion;
 122
 123         bool useProxy;
 124         int proxyType;
 125         QString proxyHost;
 126         uint proxyPort;
 127         QString proxyUser;
 128         QString proxyPass;
 129
 130         // sslVerify only applies when useSsl is true.  sslVerify should be enabled by default,
 131         // so enabling useSsl offers a more secure default.
 132         Server() : port(6667), useSsl(false), sslVerify(true), sslVersion(0), useProxy(false),
 133             proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
 134
 135         Server(const QString &host, uint port, const QString &password, bool useSsl,
 136                bool sslVerify)
 137             : host(host), port(port), password(password), useSsl(useSsl), sslVerify(sslVerify),
 138               sslVersion(0), useProxy(false), proxyType(QNetworkProxy::Socks5Proxy),
 139               proxyHost("localhost"), proxyPort(8080) {}
 140
 141         bool operator==(const Server &other) const;
 142         bool operator!=(const Server &other) const;
 143     };
 144     typedef QList<Server> ServerList;
 145
 146     Network(const NetworkId &networkid, QObject *parent = 0);
 147     ~Network();
 148
 149     inline NetworkId networkId() const { return _networkId; }
 150
 151     inline SignalProxy *proxy() const { return _proxy; }
 152     inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
 153
 154     inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
 155     inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
 156
 157     bool isChannelName(const QString &channelname) const;
 158
 159     /**
 160      * Checks if the target counts as a STATUSMSG
 161      *
 162      * Status messages are prefixed with one or more characters from the server-provided STATUSMSG
 163      * if available, otherwise "@" and "+" are assumed.  Generally, status messages sent to a
 164      * channel are only visible to those with the same or higher permissions, e.g. voiced.
 165      *
 166      * @param[in] target Name of destination, e.g. a channel or query
 167      * @returns True if a STATUSMSG, otherwise false
 168      */
 169     bool isStatusMsg(const QString &target) const;
 170
 171     inline bool isConnected() const { return _connected; }
 172     //Network::ConnectionState connectionState() const;
 173     inline int connectionState() const { return _connectionState; }
 174
 175     QString prefixToMode(const QString &prefix) const;
 176     inline QString prefixToMode(const QCharRef &prefix) const { return prefixToMode(QString(prefix)); }
 177     QString modeToPrefix(const QString &mode) const;
 178     inline QString modeToPrefix(const QCharRef &mode) const { return modeToPrefix(QString(mode)); }
 179
 180     ChannelModeType channelModeType(const QString &mode);
 181     inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
 182
 183     inline const QString &networkName() const { return _networkName; }
 184     inline const QString &currentServer() const { return _currentServer; }
 185     inline const QString &myNick() const { return _myNick; }
 186     inline int latency() const { return _latency; }
 187     inline IrcUser *me() const { return ircUser(myNick()); }
 188     inline IdentityId identity() const { return _identity; }
 189     QStringList nicks() const;
 190     inline QStringList channels() const { return _ircChannels.keys(); }
 191     /**
 192      * Gets the list of available capabilities.
 193      *
 194      * @returns QStringList of available capabilities
 195      */
 196     inline const QStringList caps() const { return QStringList(_caps.keys()); }
 197     /**
 198      * Gets the list of enabled (acknowledged) capabilities.
 199      *
 200      * @returns QStringList of enabled (acknowledged) capabilities
 201      */
 202     inline const QStringList capsEnabled() const { return _capsEnabled; }
 203     inline const ServerList &serverList() const { return _serverList; }
 204     inline bool useRandomServer() const { return _useRandomServer; }
 205     inline const QStringList &perform() const { return _perform; }
 206     inline bool useAutoIdentify() const { return _useAutoIdentify; }
 207     inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
 208     inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
 209     inline bool useSasl() const { return _useSasl; }
 210     inline const QString &saslAccount() const { return _saslAccount; }
 211     inline const QString &saslPassword() const { return _saslPassword; }
 212     inline bool useAutoReconnect() const { return _useAutoReconnect; }
 213     inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
 214     inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
 215     inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
 216     inline bool rejoinChannels() const { return _rejoinChannels; }
 217
 218     // Custom rate limiting
 219
 220     /**
 221      * Gets whether or not custom rate limiting is used
 222      *
 223      * @return True if custom rate limiting is enabled, otherwise false.
 224      */
 225     inline bool useCustomMessageRate() const { return _useCustomMessageRate; }
 226
 227     /**
 228      * Gets maximum number of messages to send without any delays
 229      *
 230      * @return
 231      * @parblock
 232      * Maximum number of messages to send without any delays.  A value of 1 disables message
 233      * bursting.
 234      * @endparblock
 235      */
 236     inline quint32 messageRateBurstSize() const { return _messageRateBurstSize; }
 237
 238     /**
 239      * Gets the delay between messages after the maximum number of undelayed messages have been sent
 240      *
 241      * @return
 242      * @parblock
 243      * Delay in milliseconds between messages after the maximum number of undelayed messages have
 244      * been sent.
 245      * @endparblock
 246      */
 247     inline quint32 messageRateDelay() const { return _messageRateDelay; }
 248
 249     /**
 250      * Gets whether or not all rate limiting is disabled, e.g. for IRC bridges
 251      *
 252      * @return If true, disable rate limiting, otherwise apply configured limits.
 253      */
 254     inline bool unlimitedMessageRate() const { return _unlimitedMessageRate; }
 255
 256     NetworkInfo networkInfo() const;
 257     void setNetworkInfo(const NetworkInfo &);
 258
 259     QString prefixes() const;
 260     QString prefixModes() const;
 261     void determinePrefixes() const;
 262
 263     bool supports(const QString &param) const { return _supports.contains(param); }
 264     QString support(const QString &param) const;
 265
 266     /**
 267      * Checks if a given capability is acknowledged and active.
 268      *
 269      * @param[in] capability Name of capability
 270      * @returns True if acknowledged (active), otherwise false
 271      */
 272     inline bool capEnabled(const QString &capability) const { return _capsEnabled.contains(capability.toLower()); }
 273     // IRCv3 specs all use lowercase capability names
 274
 275     /**
 276      * Gets the value of an available capability, e.g. for SASL, "EXTERNAL,PLAIN".
 277      *
 278      * @param[in] capability Name of capability
 279      * @returns Value of capability if one was specified, otherwise empty string
 280      */
 281     QString capValue(const QString &capability) const { return _caps.value(capability.toLower()); }
 282     // IRCv3 specs all use lowercase capability names
 283     // QHash returns the default constructed value if not found, in this case, empty string
 284     // See:  https://doc.qt.io/qt-4.8/qhash.html#value
 285
 286     /**
 287      * Check if the given authentication mechanism is likely to be supported.
 288      *
 289      * This depends on the server advertising SASL support and either declaring available mechanisms
 290      * (SASL 3.2), or just indicating something is supported (SASL 3.1).
 291      *
 292      * @param[in] saslMechanism  Desired SASL mechanism
 293      * @return True if mechanism supported or unknown, otherwise false
 294      */
 295     bool saslMaybeSupports(const QString &saslMechanism) const;
 296
 297     IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
 298     inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
 299     IrcUser *ircUser(QString nickname) const;
 300     inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
 301     inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
 302     inline quint32 ircUserCount() const { return _ircUsers.count(); }
 303
 304     IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
 305     inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
 306     IrcChannel *ircChannel(QString channelname) const;
 307     inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
 308     inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
 309     inline quint32 ircChannelCount() const { return _ircChannels.count(); }
 310
 311     QByteArray codecForServer() const;
 312     QByteArray codecForEncoding() const;
 313     QByteArray codecForDecoding() const;
 314     void setCodecForServer(QTextCodec *codec);
 315     void setCodecForEncoding(QTextCodec *codec);
 316     void setCodecForDecoding(QTextCodec *codec);
 317
 318     QString decodeString(const QByteArray &text) const;
 319     QByteArray encodeString(const QString &string) const;
 320     QString decodeServerString(const QByteArray &text) const;
 321     QByteArray encodeServerString(const QString &string) const;
 322
 323     static QByteArray defaultCodecForServer();
 324     static QByteArray defaultCodecForEncoding();
 325     static QByteArray defaultCodecForDecoding();
 326     static void setDefaultCodecForServer(const QByteArray &name);
 327     static void setDefaultCodecForEncoding(const QByteArray &name);
 328     static void setDefaultCodecForDecoding(const QByteArray &name);
 329
 330     inline bool autoAwayActive() const { return _autoAwayActive; }
 331     inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
 332
 333 public slots:
 334     void setNetworkName(const QString &networkName);
 335     void setCurrentServer(const QString &currentServer);
 336     void setConnected(bool isConnected);
 337     void setConnectionState(int state);
 338     virtual void setMyNick(const QString &mynick);
 339     void setLatency(int latency);
 340     void setIdentity(IdentityId);
 341
 342     void setServerList(const QVariantList &serverList);
 343     void setUseRandomServer(bool);
 344     void setPerform(const QStringList &);
 345     void setUseAutoIdentify(bool);
 346     void setAutoIdentifyService(const QString &);
 347     void setAutoIdentifyPassword(const QString &);
 348     void setUseSasl(bool);
 349     void setSaslAccount(const QString &);
 350     void setSaslPassword(const QString &);
 351     virtual void setUseAutoReconnect(bool);
 352     virtual void setAutoReconnectInterval(quint32);
 353     virtual void setAutoReconnectRetries(quint16);
 354     void setUnlimitedReconnectRetries(bool);
 355     void setRejoinChannels(bool);
 356
 357     // Custom rate limiting
 358
 359     /**
 360      * Sets whether or not custom rate limiting is used.
 361      *
 362      * Setting limits too low may get you disconnected from the server!
 363      *
 364      * @param[in] useCustomRate If true, use custom rate limits, otherwise use Quassel defaults.
 365      */
 366     void setUseCustomMessageRate(bool useCustomRate);
 367
 368     /**
 369      * Sets maximum number of messages to send without any delays
 370      *
 371      * @param[in] burstSize
 372      * @parblock
 373      * Maximum number of messages to send without any delays.  A value of 1 disables message
 374      * bursting.  Cannot be less than 1 as sending 0 messages at a time accomplishes nothing.
 375      * @endparblock
 376      */
 377     void setMessageRateBurstSize(quint32 burstSize);
 378
 379     /**
 380      * Sets the delay between messages after the maximum number of undelayed messages have been sent
 381      *
 382      * @param[in] messageDelay
 383      * @parblock
 384      * Delay in milliseconds between messages after the maximum number of undelayed messages have
 385      * been sent.
 386      * @endparblock
 387      */
 388     void setMessageRateDelay(quint32 messageDelay);
 389
 390     /**
 391      * Sets whether or not all rate limiting is disabled, e.g. for IRC bridges
 392      *
 393      * Don't use with most normal networks.
 394      *
 395      * @param[in] unlimitedRate If true, disable rate limiting, otherwise apply configured limits.
 396      */
 397     void setUnlimitedMessageRate(bool unlimitedRate);
 398
 399     void setCodecForServer(const QByteArray &codecName);
 400     void setCodecForEncoding(const QByteArray &codecName);
 401     void setCodecForDecoding(const QByteArray &codecName);
 402
 403     void addSupport(const QString &param, const QString &value = QString());
 404     void removeSupport(const QString &param);
 405
 406     // IRCv3 capability negotiation (can be connected to signals)
 407
 408     /**
 409      * Add an available capability, optionally providing a value.
 410      *
 411      * This may happen during first connect, or at any time later if a new capability becomes
 412      * available (e.g. SASL service starting).
 413      *
 414      * @param[in] capability Name of the capability
 415      * @param[in] value
 416      * @parblock
 417      * Optional value of the capability, e.g. sasl=plain.
 418      * @endparblock
 419      */
 420     void addCap(const QString &capability, const QString &value = QString());
 421
 422     /**
 423      * Marks a capability as acknowledged (enabled by the IRC server).
 424      *
 425      * @param[in] capability Name of the capability
 426      */
 427     void acknowledgeCap(const QString &capability);
 428
 429     /**
 430      * Removes a capability from the list of available capabilities.
 431      *
 432      * This may happen during first connect, or at any time later if an existing capability becomes
 433      * unavailable (e.g. SASL service stopping).  This also removes the capability from the list
 434      * of acknowledged capabilities.
 435      *
 436      * @param[in] capability Name of the capability
 437      */
 438     void removeCap(const QString &capability);
 439
 440     /**
 441      * Clears all capabilities from the list of available capabilities.
 442      *
 443      * This also removes the capability from the list of acknowledged capabilities.
 444      */
 445     void clearCaps();
 446
 447     inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
 448     inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
 449
 450     //init geters
 451     QVariantMap initSupports() const;
 452     /**
 453      * Get the initial list of available capabilities.
 454      *
 455      * @return QVariantMap of <QString, QString> indicating available capabilities and values
 456      */
 457     QVariantMap initCaps() const;
 458     /**
 459      * Get the initial list of enabled (acknowledged) capabilities.
 460      *
 461      * @return QVariantList of QString indicating enabled (acknowledged) capabilities and values
 462      */
 463     QVariantList initCapsEnabled() const { return toVariantList(capsEnabled()); }
 464     inline QVariantList initServerList() const { return toVariantList(serverList()); }
 465     virtual QVariantMap initIrcUsersAndChannels() const;
 466
 467     //init seters
 468     void initSetSupports(const QVariantMap &supports);
 469     /**
 470      * Initialize the list of available capabilities.
 471      *
 472      * @param[in] caps QVariantMap of <QString, QString> indicating available capabilities and values
 473      */
 474     void initSetCaps(const QVariantMap &caps);
 475     /**
 476      * Initialize the list of enabled (acknowledged) capabilities.
 477      *
 478      * @param[in] caps QVariantList of QString indicating enabled (acknowledged) capabilities and values
 479      */
 480     inline void initSetCapsEnabled(const QVariantList &capsEnabled) { _capsEnabled = fromVariantList<QString>(capsEnabled); }
 481     inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
 482     virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
 483
 484     /**
 485      * Update IrcUser hostmask and username from mask, creating an IrcUser if one does not exist.
 486      *
 487      * @param[in] mask   Full nick!user@hostmask string
 488      * @return IrcUser of the matching nick if exists, otherwise a new IrcUser
 489      */
 490     IrcUser *updateNickFromMask(const QString &mask);
 491
 492     // these slots are to keep the hashlists of all users and the
 493     // channel lists up to date
 494     void ircUserNickChanged(QString newnick);
 495
 496     virtual inline void requestConnect() const { REQUEST(NO_ARG) }
 497     virtual inline void requestDisconnect() const { REQUEST(NO_ARG) }
 498     virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { REQUEST(ARG(info)) }
 499
 500     void emitConnectionError(const QString &);
 501
 502 protected slots:
 503     virtual void removeIrcUser(IrcUser *ircuser);
 504     virtual void removeIrcChannel(IrcChannel *ircChannel);
 505     virtual void removeChansAndUsers();
 506
 507 signals:
 508     void aboutToBeDestroyed();
 509     void networkNameSet(const QString &networkName);
 510     void currentServerSet(const QString &currentServer);
 511     void connectedSet(bool isConnected);
 512     void connectionStateSet(Network::ConnectionState);
 513 //   void connectionStateSet(int);
 514     void connectionError(const QString &errorMsg);
 515     void myNickSet(const QString &mynick);
 516 //   void latencySet(int latency);
 517     void identitySet(IdentityId);
 518
 519     void configChanged();
 520
 521     //   void serverListSet(QVariantList serverList);
 522 //   void useRandomServerSet(bool);
 523 //   void performSet(const QStringList &);
 524 //   void useAutoIdentifySet(bool);
 525 //   void autoIdentifyServiceSet(const QString &);
 526 //   void autoIdentifyPasswordSet(const QString &);
 527 //   void useAutoReconnectSet(bool);
 528 //   void autoReconnectIntervalSet(quint32);
 529 //   void autoReconnectRetriesSet(quint16);
 530 //   void unlimitedReconnectRetriesSet(bool);
 531 //   void rejoinChannelsSet(bool);
 532
 533     // Custom rate limiting (can drive other slots)
 534
 535     /**
 536      * Signals enabling or disabling custom rate limiting
 537      *
 538      * @see Network::useCustomMessageRate()
 539      *
 540      * @param[out] useCustomRate
 541      */
 542     void useCustomMessageRateSet(const bool useCustomRate);
 543
 544     /**
 545      * Signals a change in maximum number of messages to send without any delays
 546      *
 547      * @see Network::messageRateBurstSize()
 548      *
 549      * @param[out] burstSize
 550      */
 551     void messageRateBurstSizeSet(const quint32 burstSize);
 552
 553     /**
 554      * Signals a change in delay between messages after the max. undelayed messages have been sent
 555      *
 556      * @see Network::messageRateDelay()
 557      *
 558      * @param[out] messageDelay
 559      */
 560     void messageRateDelaySet(const quint32 messageDelay);
 561
 562     /**
 563      * Signals enabling or disabling all rate limiting
 564      *
 565      * @see Network::unlimitedMessageRate()
 566      *
 567      * @param[out] unlimitedRate
 568      */
 569     void unlimitedMessageRateSet(const bool unlimitedRate);
 570
 571 //   void codecForServerSet(const QByteArray &codecName);
 572 //   void codecForEncodingSet(const QByteArray &codecName);
 573 //   void codecForDecodingSet(const QByteArray &codecName);
 574
 575 //   void supportAdded(const QString &param, const QString &value);
 576 //   void supportRemoved(const QString &param);
 577
 578     // IRCv3 capability negotiation (can drive other slots)
 579     /**
 580      * Indicates a capability is now available, with optional value in Network::capValue().
 581      *
 582      * @see Network::addCap()
 583      *
 584      * @param[in] capability Name of the capability
 585      */
 586     void capAdded (const QString &capability);
 587
 588     /**
 589      * Indicates a capability was acknowledged (enabled by the IRC server).
 590      *
 591      * @see Network::acknowledgeCap()
 592      *
 593      * @param[in] capability Name of the capability
 594      */
 595     void capAcknowledged(const QString &capability);
 596
 597     /**
 598      * Indicates a capability was removed from the list of available capabilities.
 599      *
 600      * @see Network::removeCap()
 601      *
 602      * @param[in] capability Name of the capability
 603      */
 604     void capRemoved(const QString &capability);
 605
 606 //   void ircUserAdded(const QString &hostmask);
 607     void ircUserAdded(IrcUser *);
 608 //   void ircChannelAdded(const QString &channelname);
 609     void ircChannelAdded(IrcChannel *);
 610
 611 //   void connectRequested() const;
 612 //   void disconnectRequested() const;
 613 //   void setNetworkInfoRequested(const NetworkInfo &) const;
 614
 615 protected:
 616     inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
 617     inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new IrcUser(hostmask, this); }
 618
 619 private:
 620     QPointer<SignalProxy> _proxy;
 621
 622     NetworkId _networkId;
 623     IdentityId _identity;
 624
 625     QString _myNick;
 626     int _latency;
 627     QString _networkName;
 628     QString _currentServer;
 629     bool _connected;
 630     ConnectionState _connectionState;
 631
 632     mutable QString _prefixes;
 633     mutable QString _prefixModes;
 634
 635     QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
 636     QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 637     QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
 638
 639     QHash<QString, QString> _caps;  /// Capabilities supported by the IRC server
 640     // By synchronizing the supported capabilities, the client could suggest certain behaviors, e.g.
 641     // in the Network settings dialog, recommending SASL instead of using NickServ, or warning if
 642     // SASL EXTERNAL isn't available.
 643     QStringList _capsEnabled;       /// Enabled capabilities that received 'CAP ACK'
 644     // _capsEnabled uses the same values from the <name>=<value> pairs stored in _caps
 645
 646     ServerList _serverList;
 647     bool _useRandomServer;
 648     QStringList _perform;
 649
 650     bool _useAutoIdentify;
 651     QString _autoIdentifyService;
 652     QString _autoIdentifyPassword;
 653
 654     bool _useSasl;
 655     QString _saslAccount;
 656     QString _saslPassword;
 657
 658     bool _useAutoReconnect;
 659     quint32 _autoReconnectInterval;
 660     quint16 _autoReconnectRetries;
 661     bool _unlimitedReconnectRetries;
 662     bool _rejoinChannels;
 663
 664     // Custom rate limiting
 665     bool _useCustomMessageRate;         /// If true, use custom rate limits, otherwise use defaults
 666     quint32 _messageRateBurstSize;      /// Maximum number of messages to send without any delays
 667     quint32 _messageRateDelay;          /// Delay in ms. for messages when max. burst messages sent
 668     bool _unlimitedMessageRate;         /// If true, disable rate limiting, otherwise apply limits
 669
 670     QTextCodec *_codecForServer;
 671     QTextCodec *_codecForEncoding;
 672     QTextCodec *_codecForDecoding;
 673
 674     static QTextCodec *_defaultCodecForServer;
 675     static QTextCodec *_defaultCodecForEncoding;
 676     static QTextCodec *_defaultCodecForDecoding;
 677
 678     bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
 679
 680     friend class IrcUser;
 681     friend class IrcChannel;
 682 };
 683
 684
 685 //! Stores all editable information about a network (as opposed to runtime state).
 686 struct NetworkInfo {
 687     // set some default values, note that this does not initialize e.g. name and id
 688     NetworkInfo();
 689
 690     NetworkId networkId;
 691     QString networkName;
 692     IdentityId identity;
 693
 694     bool useCustomEncodings; // not used!
 695     QByteArray codecForServer;
 696     QByteArray codecForEncoding;
 697     QByteArray codecForDecoding;
 698
 699     Network::ServerList serverList;
 700     bool useRandomServer;
 701
 702     QStringList perform;
 703
 704     bool useAutoIdentify;
 705     QString autoIdentifyService;
 706     QString autoIdentifyPassword;
 707
 708     bool useSasl;
 709     QString saslAccount;
 710     QString saslPassword;
 711
 712     bool useAutoReconnect;
 713     quint32 autoReconnectInterval;
 714     quint16 autoReconnectRetries;
 715     bool unlimitedReconnectRetries;
 716     bool rejoinChannels;
 717
 718     // Custom rate limiting
 719     bool useCustomMessageRate;         /// If true, use custom rate limits, otherwise use defaults
 720     quint32 messageRateBurstSize;      /// Maximum number of messages to send without any delays
 721     quint32 messageRateDelay;          /// Delay in ms. for messages when max. burst messages sent
 722     bool unlimitedMessageRate;         /// If true, disable rate limiting, otherwise apply limits
 723
 724     bool operator==(const NetworkInfo &other) const;
 725     bool operator!=(const NetworkInfo &other) const;
 726 };
 727
 728 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 729 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 730 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
 731 Q_DECLARE_METATYPE(NetworkInfo)
 732
 733 QDataStream &operator<<(QDataStream &out, const Network::Server &server);
 734 QDataStream &operator>>(QDataStream &in, Network::Server &server);
 735 QDebug operator<<(QDebug dbg, const Network::Server &server);
 736 Q_DECLARE_METATYPE(Network::Server)
 737
 738 #endif