org.restcomm.connect.telephony.api.util.B2BUAHelper Maven / Gradle / Ivy
The 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 > extensionHeaders = (Map>)incomingSession.getAttribute(EXTENSION_HEADERS);
addHeadersToMessage(outRequest, extensionHeaders, sipFactory);
outRequest.send();
Address originalFromAddress = request.getFrom();
SipURI originalFromUri = (SipURI) originalFromAddress.getURI();
int port = originalFromUri.getPort();
if (port == -1) {
port = request.getRemotePort();
originalFromUri.setPort(port);
}
if(isBehindLB) {
// https://github.com/RestComm/Restcomm-Connect/issues/1357
String realIP = initialIpBeforeLB + ":" + initialPortBeforeLB;
SipURI uri = sipFactory.createSipURI(null, realIP);
if (logger.isDebugEnabled()) {
logger.debug("We are behind load balancer, storing initial IP and Ports " + uri);
}
outRequest.getSession().setAttribute(FROM_INET_URI, uri);
} else {
if (logger.isDebugEnabled()) {
logger.debug("We are not behind load balancer, storing " + FROM_INET_URI +": " + to);
}
outRequest.getSession().setAttribute(FROM_INET_URI, originalFromUri);
}
final CallDetailRecord.Builder builder = CallDetailRecord.builder();
builder.setSid(Sid.generate(Sid.Type.CALL));
builder.setInstanceId(RestcommConfiguration.getInstance().getMain().getInstanceId());
builder.setDateCreated(DateTime.now());
builder.setAccountSid(fromClient.getAccountSid());
builder.setTo(to.toString());
builder.setCallerName(fromClient.getFriendlyName());
builder.setFrom(fromClient.getFriendlyName());
// builder.setForwardedFrom(callInfo.forwardedFrom());
// builder.setPhoneNumberSid(phoneId);
builder.setStatus(CallStateChanged.State.QUEUED.name());
builder.setDirection("Client-To-Client");
builder.setApiVersion(fromClient.getApiVersion());
builder.setPrice(new BigDecimal("0.00"));
// TODO implement currency property to be read from Configuration
builder.setPriceUnit(Currency.getInstance("USD"));
final StringBuilder buffer = new StringBuilder();
buffer.append("/").append(fromClient.getApiVersion()).append("/Accounts/");
buffer.append(fromClient.getAccountSid().toString()).append("/Calls/");
buffer.append(fromClient.getSid().toString());
final URI uri = URI.create(buffer.toString());
builder.setUri(uri);
CallDetailRecordsDao records = daoManager.getCallDetailRecordsDao();
CallDetailRecord callRecord = builder.build();
records.addCallDetailRecord(callRecord);
incomingSession.setAttribute(CDR_SID, callRecord.getSid());
outgoingSession.setAttribute(CDR_SID, callRecord.getSid());
incomingSession.setAttribute(CDR_ACCOUNT_SID, fromClient.getSid());
outgoingSession.setAttribute(CDR_ACCOUNT_SID, fromClient.getSid());
incomingSession.setAttribute(CDR_DIRECTION, "Client-To-Client");
outgoingSession.setAttribute(CDR_DIRECTION, "Client-To-Client");
incomingSession.setAttribute(CDR_FROM, fromClient.getLogin());
outgoingSession.setAttribute(CDR_FROM, fromClient.getLogin());
incomingSession.setAttribute(CDR_TO, to.toString());
outgoingSession.setAttribute(CDR_TO, to.toString());
sendCallInfoStreamEvent(system, request, CallStateChanged.State.QUEUED);
return true; // successfully proxied the SIP request
} catch (IOException exception) {
if (logger.isInfoEnabled()) {
logger.info(String.format("B2BUA: Error while trying to proxy request from %s to %s", from, to));
logger.info("Exception: " + exception);
}
}
return false;
}
// Issue 308: https://telestax.atlassian.net/browse/RESTCOMM-308
@SuppressWarnings("unchecked")
private static String patch(final byte[] data, final String externalIp) throws UnknownHostException, SdpException {
final String text = new String(data);
if(logger.isInfoEnabled()){
logger.info("About to patch ");
logger.info("SDP :" + text);
logger.info("Using externalIP: " + externalIp);
}
final SessionDescription sdp = SdpFactory.getInstance().createSessionDescription(text);
SessionName sessionName = SdpFactory.getInstance().createSessionName("Restcomm B2BUA");
sdp.setSessionName(sessionName);
// Handle the connection at the session level.
fix(sdp.getConnection(), externalIp);
// Handle the connections at the media description level.
final Vector descriptions = sdp.getMediaDescriptions(false);
for (final MediaDescription description : descriptions) {
fix(description.getConnection(), externalIp);
}
sdp.getOrigin().setAddress(externalIp);
return sdp.toString();
}
// Issue 308: https://telestax.atlassian.net/browse/RESTCOMM-308
@SuppressWarnings("unused")
private static void fix(final Connection connection, final String externalIp) throws UnknownHostException, SdpException {
if (connection != null) {
if (Connection.IN.equals(connection.getNetworkType())) {
if (Connection.IP4.equals(connection.getAddressType())) {
final InetAddress address = DNSUtils.getByName(connection.getAddress());
if (address.isSiteLocalAddress() || address.isAnyLocalAddress() || address.isLoopbackAddress()) {
final String ip = address.getHostAddress();
connection.setAddress(externalIp);
}
}
}
}
}
public static SipServletResponse getLinkedResponse(SipServletMessage message) {
SipSession linkedB2BUASession = getLinkedSession(message);
// if this is an ACK that belongs to a B2BUA session, then we proxy it to the other client
if (linkedB2BUASession != null) {
SipServletResponse response = (SipServletResponse) linkedB2BUASession.getAttribute(B2BUA_LAST_RESPONSE);
return response;
}
return null;
}
public static SipServletRequest getLinkedRequest(SipServletMessage message) {
SipSession linkedB2BUASession = getLinkedSession(message);
if (linkedB2BUASession != null) {
SipServletRequest linkedRequest = (SipServletRequest) linkedB2BUASession.getAttribute(B2BUA_LAST_REQUEST);
return linkedRequest;
}
return null;
}
public static SipSession getLinkedSession(SipServletMessage message) {
SipSession sipSession = null;
if (message.getSession().isValid()) {
sipSession = (SipSession) message.getSession().getAttribute(B2BUA_LINKED_SESSION);
}
if (sipSession == null) {
if(logger.isInfoEnabled()) {
logger.info("SIP SESSION is NULL");
}
}
return sipSession;
}
/**
* @param response
* @throws IOException
*/
public static void forwardResponse(final ActorSystem system, final SipServletResponse response, final boolean patchForNat) throws IOException {
if (logger.isInfoEnabled()) {
logger.info(String.format("B2BUA: Got response: \n %s", response));
}
if (response.getSession() == null || !response.getSession().isValid()) {
if (logger.isDebugEnabled()) {
logger.debug("Response session is either null or invalidated");
}
return;
}
if (getLinkedSession(response) == null || !getLinkedSession(response).isValid()) {
if (logger.isDebugEnabled()) {
logger.debug("Linked session of response is either null or invalidated");
}
return;
}
CallDetailRecordsDao records = daoManager.getCallDetailRecordsDao();
if (response.getStatus() > 200)
response.getSession().setAttribute(B2BUA_LAST_FINAL_RESPONSE, response);
// container handles CANCEL related responses no need to forward them
if (response.getStatus() == 487 || (response.getStatus() == 200 && response.getMethod().equalsIgnoreCase("CANCEL"))) {
if (logger.isDebugEnabled()) {
logger.debug("response to CANCEL not forwarding");
}
// Update CallDetailRecord
SipServletRequest request = (SipServletRequest) getLinkedSession(response).getAttribute(B2BUA_LAST_REQUEST);
CallDetailRecord callRecord = records.getCallDetailRecord((Sid) request.getSession().getAttribute(CDR_SID));
if (callRecord != null) {
if(logger.isInfoEnabled()) {
logger.info("CDR found! Updating");
}
callRecord = callRecord.setStatus(CallStateChanged.State.CANCELED.name());
final DateTime now = DateTime.now();
callRecord = callRecord.setEndTime(now);
int seconds;
if (callRecord.getStartTime() != null) {
seconds = (int) (DateTime.now().getMillis() - callRecord.getStartTime().getMillis()) / 1000;
} else {
seconds = 0;
}
callRecord = callRecord.setDuration(seconds);
records.updateCallDetailRecord(callRecord);
sendCallInfoStreamEvent(system, request, CallStateChanged.State.CANCELED);
}
return;
}
// We don't forward 200 OK Response to BYE.
if (response.getStatus() == 200 && response.getMethod().equalsIgnoreCase("BYE")) {
if (logger.isDebugEnabled()) {
logger.debug("response to BYE not forwarding");
}
return;
}
// forward the response
if (response.getSession() != null &&
(!response.getSession().getState().equals(SipSession.State.TERMINATED))) {
response.getSession().setAttribute(B2BUA_LAST_RESPONSE, response);
}
SipServletRequest linkedRequest = (SipServletRequest) getLinkedSession(response).getAttribute(B2BUA_LAST_REQUEST);
SipServletResponse clonedResponse = linkedRequest.createResponse(response.getStatus());
SipURI originalURI = null;
try {
//only fix Contact if necessary, some requests like MESSAGE
//doesn't need Contact header
if(clonedResponse.getAddressHeader("Contact") != null &&
response.getAddressHeader("Contact") != null &&
response.getAddressHeader("Contact").getURI() != null) {
originalURI = (SipURI) response.getAddressHeader("Contact").getURI();
if (originalURI != null && originalURI.getUser() != null && !originalURI.getUser().isEmpty()) {
((SipURI) clonedResponse.getAddressHeader("Contact").getURI()).setUser(originalURI.getUser());
}
}
} catch (ServletParseException | NullPointerException e) {
logger.error("Problem while trying to set User part on a clones response for a P2P call, "+e);
}
CallDetailRecord callRecord = records.getCallDetailRecord((Sid) linkedRequest.getSession().getAttribute(CDR_SID));
Sid organizationSid = daoManager.getAccountsDao().getAccount(callRecord.getAccountSid()).getOrganizationSid();
if (response.getRawContent() != null && response.getRawContent().length > 0 ) {
final byte[] sdp = response.getRawContent();
String offer = null;
if (response.getContentType().equalsIgnoreCase("application/sdp") && patchForNat) {
// Issue 306: https://telestax.atlassian.net/browse/RESTCOMM-306
Registration registration = daoManager.getRegistrationsDao().getRegistration(callRecord.getTo(), organizationSid);
String externalIp;
if (registration != null) {
externalIp = registration.getLocation().split(":")[1].split("@")[1];
} else {
externalIp = callRecord.getTo().split(":")[1].split("@")[1];
}
try {
if(logger.isDebugEnabled()) {
logger.debug("Got original address from Registration :" + externalIp);
}
offer = patch(sdp, externalIp);
} catch (SdpException e) {
logger.error("Unexpected exception while patching sdp ", e);
}
}
if (offer != null) {
clonedResponse.setContent(offer, response.getContentType());
} else {
clonedResponse.setContent(sdp, response.getContentType());
}
}
addHeadersToMessage(clonedResponse, getCustomHeaders(response, "X-"));
clonedResponse.send();
// CallDetailRecord callRecord = records.getCallDetailRecord((Sid) request.getSession().getAttribute(CDR_SID));
if (callRecord != null) {
if(logger.isInfoEnabled()) {
logger.info("CDR found! Updating");
}
if (!linkedRequest.getMethod().equalsIgnoreCase("BYE")) {
if (response.getStatus() == 100 || response.getStatus() == 180 || response.getStatus() == 183) {
callRecord = callRecord.setStatus(CallStateChanged.State.RINGING.name());
} else if (response.getStatus() == 200 || response.getStatus() == 202) {
callRecord = callRecord.setStatus(CallStateChanged.State.IN_PROGRESS.name());
callRecord = callRecord.setAnsweredBy(((SipURI) response.getTo().getURI()).getUser());
final DateTime now = DateTime.now();
callRecord = callRecord.setStartTime(now);
} else if (response.getStatus() == 486 || response.getStatus() == 600) {
callRecord = callRecord.setStatus(CallStateChanged.State.BUSY.name());
} else if (response.getStatus() > 400) {
callRecord = callRecord.setStatus(CallStateChanged.State.FAILED.name());
}
} else {
callRecord = callRecord.setStatus(CallStateChanged.State.COMPLETED.name());
final DateTime now = DateTime.now();
callRecord = callRecord.setEndTime(now);
final int seconds = (int) ((DateTime.now().getMillis() - callRecord.getStartTime().getMillis()) / 1000);
callRecord = callRecord.setDuration(seconds);
}
records.updateCallDetailRecord(callRecord);
sendCallInfoStreamEvent(system, linkedRequest, CallStateChanged.State.valueOf(callRecord.getStatus()));
}
}
public static void updateCDR(ActorSystem system, SipServletMessage message, CallStateChanged.State state) {
CallDetailRecordsDao records = daoManager.getCallDetailRecordsDao();
SipServletRequest request = null;
// Update CallDetailRecord
if (message instanceof SipServletResponse) {
request = (SipServletRequest) getLinkedSession(message).getAttribute(B2BUA_LAST_REQUEST);
} else if (message instanceof SipServletRequest) {
request = (SipServletRequest) message;
}
CallDetailRecord callRecord = records.getCallDetailRecord((Sid) request.getSession().getAttribute(CDR_SID));
if (callRecord != null) {
if(logger.isInfoEnabled()) {
logger.info("CDR found! Updating");
}
callRecord = callRecord.setStatus(state.name());
final DateTime now = DateTime.now();
callRecord = callRecord.setEndTime(now);
int seconds;
if (callRecord.getStartTime() != null) {
seconds = (int) (DateTime.now().getMillis() - callRecord.getStartTime().getMillis()) / 1000;
} else {
seconds = 0;
}
callRecord = callRecord.setDuration(seconds);
records.updateCallDetailRecord(callRecord);
sendCallInfoStreamEvent(system, message, state);
}
}
/**
* Check whether a SIP request or response belongs to a peer to peer (B2BUA) session
*
* @param sipMessage
* @return
*/
public static boolean isB2BUASession(SipServletMessage sipMessage) {
SipSession linkedB2BUASession = getLinkedSession(sipMessage);
return (linkedB2BUASession != null);
}
private static Map getCustomHeaders (SipServletMessage message, String prefix) {
Map customHeaders = new HashMap<>();
Iterator headersIter = message.getHeaderNames();
while (headersIter.hasNext()) {
String header = headersIter.next();
if (header.toUpperCase().startsWith(prefix)) {
customHeaders.put(header, message.getHeader(header).toString());
}
}
return customHeaders;
}
/**
* Method adds custom headers to a SipServlet message
* @param message
* @param customHeaders
*/
private static void addHeadersToMessage(SipServletMessage message, Map customHeaders) {
for (Map.Entry entry: customHeaders.entrySet()) {
String headerName = entry.getKey();
String headerVal = entry.getValue();
message.addHeader(headerName, headerVal);
}
}
/**
* Modify Messages with new headers and header attributes
* Moved from CallManager and Call
*
* The method deals with custom and standard headers, such as R-URI, Route etc
*
* TODO: refactor/rename/handle more specific headers
* @param sipFactory SipFactory
* @param message
* @param headers
*/
public static void addHeadersToMessage(SipServletRequest message, Map> headers, SipFactory sipFactory) {
if (headers != null && sipFactory != null) {
for (Map.Entry> entry : headers.entrySet()) {
//check if header exists
String headerName = entry.getKey();
if (logger.isDebugEnabled()) {
logger.debug("headerName=" + headerName + " headerVal=" + message.getHeader(headerName));
}
if(headerName.equalsIgnoreCase("Request-URI")) {
//handle Request-URI
javax.servlet.sip.URI reqURI = message.getRequestURI();
if(logger.isDebugEnabled()) {
logger.debug("ReqURI="+reqURI.toString()+" msgReqURI="+message.getRequestURI());
}
for(String keyValPair :entry.getValue()){
String parName = "";
String parVal = "";
int equalsPos = keyValPair.indexOf("=");
parName = keyValPair.substring(0, equalsPos);
parVal = keyValPair.substring(equalsPos+1);
reqURI.setParameter(parName, parVal);
if(logger.isDebugEnabled()) {
logger.debug("ReqURI pars ="+parName+"="+parVal+" equalsPos="+equalsPos+" keyValPair="+keyValPair);
}
}
message.setRequestURI(reqURI);
if(logger.isDebugEnabled()) {
logger.debug("ReqURI="+reqURI.toString()+" msgReqURI="+message.getRequestURI());
}
} else if( headerName.equalsIgnoreCase("Route") ){
//handle Route
String headerVal = message.getHeader(headerName);
//TODO: do we want to add arbitrary parameters?
if(logger.isDebugEnabled()) {
logger.debug("ROUTE: "+headerName + "=" + headerVal);
}
//check how many pairs of host +port
for(String keyValPair :entry.getValue()){
String parName = "";
String parVal = "";
int equalsPos = keyValPair.indexOf("=");
if(equalsPos>0){
parName = keyValPair.substring(0, equalsPos);
}
parVal = keyValPair.substring(equalsPos+1);
if (parName.isEmpty() || parName.equalsIgnoreCase("host_name")) {
try {
if(logger.isDebugEnabled()) {
logger.debug("adding ROUTE parVal =" + parVal);
}
final SipURI uri = sipFactory.createSipURI(null, parVal);
message.pushRoute((SipURI)uri);
if(logger.isDebugEnabled()) {
logger.debug("added ROUTE parVal =" + uri.toString());
}
} catch (Exception e) {
if(logger.isDebugEnabled()) {
logger.debug("error adding ROUTE uri ="
+ parVal);
}
}
}
if(logger.isDebugEnabled()) {
logger.debug("ROUTE pars ="+parName+"="+parVal+" equalsPos="+equalsPos+" keyValPair="+keyValPair);
}
}
} else {
StringBuilder sb = new StringBuilder();
try {
String headerVal = message.getHeader(headerName);
if (headerVal != null && !headerVal.isEmpty()) {
if (entry.getValue() instanceof ArrayList) {
for (String pair : entry.getValue()) {
sb.append(";").append(pair);
}
}
message.setHeader(headerName,
headerVal + sb.toString());
} else {
if (entry.getValue() instanceof ArrayList) {
for (String pair : entry.getValue()) {
sb.append(pair).append(";");
}
}
message.addHeader(headerName, sb.toString());
}
} catch (IllegalArgumentException iae) {
logger.error("Exception while setting message header: "
+ iae.getMessage());
}
}
if (logger.isDebugEnabled()) {
logger.debug("headerName=" + headerName + " headerVal=" + message.getHeader(headerName));
}
}
} else {
logger.error("headers are null");
}
}
private static void sendCallInfoStreamEvent(ActorSystem system, SipServletMessage message, CallStateChanged.State state) {
SipSession session = message.getSession();
Object sid = session.getAttribute(CDR_SID);
if (sid != null) {
CallInfo callInfo = new CallInfo(
(Sid) sid,
(Sid) session.getAttribute(CDR_ACCOUNT_SID),
state,
null,
(String) session.getAttribute(CDR_DIRECTION),
null,
null,
null,
(String) session.getAttribute(CDR_FROM),
(String) session.getAttribute(CDR_TO),
null, null, false, false, false, null, null
);
system.eventStream().publish(new CallInfoStreamEvent(callInfo));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy