Browse Source

manifest issues

br: 37548
Still not totally convinced that the line is not allowed to be 74 bytes long (including eol)
But the specs allow to cut off early, except for the name. So name is allowed to by 70 bytes
long, and only if the name is 70 or 69 bytes long the line will be 74 (73) bytes long. Else
it will be shorter than 72 bytes including eol.

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@420638 13f79535-47bb-0310-9956-ffa450edef68
master
Jacobus Martinus Kruithof 19 years ago
parent
commit
176b11946b
4 changed files with 87 additions and 5 deletions
  1. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/Jar.java
  2. +43
    -3
      src/main/org/apache/tools/ant/taskdefs/Manifest.java
  3. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/ManifestTask.java
  4. +42
    -0
      src/testcases/org/apache/tools/ant/taskdefs/ManifestTest.java

+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/Jar.java View File

@@ -429,7 +429,7 @@ public class Jar extends Zip {
JAR_MARKER); JAR_MARKER);
// time to write the manifest // time to write the manifest
ByteArrayOutputStream baos = new ByteArrayOutputStream(); ByteArrayOutputStream baos = new ByteArrayOutputStream();
OutputStreamWriter osw = new OutputStreamWriter(baos, "UTF-8");
OutputStreamWriter osw = new OutputStreamWriter(baos, Manifest.JAR_ENCODING);
PrintWriter writer = new PrintWriter(osw); PrintWriter writer = new PrintWriter(osw);
manifest.write(writer); manifest.write(writer);
writer.flush(); writer.flush();


+ 43
- 3
src/main/org/apache/tools/ant/taskdefs/Manifest.java View File

