All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.restcomm.connect.telephony.ua.UserAgentManager Maven / Gradle / Ivy

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.ua;

import akka.actor.ActorRef;
import akka.actor.ReceiveTimeout;
import akka.actor.UntypedActor;
import akka.event.Logging;
import akka.event.LoggingAdapter;
import org.apache.commons.configuration.Configuration;
import org.joda.time.DateTime;
import org.restcomm.connect.commons.configuration.RestcommConfiguration;
import org.restcomm.connect.commons.dao.Sid;
import org.restcomm.connect.commons.util.DigestAuthentication;
import org.restcomm.connect.dao.ClientsDao;
import org.restcomm.connect.dao.DaoManager;
import org.restcomm.connect.dao.RegistrationsDao;
import org.restcomm.connect.dao.entities.Client;
import org.restcomm.connect.dao.entities.Registration;
import org.restcomm.connect.monitoringservice.MonitoringService;
import org.restcomm.connect.telephony.api.GetCall;
import org.restcomm.connect.telephony.api.Hangup;
import org.restcomm.connect.telephony.api.UserRegistration;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.sip.Address;
import javax.servlet.sip.Parameterable;
import javax.servlet.sip.ServletParseException;
import javax.servlet.sip.SipApplicationSession;
import javax.servlet.sip.SipFactory;
import javax.servlet.sip.SipServletMessage;
import javax.servlet.sip.SipServletRequest;
import javax.servlet.sip.SipServletResponse;
import javax.servlet.sip.SipSession;
import javax.servlet.sip.SipURI;
import java.io.IOException;
import java.net.UnknownHostException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.UUID;

import static java.lang.Integer.parseInt;
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 static org.restcomm.connect.commons.util.HexadecimalUtils.toHex;

/**
 * @author [email protected] (Thomas Quintana)
 * @author [email protected]
 */
public final class UserAgentManager extends UntypedActor {
    private static final int DEFAUL_IMS_PROXY_PORT = -1;
    private static final String REGISTER = "REGISTER";
    private static final String REQ_PARAMETER = "Req";

    private final LoggingAdapter logger = Logging.getLogger(getContext().system(), this);
    private boolean authenticateUsers = true;
    private final SipFactory factory;
    private final DaoManager storage;
    private final ServletContext servletContext;
    private ActorRef monitoringService;
    private final int pingInterval;
    private final String instanceId;

    // IMS authentication
    private boolean actAsImsUa;
    private String imsProxyAddress;
    private int imsProxyPort;
    private String imsDomain;

    public UserAgentManager(final Configuration configuration, final SipFactory factory, final DaoManager storage,
            final ServletContext servletContext) {
        super();
        // this.configuration = configuration;
        this.servletContext = servletContext;
        monitoringService = (ActorRef) servletContext.getAttribute(MonitoringService.class.getName());
        final Configuration runtime = configuration.subset("runtime-settings");
        this.authenticateUsers = runtime.getBoolean("authenticate");
        this.factory = factory;
        this.storage = storage;
        pingInterval = runtime.getInt("ping-interval", 60);
        logger.info("About to run firstTimeCleanup()");
        instanceId = RestcommConfiguration.getInstance().getMain().getInstanceId();
        if(!runtime.subset("ims-authentication").isEmpty()){
            final Configuration imsAuthentication = runtime.subset("ims-authentication");
            this.actAsImsUa = imsAuthentication.getBoolean("act-as-ims-ua");
            if (actAsImsUa) {
                this.imsProxyAddress = imsAuthentication.getString("proxy-address");
                this.imsProxyPort = imsAuthentication.getInt("proxy-port");
                if (imsProxyPort == 0) {
                    imsProxyPort = DEFAUL_IMS_PROXY_PORT;
                }
                this.imsDomain = imsAuthentication.getString("domain");
                if (actAsImsUa && (imsProxyAddress == null || imsProxyAddress.isEmpty()
                        || imsDomain == null || imsDomain.isEmpty())) {
                    logger.warning("ims proxy-address or domain is not configured");
                }
                this.actAsImsUa = actAsImsUa && imsProxyAddress != null && !imsProxyAddress.isEmpty()
                        && imsDomain != null && !imsDomain.isEmpty();
            }
        }

        firstTimeCleanup();
    }

