stanza.h

/*
  Copyright (c) 2005-2008 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 STANZA_H__
#define STANZA_H__

#include "gloox.h"
#include "tag.h"
#include "jid.h"

namespace gloox
{

  class StanzaExtension;

  typedef std::list<StanzaExtension*> StanzaExtensionList;

  class GLOOX_API Stanza : public Tag
  {
    public:
      Stanza( const Tag *tag );

      Stanza( const std::string& name, const std::string& cdata = "",
              const std::string& xmllang = "default", bool incoming = false );

      virtual ~Stanza();

      virtual StanzaSubType subtype() const { return m_subtype; }

      virtual const JID& from() const { return m_from; }

      virtual const JID& to() const { return m_to; }

      virtual const std::string& id() const { return m_id; }

      virtual const std::string& xmlns() const { return m_xmlns; }

      virtual Presence presence() const { return m_presence; }

      virtual int priority() const { return m_priority; }

      virtual const std::string status( const std::string& lang = "default" ) const
        { return findLang( m_status, lang ); }

      virtual const std::string body( const std::string& lang = "default" ) const
        { return findLang( m_body, lang ); }

      virtual const std::string subject( const std::string& lang = "default" ) const
        { return findLang( m_subject, lang ); }

      virtual const std::string errorText( const std::string& lang = "default" ) const
        { return findLang( m_errorText, lang ); }

      virtual StanzaError error() const { return m_stanzaError; }

      Tag* errorAppCondition() { return m_stanzaErrorAppCondition; }

      virtual const std::string& thread() const { return m_thread; }

      void setThread( const std::string& thread ) { m_thread = thread; }

      const std::string& xmlLang() const { return m_xmllang; }

      void finalize() { init(); }

      void addExtension( StanzaExtension *se );

      const StanzaExtensionList& extensions() const { return m_extensionList; }

      static Stanza* createIqStanza( const JID& to, const std::string& id,
                                     StanzaSubType subtype = StanzaIqGet,
                                     const std::string& xmlns = "", Tag* tag = 0 );

      static Stanza* createPresenceStanza( const JID& to, const std::string& msg = "",
                                           Presence status = PresenceAvailable,
                                           const std::string& xmllang = "" );

      static Stanza* createMessageStanza( const JID& to, const std::string& body,
                                          StanzaSubType subtype = StanzaMessageChat,
                                          const std::string& subject = "", const std::string& thread = "",
                                          const std::string& xmllang = "" );

      static Stanza* createSubscriptionStanza( const JID& to, const std::string& msg = "",
                                               StanzaSubType subtype = StanzaS10nSubscribe,
                                               const std::string& xmllang = "" );

    protected:
      void init();

      StanzaExtensionList m_extensionList;
      StanzaSubType m_subtype;
      Presence m_presence;
      StanzaError m_stanzaError;
      StanzaErrorType m_stanzaErrorType;
      Tag *m_stanzaErrorAppCondition;
      StringMap m_errorText;
      StringMap m_body;
      StringMap m_subject;
      StringMap m_status;
      JID m_from;
      JID m_to;
      std::string m_xmlns;
      std::string m_id;
      std::string m_thread;
      std::string m_xmllang;
      int m_priority;

      static const std::string findLang( const StringMap& map, const std::string& lang );
      static void setLang( StringMap& map, const Tag *tag );
  };

}

#endif // STANZA_H__