* Copyright (C) 2006 iptego GmbH
 * Copyright (C) 2011 Stefan Sayer
 * This file is part of SEMS, a free SIP media server.
 * SEMS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. This program is released under
 * the GPL with the additional exemption that compiling, linking,
 * and/or using OpenSSL is allowed.
 * For a license to use the SEMS software under conditions
 * other than those described here, or to purchase support for this
 * software, please contact iptel.org by e-mail at the following addresses:
 *    info@iptel.org
 * SEMS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef _AmSipRegistration_h_
#define _AmSipRegistration_h_
#include <string>
using std::string;

#include "ampi/SIPRegistrarClientAPI.h"
#include "ampi/UACAuthAPI.h"
#include "AmUriParser.h"
#include "AmSessionEventHandler.h"


struct SIPRegistrationInfo {
  string domain;
  string user;
  string name;
  string auth_user;
  string pwd;
  string proxy;
  string contact;

  SIPRegistrationInfo(const string& domain,
		      const string& user,
		      const string& name,
		      const string& auth_user,
		      const string& pwd,
		      const string& proxy,
		      const string& contact)
    : domain(domain),user(user),name(name),
  { }

class AmSIPRegistration 
: public AmBasicSipEventHandler,
  public DialogControl,
  public CredentialHolder
  AmBasicSipDialog dlg;
  UACAuthCred cred;

  SIPRegistrationInfo info;

  // session to post events to 
  string sess_link;      

  AmSessionEventHandler* seh;

  AmSipRequest req;

  AmUriParser server_contact;
  AmUriParser local_contact;

  time_t reg_begin;	
  unsigned int reg_expires;
  time_t reg_send_begin; 

  unsigned int expires_interval;

  AmSIPRegistration(const string& handle,
		    const SIPRegistrationInfo& info,
		    const string& sess_link);

  void setRegistrationInfo(const SIPRegistrationInfo& _info);

  void setSessionEventHandler(AmSessionEventHandler* new_seh);

  void setExpiresInterval(unsigned int desired_expires);

  bool doRegistration();
  bool doUnregister();
  bool timeToReregister(time_t now_sec);
  bool registerExpired(time_t now_sec);
  void onRegisterExpired();
  void onRegisterSendTimeout();

  bool registerSendTimeout(time_t now_sec);

  void onSendRequest(AmSipRequest& req, int& flags);
  void onSendReply(const AmSipRequest& req, AmSipReply& reply, int& flags);

  // DialogControl if
  AmBasicSipDialog* getDlg() { return &dlg; }
  // CredentialHolder	
  UACAuthCred* getCredentials() { return &cred; }

  void onSipReply(const AmSipRequest& req,
		  const AmSipReply& reply, 
		  AmBasicSipDialog::Status old_dlg_status);

  /** is this registration registered? */
  bool active; 
  /** should this registration be removed from container? */
  bool remove;
  /** are we waiting for the response to a register? */
  bool waiting_result;
  /** are we unregistering? */
  bool unregistering;

  enum RegistrationState {
    RegisterPending = 0,
  /** return the state of the registration */
  RegistrationState getState(); 
  /** return the expires left for the registration */
  unsigned int getExpiresLeft();
  /** return the expires TS for the registration */
  time_t getExpiresTS();

  bool getUnregistering();

  SIPRegistrationInfo& getInfo() { return info; }
  const string& getEventSink() { return sess_link; }
  const string& getHandle() { return req.from_tag; }