registration.h

/*
  Copyright (c) 2005-2023 by Jakob Schröter <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 REGISTRATION_H__
#define REGISTRATION_H__
 
#include "iqhandler.h"
#include "registrationhandler.h"
#include "dataform.h"
#include "jid.h"
#include "oob.h"
 
#include <string>
#include <map>
 
namespace gloox
{
 
  class ClientBase;
  class Stanza;
 
  struct RegistrationFields
  {
    std::string username;           
    std::string nick;               
    std::string password;           
    std::string name;               
    std::string first;              
    std::string last;               
    std::string email;              
    std::string address;            
    std::string city;               
    std::string state;              
    std::string zip;                
    std::string phone;              
    std::string url;                
    std::string date;               
    std::string misc;               
    std::string text;               
  };
 
  class GLOOX_API Registration : public IqHandler
  {
    public:
 
      enum fieldEnum
      {
        FieldUsername  =     1,     
        FieldNick      =     2,     
        FieldPassword  =     4,     
        FieldName      =     8,     
        FieldFirst     =    16,     
        FieldLast      =    32,     
        FieldEmail     =    64,     
        FieldAddress   =   128,     
        FieldCity      =   256,     
        FieldState     =   512,     
        FieldZip       =  1024,     
        FieldPhone     =  2048,     
        FieldUrl       =  4096,     
        FieldDate      =  8192,     
        FieldMisc      = 16384,     
        FieldText      = 32768      
      };
 
      class Query : public StanzaExtension
      {
        public:
          Query( DataForm* form );
 
          Query( bool del = false );
 
          Query( int fields, const RegistrationFields& values );
 
          Query( const Tag* tag );
 
          virtual ~Query();
 
          const DataForm* form() const { return m_form; }
 
          const std::string& instructions() const { return m_instructions; }
 
          int fields() const { return m_fields; }
 
          const RegistrationFields& values() const { return m_values; }
 
          bool registered() const { return m_reg; }
 
          bool remove() const { return m_del; }
 
          const OOB* oob() const { return m_oob; }
 
          // reimplemented from StanzaExtension
          virtual const std::string& filterString() const;
 
          // reimplemented from StanzaExtension
          virtual StanzaExtension* newInstance( const Tag* tag ) const
          {
            return new Query( tag );
          }
 
          // reimplemented from StanzaExtension
          virtual Tag* tag() const;
 
          // reimplemented from StanzaExtension
          virtual StanzaExtension* clone() const
          {
            Query* q = new Query();
            q->m_form = m_form ? new DataForm( *m_form ) : 0;
            q->m_fields = m_fields;
            q->m_values = m_values;
            q->m_instructions = m_instructions;
            q->m_oob = new OOB( *m_oob );
            q->m_del = m_del;
            q->m_reg = m_reg;
            return q;
          }
 
        private:
          DataForm* m_form;
          int m_fields;
          RegistrationFields m_values;
          std::string m_instructions;
          OOB* m_oob;
          bool m_del;
          bool m_reg;
      };
 
      Registration( ClientBase* parent, const JID& to );
 
      Registration( ClientBase* parent );
 
      virtual ~Registration();
 
      void fetchRegistrationFields();
 
      bool createAccount( int fields, const RegistrationFields& values );
 
      void createAccount( DataForm* form );
 
      void removeAccount();
 
      void changePassword( const std::string& username, const std::string& password );
 
      void registerRegistrationHandler( RegistrationHandler* rh );
 
      void removeRegistrationHandler();
 
      // reimplemented from IqHandler.
      virtual bool handleIq( const IQ& iq ) { (void)iq; return false; }
 
      // reimplemented from IqHandler.
      virtual void handleIqID( const IQ& iq, int context );
 
    private:
#ifdef REGISTRATION_TEST
    public:
#endif
 
      enum IdType
      {
        FetchRegistrationFields,
        CreateAccount,
        RemoveAccount,
        ChangePassword
      };
 
      Registration operator=( const Registration& );
 
      void init();
 
      ClientBase* m_parent;
      const JID m_to;
      RegistrationHandler* m_registrationHandler;
  };
 
}
 
#endif // REGISTRATION_H__