@@ -83,11 +83,32 @@ public class Manifest {
public static final String ERROR_FROM_FORBIDDEN = "Manifest attributes should not start " public static final String ERROR_FROM_FORBIDDEN = "Manifest attributes should not start "
+ "with \"" + ATTRIBUTE_FROM + "\" in \""; + "with \"" + ATTRIBUTE_FROM + "\" in \"";


/** Encoding to be used for JAR files. */
public static final String JAR_ENCODING = "UTF-8";
/** /**
* An attribute for the manifest. * An attribute for the manifest.
* Those attributes that are not nested into a section will be added to the "Main" section. * Those attributes that are not nested into a section will be added to the "Main" section.
*/ */
public static class Attribute { public static class Attribute {

/**
* Maximum length of the name to have the value starting on the same
* line as the name. This to stay under 72 bytes total line length
* (including CRLF).
*/
private static final int MAX_NAME_VALUE_LENGTH = 68;

/**
* Maximum length of the name according to the jar specification.
* In this case the first line will have 74 bytes total line length
* (including CRLF). This conflicts with the 72 bytes total line length
* max, but is the only possible conclusion from the manifest specification, if
* names with 70 bytes length are allowed, have to be on the first line, and
* have to be followed by ": ".
*/
private static final int MAX_NAME_LENGTH = 70;

/** The attribute's name */ /** The attribute's name */
private String name = null; private String name = null;


@@ -302,12 +323,31 @@ public class Manifest {
*/ */
private void writeValue(PrintWriter writer, String value) private void writeValue(PrintWriter writer, String value)
throws IOException { throws IOException {
String line = name + ": " + value;
while (line.getBytes().length > MAX_LINE_LENGTH) {
String line = null;
int nameLength = name.getBytes(JAR_ENCODING).length;
if (nameLength > MAX_NAME_VALUE_LENGTH)
{
if (nameLength > MAX_NAME_LENGTH)
{
throw new IOException("Unable to write manifest line "
+ name + ": " + value);
}
writer.print(name + ": " + EOL);
line = " " + value;
}
else
{
line = name + ": " + value;
}
while (line.getBytes(JAR_ENCODING).length > MAX_SECTION_LENGTH) {
// try to find a MAX_LINE_LENGTH byte section // try to find a MAX_LINE_LENGTH byte section
int breakIndex = MAX_SECTION_LENGTH; int breakIndex = MAX_SECTION_LENGTH;
if (breakIndex >= line.length())
{
breakIndex = line.length() - 1;
}
String section = line.substring(0, breakIndex); String section = line.substring(0, breakIndex);
while (section.getBytes().length > MAX_SECTION_LENGTH
while (section.getBytes(JAR_ENCODING).length > MAX_SECTION_LENGTH
&& breakIndex > 0) { && breakIndex > 0) {
breakIndex--; breakIndex--;
section = line.substring(0, breakIndex); section = line.substring(0, breakIndex);


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/ManifestTask.java View File

@@ -199,7 +199,7 @@ public class ManifestTask extends Task {
PrintWriter w = null; PrintWriter w = null;
try { try {
FileOutputStream fos = new FileOutputStream(manifestFile); FileOutputStream fos = new FileOutputStream(manifestFile);
OutputStreamWriter osw = new OutputStreamWriter(fos, "UTF-8");
OutputStreamWriter osw = new OutputStreamWriter(fos, Manifest.JAR_ENCODING);
w = new PrintWriter(osw); w = new PrintWriter(osw);
toWrite.write(w); toWrite.write(w);
} catch (IOException e) { } catch (IOException e) {


+ 42
- 0
src/testcases/org/apache/tools/ant/taskdefs/ManifestTest.java View File

@@ -17,10 +17,13 @@


package org.apache.tools.ant.taskdefs; package org.apache.tools.ant.taskdefs;


import java.io.BufferedReader;
import java.io.File; import java.io.File;
import java.io.FileReader; import java.io.FileReader;
import java.io.IOException; import java.io.IOException;
import java.util.Enumeration; import java.util.Enumeration;
import java.util.HashSet;
import java.util.Set;


import org.apache.tools.ant.BuildFileTest; import org.apache.tools.ant.BuildFileTest;
import org.apache.tools.ant.Project; import org.apache.tools.ant.Project;
@@ -40,6 +43,15 @@ public class ManifestTest extends BuildFileTest {
"OfCourseTheAnswerIsThatIsWhatTheSpecRequiresAndIfAnythingHas" + "OfCourseTheAnswerIsThatIsWhatTheSpecRequiresAndIfAnythingHas" +
"AProblemWithThatItIsNotABugInAnt"; "AProblemWithThatItIsNotABugInAnt";


public static final String LONG_70_NAME
= "ThisNameIsJustSeventyCharactersWhichIsAllowedAccordingToTheSpecsFiller";
public static final String LONG_68_NAME
= "ThisNameIsJustSixtyEightCharactersWhichIsAllowedAccordingToTheSpecsX";
public static final String NOT_LONG_NAME
= "NameIsJustUnderSeventyCharactersWhichIsAllowedAccordingTheSpec";

public static final String VALUE = "NOT_LONG";

public ManifestTest(String name) { public ManifestTest(String name) {
super(name); super(name);
} }
@@ -192,6 +204,10 @@ public class ManifestTest extends BuildFileTest {
public void testLongLine() throws IOException, ManifestException { public void testLongLine() throws IOException, ManifestException {
Project p = getProject(); Project p = getProject();
p.setUserProperty("test.longline", LONG_LINE); p.setUserProperty("test.longline", LONG_LINE);
p.setUserProperty("test.long68name" , LONG_68_NAME);
p.setUserProperty("test.long70name" , LONG_70_NAME);
p.setUserProperty("test.notlongname" , NOT_LONG_NAME);
p.setUserProperty("test.value", VALUE);
executeTarget("testLongLine"); executeTarget("testLongLine");


Manifest manifest = getManifest(EXPANDED_MANIFEST); Manifest manifest = getManifest(EXPANDED_MANIFEST);
@@ -199,6 +215,32 @@ public class ManifestTest extends BuildFileTest {
String classpath = mainSection.getAttributeValue("class-path"); String classpath = mainSection.getAttributeValue("class-path");
assertEquals("Class-Path attribute was not set correctly - ", assertEquals("Class-Path attribute was not set correctly - ",
LONG_LINE, classpath); LONG_LINE, classpath);
String value = mainSection.getAttributeValue(LONG_68_NAME);
assertEquals("LONG_68_NAME_VALUE_MISMATCH", VALUE, value);
value = mainSection.getAttributeValue(LONG_70_NAME);
assertEquals("LONG_70_NAME_VALUE_MISMATCH", VALUE, value);
value = mainSection.getAttributeValue(NOT_LONG_NAME);
assertEquals("NOT_LONG_NAME_VALUE_MISMATCH", VALUE, value);
BufferedReader in = new BufferedReader(new FileReader(EXPANDED_MANIFEST));
Set set = new HashSet();
String read = in.readLine();
while (read != null)
{
set.add(read);
read = in.readLine();
}
assertTrue("Manifest file should have contained string ", set
.remove(" NOT_LONG"));
assertTrue("Manifest file should have contained string ", set
.remove(" NG"));
assertTrue("Manifest file should have contained string ", set
.remove(LONG_70_NAME + ": "));
assertTrue("Manifest file should have contained string ", set
.remove(NOT_LONG_NAME + ": NOT_LO"));
} }


/** /**


Loading…
Cancel
Save