org.restcomm.connect.telephony.proxy.ProxyManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restcomm-connect.telephony Show documentation
There is a newer version: 8.4.0-227
Show newest version
/*
 * TeleStax, Open Source Cloud Communications
 * Copyright 2011-2014, Telestax Inc and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 *
 */
package org.restcomm.connect.telephony.proxy;

import static javax.servlet.sip.SipServlet.OUTBOUND_INTERFACES;
import static javax.servlet.sip.SipServletResponse.SC_OK;
import static javax.servlet.sip.SipServletResponse.SC_PROXY_AUTHENTICATION_REQUIRED;
import static javax.servlet.sip.SipServletResponse.SC_UNAUTHORIZED;

import java.util.List;
import java.util.concurrent.TimeUnit;

import javax.servlet.ServletContext;
import javax.servlet.sip.Address;
import javax.servlet.sip.AuthInfo;
import javax.servlet.sip.ServletParseException;
import javax.servlet.sip.SipApplicationSession;
import javax.servlet.sip.SipFactory;
import javax.servlet.sip.SipServletRequest;
import javax.servlet.sip.SipServletResponse;
import javax.servlet.sip.SipSession;
import javax.servlet.sip.SipURI;

import org.joda.time.DateTime;
import org.restcomm.connect.dao.DaoManager;
import org.restcomm.connect.dao.GatewaysDao;
import org.restcomm.connect.dao.entities.Gateway;
import org.restcomm.connect.telephony.api.RegisterGateway;

import scala.concurrent.duration.Duration;
import akka.actor.ActorContext;
import akka.actor.ReceiveTimeout;
import akka.actor.UntypedActor;
import akka.event.Logging;
import akka.event.LoggingAdapter;

/**
 * @author [email protected] (Thomas Quintana)
 * @author [email protected]
 */
public final class ProxyManager extends UntypedActor {
    private final LoggingAdapter logger = Logging.getLogger(getContext().system(), this);

    private static final int ttl = 1800;

    private final ServletContext servletContext;
    private final SipFactory factory;
    private final DaoManager storage;
    private final String address;

    public ProxyManager(final ServletContext servletContext, final SipFactory factory, final DaoManager storage,
            final String address) {
        super();
        this.servletContext = servletContext;
        this.factory = factory;
        this.storage = storage;
        this.address = address;
        final ActorContext context = context();
        context.setReceiveTimeout(Duration.create(60, TimeUnit.SECONDS));
        registerFirstTime();
        if(logger.isInfoEnabled()) {
            logger.info("Proxy Manager started.");
        }
    }

    private void authenticate(final Object message) {
        final SipServletResponse response = (SipServletResponse) message;
        final SipApplicationSession application = response.getApplicationSession();
        final Gateway gateway = (Gateway) application.getAttribute(Gateway.class.getName());
        final int status = response.getStatus();
        final AuthInfo authentication = factory.createAuthInfo();
        final String realm = response.getChallengeRealms().next();
        final String user = gateway.getUserName();
        final String password = gateway.getPassword();
        authentication.addAuthInfo(status, realm, user, password);
        register(gateway, authentication, response);
    }

    private Address contact(final Gateway gateway, final int expires) throws ServletParseException {
        SipURI outboundInterface = null;
        if (address != null && !address.isEmpty()) {
            if(address.contains(":")) {
                outboundInterface = (SipURI) factory.createSipURI(null, address);
            } else {
                outboundInterface = outboundInterface(address, "udp");
            }
        } else {
            outboundInterface = outboundInterface();
        }
        if (outboundInterface == null)
            outboundInterface = (SipURI) factory.createSipURI(null, address);
        final String user = gateway.getUserName();
        final String host = outboundInterface.getHost();
        int port = outboundInterface.getPort();
        if (port == -1) {
            port = outboundInterface().getPort();
        }
        final StringBuilder buffer = new StringBuilder();
        buffer.append("sip:").append(user).append("@").append(host).append(":").append(port);
        final Address contact = factory.createAddress(buffer.toString());
        contact.setExpires(expires);
        return contact;
    }