    private void firstTimeCleanup() {
        if (logger.isInfoEnabled())
            logger.info("Initial registration cleanup. Will check existing registrations in DB and cleanup appropriately");
        final RegistrationsDao registrations = storage.getRegistrationsDao();
        List results = registrations.getRegistrationsByInstanceId(instanceId);
        for (final Registration result : results) {
            if (result.isWebRTC()) {
                //If this is a WebRTC registration remove it since after restart the websocket connection is gone
                if (logger.isInfoEnabled())
                    logger.info("Will remove WebRTC client: "+result.getLocation());
                registrations.removeRegistration(result);
                monitoringService.tell(new UserRegistration(result.getUserName(), result.getLocation(), false), self());
            } else {
                final DateTime expires = result.getDateExpires();
                if (expires.isBeforeNow() || expires.isEqualNow()) {
                    if (logger.isInfoEnabled()) {
                        logger.info("Registration: " + result.getLocation() + " expired and will be removed now");
                    }
                    registrations.removeRegistration(result);
                    monitoringService.tell(new UserRegistration(result.getUserName(), result.getLocation(), false), self());
                    monitoringService.tell(new GetCall(result.getLocation()), self());
                } else {
                    final DateTime updated = result.getDateUpdated();
                    Long pingIntervalMillis = new Long(pingInterval * 1000 * 3);
                    if ((DateTime.now().getMillis() - updated.getMillis()) > pingIntervalMillis) {
                        //Last time this registration updated was older than (pingInterval * 3), looks like it doesn't respond to OPTIONS
                        if (logger.isInfoEnabled()) {
                            logger.info("Registration: " + result.getLocation() + " didn't respond to OPTIONS and will be removed now");
                        }
                        registrations.removeRegistration(result);
                        monitoringService.tell(new UserRegistration(result.getUserName(), result.getLocation(), false), self());
                        monitoringService.tell(new GetCall(result.getLocation()), self());
                    }
                }
            }
        }
        results = registrations.getRegistrationsByInstanceId(instanceId);
        if (logger.isInfoEnabled())
            logger.info("Initial registration cleanup finished, starting Restcomm with "+results.size()+" registrations");
    }

    private void clean() throws ServletException {
        final RegistrationsDao registrations = storage.getRegistrationsDao();
        final List results = registrations.getRegistrationsByInstanceId(instanceId);
        for (final Registration result : results) {
            final DateTime expires = result.getDateExpires();
            if (expires.isBeforeNow() || expires.isEqualNow()) {
                if(logger.isInfoEnabled()) {
                    logger.info("Registration: "+result.getAddressOfRecord()+" expired. Will ping again.");
                }
                //Instead of removing registrations we ping the client one last time to ensure it was not a temporary loss
                // of connectivity. We don't need to remove the registration here. It will be handled only if the OPTIONS ping
                // times out and the related calls from the client cleaned up as well
                try{
                    ping(result.getLocation());
                }catch(ServletParseException spe){
                    logger.warning("Bad Parameters: "+result.getLocation());
                    registrations.removeRegistration(result);
                }
                //registrations.removeRegistration(result);
                //monitoringService.tell(new UserRegistration(result.getUserName(), result.getLocation(), false), self());
            } else {
                final DateTime updated = result.getDateUpdated();
                Long pingIntervalMillis = new Long(pingInterval * 1000 * 3);
                if ((DateTime.now().getMillis() - updated.getMillis()) > pingIntervalMillis) {
                    //Last time this registration updated was older than (pingInterval * 3), looks like it doesn't respond to OPTIONS
                    if (logger.isInfoEnabled()) {
                        logger.info("Registration: " + result.getAddressOfRecord() + " didn't respond to OPTIONS. Will ping again.");
                    }
                    // Instead of removing registrations we ping the client one last time to ensure it was not a temporary loss
                    // of connectivity. We don't need to remove the registration here. It will be handled only if the OPTIONS ping
                    // times out and the related calls from the client cleaned up as well
                    try{
                        ping(result.getLocation());
                    }catch(ServletParseException spe){
                        logger.warning("Bad Parameters: "+result.getLocation());
                        registrations.removeRegistration(result);
                    }
                    // registrations.removeRegistration(result);
                    // monitoringService.tell(new UserRegistration(result.getUserName(), result.getLocation(), false), self());
                }
            }
        }
    }

    private void disconnectActiveCalls(ActorRef call) {
        if (call != null && !call.isTerminated()) {
            call.tell(new Hangup("Registration_Removed"), self());
            //callManager.tell(new DestroyCall(call), self());
            if (logger.isDebugEnabled()) {
                logger.debug("Disconnected call: "+call.path()+" , after registration removed");
            }
        }
    }

