8075810: LogManager.readConfiguration may throw undocumented IllegalArgumentException
Summary: LogManager.readConfiguration will wrap the IllegalArgumentException thrown by Properties.load inside an IOException.
Reviewed-by: lancea, mchung, rriggs
--- a/jdk/src/java.logging/share/classes/java/util/logging/LogManager.java Wed Apr 01 16:01:41 2015 +0300
+++ b/jdk/src/java.logging/share/classes/java/util/logging/LogManager.java Thu Apr 02 11:42:07 2015 +0200
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -1379,7 +1379,19 @@
reset();
// Load the properties
- props.load(ins);
+ try {
+ props.load(ins);
+ } catch (IllegalArgumentException x) {
+ // props.load may throw an IllegalArgumentException if the stream
+ // contains malformed Unicode escape sequences.
+ // We wrap that in an IOException as readConfiguration is
+ // specified to throw IOException if there are problems reading
+ // from the stream.
+ // Note: new IOException(x.getMessage(), x) allow us to get a more
+ // concise error message than new IOException(x);
+ throw new IOException(x.getMessage(), x);
+ }
+
// Instantiate new configuration objects.
String names[] = parseClassNames("config");
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/test/java/util/logging/LogManager/Configuration/InvalidEscapeConfigurationTest.java Thu Apr 02 11:42:07 2015 +0200
@@ -0,0 +1,164 @@
+/*
+ * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.io.UnsupportedEncodingException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Properties;
+import java.util.logging.LogManager;
+
+
+/**
+ * @test
+ * @bug 8075810
+ * @run main/othervm InvalidEscapeConfigurationTest
+ * @author danielfuchs
+ */
+public class InvalidEscapeConfigurationTest {
+
+ public static void main(String[] args)
+ throws UnsupportedEncodingException, IOException {
+ String[] validEscapes = {
+ "com.f\\u006fo.level = INF\\u004f",
+ "com.f\\u006fo.level = INFO",
+ "com.foo.level = INF\\u004f"
+ };
+ String[] invalidEscapes = {
+ "com.fo\\u0O6f.level = INF\\u0O4f",
+ "com.fo\\u0O6f.level = INFO",
+ "com.foo.level = INF\\u0O4f"
+ };
+ for (String line : validEscapes) {
+ test(line, true);
+ }
+ for (String line : invalidEscapes) {
+ test(line, false);
+ }
+ try {
+ Properties props = new Properties();
+ props.load((InputStream)null);
+ throw new RuntimeException("Properties.load(null): "
+ + "NullPointerException exception not raised");
+ } catch (NullPointerException x) {
+ System.out.println("Properties.load(null): "
+ + "got expected exception: " + x);
+ }
+ try {
+ LogManager.getLogManager().readConfiguration(null);
+ throw new RuntimeException("LogManager.readConfiguration(null): "
+ + "NullPointerException exception not raised");
+ } catch (NullPointerException x) {
+ System.out.println("LogManager.readConfiguration(null): "
+ + "got expected exception: " + x);
+ }
+
+
+ }
+
+ public static void test(String line, boolean valid) throws IOException {
+ String test = (valid ? "valid" : "invalid")
+ + " line \"" +line + "\"";
+ System.out.println("Testing " + test);
+
+ // First verify that we get the expected result from Properties.load()
+ try {
+ ByteArrayInputStream bais =
+ new ByteArrayInputStream(line.getBytes("UTF-8"));
+ Properties props = new Properties();
+ props.load(bais);
+ if (!valid) {
+ throw new RuntimeException(test
+ + "\n\tProperties.load: expected exception not raised");
+ } else {
+ System.out.println("Properties.load passed for " + test);
+ }
+ } catch(IllegalArgumentException x) {
+ if (!valid) {
+ System.out.println(
+ "Properties.load: Got expected exception: "
+ + x + "\n\tfor " + test);
+ } else {
+ throw x;
+ }
+ }
+
+ // Then verify that we get the expected result from
+ // LogManager.readConfiguration
+ try {
+ String content = defaultConfiguration() + '\n' + line + '\n';
+ ByteArrayInputStream bais =
+ new ByteArrayInputStream(content.getBytes("UTF-8"));
+ LogManager.getLogManager().readConfiguration(bais);
+ if (!valid) {
+ throw new RuntimeException(test
+ + "\n\tLogManager.readConfiguration: "
+ + "expected exception not raised");
+ } else {
+ System.out.println("LogManager.readConfiguration passed for "
+ + test);
+ }
+ } catch(IOException x) {
+ if (!valid) {
+ System.out.println(
+ "LogManager.readConfiguration: Got expected exception: "
+ + x + "\n\tfor " + test);
+ } else {
+ throw x;
+ }
+ }
+ }
+
+ static String getConfigurationFileName() {
+ String fname = System.getProperty("java.util.logging.config.file");
+ if (fname == null) {
+ fname = System.getProperty("java.home");
+ if (fname == null) {
+ throw new Error("Can't find java.home ??");
+ }
+ fname = Paths.get(fname, "conf", "logging.properties")
+ .toAbsolutePath().normalize().toString();
+ }
+ return fname;
+ }
+
+ static String defaultConfiguration() throws IOException {
+ Properties props = new Properties();
+ String fileName = getConfigurationFileName();
+ if (Files.exists(Paths.get(fileName))) {
+ try (InputStream is = new FileInputStream(fileName);) {
+ props.load(is);
+ } catch(IOException x) {
+ throw new UncheckedIOException(x);
+ }
+ }
+ ByteArrayOutputStream bos = new ByteArrayOutputStream();
+ props.store(bos, null);
+ return bos.toString();
+ }
+
+}