managerimpl.cpp

/*
 *  Copyright (C) 2004-2007 Savoir-Faire Linux inc.
 *  Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
 *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
 *  Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
 *  Author: Alexandre Savard <alexandre.savard@savoirfairelinux.com>
 *  Author: Guillaume Carmel-Archambault <guillaume.carmel-archambault@savoirfairelinux.com>
 *
 *  This program 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include "managerimpl.h"

#include "account.h"
#include "dbus/callmanager.h"
#include "user_cfg.h"
#include "global.h"
#include "sip/sipaccount.h"

#include "audio/audiolayer.h"
#include "audio/alsa/alsalayer.h"
#include "audio/pulseaudio/pulselayer.h"
#include "audio/sound/tonelist.h"
#include "history/historymanager.h"
#include "accountcreator.h" // create new account
#include "sip/sipvoiplink.h"
#include "manager.h"
#include "dbus/configurationmanager.h"

#include "conference.h"

#include <errno.h>
#include <time.h>
#include <cstdlib>
#include <iostream>
#include <fstream>
#include <sstream>
#include <sys/types.h> // mkdir(2)
#include <sys/stat.h>  // mkdir(2)
#include <pwd.h>       // getpwuid
#define DIRECT_IP_CALL	"IP CALL"

#define fill_config_str(name, value) \
  (_config.addConfigTreeItem(section, Conf::ConfigTreeItem(std::string(name), std::string(value), type_str)))
#define fill_config_int(name, value) \
  (_config.addConfigTreeItem(section, Conf::ConfigTreeItem(std::string(name), std::string(value), type_int)))

#define MD5_APPEND(pms,buf,len) pj_md5_update(pms, (const pj_uint8_t*)buf, len)

ManagerImpl::ManagerImpl (void) :
	_hasTriedToRegister(false), _config(), _currentCallId2(),
			_currentCallMutex(), _codecBuilder(NULL), _audiodriver(NULL),
			_dtmfKey(NULL), _codecDescriptorMap(), _toneMutex(),
			_telephoneTone(NULL), _audiofile(), _spkr_volume(0),
			_mic_volume(0), _mutex(), _dbus(NULL), _waitingCall(),
			_waitingCallMutex(), _nbIncomingWaitingCall(0), _path(""),
			_exist(0), _setupLoaded(false), _callAccountMap(),
			_callAccountMapMutex(), _callConfigMap(), _accountMap(),
			_directIpAccount(NULL), _cleaner(NULL), _history(NULL) {

	// initialize random generator for call id
	srand(time(NULL));

	_cleaner = new NumberCleaner();
	_history = new HistoryManager();

#ifdef TEST
	testAccountMap();
	loadAccountMap();
	testCallAccountMap();
	unloadAccountMap();
#endif

	// should be call before initConfigFile
	// loadAccountMap();, called in init() now.
}

// never call if we use only the singleton...
ManagerImpl::~ManagerImpl (void) {
	// terminate();
	delete _cleaner; _cleaner = NULL;
	delete _history; _history = NULL;

	_debug ("Manager: %s stop correctly.", PROGNAME);
}

void ManagerImpl::init () {

	// Load accounts, init map
	loadAccountMap();

	initVolume();

	if (_exist == 0) {
		_warn ("Manager: Cannot create config file in your home directory");
	}

	initAudioDriver();

	selectAudioDriver();

	// Initialize the list of supported audio codecs
	initAudioCodec();

	AudioLayer *audiolayer = getAudioDriver();

	if (audiolayer != 0) {
		unsigned int sampleRate = audiolayer->getSampleRate();

		_debugInit ("Manager: Load telephone tone");
		std::string country = getConfigString(PREFERENCES, ZONE_TONE);
		_telephoneTone = new TelephoneTone(country, sampleRate);

		_debugInit ("Manager: Loading DTMF key");
		_dtmfKey = new DTMF(sampleRate);
	}

	if (audiolayer == 0)
		audiolayer->stopStream();

	// Load the history
	_history->load_history(getConfigInt(PREFERENCES, CONFIG_HISTORY_LIMIT));
}

void ManagerImpl::terminate () {

	_debug ("Manager: Terminate ");
	saveConfig();

	unloadAccountMap();

	_debug ("Manager: Unload DTMF key");
	delete _dtmfKey;

	_debug("Manager: Unload telephone tone");
	delete _telephoneTone; _telephoneTone = NULL;

	_debug ("Manager: Unload audio driver");
	delete _audiodriver; _audiodriver = NULL;

	_debug ("Manager: Unload telephone tone");
	delete _telephoneTone; _telephoneTone = NULL;

	_debug ("Manager: Unload audio codecs ");
	_codecDescriptorMap.deleteHandlePointer();

}

bool ManagerImpl::isCurrentCall (const CallID& callId) {
	return (_currentCallId2 == callId ? true : false);
}

bool ManagerImpl::hasCurrentCall () {
	// _debug ("ManagerImpl::hasCurrentCall current call ID = %s", _currentCallId2.c_str());

	if (_currentCallId2 != "") {
		return true;
	}

	return false;
}

const CallID&
ManagerImpl::getCurrentCallId () {
	return _currentCallId2;
}

void ManagerImpl::switchCall (const CallID& id) {
	ost::MutexLock m(_currentCallMutex);
	_debug ("----- Switch current call id to %s -----", id.c_str());
	_currentCallId2 = id;
}

///////////////////////////////////////////////////////////////////////////////
// Management of events' IP-phone user
///////////////////////////////////////////////////////////////////////////////
/* Main Thread */

