Fixed the implementation to handle "*" sub-domains.

Updated the public_suffix_list.dat to the latest.
Added an `mk` script to easily rebuild the library and tools.
Allow the public_suffix_list.dat to be in the tests/... sub-folder.
Updated the tests to pass with the latest version.
Added a test to verify specific URLs (in tld_test.c).
Fixed file description at the top of two tests.
Added the .gitignore file.
Replaced many tabs with spaces so diffs as expected.
Updated the copyright year.

Author: AlexisWilke

.gitignore

@@ -0,0 +1,3 @@
+*.sw?
+gmon.out
+tmp

README.md

@@ -39,6 +39,8 @@ The documentation can also be generated from the source using Doxygen.
 
 # Notes:
 
+* Version 1.6.0 properly handles sub-domains defined with an asterisk.
+
 * Version 1.5.9 has been updated to the latest version of the world TLDs.
   It also includes a fix to the email code so spaces are forbidden.
 

debian/changelog

@@ -1,3 +1,18 @@
+libtld (1.6.0.0~xenial) xenial; urgency=high
+
+  * Fixed the implementation to properly support "*" sub-domains.
+  * Updated the public_suffix_list.dat to the latest.
+  * Added an `mk` script to easily rebuild the library and tools.
+  * Allow the public_suffix_list.dat to be in the tests/... sub-folder.
+  * Updated the tests to pass with the latest version.
+  * Added a test to verify specific URLs (in tld_test.c).
+  * Fixed file description at the top of two tests.
+  * Added the .gitignore file.
+  * Replaced many tabs with spaces so diffs as expected.
+  * Updated the copyright year.
+
+ -- Alexis Wilke <[email protected]>  Fri, 07 May 2021 17:09:15 -0700
+
 libtld (1.5.14.0~xenial) xenial; urgency=high
 
   * Fixed the compile of QString() with QChar() that does not offer a `char`.

debian/copyright

@@ -6,10 +6,10 @@ Source: https://snapwebsites.org/project/libtld
 License: MIT
 Disclaimer: This package is part of the Snap! C++ system. It is not a native Debian package.
 Copyright:
- Copyright (c) 2011-2019  Made to Order Software Corp.  All Rights Reserved
+ Copyright (c) 2011-2021  Made to Order Software Corp.  All Rights Reserved
 
 Files: tests/public_suffix_list.dat
-Copyright: Copyright (c) 2007-2017 Mozilla Foundation
+Copyright: Copyright (c) 2007-2021 Mozilla Foundation
 License: Mozilla Public License, v. 2.0
  Mozilla Public License
  Version 2.0
@@ -369,5 +369,5 @@ License: Mozilla Public License, v. 2.0
  as defined by the Mozilla Public License, v. 2.0.
 
 Files: CMakeLists.txt debian/* dev/* doc/* include/* package/* php/* src/* tests/*
-Copyright: Copyright (c) 2011-2019  Made to Order Software Corp.  All Rights Reserved
+Copyright: Copyright (c) 2011-2021  Made to Order Software Corp.  All Rights Reserved
 License: MIT

dev/libtld-only-CMakeLists.txt

@@ -28,8 +28,8 @@
 #
 
 set(LIBTLD_VERSION_MAJOR 1)
-set(LIBTLD_VERSION_MINOR 5)
-set(LIBTLD_VERSION_PATCH 11)
+set(LIBTLD_VERSION_MINOR 6)
+set(LIBTLD_VERSION_PATCH 0)
 
 cmake_minimum_required(VERSION 2.8.4)
 project(tld)

mk

@@ -0,0 +1,50 @@
+#!/bin/sh
+#
+# Sample script to run make without having to retype the long path each time
+# This will work if you built the environment using our ~/bin/build-snap script
+
+PROJECT=libtld
+PROCESSORS="`nproc`"
+BUILDDIR="../../../BUILD/contrib/${PROJECT}"
+
+# "Brief Version" -- for the documentation
+VERSION=`dpkg-parsechangelog --show-field Version | sed -e 's/~.*//' -e 's/\(^[0-9]\+\.[0-9]\+\).*/\1/'`
+
+
+case $1 in
+"-l")
+	make -C ${BUILDDIR} 2>&1 | less -SR
+	;;
+
+"-d")
+	rm -rf ${BUILDDIR}/doc/${PROJECT}-doc-${VERSION}.tar.gz
+	make -C ${BUILDDIR}
+	;;
+
+"-i")
+	make -j${PROCESSORS} -C ${BUILDDIR} install
+	;;
+
+"-t")
+	(
+		if make -j${PROCESSORS} -C ${BUILDDIR}
+		then
+			shift
+			${BUILDDIR}/tests/unittest --progress $*
+		fi
+	) 2>&1 | less -SR
+	;;
+
+"-r")
+	make -j${PROCESSORS} -C ${BUILDDIR}
+	;;
+
+"")
+	make -j${PROCESSORS} -C ${BUILDDIR}
+	;;
+
+*)
+	echo "error: unknown command line option \"$1\""
+	;;
+
+esac

src/CMakeLists.txt

@@ -2,7 +2,7 @@
 # File:         src/CMakeLists.txt
 # Object:       Definitions to create the build environment with cmake
 #
-# Copyright:    Copyright (c) 2011-2019  Made to Order Software Corp.  All Rights Reserved
+# Copyright:    Copyright (c) 2011-2021  Made to Order Software Corp.  All Rights Reserved
 #
 # https://snapwebsites.org/project/libtld
 # [email protected]

