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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
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
273
274
275
276
277
278
279
280
281
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/**
* $RCSfile$
* $Revision: $
* $Date: $
*
* Copyright (C) 2005-2008 Jive Software. All rights reserved.
*
* 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 org.jivesoftware.openfire.privacy;
import java.io.StringReader;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.atomic.AtomicInteger;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import org.jivesoftware.database.DbConnectionManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Provider for the privacy lists system. Privacy lists are read and written
* from the <tt>ofPrivacyList</tt> database table.
*
* @author Gaston Dombiak
*/
public class PrivacyListProvider {
private static final Logger Log = LoggerFactory.getLogger(PrivacyListProvider.class);
private static final String PRIVACY_LIST_COUNT =
"SELECT count(*) from ofPrivacyList";
private static final String LOAD_LIST_NAMES =
"SELECT name, isDefault FROM ofPrivacyList WHERE username=?";
private static final String LOAD_PRIVACY_LIST =
"SELECT isDefault, list FROM ofPrivacyList WHERE username=? AND name=?";
private static final String LOAD_DEFAULT_PRIVACY_LIST =
"SELECT name, list FROM ofPrivacyList WHERE username=? AND isDefault=1";
private static final String DELETE_PRIVACY_LIST =
"DELETE FROM ofPrivacyList WHERE username=? AND name=?";
private static final String DELETE_PRIVACY_LISTS =
"DELETE FROM ofPrivacyList WHERE username=?";
private static final String UPDATE_PRIVACY_LIST =
"UPDATE ofPrivacyList SET isDefault=?, list=? WHERE username=? AND name=?";
private static final String INSERT_PRIVACY_LIST =
"INSERT INTO ofPrivacyList (username, name, isDefault, list) VALUES (?, ?, ?, ?)";
private static final int POOL_SIZE = 50;
/**
* Pool of SAX Readers. SAXReader is not thread safe so we need to have a pool of readers.
*/
private BlockingQueue<SAXReader> xmlReaders = new LinkedBlockingQueue<SAXReader>(POOL_SIZE);
/**
* Stores the total number of privacy lists.
*/
private AtomicInteger privacyListCount;
public PrivacyListProvider() {
super();
// Initialize the pool of sax readers
for (int i=0; i<POOL_SIZE; i++) {
SAXReader xmlReader = new SAXReader();
xmlReader.setEncoding("UTF-8");
xmlReaders.add(xmlReader);
}
// Load the total number of privacy lists in the database. We're looking
// for the (very common) special case that there are no privacy lists stored.
// In that case, we can optimize away many database calls. In the future, a
// better general-case solution may be to cache all privacy lists defined
// if there are less than, say, 500.
privacyListCount = new AtomicInteger(0);
loadPrivacyListCount();
}
/**
* Returns the names of the existing privacy lists indicating which one is the
* default privacy list associated to a user.
*
* @param username the username of the user to get his privacy lists names.
* @return the names of the existing privacy lists with a default flag.
*/
public Map<String, Boolean> getPrivacyLists(String username) {
// If there are no privacy lists stored, this method is a no-op.
if (privacyListCount.get() == 0) {
return Collections.emptyMap();
}
Map<String, Boolean> names = new HashMap<String, Boolean>();
Connection con = null;
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(LOAD_LIST_NAMES);
pstmt.setString(1, username);
rs = pstmt.executeQuery();
while (rs.next()) {
names.put(rs.getString(1), rs.getInt(2) == 1);
}
}
catch (Exception e) {
Log.error("Error loading names of privacy lists for username: " + username, e);
}
finally {
DbConnectionManager.closeConnection(rs, pstmt, con);
}
return names;
}
/**
* Loads the requested privacy list from the database. Returns <tt>null</tt> if a list
* with the specified name does not exist.
*
* @param username the username of the user to get his privacy list.
* @param listName name of the list to load.
* @return the privacy list with the specified name or <tt>null</tt> if a list
* with the specified name does not exist.
*/
public PrivacyList loadPrivacyList(String username, String listName) {
// If there are no privacy lists stored, this method is a no-op.
if (privacyListCount.get() == 0) {
return null;
}
boolean isDefault = false;
String listValue = null;
Connection con = null;
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(LOAD_PRIVACY_LIST);
pstmt.setString(1, username);
pstmt.setString(2, listName);
rs = pstmt.executeQuery();
if (rs.next()) {
isDefault = rs.getInt(1) == 1;
listValue = rs.getString(2);
}
else {
return null;
}
}
catch (Exception e) {
Log.error("Error loading privacy list: " + listName + " of username: " + username, e);
return null;
}
finally {
DbConnectionManager.closeConnection(rs, pstmt, con);
}
PrivacyList privacyList = null;
SAXReader xmlReader = null;
try {
// Get a sax reader from the pool
xmlReader = xmlReaders.take();
Element listElement = xmlReader.read(new StringReader(listValue)).getRootElement();
privacyList = new PrivacyList(username, listName, isDefault, listElement);
}
catch (Exception e) {
Log.error(e.getMessage(), e);
}
finally {
// Return the sax reader to the pool
if (xmlReader != null) {
xmlReaders.add(xmlReader);
}
}
return privacyList;
}
/**
* Loads the default privacy list of a given user from the database. Returns <tt>null</tt>
* if no list was found.
*
* @param username the username of the user to get his default privacy list.
* @return the default privacy list or <tt>null</tt> if no list was found.
*/
public PrivacyList loadDefaultPrivacyList(String username) {
// If there are no privacy lists stored, this method is a no-op.
if (privacyListCount.get() == 0) {
return null;
}
String listName = null;
String listValue = null;
Connection con = null;
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(LOAD_DEFAULT_PRIVACY_LIST);
pstmt.setString(1, username);
rs = pstmt.executeQuery();
if (rs.next()) {
listName = rs.getString(1);
listValue = rs.getString(2);
}
else {
return null;
}
}
catch (Exception e) {
Log.error("Error loading default privacy list of username: " + username, e);
return null;
}
finally {
DbConnectionManager.closeConnection(rs, pstmt, con);
}
PrivacyList privacyList = null;
SAXReader xmlReader = null;
try {
// Get a sax reader from the pool
xmlReader = xmlReaders.take();
Element listElement = xmlReader.read(new StringReader(listValue)).getRootElement();
privacyList = new PrivacyList(username, listName, true, listElement);
}
catch (Exception e) {
Log.error(e.getMessage(), e);
}
finally {
// Return the sax reader to the pool
if (xmlReader != null) {
xmlReaders.add(xmlReader);
}
}
return privacyList;
}
/**
* Creates and saves the new privacy list to the database.
*
* @param username the username of the user that created a new privacy list.
* @param list the PrivacyList to save.
*/
public void createPrivacyList(String username, PrivacyList list) {
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(INSERT_PRIVACY_LIST);
pstmt.setString(1, username);
pstmt.setString(2, list.getName());
pstmt.setInt(3, (list.isDefault() ? 1 : 0));
pstmt.setString(4, list.asElement().asXML());
pstmt.executeUpdate();
}
catch (Exception e) {
Log.error("Error adding privacy list: " + list.getName() + " of username: " + username,
e);
}
finally {
DbConnectionManager.closeConnection(pstmt, con);
}
// Set the privacy list count to -1. We don't know how many privacy lists there
// are, but it's not "0", which is the case we care about.
privacyListCount.set(-1);
}
/**
* Updated the existing privacy list in the database.
*
* @param username the username of the user that updated a privacy list.
* @param list the PrivacyList to update in the database.
*/
public void updatePrivacyList(String username, PrivacyList list) {
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(UPDATE_PRIVACY_LIST);
pstmt.setInt(1, (list.isDefault() ? 1 : 0));
pstmt.setString(2, list.asElement().asXML());
pstmt.setString(3, username);
pstmt.setString(4, list.getName());
pstmt.executeUpdate();
}
catch (Exception e) {
Log.error("Error updating privacy list: " + list.getName() + " of username: " +
username, e);
}
finally {
DbConnectionManager.closeConnection(pstmt, con);
}
}
/**
* Deletes an existing privacy list from the database.
*
* @param username the username of the user that deleted a privacy list.
* @param listName the name of the PrivacyList to delete.
*/
public void deletePrivacyList(String username, String listName) {
// If there are no privacy lists stored, this method is a no-op.
if (privacyListCount.get() == 0) {
return;
}
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(DELETE_PRIVACY_LIST);
pstmt.setString(1, username);
pstmt.setString(2, listName);
pstmt.executeUpdate();
}
catch (Exception e) {
Log.error("Error deleting privacy list: " + listName + " of username: " + username, e);
}
finally {
DbConnectionManager.closeConnection(pstmt, con);
}
// Set the privacy list count to -1. We don't know how many privacy lists there
// are, but it's probably not "0", which is the case we care about.
privacyListCount.set(-1);
}
/**
* Deletes all existing privacy list from the database for the given user.
*
* @param username the username of the user whose privacy lists are going to be deleted.
*/
public void deletePrivacyLists(String username) {
// If there are no privacy lists stored, this method is a no-op.
if (privacyListCount.get() == 0) {
return;
}
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(DELETE_PRIVACY_LISTS);
pstmt.setString(1, username);
pstmt.executeUpdate();
}
catch (Exception e) {
Log.error("Error deleting privacy lists of username: " + username, e);
}
finally {
DbConnectionManager.closeConnection(pstmt, con);
}
// Set the privacy list count to -1. We don't know how many privacy lists there
// are, but it's probably not "0", which is the case we care about.
privacyListCount.set(-1);
}
/**
* Loads the total number of privacy lists stored in the database.
*/
private void loadPrivacyListCount() {
Connection con = null;
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(PRIVACY_LIST_COUNT);
rs = pstmt.executeQuery();
rs.next();
privacyListCount.set(rs.getInt(1));
}
catch (Exception e) {
Log.error(e.getMessage(), e);
}
finally {
DbConnectionManager.closeConnection(rs, pstmt, con);
}
}
}