Skip to content

Commit dc0f5c2

Browse files
adamretteradamretter
committed
[bugfix] Prevent memory leaks from the XML:DB API (and by extension XML-RPC API) by ensuring that resources used in queries and retrieving documents are correctly cleaned up.
See xmldb-org/xmldb-api#251
1 parent d9ab337 commit dc0f5c2

229 files changed

Lines changed: 17067 additions & 11275 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎build.sh‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727

2828
set -e
2929

30+
# Uncomment below to assist in debugging
31+
#set -x
32+
3033
TARGET="useage"
3134
DEBUG=false
3235
OFFLINE=false
@@ -173,7 +176,7 @@ fi
173176

174177
if [ "${TARGET}" == "format-poms" ]; then
175178
SAXON="${HOME}/.m2/repository/net/sf/saxon/Saxon-HE/9.9.1-8/Saxon-HE-9.9.1-8.jar"
176-
POMS="$(find . -name pom.xml)"
179+
POMS="$(find $SCRIPT_DIR -name pom.xml)"
177180
for pom in $POMS; do
178181

179182
echo -n "Formatting ${pom} ... "

‎elemental-parent/pom.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@
505505
</dependency>
506506
</dependencies>
507507
<configuration>
508-
<forkNode implementation="org.apache.maven.plugin.surefire.extensions.SurefireForkNodeFactory" />
508+
<forkNode implementation="org.apache.maven.plugin.surefire.extensions.SurefireForkNodeFactory"/>
509509
<forkCount>${surefire.forkCount}</forkCount>
510510
<reuseForks>${surefire.reuseForks}</reuseForks>
511511
<argLine>@{jacocoArgLine} --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.ref=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED -Dfile.encoding=${project.build.sourceEncoding}</argLine>
@@ -807,4 +807,4 @@
807807
</profile>
808808
</profiles>
809809

810-
</project>
810+
</project>

‎exist-ant/pom.xml‎

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@
106106
<dependency>
107107
<groupId>com.google.code.findbugs</groupId>
108108
<artifactId>jsr305</artifactId>
109-
<scope>test</scope>
110109
</dependency>
111110

112111
<dependency>
@@ -184,7 +183,34 @@
184183
<include>pom.xml</include>
185184
<include>src/test/resources-filtered/conf.xml</include>
186185
<include>src/test/resources/log4j2.xml</include>
186+
<include>src/main/java/org/exist/ant/AbstractXMLDBTask.java</include>
187+
<include>src/main/java/org/exist/ant/AddGroupTask.java</include>
188+
<include>src/main/java/org/exist/ant/AddUserTask.java</include>
189+
<include>src/main/java/org/exist/ant/ChmodTask.java</include>
190+
<include>src/main/java/org/exist/ant/ChownTask.java</include>
191+
<include>src/test/java/org/exist/ant/FileTaskTest.java</include>
192+
<include>src/main/java/org/exist/ant/ListGroupsTask.java</include>
193+
<include>src/main/java/org/exist/ant/ListUsersTask.java</include>
194+
<include>src/main/java/org/exist/ant/LockResourceTask.java</include>
195+
<include>src/main/java/org/exist/ant/RemoveGroupTask.java</include>
196+
<include>src/main/java/org/exist/ant/RemoveUserTask.java</include>
197+
<include>src/main/java/org/exist/ant/RestoreTask.java</include>
198+
<include>src/test/java/org/exist/ant/ServerTaskTest.java</include>
199+
<include>src/main/java/org/exist/ant/UserPasswordTask.java</include>
200+
<include>src/main/java/org/exist/ant/UserTask.java</include>
201+
<include>src/main/java/org/exist/ant/XMLDBCopyTask.java</include>
202+
<include>src/main/java/org/exist/ant/XMLDBCreateTask.java</include>
203+
<include>src/main/java/org/exist/ant/XMLDBExistTask.java</include>
204+
<include>src/main/java/org/exist/ant/XMLDBExtractTask.java</include>
205+
<include>src/main/java/org/exist/ant/XMLDBListTask.java</include>
206+
<include>src/main/java/org/exist/ant/XMLDBMoveTask.java</include>
207+
<include>src/main/java/org/exist/ant/XMLDBRemoveTask.java</include>
208+
<include>src/main/java/org/exist/ant/XMLDBShutdownTask.java</include>
187209
<include>src/main/java/org/exist/ant/XMLDBStoreTask.java</include>
210+
<include>src/test/java/org/exist/ant/XmldbTaskTest.java</include>
211+
<include>src/main/java/org/exist/ant/XMLDBXPathTask.java</include>
212+
<include>src/main/java/org/exist/ant/XMLDBXQueryTask.java</include>
213+
<include>src/main/java/org/exist/ant/XMLDBXUpdateTask.java</include>
188214
</includes>
189215
</licenseSet>
190216

