src/core/coresession.h

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