Adds support for draft-saintandre-impp-call-info and improves the avatar

and display name retrieval in outgoing calls and in calls in general.

2 files changed, 622 insertions, 0 deletions

diff --git a/src/net/java/sip/communicator/util/call/ContactPhoneUtil.java b/src/net/java/sip/communicator/util/call/ContactPhoneUtil.java
new file mode 100644
index 0000000..9a20f1b
--- /dev/null
+++ b/src/net/java/sip/communicator/util/call/ContactPhoneUtil.java
@@ -0,0 +1,148 @@
+/*
+ * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
+package net.java.sip.communicator.util.call;
+
+import java.util.*;
+
+import net.java.sip.communicator.service.protocol.*;
+import net.java.sip.communicator.service.protocol.OperationSetServerStoredContactInfo.*;
+import net.java.sip.communicator.service.protocol.ServerStoredDetails.*;
+import net.java.sip.communicator.util.*;
+
+/**
+ * Utility class used to check if there is a telephony service, video calls and
+ * desktop sharing enabled for a protocol specific <tt>Contact</tt>.
+ *
+ * @author Yana Stamcheva
+ */
+public class ContactPhoneUtil
+{
+    /**
+     * The logger for this class.
+     */
+    private static  final Logger logger
+        = Logger.getLogger(ContactPhoneUtil.class);
+
+    /**
+     * Searches for phones for the contact.
+     * Return null if we have stopped searching and a listener is available
+     * and will be used to inform for results.
+     * @param contact the contact to check.
+     * @param listener the <tt>DetailsResponseListener</tt> if we're interested
+     * in obtaining results that came later
+     * @param onlyVideo whether to include only video phones.
+     * @param localized whether to localize phones.
+     * @return list of phones, or null if we will use the listeners
+     * for the result.
+     */
+    public static List<String> getContactAdditionalPhones(
+                                            Contact contact,
+                                            DetailsResponseListener listener,
+                                            boolean onlyVideo,
+                                            boolean localized)
+    {
+        OperationSetServerStoredContactInfo infoOpSet =
+            contact.getProtocolProvider().getOperationSet(
+                OperationSetServerStoredContactInfo.class);
+        Iterator<GenericDetail> details;
+        ArrayList<String> phonesList = new ArrayList<String>();
+
+        if(infoOpSet != null)
+        {
+            try
+            {
+                if(listener != null)
+                {
+                    details = infoOpSet.requestAllDetailsForContact(
+                        contact, listener);
+
+                    if(details == null)
+                        return null;
+                }
+                else
+                {
+                    details = infoOpSet.getAllDetailsForContact(contact);
+                }
+
+                ArrayList<String> phoneNumbers = new ArrayList<String>();
+                while(details.hasNext())
+                {
+                    GenericDetail d = details.next();
+
+                    if(d instanceof PhoneNumberDetail &&
+                        !(d instanceof PagerDetail) &&
+                        !(d instanceof FaxDetail))
+                    {
+                        PhoneNumberDetail pnd = (PhoneNumberDetail)d;
+                        String number = pnd.getNumber();
+                        if(number != null &&
+                            number.length() > 0)
+                        {
+                            if(!(d instanceof VideoDetail) && onlyVideo)
+                                continue;
+
+                            // skip duplicate numbers
+                            if(phoneNumbers.contains(number))
+                                continue;
+
+                            phoneNumbers.add(number);
+
+                            if(!localized)
+                            {
+                                phonesList.add(number);
+                                continue;
+                            }
+
+                            phonesList.add(number
+                                + " (" + getLocalizedPhoneNumber(d) + ")");
+                        }
+                    }
+                }
+            }
+            catch(Throwable t)
+            {
+                logger.error("Error obtaining server stored contact info");
+            }
+        }
+
+        return phonesList;
+    }
+
+    /**
+     * Returns localized phone number.
+     *
+     * @param d the detail.
+     * @return the localized phone number.
+     */
+    protected static String getLocalizedPhoneNumber(GenericDetail d)
+    {
+        if(d instanceof WorkPhoneDetail)
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.WORK_PHONE");
+        }
+        else if(d instanceof MobilePhoneDetail)
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.MOBILE_PHONE");
+        }
+        else if(d instanceof VideoDetail)
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.VIDEO_PHONE");
+        }
+        else
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.HOME");
+        }
+    }
+}
diff --git a/src/net/java/sip/communicator/util/call/MetaContactPhoneUtil.java b/src/net/java/sip/communicator/util/call/MetaContactPhoneUtil.java
new file mode 100644
index 0000000..11bbd09
--- /dev/null
+++ b/src/net/java/sip/communicator/util/call/MetaContactPhoneUtil.java
@@ -0,0 +1,474 @@
+/*
+ * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
+package net.java.sip.communicator.util.call;
+
+import net.java.sip.communicator.service.contactlist.*;
+import net.java.sip.communicator.service.protocol.*;
+import net.java.sip.communicator.service.protocol.OperationSetServerStoredContactInfo.*;
+import net.java.sip.communicator.service.protocol.ServerStoredDetails.*;
+import net.java.sip.communicator.util.*;
+import net.java.sip.communicator.util.account.*;
+
+import java.util.*;
+
+/**
+ * Utility class used to check if there is a telephony service, video calls and
+ * desktop sharing enabled for a protocol specific <tt>MetaContact</tt>.
+ *
+ * @author Damian Minkov
+ * @author Yana Stamcheva
+ */
+public class MetaContactPhoneUtil
+{
+    /**
+     * The <tt>Logger</tt> used by the <tt>CallManager</tt> class and its
+     * instances for logging output.
+     */
+    private static final Logger logger
+        = Logger.getLogger(MetaContactPhoneUtil.class);
+
+    /**
+     * The metacontcat we are working on.
+     */
+    private MetaContact metaContact;
+
+    /**
+     * The phones that have been discovered for metacontact child contacts.
+     */
+    private Hashtable<Contact,List<String>> phones =
+        new Hashtable<Contact, List<String>>();
+
+    /**
+     * True if there is any phone found for the metacontact.
+     */
+    private boolean hasPhones = false;
+
+    /**
+     * True if there is any video phone found for the metacontact.
+     */
+    private boolean hasVideoDetail = false;
+
+    /**
+     * Is routing for video enabled for any of the contacts of the metacontact.
+     */
+    private boolean routingForVideoEnabled = false;
+
+    /**
+     * Is routing for desktop enabled for any of the contacts of the metacontact.
+     */
+    private boolean routingForDesktopEnabled = false;
+
+    /**
+     * Obtains the util for <tt>metaContact</tt>
+     * @param metaContact the metaconctact.
+     * @return ContactPhoneUtil for the <tt>metaContact</tt>.
+     */
+    public static MetaContactPhoneUtil getPhoneUtil(MetaContact metaContact)
+    {
+        return new MetaContactPhoneUtil(metaContact);
+    }
+
+    /**
+     * Creates utility instance for <tt>metaContact</tt>.
+     * @param metaContact the metacontact checked in the utility.
+     */
+    protected MetaContactPhoneUtil(MetaContact metaContact)
+    {
+        this.metaContact = metaContact;
+    }
+
+    /**
+     * Returns the metaContact we work on.
+     * @return the metaContact we work on.
+     */
+    public MetaContact getMetaContact()
+    {
+        return metaContact;
+    }
+
+    /**
+     * Returns localized addition phones list for contact, if any.
+     * Return null if we have stopped searching and a listener is available
+     * and will be used to inform for results.
+     * @param contact the contact
+     * @return localized addition phones list for contact, if any.
+     */
+    public List<String> getPhones(Contact contact)
+    {
+        return getPhones(contact, null, true);
+    }
+
+    /**
+     * Returns list of video phones for <tt>contact</tt>, localized.
+     * Return null if we have stopped searching and a listener is available
+     * and will be used to inform for results.
+     * @param contact the contact to check for video phones.
+     * @param listener the <tt>DetailsResponseListener</tt> to listen for result
+     * details
+     * @return list of video phones for <tt>contact</tt>, localized.
+     */
+    public List<String> getVideoPhones( Contact contact,
+                                        DetailsResponseListener listener)
+    {
+        if(!this.metaContact.containsContact(contact))
+        {
+            return new ArrayList<String>();
+        }
+
+        List<String> phonesList = ContactPhoneUtil.getContactAdditionalPhones(
+                contact, listener, true, true);
+
+        if(phonesList == null)
+            return null;
+        else if (phonesList.size() > 0)
+            hasVideoDetail = true;
+
+        return phonesList;
+    }
+
+    /**
+     * List of phones for contact, localized if <tt>localized</tt> is
+     * <tt>true</tt>, and not otherwise.
+     * Return null if we have stopped searching and a listener is available
+     * and will be used to inform for results.
+     * @param contact the contact to check for video phones.
+     * @param listener the <tt>DetailsResponseListener</tt> to listen for result
+     * details
+     * @param localized whether to localize the phones, put a description text.
+     * @return list of phones for contact.
+     */
+    public List<String> getPhones(  Contact contact,
+                                    DetailsResponseListener listener,
+                                    boolean localized)
+    {
+        if(!this.metaContact.containsContact(contact))
+        {
+            return new ArrayList<String>();
+        }
+
+        if(phones.containsKey(contact))
+        {
+            return phones.get(contact);
+        }
+
+        List<String> phonesList
+            = ContactPhoneUtil.getContactAdditionalPhones(
+                contact, listener, false, localized);
+
+        if(phonesList == null)
+            return null;
+        else if (phonesList.size() > 0)
+            hasPhones = true;
+
+        phones.put(contact, phonesList);
+
+        return phonesList;
+    }
+
+    /**
+     * Is video called is enabled for metaContact. If any of the child
+     * contacts has video enabled.
+     *
+     * @param listener the <tt>DetailsResponseListener</tt> to listen for result
+     * details
+     * @return is video called is enabled for metaContact.
+     */
+    public boolean isVideoCallEnabled(DetailsResponseListener listener)
+    {
+        // make sure children are checked
+        if(!checkMetaContactPhones(listener))
+            return false;
+
+        return metaContact.getDefaultContact(
+                    OperationSetVideoTelephony.class) != null
+               || routingForVideoEnabled
+               || hasVideoDetail;
+    }
+
+    /**
+     * Is video called is enabled for metaContact. If any of the child
+     * contacts has video enabled.
+     *
+     * @return is video called is enabled for metaContact.
+     */
+    public boolean isVideoCallEnabled()
+    {
+        return isVideoCallEnabled((DetailsResponseListener) null);
+    }
+
+    /**
+     * Is video call enabled for contact.
+     * @param contact to check for video capabilities.
+     * @return is video call enabled for contact.
+     */
+    public boolean isVideoCallEnabled(Contact contact)
+    {
+        if(!this.metaContact.containsContact(contact))
+            return false;
+
+        // make sure we have checked everything for the contact
+        // before continue
+        if(!checkContactPhones(contact))
+            return false;
+
+        routingForVideoEnabled =
+            ConfigurationUtils
+                .isRouteVideoAndDesktopUsingPhoneNumberEnabled()
+            && phones.contains(contact)
+            && phones.get(contact).size() > 0
+            && AccountUtils.getOpSetRegisteredProviders(
+                OperationSetVideoTelephony.class,
+                null,
+                null).size() > 0;
+
+        return contact.getProtocolProvider().getOperationSet(
+            OperationSetVideoTelephony.class) != null
+                && hasContactCapabilities(contact,
+                        OperationSetVideoTelephony.class)
+                || routingForVideoEnabled;
+    }
+
+    /**
+     * Is desktop sharing enabled for metaContact. If any of the child
+     * contacts has desktop sharing enabled.
+     * @param listener the <tt>DetailsResponseListener</tt> to listen for result
+     * details
+     * @return is desktop share is enabled for metaContact.
+     */
+    public boolean isDesktopSharingEnabled(DetailsResponseListener listener)
+    {
+        // make sure children are checked
+        if(!checkMetaContactPhones(listener))
+            return false;
+
+        return metaContact.getDefaultContact(
+            OperationSetDesktopSharingServer.class) != null
+            || routingForDesktopEnabled
+            || hasVideoDetail;
+    }
+
+    /**
+     * Is desktop sharing enabled for metaContact. If any of the child
+     * contacts has desktop sharing enabled.
+     * @return is desktop share is enabled for metaContact.
+     */
+    public boolean isDesktopSharingEnabled()
+    {
+        return isDesktopSharingEnabled((DetailsResponseListener) null);
+    }
+
+    /**
+     * Is desktop sharing enabled for contact.
+     * @param contact to check for desktop sharing capabilities.
+     * @return is desktop sharing enabled for contact.
+     */
+    public boolean isDesktopSharingEnabled(Contact contact)
+    {
+        if(!this.metaContact.containsContact(contact))
+            return false;
+
+        // make sure we have checked everything for the contact
+        // before continue
+        if(!checkContactPhones(contact))
+            return false;
+
+        routingForDesktopEnabled =
+            ConfigurationUtils
+                .isRouteVideoAndDesktopUsingPhoneNumberEnabled()
+            && phones.contains(contact)
+            && phones.get(contact).size() > 0
+            && AccountUtils.getOpSetRegisteredProviders(
+                    OperationSetDesktopSharingServer.class,
+                    null,
+                    null).size() > 0;
+        return contact.getProtocolProvider().getOperationSet(
+            OperationSetDesktopSharingServer.class) != null
+               && hasContactCapabilities(contact,
+                        OperationSetDesktopSharingServer.class)
+               || routingForDesktopEnabled;
+    }
+
+    /**
+     * Is call enabled for metaContact. If any of the child
+     * contacts has call enabled.
+     * @param listener the <tt>DetailsResponseListener</tt> to listen for result
+     * details
+     * @return is call enabled for metaContact.
+     */
+    public boolean isCallEnabled(DetailsResponseListener listener)
+    {
+        // make sure children are checked
+        if(!checkMetaContactPhones(listener))
+            return false;
+
+        return metaContact.getDefaultContact(
+                    OperationSetBasicTelephony.class) != null
+               || (hasPhones
+                    && AccountUtils.getRegisteredProviders(
+                        OperationSetBasicTelephony.class).size() > 0);
+    }
+
+    /**
+     * Is call enabled for metaContact. If any of the child
+     * contacts has call enabled.
+     * @return is call enabled for metaContact.
+     */
+    public boolean isCallEnabled()
+    {
+        return isCallEnabled((DetailsResponseListener) null);
+    }
+
+    /**
+     * Is call enabled for contact.
+     * @param contact to check for call capabilities.
+     * @return is call enabled for contact.
+     */
+    public boolean isCallEnabled(Contact contact)
+    {
+        if(!checkContactPhones(contact))
+            return false;
+
+        return contact.getProtocolProvider().getOperationSet(
+                        OperationSetBasicTelephony.class) != null
+               && hasContactCapabilities(contact,
+                        OperationSetBasicTelephony.class);
+    }
+
+    /**
+     * Checking all contacts for the metacontact.
+     * Return <tt>false</tt> if there are listeners added for a contact
+     * and we need to stop executions cause listener will be used to be informed
+     * for result.
+     *
+     * @return whether to continue or listeners present and will be informed
+     * for result.
+     */
+    private boolean checkMetaContactPhones()
+    {
+        return checkMetaContactPhones(null);
+    }
+
+    /**
+     * Checking all contacts for the metacontact.
+     * Return <tt>false</tt> if there are listeners added for a contact
+     * and we need to stop executions cause listener will be used to be informed
+     * for result.
+     *
+     * @param l the <tt>DetailsResponseListener</tt> to listen for further
+     * details
+     * @return whether to continue or listeners present and will be informed
+     * for result.
+     */
+    private boolean checkMetaContactPhones(DetailsResponseListener l)
+    {
+        Iterator<Contact> contactIterator = metaContact.getContacts();
+        while(contactIterator.hasNext())
+        {
+            Contact contact = contactIterator.next();
+            if(phones.containsKey(contact))
+                continue;
+
+            List<String> phones = getPhones(contact, l, true);
+            if(phones == null)
+                return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Checking contact for phones.
+     * Return <tt>false</tt> if there are listeners added for the contact
+     * and we need to stop executions cause listener will be used to be informed
+     * for result.
+     *
+     * @return whether to continue or listeners present and will be informed
+     * for result.
+     */
+    private boolean checkContactPhones(Contact contact)
+    {
+        if(!phones.containsKey(contact))
+        {
+            List<String> phones = getPhones(contact);
+            if(phones == null)
+                return false;
+
+            // to check for routingForVideoEnabled prop
+            isVideoCallEnabled(contact);
+            // to check for routingForDesktopEnabled prop
+            isDesktopSharingEnabled(contact);
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns <tt>true</tt> if <tt>Contact</tt> supports the specified
+     * <tt>OperationSet</tt>, <tt>false</tt> otherwise.
+     *
+     * @param contact contact to check
+     * @param opSet <tt>OperationSet</tt> to search for
+     * @return Returns <tt>true</tt> if <tt>Contact</tt> supports the specified
+     * <tt>OperationSet</tt>, <tt>false</tt> otherwise.
+     */
+    private boolean hasContactCapabilities(
+            Contact contact, Class<? extends OperationSet> opSet)
+    {
+        OperationSetContactCapabilities capOpSet =
+            contact.getProtocolProvider().
+                getOperationSet(OperationSetContactCapabilities.class);
+
+        if (capOpSet == null)
+        {
+            // assume contact has OpSet capabilities
+            return true;
+        }
+        else
+        {
+            if(capOpSet.getOperationSet(contact, opSet) != null)
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns localized phone number.
+     *
+     * @param d the detail.
+     * @return the localized phone number.
+     */
+    protected String getLocalizedPhoneNumber(GenericDetail d)
+    {
+        if(d instanceof WorkPhoneDetail)
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.WORK_PHONE");
+        }
+        else if(d instanceof MobilePhoneDetail)
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.MOBILE_PHONE");
+        }
+        else if(d instanceof VideoDetail)
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.VIDEO_PHONE");
+        }
+        else
+        {
+            return UtilActivator.getResources().
+                getI18NString(
+                    "service.gui.HOME");
+        }
+    }
+}