    private String header(final String nonce, final String realm, final String scheme) {
        final StringBuilder buffer = new StringBuilder();
        buffer.append(scheme).append(" ");
        buffer.append("realm=\"").append(realm).append("\", ");
        buffer.append("nonce=\"").append(nonce).append("\"");
        return buffer.toString();
    }

    private void authenticate(final Object message) throws IOException {
        final SipServletRequest request = (SipServletRequest) message;
        final SipServletResponse response = request.createResponse(SC_PROXY_AUTHENTICATION_REQUIRED);
        final String nonce = nonce();
        final SipURI uri = (SipURI) request.getTo().getURI();
        final String realm = uri.getHost();
        final String header = header(nonce, realm, "Digest");
        response.addHeader("Proxy-Authenticate", header);
        response.send();
    }

    private void keepAlive() throws Exception {
        final RegistrationsDao registrations = storage.getRegistrationsDao();
        final List results = registrations.getRegistrationsByInstanceId(instanceId);
        if (results != null && results.size() > 0) {
            if (logger.isDebugEnabled()) {
                logger.debug("Registrations for InstanceId: "+ instanceId +" , returned "+results.size()+" registrations");
            }
            for (final Registration result : results) {
                final String to = result.getLocation();
                try{
                    ping(to);
                }catch(ServletParseException spe){
                    logger.warning("Bad Parameters: "+to);
                    registrations.removeRegistration(result);
                }
            }
        } else {
            if (logger.isDebugEnabled()) {
                logger.debug("Registrations for InstanceId: "+ instanceId +" , returned no registrations");
            }
        }
    }

    private String nonce() {
        final byte[] uuid = UUID.randomUUID().toString().getBytes();
        final char[] hex = toHex(uuid);
        return new String(hex).substring(0, 31);
    }

    @Override
    public void onReceive(final Object message) throws Exception {
        final Class klass = message.getClass();
        final ActorRef sender = sender();
        if (logger.isInfoEnabled()) {
            logger.info("UserAgentManager Processing Message: \"" + klass.getName() + " sender : "+ sender.getClass()+" self is terminated: "+self().isTerminated());
        }
        if (message instanceof ReceiveTimeout) {
            if (logger.isDebugEnabled()) {
                logger.debug("Timeout received, ping interval: "+pingInterval+" , will clean up registrations and send keep alive");
            }
            clean();
            keepAlive();
        } else if (message instanceof SipServletRequest) {
            final SipServletRequest request = (SipServletRequest) message;
            final String method = request.getMethod();
            if ("REGISTER".equalsIgnoreCase(method)) {
                if (logger.isDebugEnabled()) {
                    logger.debug("REGISTER request received: "+request.toString());
                }
                if (actAsImsUa) {
                    proxyRequestToIms(request);
                } else if(authenticateUsers) { // https://github.com/Mobicents/RestComm/issues/29 Allow disabling of SIP authentication
                    final String authorization = request.getHeader("Proxy-Authorization");
                    if (authorization != null) {
                      if (permitted(authorization, method)) {
                          register(message);
                      } else {
                          SipServletResponse response = ((SipServletRequest) message).createResponse(javax.servlet.sip.SipServletResponse.SC_FORBIDDEN); //Issue #935, Send 403 FORBIDDEN instead of issuing 407 again and again
                          response.send();
                      }
                    } else {
                        authenticate(message);
                    }
                } else {
                    register(message);
                }
            }
        } else if (message instanceof SipServletResponse) {
            SipServletResponse response = (SipServletResponse) message;
            if (response.getStatus()>400 && response.getMethod().equalsIgnoreCase("OPTIONS")) {
                removeRegistration(response);
            } else if (actAsImsUa && response.getMethod().equalsIgnoreCase(REGISTER)) {
                proxyResponseFromIms(message, response);
            } else {
                pong(message);
            }
        } else if(message instanceof ActorRef) {
            disconnectActiveCalls((ActorRef) message);
        }
    }

    private void removeRegistration(final SipServletMessage sipServletMessage) throws ServletParseException {
        removeRegistration(sipServletMessage, false);
    }

