Add strict-oidentd mode
[quassel.git] / src / core / coresession.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2018 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 CORESESSION_H
22 #define CORESESSION_H
23
24 #include <QString>
25 #include <QVariant>
26
27 #include "corecoreinfo.h"
28 #include "corealiasmanager.h"
29 #include "corehighlightrulemanager.h"
30 #include "coreignorelistmanager.h"
31 #include "peer.h"
32 #include "protocol.h"
33 #include "message.h"
34 #include "storage.h"
35
36 class CoreBacklogManager;
37 class CoreBufferSyncer;
38 class CoreBufferViewManager;
39 class CoreDccConfig;
40 class CoreIdentity;
41 class CoreIrcListHelper;
42 class CoreNetwork;
43 class CoreNetworkConfig;
44 class CoreSessionEventProcessor;
45 class CoreTransferManager;
46 class CtcpParser;
47 class EventManager;
48 class EventStringifier;
49 class InternalPeer;
50 class IrcParser;
51 class MessageEvent;
52 class NetworkConnection;
53 class RemotePeer;
54 class SignalProxy;
55
56 struct NetworkInfo;
57
58 class QScriptEngine;
59
60 class CoreSession : public QObject
61 {
62     Q_OBJECT
63
64 public:
65     CoreSession(UserId, bool restoreState, QObject *parent = 0);
66     ~CoreSession();
67
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;
75
76     Protocol::SessionState sessionState() const;
77
78     inline SignalProxy *signalProxy() const { return _signalProxy; }
79
80     const AliasManager &aliasManager() const { return _aliasManager; }
81     AliasManager &aliasManager() { return _aliasManager; }
82
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; }
88
89     inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
90
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; }
95
96 //   void attachNetworkConnection(NetworkConnection *conn);
97
98     //! Return necessary data for restoring the session after restarting the core
99     void restoreSessionState();
100
101 public slots:
102     void addClient(RemotePeer *peer);
103     void addClient(InternalPeer *peer);
104
105     void msgFromClient(BufferInfo, QString message);
106
107     //! Create an identity and propagate the changes to the clients.
108     /** \param identity The identity to be created.
109      */
110     void createIdentity(const Identity &identity, const QVariantMap &additional);
111     void createIdentity(const CoreIdentity &identity);
112
113     //! Remove identity and propagate that fact to the clients.
114     /** \param identity The identity to be removed.
115      */
116     void removeIdentity(IdentityId identity);
117
118     //! Create a network and propagate the changes to the clients.
119     /** \param info The network's settings.
120      */
121     void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
122
123     //! Remove network and propagate that fact to the clients.
124     /** \param network The id of the network to be removed.
125      */
126     void removeNetwork(NetworkId network);
127
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
132      */
133     void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
134
135     void changePassword(PeerPtr peer, const QString &userName, const QString &oldPassword, const QString &newPassword);
136
137     void kickClient(int peerId);
138
139     QHash<QString, QString> persistentChannels(NetworkId) const;
140
141     /**
142      * Marks us away (or unaway) on all networks
143      *
144      * @param[in] msg             Away message, or blank to set unaway
145      * @param[in] skipFormatting  If true, skip timestamp formatting codes (e.g. if already done)
146      */
147     void globalAway(const QString &msg = QString(), const bool skipFormatting = false);
148
149 signals:
150     void initialized();
151     void sessionState(const Protocol::SessionState &sessionState);
152
153     //void msgFromGui(uint netid, QString buf, QString message);
154     void displayMsg(Message message);
155     void displayStatusMsg(QString, QString);
156
157     void scriptResult(QString result);
158
159     //! Identity has been created.
160     /** This signal is propagated to the clients to tell them that the given identity has been created.
161      *  \param identity The new identity.
162      */
163     void identityCreated(const Identity &identity);
164
165     //! Identity has been removed.
166     /** This signal is propagated to the clients to inform them about the removal of the given identity.
167      *  \param identity The identity that has been removed.
168      */
169     void identityRemoved(IdentityId identity);
170
171     void networkCreated(NetworkId);
172     void networkRemoved(NetworkId);
173     void networkDisconnected(NetworkId);
174
175     void passwordChanged(PeerPtr peer, bool success);
176
177     void disconnectFromCore();
178
179 protected:
180     virtual void customEvent(QEvent *event);
181
182 private slots:
183     void removeClient(Peer *peer);
184
185     void recvStatusMsgFromServer(QString msg);
186     void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
187
188     void destroyNetwork(NetworkId);
189
190     void scriptRequest(QString script);
191
192     void clientsConnected();
193     void clientsDisconnected();
194
195     void updateIdentityBySender();
196
197     void saveSessionState() const;
198
199 private:
200     void processMessages();
201
202     void loadSettings();
203     void initScriptEngine();
204
205     /// Hook for converting events to the old displayMsg() handlers
206     Q_INVOKABLE void processMessageEvent(MessageEvent *event);
207
208     UserId _user;
209
210     SignalProxy *_signalProxy;
211     CoreAliasManager _aliasManager;
212     // QHash<NetworkId, NetworkConnection *> _connections;
213     QHash<NetworkId, CoreNetwork *> _networks;
214     //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
215     QHash<IdentityId, CoreIdentity *> _identities;
216
217     CoreBufferSyncer *_bufferSyncer;
218     CoreBacklogManager *_backlogManager;
219     CoreBufferViewManager *_bufferViewManager;
220     CoreDccConfig *_dccConfig;
221     CoreIrcListHelper *_ircListHelper;
222     CoreNetworkConfig *_networkConfig;
223     CoreCoreInfo _coreInfo;
224     CoreTransferManager *_transferManager;
225
226     EventManager *_eventManager;
227     EventStringifier *_eventStringifier; // should eventually move into client
228     CoreSessionEventProcessor *_sessionEventProcessor;
229     CtcpParser *_ctcpParser;
230     IrcParser *_ircParser;
231
232     QScriptEngine *scriptEngine;
233
234     /**
235      * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and
236      * processing them to prefixes based on the network's settings.
237      * @param sender The hostmask of the sender
238      * @param bufferInfo The BufferInfo object of the buffer
239      */
240     QString senderPrefixes(const QString &sender, const BufferInfo &bufferInfo) const;
241     QList<RawMessage> _messageQueue;
242     bool _processMessages;
243     CoreIgnoreListManager _ignoreListManager;
244     CoreHighlightRuleManager _highlightRuleManager;
245 };
246
247
248 struct RawMessage {
249     NetworkId networkId;
250     Message::Type type;
251     BufferInfo::Type bufferType;
252     QString target;
253     QString text;
254     QString sender;
255     Message::Flags flags;
256     RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
257         : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}
258 };
259
260 #endif