RosterItemProvider.java 14.2 KB
Newer Older
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision: 1751 $
 * $Date: 2005-08-07 20:08:47 -0300 (Sun, 07 Aug 2005) $
 *
6
 * Copyright (C) 2005-2008 Jive Software. All rights reserved.
7 8
 *
 * This software is published under the terms of the GNU Public License (GPL),
9 10
 * a copy of which is included in this distribution, or a commercial license
 * agreement with Jive.
11 12
 */

13
package org.jivesoftware.openfire.roster;
14 15 16

import org.jivesoftware.database.DbConnectionManager;
import org.jivesoftware.database.SequenceManager;
17 18
import org.jivesoftware.openfire.user.UserAlreadyExistsException;
import org.jivesoftware.openfire.user.UserNotFoundException;
19 20
import org.jivesoftware.util.JiveConstants;
import org.jivesoftware.util.LocaleUtils;
21
import org.jivesoftware.util.Log;
22 23 24 25 26
import org.xmpp.packet.JID;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
27
import java.sql.SQLException;
28
import java.util.*;
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

/**
 * Defines the provider methods required for creating, reading, updating and deleting roster
 * items.<p>
 *
 * Rosters are another user resource accessed via the user or chatbot's long ID. A user/chatbot
 * may have zero or more roster items and each roster item may have zero or more groups. Each
 * roster item is additionaly keyed on a XMPP jid. In most cases, the entire roster will be read
 * in from memory and manipulated or sent to the user. However some operations will need to retrive
 * specific roster items rather than the entire roster.
 *
 * @author Iain Shigeoka
 */
public class RosterItemProvider {

    private static final String CREATE_ROSTER_ITEM =
45
            "INSERT INTO ofRoster (username, rosterID, jid, sub, ask, recv, nick) " +
46 47
            "VALUES (?, ?, ?, ?, ?, ?, ?)";
    private static final String UPDATE_ROSTER_ITEM =
48
            "UPDATE ofRoster SET sub=?, ask=?, recv=?, nick=? WHERE rosterID=?";
49
    private static final String DELETE_ROSTER_ITEM_GROUPS =
50
            "DELETE FROM ofRosterGroups WHERE rosterID=?";
51
    private static final String CREATE_ROSTER_ITEM_GROUPS =
52
            "INSERT INTO ofRosterGroups (rosterID, rank, groupName) VALUES (?, ?, ?)";
53
    private static final String DELETE_ROSTER_ITEM =
54
            "DELETE FROM ofRoster WHERE rosterID=?";
55
    private static final String LOAD_USERNAMES =
56
            "SELECT DISTINCT username from ofRoster WHERE jid=?";
57
    private static final String COUNT_ROSTER_ITEMS =
58
            "SELECT COUNT(rosterID) FROM ofRoster WHERE username=?";
59
     private static final String LOAD_ROSTER =
60
             "SELECT jid, rosterID, sub, ask, recv, nick FROM ofRoster WHERE username=?";
61
    private static final String LOAD_ROSTER_ITEM_GROUPS =
62
            "SELECT rosterID,groupName FROM ofRosterGroups";
63 64 65 66 67 68 69 70 71 72 73 74 75


    private static RosterItemProvider instance = new RosterItemProvider();

    public static RosterItemProvider getInstance() {
        return instance;
    }

