disco.h

/*
  Copyright (c) 2004-2012 by Jakob Schroeter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox

  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.

  This software is distributed without any warranty.
*/



#ifndef DISCO_H__
#define DISCO_H__

#include "gloox.h"

#include "iqhandler.h"
#include "jid.h"

#include <string>
#include <list>
#include <map>

namespace gloox
{

  class ClientBase;
  class DataForm;
  class DiscoHandler;
  class DiscoNodeHandler;
  class IQ;

  class GLOOX_API Disco : public IqHandler
  {
    friend class ClientBase;

    public:

      class Identity; // declared below class Info

      typedef std::list<Identity*> IdentityList;

      class GLOOX_API Info : public StanzaExtension
      {
        friend class Disco;

        public:
          const std::string& node() const { return m_node; }

          const StringList& features() const { return m_features; }

          bool hasFeature( const std::string& feature ) const;

          const IdentityList& identities() const { return m_identities; }

          const DataForm* form() const { return m_form; }

          void setForm( DataForm* form );

          // reimplemented from StanzaExtension
          virtual const std::string& filterString() const;

          // reimplemented from StanzaExtension
          virtual StanzaExtension* newInstance( const Tag* tag ) const
          {
            return new Info( tag );
          }

          // reimplemented from StanzaExtension
          virtual StanzaExtension* clone() const
          {
            return new Info( *this );
          }

          // reimplemented from StanzaExtension
          virtual Tag* tag() const;

        private:
#ifdef DISCO_INFO_TEST
        public:
#endif

          Info( const std::string& node = EmptyString, bool defaultFeatures = false );

          Info( const Tag* tag );

          Info( const Info& info );

          virtual ~Info();

          void setNode( const std::string& node ) { m_node = node; }

          void setFeatures( const StringList& features )
          {
            StringList fl( features );
            fl.sort(); // needed on win32
            m_features.merge( fl );
          }

          void setIdentities( const IdentityList& identities ) { m_identities = identities; }

          std::string m_node;
          StringList m_features;
          IdentityList m_identities;
          DataForm* m_form;
      };

      class GLOOX_API Identity
      {
        friend class Info;
        friend class Disco;

        public:
          Identity( const std::string& category,
                    const std::string& type,
                    const std::string& name );

          Identity( const Identity& id );

          ~Identity();

          const std::string& category() const { return m_category; }

          const std::string& type() const { return m_type; }

          const std::string& name() const { return m_name; }

          Tag* tag() const;

        private:
          Identity( const Tag* tag );

          std::string m_category;   
          std::string m_type;       
          std::string m_name;       
      };

      class Item; // declared below class Items

      typedef std::list<Item*> ItemList;

      class GLOOX_API Items : public StanzaExtension
      {
        friend class Disco;

        public:
          // This needs to be public so one can proactively send a list of adhoc commands
          // see @xep{0050}
          Items( const std::string& node = EmptyString );

          virtual ~Items();

          void setItems( const ItemList& items );

          const std::string& node() const { return m_node; }

          const ItemList& items() const { return m_items; }

          // reimplemented from StanzaExtension
          virtual const std::string& filterString() const;

          // reimplemented from StanzaExtension
          virtual StanzaExtension* newInstance( const Tag* tag ) const
          {
            return new Items( tag );
          }

          // reimplemented from StanzaExtension
          virtual Tag* tag() const;

          // reimplemented from StanzaExtension
          virtual StanzaExtension* clone() const
          {
            return new Items( *this );
          }

        private:
#ifdef DISCO_ITEMS_TEST
        public:
#endif

          Items( const Tag* tag );

          std::string m_node;
          ItemList m_items;
      };

      class GLOOX_API Item
      {
        friend class Items;

        public:
          Item( const JID& jid,
                const std::string& node,
                const std::string& name )
          : m_jid( jid ), m_node( node ), m_name( name ) {}

          ~Item() {}

          const JID& jid() const { return m_jid; }

          const std::string& node() const { return m_node; }

          const std::string& name() const { return m_name; }

          Tag* tag() const;

        private:
          Item( const Tag* tag );

          JID m_jid;                
          std::string m_node;       
          std::string m_name;       
      };

      void addFeature( const std::string& feature )
        { m_features.push_back( feature ); }

      void removeFeature( const std::string& feature )
        { m_features.remove( feature ); }

      const StringList features( bool defaultFeatures = false ) const;

      void getDiscoInfo( const JID& to, const std::string& node, DiscoHandler* dh, int context,
                         const std::string& tid = EmptyString )
        { getDisco( to, node, dh, context, GetDiscoInfo, tid ); }

      void getDiscoItems( const JID& to, const std::string& node, DiscoHandler* dh, int context,
                          const std::string& tid = EmptyString )
        { getDisco( to, node, dh, context, GetDiscoItems, tid ); }

      void setVersion( const std::string& name, const std::string& version,
                       const std::string& os = EmptyString );

      const std::string& name() const { return m_versionName; }

      const std::string& version() const { return m_versionVersion; }

      const std::string& os() const { return m_versionOs; }

      void setIdentity( const std::string& category, const std::string& type,
                        const std::string& name = EmptyString );

      void addIdentity( const std::string& category, const std::string& type,
                        const std::string& name = EmptyString )
        { m_identities.push_back( new Identity( category, type, name ) ); }

      const IdentityList& identities() const { return m_identities; }

      void setForm( DataForm* form );

      const DataForm* form() const { return m_form; }

      void registerDiscoHandler( DiscoHandler* dh )
        { m_discoHandlers.push_back( dh ); }

      void removeDiscoHandler( DiscoHandler* dh );

      void registerNodeHandler( DiscoNodeHandler* nh, const std::string& node );

      void removeNodeHandler( DiscoNodeHandler* nh, const std::string& node );

      void removeNodeHandlers( DiscoNodeHandler* nh );

      // reimplemented from IqHandler.
      virtual bool handleIq( const IQ& iq );

      // reimplemented from IqHandler.
      virtual void handleIqID( const IQ& iq, int context );

    private:
#ifdef DISCO_TEST
    public:
#endif
      Disco( ClientBase* parent );
      virtual ~Disco();

      enum IdType
      {
        GetDiscoInfo,
        GetDiscoItems
      };

      void getDisco( const JID& to, const std::string& node, DiscoHandler* dh,
                     int context, IdType idType, const std::string& tid );

      struct DiscoHandlerContext
      {
        DiscoHandler* dh;
        int context;
      };

      ClientBase* m_parent;

      typedef std::list<DiscoHandler*> DiscoHandlerList;
      typedef std::list<DiscoNodeHandler*> DiscoNodeHandlerList;
      typedef std::map<std::string, DiscoNodeHandlerList> DiscoNodeHandlerMap;
      typedef std::map<std::string, DiscoHandlerContext> DiscoHandlerMap;

      DiscoHandlerList m_discoHandlers;
      DiscoNodeHandlerMap m_nodeHandlers;
      DiscoHandlerMap m_track;
      IdentityList m_identities;
      StringList m_features;
      StringMap m_queryIDs;
      DataForm* m_form;

      std::string m_versionName;
      std::string m_versionVersion;
      std::string m_versionOs;

  };

}

#endif // DISCO_H__