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