@@ -202,7 +228,34 @@
202228
<exclude>xquery-license-style.xml</exclude>
203229
<exclude>src/test/resources-filtered/conf.xml</exclude>
204230
<exclude>src/test/resources/log4j2.xml</exclude>
231+
<exclude>src/main/java/org/exist/ant/AbstractXMLDBTask.java</exclude>
232+
<exclude>src/main/java/org/exist/ant/AddGroupTask.java</exclude>
233+
<exclude>src/main/java/org/exist/ant/AddUserTask.java</exclude>
234+
<exclude>src/main/java/org/exist/ant/ChmodTask.java</exclude>
235+
<exclude>src/main/java/org/exist/ant/ChownTask.java</exclude>
236+
<exclude>src/test/java/org/exist/ant/FileTaskTest.java</exclude>
237+
<exclude>src/main/java/org/exist/ant/ListGroupsTask.java</exclude>
238+
<exclude>src/main/java/org/exist/ant/ListUsersTask.java</exclude>
239+
<exclude>src/main/java/org/exist/ant/LockResourceTask.java</exclude>
240+
<exclude>src/main/java/org/exist/ant/RemoveGroupTask.java</exclude>
241+
<exclude>src/main/java/org/exist/ant/RemoveUserTask.java</exclude>
242+
<exclude>src/main/java/org/exist/ant/RestoreTask.java</exclude>
243+
<exclude>src/test/java/org/exist/ant/ServerTaskTest.java</exclude>
244+
<exclude>src/main/java/org/exist/ant/UserPasswordTask.java</exclude>
245+
<exclude>src/main/java/org/exist/ant/UserTask.java</exclude>
246+
<exclude>src/main/java/org/exist/ant/XMLDBCopyTask.java</exclude>
247+
<exclude>src/main/java/org/exist/ant/XMLDBCreateTask.java</exclude>
248+
<exclude>src/main/java/org/exist/ant/XMLDBExistTask.java</exclude>
249+
<exclude>src/main/java/org/exist/ant/XMLDBExtractTask.java</exclude>
250+
<exclude>src/main/java/org/exist/ant/XMLDBListTask.java</exclude>
251+
<exclude>src/main/java/org/exist/ant/XMLDBMoveTask.java</exclude>
252+
<exclude>src/main/java/org/exist/ant/XMLDBRemoveTask.java</exclude>
253+
<exclude>src/main/java/org/exist/ant/XMLDBShutdownTask.java</exclude>
205254
<exclude>src/main/java/org/exist/ant/XMLDBStoreTask.java</exclude>
255+
<exclude>src/test/java/org/exist/ant/XmldbTaskTest.java</exclude>
256+
<exclude>src/main/java/org/exist/ant/XMLDBXPathTask.java</exclude>
257+
<exclude>src/main/java/org/exist/ant/XMLDBXQueryTask.java</exclude>
258+
<exclude>src/main/java/org/exist/ant/XMLDBXUpdateTask.java</exclude>
206259
</excludes>
207260
</licenseSet>
208261
</licenseSets>

‎exist-ant/src/main/java/org/exist/ant/AbstractXMLDBTask.java‎

Lines changed: 62 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -37,6 +61,7 @@
3761
import org.xmldb.api.base.XMLDBException;
3862
import org.xmldb.api.modules.CollectionManagementService;
3963

64+
import javax.annotation.Nullable;
4065
import java.util.StringTokenizer;
4166

4267

@@ -186,79 +211,67 @@ protected void registerDatabase() throws BuildException
186211
}
187212

188213

