X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcoresession.h;h=83e8786418bf02a9d57ac28c2237f04a19b27ab2;hp=8b4305e343f64a61ba75c564ebf255dca157ef48;hb=b134e777b822b929a78455fd92146bf7443e9aa1;hpb=88b350153eb364853e75d237d3eed2dfaf839d59 diff --git a/src/core/coresession.h b/src/core/coresession.h index 8b4305e3..83e87864 100644 --- a/src/core/coresession.h +++ b/src/core/coresession.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-09 by the Quassel Project * + * Copyright (C) 2005-2020 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,209 +15,327 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef CORESESSION_H -#define CORESESSION_H +#pragma once +#include +#include + +#include +#include #include #include -#include "corecoreinfo.h" #include "corealiasmanager.h" +#include "corehighlightrulemanager.h" #include "coreignorelistmanager.h" +#include "coreinfo.h" #include "message.h" +#include "metricsserver.h" +#include "peer.h" +#include "protocol.h" #include "storage.h" class CoreBacklogManager; class CoreBufferSyncer; class CoreBufferViewManager; +class CoreDccConfig; class CoreIdentity; class CoreIrcListHelper; class CoreNetwork; class CoreNetworkConfig; class CoreSessionEventProcessor; +class CoreTransferManager; class CtcpParser; class EventManager; class EventStringifier; +class InternalPeer; class IrcParser; class MessageEvent; -class NetworkConnection; +class RemotePeer; class SignalProxy; struct NetworkInfo; -class QScriptEngine; - -class CoreSession : public QObject { - Q_OBJECT +class CoreSession : public QObject +{ + Q_OBJECT public: - CoreSession(UserId, bool restoreState, QObject *parent = 0); - ~CoreSession(); + CoreSession(UserId, bool restoreState, bool strictIdentEnabled, QObject* parent = nullptr); - QList buffers() const; - inline UserId user() const { return _user; } - CoreNetwork *network(NetworkId) const; - CoreIdentity *identity(IdentityId) const; - inline CoreNetworkConfig *networkConfig() const { return _networkConfig; } - NetworkConnection *networkConnection(NetworkId) const; + std::vector buffers() const; + inline UserId user() const { return _user; } + CoreNetwork* network(NetworkId) const; + CoreIdentity* identity(IdentityId) const; - QVariant sessionState(); + /** + * Returns the optionally strict-compliant ident for the given user identity + * + * If strict mode is enabled, this will return the user's Quassel username for any identity, + * otherwise this will return the given identity's ident, whatever it may be. + * + * @return The user's ident, compliant with strict mode (when enabled) + */ + const QString strictCompliantIdent(const CoreIdentity* identity); - inline SignalProxy *signalProxy() const { return _signalProxy; } + inline CoreNetworkConfig* networkConfig() const { return _networkConfig; } - const AliasManager &aliasManager() const { return _aliasManager; } - AliasManager &aliasManager() { return _aliasManager; } + Protocol::SessionState sessionState() const; - inline EventManager *eventManager() const { return _eventManager; } - inline EventStringifier *eventStringifier() const { return _eventStringifier; } - inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; } - inline CtcpParser *ctcpParser() const { return _ctcpParser; } - inline IrcParser *ircParser() const { return _ircParser; } + inline SignalProxy* signalProxy() const { return _signalProxy; } - inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; } + const AliasManager& aliasManager() const { return _aliasManager; } + AliasManager& aliasManager() { return _aliasManager; } - inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; } -// void attachNetworkConnection(NetworkConnection *conn); + inline EventManager* eventManager() const { return _eventManager; } + inline EventStringifier* eventStringifier() const { return _eventStringifier; } + inline CoreSessionEventProcessor* sessionEventProcessor() const { return _sessionEventProcessor; } + inline CtcpParser* ctcpParser() const { return _ctcpParser; } + inline IrcParser* ircParser() const { return _ircParser; } - //! Return necessary data for restoring the session after restarting the core - void restoreSessionState(); + inline CoreIrcListHelper* ircListHelper() const { return _ircListHelper; } -public slots: - void addClient(QIODevice *device); - void addClient(SignalProxy *proxy); + inline CoreIgnoreListManager* ignoreListManager() { return &_ignoreListManager; } + inline HighlightRuleManager* highlightRuleManager() { return &_highlightRuleManager; } + inline CoreTransferManager* transferManager() const { return _transferManager; } + inline CoreDccConfig* dccConfig() const { return _dccConfig; } - void msgFromClient(BufferInfo, QString message); + // void attachNetworkConnection(NetworkConnection *conn); - //! Create an identity and propagate the changes to the clients. - /** \param identity The identity to be created. - */ - void createIdentity(const Identity &identity, const QVariantMap &additional); - void createIdentity(const CoreIdentity &identity); + //! Return necessary data for restoring the session after restarting the core + void restoreSessionState(); - //! Remove identity and propagate that fact to the clients. - /** \param identity The identity to be removed. - */ - void removeIdentity(IdentityId identity); +public slots: + void addClient(RemotePeer* peer); + void addClient(InternalPeer* peer); - //! Create a network and propagate the changes to the clients. - /** \param info The network's settings. - */ - void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList()); + /** + * Shuts down the session and deletes itself afterwards. + */ + void shutdown(); - //! Remove network and propagate that fact to the clients. - /** \param network The id of the network to be removed. - */ - void removeNetwork(NetworkId network); + void msgFromClient(BufferInfo, QString message); - //! Rename a Buffer for a given network - /* \param networkId The id of the network the buffer belongs to - * \param newName The new name of the buffer - * \param oldName The old name of the buffer - */ - void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName); + //! Create an identity and propagate the changes to the clients. + /** \param identity The identity to be created. + */ + void createIdentity(const Identity& identity, const QVariantMap& additional); + void createIdentity(const CoreIdentity& identity); - QHash persistentChannels(NetworkId) const; + //! Remove identity and propagate that fact to the clients. + /** \param identity The identity to be removed. + */ + void removeIdentity(IdentityId identity); - //! Marks us away (or unaway) on all networks - void globalAway(const QString &msg = QString()); + //! Create a network and propagate the changes to the clients. + /** \param info The network's settings. + */ + void createNetwork(const NetworkInfo& info, const QStringList& persistentChannels = QStringList()); -signals: - void initialized(); - void sessionState(const QVariant &); + //! Remove network and propagate that fact to the clients. + /** \param network The id of the network to be removed. + */ + void removeNetwork(NetworkId network); - //void msgFromGui(uint netid, QString buf, QString message); - void displayMsg(Message message); - void displayStatusMsg(QString, QString); + //! Rename a Buffer for a given network + /* \param networkId The id of the network the buffer belongs to + * \param newName The new name of the buffer + * \param oldName The old name of the buffer + */ + void renameBuffer(const NetworkId& networkId, const QString& newName, const QString& oldName); - void scriptResult(QString result); + void changePassword(PeerPtr peer, const QString& userName, const QString& oldPassword, const QString& newPassword); - //! Identity has been created. - /** This signal is propagated to the clients to tell them that the given identity has been created. - * \param identity The new identity. - */ - void identityCreated(const Identity &identity); + void kickClient(int peerId); - //! Identity has been removed. - /** This signal is propagated to the clients to inform them about the removal of the given identity. - * \param identity The identity that has been removed. - */ - void identityRemoved(IdentityId identity); + QHash persistentChannels(NetworkId) const; - void networkCreated(NetworkId); - void networkRemoved(NetworkId); - void networkDisconnected(NetworkId); + QHash bufferCiphers(NetworkId id) const; + void setBufferCipher(NetworkId id, const QString& bufferName, const QByteArray& cipher) const; -protected: - virtual void customEvent(QEvent *event); + /** + * Marks us away (or unaway) on all networks + * + * @param[in] msg Away message, or blank to set unaway + * @param[in] skipFormatting If true, skip timestamp formatting codes (e.g. if already done) + */ + void globalAway(const QString& msg = QString(), bool skipFormatting = false); -private slots: - void removeClient(QIODevice *dev); +signals: + void initialized(); + void sessionStateReceived(const Protocol::SessionState& sessionState); - void recvStatusMsgFromServer(QString msg); - void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None); + // void msgFromGui(uint netid, QString buf, QString message); + void displayMsg(Message message); + void displayStatusMsg(QString, QString); - void destroyNetwork(NetworkId); + //! Identity has been created. + /** This signal is propagated to the clients to tell them that the given identity has been created. + * \param identity The new identity. + */ + void identityCreated(const Identity& identity); - void scriptRequest(QString script); + //! Identity has been removed. + /** This signal is propagated to the clients to inform them about the removal of the given identity. + * \param identity The identity that has been removed. + */ + void identityRemoved(IdentityId identity); - void clientsConnected(); - void clientsDisconnected(); + void networkCreated(NetworkId); + void networkRemoved(NetworkId); + void networkDisconnected(NetworkId); - void updateIdentityBySender(); + void passwordChanged(PeerPtr peer, bool success); - void saveSessionState() const; + void disconnectFromCore(); -private: - void processMessages(); +protected: + void customEvent(QEvent* event) override; - void loadSettings(); - void initScriptEngine(); +private slots: + void removeClient(Peer* peer); - /// Hook for converting events to the old displayMsg() handlers - Q_INVOKABLE void processMessageEvent(MessageEvent *event); + void recvStatusMsgFromServer(QString msg); + void recvMessageFromServer(RawMessage msg); - UserId _user; + void destroyNetwork(NetworkId); - SignalProxy *_signalProxy; - CoreAliasManager _aliasManager; - // QHash _connections; - QHash _networks; - // QHash _networksToRemove; - QHash _identities; + void clientsConnected(); + void clientsDisconnected(); - CoreBufferSyncer *_bufferSyncer; - CoreBacklogManager *_backlogManager; - CoreBufferViewManager *_bufferViewManager; - CoreIrcListHelper *_ircListHelper; - CoreNetworkConfig *_networkConfig; - CoreCoreInfo _coreInfo; + void updateIdentityBySender(); - EventManager *_eventManager; - EventStringifier *_eventStringifier; // should eventually move into client - CoreSessionEventProcessor *_sessionEventProcessor; - CtcpParser *_ctcpParser; - IrcParser *_ircParser; + void saveSessionState() const; - QScriptEngine *scriptEngine; + void onNetworkDisconnected(NetworkId networkId); - QList _messageQueue; - bool _processMessages; - CoreIgnoreListManager _ignoreListManager; +private: + void processMessages(); + + void loadSettings(); + + /// Hook for converting events to the old displayMsg() handlers + Q_INVOKABLE void processMessageEvent(MessageEvent* event); + + UserId _user; + + /// Whether or not strict ident mode is enabled, locking users' idents to Quassel username + bool _strictIdentEnabled; + + SignalProxy* _signalProxy; + CoreAliasManager _aliasManager; + + QHash _identities; + QHash _networks; + QSet _networksPendingDisconnect; + + CoreBufferSyncer* _bufferSyncer; + CoreBacklogManager* _backlogManager; + CoreBufferViewManager* _bufferViewManager; + CoreDccConfig* _dccConfig; + CoreIrcListHelper* _ircListHelper; + CoreNetworkConfig* _networkConfig; + CoreInfo* _coreInfo; + CoreTransferManager* _transferManager; + + EventManager* _eventManager; + EventStringifier* _eventStringifier; // should eventually move into client + CoreSessionEventProcessor* _sessionEventProcessor; + CtcpParser* _ctcpParser; + IrcParser* _ircParser; + + /** + * This method obtains the prefixes of the message's sender within a channel, by looking up their channelmodes, and + * processing them to prefixes based on the network's settings. + * @param sender The hostmask of the sender + * @param bufferInfo The BufferInfo object of the buffer + */ + QString senderPrefixes(const QString& sender, const BufferInfo& bufferInfo) const; + + /** + * This method obtains the realname of the message's sender. + * @param sender The hostmask of the sender + * @param networkId The network the user is on + */ + QString realName(const QString& sender, NetworkId networkId) const; + + /** + * This method obtains the avatar of the message's sender. + * @param sender The hostmask of the sender + * @param networkId The network the user is on + */ + QString avatarUrl(const QString& sender, NetworkId networkId) const; + QList _messageQueue; + bool _processMessages; + CoreIgnoreListManager _ignoreListManager; + CoreHighlightRuleManager _highlightRuleManager; + MetricsServer* _metricsServer{nullptr}; }; -struct RawMessage { - NetworkId networkId; - Message::Type type; - BufferInfo::Type bufferType; - QString target; - QString text; - QString sender; - Message::Flags flags; - RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags) - : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {} +struct NetworkInternalMessage +{ + Message::Type type; + BufferInfo::Type bufferType; + QString target; + QString text; + QString sender; + Message::Flags flags; + NetworkInternalMessage(Message::Type type, + BufferInfo::Type bufferType, + QString target, + QString text, + QString sender = "", + Message::Flags flags = Message::None) + : type(type) + , bufferType(bufferType) + , target(std::move(target)) + , text(std::move(text)) + , sender(std::move(sender)) + , flags(flags) + {} }; -#endif +struct RawMessage +{ + QDateTime timestamp; + NetworkId networkId; + Message::Type type; + BufferInfo::Type bufferType; + QString target; + QString text; + QString sender; + Message::Flags flags; + + RawMessage(QDateTime timestamp, + NetworkId networkId, + Message::Type type, + BufferInfo::Type bufferType, + QString target, + QString text, + QString sender, + Message::Flags flags) + : timestamp(std::move(timestamp)) + , networkId(networkId) + , type(type) + , bufferType(bufferType) + , target(std::move(target)) + , text(std::move(text)) + , sender(std::move(sender)) + , flags(flags) + {} + + RawMessage(NetworkId networkId, + const NetworkInternalMessage& msg) + : timestamp(QDateTime::currentDateTimeUtc()) + , networkId(networkId) + , type(msg.type) + , bufferType(msg.bufferType) + , target(msg.target) + , text(msg.text) + , sender(msg.sender) + , flags(msg.flags) + {} +};