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 ***************************************************************************/
29 #include "corealiasmanager.h"
30 #include "corehighlightrulemanager.h"
31 #include "coreignorelistmanager.h"
37 class CoreBacklogManager;
38 class CoreBufferSyncer;
39 class CoreBufferViewManager;
42 class CoreIrcListHelper;
44 class CoreNetworkConfig;
45 class CoreSessionEventProcessor;
46 class CoreTransferManager;
49 class EventStringifier;
53 class NetworkConnection;
61 class CoreSession : public QObject
66 CoreSession(UserId, bool restoreState, bool strictIdentEnabled, 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;
74 * Returns the optionally strict-compliant ident for the given user identity
76 * If strict mode is enabled, this will return the user's Quassel username for any identity,
77 * otherwise this will return the given identity's ident, whatever it may be.
79 * @return The user's ident, compliant with strict mode (when enabled)
81 const QString strictCompliantIdent(const CoreIdentity *identity);
83 inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
84 NetworkConnection *networkConnection(NetworkId) const;
86 Protocol::SessionState sessionState() const;
88 inline SignalProxy *signalProxy() const { return _signalProxy; }
90 const AliasManager &aliasManager() const { return _aliasManager; }
91 AliasManager &aliasManager() { return _aliasManager; }
93 inline EventManager *eventManager() const { return _eventManager; }
94 inline EventStringifier *eventStringifier() const { return _eventStringifier; }
95 inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; }
96 inline CtcpParser *ctcpParser() const { return _ctcpParser; }
97 inline IrcParser *ircParser() const { return _ircParser; }
99 inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
101 inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; }
102 inline HighlightRuleManager *highlightRuleManager() { return &_highlightRuleManager; }
103 inline CoreTransferManager *transferManager() const { return _transferManager; }
104 inline CoreDccConfig *dccConfig() const { return _dccConfig; }
106 // void attachNetworkConnection(NetworkConnection *conn);
108 //! Return necessary data for restoring the session after restarting the core
109 void restoreSessionState();
112 void addClient(RemotePeer *peer);
113 void addClient(InternalPeer *peer);
116 * Shuts down the session and deletes itself afterwards.
120 void msgFromClient(BufferInfo, QString message);
122 //! Create an identity and propagate the changes to the clients.
123 /** \param identity The identity to be created.
125 void createIdentity(const Identity &identity, const QVariantMap &additional);
126 void createIdentity(const CoreIdentity &identity);
128 //! Remove identity and propagate that fact to the clients.
129 /** \param identity The identity to be removed.
131 void removeIdentity(IdentityId identity);
133 //! Create a network and propagate the changes to the clients.
134 /** \param info The network's settings.
136 void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
138 //! Remove network and propagate that fact to the clients.
139 /** \param network The id of the network to be removed.
141 void removeNetwork(NetworkId network);
143 //! Rename a Buffer for a given network
144 /* \param networkId The id of the network the buffer belongs to
145 * \param newName The new name of the buffer
146 * \param oldName The old name of the buffer
148 void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
150 void changePassword(PeerPtr peer, const QString &userName, const QString &oldPassword, const QString &newPassword);
152 void kickClient(int peerId);
154 QHash<QString, QString> persistentChannels(NetworkId) const;
156 QHash<QString, QByteArray> bufferCiphers(NetworkId id) const;
157 void setBufferCipher(NetworkId id, const QString &bufferName, const QByteArray &cipher) const;
160 * Marks us away (or unaway) on all networks
162 * @param[in] msg Away message, or blank to set unaway
163 * @param[in] skipFormatting If true, skip timestamp formatting codes (e.g. if already done)
165 void globalAway(const QString &msg = QString(), const bool skipFormatting = false);
169 void sessionState(const Protocol::SessionState &sessionState);
171 //void msgFromGui(uint netid, QString buf, QString message);
172 void displayMsg(Message message);
173 void displayStatusMsg(QString, QString);
175 void scriptResult(QString result);
177 //! Identity has been created.
178 /** This signal is propagated to the clients to tell them that the given identity has been created.
179 * \param identity The new identity.
181 void identityCreated(const Identity &identity);
183 //! Identity has been removed.
184 /** This signal is propagated to the clients to inform them about the removal of the given identity.
185 * \param identity The identity that has been removed.
187 void identityRemoved(IdentityId identity);
189 void networkCreated(NetworkId);
190 void networkRemoved(NetworkId);
191 void networkDisconnected(NetworkId);
193 void passwordChanged(PeerPtr peer, bool success);
195 void disconnectFromCore();
198 virtual void customEvent(QEvent *event);
201 void removeClient(Peer *peer);
203 void recvStatusMsgFromServer(QString msg);
204 void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
206 void destroyNetwork(NetworkId);
208 void scriptRequest(QString script);
210 void clientsConnected();
211 void clientsDisconnected();
213 void updateIdentityBySender();
215 void saveSessionState() const;
217 void onNetworkDisconnected(NetworkId networkId);
220 void processMessages();
223 void initScriptEngine();
225 /// Hook for converting events to the old displayMsg() handlers
226 Q_INVOKABLE void processMessageEvent(MessageEvent *event);
230 /// Whether or not strict ident mode is enabled, locking users' idents to Quassel username
231 bool _strictIdentEnabled;
233 SignalProxy *_signalProxy;
234 CoreAliasManager _aliasManager;
236 QHash<IdentityId, CoreIdentity *> _identities;
237 QHash<NetworkId, CoreNetwork *> _networks;
238 QSet<NetworkId> _networksPendingDisconnect;
240 CoreBufferSyncer *_bufferSyncer;
241 CoreBacklogManager *_backlogManager;
242 CoreBufferViewManager *_bufferViewManager;
243 CoreDccConfig *_dccConfig;
244 CoreIrcListHelper *_ircListHelper;
245 CoreNetworkConfig *_networkConfig;
247 CoreTransferManager *_transferManager;
249 EventManager *_eventManager;
250 EventStringifier *_eventStringifier; // should eventually move into client
251 CoreSessionEventProcessor *_sessionEventProcessor;
252 CtcpParser *_ctcpParser;
253 IrcParser *_ircParser;
255 QScriptEngine *scriptEngine;
258 * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and
259 * processing them to prefixes based on the network's settings.
260 * @param sender The hostmask of the sender
261 * @param bufferInfo The BufferInfo object of the buffer
263 QString senderPrefixes(const QString &sender, const BufferInfo &bufferInfo) const;
266 * This method obtains the realname of the message's sender.
267 * @param sender The hostmask of the sender
268 * @param networkId The network the user is on
270 QString realName(const QString &sender, NetworkId networkId) const;
273 * This method obtains the avatar of the message's sender.
274 * @param sender The hostmask of the sender
275 * @param networkId The network the user is on
277 QString avatarUrl(const QString &sender, NetworkId networkId) const;
278 QList<RawMessage> _messageQueue;
279 bool _processMessages;
280 CoreIgnoreListManager _ignoreListManager;
281 CoreHighlightRuleManager _highlightRuleManager;
288 BufferInfo::Type bufferType;
292 Message::Flags flags;
293 RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
294 : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}