tdeimproxy.h

/*
    tdeimproxy.h
 
    IM service library for KDE
 
    Copyright (c) 2004 Will Stephenson   <lists@stevello.free-online.co.uk>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef TDEIMPROXY_H
#define TDEIMPROXY_H
 
#include <tqdict.h>
#include <tqmap.h>
#include <tqptrdict.h>
#include <tqstringlist.h>
 
 
#define IM_SERVICE_TYPE "DCOP/InstantMessenger"
#define IM_CLIENT_PREFERENCES_FILE "default_components"
#define IM_CLIENT_PREFERENCES_SECTION "InstantMessenger"
#define IM_CLIENT_PREFERENCES_ENTRY "imClient"
 
#include "tdeimproxyiface.h"
 
class DCOPClient;
class KIMIface_stub;
class KURL;
class ContactPresenceListCurrent;

typedef TQMap<TQCString, int> AppPresence;      // appId->presence; contains all applications' ideas of a user's presence
typedef TQDict<AppPresence> PresenceMap;            // uid->AppPresence; contains a AppPresences for all users
typedef TQMap<TQString, ContactPresenceListCurrent> PresenceStringMap;

class TDEIMPROXY_EXPORT KIMProxy : public TQObject, virtual public KIMProxyIface
{
    TQ_OBJECT
    struct Private;
 
    template<class> friend class KStaticDeleter;
    ~KIMProxy();
 
    public:
        static KIMProxy * instance( DCOPClient * client );

        bool initialize();

        TQStringList allContacts();

        TQStringList reachableContacts();

        TQStringList onlineContacts();

        TQStringList fileTransferContacts();

        bool isPresent( const TQString& uid );

        TQString displayName( const TQString& uid );

        int presenceNumeric( const TQString& uid );

        TQString presenceString( const TQString& uid );

        TQPixmap presenceIcon( const TQString& uid );

        bool canReceiveFiles( const TQString & uid );

        bool canRespond( const TQString & uid );

        TQString locate( const TQString & contactId, const TQString & protocol );

        TQString context( const TQString & uid );

        void chatWithContact( const TQString& uid );

        void messageContact( const TQString& uid, const TQString& message );

        void sendFile(const TQString &uid, const KURL &sourceURL,
             const TQString &altFileName = TQString::null, uint fileSize = 0);

        bool addContact( const TQString &contactId, const TQString &protocol );

        bool imAppsAvailable();

        bool startPreferredApp();

        void contactPresenceChanged( TQString uid, TQCString appId, int presence );
 
    public slots:
        void registeredToDCOP( const TQCString& appId );

        void unregisteredFromDCOP( const TQCString& appId );
    signals:
        void sigContactPresenceChanged( const TQString &uid );

        void sigPresenceInfoExpired();
    protected:
        void pollApp( const TQCString & appId );
        void pollAll( const TQString &uid );

        bool updatePresence( const TQString &uid, const TQCString &appId, int presence );

        TQString preferredApp();

        KIMIface_stub * stubForUid( const TQString &uid );

        KIMIface_stub * stubForProtocol( const TQString &protocol );
 
    private:
        // client stubs used to get presence
        // appId (from DCOP) -> KIMIface_stub
        TQDict<KIMIface_stub> m_im_client_stubs;
        // map containing numeric presence and the originating application ID for each KABC uid we know of
        // KABC Uid -> (appId, numeric presence )(AppPresence)
        PresenceMap m_presence_map;
        // cache of the client strings in use by each application
        // dictionary of KIMIface_stub -> map of numeric presence -> string presence
        // FIXME: remove for KDE4 - UNUSED but maintained for binary compatibility in KDE 3.4
        TQPtrDict<int> m_client_presence_strings;
        Private * d;
        bool m_apps_available;
        bool m_initialized;
        KIMProxy( DCOPClient * client);
        static KIMProxy * s_instance;
};
 
#endif