    /**
     * Creates a new roster item for the given user (optional operation).<p>
     *
     * <b>Important!</b> The item passed as a parameter to this method is strictly a convenience
     * for passing all of the data needed for a new roster item. The roster item returned from the
76
     * method will be cached by Openfire. In some cases, the roster item passed in will be passed
77 78 79 80
     * back out. However, if an implementation may return RosterItems as a separate class
     * (for example, a RosterItem that directly accesses the backend storage, or one that is an
     * object in an object database).<p>
     *
Matt Tucker's avatar
Matt Tucker committed
81 82 83 84
     * @param username the username of the user/chatbot that owns the roster item.
     * @param item the settings for the roster item to create.
     * @return the new roster item.
     * @throws UserAlreadyExistsException if a roster item with the username already exists. 
85 86 87 88 89 90 91 92
     */
    public RosterItem createItem(String username, RosterItem item)
            throws UserAlreadyExistsException
    {
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            long rosterID = SequenceManager.nextID(JiveConstants.ROSTER);
93
            con = DbConnectionManager.getConnection();
94 95 96 97 98 99 100 101 102 103 104 105 106 107
            pstmt = con.prepareStatement(CREATE_ROSTER_ITEM);
            pstmt.setString(1, username);
            pstmt.setLong(2, rosterID);
            pstmt.setString(3, item.getJid().toBareJID());
            pstmt.setInt(4, item.getSubStatus().getValue());
            pstmt.setInt(5, item.getAskStatus().getValue());
            pstmt.setInt(6, item.getRecvStatus().getValue());
            pstmt.setString(7, item.getNickname());
            pstmt.executeUpdate();

            item.setID(rosterID);
            insertGroups(rosterID, item.getGroups().iterator(), con);
        }
        catch (SQLException e) {
108
            Log.warn("Error trying to insert a new row in ofRoster", e);
109 110 111
            throw new UserAlreadyExistsException(item.getJid().toBareJID());
        }
        finally {
Matt Tucker's avatar
Matt Tucker committed
112
            DbConnectionManager.closeConnection(pstmt, con);
113 114 115 116 117 118 119 120
        }
        return item;
    }

    /**
     * Update the roster item in storage with the information contained in the given item
     * (optional operation).<p>
     *
121
     * If you don't want roster items edited through openfire, throw UnsupportedOperationException.
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
     *
     * @param username the username of the user/chatbot that owns the roster item
     * @param item   The roster item to update
     * @throws UserNotFoundException If no entry could be found to update
     */
    public void updateItem(String username, RosterItem item) throws UserNotFoundException {
        Connection con = null;
        PreparedStatement pstmt = null;
        long rosterID = item.getID();
        try {
            con = DbConnectionManager.getConnection();
            // Update existing roster item
            pstmt = con.prepareStatement(UPDATE_ROSTER_ITEM);
            pstmt.setInt(1, item.getSubStatus().getValue());
            pstmt.setInt(2, item.getAskStatus().getValue());
            pstmt.setInt(3, item.getRecvStatus().getValue());
            pstmt.setString(4, item.getNickname());
            pstmt.setLong(5, rosterID);
            pstmt.executeUpdate();
            // Close now the statement (do not wait to be GC'ed)
            pstmt.close();

            // Delete old group list
            pstmt = con.prepareStatement(DELETE_ROSTER_ITEM_GROUPS);
            pstmt.setLong(1, rosterID);
            pstmt.executeUpdate();

            insertGroups(rosterID, item.getGroups().iterator(), con);
        }
        catch (SQLException e) {
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
        finally {
Matt Tucker's avatar
Matt Tucker committed
155
            DbConnectionManager.closeConnection(pstmt, con);
156 157 158 159 160 161
        }
    }

    /**
     * Delete the roster item with the given itemJID for the user (optional operation).<p>
     *
162
     * If you don't want roster items deleted through openfire, throw
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
     * UnsupportedOperationException.
     *
     * @param username the long ID of the user/chatbot that owns the roster item
     * @param rosterItemID The roster item to delete
     */
    public void deleteItem(String username, long rosterItemID) {
        // Only try to remove the user if they exist in the roster already:
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            con = DbConnectionManager.getConnection();
            // Remove roster groups
            pstmt = con.prepareStatement(DELETE_ROSTER_ITEM_GROUPS);

            pstmt.setLong(1, rosterItemID);
            pstmt.executeUpdate();
            // Close now the statement (do not wait to be GC'ed)
            pstmt.close();

            // Remove roster
            pstmt = con.prepareStatement(DELETE_ROSTER_ITEM);

            pstmt.setLong(1, rosterItemID);
            pstmt.executeUpdate();
        }
        catch (SQLException e) {
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
        finally {
Matt Tucker's avatar
Matt Tucker committed
192
            DbConnectionManager.closeConnection(pstmt, con);
193 194 195 196 197 198 199 200 201 202 203 204 205
        }
    }

    /**
     * Returns an iterator on the usernames whose roster includes the specified JID.
     *
     * @param jid the jid that the rosters should include.
     * @return an iterator on the usernames whose roster includes the specified JID.
     */
    public Iterator<String> getUsernames(String jid) {
        List<String> answer = new ArrayList<String>();
        Connection con = null;
        PreparedStatement pstmt = null;
Matt Tucker's avatar
Matt Tucker committed
206
        ResultSet rs = null;
207 208 209 210
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(LOAD_USERNAMES);
            pstmt.setString(1, jid);
Matt Tucker's avatar
Matt Tucker committed
211
            rs = pstmt.executeQuery();
212 213 214 215 216 217 218 219
            while (rs.next()) {
                answer.add(rs.getString(1));
            }
        }
        catch (SQLException e) {
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
        finally {
Matt Tucker's avatar
Matt Tucker committed
220
            DbConnectionManager.closeConnection(rs, pstmt, con);
221 222 223 224 225 226 227 228 229 230 231 232 233 234
        }
        return answer.iterator();
    }

    /**
     * Obtain a count of the number of roster items available for the given user.
     *
     * @param username the username of the user/chatbot that owns the roster items
     * @return The number of roster items available for the user
     */
    public int getItemCount(String username) {
        int count = 0;
        Connection con = null;
        PreparedStatement pstmt = null;
Matt Tucker's avatar
Matt Tucker committed
235
        ResultSet rs = null;
236 237 238 239
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(COUNT_ROSTER_ITEMS);
            pstmt.setString(1, username);
Matt Tucker's avatar
Matt Tucker committed
240
            rs = pstmt.executeQuery();
241 242 243 244 245 246 247 248
            if (rs.next()) {
                count = rs.getInt(1);
            }
        }
        catch (SQLException e) {
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
        finally {
Matt Tucker's avatar
Matt Tucker committed
249
            DbConnectionManager.closeConnection(rs, pstmt, con);
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
        }
        return count;
    }

    /**
     * Retrieve an iterator of RosterItems for the given user.<p>
     *
     * This method will commonly be called when a user logs in. The data will be cached
     * in memory when possible. However, some rosters may be very large so items may need
     * to be retrieved from the provider more frequently than usual for provider data.
     *
     * @param username the username of the user/chatbot that owns the roster items
     * @return An iterator of all RosterItems owned by the user
     */
    public Iterator<RosterItem> getItems(String username) {
        LinkedList<RosterItem> itemList = new LinkedList<RosterItem>();
266
        Map<Long, RosterItem> itemsByID = new HashMap<Long, RosterItem>();
267 268
        Connection con = null;
        PreparedStatement pstmt = null;
269
        ResultSet rs;
270 271 272 273 274
        try {
            // Load all the contacts in the roster
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(LOAD_ROSTER);
            pstmt.setString(1, username);
Matt Tucker's avatar
Matt Tucker committed
275
            rs = pstmt.executeQuery();
276 277 278 279 280 281 282 283 284 285 286
            while (rs.next()) {
                // Create a new RosterItem (ie. user contact) from the stored information
                RosterItem item = new RosterItem(rs.getLong(2),
                        new JID(rs.getString(1)),
                        RosterItem.SubType.getTypeFromInt(rs.getInt(3)),
                        RosterItem.AskType.getTypeFromInt(rs.getInt(4)),
                        RosterItem.RecvType.getTypeFromInt(rs.getInt(5)),
                        rs.getString(6),
                        null);
                // Add the loaded RosterItem (ie. user contact) to the result
                itemList.add(item);
287
                itemsByID.put(item.getID(), item);
288
            }
289 290
            // Close the statement and result set
            rs.close();
Matt Tucker's avatar
Matt Tucker committed
291
            pstmt.close();
292
            // Set null to pstmt to be sure that it's not closed twice. It seems that
Matt Tucker's avatar
Matt Tucker committed
293
            // Sybase driver is raising an error when trying to close an already closed statement.
294
            pstmt = null;
295 296

            // Load the groups for the loaded contact
297 298 299 300 301 302 303 304 305
            if (!itemList.isEmpty()) {
                StringBuilder sb = new StringBuilder(100);
                sb.append(LOAD_ROSTER_ITEM_GROUPS).append(" WHERE rosterID IN (");
                for (RosterItem item : itemList) {
                    sb.append(item.getID()).append(",");
                }
                sb.setLength(sb.length()-1);
                sb.append(") ORDER BY rosterID, rank");
                pstmt = con.prepareStatement(sb.toString());
306 307
                rs = pstmt.executeQuery();
                while (rs.next()) {
308
                    itemsByID.get(rs.getLong(1)).getGroups().add(rs.getString(2));
309
                }
310
                rs.close();
311
            }
312 313 314 315 316
        }
        catch (SQLException e) {
            Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
        }
        finally {
317
            DbConnectionManager.closeConnection(pstmt, con);
318 319 320 321 322 323 324
        }
        return itemList.iterator();
    }

    /**
     * Insert the groups into the given roster item.
     *
Matt Tucker's avatar
Matt Tucker committed
325 326 327 328
     * @param rosterID the roster ID of the item the groups belong to
     * @param iter an iterator over the group names to insert
     * @param con the database connection to use for the operation.
     * @throws SQLException if an SQL exception occurs.
329 330 331 332 333 334 335 336 337
     */
    private void insertGroups(long rosterID, Iterator<String> iter, Connection con) throws SQLException
    {
        PreparedStatement pstmt = null;
        try {
            pstmt = con.prepareStatement(CREATE_ROSTER_ITEM_GROUPS);
            pstmt.setLong(1, rosterID);
            for (int i = 0; iter.hasNext(); i++) {
                pstmt.setInt(2, i);
Matt Tucker's avatar
Matt Tucker committed
338
                String groupName = iter.next();
Gaston Dombiak's avatar
Gaston Dombiak committed
339
                pstmt.setString(3, groupName);
340 341 342 343 344 345 346 347 348
                try {
                    pstmt.executeUpdate();
                }
                catch (SQLException e) {
                    Log.error(e);
                }
            }
        }
        finally {
Matt Tucker's avatar
Matt Tucker committed
349
            DbConnectionManager.closeStatement(pstmt);
350 351 352
        }
    }
}