bool ManagerImpl::outgoingCall (const std::string& account_id,
		const CallID& call_id, const std::string& to) {

	std::string pattern, to_cleaned;
	Call::CallConfiguration callConfig;
	SIPVoIPLink *siplink;

	_debug ("Manager: New outgoing call %s to %s", call_id.c_str(), to.c_str());

	CallID current_call_id = getCurrentCallId();

	if (getConfigString(HOOKS, PHONE_NUMBER_HOOK_ENABLED) == "1")
		_cleaner->set_phone_number_prefix(getConfigString(HOOKS,
				PHONE_NUMBER_HOOK_ADD_PREFIX));
	else
		_cleaner->set_phone_number_prefix("");

	to_cleaned = _cleaner->clean(to);

	/* Check what kind of call we are dealing with */
	check_call_configuration(call_id, to_cleaned, &callConfig);

	// in any cases we have to detach from current communication
	if (hasCurrentCall()) {

		_debug ("Manager: Has current call (%s) put it onhold", current_call_id.c_str());
		// if this is not a conferenceand this and is not a conference participant
		if (!isConference(current_call_id) && !participToConference(current_call_id)) {
			onHoldCall(current_call_id);
		} else if (isConference(current_call_id) && !participToConference(call_id)) {
			detachParticipant(default_id, current_call_id);
		}
	}

	if (callConfig == Call::IPtoIP) {
		_debug ("Manager: Start IP2IP call");
		/* We need to retrieve the sip voiplink instance */
		siplink = SIPVoIPLink::instance("");

		if (siplink->new_ip_to_ip_call(call_id, to_cleaned)) {
			switchCall(call_id);
			return true;
		} else {
			callFailure(call_id);
		}

		return false;
	}

	_debug("Manager: Selecting account %s", account_id.c_str());
	if (!accountExists(account_id)) {
		_error ("Manager: Error: Account doesn't exist in new outgoing call");
		return false;
	}

	if (getAccountFromCall(call_id) != AccountNULL) {
		_error ("Manager: Error: Call id already exists in outgoing call");
		return false;
	}

	_debug ("Manager: Adding Outgoing Call %s on account %s", call_id.data(), account_id.data());
	associateCallToAccount(call_id, account_id);

	if (getAccountLink(account_id)->newOutgoingCall(call_id, to_cleaned)) {
	    switchCall(call_id);
	    return true;
	} else {
	    callFailure(call_id);
	    _debug ("Manager: Error: An error occur, the call was not created");
	}

	return false;
}