    private void removeRegistration(final SipServletMessage sipServletMessage, boolean locationInContact) throws ServletParseException{
        String user = ((SipURI)sipServletMessage.getTo().getURI()).getUser();
        SipURI location = locationInContact ? ((SipURI)sipServletMessage.getAddressHeader("Contact").getURI()) :
            ((SipURI)sipServletMessage.getTo().getURI());
        if(logger.isDebugEnabled()) {
            logger.debug("Error response for the OPTIONS to: "+location+" will remove registration");
        }
        final RegistrationsDao regDao = storage.getRegistrationsDao();
        List registrations = regDao.getRegistrations(user);
        if (registrations != null) {
            Iterator iter = registrations.iterator();
            SipURI regLocation = null;
            while (iter.hasNext()) {
                Registration reg = iter.next();
                try {
                    regLocation = (SipURI) factory.createURI(reg.getLocation());
                } catch (ServletParseException e) {}

//                Long pingIntervalMillis = new Long(pingInterval * 1000 * 3);
//                boolean optionsTimeout = ((DateTime.now().getMillis() - reg.getDateUpdated().getMillis()) > pingIntervalMillis);

                if(logger.isDebugEnabled()) {
                    logger.debug("regLocation: " + regLocation + " reg.getAddressOfRecord(): "+reg.getAddressOfRecord() +
                            " reg.getLocation(): "+reg.getLocation() + ", reg.getDateExpires(): " + reg.getDateExpires()
                            + ", reg.getDateUpdated(): " + reg.getDateUpdated()
                            + ", location: " + location
                            + ", reg.getLocation().contains(location): " + reg.getLocation().contains(location.toString()));
                    if (reg.getDateExpires().isBeforeNow() || reg.getDateExpires().isEqualNow()) {
                        logger.debug("Registration: "+ reg.getAddressOfRecord()+" expired");
                    }
                }

                String locationStored = getLocationWithoutParameters(regLocation);
                String locationToTest = getLocationWithoutParameters(location);


                // We clean up only if the location is similar to the registration location to avoid cleaning up all registration lcoation for the AOR
                // We keep getting REGISTER and allow for some leeway in case of connectivity issues from restcomm clients.
//                if (regLocation != null && optionsTimeout && reg.getLocation().contains(location) &&
                if (locationStored != null && locationStored.equalsIgnoreCase(locationToTest) ) {
//                    && (reg.getAddressOfRecord().equalsIgnoreCase(regLocation.toString()) || reg.getLocation().equalsIgnoreCase(regLocation.toString()))) {

                    if(logger.isDebugEnabled()) {
                        logger.debug("Registration: " + reg.getLocation() + " failed to response to OPTIONS and will be removed");
                    }

                    regDao.removeRegistration(reg);
                    monitoringService.tell(new UserRegistration(reg.getUserName(), reg.getLocation(), false), self());
                    monitoringService.tell(new GetCall(reg.getLocation()), self());
                } else {
                    if (logger.isDebugEnabled()) {
                        String msg = String.format("Registration DID NOT removed. SIP Message location: %s, registration location (in DB) %s.", locationToTest, reg.getLocation());
                        logger.debug(msg);
                    }
                }
            }
        }
    }

    private String getLocationWithoutParameters(final SipURI location) {
        String result = null;
        result = "sip:"+location.getUser()+"@"+location.getHost()+":"+location.getPort();
        return result;
    }

    private void patch(final SipURI uri, final String address, final int port) throws UnknownHostException {
        uri.setHost(address);
        uri.setPort(port);
    }

    private boolean permitted(final String authorization, final String method) {
        final Map map = toMap(authorization);
        final String user = map.get("username").trim();
        final String algorithm = map.get("algorithm");
        final String realm = map.get("realm");
        final String uri = map.get("uri");
        final String nonce = map.get("nonce");
        final String nc = map.get("nc");
        final String cnonce = map.get("cnonce");
        final String qop = map.get("qop");
        final String response = map.get("response");
        final ClientsDao clients = storage.getClientsDao();
        final Client client = clients.getClient(user);
        if (client != null && Client.ENABLED == client.getStatus()) {
            final String password = client.getPassword();
            final String result = DigestAuthentication.response(algorithm, user, realm, password, nonce, nc, cnonce, method,
                    uri, null, qop);
            return result.equals(response);
        } else {
            return false;
        }
    }

