Stricter user config file validation.

Add a configuration parameter (strict-configuration), enabled by default, which makes FOP throw an exception instead of logging an error when a problem occurs.
Invalid resource paths should be catched now. Fixes bug #40120.
Submitted by: Adrian Cumiskey (fop-dev AT cumiskey DOT com)


git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@507539 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 27 insertions, 2 deletions

diff --git a/src/documentation/content/xdocs/trunk/configuration.xml b/src/documentation/content/xdocs/trunk/configuration.xml
index c40a64de5..7032379ca 100644
--- a/src/documentation/content/xdocs/trunk/configuration.xml
+++ b/src/documentation/content/xdocs/trunk/configuration.xml
@@ -64,19 +64,21 @@
       <tr>
         <th>Element</th>
         <th>Data Type (for the value)</th>
+        <th>Description</th>
         <th>Default Value</th>
       </tr>
       <tr>
         <td>base</td>
         <td>URL or directory</td>
         <td>Specifies the base URL based on which relative URL will be resolved.</td>
+        <td>current directory</td>
       </tr>
       <tr>
         <td>font-base</td>
         <td>URL or directory</td>
         <td>Specifies the base URL based on which relative font URLs will be resolved.
-        If not specified defaults to the base URL above.
         </td>
+	<td>base URL/directory (above)</td>
       </tr>
       <tr>
         <td>hyphenation-base</td>
@@ -85,6 +87,7 @@
         files will be resolved. If not specified, support for user-supplied hyphenation 
         patterns remains disabled.
         </td>
+        <td>disabled</td>
       </tr>
       <tr>
         <td>source-resolution</td>
@@ -93,6 +96,7 @@
           Resolution in dpi (dots per inch) which is used internally to determine the pixel 
           size for SVG images and bitmap images without resolution information.
         </td>
+        <td>72 dpi</td>
       </tr>
       <tr>
         <td>target-resolution</td>
@@ -102,6 +106,17 @@
           images generated by bitmap renderers (such as the TIFF renderer) and by bitmaps
           generated by Apache Batik for filter effects and such.
         </td>
+        <td>72 dpi</td>
+      </tr>
+      <tr>
+        <td>strict-configuration</td>
+        <td>Boolean (true, false)</td>
+        <td>
+	  Setting this option to 'true' will cause FOP to strictly verify the contents of the
+	  FOP configuration file to ensure that defined resources (such as fonts and base
+	  URLs/directories) are valid and available to FOP.  Any errors found will cause FOP to
+	  immediately raise an exception.</td>
+        <td>false</td>
       </tr>
       <tr>
         <td>strict-validation</td>
@@ -110,7 +125,8 @@
           Setting this option to 'false' causes FOP to be more forgiving about XSL-FO validity, 
           for example, you're allowed to specify a border on a region-body which is supported 
           by some FO implementations but is non-standard. Note that such a border would 
-          currently have no effect in Apache FOP.</td>
+	  currently have no effect in Apache FOP.</td>
+        <td>true</td>
       </tr>
       <tr>
         <td>break-indent-inheritance</td>
@@ -124,6 +140,7 @@
           the desired behaviour and because the behaviour among the commercial implementations
           varies. The default for this option (i.e. false) is to behave exactly like the 
           specification describes.</td>
+        <td>false</td>
       </tr>
       <tr>
         <td>default-page-settings</td>
@@ -132,11 +149,13 @@
           Specifies the default width and height of a page if "auto" is specified 
           for either or both values. Use "height" and "width" attributes on the 
           default-page-settings element to specify the two values.</td>
+        <td>"height" 11 inches, "width" 8.26 inches</td>
       </tr>
       <tr>
         <td>renderers</td>
         <td>(see text below)</td>
         <td>Contains the configuration for each renderer. See below.</td>
+	<td>N/A</td>
       </tr>
     </table>
     <p>
@@ -145,6 +164,12 @@
     <source><![CDATA[
 <fop version="1.0">
 
+  <!-- Strict user configuration -->
+  <strict-configuration>true</strict-configuration>
+
+  <!-- Strict FO validation -->
+  <strict-validation>true</strict-validation>
+
   <!-- Base URL for resolving relative URLs -->
   <base>./</base>