//THREAD=Main : for outgoing Call
bool ManagerImpl::answerCall (const CallID& call_id) {

	_debug ("ManagerImpl: Answer call %s", call_id.c_str());

	stopTone();

	// store the current call id
	CallID current_call_id = getCurrentCallId();

	AccountID account_id = getAccountFromCall(call_id);

	if (account_id == AccountNULL) {
		_debug ("    answerCall: AccountId is null");
	}

	Call* call = NULL;

	call = getAccountLink(account_id)->getCall(call_id);

	if (call == NULL) {
		_debug ("    answerCall: Call is null");
	}

	// in any cases we have to detach from current communication
	if (hasCurrentCall()) {

		_debug ("    answerCall: Currently conversing with %s", current_call_id.c_str());
		// if it is not a conference and is not a conference participant

		if (!isConference(current_call_id) && !participToConference(
				current_call_id)) {
			_debug ("    answerCall: Put the current call (%s) on hold", current_call_id.c_str());
			onHoldCall(current_call_id);
		}

		// if we are talking to a conference and we are answering an incoming call
		else if (isConference(current_call_id)
				&& !participToConference(call_id)) {
			_debug ("    answerCall: Detach main participant from conference");
			detachParticipant(default_id, current_call_id);
		}

	}

	if (!getAccountLink(account_id)->answer(call_id)) {
		// error when receiving...
		removeCallAccount(call_id);
		return false;
	}

	// if it was waiting, it's waiting no more
	if (_dbus)
		_dbus->getCallManager()->callStateChanged(call_id, "CURRENT");

	// std::string codecName = Manager::instance().getCurrentCodecName (call_id);
	// if (_dbus) _dbus->getCallManager()->currentSelectedCodec (call_id, codecName.c_str());

	removeWaitingCall(call_id);

	// if we dragged this call into a conference already
	if (participToConference(call_id)) {

		// AccountID currentAccountId;
		// Call* call = NULL;

		// currentAccountId = getAccountFromCall (call_id);
		// call = getAccountLink (currentAccountId)->getCall (call_id);

		switchCall(call->getConfId());
	} else {
		switchCall(call_id);
	}

	return true;
}

//THREAD=Main
bool ManagerImpl::hangupCall (const CallID& call_id) {

	_info("Manager: Hangup call %s", call_id.c_str());

	PulseLayer *pulselayer;
	AccountID account_id;
	bool returnValue = true;

	// store the current call id
	CallID current_call_id = getCurrentCallId();

	stopTone();

	/* Broadcast a signal over DBus */
	_debug ("Manager: Send DBUS call state change (HUNGUP) for id %s", call_id.c_str());

	if (_dbus)
		_dbus->getCallManager()->callStateChanged(call_id, "HUNGUP");

	if (participToConference(call_id)) {

		Conference *conf = getConferenceFromCallID(call_id);

		if (conf != NULL) {
			// remove this participant
			removeParticipant(call_id);

			processRemainingParticipant(current_call_id, conf);
		}

	} else {
		// we are not participating to a conference, current call switched to ""
		if (!isConference(current_call_id))
			switchCall("");
	}

	/* Direct IP to IP call */
	if (getConfigFromCall(call_id) == Call::IPtoIP) {
		returnValue = SIPVoIPLink::instance(AccountNULL)->hangup(call_id);
	}
	/* Classic call, attached to an account */
	else {
		account_id = getAccountFromCall(call_id);

		// Account may be NULL if call have not been sent yet
		if (account_id == AccountNULL) {
			_error ("Manager: Error: account id is NULL in hangup");
			returnValue = false;
		} else {
			returnValue = getAccountLink(account_id)->hangup(call_id);
			removeCallAccount(call_id);
		}
	}

	int nbCalls = getCallList().size();

	AudioLayer *audiolayer = getAudioDriver();

	// stop streams
	if (audiolayer && (nbCalls <= 0)) {
		_debug ("Manager: stop audio stream, ther is only %i call(s) remaining", nbCalls);
		audiolayer->stopStream();
	}

	if (_audiodriver->getLayerType() == PULSEAUDIO) {
		pulselayer = dynamic_cast<PulseLayer *> (getAudioDriver());
	}

	return returnValue;
}

