yate/modules/pbx.cpp

/**
 * pbx.cpp
 * This file is part of the YATE Project http://YATE.null.ro
 *
 * Basic PBX message handlers
 *
 * Yet Another Telephony Engine - a fully featured software PBX and IVR
 * Copyright (C) 2004-2014 Null Team
 *
 * This software is distributed under multiple licenses;
 * see the COPYING file in the main directory for licensing
 * information for this specific distribution.
 *
 * This use of this software may be subject to additional restrictions.
 * See the LEGAL file in the main directory for details.
 *
 * 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.
 */

#include <yatephone.h>

using namespace TelEngine;
namespace { // anonymous

class PbxModule : public Module
{
public:
    PbxModule();
    virtual ~PbxModule();
    virtual void initialize();
    bool m_first;
};


static PbxModule s_module;
static const String s_masquerade("chan.masquerade");


// chan.connect handler used to connect two channels
class ConnHandler : public MessageHandler
{
public:
    ConnHandler(int prio = 90)
	: MessageHandler("chan.connect",prio,s_module.name())
	{ }
    virtual bool received(Message &msg);
};

// call.execute handler used to 'steal' a channel
class ChanPickup : public MessageHandler
{
public:
    ChanPickup(int prio = 100)
	: MessageHandler("call.execute",prio,s_module.name())
	{ }
    virtual bool received(Message &msg);
};

// chan.attach handler used for detaching data nodes by message
class AttachHandler : public MessageHandler
{
public:
    AttachHandler(int prio = 100)
	: MessageHandler("chan.attach",prio,s_module.name())
	{ }
    virtual bool received(Message &msg);
};

// chan.record handler used for detaching data nodes by message
class RecordHandler : public MessageHandler
{
public:
    RecordHandler(int prio = 100)
	: MessageHandler("chan.record",prio,s_module.name())
	{ }
    virtual bool received(Message &msg);
};


// Utility function to get a pointer to a call endpoint (or its peer) by id
static CallEndpoint* locateChan(const String& id, bool peer = false)
{
    if (id.null())
	return 0;
    Message m("chan.locate");
    m.addParam("id",id);
    if (!Engine::dispatch(m))
	return 0;
    CallEndpoint* ce = static_cast<CallEndpoint*>(m.userObject(YATOM("CallEndpoint")));
    if (!ce)
	return 0;
    return peer ? ce->getPeer() : ce;
}


bool ConnHandler::received(Message &msg)
{
    const char* id = msg.getValue("id");
    bool idPeer = msg.getBoolValue("id_peer");
    RefPointer<CallEndpoint> c1;
    if (id) {
	CallEndpoint* c = YOBJECT(CallEndpoint,msg.userData());
	if (c && (c->id() == id))
	    c1 = idPeer ? c->getPeer() : c;
    }
    if (!c1)
	c1 = locateChan(id,idPeer);
    RefPointer<CallEndpoint> c2(locateChan(msg.getValue("targetid"),msg.getBoolValue("targetid_peer")));
    if (!(c1 && c2))
	return false;
    return c1->connect(c2,msg.getValue("reason"));
}


// call.execute handler used to 'steal' a channel
bool ChanPickup::received(Message& msg)
{
    String callto = msg.getValue("callto");
    if (!(callto.startSkip("pickup/",false) && callto))
	return false;

    // It's ours. Get the channels
    RefPointer<CallEndpoint> caller(YOBJECT(CallEndpoint,msg.userData()));
    RefPointer<CallEndpoint> called(locateChan(callto,msg.getBoolValue("pickup_peer",true)));

    if (!caller) {
	Debug(&s_module,DebugNote,"No channel to pick up: callto='%s'",
	    msg.getValue("callto"));
	msg.setParam("error","failure");
	return false;
    }
    if (!called) {
	Debug(&s_module,DebugInfo,
	    "Can't locate the peer for channel '%s' to pick up",callto.c_str());
	msg.setParam("error","nocall");
	return false;
    }

    // Connect parties and answer them
    const char* reason = msg.getValue("reason","pickup");
    Debug(&s_module,DebugAll,"Channel '%s' picking up '%s' abandoning '%s', reason: '%s'",
	caller->id().c_str(),called->id().c_str(),called->getPeerId().c_str(),reason);
    if (!called->connect(caller,reason)) {
	Debug(&s_module,DebugNote,"Pick up failed to connect '%s' to '%s'",
	    caller->id().c_str(),called->id().c_str());
	return false;
    }
    msg.setParam("peerid",called->id());
    msg.setParam("targetid",called->id());

    Message* m = new Message(s_masquerade);
    m->addParam("id",called->id());
    m->addParam("message","call.answered");
    m->addParam("peerid",called->getPeerId());
    m->addParam("reason",reason);
    if (Engine::dispatch(m) || (s_masquerade != *m))
	TelEngine::destruct(m);
    else {
	*m = "call.answered";
	m->clearParam("message");
	Engine::enqueue(m);
    }
    if (caller->getPeer() != called) {
	Debug(&s_module,DebugMild,"Channel '%s' disconnected from '%s' while picking up",
	    caller->id().c_str(),called->id().c_str());
	return true;
    }
    m = new Message(s_masquerade);
    m->addParam("id",caller->id());
    m->addParam("message","call.answered");
    m->addParam("peerid",called->getPeerId());
    m->addParam("reason",reason);
    Engine::enqueue(m);
    return true;
}


// chan.attach handler for detaching data nodes by message
bool AttachHandler::received(Message &msg)
{
    bool src = msg[YSTRING("source")] == "-";
    bool cons = msg[YSTRING("consumer")] == "-";
    bool ovr = msg[YSTRING("override")] == "-";
    bool repl = msg[YSTRING("replace")] == "-";
    if (!(src || cons || ovr || repl))
	return false;

    RefPointer<DataEndpoint> de = static_cast<DataEndpoint*>(msg.userObject(YATOM("DataEndpoint")));
    if (!de) {
	CallEndpoint* ch = static_cast<CallEndpoint*>(msg.userObject(YATOM("CallEndpoint")));
	if (ch) {
	    DataEndpoint::commonMutex().lock();
	    de = ch->getEndpoint(msg.getValue(YSTRING("media"),"audio"));
	    DataEndpoint::commonMutex().unlock();
	}
	if (!de)
	    return false;
    }

    if (src)
	de->setSource();

    if (cons)
	de->setConsumer();

    if (ovr || repl) {
	RefPointer<DataSource> sPeer = 0;
	DataEndpoint::commonMutex().lock();
	RefPointer<DataConsumer> c = de->getConsumer();
	if (repl && de->getPeer())
	    sPeer = de->getPeer()->getSource();
	RefPointer<DataEndpoint> de2 = repl ? de->getPeer() : 0;
	DataEndpoint::commonMutex().unlock();
	if (c) {
	    if (repl) {
		RefPointer<DataSource> s = c->getConnSource();
		if (s)
		    s->detach(c);
		// we need to reattach the peer's source, if any
		if (sPeer)
		    DataTranslator::attachChain(sPeer,c);
	    }
	    if (ovr) {
		RefPointer<DataSource> s = c->getOverSource();
		if (s)
		    s->detach(c);
	    }
	}
    }

    de = 0;

    // Stop dispatching if we handled all requested
    return msg.getBoolValue(YSTRING("single"));
}


// chan.record handler for detaching data nodes by message
bool RecordHandler::received(Message &msg)
{
    bool call = msg[YSTRING("call")] == "-";
    bool peer = msg[YSTRING("peer")] == "-";
    if (!(call || peer))
	return false;

    RefPointer<DataEndpoint> de = static_cast<DataEndpoint*>(msg.userObject(YATOM("DataEndpoint")));
    if (!de) {
	CallEndpoint* ch = static_cast<CallEndpoint*>(msg.userObject(YATOM("CallEndpoint")));
	if (ch) {
	    DataEndpoint::commonMutex().lock();
	    de = ch->getEndpoint(msg.getValue(YSTRING("media"),"audio"));
	    DataEndpoint::commonMutex().unlock();
	}
	if (!de)
	    return false;
    }

    if (call)
	de->setCallRecord();

    if (peer)
	de->setPeerRecord();

    de = 0;

    // Stop dispatching if we handled all requested
    return msg.getBoolValue(YSTRING("single"),call && peer);
}


PbxModule::PbxModule()
    : Module("pbx","misc"), m_first(true)
{
    Output("Loaded module PBX");
}

PbxModule::~PbxModule()
{
    Output("Unloading module PBX");
}

void PbxModule::initialize()
{
    Output("Initializing module PBX");
    if (m_first) {
	setup();
	m_first = false;
	Engine::install(new ConnHandler);
	Engine::install(new ChanPickup);
	Engine::install(new AttachHandler);
	Engine::install(new RecordHandler);
    }
}

}; // anonymous namespace

/* vi: set ts=8 sw=4 sts=4 noet: */