aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/plugin/otr/OtrContactManager.java
blob: f2a6e43151c099a00188c068d5325473c59cde1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.plugin.otr;

import java.util.*;
import java.util.concurrent.*;

import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.util.*;

import org.osgi.framework.*;

/**
 * The OtrContactManager is used for accessing <tt>OtrContact</tt>s in a static
 * way.
 * 
 * The <tt>OtrContact</tt> class is just a wrapper of [Contact, ContactResource]
 * pairs. Its purpose is for the otr plugin to be able to create different
 * <tt>Session</tt>s for every ContactResource that a Contact has.
 * 
 * Currently, only the Jabber protocol supports ContactResources.
 * 
 * @author Marin Dzhigarov
 *
 */
public class OtrContactManager implements ServiceListener
{

    /**
     * The logger
     */
    private final Logger logger = Logger.getLogger(OtrContactManager.class);

    /**
     * A map that caches OtrContacts to minimize memory usage.
     */
    private static final Map<Contact, List<OtrContact>> contactsMap =
        new ConcurrentHashMap<Contact, List<OtrContact>>();

    /**
     * The <tt>OtrContact</tt> class is just a wrapper of
     * [Contact, ContactResource] pairs. Its purpose is for the otr plugin to be
     * able to create different <tt>Session</tt>s for every ContactResource that
     * a Contact has.
     * 
     * @author Marin Dzhigarov
     *
     */
    public static class OtrContact
    {
        public final Contact contact;

        public final ContactResource resource;

        private OtrContact(Contact contact, ContactResource resource)
        {
            this.contact = contact;
            this.resource = resource;
        }

        public boolean equals(Object obj)
        {
            if (this == obj)
                return true;

            if (!(obj instanceof OtrContact))
                return false;

            OtrContact other = (OtrContact) obj;

            if (this.contact != null && this.contact.equals(other.contact))
            {
                if (this.resource != null && resource.equals(other.resource))
                    return true;
                if (this.resource == null && other.resource == null)
                    return true;
                return false;
            }
            return false;
        }

        public int hashCode()
        {
            int result = 17;

            result = 31 * result + (contact == null ? 0 : contact.hashCode());
            result = 31 * result + (resource == null ? 0 : resource.hashCode());

            return result;
        }
    }

    /**
     * Gets the <tt>OtrContact</tt> that represents this
     * [Contact, ContactResource] pair from the cache. If such pair does not
     * still exist it is then created and cached for further usage.
     * 
     * @param contact the <tt>Contact</tt> that the returned OtrContact
     *                  represents.
     * @param resource the <tt>ContactResource</tt> that the returned OtrContact
     *                  represents.
     * @return The <tt>OtrContact</tt> that represents this
     *                  [Contact, ContactResource] pair.
     */
    public static OtrContact getOtrContact(
        Contact contact, ContactResource resource)
    {
        if (contact == null)
            return null;

        List<OtrContact> otrContactsList = contactsMap.get(contact);
        if (otrContactsList != null)
        {
            for (OtrContact otrContact : otrContactsList)
            {
                if (resource != null && resource.equals(otrContact.resource))
                    return otrContact;
            }
            OtrContact otrContact = new OtrContact(contact, resource);
            synchronized (otrContactsList)
            {
                while (!otrContactsList.contains(otrContact))
                    otrContactsList.add(otrContact);
            }
            return otrContact;
        }
        else
        {
            synchronized (contactsMap)
            {
                while (!contactsMap.containsKey(contact))
                {
                    otrContactsList = new ArrayList<OtrContact>();
                    contactsMap.put(contact, otrContactsList);
                }
            }
            return getOtrContact(contact, resource);
        }
    }

    /**
     * Cleans up unused cached up Contacts.
     */
    public void serviceChanged(ServiceEvent event)
    {
        Object service
            = OtrActivator.bundleContext.getService(event.getServiceReference());

        if (!(service instanceof ProtocolProviderService))
            return;
    
        if (event.getType() == ServiceEvent.UNREGISTERING)
        {
            if (logger.isDebugEnabled())
            {
                logger.debug(
                        "Unregistering a ProtocolProviderService, cleaning"
                            + " OTR's Contact to OtrContact map");
            }

            ProtocolProviderService provider
                = (ProtocolProviderService) service;
    
            synchronized(contactsMap)
            {
                Iterator<Contact> i = contactsMap.keySet().iterator();
    
                while (i.hasNext())
                {
                    if (provider.equals(i.next().getProtocolProvider()))
                        i.remove();
                }
            }
        }
    }
}