Listener.cpp

/*
 * libfritz++
 *
 * Copyright (C) 2007-2012 Joachim Wilke <libfritz@joachim-wilke.de>
 *
 * 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 2
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */

#include "Listener.h"

#include <cstdlib>
#include <sstream>
#include <future>
#include <chrono>

#include "CallList.h"
#include "Config.h"
#include "FonbookManager.h"
#include "Tools.h"
#include <libnet++/TcpClient.h>
#include <liblog++/Log.h>

namespace fritz{

Listener *Listener::me = nullptr;

Listener::Listener(EventHandler *event)
{
	this->event = event;
	thread = new std::thread(&Listener::run, this);
}

Listener::~Listener()
{
	if (thread) {
		cancelThread();
		thread->join();
		delete thread;
	}
}

void Listener::cancelThread() {
	cancelRequested = true;
	if (tcpClientPtr)
		tcpClientPtr->expireStreamNow();
}

void Listener::CreateListener(EventHandler *event) {
	EventHandler *oldEvent = me ? me->event : nullptr;
	DeleteListener();
	if (event || oldEvent)
		me = new Listener(event ? event : oldEvent);
	else
		ERR("Invalid call parameter. First call to CreateListener needs event handler object.");
}

void Listener::DeleteListener() {
	if (me) {
		DBG("deleting listener");
		delete me;
		me = nullptr;
	}
}

void Listener::handleNewCall(bool outgoing, int connId, std::string remoteNumber, std::string localParty, std::string medium) {
	if ( Tools::MatchesMsnFilter(localParty) ) {
		// do reverse lookup
		Fonbook::sResolveResult result = FonbookManager::GetFonbook()->resolveToName(remoteNumber);
		// resolve SIP names
		std::string mediumName;
		if (medium.find("SIP")           != std::string::npos &&
				gConfig->getSipNames().size() > (size_t)atoi(&medium[3]))
			mediumName = gConfig->getSipNames()[atoi(&medium[3])];
		else
			mediumName = medium;
		// notify application
		if (event) event->handleCall(outgoing, connId, remoteNumber, result.name, result.type, localParty, medium, mediumName);
		activeConnections.push_back(connId);
	}
}

void Listener::handleConnect(int connId) {
	// only notify application if this connection is part of activeConnections
	bool notify = false;
	for (std::vector<int>::iterator it = activeConnections.begin(); it < activeConnections.end(); ++it) {
		if (*it == connId) {
			notify = true;
			break;
		}
	}
	if (notify)
		if (event) event->handleConnect(connId);
}

void Listener::handleDisconnect(int connId, std::string duration) {
	// only notify application if this connection is part of activeConnections
	bool notify = false;
	for (std::vector<int>::iterator it = activeConnections.begin(); it < activeConnections.end(); ++it) {
		if (*it == connId) {
			activeConnections.erase(it);
			notify = true;
			break;
		}
	}
	if (notify) {
		if (event) event->handleDisconnect(connId, duration);
		// force reload of callList
		CallList *callList = CallList::GetCallList(false);
		if (callList)
			callList->reload();
	}
}

void Listener::run() {
	DBG("Listener thread started");
	unsigned int retry_delay = RETRY_DELAY / 2;
	while (!cancelRequested) {
		try {
			retry_delay = retry_delay > 1800 ? 3600 : retry_delay * 2;
			network::TcpClient tcpClient(gConfig->getUrl(), gConfig->getListenerPort());
			tcpClientPtr = &tcpClient;
			while (!cancelRequested) {
				DBG("Waiting for a message.");

				std::string line = tcpClient.readLine();
				if (cancelRequested)
					break;

				if (gConfig->logPersonalInfo())
					DBG("Got message " << line);

				// split line into tokens
				std::string date  = Tools::Tokenize(line, ';', 0);
				std::string type  = Tools::Tokenize(line, ';', 1);
				int connId        = atoi(Tools::Tokenize(line, ';', 2).c_str());
				std::string partA = Tools::Tokenize(line, ';', 3);
				std::string partB = Tools::Tokenize(line, ';', 4);
				std::string partC = Tools::Tokenize(line, ';', 5);
				std::string partD = Tools::Tokenize(line, ';', 6);

#if 0 // some strings sent from the FB, made available to xgettext
					I18N_NOOP("POTS");
					I18N_NOOP("ISDN");
#endif

				if (type.compare("CALL") == 0) {
					// partA => box port
					// partB => caller Id (local)
					// partC => called Id (remote)
					// partD => medium (POTS, SIP[1-9], ISDN, ...)
					DBG("CALL " << ", " << partA
							    << ", " << (gConfig->logPersonalInfo() ? partB : HIDDEN)
		                        << ", " << (gConfig->logPersonalInfo() ? partC : HIDDEN)
		                        << ", " << partD);

					// an '#' can be appended to outgoing calls by the phone, so delete it
					if (partC[partC.length()-1] == '#')
						partC = partC.substr(0, partC.length()-1);

					handleNewCall(true, connId, partC, partB, partD);

				} else if (type.compare("RING") == 0) {
					// partA => caller Id (remote)
					// partB => called Id (local)
					// partC => medium (POTS, SIP[1-9], ISDN, ...)
					DBG("RING " << ", " << (gConfig->logPersonalInfo() ? partA : HIDDEN)
							    << ", " << (gConfig->logPersonalInfo() ? partB : HIDDEN)
		                        << ", " << partC);

					handleNewCall(false, connId, partA, partB, partC);

				} else if (type.compare("CONNECT") == 0) {
					// partA => box port
					// partB => local/remote Id
					DBG("CONNECT " << ", " << partA
							       << ", " << (gConfig->logPersonalInfo() ? partB : HIDDEN));

					handleConnect(connId);

				} else if (type.compare("DISCONNECT") == 0) {
					// partA => call duration
					DBG("DISCONNECT " << ", " << partA );

					handleDisconnect(connId, partA);

				} else {
					DBG("Got unknown message " << line);
					throw this;
				}
				retry_delay = RETRY_DELAY;
			}
		} catch(std::runtime_error &re) {
			ERR("Exception - " << re.what());
			// TODO: Detect reason for exception
			//if (se.getSocketError() == ost::Socket::errConnectRefused)
			ERR("Make sure to enable the Fritz!Box call monitor by dialing #96*5* once.");
		} catch (Listener *listener) {
			ERR("Exception unknown data received.");
		}
		tcpClientPtr = nullptr;
		if (cancelRequested)
			break;
		ERR("waiting " << retry_delay << " seconds before retrying");
		unsigned int retry_delay_counter = retry_delay;
		while (--retry_delay_counter && !cancelRequested) // delay the retry
			std::this_thread::sleep_for(std::chrono::seconds(1));
	}
	DBG("Listener thread ended");
}

}