Periodically save all settings of a coresession
[quassel.git] / src / core / coresession.h
1 /***************************************************************************
2  *   Copyright (C) 2005-09 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 "coreignorelistmanager.h"
30 #include "message.h"
31 #include "storage.h"
32
33 class CoreBacklogManager;
34 class CoreBufferSyncer;
35 class CoreBufferViewManager;
36 class CoreIrcListHelper;
37 class CoreNetworkConfig;
38 class Identity;
39 class CoreIdentity;
40 class NetworkConnection;
41 class CoreNetwork;
42 struct NetworkInfo;
43 class SignalProxy;
44
45 class QScriptEngine;
46
47 class CoreSession : public QObject {
48   Q_OBJECT
49
50 public:
51   CoreSession(UserId, bool restoreState, QObject *parent = 0);
52   ~CoreSession();
53
54   QList<BufferInfo> buffers() const;
55   inline UserId user() const { return _user; }
56   CoreNetwork *network(NetworkId) const;
57   CoreIdentity *identity(IdentityId) const;
58   inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
59   NetworkConnection *networkConnection(NetworkId) const;
60
61   QVariant sessionState();
62
63   inline SignalProxy *signalProxy() const { return _signalProxy; }
64
65   const AliasManager &aliasManager() const { return _aliasManager; }
66   AliasManager &aliasManager() { return _aliasManager; }
67
68   inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
69
70 //   void attachNetworkConnection(NetworkConnection *conn);
71
72   //! Return necessary data for restoring the session after restarting the core
73   void restoreSessionState();
74
75 public slots:
76   void addClient(QIODevice *device);
77   void addClient(SignalProxy *proxy);
78
79   void msgFromClient(BufferInfo, QString message);
80
81   //! Create an identity and propagate the changes to the clients.
82   /** \param identity The identity to be created.
83    */
84   void createIdentity(const Identity &identity, const QVariantMap &additional);
85   void createIdentity(const CoreIdentity &identity);
86
87   //! Remove identity and propagate that fact to the clients.
88   /** \param identity The identity to be removed.
89    */
90   void removeIdentity(IdentityId identity);
91
92   //! Create a network and propagate the changes to the clients.
93   /** \param info The network's settings.
94    */
95   void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
96
97   //! Remove network and propagate that fact to the clients.
98   /** \param network The id of the network to be removed.
99    */
100   void removeNetwork(NetworkId network);
101
102   //! Rename a Buffer for a given network
103   /* \param networkId The id of the network the buffer belongs to
104    * \param newName   The new name of the buffer
105    * \param oldName   The old name of the buffer
106    */
107   void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
108
109   QHash<QString, QString> persistentChannels(NetworkId) const;
110
111 signals:
112   void initialized();
113   void sessionState(const QVariant &);
114
115   //void msgFromGui(uint netid, QString buf, QString message);
116   void displayMsg(Message message);
117   void displayStatusMsg(QString, QString);
118
119   void scriptResult(QString result);
120
121   //! Identity has been created.
122   /** This signal is propagated to the clients to tell them that the given identity has been created.
123    *  \param identity The new identity.
124    */
125   void identityCreated(const Identity &identity);
126
127   //! Identity has been removed.
128   /** This signal is propagated to the clients to inform them about the removal of the given identity.
129    *  \param identity The identity that has been removed.
130    */
131   void identityRemoved(IdentityId identity);
132
133   void networkCreated(NetworkId);
134   void networkRemoved(NetworkId);
135
136 private slots:
137   void removeClient(QIODevice *dev);
138
139   void recvStatusMsgFromServer(QString msg);
140   void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
141
142   void destroyNetwork(NetworkId);
143
144   void scriptRequest(QString script);
145
146   void clientsConnected();
147   void clientsDisconnected();
148
149   void updateIdentityBySender();
150
151   void saveSessionState() const;
152
153 protected:
154   virtual void customEvent(QEvent *event);
155
156 private:
157   void loadSettings();
158   void initScriptEngine();
159   void processMessages();
160
161   UserId _user;
162
163   SignalProxy *_signalProxy;
164   CoreAliasManager _aliasManager;
165   // QHash<NetworkId, NetworkConnection *> _connections;
166   QHash<NetworkId, CoreNetwork *> _networks;
167   //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
168   QHash<IdentityId, CoreIdentity *> _identities;
169
170   CoreBufferSyncer *_bufferSyncer;
171   CoreBacklogManager *_backlogManager;
172   CoreBufferViewManager *_bufferViewManager;
173   CoreIrcListHelper *_ircListHelper;
174   CoreNetworkConfig *_networkConfig;
175   CoreCoreInfo _coreInfo;
176
177   QScriptEngine *scriptEngine;
178
179   struct RawMessage {
180     NetworkId networkId;
181     Message::Type type;
182     BufferInfo::Type bufferType;
183     QString target;
184     QString text;
185     QString sender;
186     Message::Flags flags;
187     RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
188       : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}
189   };
190   QList<RawMessage> _messageQueue;
191   bool _processMessages;
192   CoreIgnoreListManager _ignoreListManager;
193 };
194
195 #endif