1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
25 #include "coreircchannel.h"
30 # include <QSslSocket>
33 # include <QTcpSocket>
36 #include "coresession.h"
39 class IrcServerHandler;
40 class CoreUserInputHandler;
42 class CoreIgnoreListManager;
44 class CoreNetwork : public Network {
49 CoreNetwork(const NetworkId &networkid, CoreSession *session);
51 inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
53 inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
54 inline CoreSession *coreSession() const { return _coreSession; }
55 inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
57 inline IrcServerHandler *ircServerHandler() const { return _ircServerHandler; }
58 inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
59 inline CtcpHandler *ctcpHandler() const { return _ctcpHandler; }
60 inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
62 //! Decode a string using the server (network) decoding.
63 inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
65 //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
66 QString channelDecode(const QString &channelName, const QByteArray &string) const;
68 //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
69 QString userDecode(const QString &userNick, const QByteArray &string) const;
71 //! Encode a string using the server (network) encoding.
72 inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
74 //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
75 QByteArray channelEncode(const QString &channelName, const QString &string) const;
77 //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
78 QByteArray userEncode(const QString &userNick, const QString &string) const;
80 inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
82 inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
84 inline UserId userId() const { return _coreSession->user(); }
87 virtual void setMyNick(const QString &mynick);
89 virtual void requestConnect() const;
90 virtual void requestDisconnect() const;
91 virtual void requestSetNetworkInfo(const NetworkInfo &info);
93 virtual void setUseAutoReconnect(bool);
94 virtual void setAutoReconnectInterval(quint32);
95 virtual void setAutoReconnectRetries(quint16);
97 void setPingInterval(int interval);
99 void connectToIrc(bool reconnecting = false);
100 void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
102 void userInput(BufferInfo bufferInfo, QString msg);
103 void putRawLine(QByteArray input);
104 void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray());
106 void setChannelJoined(const QString &channel);
107 void setChannelParted(const QString &channel);
108 void addChannelKey(const QString &channel, const QString &key);
109 void removeChannelKey(const QString &channel);
111 void setAutoWhoEnabled(bool enabled);
112 void setAutoWhoInterval(int interval);
113 void setAutoWhoDelay(int delay);
115 bool setAutoWhoDone(const QString &channel);
117 Server usedServer() const;
119 inline void resetPingTimeout() { _pingCount = 0; }
121 inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None) {
122 emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
126 void recvRawServerMsg(QString);
127 void displayStatusMsg(QString);
128 void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
129 void disconnected(NetworkId networkId);
130 void connectionError(const QString &errorMsg);
132 void quitRequested(NetworkId networkId);
133 void sslErrors(const QVariant &errorData);
136 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
139 void socketHasData();
140 void socketError(QAbstractSocket::SocketError);
141 void socketInitialized();
142 inline void socketCloseTimeout() { socket.disconnectFromHost(); }
143 void socketDisconnected();
144 void socketStateChanged(QAbstractSocket::SocketState);
145 void networkInitialized();
148 void restoreUserModes();
149 void doAutoReconnect();
151 void enablePingTimeout(bool enable = true);
152 void disablePingTimeout();
154 void startAutoWhoCycle();
157 void sslErrors(const QList<QSslError> &errors);
160 void fillBucketAndProcessQueue();
162 void writeToSocket(const QByteArray &data);
165 CoreSession *_coreSession;
173 IrcServerHandler *_ircServerHandler;
174 CoreUserInputHandler *_userInputHandler;
175 CtcpHandler *_ctcpHandler;
177 QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
179 QTimer _autoReconnectTimer;
180 int _autoReconnectCount;
182 QTimer _socketCloseTimer;
184 /* this flag triggers quitRequested() once the socket is closed
185 * it is needed to determine whether or not the connection needs to be
186 * in the automatic session restore. */
190 bool _previousConnectionAttemptFailed;
191 int _lastUsedServerIndex;
197 QStringList _autoWhoQueue;
198 QHash<QString, int> _autoWhoPending;
199 QTimer _autoWhoTimer, _autoWhoCycleTimer;
201 QTimer _tokenBucketTimer;
202 int _messageDelay; // token refill speed in ms
203 int _burstSize; // size of the token bucket
204 int _tokenBucket; // the virtual bucket that holds the tokens
205 QList<QByteArray> _msgQueue;
208 #endif //CORENETWORK_H