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 "coreinfo.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, bool strictIdentEnabled, 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
  73     /**
  74      * Returns the optionally strict-compliant ident for the given user identity
  75      *
  76      * If strict mode is enabled, this will return the user's Quassel username for any identity,
  77      * otherwise this will return the given identity's ident, whatever it may be.
  78      *
  79      * @return The user's ident, compliant with strict mode (when enabled)
  80      */
  81     const QString strictCompliantIdent(const CoreIdentity *identity);
  82
  83     inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
  84     NetworkConnection *networkConnection(NetworkId) const;
  85
  86     Protocol::SessionState sessionState() const;
  87
  88     inline SignalProxy *signalProxy() const { return _signalProxy; }
  89
  90     const AliasManager &aliasManager() const { return _aliasManager; }
  91     AliasManager &aliasManager() { return _aliasManager; }
  92
  93     inline EventManager *eventManager() const { return _eventManager; }
  94     inline EventStringifier *eventStringifier() const { return _eventStringifier; }
  95     inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; }
  96     inline CtcpParser *ctcpParser() const { return _ctcpParser; }
  97     inline IrcParser *ircParser() const { return _ircParser; }
  98
  99     inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
 100
 101     inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; }
 102     inline HighlightRuleManager *highlightRuleManager() { return &_highlightRuleManager; }
 103     inline CoreTransferManager *transferManager() const { return _transferManager; }
 104     inline CoreDccConfig *dccConfig() const { return _dccConfig; }
 105
 106 //   void attachNetworkConnection(NetworkConnection *conn);
 107
 108     //! Return necessary data for restoring the session after restarting the core
 109     void restoreSessionState();
 110
 111 public slots:
 112     void addClient(RemotePeer *peer);
 113     void addClient(InternalPeer *peer);
 114
 115     void msgFromClient(BufferInfo, QString message);
 116
 117     //! Create an identity and propagate the changes to the clients.
 118     /** \param identity The identity to be created.
 119      */
 120     void createIdentity(const Identity &identity, const QVariantMap &additional);
 121     void createIdentity(const CoreIdentity &identity);
 122
 123     //! Remove identity and propagate that fact to the clients.
 124     /** \param identity The identity to be removed.
 125      */
 126     void removeIdentity(IdentityId identity);
 127
 128     //! Create a network and propagate the changes to the clients.
 129     /** \param info The network's settings.
 130      */
 131     void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
 132
 133     //! Remove network and propagate that fact to the clients.
 134     /** \param network The id of the network to be removed.
 135      */
 136     void removeNetwork(NetworkId network);
 137
 138     //! Rename a Buffer for a given network
 139     /* \param networkId The id of the network the buffer belongs to
 140      * \param newName   The new name of the buffer
 141      * \param oldName   The old name of the buffer
 142      */
 143     void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
 144
 145     void changePassword(PeerPtr peer, const QString &userName, const QString &oldPassword, const QString &newPassword);
 146
 147     void kickClient(int peerId);
 148
 149     QHash<QString, QString> persistentChannels(NetworkId) const;
 150
 151     QHash<QString, QByteArray> bufferCiphers(NetworkId id) const;
 152     void setBufferCipher(NetworkId id, const QString &bufferName, const QByteArray &cipher) const;
 153
 154     /**
 155      * Marks us away (or unaway) on all networks
 156      *
 157      * @param[in] msg             Away message, or blank to set unaway
 158      * @param[in] skipFormatting  If true, skip timestamp formatting codes (e.g. if already done)
 159      */
 160     void globalAway(const QString &msg = QString(), const bool skipFormatting = false);
 161
 162 signals:
 163     void initialized();
 164     void sessionState(const Protocol::SessionState &sessionState);
 165
 166     //void msgFromGui(uint netid, QString buf, QString message);
 167     void displayMsg(Message message);
 168     void displayStatusMsg(QString, QString);
 169
 170     void scriptResult(QString result);
 171
 172     //! Identity has been created.
 173     /** This signal is propagated to the clients to tell them that the given identity has been created.
 174      *  \param identity The new identity.
 175      */
 176     void identityCreated(const Identity &identity);
 177
 178     //! Identity has been removed.
 179     /** This signal is propagated to the clients to inform them about the removal of the given identity.
 180      *  \param identity The identity that has been removed.
 181      */
 182     void identityRemoved(IdentityId identity);
 183
 184     void networkCreated(NetworkId);
 185     void networkRemoved(NetworkId);
 186     void networkDisconnected(NetworkId);
 187
 188     void passwordChanged(PeerPtr peer, bool success);
 189
 190     void disconnectFromCore();
 191
 192 protected:
 193     virtual void customEvent(QEvent *event);
 194
 195 private slots:
 196     void removeClient(Peer *peer);
 197
 198     void recvStatusMsgFromServer(QString msg);
 199     void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 200
 201     void destroyNetwork(NetworkId);
 202
 203     void scriptRequest(QString script);
 204
 205     void clientsConnected();
 206     void clientsDisconnected();
 207
 208     void updateIdentityBySender();
 209
 210     void saveSessionState() const;
 211
 212 private:
 213     void processMessages();
 214
 215     void loadSettings();
 216     void initScriptEngine();
 217
 218     /// Hook for converting events to the old displayMsg() handlers
 219     Q_INVOKABLE void processMessageEvent(MessageEvent *event);
 220
 221     UserId _user;
 222
 223     /// Whether or not strict ident mode is enabled, locking users' idents to Quassel username
 224     bool _strictIdentEnabled;
 225
 226     SignalProxy *_signalProxy;
 227     CoreAliasManager _aliasManager;
 228     // QHash<NetworkId, NetworkConnection *> _connections;
 229     QHash<NetworkId, CoreNetwork *> _networks;
 230     //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
 231     QHash<IdentityId, CoreIdentity *> _identities;
 232
 233     CoreBufferSyncer *_bufferSyncer;
 234     CoreBacklogManager *_backlogManager;
 235     CoreBufferViewManager *_bufferViewManager;
 236     CoreDccConfig *_dccConfig;
 237     CoreIrcListHelper *_ircListHelper;
 238     CoreNetworkConfig *_networkConfig;
 239     CoreInfo *_coreInfo;
 240     CoreTransferManager *_transferManager;
 241
 242     EventManager *_eventManager;
 243     EventStringifier *_eventStringifier; // should eventually move into client
 244     CoreSessionEventProcessor *_sessionEventProcessor;
 245     CtcpParser *_ctcpParser;
 246     IrcParser *_ircParser;
 247
 248     QScriptEngine *scriptEngine;
 249
 250     /**
 251      * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and
 252      * processing them to prefixes based on the network's settings.
 253      * @param sender The hostmask of the sender
 254      * @param bufferInfo The BufferInfo object of the buffer
 255      */
 256     QString senderPrefixes(const QString &sender, const BufferInfo &bufferInfo) const;
 257
 258     /**
 259      * This method obtains the realname of the message's sender.
 260      * @param sender The hostmask of the sender
 261      * @param networkId The network the user is on
 262      */
 263     QString realName(const QString &sender, NetworkId networkId) const;
 264
 265     /**
 266      * This method obtains the avatar of the message's sender.
 267      * @param sender The hostmask of the sender
 268      * @param networkId The network the user is on
 269      */
 270     QString avatarUrl(const QString &sender, NetworkId networkId) const;
 271     QList<RawMessage> _messageQueue;
 272     bool _processMessages;
 273     CoreIgnoreListManager _ignoreListManager;
 274     CoreHighlightRuleManager _highlightRuleManager;
 275 };
 276
 277
 278 struct RawMessage {
 279     NetworkId networkId;
 280     Message::Type type;
 281     BufferInfo::Type bufferType;
 282     QString target;
 283     QString text;
 284     QString sender;
 285     Message::Flags flags;
 286     RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
 287         : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}
 288 };
 289
 290 #endif