UserManager.java 20 KB
Newer Older
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision: 1217 $
 * $Date: 2005-04-11 18:11:06 -0300 (Mon, 11 Apr 2005) $
 *
6
 * Copyright (C) 2004-2008 Jive Software. All rights reserved.
7
 *
8 9 10 11 12 13 14 15 16 17 18
 * 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.
19 20
 */

21
package org.jivesoftware.openfire.user;
22

23 24 25
import gnu.inet.encoding.Stringprep;
import gnu.inet.encoding.StringprepException;

26 27 28 29 30 31
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

32
import org.dom4j.Element;
33 34
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.event.UserEventDispatcher;
35
import org.jivesoftware.openfire.event.UserEventListener;
36 37 38 39 40
import org.jivesoftware.util.ClassUtils;
import org.jivesoftware.util.JiveGlobals;
import org.jivesoftware.util.PropertyEventDispatcher;
import org.jivesoftware.util.PropertyEventListener;
import org.jivesoftware.util.StringUtils;
41
import org.jivesoftware.util.cache.Cache;
42
import org.jivesoftware.util.cache.CacheFactory;
43 44
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
45
import org.xmpp.component.IQResultListener;
46 47
import org.xmpp.packet.IQ;
import org.xmpp.packet.JID;
48 49 50 51 52 53 54

/**
 * Manages users, including loading, creating and deleting.
 *
 * @author Matt Tucker
 * @see User
 */
55
public class UserManager implements IQResultListener {
56

57 58
	private static final Logger Log = LoggerFactory.getLogger(UserManager.class);

59 60 61 62 63
    // Wrap this guy up so we can mock out the UserManager class.
    private static class UserManagerContainer {
        private static UserManager instance = new UserManager();
    }

64
    /**
65 66 67 68 69 70
     * Returns the currently-installed UserProvider. <b>Warning:</b> in virtually all
     * cases the user provider should not be used directly. Instead, the appropriate
     * methods in UserManager should be called. Direct access to the user provider is
     * only provided for special-case logic.
     *
     * @return the current UserProvider.
71
     */
72 73 74 75
    public static UserProvider getUserProvider() {
        return UserManagerContainer.instance.provider;
    }

76
    /**
77 78 79
     * Returns a singleton UserManager instance.
     *
     * @return a UserManager instance.
80
     */
81 82 83 84 85 86 87 88 89
    public static UserManager getInstance() {
        return UserManagerContainer.instance;
    }

    /** Cache of local users. */
    private Cache<String, User> userCache;
    /** Cache if a local or remote user exists. */
    private Cache<String, Boolean> remoteUsersCache;
    private UserProvider provider;
90

91
    private UserManager() {
92
        // Initialize caches.
93
        userCache = CacheFactory.createCache("User");
Gaston Dombiak's avatar
Gaston Dombiak committed
94
        remoteUsersCache = CacheFactory.createCache("Remote Users Existence");
95

96
        // Load a user provider.
97 98 99 100
        initProvider();

        // Detect when a new auth provider class is set
        PropertyEventListener propListener = new PropertyEventListener() {
101
            @Override
102
            public void propertySet(String property, Map params) {
103 104 105
                if ("provider.user.className".equals(property)) {
                    initProvider();
                }
106 107
            }

108
            @Override
109 110 111 112
            public void propertyDeleted(String property, Map params) {
                //Ignore
            }

113
            @Override
114
            public void xmlPropertySet(String property, Map params) {
115
                //Ignore
116 117
            }

118
            @Override
119 120 121 122 123
            public void xmlPropertyDeleted(String property, Map params) {
                //Ignore
            }
        };
        PropertyEventDispatcher.addListener(propListener);
124 125

        UserEventListener userListener = new UserEventListener() {
126
            @Override
127
            public void userCreated(User user, Map<String, Object> params) {
128 129
                // Since the user could be created by the provider, add it possible again
                userCache.put(user.getUsername(), user);
130 131
            }

132
            @Override
133
            public void userDeleting(User user, Map<String, Object> params) {
134 135
                // Since the user could be deleted by the provider, remove it possible again
                userCache.remove(user.getUsername());
136 137
            }

138
            @Override
139 140 141 142 143 144 145
            public void userModified(User user, Map<String, Object> params) {
                // Set object again in cache. This is done so that other cluster nodes
                // get refreshed with latest version of the user
                userCache.put(user.getUsername(), user);
            }
        };
        UserEventDispatcher.addListener(userListener);
146 147 148 149
    }

