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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.catalina.servlets;
import java.io.StringWriter;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;
import jakarta.servlet.http.HttpServletResponse;
import org.apache.catalina.servlets.WebdavServlet.PropertyUpdateType;
import org.apache.catalina.servlets.WebdavServlet.ProppatchOperation;
import org.apache.catalina.util.DOMWriter;
import org.apache.catalina.util.XMLWriter;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
import org.apache.tomcat.util.res.StringManager;
import org.w3c.dom.Node;
/**
* WebDAV dead properties storage using a DataSource.
* <p>
* A single properties table with four columns is used:
* <ul>
* <li>path: the resource path</li>
* <li>namespace: the node namespace</li>
* <li>name: the local name in the namespace</li>
* <li>node: the full serialized XML node including the name</li>
* </ul>
* The table name used can be configured using the <code>tableName</code> property of the store.
* <p>
* Example table schema: <code>CREATE TABLE properties (
* path VARCHAR(1024) NOT NULL,
* namespace VARCHAR(64) NOT NULL,
* name VARCHAR(64) NOT NULL,
* node VARCHAR(2048) NOT NULL,
* PRIMARY KEY (path, namespace, name)
* )</code>
*/
public class DataSourcePropertyStore implements WebdavServlet.PropertyStore {
protected static final StringManager sm = StringManager.getManager(DataSourcePropertyStore.class);
private final Log log = LogFactory.getLog(DataSourcePropertyStore.class);
/**
* DataSource JNDI name, will be prefixed with java:comp/env for the lookup.
*/
private String dataSourceName = "WebdavPropertyStore";
/**
* Table name.
*/
private String tableName = "properties";
private String addPropertyStatement;
private String setPropertyStatement;
private String removeAllPropertiesStatement;
private String removePropertyStatement;
private String getPropertyStatement;
private String getPropertiesNameStatement;
private String getPropertiesStatement;
private String getPropertiesNodeStatement;
private final ReentrantReadWriteLock dbLock = new ReentrantReadWriteLock();
private final Lock dbReadLock = dbLock.readLock();
private final Lock dbWriteLock = dbLock.writeLock();
/**
* @return the DataSource JNDI name, will be prefixed with java:comp/env for the lookup.
*/
public String getDataSourceName() {
return this.dataSourceName;
}
/**
* @param dataSourceName the DataSource JNDI name, will be prefixed with java:comp/env for the lookup.
*/
public void setDataSourceName(String dataSourceName) {
this.dataSourceName = dataSourceName;
}
/**
* @return the table name that will be used in the database
*/
public String getTableName() {
return this.tableName;
}
/**
* @param tableName the table name to use in the database
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
* DataSource instance being used.
*/
protected DataSource dataSource = null;
@Override
public void init() {
if (dataSource == null) {
try {
dataSource = (DataSource) ((new InitialContext()).lookup("java:comp/env/" + dataSourceName));
} catch (NamingException e) {
throw new IllegalArgumentException(
sm.getString("webdavservlet.dataSourceStore.noDataSource", dataSourceName), e);
}
}
addPropertyStatement = "INSERT INTO " + tableName + " (path, namespace, name, node) VALUES (?, ?, ?, ?)";
setPropertyStatement = "UPDATE " + tableName + " SET node = ? WHERE path = ? AND namespace = ? AND name = ?";
removeAllPropertiesStatement = "DELETE FROM " + tableName + " WHERE path = ?";
removePropertyStatement = "DELETE FROM " + tableName + " WHERE path = ? AND namespace = ? AND name = ?";
getPropertyStatement = "SELECT node FROM " + tableName + " WHERE path = ? AND namespace = ? AND name = ?";
getPropertiesNameStatement = "SELECT namespace, name FROM " + tableName + " WHERE path = ?";
getPropertiesStatement = "SELECT namespace, name, node FROM " + tableName + " WHERE path = ?";
getPropertiesNodeStatement = "SELECT node FROM " + tableName + " WHERE path = ?";
}
@Override
public void destroy() {
}
@Override
public void periodicEvent() {
}
@Override
public void copy(String source, String destination) {
if (dataSource == null) {
return;
}
dbWriteLock.lock();
try (Connection connection = dataSource.getConnection();
PreparedStatement statement = connection.prepareStatement(getPropertiesStatement)) {
statement.setString(1, source);
if (statement.execute()) {
ResultSet rs = statement.getResultSet();
while (rs.next()) {
String namespace = rs.getString(1);
String name = rs.getString(2);
String node = rs.getString(3);
boolean found = false;
try (PreparedStatement statement2 = connection.prepareStatement(getPropertyStatement)) {
statement2.setString(1, destination);
statement2.setString(2, namespace);
statement2.setString(3, name);
if (statement2.execute()) {
ResultSet rs2 = statement2.getResultSet();
if (rs2.next()) {
found = true;
}
}
}
if (found) {
try (PreparedStatement statement2 = connection.prepareStatement(setPropertyStatement)) {
statement2.setString(1, node);
statement2.setString(2, destination);
statement2.setString(3, namespace);
statement2.setString(4, name);
statement2.execute();
}
} else {
try (PreparedStatement statement2 = connection.prepareStatement(addPropertyStatement)) {
statement2.setString(1, destination);
statement2.setString(2, namespace);
statement2.setString(3, name);
statement2.setString(4, node);
statement2.execute();
}
}
}
}
} catch (SQLException e) {
log.warn(sm.getString("webdavservlet.dataSourceStore.error", "copy", source), e);
} finally {
dbWriteLock.unlock();
}
}
@Override
public void delete(String resource) {
if (dataSource == null) {
return;
}
dbWriteLock.lock();
try (Connection connection = dataSource.getConnection();
PreparedStatement statement = connection.prepareStatement(removeAllPropertiesStatement)) {
statement.setString(1, resource);
statement.execute();
} catch (SQLException e) {
log.warn(sm.getString("webdavservlet.dataSourceStore.error", "delete", resource), e);
} finally {
dbWriteLock.unlock();
}
}
@Override
public boolean propfind(String resource, Node property, boolean nameOnly, XMLWriter generatedXML) {
if (dataSource == null) {
return false;
}
if (nameOnly) {
// Add the names of all properties
dbReadLock.lock();
try (Connection connection = dataSource.getConnection();
PreparedStatement statement = connection.prepareStatement(getPropertiesNameStatement)) {
statement.setString(1, resource);
if (statement.execute()) {
ResultSet rs = statement.getResultSet();
while (rs.next()) {
String namespace = rs.getString(1);
String name = rs.getString(2);
generatedXML.writeElement(null, namespace, name, XMLWriter.NO_CONTENT);
}
}
} catch (SQLException e) {
log.warn(sm.getString("webdavservlet.dataSourceStore.error", "propfind", resource), e);
} finally {
dbReadLock.unlock();
}
} else if (property != null) {
// Add a single property
dbReadLock.lock();
try (Connection connection = dataSource.getConnection();
PreparedStatement statement = connection.prepareStatement(getPropertyStatement)) {
statement.setString(1, resource);
statement.setString(2, property.getNamespaceURI());
statement.setString(3, property.getLocalName());
if (statement.execute()) {
ResultSet rs = statement.getResultSet();
if (rs.next()) {
String node = rs.getString(1);
generatedXML.writeRaw(node);
return true;
}
}
} catch (SQLException e) {
log.warn(sm.getString("webdavservlet.dataSourceStore.error", "propfind", resource), e);
} finally {
dbReadLock.unlock();
}
} else {
// Add all properties
dbReadLock.lock();
try (Connection connection = dataSource.getConnection();
PreparedStatement statement = connection.prepareStatement(getPropertiesNodeStatement)) {
statement.setString(1, resource);
if (statement.execute()) {
ResultSet rs = statement.getResultSet();
while (rs.next()) {
String node = rs.getString(1);
generatedXML.writeRaw(node);
}
}
} catch (SQLException e) {
log.warn(sm.getString("webdavservlet.dataSourceStore.error", "propfind", resource), e);
} finally {
dbReadLock.unlock();
}
}
return false;
}
@Override
public void proppatch(String resource, ArrayList<ProppatchOperation> operations) {
boolean protectedProperty = false;
// Check for the protected properties
for (ProppatchOperation operation : operations) {
if (operation.getProtectedProperty()) {
protectedProperty = true;
operation.setStatusCode(HttpServletResponse.SC_FORBIDDEN);
}
}
if (protectedProperty) {
for (ProppatchOperation operation : operations) {
if (!operation.getProtectedProperty()) {
operation.setStatusCode(WebdavStatus.SC_FAILED_DEPENDENCY);
}
}
} else {
if (dataSource == null) {
for (ProppatchOperation operation : operations) {
operation.setStatusCode(WebdavStatus.SC_INTERNAL_SERVER_ERROR);
}
return;
}
boolean failure = false;
dbWriteLock.lock();
try (Connection connection = dataSource.getConnection()) {
connection.setAutoCommit(false);
for (ProppatchOperation operation : operations) {
if (operation.getUpdateType() == PropertyUpdateType.SET) {
Node node = operation.getPropertyNode().cloneNode(true);
StringWriter strWriter = new StringWriter();
DOMWriter domWriter = new DOMWriter(strWriter);
domWriter.print(node);
String serializedNode = strWriter.toString();
boolean found = false;
try {
try (PreparedStatement statement = connection.prepareStatement(getPropertyStatement)) {
statement.setString(1, resource);
statement.setString(2, node.getNamespaceURI());
statement.setString(3, node.getLocalName());
if (statement.execute()) {
ResultSet rs = statement.getResultSet();
if (rs.next()) {
found = true;
}
}
}
if (found) {
try (PreparedStatement statement = connection.prepareStatement(setPropertyStatement)) {
statement.setString(1, serializedNode);
statement.setString(2, resource);
statement.setString(3, node.getNamespaceURI());
statement.setString(4, node.getLocalName());
statement.execute();
}
} else {
try (PreparedStatement statement = connection.prepareStatement(addPropertyStatement)) {
statement.setString(1, resource);
statement.setString(2, node.getNamespaceURI());
statement.setString(3, node.getLocalName());
statement.setString(4, serializedNode);
statement.execute();
}
}
} catch (SQLException e) {
failure = true;
operation.setStatusCode(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
break;
}
}
if (operation.getUpdateType() == PropertyUpdateType.REMOVE) {
Node node = operation.getPropertyNode();
try (PreparedStatement statement = connection.prepareStatement(removePropertyStatement)) {
statement.setString(1, resource);
statement.setString(2, node.getNamespaceURI());
statement.setString(3, node.getLocalName());
statement.execute();
} catch (SQLException e) {
failure = true;
operation.setStatusCode(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
break;
}
}
}
if (failure) {
connection.rollback();
for (ProppatchOperation operation : operations) {
if (operation.getStatusCode() == HttpServletResponse.SC_OK) {
operation.setStatusCode(WebdavStatus.SC_FAILED_DEPENDENCY);
}
}
} else {
connection.commit();
}
} catch (SQLException e) {
log.warn(sm.getString("webdavservlet.dataSourceStore.error", "proppatch", resource), e);
for (ProppatchOperation operation : operations) {
operation.setStatusCode(WebdavStatus.SC_INTERNAL_SERVER_ERROR);
}
} finally {
dbWriteLock.unlock();
}
}
}
}
|