    private void ping(final String to) throws ServletException {
        final SipApplicationSession application = factory.createApplicationSession();
        String toTransport = ((SipURI) factory.createURI(to)).getTransportParam();
        if (toTransport == null) {
            // RESTCOMM-301 NPE in RestComm Ping
            toTransport = "udp";
        }
        /* sometime users on webrtc clients like olympus, closes the tab instead of properly hangup.
         * so removing this check so we could send OPTIONS to WebRtc clients as well:
         * if (toTransport.equalsIgnoreCase("ws") || toTransport.equalsIgnoreCase("wss")) {
            return;
        }*/
        final SipURI outboundInterface = outboundInterface(toTransport);
        StringBuilder buffer = new StringBuilder();
        buffer.append("sip:restcomm").append("@").append(outboundInterface.getHost());
        final String from = buffer.toString();
        final SipServletRequest ping = factory.createRequest(application, "OPTIONS", from, to);
        final SipURI uri = (SipURI) factory.createURI(to);
        ping.pushRoute(uri);
        ping.setRequestURI(uri);
        final SipSession session = ping.getSession();
        session.setHandler("UserAgentManager");
        if(logger.isDebugEnabled()) {
            logger.debug("About to send OPTIONS keepalive to: "+to);
        }
        try {
            ping.send();
        } catch (IOException e) {
            if (logger.isInfoEnabled()) {
                logger.info("There was a problem while trying to ping client: "+to+" , will remove registration. " + e.getMessage());
            }
            removeRegistration(ping);
        }
    }

    private void pong(final Object message) {
        final SipServletResponse response = (SipServletResponse) message;
        if (response.getApplicationSession().isValid()) {
            try {
                response.getApplicationSession().setInvalidateWhenReady(true);
            } catch (IllegalStateException ise) {
                if (logger.isDebugEnabled()) {
                    logger.debug("The session was already invalidated, nothing to do");
                }
            }
        }
        final RegistrationsDao registrations = storage.getRegistrationsDao();
        Registration registration = registrations.getRegistration(((SipURI)response.getTo().getURI()).getUser());
        //Registration here shouldn't be null. Update it
        registration = registration.updated();
        registrations.updateRegistration(registration);
    }

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

