1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
27 #include "corecoreinfo.h"
28 #include "corealiasmanager.h"
29 #include "corehighlightrulemanager.h"
30 #include "coreignorelistmanager.h"
36 class CoreBacklogManager;
37 class CoreBufferSyncer;
38 class CoreBufferViewManager;
41 class CoreIrcListHelper;
43 class CoreNetworkConfig;
44 class CoreSessionEventProcessor;
45 class CoreTransferManager;
48 class EventStringifier;
52 class NetworkConnection;
60 class CoreSession : public QObject
65 CoreSession(UserId, bool restoreState, QObject *parent = 0);
68 QList<BufferInfo> buffers() const;
69 inline UserId user() const { return _user; }
70 CoreNetwork *network(NetworkId) const;
71 CoreIdentity *identity(IdentityId) const;
72 const QString strictSysident();
73 inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
74 NetworkConnection *networkConnection(NetworkId) const;
76 Protocol::SessionState sessionState() const;
78 inline SignalProxy *signalProxy() const { return _signalProxy; }
80 const AliasManager &aliasManager() const { return _aliasManager; }
81 AliasManager &aliasManager() { return _aliasManager; }
83 inline EventManager *eventManager() const { return _eventManager; }
84 inline EventStringifier *eventStringifier() const { return _eventStringifier; }
85 inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; }
86 inline CtcpParser *ctcpParser() const { return _ctcpParser; }
87 inline IrcParser *ircParser() const { return _ircParser; }
89 inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
91 inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; }
92 inline HighlightRuleManager *highlightRuleManager() { return &_highlightRuleManager; }
93 inline CoreTransferManager *transferManager() const { return _transferManager; }
94 inline CoreDccConfig *dccConfig() const { return _dccConfig; }
96 // void attachNetworkConnection(NetworkConnection *conn);
98 //! Return necessary data for restoring the session after restarting the core
99 void restoreSessionState();
102 void addClient(RemotePeer *peer);
103 void addClient(InternalPeer *peer);
105 void msgFromClient(BufferInfo, QString message);
107 //! Create an identity and propagate the changes to the clients.
108 /** \param identity The identity to be created.
110 void createIdentity(const Identity &identity, const QVariantMap &additional);
111 void createIdentity(const CoreIdentity &identity);
113 //! Remove identity and propagate that fact to the clients.
114 /** \param identity The identity to be removed.
116 void removeIdentity(IdentityId identity);
118 //! Create a network and propagate the changes to the clients.
119 /** \param info The network's settings.
121 void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
123 //! Remove network and propagate that fact to the clients.
124 /** \param network The id of the network to be removed.
126 void removeNetwork(NetworkId network);
128 //! Rename a Buffer for a given network
129 /* \param networkId The id of the network the buffer belongs to
130 * \param newName The new name of the buffer
131 * \param oldName The old name of the buffer
133 void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
135 void changePassword(PeerPtr peer, const QString &userName, const QString &oldPassword, const QString &newPassword);
137 void kickClient(int peerId);
139 QHash<QString, QString> persistentChannels(NetworkId) const;
141 QHash<QString, QByteArray> bufferCiphers(NetworkId id) const;
142 void setBufferCipher(NetworkId id, const QString &bufferName, const QByteArray &cipher) const;
145 * Marks us away (or unaway) on all networks
147 * @param[in] msg Away message, or blank to set unaway
148 * @param[in] skipFormatting If true, skip timestamp formatting codes (e.g. if already done)
150 void globalAway(const QString &msg = QString(), const bool skipFormatting = false);
154 void sessionState(const Protocol::SessionState &sessionState);
156 //void msgFromGui(uint netid, QString buf, QString message);
157 void displayMsg(Message message);
158 void displayStatusMsg(QString, QString);
160 void scriptResult(QString result);
162 //! Identity has been created.
163 /** This signal is propagated to the clients to tell them that the given identity has been created.
164 * \param identity The new identity.
166 void identityCreated(const Identity &identity);
168 //! Identity has been removed.
169 /** This signal is propagated to the clients to inform them about the removal of the given identity.
170 * \param identity The identity that has been removed.
172 void identityRemoved(IdentityId identity);
174 void networkCreated(NetworkId);
175 void networkRemoved(NetworkId);
176 void networkDisconnected(NetworkId);
178 void passwordChanged(PeerPtr peer, bool success);
180 void disconnectFromCore();
183 virtual void customEvent(QEvent *event);
186 void removeClient(Peer *peer);
188 void recvStatusMsgFromServer(QString msg);
189 void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
191 void destroyNetwork(NetworkId);
193 void scriptRequest(QString script);
195 void clientsConnected();
196 void clientsDisconnected();
198 void updateIdentityBySender();
200 void saveSessionState() const;
203 void processMessages();
206 void initScriptEngine();
208 /// Hook for converting events to the old displayMsg() handlers
209 Q_INVOKABLE void processMessageEvent(MessageEvent *event);
213 SignalProxy *_signalProxy;
214 CoreAliasManager _aliasManager;
215 // QHash<NetworkId, NetworkConnection *> _connections;
216 QHash<NetworkId, CoreNetwork *> _networks;
217 // QHash<NetworkId, CoreNetwork *> _networksToRemove;
218 QHash<IdentityId, CoreIdentity *> _identities;
220 CoreBufferSyncer *_bufferSyncer;
221 CoreBacklogManager *_backlogManager;
222 CoreBufferViewManager *_bufferViewManager;
223 CoreDccConfig *_dccConfig;
224 CoreIrcListHelper *_ircListHelper;
225 CoreNetworkConfig *_networkConfig;
226 CoreCoreInfo _coreInfo;
227 CoreTransferManager *_transferManager;
229 EventManager *_eventManager;
230 EventStringifier *_eventStringifier; // should eventually move into client
231 CoreSessionEventProcessor *_sessionEventProcessor;
232 CtcpParser *_ctcpParser;
233 IrcParser *_ircParser;
235 QScriptEngine *scriptEngine;
238 * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and
239 * processing them to prefixes based on the network's settings.
240 * @param sender The hostmask of the sender
241 * @param bufferInfo The BufferInfo object of the buffer
243 QString senderPrefixes(const QString &sender, const BufferInfo &bufferInfo) const;
246 * This method obtains the realname of the message's sender.
247 * @param sender The hostmask of the sender
248 * @param networkId The network the user is on
250 QString realName(const QString &sender, NetworkId networkId) const;
253 * This method obtains the avatar of the message's sender.
254 * @param sender The hostmask of the sender
255 * @param networkId The network the user is on
257 QString avatarUrl(const QString &sender, NetworkId networkId) const;
258 QList<RawMessage> _messageQueue;
259 bool _processMessages;
260 CoreIgnoreListManager _ignoreListManager;
261 CoreHighlightRuleManager _highlightRuleManager;
268 BufferInfo::Type bufferType;
272 Message::Flags flags;
273 RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
274 : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}