/**
* Removes from the specified list of candidates providers connected to a registrar that does not
* match the IP address that we are receiving a request from.
*
* @param candidates the list of providers we've like to filter.
* @param request the request that we are currently dispatching
*/
private void filterByAddress(List<ProtocolProviderServiceSipImpl> candidates, Request request) {
Iterator<ProtocolProviderServiceSipImpl> iterPP = candidates.iterator();
while (iterPP.hasNext()) {
ProtocolProviderServiceSipImpl candidate = iterPP.next();
if (candidate.getRegistrarConnection() == null) {
// RegistrarLess connections are ok
continue;
}
if (!candidate.getRegistrarConnection().isRegistrarless()
&& !candidate.getRegistrarConnection().isRequestFromSameConnection(request)) {
iterPP.remove();
}
}
}
/**
* Loads the tooltip with the data for current metacontact.
*
* @param tip the tooltip to fill.
*/
private void loadTooltip(final ExtendedTooltip tip) {
Iterator<Contact> i = metaContact.getContacts();
ContactPhoneUtil contactPhoneUtil = ContactPhoneUtil.getPhoneUtil(metaContact);
String statusMessage = null;
Contact protocolContact;
boolean isLoading = false;
while (i.hasNext()) {
protocolContact = i.next();
// Set the first found status message.
if (statusMessage == null
&& protocolContact.getStatusMessage() != null
&& protocolContact.getStatusMessage().length() > 0)
statusMessage = protocolContact.getStatusMessage();
if (ConfigurationUtils.isHideAccountStatusSelectorsEnabled()) break;
ImageIcon protocolStatusIcon =
ImageLoader.getIndexedProtocolIcon(
ImageUtils.getBytesInImage(protocolContact.getPresenceStatus().getStatusIcon()),
protocolContact.getProtocolProvider());
String contactAddress = protocolContact.getAddress();
// String statusMessage = protocolContact.getStatusMessage();
tip.addLine(protocolStatusIcon, contactAddress);
addContactResourceTooltipLines(tip, protocolContact);
if (!protocolContact.getProtocolProvider().isRegistered()) continue;
contactPhoneUtil.addDetailsResponseListener(
protocolContact,
new OperationSetServerStoredContactInfo.DetailsResponseListener() {
public void detailsRetrieved(final Iterator<GenericDetail> details) {
if (!SwingUtilities.isEventDispatchThread()) {
SwingUtilities.invokeLater(
new Runnable() {
public void run() {
detailsRetrieved(details);
}
});
return;
}
// remove previously shown information
// as it contains "Loading..." text
tip.removeAllLines();
// load it again
loadTooltip(tip);
}
});
List<String> phones = contactPhoneUtil.getPhones(protocolContact);
if (phones != null) {
addPhoneTooltipLines(tip, phones.iterator());
} else isLoading = true;
}
if (isLoading)
tip.addLine(null, GuiActivator.getResources().getI18NString("service.gui.LOADING"));
if (statusMessage != null) tip.setBottomText(statusMessage);
}
/**
* Returns an <tt>Iterator</tt> over a list of strings, which can be used to find this contact.
*
* @return an <tt>Iterator</tt> over a list of search strings
*/
public Iterator<String> getSearchStrings() {
return searchStrings.iterator();
}
/**
* Find the <tt>ProtocolProviderServiceSipImpl</tt> (one of our "candidate recipient" listeners)
* which this <tt>request</tt> should be dispatched to. The strategy is to look first at the
* request URI, and then at the To field to find a matching candidate for dispatching. Note that
* this method takes a <tt>Request</tt> as param, and not a <tt>ServerTransaction</tt>, because
* sometimes <tt>RequestEvent</tt>s have no associated <tt>ServerTransaction</tt>.
*
* @param request the <tt>Request</tt> to find a recipient for.
* @return a suitable <tt>ProtocolProviderServiceSipImpl</tt>.
*/
private ProtocolProviderServiceSipImpl findTargetFor(Request request) {
if (request == null) {
logger.error("request shouldn't be null.");
return null;
}
List<ProtocolProviderServiceSipImpl> currentListenersCopy =
new ArrayList<ProtocolProviderServiceSipImpl>(this.getSipListeners());
// Let's first narrow down candidate choice by comparing
// addresses and ports (no point in delivering to a provider with a
// non matching IP address since they will reject it anyway).
filterByAddress(currentListenersCopy, request);
if (currentListenersCopy.size() == 0) {
logger.error("no listeners");
return null;
}
URI requestURI = request.getRequestURI();
if (requestURI.isSipURI()) {
String requestUser = ((SipURI) requestURI).getUser();
List<ProtocolProviderServiceSipImpl> candidates =
new ArrayList<ProtocolProviderServiceSipImpl>();
// check if the Request-URI username is
// one of ours usernames
for (ProtocolProviderServiceSipImpl listener : currentListenersCopy) {
String ourUserID = listener.getAccountID().getUserID();
// logger.trace(ourUserID + " *** " + requestUser);
if (ourUserID.equals(requestUser)) {
if (logger.isTraceEnabled())
logger.trace("suitable candidate found: " + listener.getAccountID());
candidates.add(listener);
}
}
// the perfect match
// every other case is approximation
if (candidates.size() == 1) {
ProtocolProviderServiceSipImpl perfectMatch = candidates.get(0);
if (logger.isTraceEnabled())
logger.trace("Will dispatch to \"" + perfectMatch.getAccountID() + "\"");
return perfectMatch;
}
// more than one account match
if (candidates.size() > 1) {
// check if a custom param exists in the contact
// address (set for registrar accounts)
for (ProtocolProviderServiceSipImpl candidate : candidates) {
String hostValue =
((SipURI) requestURI).getParameter(SipStackSharing.CONTACT_ADDRESS_CUSTOM_PARAM_NAME);
if (hostValue == null) continue;
if (hostValue.equals(candidate.getContactAddressCustomParamValue())) {
if (logger.isTraceEnabled())
logger.trace(
"Will dispatch to \""
+ candidate.getAccountID()
+ "\" because "
+ "\" the custom param was set");
return candidate;
}
}
// Past this point, our guess is not reliable. We try to find
// the "least worst" match based on parameters like the To field
// check if the To header field host part
// matches any of our SIP hosts
for (ProtocolProviderServiceSipImpl candidate : candidates) {
URI fromURI = ((FromHeader) request.getHeader(FromHeader.NAME)).getAddress().getURI();
if (fromURI.isSipURI() == false) continue;
SipURI ourURI = (SipURI) candidate.getOurSipAddress((SipURI) fromURI).getURI();
String ourHost = ourURI.getHost();
URI toURI = ((ToHeader) request.getHeader(ToHeader.NAME)).getAddress().getURI();
if (toURI.isSipURI() == false) continue;
String toHost = ((SipURI) toURI).getHost();
// logger.trace(toHost + "***" + ourHost);
if (toHost.equals(ourHost)) {
if (logger.isTraceEnabled())
logger.trace(
"Will dispatch to \""
+ candidate.getAccountID()
+ "\" because "
+ "host in the To: is the same as in our AOR");
return candidate;
}
}
// fallback on the first candidate
ProtocolProviderServiceSipImpl target = candidates.iterator().next();
logger.info(
"Will randomly dispatch to \""
+ target.getAccountID()
+ "\" because there is ambiguity on the username from"
+ " the Request-URI");
if (logger.isTraceEnabled()) logger.trace("\n" + request);
return target;
}
// fallback on any account
ProtocolProviderServiceSipImpl target = currentListenersCopy.iterator().next();
if (logger.isDebugEnabled())
logger.debug(
"Will randomly dispatch to \""
+ target.getAccountID()
+ "\" because the username in the Request-URI "
+ "is unknown or empty");
if (logger.isTraceEnabled()) logger.trace("\n" + request);
return target;
} else {
logger.error("Request-URI is not a SIP URI, dropping");
}
return null;
}
/**
* Returns an Iterator over all contacts, member of this <tt>ContactGroup</tt>.
*
* @return a java.util.Iterator over all contacts inside this <tt>ContactGroup</tt>
*/
public Iterator<Contact> contacts() {
return contacts.iterator();
}
/**
* Returns an iterator over the sub groups that this <tt>ContactGroup</tt> contains.
*
* @return a java.util.Iterator over the <tt>ContactGroup</tt> children of this group (i.e.
* subgroups).
*/
public Iterator<ContactGroup> subgroups() {
return subGroups.iterator();
}
/**
* Returns an iterator over all status instances supproted by the gibberish provider.
*
* @return an <tt>Iterator</tt> over all status instances supported by the gibberish provider.
*/
static Iterator<PresenceStatus> supportedStatusSet() {
return supportedStatusSet.iterator();
}