plugins/teamwork/kdevteamwork.h

   1 /***************************************************************************
   2 Copyright 2006 David Nolden <david.nolden.kdevelop@art-master.de>
   3 ***************************************************************************/
   4
   5 /***************************************************************************
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  ***************************************************************************/
  13
  14 #ifndef KDEVTEAMWORK_H
  15 #define KDEVTEAMWORK_H
  16
  17 #include <QObject>
  18 #include <QMap>
  19 #include <QMenu>
  20 #include <QDomDocument>
  21 #include <memory>
  22 #include <kiconloader.h>
  23 #include <set>
  24 #include <list>
  25
  26 #include "teamworkfwd.h"
  27 #include "loglevel.h"
  28 #include "lib/network/safesharedptr.h"
  29 #include "lib/network/messageinterface.h"
  30 #include "autoconstructpointer.h"
  31
  32 using namespace Teamwork;
  33 class KUrl;
  34
  35 namespace Ui {
  36 class Teamwork;
  37 }
  38
  39 class QModelIndex;
  40
  41 class KDevTeamwork : public QObject {
  42     static KDevTeamwork* m_self;
  43     enum MessageTypes {
  44       Message = 0,
  45       SourceMessage = 1
  46   };
  47
  48     Q_OBJECT
  49   public:
  50     typedef SafeSharedPtr<KDevTeamworkClient> TeamworkClientPointer;
  51     KDevTeamwork( const KUrl& workspaceDirectory, KDevTeamworkPlugin *plugin, QWidget *parent );
  52     virtual ~KDevTeamwork();
  53
  54     KDevTeamworkPlugin *plugin() const;
  55
  56     static KDevTeamwork* self() ;
  57
  58     /**Sets the whole  teamwork-part(client plus server) active/inactive. When set inactive, all connetions are closed.
  59     on success returns the given activity-state. */
  60     bool setActive( bool active );
  61     //
  62     /**enables/disables the server. */
  63     bool setServerActive( bool active );
  64
  65     void showUserInfo( const UserPointer& user );
  66
  67     ///@todo: make this a signal
  68     void fillUserMenu( QMenu* menu, const UserPointer& user );
  69
  70     ///The main fillMessageMenu is the one in the MessageManager. That also invokes this one.
  71     void fillMessageMenu( QMenu* menu, const MessagePointer& msg );
  72
  73     ///@todo remove
  74     Ui::Teamwork& widgets();
  75
  76     QWidget* widget();
  77
  78     IconCache& icons();
  79
  80     void log( const QString& str, LogLevel level = Info );
  81
  82     void err( const QString& str );
  83
  84     QIcon iconFromUser( User* user, KIconLoader::Group size = KIconLoader::Small );
  85
  86     ///Starts the update-timer for the developer-lists
  87     void startUpdateTimer();
  88
  89     TeamworkClientPointer& client();
  90
  91     PatchesManager* patchesManager();
  92
  93     CollaborationManager* collaborationManager();
  94
  95     MessageManager* messageManager();
  96
  97     void handlePatchesList( PatchesListMessage* msg );
  98     void getPatchesList( const UserPointer& user );
  99
 100     LoggerPointer logger();
 101
 102     ///Inserts the given message into the various GUI-structures. It should be based on AbstractGUIMessage.
 103     void  addMessageToList( const MessagePointer& smsg );
 104
 105     virtual void restorePartialProjectSession( const QDomElement* el );
 106
 107     virtual void savePartialProjectSession( QDomElement* el );
 108
 109     UserPointer localUser();
 110
 111     UserIdentity currentUserIdentity();
 112
 113   public slots:
 114
 115     /**Prepares the GUI for sending a message to the given user. Second parameter may be zero
 116      * @param target The user the message should be sent to
 117      * @param answerTo which message this one is a reply to.
 118      * */
 119     void guiSendMessageTo( const UserPointer& target, const MessagePointer& answerTo = MessagePointer() );
 120
 121     ///This can be used by messages in other threads to send a request that their state(currently only icon) has changed
 122     void updateMessageInfo( MessagePointer );
 123
 124   signals:
 125     ///This is called whenever the local client was destroyed or created, the current client is given as parameter(may be null). Whenever this is emitted, all UserPointers become invalid.
 126     void updateConnection( TeamworkClientPointer client );
 127     ///Called once KDevTeamwork is completely constructed
 128     void init();
 129     void deInit();
 130
 131   private slots:
 132     void documentActivated( KDevelop::IDocument* file );
 133     void popupContextMenu( const QPoint &pos );
 134     void allowIncomingChanged( int state );
 135     void enableCollaborationChanged( int state );
 136     void connectServer();
 137
 138     void uiShowPatches();
 139     void uiUserInfo();
 140
 141     void uiFilterLog();
 142
 143     void connectionRequest( ConnectionRequestPointer request );
 144
 145     void developerClicked( const QModelIndex& index );
 146     void developerDoubleClicked( const QModelIndex& index );
 147     void developerContextMenu( const QPoint& );
 148
 149     void serverClicked( const QModelIndex& index );
 150     void clientClicked( const QModelIndex& index );
 151     void messageClicked( const QModelIndex& index );
 152
 153     void serverDoubleClicked( const QModelIndex& index );
 154     void clientDoubleClicked( const QModelIndex& index );
 155     void messageDoubleClicked( const QModelIndex& index );
 156
 157     void receiveMessage( SafeSharedPtr<KDevSystemMessage> msg );
 158
 159     void clearLogButton();
 160     void saveLogButton();
 161
 162     void messageReplyTimeout();
 163     void sendMessageButton();
 164     void messageTypeIndexChanged( const int index );
 165
 166     void slotClearMessageText();
 167
 168     void slotClearMessages();
 169     void slotMessageHistory();
 170
 171     void disconnectFromServer();
 172     void disconnectAllServers();
 173
 174     void sendAnswerMessage();
 175     void sendMessageToUser();
 176     void kickClient();
 177     void banClient();
 178     void kickAllClients();
 179
 180     void messageTargetUserChanged();
 181     void updateAnswerMenu();
 182
 183     void handleTextMessage( SafeSharedPtr<KDevTeamworkTextMessage> msg );
 184
 185     void guiUserConnected( Teamwork::UserPointer );
 186     void guiUserDisconnected( Teamwork::UserPointer );
 187     void guiServerConnected( Teamwork::ClientSessionDesc, Teamwork::ServerInformation );
 188     void guiServerDisconnected( Teamwork::ClientSessionDesc, Teamwork::ServerInformation );
 189     void guiUserList( std::list<UserPointer> );
 190     void guiLog( QString str, int level ) {
 191       log( str, ( LogLevel ) level );
 192     }
 193
 194     ///Should be called time by time after the state of users changes. This updates all lists that contain users.
 195     void updateTimeout();
 196
 197     void messageUpdated( const MessagePointer& msg );
 198
 199     void maybeDeveloperContextMenu();
 200
 201     void answerMenuToggled( bool state );
 202     void answerMenuTriggered( bool );
 203
 204   private:
 205     void contextMenu( const QPoint& p, const QModelIndex& index );
 206
 207     void lockMessageGui( const MessagePointer& msg );
 208     void unlockMessageGui();
 209
 210     friend class KDevTeamworkLogger;
 211     friend class KDevTeamworkClient;
 212
 213     void addSentMessageToList( const MessagePointer&, QStandardItemModel* model );
 214
 215     void addReceivedMessageToList( const MessagePointer&, QStandardItemModel* model );
 216
 217     QAction* sendAnswerAction;
 218     QAction* sendMessageToUserAction;
 219     QAction* disconnectFromServerAction;
 220     QAction* disconnectAllServersAction;
 221
 222     QAction* kickClientAction;
 223     QAction* banClientAction;
 224     QAction* kickAllClientsAction;
 225     QAction* m_userInfoAction;
 226     QAction* showPatchesAction;
 227
 228     UserPointer sendingUser();
 229
 230     MessagePointer sendingMessage();
 231
 232     void addSentMessageToList( const MessagePointer& );
 233
 234     void addReceivedMessageToList( const MessagePointer& );
 235
 236     void addDeveloper( const Teamwork::UserPointer& u );
 237
 238     void enableActiveGUI( bool active );
 239
 240     void enableMessageGUI( bool active );
 241
 242     void filterLog( int max = 0 );
 243
 244     void registerPatches( PatchesListMessage* msg, QStandardItemModel* model );
 245
 246     UserPointer currentMessageTargetUser();
 247
 248     QMenu* m_messageFilterMenu;
 249
 250     AutoConstructPointer<TeamworkFolderManager> m_folderManager;
 251
 252     SafeSharedPtr<KDevTeamworkLogger> m_logger;
 253
 254     bool m_destroyed;
 255     KDevTeamworkPlugin *m_plugin;
 256     QWidget* m_widget;
 257     AutoConstructPointer<Ui::Teamwork> m_widgets;
 258     bool m_active, m_serverActive;
 259     TeamworkClientPointer m_client;
 260     QStandardItemModel* m_logModel;
 261     QStandardItemModel* m_messagesModel;
 262     QStandardItemModel* m_clientsModel;
 263     QStandardItemModel* m_serversModel;
 264     QStandardItemModel* m_developersModel;
 265
 266     ///The next message to send is answer to:
 267     MessagePointer m_answerTo;
 268     MessagePointer m_waitingForReply; ///This message is blocking the message-gui waiting for a reply
 269     QTimer* m_replyWaitingTimeout;
 270
 271
 272     friend class MessageUserTab;
 273
 274     KDevTeamworkUserPointer currentTabUser();
 275
 276     typedef QMap<KDevTeamworkUserPointer, SharedPtr<MessageUserTab> > UserTabMap;
 277
 278     UserTabMap m_userTabs;
 279
 280     MessagePointer m_actionMessage;
 281
 282     QTimer* m_updateTimer;
 283     QTimer* m_updateAnswerTimer; ///Timer for updating the list of possible messages the user can reply to
 284     AutoConstructPointer<PatchesManager> m_patchesManager;
 285     AutoConstructPointer<CollaborationManager> m_collaborationManager;
 286     AutoConstructPointer<MessageManager> m_messageManager;
 287     AutoConstructPointer<MessageSendManager> m_messageSendManager;
 288
 289     std::set<UserPointer, UserPointer::ValueSmallerCompare> m_persistentUsers;
 290
 291     LogLevel m_currentLogFilter;
 292
 293     AutoConstructPointer<IconCache> m_icons;
 294     std::auto_ptr<QPersistentModelIndex> m_contextMenuIndex;
 295
 296     enum MessageTypeIndex {
 297       NormalMessage,
 298       DocumentMessage
 299   };
 300 };
 301
 302 #endif // KDEVCODEVIEW_H
 303
 304 // kate: space-indent on; indent-width 2; tab-width 2; replace-tabs on