    /**
     * Creates a new User. Required values are username and password. The email address
150 151
     * and name can optionally be <tt>null</tt>, unless the UserProvider deems that
     * either of them are required.
152 153 154
     *
     * @param username the new and unique username for the account.
     * @param password the password for the account (plain text).
155 156
     * @param name the name of the user, which can be <tt>null</tt> unless the UserProvider
     *      deems that it's required.
157
     * @param email the email address to associate with the new account, which can
158
     *      be <tt>null</tt>, unless the UserProvider deems that it's required.
159 160 161 162 163 164 165 166 167 168 169
     * @return a new User.
     * @throws UserAlreadyExistsException if the username already exists in the system.
     * @throws UnsupportedOperationException if the provider does not support the
     *      operation.
     */
    public User createUser(String username, String password, String name, String email)
            throws UserAlreadyExistsException
    {
        if (provider.isReadOnly()) {
            throw new UnsupportedOperationException("User provider is read-only.");
        }
170 171 172 173 174 175
        if (username == null || username.isEmpty()) {
            throw new IllegalArgumentException("Null or empty username.");
        }
        if (password == null || password.isEmpty()) {
            throw new IllegalArgumentException("Null or empty password.");
        }
176 177 178 179 180 181 182
        // Make sure that the username is valid.
        try {
            username = Stringprep.nodeprep(username);
        }
        catch (StringprepException se) {
            throw new IllegalArgumentException("Invalid username: " + username,  se);
        }
183
        if (provider.isNameRequired() && (name == null || name.matches("\\s*"))) {
184 185
            throw new IllegalArgumentException("Invalid or empty name specified with provider that requires name. User: "
                                                + username + " Name: " + name);
186 187
        }
        if (provider.isEmailRequired() && !StringUtils.isValidEmailAddress(email)) {
188 189
            throw new IllegalArgumentException("Invalid or empty email address specified with provider that requires email address. User: "
                                                + username + " Email: " + email);
190
        }
191 192 193 194
        User user = provider.createUser(username, password, name, email);
        userCache.put(username, user);

        // Fire event.
195 196
        Map<String,Object> params = Collections.emptyMap();
        UserEventDispatcher.dispatchEvent(user, UserEventDispatcher.EventType.user_created, params);
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

        return user;
    }

    /**
     * Deletes a user (optional operation).
     *
     * @param user the user to delete.
     */
    public void deleteUser(User user) {
        if (provider.isReadOnly()) {
            throw new UnsupportedOperationException("User provider is read-only.");
        }

        String username = user.getUsername();
        // Make sure that the username is valid.
        try {
God Ly's avatar
God Ly committed
214
            /*username =*/ Stringprep.nodeprep(username);
215 216 217 218 219 220
        }
        catch (StringprepException se) {
            throw new IllegalArgumentException("Invalid username: " + username,  se);
        }

        // Fire event.
221 222
        Map<String,Object> params = Collections.emptyMap();
        UserEventDispatcher.dispatchEvent(user, UserEventDispatcher.EventType.user_deleting, params);
223 224 225 226 227 228 229 230 231 232 233 234 235 236

        provider.deleteUser(user.getUsername());
        // Remove the user from cache.
        userCache.remove(user.getUsername());
    }

    /**
     * Returns the User specified by username.
     *
     * @param username the username of the user.
     * @return the User that matches <tt>username</tt>.
     * @throws UserNotFoundException if the user does not exist.
     */
    public User getUser(String username) throws UserNotFoundException {
237 238 239
        if (username == null) {
            throw new UserNotFoundException("Username cannot be null");
        }
240 241
        // Make sure that the username is valid.
        username = username.trim().toLowerCase();
242
        User user = userCache.get(username);
243
        if (user == null) {
244 245
            synchronized (username.intern()) {
                user = userCache.get(username);
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
                if (user == null) {
                    user = provider.loadUser(username);
                    userCache.put(username, user);
                }
            }
        }
        return user;
    }

    /**
     * Returns the total number of users in the system.
     *
     * @return the total number of users.
     */
    public int getUserCount() {
        return provider.getUserCount();
    }