    @Override
    public void onReceive(Object message) throws Exception {
        if (message instanceof ReceiveTimeout) {
            refresh();
        } else if (message instanceof SipServletResponse) {
            final SipServletResponse response = (SipServletResponse) message;
            final int status = response.getStatus();
            switch (status) {
                case SC_PROXY_AUTHENTICATION_REQUIRED:
                case SC_UNAUTHORIZED: {
                    authenticate(message);
                }
                case SC_OK: {
                    update(message);
                }
            }
        } else if (message instanceof RegisterGateway) {
            register(((RegisterGateway)message).getGateway());
        }
    }

    private SipURI outboundInterface() {
        final ServletContext context = servletContext;
        SipURI result = null;
        @SuppressWarnings("unchecked")
        final List uris = (List) context.getAttribute(OUTBOUND_INTERFACES);
        for (final SipURI uri : uris) {
            final String transport = uri.getTransportParam();
            if ("udp".equalsIgnoreCase(transport)) {
                result = uri;
            }
        }
        return result;
    }

    private SipURI outboundInterface(String address, String transport) {
        final ServletContext context = servletContext;
        SipURI result = null;
        @SuppressWarnings("unchecked")
        final List uris = (List) context.getAttribute(OUTBOUND_INTERFACES);
        for (final SipURI uri : uris) {
            final String interfaceAddress = uri.getHost();
            final String interfaceTransport = uri.getTransportParam();
            if (address.equalsIgnoreCase(interfaceAddress) && transport.equalsIgnoreCase(interfaceTransport)) {
                result = uri;
            }
        }
        return result;
    }

    private void registerFirstTime() {
        if(logger.isInfoEnabled()) {
            logger.info("First time registration for the gateways");
        }
        final GatewaysDao gateways = storage.getGatewaysDao();
        final List results = gateways.getGateways();
        for (final Gateway result : results) {
            register(result);
        }
    }

    private void refresh() {
        final GatewaysDao gateways = storage.getGatewaysDao();
        final List results = gateways.getGateways();
        for (final Gateway result : results) {
            final DateTime lastUpdate = result.getDateUpdated();
            final DateTime expires = lastUpdate.plusSeconds(result.getTimeToLive());
            if (expires.isBeforeNow() || expires.isEqualNow()) {
                register(result);
            }
        }
    }

    private void register(final Gateway gateway) {
        if(logger.isInfoEnabled()) {
            logger.info("About to register gateway: "+gateway.getFriendlyName());
        }
        register(gateway, null, null);
    }

    private void register(final Gateway gateway, final AuthInfo authentication, final SipServletResponse response) {
        try {
            final SipApplicationSession application = factory.createApplicationSession();
            application.setAttribute(Gateway.class.getName(), gateway);
            final String user = gateway.getUserName();
            final String proxy = gateway.getProxy();
            final StringBuilder buffer = new StringBuilder();
            buffer.append("sip:").append(user).append("@").append(proxy);
            final String aor = buffer.toString();
            final int expires = (gateway.getTimeToLive() > 0 && gateway.getTimeToLive() < 3600) ? gateway.getTimeToLive() : ttl;
            final Address contact = contact(gateway, expires);
            // Issue http://code.google.com/p/restcomm/issues/detail?id=65
            SipServletRequest register = null;
            if (response != null) {
                final String method = response.getRequest().getMethod();
                register = response.getSession().createRequest(method);
            } else {
                register = factory.createRequest(application, "REGISTER", contact.toString(), aor);
            }
            if (authentication != null && response != null) {
                register.addAuthHeader(response, authentication);
            }
            register.addAddressHeader("Contact", contact, false);
            final SipURI uri = factory.createSipURI(null, proxy);
            register.pushRoute(uri);
            register.setRequestURI(uri);
            final SipSession session = register.getSession();
            session.setHandler("ProxyManager");
            register.send();
        } catch (final Exception exception) {
            final String name = gateway.getFriendlyName();
            logger.error(exception, "Could not send a registration request to the proxy named " + name);
        }
    }

    private void update(final Object message) {
        final SipServletResponse response = (SipServletResponse) message;
        final SipApplicationSession application = response.getApplicationSession();
        Gateway gateway = (Gateway) application.getAttribute(Gateway.class.getName());
        // This will force the gateway's dateUpdated field to now so we can use it
        // to determine if we need to re-register.
        gateway = gateway.setTimeToLive(gateway.getTimeToLive());
        final GatewaysDao gateways = storage.getGatewaysDao();
        gateways.updateGateway(gateway);
    }
}