Skip to content

Some ASCII-safe constants as byte[] to obviate ASCII-check #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Some ASCII-safe constants as byte[] to obviate ASCII-check #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 44 additions & 17 deletions axiom-api/src/main/java/org/apache/axiom/mime/MultipartBodyWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import java.io.IOException;
import java.io.OutputStream;
import java.io.UncheckedIOException;
import java.util.List;

import org.apache.axiom.blob.Blob;
Expand Down Expand Up @@ -70,13 +71,26 @@ public void write(byte[] b) throws IOException {

@Override
public void close() throws IOException {
writeAscii("\r\n");
writeAscii(SAFE_CR_LF);
}
}

private final OutputStream out;
private final String boundary;
private final byte[] buffer = new byte[256];

/*
* Some ASCII-safe constants as byte[] to obviate ASCII-check every time they are written...
*/
private static final String CR_LF = "\r\n";
private static final byte[] SAFE_CR_LF = CR_LF .getBytes();
private static final byte[] SAFE_CR_LF_CR_LF = (CR_LF + CR_LF ).getBytes();
private static final byte[] SAFE_CR_LF_CONTENT_TYPE = (CR_LF + "Content-Type: " ).getBytes();
private static final byte[] SAFE_CR_LF_CONTENT_ID = (CR_LF + "Content-ID: <" ).getBytes();
private static final byte[] SAFE_CR_LF_CONTENT_TRANSFER_ENCODING = (CR_LF + "Content-Transfer-Encoding: ").getBytes();
private static final byte[] SAFE_COLON_SPACE = ": " .getBytes();
private static final byte[] SAFE_DASH_DASH = "--" .getBytes();
private static final byte[] SAFE_DASH_DASH_CR_LF = ("--" + CR_LF ).getBytes();

private final byte[] safeBoundary;
private final OutputStream out;
private final byte[] buffer = new byte[256];

/**
* Constructor.
Expand All @@ -90,7 +104,20 @@ public void close() throws IOException {
*/
public MultipartBodyWriter(OutputStream out, String boundary) {
this.out = out;
this.boundary = boundary;
this.safeBoundary = boundary.getBytes();

for (final char boundaryChar : boundary.toCharArray()) {
if (boundaryChar >= 128) {
throw new UncheckedIOException(new IOException("Illegal character '" + boundaryChar + "' in Boundary.: " + boundary));
/*
* TODO alternatively, throw a (checked) IOException, but then Callers need to be changed too.
*/
}
}
}

private void writeAscii(final byte[] asciiSafeBytes) throws IOException {
out.write(asciiSafeBytes);
}

void writeAscii(String s) throws IOException {
Expand Down Expand Up @@ -132,30 +159,30 @@ void writeAscii(String s) throws IOException {
*/
public OutputStream writePart(ContentType contentType, ContentTransferEncoding contentTransferEncoding,
String contentID, List<Header> extraHeaders) throws IOException {
writeAscii("--");
writeAscii(boundary);
writeAscii(SAFE_DASH_DASH);
writeAscii(safeBoundary);
// RFC 2046 explicitly says that Content-Type is not mandatory (and defaults to
// text/plain; charset=us-ascii).
if (contentType != null) {
writeAscii("\r\nContent-Type: ");
writeAscii(SAFE_CR_LF_CONTENT_TYPE);
writeAscii(contentType.toString());
}
writeAscii("\r\nContent-Transfer-Encoding: ");
writeAscii(SAFE_CR_LF_CONTENT_TRANSFER_ENCODING);
writeAscii(contentTransferEncoding.toString());
if (contentID != null) {
writeAscii("\r\nContent-ID: <");
writeAscii(SAFE_CR_LF_CONTENT_ID);
writeAscii(contentID);
out.write('>');
}
if (extraHeaders != null) {
for (Header header : extraHeaders) {
writeAscii("\r\n");
writeAscii(SAFE_CR_LF);
writeAscii(header.getName());
writeAscii(": ");
writeAscii(SAFE_COLON_SPACE);
writeAscii(header.getValue());
}
}
writeAscii("\r\n\r\n");
writeAscii(SAFE_CR_LF_CR_LF);
return contentTransferEncoding.encode(new PartOutputStream(out));
}

Expand Down Expand Up @@ -191,8 +218,8 @@ public void writePart(Blob blob, ContentType contentType, ContentTransferEncodin
* if an I/O error occurs when writing to the underlying stream
*/
public void complete() throws IOException {
writeAscii("--");
writeAscii(boundary);
writeAscii("--\r\n");
writeAscii(SAFE_DASH_DASH);
writeAscii(safeBoundary);
writeAscii(SAFE_DASH_DASH_CR_LF);
}
}