    /**
     * Returns an unmodifiable Collection of all users in the system.
     *
     * @return an unmodifiable Collection of all users.
     */
    public Collection<User> getUsers() {
        return provider.getUsers();
    }

273 274 275 276 277 278 279 280 281
    /**
     * Returns an unmodifiable Collection of usernames of all users in the system.
     *
     * @return an unmodifiable Collection of all usernames in the system.
     */
    public Collection<String> getUsernames() {
        return provider.getUsernames();
    }

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    /**
     * Returns an unmodifiable Collection of all users starting at <tt>startIndex</tt>
     * with the given number of results. This is useful to support pagination in a GUI
     * where you may only want to display a certain number of results per page. It is
     * possible that the number of results returned will be less than that specified
     * by <tt>numResults</tt> if <tt>numResults</tt> is greater than the number of
     * records left to display.
     *
     * @param startIndex the beginning index to start the results at.
     * @param numResults the total number of results to return.
     * @return a Collection of users in the specified range.
     */
    public Collection<User> getUsers(int startIndex, int numResults) {
        return provider.getUsers(startIndex, numResults);
    }

    /**
     * Returns the set of fields that can be used for searching for users. Each field
     * returned must support wild-card and keyword searching. For example, an
     * implementation might send back the set {"Username", "Name", "Email"}. Any of
     * those three fields can then be used in a search with the
     * {@link #findUsers(Set,String)} method.<p>
     *
     * This method should throw an UnsupportedOperationException if this
     * operation is not supported by the backend user store.
     *
     * @return the valid search fields.
     * @throws UnsupportedOperationException if the provider does not
     *      support the operation (this is an optional operation).
     */
    public Set<String> getSearchFields() throws UnsupportedOperationException {
        return provider.getSearchFields();
    }

    /**
Matt Tucker's avatar
Matt Tucker committed
317
     * Searches for users based on a set of fields and a query string. The fields must
318 319 320 321
     * be taken from the values returned by {@link #getSearchFields()}. The query can
     * include wildcards. For example, a search on the field "Name" with a query of "Ma*"
     * might return user's with the name "Matt", "Martha" and "Madeline".<p>
     *
Matt Tucker's avatar
Matt Tucker committed
322 323
     * This method throws an UnsupportedOperationException if this operation is
     * not supported by the user provider.
324 325 326 327 328 329 330 331 332 333 334 335
     *
     * @param fields the fields to search on.
     * @param query the query string.
     * @return a Collection of users that match the search.
     * @throws UnsupportedOperationException if the provider does not
     *      support the operation (this is an optional operation).
     */
    public Collection<User> findUsers(Set<String> fields, String query)
            throws UnsupportedOperationException
    {
        return provider.findUsers(fields, query);
    }
336

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    /**
     * Searches for users based on a set of fields and a query string. The fields must
     * be taken from the values returned by {@link #getSearchFields()}. The query can
     * include wildcards. For example, a search on the field "Name" with a query of "Ma*"
     * might return user's with the name "Matt", "Martha" and "Madeline".<p>
     *
     * The startIndex and numResults parameters are used to page through search
     * results. For example, if the startIndex is 0 and numResults is 10, the first
     * 10 search results will be returned. Note that numResults is a request for the
     * number of results to return and that the actual number of results returned
     * may be fewer.<p>
     *
     * This method should throw an UnsupportedOperationException if this
     * operation is not supported by the backend user store.
     *
     * @param fields the fields to search on.
     * @param query the query string.
     * @param startIndex the starting index in the search result to return.
     * @param numResults the number of users to return in the search result.
     * @return a Collection of users that match the search.
     * @throws UnsupportedOperationException if the provider does not
     *      support the operation (this is an optional operation).
     */
    public Collection<User> findUsers(Set<String> fields, String query, int startIndex,
            int numResults)
            throws UnsupportedOperationException
    {
        return provider.findUsers(fields, query, startIndex, numResults);
    }

367 368 369 370 371 372 373
    /**
     * Returns true if the specified local username belongs to a registered local user.
     *
     * @param username to username of the user to check it it's a registered user.
     * @return true if the specified JID belongs to a local registered user.
     */
    public boolean isRegisteredUser(String username) {
374 375 376
        if (username == null || "".equals(username)) {
            return false;
        }
377 378 379 380 381 382
        try {
            getUser(username);
            return true;
        }
        catch (UserNotFoundException e) {
            return false;
383 384 385 386 387 388 389 390 391 392 393 394 395 396
        }
    }

