include/tubes/manager.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_TUBES_MANAGER_HXX
  11 #define INCLUDED_TUBES_MANAGER_HXX
  12
  13 #include <sal/config.h>
  14 #include <tubes/tubesdllapi.h>
  15 #include <rtl/ustring.hxx>
  16
  17 #include <utility>
  18 #include <vector>
  19
  20 // For testing purposes, we might need more in future.
  21 #define LIBO_TUBES_DBUS_INTERFACE "org.libreoffice.calc"
  22 #define LIBO_TUBES_DBUS_MSG_METHOD "LibOMsg"
  23 #define LIBO_TUBES_DBUS_PATH "/org/libreoffice/calc"
  24
  25 namespace osl { class Mutex; }
  26 class Collaboration;
  27 class TeleConference;
  28 class TeleManagerImpl;
  29 typedef struct _TpAccount TpAccount;
  30 typedef struct _TpContact TpContact;
  31
  32 typedef ::std::pair< TpAccount *, TpContact * > AccountContactPair;
  33 typedef ::std::vector< AccountContactPair > AccountContactPairV;
  34
  35 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
  36 /** Interface to Telepathy DBus Tubes.
  37
  38     Fragile, not working yet.
  39
  40     Accounts need to have been setup within Empathy already.
  41  */
  42
  43 class TeleManager
  44 {
  45 public:
  46     /** Prepare tube manager with account and service to be offered/listened
  47         to.
  48      */
  49     TUBES_DLLPUBLIC static bool             init( bool bListen );
  50
  51     TUBES_DLLPUBLIC static void             finalize();
  52
  53     /** True if there has been tube channel received and is still not used. */
  54     TUBES_DLLPUBLIC static bool             hasWaitingConference();
  55
  56     /** Get a conference with current UUID to set a session. */
  57     TUBES_DLLPUBLIC static TeleConference*  getConference();
  58
  59     /** Connect to DBus, create and prepare the Telepathy Account Manager. */
  60     static bool             createAccountManager();
  61
  62     /** Setup client handlers. */
  63     static bool             registerClients();
  64
  65     /** Fetches the contact list.
  66         Is non-functional until createAccountManager().
  67      */
  68     // exported for unit test
  69     TUBES_DLLPUBLIC static AccountContactPairV getContacts();
  70
  71     /** Start a demo session where all local documents are shared to each other */
  72     static TeleConference*  startDemoSession();
  73
  74     /** Start a group session in a MUC.
  75
  76         @param pAccount
  77             The account to use. This must be a valid Jabber account.
  78
  79         @param rConferenceRoom
  80             The MUC to be created/joined, e.g. "LibreOffice". If empty, the
  81             conference's UUID is used.
  82
  83         @param rConferenceServer
  84             Server to create the MUC on, e.g. "conference.example.org". If
  85             empty, only the conference's UUID is used and rConferenceRoom is
  86             ignored, hopefully resulting in a local DBus tube.
  87      */
  88     static TeleConference*  startGroupSession( TpAccount *pAccount,
  89                                                 const OUString& rConferenceRoom,
  90                                                 const OUString& rConferenceServer );
  91
  92     /** Start a session with a buddy.
  93
  94         @param pAccount
  95             The account to use. This must be a valid Jabber account.
  96
  97         @param pBuddy
  98             The buddy to be connected. Must be a contact of pAccount.
  99      */
 100     // exported for unit test
 101     TUBES_DLLPUBLIC static TeleConference* startBuddySession( TpAccount *pAccount, TpContact *pBuddy );
 102
 103     static void             registerCollaboration( Collaboration* pCollaboration );
 104     static void             unregisterCollaboration( Collaboration* pCollaboration );
 105     /** Used to determine whether we are closing the channel by ourselves.
 106      * @return true if the Collaboration is still registered  */
 107     static bool             existsCollaboration( Collaboration* pCollaboration );
 108     /** Display contact list dialog for all documents. */
 109     static void             displayAllContacts();
 110
 111     static void             registerDemoConference( TeleConference* pConference );
 112     static void             unregisterDemoConference( TeleConference* pConference );
 113     /** Broadcast packet to all conferences. Used for demo mode. */
 114     static void             broadcastPacket( const OString& rPacket );
 115
 116
 117     // Only for callbacks.
 118     static void             addConference( TeleConference* pConference );
 119     static OString     createUuid();
 120     /** @param rUuid
 121             is stored so that accepted conference with this UUID could be
 122             then retrieved by getConference() when loading new document
 123     */
 124     static void             setCurrentUuid( const OString& rUuid );
 125
 126     /// "LibreOfficeWhatEver"
 127     static OString     getFullClientName();
 128
 129     /// "org.libreoffice.calcWhatEver"
 130     static OString     getFullServiceName();
 131
 132     /// "/org/libreoffice/calcWhatEver"
 133     static OString     getFullObjectPath();
 134
 135     /** Add a suffix to the client name and DBus tube names, e.g. "WhatEver"
 136
 137         Normally the client name is LibreOffice and the DBus tube service name
 138         is something like org.libreoffice.calc, this modifies the names to
 139         "LibreOffice"+pName and "org.libreoffice.calc"+pName to make tests not
 140         interfere with the real world. This is not to be used otherwise. If
 141         used it must be called before the first TeleManager is instantiated and
 142         connects.
 143      */
 144     // exported for unit test
 145     TUBES_DLLPUBLIC static void addSuffixToNames( const char* pName );
 146
 147 private:
 148     static TeleManagerImpl* pImpl;
 149
 150     static ::osl::Mutex&    GetMutex();
 151 };
 152
 153 #endif // INCLUDED_TUBES_MANAGER_HXX
 154
 155 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */