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)
.requestLineHeaderToken(RqRequestLine.URI);
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv the indentation step should be 4 spaces

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)
.requestLineHeaderToken(RqRequestLine.METHOD);
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv the indentation step should be 4 spaces

if (SEPARATORS.matcher(method).find()) {
throw new IOException(
String.format("Invalid HTTP method: %s", method)
Expand Down
159 changes: 159 additions & 0 deletions src/main/java/org/takes/rq/RqRequestLine.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
/**
* 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 1.0
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv 0.30

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dmzaytsev I take version 1.0 from pom.xml file. Please, can you explain where I can get information about next version. That helps me not to do the same mistake in future.

Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv I add 0.0.1 to the last release usually
https://github.com/yegor256/takes/releases

Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv so it will be 0.29.1

*/
public interface RqRequestLine extends Request {

/**
* METHOD token.
*/
int METHOD = 1;

/**
* URI token.
*/
int URI = 2;

/**
* HTTPVERSION token.
*/
int HTTPVERSION = 3;
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv I think we can use enumeration instead of these constants here


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

/**
* Get Request-Line header token by index number.
* @param index Token index number
* @return HTTP Request-Line header token specified by index number
* @throws IOException If fails
*/
String requestLineHeaderToken(int index) 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
Copy link
Owner

Choose a reason for hiding this comment

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

@xupyprmv this won't work with JavaDoc. just put it all in one long line, checkstyle won't complain

* .w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1">RFC 2616</a>
*/
private static final Pattern PATTERN = Pattern.compile(
"([!-~]+) ([^ ]+)( [^ ]+)?"
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv the indentation step should be 4 spaces

);

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

@Override
public String requestLineHeader() throws IOException {
return this.extractFromRequestLineHeader(null);
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv can we avoid using null here and below?
http://www.yegor256.com/2014/05/13/why-null-is-bad.html

}

@Override
public String requestLineHeaderToken(final int index)
throws IOException {
// @checkstyle MagicNumberCheck (1 lines)
if (index < 1 || index > 3) {
Copy link
Contributor

Choose a reason for hiding this comment

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

@xupyprmv so if we will use enumeration we don't need this condition

throw new IllegalArgumentException(
String.format("Illegel indexNumber %d", index)
);
}
return this.extractFromRequestLineHeader(index);
}

/**
* Extract Request-Line or Request-Line token from Request.
*
* @param index Token index number
* @return Request-Line if index is null, token as string otherwise
* @throws IOException If fails
*/
private String extractFromRequestLineHeader(final Integer index)
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 = PATTERN.matcher(line);
if (!matcher.matches()) {
throw new HttpException(
HttpURLConnection.HTTP_BAD_REQUEST,
String.format(
"Invalid HTTP Request-Line header: %s",
line
)
);
}
if (index != null) {
final String token = matcher.group(index);
final String result;
if (token == null) {
result = token;
} else {
result = token.trim();
}
return result;
}
return line;
}
}
}
Loading