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     QHash<QString, QByteArray> bufferCiphers(NetworkId id) const;
 142     void setBufferCipher(NetworkId id, const QString &bufferName, const QByteArray &cipher) const;
 143
 144     /**
 145      * Marks us away (or unaway) on all networks
 146      *
 147      * @param[in] msg             Away message, or blank to set unaway
 148      * @param[in] skipFormatting  If true, skip timestamp formatting codes (e.g. if already done)
 149      */
 150     void globalAway(const QString &msg = QString(), const bool skipFormatting = false);
 151
 152 signals:
 153     void initialized();
 154     void sessionState(const Protocol::SessionState &sessionState);
 155
 156     //void msgFromGui(uint netid, QString buf, QString message);
 157     void displayMsg(Message message);
 158     void displayStatusMsg(QString, QString);
 159
 160     void scriptResult(QString result);
 161
 162     //! Identity has been created.
 163     /** This signal is propagated to the clients to tell them that the given identity has been created.
 164      *  \param identity The new identity.
 165      */
 166     void identityCreated(const Identity &identity);
 167
 168     //! Identity has been removed.
 169     /** This signal is propagated to the clients to inform them about the removal of the given identity.
 170      *  \param identity The identity that has been removed.
 171      */
 172     void identityRemoved(IdentityId identity);
 173
 174     void networkCreated(NetworkId);
 175     void networkRemoved(NetworkId);
 176     void networkDisconnected(NetworkId);
 177
 178     void passwordChanged(PeerPtr peer, bool success);
 179
 180     void disconnectFromCore();
 181
 182 protected:
 183     virtual void customEvent(QEvent *event);
 184
 185 private slots:
 186     void removeClient(Peer *peer);
 187
 188     void recvStatusMsgFromServer(QString msg);
 189     void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 190
 191     void destroyNetwork(NetworkId);
 192
 193     void scriptRequest(QString script);
 194
 195     void clientsConnected();
 196     void clientsDisconnected();
 197
 198     void updateIdentityBySender();
 199
 200     void saveSessionState() const;
 201
 202 private:
 203     void processMessages();
 204
 205     void loadSettings();
 206     void initScriptEngine();
 207
 208     /// Hook for converting events to the old displayMsg() handlers
 209     Q_INVOKABLE void processMessageEvent(MessageEvent *event);
 210
 211     UserId _user;
 212
 213     SignalProxy *_signalProxy;
 214     CoreAliasManager _aliasManager;
 215     // QHash<NetworkId, NetworkConnection *> _connections;
 216     QHash<NetworkId, CoreNetwork *> _networks;
 217     //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
 218     QHash<IdentityId, CoreIdentity *> _identities;
 219
 220     CoreBufferSyncer *_bufferSyncer;
 221     CoreBacklogManager *_backlogManager;
 222     CoreBufferViewManager *_bufferViewManager;
 223     CoreDccConfig *_dccConfig;
 224     CoreIrcListHelper *_ircListHelper;
 225     CoreNetworkConfig *_networkConfig;
 226     CoreCoreInfo _coreInfo;
 227     CoreTransferManager *_transferManager;
 228
 229     EventManager *_eventManager;
 230     EventStringifier *_eventStringifier; // should eventually move into client
 231     CoreSessionEventProcessor *_sessionEventProcessor;
 232     CtcpParser *_ctcpParser;
 233     IrcParser *_ircParser;
 234
 235     QScriptEngine *scriptEngine;
 236
 237     /**
 238      * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and
 239      * processing them to prefixes based on the network's settings.
 240      * @param sender The hostmask of the sender
 241      * @param bufferInfo The BufferInfo object of the buffer
 242      */
 243     QString senderPrefixes(const QString &sender, const BufferInfo &bufferInfo) const;
 244
 245     /**
 246      * This method obtains the realname of the message's sender.
 247      * @param sender The hostmask of the sender
 248      * @param networkId The network the user is on
 249      */
 250     QString realName(const QString &sender, NetworkId networkId) const;
 251
 252     /**
 253      * This method obtains the avatar of the message's sender.
 254      * @param sender The hostmask of the sender
 255      * @param networkId The network the user is on
 256      */
 257     QString avatarUrl(const QString &sender, NetworkId networkId) const;
 258     QList<RawMessage> _messageQueue;
 259     bool _processMessages;
 260     CoreIgnoreListManager _ignoreListManager;
 261     CoreHighlightRuleManager _highlightRuleManager;
 262 };
 263
 264
 265 struct RawMessage {
 266     NetworkId networkId;
 267     Message::Type type;
 268     BufferInfo::Type bufferType;
 269     QString target;
 270     QString text;
 271     QString sender;
 272     Message::Flags flags;
 273     RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
 274         : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}
 275 };
 276
 277 #endif