src/tld.c

@@ -1,5 +1,5 @@
 /* TLD library -- TLD, domain name, and sub-domain extraction
- * Copyright (c) 2011-2019  Made to Order Software Corp.  All Rights Reserved
+ * Copyright (c) 2011-2021  Made to Order Software Corp.  All Rights Reserved
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the
@@ -327,12 +327,13 @@
  */
 static int cmp(const char *a, const char *b, int n)
 {
-    /* if `a == "*"` then it always a match! */
+    /* if `a == "*"` then we have a bug in the table
     if(a[0] == '*'
     && a[1] == '\0')
     {
         return 0;
     }
+    */
 
     /* n represents the maximum number of characters to check in b */
     while(n > 0 && *a != '\0')
@@ -395,32 +396,43 @@ static int cmp(const char *a, const char *b, int n)
  */
 int search(int i, int j, const char *domain, int n)
 {
-    int p, r;
+    int auto_match = -1, p, r;
     const struct tld_description *tld;
 
-    while(i < j)
+    if(i < j)
     {
-        p = (j - i) / 2 + i;
-        tld = tld_descriptions + p;
-        r = cmp(tld->f_tld, domain, n);
-        if(r < 0)
+        /* the "*" breaks the binary search, we have to handle it specially */
+        tld = tld_descriptions + i;
+        if(tld->f_tld[0] == '*' && tld->f_tld[1] == '\0')
         {
-            /* eliminate the first half */
-            i = p + 1;
+            auto_match = i;
+            ++i;
         }
-        else if(r > 0)
-        {
-            /* eliminate the second half */
-            j = p;
-        }
-        else
+
+        while(i < j)
         {
-            /* match */
-            return p;
+            p = (j - i) / 2 + i;
+            tld = tld_descriptions + p;
+            r = cmp(tld->f_tld, domain, n);
+            if(r < 0)
+            {
+                /* eliminate the first half */
+                i = p + 1;
+            }
+            else if(r > 0)
+            {
+                /* eliminate the second half */
+                j = p;
+            }
+            else
+            {
+                /* match */
+                return p;
+            }
         }
     }
 
-    return -1;
+    return auto_match;
 }
 
 
@@ -556,7 +568,7 @@ enum tld_result tld(const char *uri, struct tld_info *info)
 {
     const char *end = uri;
     const char **level_ptr;
-    int level = 0, start_level, i, r, p;
+    int level = 0, start_level, i, r, p, offset;
     enum tld_result result;
 
     /* set defaults in the info structure */
@@ -598,7 +610,7 @@ enum tld_result tld(const char *uri, struct tld_info *info)
         }
         ++end;
     }
-    /* if level is not at least 1 then there are no period */
+    /* if level is not at least 1 then there are no periods */
     if(level == 0)
     {
         /* no TLD */
@@ -633,6 +645,7 @@ enum tld_result tld(const char *uri, struct tld_info *info)
         p = r;
         --level;
     }
+    offset = (int) (level_ptr[level] - uri);
 
     /* if there are exceptions we may need to search those now if level is 0 */
     if(level == 0)
@@ -644,29 +657,39 @@ enum tld_result tld(const char *uri, struct tld_info *info)
         if(r != -1)
         {
             p = r;
+            offset = 0;
         }
     }
 
     info->f_status = tld_descriptions[p].f_status;
-    result = info->f_status == TLD_STATUS_VALID
-                ? TLD_RESULT_SUCCESS
-                : TLD_RESULT_INVALID;
-
-    /* did we hit an exception? */
-    if(tld_descriptions[p].f_status == TLD_STATUS_EXCEPTION)
+    switch(info->f_status)
     {
-        /* return the actual TLD and not the exception */
+    case TLD_STATUS_VALID:
+        result = TLD_RESULT_SUCCESS;
+        break;
+
+    case TLD_STATUS_EXCEPTION:
+        /* return the actual TLD and not the exception
+         * i.e. "nacion.ar" is valid and the TLD is just ".ar"
+         * even though top level ".ar" is forbidden by default
+         */
         p = tld_descriptions[p].f_exception_apply_to;
         level = start_level - tld_descriptions[p].f_exception_level;
+        offset = (int) (level_ptr[level] - uri);
         info->f_status = TLD_STATUS_VALID;
         result = TLD_RESULT_SUCCESS;
+        break;
+
+    default:
+        result = TLD_RESULT_INVALID;
+        break;
+
     }
 
-    /* return a valid result */
     info->f_category = tld_descriptions[p].f_category;
     info->f_country = tld_descriptions[p].f_country;
     info->f_tld = level_ptr[level];
-    info->f_offset = (int) (level_ptr[level] - uri);
+    info->f_offset = offset;
 
     free(level_ptr);
 

src/tld_data.h

@@ -1,5 +1,5 @@
 /* TLD library -- TLD, domain name, and sub-domain extraction
- * Copyright (c) 2011-2019  Made to Order Software Corp.  All Rights Reserved
+ * Copyright (c) 2011-2021  Made to Order Software Corp.  All Rights Reserved
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the
@@ -117,6 +117,9 @@ struct tld_description
      * The string is read-only and cannot ever be modified.
      * However, we do not return this string to the caller. Instead
      * we return a pointer inside the caller's string.
+     *
+     * The string may be "*" which means that any name is valid but
+     * a name is required for a valid match at this level.
      */
     const char *                f_tld;