Bug 63740 - Host-specific xml files are not processed when xmlBase is not null
Summary: Host-specific xml files are not processed when xmlBase is not null
Alias: None
Product: Tomcat 9
Classification: Unclassified
Component: Catalina (show other bugs)
Version: 9.0.24
Hardware: PC All
: P2 regression (vote)
Target Milestone: -----
Assignee: Tomcat Developers Mailing List
Keywords: PatchAvailable
Depends on:
Reported: 2019-09-09 11:54 UTC by uk4sx
Modified: 2019-09-10 17:33 UTC (History)
0 users

proposed fix (1.88 KB, patch)
2019-09-09 11:54 UTC, uk4sx
Details | Diff
additional fix (RewriteValve) (846 bytes, patch)
2019-09-09 14:56 UTC, uk4sx
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description uk4sx 2019-09-09 11:54:25 UTC
Created attachment 36769 [details]
proposed fix

This is a Tomcat 9 - specific bug. Tested with Tomcat 9.0.24. Tomcat 8.5.43 works correctly. Earlier versions not tested.
When using a Host with xmlBase attribute the Host-specific context.xml.default and web.xml.default files are not processed at all (because they are not found).

Debugging the problem reveals that Tomcat searches for them in the wrong place:
always in ${catalina.base}/conf/${xmlBase} instead of ${xmlBase} (when xmlBase is absolute) or ${catalina.base}/${xmlBase} (when xmlBase is relative).

for xmlBase="conf/cx" tomcat searches in "${catalina.base}/conf/conf/cx"
but should search in "${catalina.base}/conf/cx"

for xmlBase="H:/myhost" tomcat searches in "${catalina.base}/conf/H:/myhost"
but should search in "H:/myhost"

Workarounds: using symlinks (a nuisance at best) or using Tomcat 8.5.

Analysis: the documentation says that when xmlBase is not specified then "conf/<engine_name>/<host_name>" will be used as default. However, Container.getConfigPath() does not prepend "conf/" when xmlBase is null,
and to compensate for this error the (only) 2 callers use
instead of the correct
This becomes a problem when xmlBase is not null: getConfResouce() prepends "conf/".

Proposed fix (see attached patch):
- Container.getConfigPath(): prepend "conf/" when xmlBase is null
- ContextConfig.contextConfig() and ContextConfig.getWebXmlSource():
call ConfigFileLoader.getSource().getResource() when working with the result of Container.getConfigPath()

Proposed fix tested successfully in 3 scenarios:
- no xmlBase: OK
- relative xmlBase: OK
- absolute xmlBase: OK

How to easily test that the fix works:
- for context.xml.default: the log contains (example)
  "Successfully processed context [/my-ws] configuration file [file:/H:/myhost/context.xml.default]"
- for web.xml.default: declare a filter in it with a (unique) nonexistent className and expect to see a "ClassNotFoundException" with that className

Thanks for fixing this.
Comment 1 uk4sx 2019-09-09 14:56:26 UTC
Created attachment 36771 [details]
additional fix (RewriteValve)

Somehow I missed one callsite of Container.getConfigPath(): it is also used in RewriteValve. The proposed fix is the same: use getResource() instead of getConfResource(). Added patch #2.
Comment 2 Mark Thomas 2019-09-10 17:33:33 UTC
Thanks for the patch and the explanation.

Fixed in:
- master for 9.0.25 onwards