X-Git-Url: https://git.quassel-irc.org/?a=blobdiff_plain;f=src%2Fclient%2Fclient.h;h=4d1bad6c1342f252464d29fa65995afbc92692a8;hb=37110ceaa070167b4f40ed449ac9ea130503a792;hp=fabed9d60f96a8ef57819d52f71235fc918f7dbb;hpb=52380175425bdab29f825c9cd17a0e4c1952c2db;p=quassel.git diff --git a/src/client/client.h b/src/client/client.h index fabed9d6..7850b0fc 100644 --- a/src/client/client.h +++ b/src/client/client.h @@ -1,11 +1,11 @@ /*************************************************************************** - * Copyright (C) 2005-07 by the Quassel IRC Team * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * + * (at your option) version 3. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -15,148 +15,310 @@ * 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 _CLIENT_H_ -#define _CLIENT_H_ +#pragma once -#include -#include #include #include -#include "buffer.h" // needed for activity lvl -class BufferInfo; -class Message; +#include "bufferinfo.h" +#include "coreinfo.h" +#include "coreaccount.h" +#include "coreconnection.h" +#include "highlightrulemanager.h" +#include "quassel.h" +#include "types.h" -class NetworkInfo; +class Message; +class MessageModel; +class AbstractMessageProcessor; +class Identity; +class CertIdentity; +class Network; class AbstractUi; class AbstractUiMsg; -class BufferTreeModel; +class NetworkModel; +class BufferModel; +class BufferSyncer; +class BufferViewOverlay; +class ClientAliasManager; +class ClientBacklogManager; +class ClientBufferViewManager; +class ClientIgnoreListManager; +class ClientIrcListHelper; +class ClientTransferManager; +class ClientUserInputHandler; +class CoreAccountModel; +class CoreConnection; +class DccConfig; +class IrcUser; +class IrcChannel; +class NetworkConfig; class SignalProxy; +class TransferModel; -class QTimer; - +struct NetworkInfo; -class Client : public QObject { - Q_OBJECT +class Client : public QObject +{ + Q_OBJECT public: - static Client *instance(); - static void destroy(); - static void init(AbstractUi *); - - static QList networkInfos(); - static NetworkInfo *networkInfo(uint networkid); - - static QList allBufferInfos(); - static QList buffers(); - static Buffer *buffer(uint bufferUid); - static Buffer *buffer(BufferInfo); - static BufferInfo statusBufferInfo(QString net); - static BufferInfo bufferInfo(QString net, QString buf); - - static BufferTreeModel *bufferModel(); - static SignalProxy *signalProxy(); - - static AbstractUiMsg *layoutMsg(const Message &); - - static bool isConnected(); - - static void storeSessionData(const QString &key, const QVariant &data); - static QVariant retrieveSessionData(const QString &key, const QVariant &def = QVariant()); - static QStringList sessionDataKeys(); - - enum ClientMode { LocalCore, RemoteCore }; + enum ClientMode { + LocalCore, + RemoteCore + }; + + static bool instanceExists(); + static Client *instance(); + static void destroy(); + static void init(AbstractUi *); + static AbstractUi *mainUi(); + + static QList networkIds(); + static const Network *network(NetworkId); + + static QList identityIds(); + static const Identity *identity(IdentityId); + + //! Request creation of an identity with the given data. + /** The request will be sent to the core, and will be propagated back to all the clients + * with a new valid IdentityId. + * \param identity The identity template for the new identity. It does not need to have a valid ID. + */ + static void createIdentity(const CertIdentity &identity); + + //! Request update of an identity with the given data. + /** The request will be sent to the core, and will be propagated back to all the clients. + * \param id The identity to be updated. + * \param serializedData The identity's content (cf. SyncableObject::toVariantMap()) + */ + static void updateIdentity(IdentityId id, const QVariantMap &serializedData); + + //! Request removal of the identity with the given ID from the core (and all the clients, of course). + /** \param id The ID of the identity to be removed. + */ + static void removeIdentity(IdentityId id); + + static void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList()); + static void updateNetwork(const NetworkInfo &info); + static void removeNetwork(NetworkId id); + + static inline NetworkModel *networkModel() { return instance()->_networkModel; } + static inline BufferModel *bufferModel() { return instance()->_bufferModel; } + static inline MessageModel *messageModel() { return instance()->_messageModel; } + static inline AbstractMessageProcessor *messageProcessor() { return instance()->_messageProcessor; } + static inline SignalProxy *signalProxy() { return instance()->_signalProxy; } + + static inline ClientAliasManager *aliasManager() { return instance()->_aliasManager; } + static inline ClientBacklogManager *backlogManager() { return instance()->_backlogManager; } + static inline CoreInfo *coreInfo() { return instance()->_coreInfo; } + static inline DccConfig *dccConfig() { return instance()->_dccConfig; } + static inline ClientIrcListHelper *ircListHelper() { return instance()->_ircListHelper; } + static inline ClientBufferViewManager *bufferViewManager() { return instance()->_bufferViewManager; } + static inline BufferViewOverlay *bufferViewOverlay() { return instance()->_bufferViewOverlay; } + static inline ClientUserInputHandler *inputHandler() { return instance()->_inputHandler; } + static inline NetworkConfig *networkConfig() { return instance()->_networkConfig; } + static inline ClientIgnoreListManager *ignoreListManager() { return instance()->_ignoreListManager; } + static inline HighlightRuleManager *highlightRuleManager() { return instance()->_highlightRuleManager; } + static inline ClientTransferManager *transferManager() { return instance()->_transferManager; } + static inline TransferModel *transferModel() { return instance()->_transferModel; } + + static inline BufferSyncer *bufferSyncer() { return instance()->_bufferSyncer; } + + static inline CoreAccountModel *coreAccountModel() { return instance()->_coreAccountModel; } + static inline CoreConnection *coreConnection() { return instance()->_coreConnection; } + static inline CoreAccount currentCoreAccount() { return coreConnection()->currentAccount(); } + static bool isCoreFeatureEnabled(Quassel::Feature feature); + + static bool isConnected(); + static bool internalCore(); + + static void userInput(const BufferInfo &bufferInfo, const QString &message); + + static void setBufferLastSeenMsg(BufferId id, const MsgId &msgId); // this is synced to core and other clients + static void setMarkerLine(BufferId id, const MsgId &msgId); // this is synced to core and other clients + static MsgId markerLine(BufferId id); + + static void removeBuffer(BufferId id); + static void renameBuffer(BufferId bufferId, const QString &newName); + static void mergeBuffersPermanently(BufferId bufferId1, BufferId bufferId2); + static void purgeKnownBufferIds(); + + /** + * Requests client to resynchronize the CoreInfo object for legacy (pre-0.13) cores + * + * This provides compatibility with updating core information for legacy cores, and can be + * removed after protocol break. + * + * NOTE: On legacy (pre-0.13) cores, any existing connected signals will be destroyed and must + * be re-added after calling this, in addition to checking for existing data in coreInfo(). + */ + static void refreshLegacyCoreInfo(); + + static void changePassword(const QString &oldPassword, const QString &newPassword); + static void kickClient(int peerId); + + void displayIgnoreList(QString ignoreRule) { + emit showIgnoreList(ignoreRule); + } + + void displayChannelList(NetworkId networkId) { + emit showChannelList(networkId); + } signals: - void sendInput(BufferInfo, QString message); - void showBuffer(Buffer *); - void bufferSelected(Buffer *); - void bufferUpdated(Buffer *); - void bufferActivity(Buffer::ActivityLevel, Buffer *); - void bufferDestroyed(Buffer *); - void backlogReceived(Buffer *, QList); - void requestBacklog(BufferInfo, QVariant, QVariant); - void requestNetworkStates(); - - void recvPartialItem(uint avail, uint size); - void coreConnectionError(QString errorMsg); - void coreConnectionMsg(const QString &msg); - void coreConnectionProgress(uint part, uint total); - - void connected(); - void disconnected(); - - void sessionDataChanged(const QString &key); - void sessionDataChanged(const QString &key, const QVariant &data); - void sendSessionData(const QString &key, const QVariant &data); + void requestNetworkStates(); + + void showConfigWizard(const QVariantMap &coredata); + void showChannelList(NetworkId networkId); + void showIgnoreList(QString ignoreRule); + + void connected(); + void disconnected(); + void coreConnectionStateChanged(bool); + + /** + * Signals that core information has been resynchronized, removing existing signal handlers + * + * Whenever this is emitted, one should re-add any handlers for CoreInfo::coreDataChanged() and + * apply any existing information in the coreInfo() object. + * + * Only emitted on legacy (pre-0.13) cores. Generally, one should use the + * CoreInfo::coreDataChanged() signal too. + */ + void coreInfoResynchronized(); + + //! The identity with the given ID has been newly created in core and client. + /** \param id The ID of the newly created identity. + */ + void identityCreated(IdentityId id); + + //! The identity with the given ID has been removed. + /** Upon emitting this signal, the identity is already gone from the core, and it will + * be deleted from the client immediately afterwards, so connected slots need to clean + * up their stuff. + * \param id The ID of the identity about to be removed. + */ + void identityRemoved(IdentityId id); + + //! Sent to the core when an identity shall be created. Should not be used elsewhere. + void requestCreateIdentity(const Identity &, const QVariantMap &); + //! Sent to the core when an identity shall be removed. Should not be used elsewhere. + void requestRemoveIdentity(IdentityId); + + void networkCreated(NetworkId id); + void networkRemoved(NetworkId id); + + void requestCreateNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList()); + void requestRemoveNetwork(NetworkId); + + //! Emitted when a buffer has been marked as read + /** This is currently triggered by setting lastSeenMsg, either local or remote, + * or by bringing the window to front. + * \param id The buffer that has been marked as read + */ + void bufferMarkedAsRead(BufferId id); + + //! Requests a password change (user name must match the currently logged in user) + void requestPasswordChange(PeerPtr peer, const QString &userName, const QString &oldPassword, const QString &newPassword); + + void requestKickClient(int peerId); + void passwordChanged(bool success); + + //! Emitted when database schema upgrade starts or ends (only mono client) + void dbUpgradeInProgress(bool inProgress); public slots: - //void selectBuffer(Buffer *); - //void connectToLocalCore(); - void connectToCore(const QVariantMap &); - void disconnectFromCore(); + void disconnectFromCore(); -private slots: - void recvCoreState(const QVariant &state); - void recvSessionData(const QString &key, const QVariant &data); + void bufferRemoved(BufferId bufferId); + void bufferRenamed(BufferId bufferId, const QString &newName); + void buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2); - void coreSocketError(QAbstractSocket::SocketError); - void coreHasData(); - void coreSocketConnected(); - void coreSocketDisconnected(); - void coreSocketStateChanged(QAbstractSocket::SocketState); + void markBufferAsRead(BufferId id); - void userInput(BufferInfo, QString); + void onDbUpgradeInProgress(bool inProgress); - void networkConnected(uint); - void networkDisconnected(uint); - - void updateCoreConnectionProgress(); - void recvMessage(const Message &message); - void recvStatusMsg(QString network, QString message); - void recvBacklogData(BufferInfo, QVariantList, bool); - void updateBufferInfo(BufferInfo); - - void removeBuffer(Buffer *); - - void layoutMsg(); - -private: - Client(QObject *parent = 0); - virtual ~Client(); - void init(); - - void syncToCore(const QVariant &coreState); - QVariant connectToLocalCore(QString user, QString passwd); // defined in main.cpp - void disconnectFromLocalCore(); // defined in main.cpp - - static QPointer instanceptr; - - QPointer socket; - QPointer _signalProxy; - QPointer mainUi; - QPointer _bufferModel; +private slots: + void setSyncedToCore(); + void setDisconnectedFromCore(); + void connectionStateChanged(CoreConnection::ConnectionState); - ClientMode clientMode; + void recvMessage(const Message &message); + void recvStatusMsg(QString network, QString message); - quint32 blockSize; - bool connectedToCore; - - QVariantMap coreConnectionInfo; - QHash _buffers; - QHash _networkInfo; + void networkDestroyed(); + void coreIdentityCreated(const Identity &); + void coreIdentityRemoved(IdentityId); + void coreNetworkCreated(NetworkId); + void coreNetworkRemoved(NetworkId); - QTimer *layoutTimer; - QList layoutQueue; + void corePasswordChanged(PeerPtr, bool success); - QVariantMap sessionData; + void finishConnectionInitialization(); + void sendBufferedUserInput(); +private: + Client(QObject *parent = 0); + virtual ~Client(); + void init(); + + void requestInitialBacklog(); + + /** + * Deletes and resynchronizes the CoreInfo object for legacy (pre-0.13) cores + * + * This provides compatibility with updating core information for legacy cores, and can be + * removed after protocol break. + * + * NOTE: On legacy (pre-0.13) cores, any existing connected signals will be destroyed and must + * be re-added after calling this, in addition to checking for existing data in coreInfo(). + */ + void requestLegacyCoreInfo(); + + static void addNetwork(Network *); + + static QPointer instanceptr; + + SignalProxy *_signalProxy; + AbstractUi *_mainUi; + NetworkModel *_networkModel; + BufferModel *_bufferModel; + BufferSyncer *_bufferSyncer; + ClientAliasManager *_aliasManager; + ClientBacklogManager *_backlogManager; + ClientBufferViewManager *_bufferViewManager; + BufferViewOverlay *_bufferViewOverlay; + CoreInfo *_coreInfo; + DccConfig *_dccConfig; + ClientIrcListHelper *_ircListHelper; + ClientUserInputHandler *_inputHandler; + NetworkConfig *_networkConfig; + ClientIgnoreListManager *_ignoreListManager; + HighlightRuleManager *_highlightRuleManager; + ClientTransferManager *_transferManager; + TransferModel *_transferModel; + + MessageModel *_messageModel; + AbstractMessageProcessor *_messageProcessor; + + CoreAccountModel *_coreAccountModel; + CoreConnection *_coreConnection; + + ClientMode clientMode; + + QHash _networks; + QHash _identities; + + bool _connected; + + QList > _userInputBuffer; + + friend class CoreConnection; }; - -#endif