Return-Path: X-Original-To: apmail-hc-commits-archive@www.apache.org Delivered-To: apmail-hc-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7E5C11130F for ; Wed, 27 Aug 2014 17:08:36 +0000 (UTC) Received: (qmail 61220 invoked by uid 500); 27 Aug 2014 17:08:36 -0000 Delivered-To: apmail-hc-commits-archive@hc.apache.org Received: (qmail 61177 invoked by uid 500); 27 Aug 2014 17:08:36 -0000 Mailing-List: contact commits-help@hc.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "HttpComponents Project" Delivered-To: mailing list commits@hc.apache.org Received: (qmail 61168 invoked by uid 99); 27 Aug 2014 17:08:36 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 27 Aug 2014 17:08:36 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 27 Aug 2014 17:08:10 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 9536223889EA for ; Wed, 27 Aug 2014 17:08:08 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1620941 - in /httpcomponents/httpclient/trunk/httpclient/src: main/java/org/apache/http/conn/util/ main/java/org/apache/http/impl/cookie/ test/java/org/apache/http/conn/util/ Date: Wed, 27 Aug 2014 17:08:08 -0000 To: commits@hc.apache.org From: olegk@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20140827170808.9536223889EA@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: olegk Date: Wed Aug 27 17:08:08 2014 New Revision: 1620941 URL: http://svn.apache.org/r1620941 Log: Refactored public suffix list parser; deprecated old implementation Added: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java (with props) httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixListParser.java - copied, changed from r1620940, httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java (with props) Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java Added: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java?rev=1620941&view=auto ============================================================================== --- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java (added) +++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java Wed Aug 27 17:08:08 2014 @@ -0,0 +1,59 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + * + */ +package org.apache.http.conn.util; + +import java.util.Collections; +import java.util.List; + +import org.apache.http.annotation.Immutable; +import org.apache.http.util.Args; + +/** + * Public suffix list from publicsuffix.org. + * + * @since 4.4 + */ +@Immutable +public final class PublicSuffixList { + + private final List rules; + private final List exceptions; + + public PublicSuffixList(final List rules, final List exceptions) { + this.rules = Collections.unmodifiableList(Args.notNull(rules, "Domain suffix rules")); + this.exceptions = Collections.unmodifiableList(Args.notNull(exceptions, "Domain suffix exceptions")); + } + + public List getRules() { + return rules; + } + + public List getExceptions() { + return exceptions; + } + +} Propchange: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java ------------------------------------------------------------------------------ svn:keywords = Date Revision Propchange: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixList.java ------------------------------------------------------------------------------ svn:mime-type = text/plain Copied: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixListParser.java (from r1620940, httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java) URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixListParser.java?p2=httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixListParser.java&p1=httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java&r1=1620940&r2=1620941&rev=1620941&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java (original) +++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/util/PublicSuffixListParser.java Wed Aug 27 17:08:08 2014 @@ -24,13 +24,13 @@ * . * */ -package org.apache.http.impl.cookie; +package org.apache.http.conn.util; import java.io.BufferedReader; import java.io.IOException; import java.io.Reader; import java.util.ArrayList; -import java.util.Collection; +import java.util.List; import org.apache.http.annotation.Immutable; @@ -38,29 +38,27 @@ import org.apache.http.annotation.Immuta * Parses the list from publicsuffix.org * and configures a PublicSuffixFilter. * - * @since 4.0 + * @since 4.4 */ @Immutable -public class PublicSuffixListParser { +public final class PublicSuffixListParser { + private static final int MAX_LINE_LEN = 256; - private final PublicSuffixFilter filter; - PublicSuffixListParser(final PublicSuffixFilter filter) { - this.filter = filter; + public PublicSuffixListParser() { } /** - * Parses the public suffix list format. - * When creating the reader from the file, make sure to + * Parses the public suffix list format. When creating the reader from the file, make sure to * use the correct encoding (the original list is in UTF-8). * - * @param list the suffix list. The caller is responsible for closing the reader. - * @throws IOException on error while reading from list + * @param reader the data reader. The caller is responsible for closing the reader. + * @throws java.io.IOException on error while reading from list */ - public void parse(final Reader list) throws IOException { - final Collection rules = new ArrayList(); - final Collection exceptions = new ArrayList(); - final BufferedReader r = new BufferedReader(list); + public PublicSuffixList parse(final Reader reader) throws IOException { + final List rules = new ArrayList(); + final List exceptions = new ArrayList(); + final BufferedReader r = new BufferedReader(reader); final StringBuilder sb = new StringBuilder(256); boolean more = true; while (more) { @@ -69,12 +67,10 @@ public class PublicSuffixListParser { if (line.isEmpty()) { continue; } - if (line.startsWith("//")) - { + if (line.startsWith("//")) { continue; //entire lines can also be commented using // } - if (line.startsWith(".")) - { + if (line.startsWith(".")) { line = line.substring(1); // A leading dot is optional } // An exclamation mark (!) at the start of a rule marks an exception to a previous wildcard rule @@ -89,18 +85,9 @@ public class PublicSuffixListParser { rules.add(line); } } - - filter.setPublicSuffixes(rules); - filter.setExceptions(exceptions); + return new PublicSuffixList(rules, exceptions); } - /** - * - * @param r - * @param sb - * @return false when the end of the stream is reached - * @throws IOException - */ private boolean readLine(final Reader r, final StringBuilder sb) throws IOException { sb.setLength(0); int b; @@ -117,11 +104,11 @@ public class PublicSuffixListParser { if (!hitWhitespace) { sb.append(c); } - if (sb.length() > MAX_LINE_LEN) - { + if (sb.length() > MAX_LINE_LEN) { throw new IOException("Line too long"); // prevent excess memory usage } } return (b != -1); } + } Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java?rev=1620941&r1=1620940&r2=1620941&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java (original) +++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/PublicSuffixListParser.java Wed Aug 27 17:08:08 2014 @@ -26,27 +26,29 @@ */ package org.apache.http.impl.cookie; -import java.io.BufferedReader; import java.io.IOException; import java.io.Reader; -import java.util.ArrayList; -import java.util.Collection; import org.apache.http.annotation.Immutable; +import org.apache.http.conn.util.PublicSuffixList; /** * Parses the list from publicsuffix.org * and configures a PublicSuffixFilter. * + * @deprecated (4.4) use {@link org.apache.http.conn.util.PublicSuffixListParser}. + * * @since 4.0 */ @Immutable public class PublicSuffixListParser { - private static final int MAX_LINE_LEN = 256; + private final PublicSuffixFilter filter; + private final org.apache.http.conn.util.PublicSuffixListParser parser; PublicSuffixListParser(final PublicSuffixFilter filter) { this.filter = filter; + this.parser = new org.apache.http.conn.util.PublicSuffixListParser(); } /** @@ -54,74 +56,13 @@ public class PublicSuffixListParser { * When creating the reader from the file, make sure to * use the correct encoding (the original list is in UTF-8). * - * @param list the suffix list. The caller is responsible for closing the reader. + * @param reader the suffix list. The caller is responsible for closing the reader. * @throws IOException on error while reading from list */ - public void parse(final Reader list) throws IOException { - final Collection rules = new ArrayList(); - final Collection exceptions = new ArrayList(); - final BufferedReader r = new BufferedReader(list); - final StringBuilder sb = new StringBuilder(256); - boolean more = true; - while (more) { - more = readLine(r, sb); - String line = sb.toString(); - if (line.isEmpty()) { - continue; - } - if (line.startsWith("//")) - { - continue; //entire lines can also be commented using // - } - if (line.startsWith(".")) - { - line = line.substring(1); // A leading dot is optional - } - // An exclamation mark (!) at the start of a rule marks an exception to a previous wildcard rule - final boolean isException = line.startsWith("!"); - if (isException) { - line = line.substring(1); - } - - if (isException) { - exceptions.add(line); - } else { - rules.add(line); - } - } - - filter.setPublicSuffixes(rules); - filter.setExceptions(exceptions); + public void parse(final Reader reader) throws IOException { + final PublicSuffixList suffixList = parser.parse(reader); + filter.setPublicSuffixes(suffixList.getRules()); + filter.setExceptions(suffixList.getExceptions()); } - /** - * - * @param r - * @param sb - * @return false when the end of the stream is reached - * @throws IOException - */ - private boolean readLine(final Reader r, final StringBuilder sb) throws IOException { - sb.setLength(0); - int b; - boolean hitWhitespace = false; - while ((b = r.read()) != -1) { - final char c = (char) b; - if (c == '\n') { - break; - } - // Each line is only read up to the first whitespace - if (Character.isWhitespace(c)) { - hitWhitespace = true; - } - if (!hitWhitespace) { - sb.append(c); - } - if (sb.length() > MAX_LINE_LEN) - { - throw new IOException("Line too long"); // prevent excess memory usage - } - } - return (b != -1); - } } Added: httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java?rev=1620941&view=auto ============================================================================== --- httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java (added) +++ httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java Wed Aug 27 17:08:08 2014 @@ -0,0 +1,59 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + * + */ + +package org.apache.http.conn.util; + +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.Arrays; + +import org.apache.http.Consts; +import org.junit.Assert; +import org.junit.Test; + +public class TestPublicSuffixListParser { + + private static final String SOURCE_FILE = "suffixlist.txt"; + + @Test + public void testParse() throws Exception { + final ClassLoader classLoader = getClass().getClassLoader(); + final InputStream in = classLoader.getResourceAsStream(SOURCE_FILE); + Assert.assertNotNull(in); + final PublicSuffixList suffixList; + try { + final PublicSuffixListParser parser = new PublicSuffixListParser(); + suffixList = parser.parse(new InputStreamReader(in, Consts.UTF_8)); + } finally { + in.close(); + } + Assert.assertNotNull(suffixList); + Assert.assertEquals(Arrays.asList("jp", "ac.jp", "*.tokyo.jp", "no", "h\u00E5.no", "xx"), suffixList.getRules()); + Assert.assertEquals(Arrays.asList("metro.tokyo.jp"), suffixList.getExceptions()); + } + +} Propchange: httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java ------------------------------------------------------------------------------ svn:keywords = Date Revision Propchange: httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/conn/util/TestPublicSuffixListParser.java ------------------------------------------------------------------------------ svn:mime-type = text/plain