189-
protected final Collection mkcol(final Collection rootCollection, final String baseURI, String path, final String relPath ) throws XMLDBException
190-
{
191-
CollectionManagementService mgtService;
192-
Collection current = rootCollection;
193-
Collection collection;
194-
String token;
195-
196-
///TODO : use dedicated function in XmldbURI
197-
final StringTokenizer tokenizer = new StringTokenizer( relPath, "/" );
198-
199-
while( tokenizer.hasMoreTokens() ) {
200-
201-
token = tokenizer.nextToken();
214+
protected final Collection mkcol(Collection collection, final String baseURI, String path, final String relPath) throws XMLDBException {
215+
final StringTokenizer tokenizer = new StringTokenizer(relPath, "/");
202216

203-
if( path != null ) {
217+
while (tokenizer.hasMoreTokens()) {
218+
final String token = tokenizer.nextToken();
219+
if (path != null) {
204220
path = path + "/" + token;
205221
} else {
206222
path = "/" + token;
207223
}
208224

209-
log( "Get collection " + baseURI + path, Project.MSG_DEBUG );
210-
collection = DatabaseManager.getCollection( baseURI + path, user, password );
211-
212-
if( collection == null ) {
213-
log( "Create collection management service for collection " + current.getName(), Project.MSG_DEBUG );
214-
mgtService = current.getService( CollectionManagementService.class );
215-
log( "Create child collection " + token, Project.MSG_DEBUG );
216-
current = mgtService.createCollection( token );
217-
log( "Created collection " + current.getName() + '.', Project.MSG_DEBUG );
225+
Collection child = DatabaseManager.getCollection(baseURI + path, user, password);
226+
if (child == null) {
227+
final CollectionManagementService mgtService = collection.getService(CollectionManagementService.class);
228+
log("Create child collection " + token, Project.MSG_DEBUG);
229+
child = mgtService.createCollection(token);
230+
log("Created collection " + child.getName() + '.', Project.MSG_DEBUG);
231+
}
218232

219-
} else {
220-
current = collection;
233+
try {
234+
// close the parent collection
235+
collection.close();
236+
} catch (final XMLDBException e) {
237+
// no-op
221238
}
239+
240+
collection = child;
222241
}
223-
return( current );
242+
243+
return collection;
224244
}
225245

226246

227-
protected final void setPermissions(final Resource res ) throws BuildException
228-
{
229-
Collection base = null;
230-
UserManagementService service = null;
231-
232-
if( uri == null ) {
233-
throw( new BuildException( "you have to specify an XMLDB collection URI" ) );
247+
protected final void setPermissions(final Resource res) throws BuildException {
248+
if (uri == null) {
249+
throw new BuildException( "you have to specify an XMLDB collection URI");
234250
}
235251

236-
try {
237-
log( "Get base collection: " + uri, Project.MSG_DEBUG );
238-
base = DatabaseManager.getCollection( uri, user, password );
252+
log("Get base collection: " + uri, Project.MSG_DEBUG);
253+
try (final Collection base = DatabaseManager.getCollection(uri, user, password)) {
239254

240-
if( base == null ) {
255+
if (base == null ) {
241256
final String msg = "Collection " + uri + " could not be found.";
242257

243-
if( failonerror ) {
244-
throw( new BuildException( msg ) );
258+
if (failonerror) {
259+
throw new BuildException(msg);
245260
} else {
246-
log( msg, Project.MSG_ERR );
261+
log(msg, Project.MSG_ERR);
247262
}
248263
} else {
249-
service = base.getService( UserManagementService.class);
250-
251-
setPermissions( res, service );
264+
final UserManagementService service = base.getService(UserManagementService.class);
265+
setPermissions(res, service);
252266
}
253267

254-
}
255-
catch( final XMLDBException e ) {
268+
} catch (final XMLDBException e) {
256269
final String msg = "XMLDB exception caught: " + e.getMessage();
257270

258-
if( failonerror ) {
259-
throw( new BuildException( msg, e ) );
271+
if (failonerror) {
272+
throw new BuildException(msg, e);
260273
} else {
261-
log( msg, e, Project.MSG_ERR );
274+
log(msg, e, Project.MSG_ERR);
262275
}
263276
}
264277
}
@@ -283,7 +296,7 @@ protected final void setPermissions(final Collection col ) throws BuildException
283296
}
284297

285298

286-
protected final void setPermissions(final Resource res, final UserManagementService service ) throws BuildException
299+
protected final void setPermissions(@Nullable final Resource res, final UserManagementService service ) throws BuildException
287300
{
288301
try {
289302
if( permissions != null ) {

‎exist-ant/src/main/java/org/exist/ant/AddGroupTask.java‎

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -34,12 +58,8 @@ public class AddGroupTask extends UserTask
3458
{
3559
private String name;
3660

37-
/* (non-Javadoc)
38-
* @see org.apache.tools.ant.Task#execute()
39-
*/
40-
public void execute() throws BuildException
41-
{
42-
super.execute();
61+
@Override
62+
public void executeUserTask() throws BuildException {
4363

4464
if( name == null ) {
4565
throw( new BuildException( "Must specify a group name" ) );
@@ -49,7 +69,7 @@ public void execute() throws BuildException
4969
final GroupAider group = new GroupAider( name );
5070

5171
log( "Adding group " + name, Project.MSG_INFO );
52-
service.addGroup( group );
72+
getService().addGroup( group );
5373

5474
}
5575
catch( final XMLDBException e ) {

‎exist-ant/src/main/java/org/exist/ant/AddUserTask.java‎

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* admin@evolvedbinary.com
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -37,12 +61,8 @@ public class AddUserTask extends UserTask {
3761
private String primaryGroup;
3862
private String secret;
3963

40-
/* (non-Javadoc)
41-
* @see org.apache.tools.ant.Task#execute()
42-
*/
43-
public void execute() throws BuildException
44-
{
45-
super.execute();
64+
@Override
65+
public void executeUserTask() throws BuildException {
4666

4767
if( name == null ) {
4868
throw( new BuildException( "Must specify at leat a user name" ) );
@@ -60,7 +80,7 @@ public void execute() throws BuildException
6080
}
6181

6282
log( "Adding user " + name, Project.MSG_INFO );
63-
service.addAccount( usr );
83+
getService().addAccount( usr );
6484

6585
}
6686
catch( final XMLDBException e ) {

0 commit comments

Comments
 (0)