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 inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
73 NetworkConnection *networkConnection(NetworkId) const;
75 Protocol::SessionState sessionState() const;
77 inline SignalProxy *signalProxy() const { return _signalProxy; }
79 const AliasManager &aliasManager() const { return _aliasManager; }
80 AliasManager &aliasManager() { return _aliasManager; }
82 inline EventManager *eventManager() const { return _eventManager; }
83 inline EventStringifier *eventStringifier() const { return _eventStringifier; }
84 inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; }
85 inline CtcpParser *ctcpParser() const { return _ctcpParser; }
86 inline IrcParser *ircParser() const { return _ircParser; }
88 inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
90 inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; }
91 inline HighlightRuleManager *highlightRuleManager() { return &_highlightRuleManager; }
92 inline CoreTransferManager *transferManager() const { return _transferManager; }
93 inline CoreDccConfig *dccConfig() const { return _dccConfig; }
95 // void attachNetworkConnection(NetworkConnection *conn);
97 //! Return necessary data for restoring the session after restarting the core
98 void restoreSessionState();
101 void addClient(RemotePeer *peer);
102 void addClient(InternalPeer *peer);
104 void msgFromClient(BufferInfo, QString message);
106 //! Create an identity and propagate the changes to the clients.
107 /** \param identity The identity to be created.
109 void createIdentity(const Identity &identity, const QVariantMap &additional);
110 void createIdentity(const CoreIdentity &identity);
112 //! Remove identity and propagate that fact to the clients.
113 /** \param identity The identity to be removed.
115 void removeIdentity(IdentityId identity);
117 //! Create a network and propagate the changes to the clients.
118 /** \param info The network's settings.
120 void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
122 //! Remove network and propagate that fact to the clients.
123 /** \param network The id of the network to be removed.
125 void removeNetwork(NetworkId network);
127 //! Rename a Buffer for a given network
128 /* \param networkId The id of the network the buffer belongs to
129 * \param newName The new name of the buffer
130 * \param oldName The old name of the buffer
132 void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
134 void changePassword(PeerPtr peer, const QString &userName, const QString &oldPassword, const QString &newPassword);
136 void kickClient(int peerId);
138 QHash<QString, QString> persistentChannels(NetworkId) const;
141 * Marks us away (or unaway) on all networks
143 * @param[in] msg Away message, or blank to set unaway
144 * @param[in] skipFormatting If true, skip timestamp formatting codes (e.g. if already done)
146 void globalAway(const QString &msg = QString(), const bool skipFormatting = false);
150 void sessionState(const Protocol::SessionState &sessionState);
152 //void msgFromGui(uint netid, QString buf, QString message);
153 void displayMsg(Message message);
154 void displayStatusMsg(QString, QString);
156 void scriptResult(QString result);
158 //! Identity has been created.
159 /** This signal is propagated to the clients to tell them that the given identity has been created.
160 * \param identity The new identity.
162 void identityCreated(const Identity &identity);
164 //! Identity has been removed.
165 /** This signal is propagated to the clients to inform them about the removal of the given identity.
166 * \param identity The identity that has been removed.
168 void identityRemoved(IdentityId identity);
170 void networkCreated(NetworkId);
171 void networkRemoved(NetworkId);
172 void networkDisconnected(NetworkId);
174 void passwordChanged(PeerPtr peer, bool success);
176 void disconnectFromCore();
179 virtual void customEvent(QEvent *event);
182 void removeClient(Peer *peer);
184 void recvStatusMsgFromServer(QString msg);
185 void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
187 void destroyNetwork(NetworkId);
189 void scriptRequest(QString script);
191 void clientsConnected();
192 void clientsDisconnected();
194 void updateIdentityBySender();
196 void saveSessionState() const;
199 void processMessages();
202 void initScriptEngine();
204 /// Hook for converting events to the old displayMsg() handlers
205 Q_INVOKABLE void processMessageEvent(MessageEvent *event);
209 SignalProxy *_signalProxy;
210 CoreAliasManager _aliasManager;
211 // QHash<NetworkId, NetworkConnection *> _connections;
212 QHash<NetworkId, CoreNetwork *> _networks;
213 // QHash<NetworkId, CoreNetwork *> _networksToRemove;
214 QHash<IdentityId, CoreIdentity *> _identities;
216 CoreBufferSyncer *_bufferSyncer;
217 CoreBacklogManager *_backlogManager;
218 CoreBufferViewManager *_bufferViewManager;
219 CoreDccConfig *_dccConfig;
220 CoreIrcListHelper *_ircListHelper;
221 CoreNetworkConfig *_networkConfig;
222 CoreCoreInfo _coreInfo;
223 CoreTransferManager *_transferManager;
225 EventManager *_eventManager;
226 EventStringifier *_eventStringifier; // should eventually move into client
227 CoreSessionEventProcessor *_sessionEventProcessor;
228 CtcpParser *_ctcpParser;
229 IrcParser *_ircParser;
231 QScriptEngine *scriptEngine;
234 * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and
235 * processing them to prefixes based on the network's settings.
236 * @param sender The hostmask of the sender
237 * @param bufferInfo The BufferInfo object of the buffer
239 QString senderPrefixes(const QString &sender, const BufferInfo &bufferInfo) const;
240 QList<RawMessage> _messageQueue;
241 bool _processMessages;
242 CoreIgnoreListManager _ignoreListManager;
243 CoreHighlightRuleManager _highlightRuleManager;
250 BufferInfo::Type bufferType;
254 Message::Flags flags;
255 RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
256 : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}