bool ManagerImpl::hangupConference (const ConfID& id) {

	_debug ("Manager: Hangup conference %s", id.c_str());

	Conference *conf;
	ConferenceMap::iterator iter_conf = _conferencemap.find(id);

	AccountID currentAccountId;

	// Call* call = NULL;


	if (iter_conf != _conferencemap.end()) {
		conf = iter_conf->second;

		ParticipantSet participants = conf->getParticipantList();
		ParticipantSet::iterator iter_participant = participants.begin();

		while (iter_participant != participants.end()) {
			_debug ("Manager: Hangup onference participant %s", (*iter_participant).c_str());

			hangupCall(*iter_participant);

			iter_participant++;

		}

	}

	switchCall("");

	return true;
}

//THREAD=Main
bool ManagerImpl::cancelCall (const CallID& id) {
	AccountID accountid;
	bool returnValue;

	_debug("Manager: Cancel call");

	stopTone();

	/* Direct IP to IP call */

	if (getConfigFromCall(id) == Call::IPtoIP) {
		returnValue = SIPVoIPLink::instance(AccountNULL)->cancel(id);
	}

	/* Classic call, attached to an account */
	else {
		accountid = getAccountFromCall(id);

		if (accountid == AccountNULL) {
			_debug ("! Manager Cancel Call: Call doesn't exists");
			return false;
		}

		returnValue = getAccountLink(accountid)->cancel(id);

		removeCallAccount(id);
	}

	// it could be a waiting call?
	removeWaitingCall(id);

	switchCall("");

	return returnValue;
}

//THREAD=Main
bool ManagerImpl::onHoldCall (const CallID& call_id) {
	AccountID account_id;
	bool returnValue;

	_debug ("Manager: Put call %s on hold", call_id.c_str());

	stopTone();

	CallID current_call_id = getCurrentCallId();


	/* Direct IP to IP call */

	if (getConfigFromCall(call_id) == Call::IPtoIP) {
		returnValue = SIPVoIPLink::instance(AccountNULL)-> onhold(call_id);
	}

	/* Classic call, attached to an account */
	else {
		account_id = getAccountFromCall(call_id);

		if (account_id == AccountNULL) {
			_debug ("Manager: Account ID %s or callid %s doesn't exists in call onHold", account_id.c_str(), call_id.c_str());
			return false;
		}

		returnValue = getAccountLink(account_id)->onhold(call_id);
	}

	removeWaitingCall(call_id);

	// keeps current call id if the action is not holding this call or a new outgoing call

	if (current_call_id == call_id) {

		switchCall("");
	}

	if (_dbus)
		_dbus->getCallManager()->callStateChanged(call_id, "HOLD");

	return returnValue;
}

//THREAD=Main
bool ManagerImpl::offHoldCall (const CallID& call_id) {

	AccountID account_id;
	bool returnValue, is_rec;
	std::string codecName;

	is_rec = false;

	_debug ("Manager: Put call %s off hold", call_id.c_str());

	stopTone();

	CallID current_call_id = getCurrentCallId();

	//Place current call on hold if it isn't

	if (hasCurrentCall()) {
		// if this is not a conferenceand this and is not a conference participant
		if (!isConference(current_call_id) && !participToConference(
				current_call_id)) {
			onHoldCall(current_call_id);
		} else if (isConference(current_call_id) && !participToConference(
				call_id)) {
			detachParticipant(default_id, current_call_id);
		}
	}

	// switch current call id to id since sipvoip link need it to amke a call
	// switchCall(id);

	/* Direct IP to IP call */
	if (getConfigFromCall(call_id) == Call::IPtoIP) {
		// is_rec = SIPVoIPLink::instance (AccountNULL)-> isRecording (call_id);
		returnValue = SIPVoIPLink::instance(AccountNULL)-> offhold(call_id);
	}

	/* Classic call, attached to an account */
	else {
		account_id = getAccountFromCall(call_id);

		if (account_id == AccountNULL) {
			_warn ("Manager: Error: Call doesn't exists in off hold");
			return false;
		}

		_debug ("Manager: Setting offhold, Account %s, callid %s", account_id.c_str(), call_id.c_str());

		is_rec = getAccountLink(account_id)->getCall(call_id)->isRecording();
		returnValue = getAccountLink(account_id)->offhold(call_id);
	}

	if (_dbus) {
		if (is_rec)
			_dbus->getCallManager()->callStateChanged(call_id, "UNHOLD_RECORD");
		else
			_dbus->getCallManager()->callStateChanged(call_id, "UNHOLD_CURRENT");

	}

	if (participToConference(call_id)) {

		AccountID currentAccountId;
		Call* call = NULL;

		currentAccountId = getAccountFromCall(call_id);
		call = getAccountLink(currentAccountId)->getCall(call_id);

		switchCall(call->getConfId());

	} else {
		switchCall(call_id);
		_audiodriver->flushMain();
	}

	return returnValue;
}