    private void register(final Object message) throws Exception {
        final SipServletRequest request = (SipServletRequest) message;
        final Address contact = request.getAddressHeader("Contact");
        // Get the expiration time.
        int ttl = contact.getExpires();
        if (ttl == -1) {
            final String expires = request.getHeader("Expires");
            if (expires != null) {
                ttl = parseInt(expires);
            } else {
                ttl = 3600;
            }
        }
        // Make sure registrations don't last more than 1 hour.
        if (ttl > 3600) {
            ttl = 3600;
        }
        if (logger.isDebugEnabled()) {
            logger.debug("Register request received for contact: "+contact+", and ttl: "+ttl);
        }
        // Get the rest of the information needed for a registration record.
        String name = contact.getDisplayName();
        String ua = request.getHeader("User-Agent");
        final SipURI to = (SipURI) request.getTo().getURI();
        final String aor = to.toString();
        final String user = to.getUser().trim();
        final SipURI uri = (SipURI) contact.getURI();
        final String ip = request.getInitialRemoteAddr();
        final int port = request.getInitialRemotePort();

        String transport = (uri.getTransportParam()==null?request.getParameter("transport"):uri.getTransportParam()); //Issue #935, take transport of initial request-uri if contact-uri has no transport parameter
        //If RURI is secure (SIPS) then pick TLS for transport - https://github.com/RestComm/Restcomm-Connect/issues/1956
        if (((SipURI)request.getRequestURI()).isSecure()) {
            transport = "tls";
        }
        if (transport == null && !request.getInitialTransport().equalsIgnoreCase("udp")) {
            //Issue1068, if Contact header or RURI doesn't specify transport, check InitialTransport from
            transport = request.getInitialTransport();
        }

        boolean isLBPresent = false;
        //Issue 306: https://telestax.atlassian.net/browse/RESTCOMM-306
        final String initialIpBeforeLB = request.getHeader("X-Sip-Balancer-InitialRemoteAddr");
        final String initialPortBeforeLB = request.getHeader("X-Sip-Balancer-InitialRemotePort");
        if(initialIpBeforeLB != null && !initialIpBeforeLB.isEmpty() && initialPortBeforeLB != null && !initialPortBeforeLB.isEmpty()) {
            if(logger.isInfoEnabled()) {
                logger.info("Client in front of LB. Patching URI: "+uri.toString()+" with IP: "+initialIpBeforeLB+" and PORT: "+initialPortBeforeLB+" for USER: "+user);
            }
            patch(uri, initialIpBeforeLB, Integer.valueOf(initialPortBeforeLB));
            isLBPresent = true;
        } else {
            if(logger.isInfoEnabled()) {
                logger.info("Patching URI: " + uri.toString() + " with IP: " + ip + " and PORT: " + port + " for USER: " + user);
            }
            patch(uri, ip, port);
        }

        final StringBuffer buffer = new StringBuffer();
        if (((SipURI)request.getRequestURI()).isSecure()) {
            buffer.append("sips:");
        } else {
            buffer.append("sip:");
        }
        buffer.append(normalize(user)).append("@").append(uri.getHost()).append(":").append(uri.getPort());
        // https://bitbucket.org/telestax/telscale-restcomm/issue/142/restcomm-support-for-other-transports-than
        if (transport != null) {
            buffer.append(";transport=").append(transport);
        }

        Iterator extraParameterNames = uri.getParameterNames();
        while (extraParameterNames.hasNext()) {
            String paramName = extraParameterNames.next();
            if (!paramName.equalsIgnoreCase("transport")) {
                String paramValue = uri.getParameter(paramName);
                buffer.append(";");
                buffer.append(paramName);
                buffer.append("=");
                buffer.append(paramValue);
            }
        }

        final String address = buffer.toString();
        // Prepare the response.
        final SipServletResponse response = request.createResponse(SC_OK);
        // Update the data store.
        final Sid sid = Sid.generate(Sid.Type.REGISTRATION);
        final DateTime now = DateTime.now();

        // Issue 87
        // (http://www.google.com/url?q=https://bitbucket.org/telestax/telscale-restcomm/issue/87/verb-and-not-working-for-end-to-end-calls%23comment-5855486&usd=2&usg=ALhdy2_mIt4FU4Yb_EL-s0GZCpBG9BB8eQ)
        // if display name or UA are null, the hasRegistration returns 0 even if there is a registration
        if (name == null)
            name = user;
        if (ua == null)
            ua = "GenericUA";

        boolean webRTC = isWebRTC(transport, ua);

        final Registration registration = new Registration(sid, instanceId, now, now, aor, name, user, ua, ttl, address, webRTC, isLBPresent);
        final RegistrationsDao registrations = storage.getRegistrationsDao();

        if (ttl == 0) {
            // Remove Registration if ttl=0
            registrations.removeRegistration(registration);
            response.setHeader("Expires", "0");
            monitoringService.tell(new UserRegistration(user, address, false), self());
            if(logger.isInfoEnabled()) {
                logger.info("The user agent manager unregistered " + user + " at address "+address+":"+port);
            }
        } else {
            monitoringService.tell(new UserRegistration(user, address, true), self());
            if (registrations.hasRegistration(registration)) {
                // Update Registration if exists
                registrations.updateRegistration(registration);
                if(logger.isInfoEnabled()) {
                    logger.info("The user agent manager updated " + user + " at address " + address+":"+port);
                }
            } else {
                // Add registration since it doesn't exists on the DB
                registrations.addRegistration(registration);
                if(logger.isInfoEnabled()) {
                    logger.info("The user agent manager registered " + user + " at address " + address+":"+port);
                }
            }
            response.setHeader("Contact", contact(uri, ttl));
        }
        // Success
        response.send();
        // Cleanup
        // if(request.getSession().isValid()) {
        // request.getSession().invalidate();
        // }
        try {
            if (request != null) {
                if (request.getApplicationSession() != null) {
                    if (request.getApplicationSession().isValid()) {
                        try {
                            request.getApplicationSession().setInvalidateWhenReady(true);
                        } catch (IllegalStateException exception) {
                            logger.warning("Illegal State: while trying to setInvalidateWhenReady(true) for application session, message: "+exception.getMessage());
                        }
                    }
                } else {
                    if (logger.isInfoEnabled()) {
                        logger.info("After sent response: "+response.toString()+" for Register request, application session is NULL!");
                    }
                }
            } else {
                if (logger.isInfoEnabled()) {
                    logger.info("After sent response: "+response.toString()+" for Register request, request is NULL!");
                }
            }
        } catch (Exception e) {
            logger.error("Exception while trying to setInvalidateWhenReady(true) after sent response to register : "+response.toString()+" exception: "+e);
        }
    }