    /**
     * Returns true if the specified JID belongs to a local or remote registered user. For
     * remote users (i.e. domain does not match local domain) a disco#info request is going
     * to be sent to the bare JID of the user.
     *
     * @param user to JID of the user to check it it's a registered user.
     * @return true if the specified JID belongs to a local or remote registered user.
     */
    public boolean isRegisteredUser(JID user) {
        XMPPServer server = XMPPServer.getInstance();
        if (server.isLocal(user)) {
397 398 399 400 401 402 403
            try {
                getUser(user.getNode());
                return true;
            }
            catch (UserNotFoundException e) {
                return false;
            }
404 405 406
        }
        else {
            // Look up in the cache using the full JID
407
            Boolean isRegistered = remoteUsersCache.get(user.toString());
408 409
            if (isRegistered == null) {
                // Check if the bare JID of the user is cached
410 411 412 413 414 415
                isRegistered = remoteUsersCache.get(user.toBareJID());
                if (isRegistered == null) {
                    // No information is cached so check user identity and cache it
                    // A disco#info is going to be sent to the bare JID of the user. This packet
                    // is going to be handled by the remote server.
                    IQ iq = new IQ(IQ.Type.get);
416
                    iq.setFrom(server.getServerInfo().getXMPPDomain());
417 418 419 420 421 422 423
                    iq.setTo(user.toBareJID());
                    iq.setChildElement("query", "http://jabber.org/protocol/disco#info");
                    // Send the disco#info request to the remote server. The reply will be
                    // processed by the IQResultListener (interface that this class implements)
                    server.getIQRouter().addIQResultListener(iq.getID(), this);
                    synchronized (user.toBareJID().intern()) {
                        server.getIQRouter().route(iq);
424
                        // Wait for the reply to be processed. Time out in 1 minute.
425
                        try {
426
                            user.toBareJID().intern().wait(60000);
427 428 429 430
                        }
                        catch (InterruptedException e) {
                            // Do nothing
                        }
431
                    }
432 433 434 435 436 437 438
                    // Get the discovered result
                    isRegistered = remoteUsersCache.get(user.toBareJID());
                    if (isRegistered == null) {
                        // Disco failed for some reason (i.e. we timed out before getting a result)
                        // so assume that user is not anonymous and cache result
                        isRegistered = Boolean.FALSE;
                        remoteUsersCache.put(user.toString(), isRegistered);
439
                    }
440 441
                }
            }
442
            return isRegistered;
443 444 445
        }
    }

446
    @Override
447 448 449 450 451 452 453
    public void receivedAnswer(IQ packet) {
        JID from = packet.getFrom();
        // Assume that the user is not a registered user
        Boolean isRegistered = Boolean.FALSE;
        // Analyze the disco result packet
        if (IQ.Type.result == packet.getType()) {
            Element child = packet.getChildElement();
454 455 456 457 458 459 460 461
            if (child != null) {
                for (Iterator it=child.elementIterator("identity"); it.hasNext();) {
                    Element identity = (Element) it.next();
                    String accountType = identity.attributeValue("type");
                    if ("registered".equals(accountType) || "admin".equals(accountType)) {
                        isRegistered = Boolean.TRUE;
                        break;
                    }
462 463 464 465
                }
            }
        }
        // Update cache of remote registered users
466
        remoteUsersCache.put(from.toBareJID(), isRegistered);
467 468 469 470 471 472

        // Wake up waiting thread
        synchronized (from.toBareJID().intern()) {
            from.toBareJID().intern().notifyAll();
        }
    }
473

474
    @Override
475 476 477 478
    public void answerTimeout(String packetId) {
        Log.warn("An answer to a previously sent IQ stanza was never received. Packet id: " + packetId);
    }

479
    private void initProvider() {
480 481 482 483
        // Convert XML based provider setup to Database based
        JiveGlobals.migrateProperty("provider.user.className");

        String className = JiveGlobals.getProperty("provider.user.className",
484
                "org.jivesoftware.openfire.user.DefaultUserProvider");
485 486 487 488 489 490 491 492 493 494 495 496
        // Check if we need to reset the provider class
        if (provider == null || !className.equals(provider.getClass().getName())) {
            try {
                Class c = ClassUtils.forName(className);
                provider = (UserProvider) c.newInstance();
            }
            catch (Exception e) {
                Log.error("Error loading user provider: " + className, e);
                provider = new DefaultUserProvider();
            }
        }
    }
497
}