stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

5082756: Image I/O plug-ins set metadata boolean attributes to "true" or "false"

Browse Source 
Reviewed-by: igor, prr
This commit is contained in:
Martin von Gagern 2009-01-13 16:55:12 +03:00 committed by Andrew Brygin
parent 729f2789f0
commit bf4d190698
8 changed files with 224 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
jdk/src/share/classes/com/sun/imageio/plugins/gif/GIFImageMetadata.java
View File

@ -153,7 +153,7 @@ public class GIFImageMetadata extends GIFMetadata {
node.setAttribute("imageWidth", Integer.toString(imageWidth));
node.setAttribute("imageHeight", Integer.toString(imageHeight));
node.setAttribute("interlaceFlag",
interlaceFlag ? "true" : "false");
interlaceFlag ? "TRUE" : "FALSE");
root.appendChild(node);
// Local color table
@ -185,9 +185,9 @@ public class GIFImageMetadata extends GIFMetadata {
node.setAttribute("disposalMethod",
disposalMethodNames[disposalMethod]);
node.setAttribute("userInputFlag",
userInputFlag ? "true" : "false");
userInputFlag ? "TRUE" : "FALSE");
node.setAttribute("transparentColorFlag",
transparentColorFlag ? "true" : "false");
transparentColorFlag ? "TRUE" : "FALSE");
node.setAttribute("delayTime",
Integer.toString(delayTime));
node.setAttribute("transparentColorIndex",

9
jdk/src/share/classes/com/sun/imageio/plugins/gif/GIFMetadata.java
View File

@ -158,13 +158,10 @@ abstract class GIFMetadata extends IIOMetadata {
}
}
String value = attr.getNodeValue();
// XXX Should be able to use equals() here instead of
// equalsIgnoreCase() but some boolean attributes are incorrectly
// set to "true" or "false" by the J2SE core metadata classes
// getAsTree() method (which are duplicated above). See bug 5082756.
if (value.equalsIgnoreCase("TRUE")) {
// Allow lower case booleans for backward compatibility, #5082756
if (value.equals("TRUE") || value.equals("true")) {
return true;
} else if (value.equalsIgnoreCase("FALSE")) {
} else if (value.equals("FALSE") || value.equals("false")) {
return false;
} else {
fatal(node, "Attribute " + name + " must be 'TRUE' or 'FALSE'!");

2
jdk/src/share/classes/com/sun/imageio/plugins/gif/GIFStreamMetadata.java
View File

@ -202,7 +202,7 @@ public class GIFStreamMetadata extends GIFMetadata {
compression_node.appendChild(node);
node = new IIOMetadataNode("Lossless");
node.setAttribute("value", "true");
node.setAttribute("value", "TRUE");
compression_node.appendChild(node);
// NumProgressiveScans not in stream

2
jdk/src/share/classes/com/sun/imageio/plugins/jpeg/JPEGMetadata.java
View File

@ -955,7 +955,7 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
// Lossless - false
IIOMetadataNode lossless = new IIOMetadataNode("Lossless");
lossless.setAttribute("value", "false");
lossless.setAttribute("value", "FALSE");
compression.appendChild(lossless);
// NumProgressiveScans - count sos segments

13
jdk/src/share/classes/com/sun/imageio/plugins/png/PNGMetadata.java
View File

@ -600,7 +600,7 @@ public class PNGMetadata extends IIOMetadata implements Cloneable {
IIOMetadataNode iTXt_node = new IIOMetadataNode("iTXtEntry");
iTXt_node.setAttribute("keyword", iTXt_keyword.get(i));
iTXt_node.setAttribute("compressionFlag",
iTXt_compressionFlag.get(i) ? "1" : "0");
iTXt_compressionFlag.get(i) ? "TRUE" : "FALSE");
iTXt_node.setAttribute("compressionMethod",
iTXt_compressionMethod.get(i).toString());
iTXt_node.setAttribute("languageTag",
@ -832,7 +832,7 @@ public class PNGMetadata extends IIOMetadata implements Cloneable {
}
node = new IIOMetadataNode("BlackIsZero");
node.setAttribute("value", "true");
node.setAttribute("value", "TRUE");
chroma_node.appendChild(node);
if (PLTE_present) {
@ -894,7 +894,7 @@ public class PNGMetadata extends IIOMetadata implements Cloneable {
compression_node.appendChild(node);
node = new IIOMetadataNode("Lossless");
node.setAttribute("value", "true");
node.setAttribute("value", "TRUE");
compression_node.appendChild(node);
node = new IIOMetadataNode("NumProgressiveScans");
@ -1162,12 +1162,13 @@ public class PNGMetadata extends IIOMetadata implements Cloneable {
}
}
String value = attr.getNodeValue();
if (value.equals("true")) {
// Allow lower case booleans for backward compatibility, #5082756
if (value.equals("TRUE") || value.equals("true")) {
return true;
} else if (value.equals("false")) {
} else if (value.equals("FALSE") || value.equals("false")) {
return false;
} else {
fatal(node, "Attribute " + name + " must be 'true' or 'false'!");
fatal(node, "Attribute " + name + " must be 'TRUE' or 'FALSE'!");
return false;
}
}

8
jdk/src/share/classes/javax/imageio/metadata/IIOMetadataFormat.java
View File

@ -242,8 +242,12 @@ public interface IIOMetadataFormat {
/**
* A constant returned by <code>getAttributeDataType</code>
* indicating that the value of an attribute is one of 'true' or
* 'false'.
* indicating that the value of an attribute is one of the boolean
* values 'true' or 'false'.
* Attribute values of type DATATYPE_BOOLEAN should be marked as
* enumerations, and the permitted values should be the string
* literal values "TRUE" or "FALSE", although a plugin may also
* recognise lower or mixed case equivalents.
*/
int DATATYPE_BOOLEAN = 1;

202
jdk/test/javax/imageio/metadata/BooleanAttributes.java Normal file
View File

@ -0,0 +1,202 @@
/*
* Copyright 2008 Sun Microsystems, Inc. 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. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
/**
* @test
* @bug 5082756
* @summary ensure that boolean attributes follow ( "TRUE" | "FALSE" )
* including correct (i.e. upper) case
*
* @run main BooleanAttributes
*/
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.StringReader;
import java.util.Arrays;
import java.util.List;
import javax.imageio.IIOImage;
import javax.imageio.ImageIO;
import javax.imageio.ImageReader;
import javax.imageio.ImageTypeSpecifier;
import javax.imageio.ImageWriteParam;
import javax.imageio.ImageWriter;
import javax.imageio.metadata.IIOMetadata;
import javax.imageio.stream.ImageInputStream;
import javax.imageio.stream.ImageOutputStream;
import javax.imageio.stream.MemoryCacheImageInputStream;
import javax.imageio.stream.MemoryCacheImageOutputStream;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.stream.StreamSource;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
public class BooleanAttributes {
private static TransformerFactory transformerFactory =
TransformerFactory.newInstance();
private static XPath xpathEngine = XPathFactory.newInstance().newXPath();
public static void main(String[] args) throws Exception {
test("image/png", false, "<javax_imageio_1.0 />",
"Chroma/BlackIsZero/@value",
"Compression/Lossless/@value");
test("image/png", false,
"<javax_imageio_png_1.0>" +
"<iTXt><iTXtEntry keyword='Comment' compressionFlag='TRUE' " +
"compressionMethod='0' languageTag='en' " +
"translatedKeyword='comment' text='foo'/></iTXt>" +
"</javax_imageio_png_1.0>",
"iTXt/iTXtEntry/@compressionFlag");
test("image/png", false,
"<javax_imageio_png_1.0>" +
"<iTXt><iTXtEntry keyword='Comment' compressionFlag='FALSE' " +
"compressionMethod='0' languageTag='en' " +
"translatedKeyword='comment' text='foo'/></iTXt>" +
"</javax_imageio_png_1.0>",
"iTXt/iTXtEntry/@compressionFlag");
test("image/gif", false, "<javax_imageio_1.0 />",
"Chroma/BlackIsZero/@value",
"Compression/Lossless/@value");
test("image/gif", false,
"<javax_imageio_gif_image_1.0>" +
"<ImageDescriptor imageLeftPosition='0' imageTopPosition='0' " +
"imageWidth='16' imageHeight='16' interlaceFlag='TRUE' />" +
"<LocalColorTable sizeOfLocalColorTable='2' " +
"backgroundColorIndex='1' sortFlag='TRUE'>" +
"<ColorTableEntry index='0' red='0' green='0' blue='0' />" +
"<ColorTableEntry index='1' red='255' green='255' blue='255' />" +
"</LocalColorTable>" +
"<GraphicControlExtension disposalMethod='doNotDispose' " +
"userInputFlag='FALSE' transparentColorFlag='TRUE' " +
"delayTime='100' transparentColorIndex='1' />" +
"</javax_imageio_gif_image_1.0>",
"ImageDescriptor/@interlaceFlag",
"LocalColorTable/@sortFlag",
"GraphicControlExtension/@userInputFlag",
"GraphicControlExtension/@transparentColorFlag");
test("image/gif", true,
"<javax_imageio_gif_stream_1.0>" +
"<GlobalColorTable sizeOfGlobalColorTable='2' " +
"backgroundColorIndex='1' sortFlag='TRUE'>" +
"<ColorTableEntry index='0' red='0' green='0' blue='0' />" +
"<ColorTableEntry index='1' red='255' green='255' blue='255' />" +
"</GlobalColorTable>" +
"</javax_imageio_gif_stream_1.0>",
"GlobalColorTable/@sortFlag");
test("image/jpeg", false, "<javax_imageio_1.0 />",
"Compression/Lossless/@value");
}
private static void transform(Source src, Result dst)
throws Exception
{
transformerFactory.newTransformer().transform(src, dst);
}
private static void verify(Node meta, String[] xpaths, boolean required)
throws Exception
{
for (String xpath: xpaths) {
NodeList list = (NodeList)
xpathEngine.evaluate(xpath, meta, XPathConstants.NODESET);
if (list.getLength() == 0 && required)
throw new AssertionError("Missing value: " + xpath);
for (int i = 0; i < list.getLength(); ++i) {
String value = list.item(i).getNodeValue();
if (!(value.equals("TRUE") || value.equals("FALSE")))
throw new AssertionError(xpath + " has value " + value);
}
}
}
public static void test(String mimeType, boolean useStreamMeta,
String metaXml, String... boolXpaths)
throws Exception
{
BufferedImage img =
new BufferedImage(16, 16, BufferedImage.TYPE_INT_RGB);
ImageWriter iw = ImageIO.getImageWritersByMIMEType(mimeType).next();
ByteArrayOutputStream os = new ByteArrayOutputStream();
ImageOutputStream ios = new MemoryCacheImageOutputStream(os);
iw.setOutput(ios);
ImageWriteParam param = null;
IIOMetadata streamMeta = iw.getDefaultStreamMetadata(param);
IIOMetadata imageMeta =
iw.getDefaultImageMetadata(new ImageTypeSpecifier(img), param);
IIOMetadata meta = useStreamMeta ? streamMeta : imageMeta;
Source src = new StreamSource(new StringReader(metaXml));
DOMResult dst = new DOMResult();
transform(src, dst);
Document doc = (Document)dst.getNode();
Element node = doc.getDocumentElement();
String metaFormat = node.getNodeName();
// Verify that the default metadata gets formatted correctly.
verify(meta.getAsTree(metaFormat), boolXpaths, false);
meta.mergeTree(metaFormat, node);
// Verify that the merged metadata gets formatte correctly.
verify(meta.getAsTree(metaFormat), boolXpaths, true);
iw.write(streamMeta, new IIOImage(img, null, imageMeta), param);
iw.dispose();
ios.close();
ImageReader ir = ImageIO.getImageReader(iw);
byte[] bytes = os.toByteArray();
if (bytes.length == 0)
throw new AssertionError("Zero length image file");
ByteArrayInputStream is = new ByteArrayInputStream(bytes);
ImageInputStream iis = new MemoryCacheImageInputStream(is);
ir.setInput(iis);
if (useStreamMeta) meta = ir.getStreamMetadata();
else meta = ir.getImageMetadata(0);
// Verify again after writing and re-reading the image
verify(meta.getAsTree(metaFormat), boolXpaths, true);
}
public static void xtest(Object... eatAnyArguments) {
System.err.println("Disabled test! Change xtest back into test!");
}
}

2
jdk/test/javax/imageio/plugins/png/ITXtTest.java
View File

@ -123,7 +123,7 @@ public class ITXtTest {
}
t.keyword = e.getAttribute("keyword");
t.isCompressed =
(Integer.valueOf(e.getAttribute("compressionFlag")).intValue() == 1);
Boolean.valueOf(e.getAttribute("compressionFlag")).booleanValue();
t.compression =
Integer.valueOf(e.getAttribute("compressionMethod")).intValue();
t.language = e.getAttribute("languageTag");