    /**
     * Checks whether the client is WebRTC or not.
     *
     * 

* A client is considered WebRTC if one of the following statements is true:
* 1. The chosen transport is WebSockets (transport=ws).
* 2. The chosen transport is WebSockets Secured (transport=wss).
* 3. The User-Agent corresponds to one of TeleStax mobile clients. *

* * @param transport * @param userAgent * @return */ private boolean isWebRTC(String transport, String userAgent) { return "ws".equalsIgnoreCase(transport) || "wss".equalsIgnoreCase(transport) || userAgent.toLowerCase().contains("restcomm"); } private String contact(final SipURI uri, final int expires) { final Address contact = factory.createAddress(uri); contact.setExpires(expires); return contact.toString(); } private Map toMap(final String header) { final Map map = new HashMap(); final int endOfScheme = header.indexOf(" "); map.put("scheme", header.substring(0, endOfScheme).trim()); final String[] tokens = header.substring(endOfScheme + 1).split(","); for (final String token : tokens) { final String[] values = token.trim().split("=",2); //Issue #935, split only for first occurrence of "=" map.put(values[0].toLowerCase(), values[1].replace("\"", "")); } return map; } private void proxyResponseFromIms(Object message, SipServletResponse response) throws ServletParseException, IOException { if(logger.isDebugEnabled()) { logger.debug("REGISTER IMS Response received: "+message); } final SipServletRequest incomingRequest = (SipServletRequest) response.getApplicationSession().getAttribute(REQ_PARAMETER); String wwwAuthenticate = response.getHeader("WWW-Authenticate"); final Address contact = incomingRequest.getAddressHeader("Contact"); final SipURI uri = (SipURI) contact.getURI(); final String ip = incomingRequest.getInitialRemoteAddr(); final int port = incomingRequest.getInitialRemotePort(); String ua = incomingRequest.getHeader("User-Agent"); String name = contact.getDisplayName(); final SipURI to = (SipURI) incomingRequest.getTo().getURI(); final String aor = to.toString(); final String user = to.getUser(); boolean isLBPresent = false; //Issue 306: https://telestax.atlassian.net/browse/RESTCOMM-306 final String initialIpBeforeLB = incomingRequest.getHeader("X-Sip-Balancer-InitialRemoteAddr"); final String initialPortBeforeLB = incomingRequest.getHeader("X-Sip-Balancer-InitialRemotePort"); if(initialIpBeforeLB != null && !initialIpBeforeLB.isEmpty() && initialPortBeforeLB != null && !initialPortBeforeLB.isEmpty()) { if(logger.isInfoEnabled()) { logger.info("Client in front of LB. Patching URI: "+uri.toString()+" with IP: "+initialIpBeforeLB+" and PORT: "+initialPortBeforeLB+" for USER: "+user); } patch(uri, initialIpBeforeLB, Integer.valueOf(initialPortBeforeLB)); isLBPresent = true; } else { if(logger.isInfoEnabled()) { logger.info("Patching URI: " + uri.toString() + " with IP: " + ip + " and PORT: " + port + " for USER: " + user); } patch(uri, ip, port); } SipServletResponse incomingLegResposne = incomingRequest.createResponse(response.getStatus(), response.getReasonPhrase()); if (wwwAuthenticate != null) { incomingLegResposne.addHeader("WWW-Authenticate", wwwAuthenticate); } int ttl = 3600; final Address imsContact = response.getAddressHeader("Contact"); if (imsContact != null) { ttl = imsContact.getExpires(); if (ttl == -1) { final String expires = response.getRequest().getHeader("Expires"); if (expires != null) { ttl = parseInt(expires); } else { ttl = 3600; } } final SipURI sipURI = (SipURI) contact.getURI(); String newContact = contact(sipURI, ttl); if(logger.isInfoEnabled()) { logger.info("ttl: "+ttl); logger.info("new contact: "+newContact); } incomingLegResposne.setHeader("Contact", newContact); } if(logger.isInfoEnabled()) { logger.info("outgoing leg state: "+response.getSession().getState()); logger.info("incoming leg state: "+incomingLegResposne.getSession().getState()); } if (response.getStatus()>=400 && response.getStatus() != SC_UNAUTHORIZED && response.getStatus() != SC_PROXY_AUTHENTICATION_REQUIRED) { removeRegistration(incomingRequest, true); } else if (response.getStatus()==200) { String transport = (uri.getTransportParam()==null?incomingRequest.getParameter("transport"):uri.getTransportParam()); //Issue #935, take transport of initial request-uri if contact-uri has no transport parameter if (transport == null && !incomingRequest.getInitialTransport().equalsIgnoreCase("udp")) { //Issue1068, if Contact header or RURI doesn't specify transport, check InitialTransport from transport = incomingRequest.getInitialTransport(); } final Sid sid = Sid.generate(Sid.Type.REGISTRATION); final DateTime now = DateTime.now(); final StringBuffer buffer = new StringBuffer(); buffer.append("sip:").append(normalize(user)).append("@").append(uri.getHost()).append(":").append(uri.getPort()); // https://bitbucket.org/telestax/telscale-restcomm/issue/142/restcomm-support-for-other-transports-than if (transport != null) { buffer.append(";transport=").append(transport); } final String address = buffer.toString(); if (name == null) name = user; if (ua == null) ua = "GenericUA"; boolean webRTC = isWebRTC(transport, ua); final Registration registration = new Registration(sid, RestcommConfiguration.getInstance().getMain().getInstanceId(), now, now, aor, name, user, ua, ttl, address, webRTC, isLBPresent); final RegistrationsDao registrations = storage.getRegistrationsDao(); if (ttl == 0) { // Remove Registration if ttl=0 registrations.removeRegistration(registration); incomingLegResposne.setHeader("Expires", "0"); monitoringService.tell(new UserRegistration(user, address, false), self()); if(logger.isInfoEnabled()) { logger.info("The user agent manager unregistered " + user + " at address "+address+":"+port); } } else { monitoringService.tell(new UserRegistration(user, address, true), self()); if (registrations.hasRegistration(registration)) { // Update Registration if exists registrations.updateRegistration(registration); if(logger.isInfoEnabled()) { logger.info("The user agent manager updated " + user + " at address " + address+":"+port); } } else { // Add registration since it doesn't exists on the DB registrations.addRegistration(registration); if(logger.isInfoEnabled()) { logger.info("The user agent manager registered " + user + " at address " + address+":"+port); } } } } incomingLegResposne.send(); if(logger.isDebugEnabled()) { logger.debug("REGISTER IMS Response sent: "+incomingLegResposne); } } /** * normalize: normalize clients that contain @ sign in user e.g. [email protected] * @param user * @return */ private String normalize(String user) { if(user != null){ if(user.contains("@")) user = user.replaceAll("@", "%40"); } if(logger.isDebugEnabled()) logger.debug("Normalized User = " + user); return user; } private void proxyRequestToIms(SipServletRequest request) throws ServletParseException, IOException { // TODO question - this method is deprecated but only that can be used to set callId which has to be the same for both REGISTER messages final SipServletRequest outgoingRequest = factory.createRequest(request, true); Parameterable via = outgoingRequest.getParameterableHeader("Via"); if (via == null) { seltLocalContact(outgoingRequest); } else { String[] strings = via.getValue().trim().split(" "); if (strings.length != 2) { seltLocalContact(outgoingRequest); } else { outgoingRequest.removeHeader("Contact"); String addressFromVia = strings[1].trim(); Address address = factory.createAddress("sip:" + addressFromVia); outgoingRequest.setAddressHeader("Contact", address); } } request.getApplicationSession().setAttribute(REQ_PARAMETER, request); final SipURI routeToRegistrar = factory.createSipURI(null, imsProxyAddress); routeToRegistrar.setLrParam(true); routeToRegistrar.setPort(imsProxyPort); outgoingRequest.pushRoute(routeToRegistrar); final SipURI requestUri = factory.createSipURI(null, imsDomain); outgoingRequest.setRequestURI(requestUri); if(logger.isDebugEnabled()) { logger.debug("Sending to ims proxy: "+ outgoingRequest); } outgoingRequest.send(); } private void seltLocalContact(SipServletRequest outgoingRequest) throws ServletParseException { Address contact = outgoingRequest.getAddressHeader("Contact"); SipURI sipURI = ((SipURI)contact.getURI()); sipURI.setPort(outgoingRequest.getLocalPort()); sipURI.setHost(outgoingRequest.getLocalAddr()); } @Override public void postStop() { try { if (logger.isInfoEnabled()) { logger.info("UserAgentManager actor at postStop, path: "+self().path()+", isTerminated: "+self().isTerminated()+", sender: "+sender()); if (storage != null){ logger.info("Number of current Registrations:" + storage.getRegistrationsDao().getRegistrations().size()); } } } catch (Exception exception) { if(logger.isInfoEnabled()) { logger.info("Exception during UserAgentManager postStop"); } } super.postStop(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy