Skip to content
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.

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

#473 Refactoring Request-Line validation #484

Merged
merged 11 commits into from
Jan 6, 2016
33 changes: 2 additions & 31 deletions src/main/java/org/takes/rq/RqHref.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.util.Iterator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import lombok.EqualsAndHashCode;
import org.takes.HttpException;
import org.takes.Request;
Expand Down Expand Up @@ -63,15 +61,6 @@ public interface RqHref extends Request {
@EqualsAndHashCode(callSuper = true)
final class Base extends RqWrap implements RqHref {

/**
* HTTP Request-Line pattern.
* @see <a href="http://www
* .w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1">RFC 2616</a>
*/
private static final Pattern REQUEST_PATTERN = Pattern.compile(
"([!-~]+) ([^ ]+)( [^ ]+)?"
);

/**
* Ctor.
* @param req Original request
Expand All @@ -80,28 +69,10 @@ public Base(final Request req) {
super(req);
}

// @todo #445:30min/DEV RqMethod already validates Request-Line and
// extracts HTTP Method from it. We should extract all important
// information from Request-Line (HTTP method, URI and HTTP version)
// in one place to enforce DRY principle.
@Override
public Href href() throws IOException {
if (!this.head().iterator().hasNext()) {
throw new HttpException(
HttpURLConnection.HTTP_BAD_REQUEST,
"HTTP Request should have Request-Line"
);
}
final String line = this.head().iterator().next();
final Matcher matcher =
REQUEST_PATTERN.matcher(line);
if (!matcher.matches()) {
throw new HttpException(
HttpURLConnection.HTTP_BAD_REQUEST,
String.format("Illegal Request-Line: %s", line)
);
}
final String uri = matcher.group(2);
final String uri = new RqRequestLine.Base(this)
.uri();
return new Href(
String.format(
"http://%s%s",
Expand Down
19 changes: 2 additions & 17 deletions src/main/java/org/takes/rq/RqMethod.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@

import java.io.IOException;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import lombok.EqualsAndHashCode;
import org.takes.Request;
Expand Down Expand Up @@ -112,14 +111,6 @@ final class Base extends RqWrap implements RqMethod {
"[()<>@,;:\\\"/\\[\\]?={}]"
);

/**
* HTTP method line pattern.
* [!-~] is for method or extension-method token (octets 33 - 126).
*/
private static final Pattern PATTERN = Pattern.compile(
"([!-~]+) [^ ]+( [^ ]+){0,1}"
);

/**
* Ctor.
* @param req Original request
Expand All @@ -130,14 +121,8 @@ public Base(final Request req) {

@Override
public String method() throws IOException {
final String line = this.head().iterator().next();
final Matcher matcher = PATTERN.matcher(line);
if (!matcher.matches()) {
throw new IOException(
String.format("Invalid HTTP method line: %s", line)
);
}
final String method = matcher.group(1);
final String method = new RqRequestLine.Base(this)
.method();
if (SEPARATORS.matcher(method).find()) {
throw new IOException(
String.format("Invalid HTTP method: %s", method)
Expand Down
212 changes: 212 additions & 0 deletions src/main/java/org/takes/rq/RqRequestLine.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
/**
* The MIT License (MIT)
*
* Copyright (c) 2015 Yegor Bugayenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.takes.rq;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import lombok.EqualsAndHashCode;
import org.takes.HttpException;
import org.takes.Request;

/**
* HTTP Request-Line parsing.
*
* <p>All implementations of this interface must be immutable and thread-safe.
*
* @author Vladimir Maksimenko (xupypr@xupypr.com)
* @version $Id$
* @since 0.29.1
*/
@SuppressWarnings("PMD.TooManyMethods")
public interface RqRequestLine extends Request {

/**
* Get Request-Line header.
* @return HTTP Request-Line header
* @throws IOException If fails
*/
String header() throws IOException;

/**
* Get Request-Line method token.
* @return HTTP Request-Line method token
* @throws IOException If fails
*/
String method() throws IOException;

/**
* Get Request-Line Request-URI token.
* @return HTTP Request-Line method token
* @throws IOException If fails
*/
String uri() throws IOException;

/**
* Get Request-Line HTTP-Version token.
* @return HTTP Request-Line method token
* @throws IOException If fails
*/
String version() throws IOException;

/**
* Request decorator for Request-Line header validation
*
* <p>The class is immutable and thread-safe.
* @author Vladimir Maksimenko (xupypr@xupypr.com)
* @version $Id$
* @since 1.0
*/
@EqualsAndHashCode(callSuper = true)
final class Base extends RqWrap implements RqRequestLine {
/**
* HTTP Request-line pattern.
* [!-~] is for method or extension-method token (octets 33 - 126).
* @see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1">RFC 2616</a>
*/
private static final Pattern PATTERN = Pattern.compile(
"([!-~]+) ([^ ]+)( [^ ]+)?"
);

private static enum Token {
/**
* METHOD token.
*/
METHOD(1),

/**
* URI token.
*/
URI(2),

/**
* HTTPVERSION token.
*/
HTTPVERSION(3);

/**
* Value.
*/
private final int value;

/**
* Ctor.
* @param val Value
*/
private Token(final int val) {
this.value = val;
}
}

/**
* Ctor.
* @param req Original request
*/
public Base(final Request req) {
super(req);
}

@Override
public String header() throws IOException {
final String line = this.line();
this.matcher(line);
return line;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xupyprmv read this one again: http://www.yegor256.com/2015/12/08/temporal-coupling-between-method-calls.html Your code here should look like this:

public String header() {
  return this.validated(this.line());
}

See the idea?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xupyprmv maybe I'm wrong with this exact example, but this.matcher(line) is a code smell. You should never use functions as procedures, ignoring their returns.

}

@Override
public String method() throws IOException {
return this.token(Token.METHOD);
}

@Override
public String uri() throws IOException {
return this.token(Token.URI);
}

@Override
public String version() throws IOException {
return this.token(Token.HTTPVERSION);
}

/**
* Get Request-Line header token.
* @param token Token
* @return HTTP Request-Line header token
* @throws IOException If fails
*/
private String token(final Token token)
throws IOException {
final String result = this.matcher(this.line())
.group(token.value);
if (result == null) {
throw new IllegalArgumentException(
String.format(
"There is no token %s in Request-Line header",
token.toString()
)
);
}
return result.trim();
}

/**
* Get Request-Line header.
*
* @return Valid Request-Line header
* @throws IOException If fails
*/
private String line() throws IOException {
if (!this.head().iterator().hasNext()) {
throw new HttpException(
HttpURLConnection.HTTP_BAD_REQUEST,
"HTTP Request should have Request-Line"
);
}
return this.head().iterator().next();
}

/**
* Validate Request-Line according to PATTERN.
*
* @param line Request-Line header
* @return Matcher that can be used to extract tokens
* @throws HttpException If fails
*/
private Matcher matcher(final String line)
throws HttpException {
final Matcher matcher = PATTERN.matcher(line);
if (!matcher.matches()) {
throw new HttpException(
HttpURLConnection.HTTP_BAD_REQUEST,
String.format(
"Invalid HTTP Request-Line header: %s",
line
)
);
}
return matcher;
}
}
}
Loading