//THREAD=Main
bool ManagerImpl::transferCall (const CallID& call_id, const std::string& to) {
	AccountID accountid;
	bool returnValue;

	_info("Manager: Transfer call %s\n", call_id.c_str());

	CallID current_call_id = getCurrentCallId();

	// Direct IP to IP call
	if (getConfigFromCall(call_id) == Call::IPtoIP) {
		returnValue = SIPVoIPLink::instance(AccountNULL)-> transfer(call_id, to);
	}
	// Classic call, attached to an account
	else {

	accountid = getAccountFromCall(call_id);

		if (accountid == AccountNULL) {
			_warn ("Manager: Call doesn't exists");
			return false;
		}

		returnValue = getAccountLink(accountid)->transfer(call_id, to);

	}

	// remove waiting call in case we make transfer without even answer
	removeWaitingCall(call_id);

	return returnValue;
}

void ManagerImpl::transferFailed () {

	_debug("UserAgent: Transfer failed");

	if (_dbus)
		_dbus->getCallManager()->transferFailed();
}

void ManagerImpl::transferSucceded () {

	_debug("UserAgent: Transfer succeded");

	if (_dbus)
		_dbus->getCallManager()->transferSucceded();

}

//THREAD=Main : Call:Incoming
bool ManagerImpl::refuseCall (const CallID& id) {
	AccountID accountid;
	bool returnValue;

	_debug("Manager: Refuse call %s", id.c_str());

	CallID current_call_id = getCurrentCallId();

	stopTone();

	int nbCalls = getCallList().size();

	// AudioLayer* audiolayer = getAudioDriver();

	if (nbCalls <= 1) {
		_debug ("    refuseCall: stop audio stream, there is only %i call(s) remaining", nbCalls);

		AudioLayer* audiolayer = getAudioDriver();
		audiolayer->stopStream();
	}

	/* Direct IP to IP call */

	if (getConfigFromCall(id) == Call::IPtoIP) {
		returnValue = SIPVoIPLink::instance(AccountNULL)-> refuse(id);
	}

	/* Classic call, attached to an account */
	else {
		accountid = getAccountFromCall(id);

		if (accountid == AccountNULL) {
			_warn ("Manager: Call doesn't exists");
			return false;
		}

		returnValue = getAccountLink(accountid)->refuse(id);

		removeCallAccount(id);
	}

	// if the call was outgoing or established, we didn't refuse it
	// so the method did nothing
	if (returnValue) {
		removeWaitingCall(id);

		if (_dbus)
			_dbus->getCallManager()->callStateChanged(id, "HUNGUP");
	}

	return returnValue;
}

Conference*
ManagerImpl::createConference (const CallID& id1, const CallID& id2) {
	_debug ("Manager: Create conference with call %s and %s", id1.c_str(), id2.c_str());

	Conference* conf = new Conference();

	conf->add(id1);
	conf->add(id2);

	// Add conference to map
	_conferencemap.insert( std::pair<CallID, Conference*>(conf->getConfID(), conf));

	// broadcast a signal over dbus
	_dbus->getCallManager()->conferenceCreated(conf->getConfID());

	return conf;
}

void ManagerImpl::removeConference (const ConfID& conference_id) {

	_debug ("Manager: Remove conference %s", conference_id.c_str());

	Conference* conf = NULL;

	_debug ("Manager: number of participant: %d", (int) _conferencemap.size());
	ConferenceMap::iterator iter = _conferencemap.find(conference_id);

	if (iter != _conferencemap.end()) {
		conf = iter->second;
	}

	if (conf == NULL) {
		_error ("Manager: Error: Conference not found");
		return;
	}

	// We now need to bind the audio to the remain participant

	// Unbind main participant audio from conference
	_audiodriver->getMainBuffer()->unBindAll(default_id);

	ParticipantSet participants = conf->getParticipantList();