utf8: don't allow NUL in decoded strings.
[ccan] / tools / ccanlint / tests / license_exists.c
index 72461bec6d40ab4b3534385dc1c1c3bc932c3c9f..3482bfee7745d6913a76380e8648a18695e62d65 100644 (file)
@@ -1,4 +1,7 @@
 #include <tools/ccanlint/ccanlint.h>
+#include <ccan/tal/tal.h>
+#include <ccan/tal/str/str.h>
+#include <ccan/tal/path/path.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <err.h>
-#include <ccan/talloc/talloc.h>
 #include <ccan/str/str.h>
+#include <ccan/take/take.h>
 
-struct ccanlint has_license;
-
-static struct doc_section *find_license(const struct manifest *m)
+/* We might need more ../ for nested modules. */
+static const char *link_prefix(struct manifest *m)
 {
-       struct doc_section *d;
+       char *prefix = tal_strdup(m, "../../");
+       unsigned int i;
 
-       list_for_each(m->info_file->doc_sections, d, list) {
-               if (!streq(d->function, m->basename))
-                       continue;
-               if (streq(d->type, "license"))
-                       return d;
-       }
-       return NULL;
+       for (i = 0; i < strcount(m->modname, "/"); i++)
+               prefix = tal_strcat(m, take(prefix), "../");
+
+       return tal_strcat(m, take(prefix), "licenses/");
 }
 
-static const char *expected_link(const struct manifest *m,
-                                struct doc_section *d)
+static const char *expected_link(const tal_t *ctx,
+                                const char *prefix, enum license license)
 {
-       if (streq(d->lines[0], "GPL")
-           || streq(d->lines[0], "GPLv3")
-           || streq(d->lines[0], "GPLv3 or later")
-           || streq(d->lines[0], "GPLv3 (or later)")
-           || streq(d->lines[0], "GPL (3 or any later version)"))
-               return "../../licenses/GPL-3";
-       if (streq(d->lines[0], "GPLv2")
-           || streq(d->lines[0], "GPLv2 or later")
-           || streq(d->lines[0], "GPLv2 (or later)")
-           || streq(d->lines[0], "GPL (2 or any later version)"))
-               return "../../licenses/GPL-3";
-       if (streq(d->lines[0], "LGPL")
-           || streq(d->lines[0], "LGPLv3")
-           || streq(d->lines[0], "LGPLv3 or later")
-           || streq(d->lines[0], "LGPLv3 (or later)")
-           || streq(d->lines[0], "LGPL (3 or any later version)"))
-               return "../../licenses/LGPL-3";
-       if (streq(d->lines[0], "LGPLv2")
-           || streq(d->lines[0], "LGPLv2 or later")
-           || streq(d->lines[0], "LGPLv2 (or later)")
-           || streq(d->lines[0], "LGPL (2 or any later version)"))
-               return "../../licenses/LGPL-2.1";
-       if (streq(d->lines[0], "BSD")
-           || streq(d->lines[0], "BSD-MIT")
-           || streq(d->lines[0], "MIT"))
-               return "../../licenses/BSD-MIT";
-       return NULL;
+       const char *shortname;
+
+       switch (license) {
+       case LICENSE_LGPLv2_PLUS:
+       case LICENSE_LGPLv2:
+               shortname = "LGPL-2.1";
+               break;
+       case LICENSE_LGPLv3:
+       case LICENSE_LGPL:
+               shortname = "LGPL-3";
+               break;
+
+       case LICENSE_GPLv2_PLUS:
+       case LICENSE_GPLv2:
+               shortname = "GPL-2";
+               break;
+
+       case LICENSE_GPLv3:
+       case LICENSE_GPL:
+               shortname = "GPL-3";
+               break;
+
+       case LICENSE_BSD:
+               shortname = "BSD-3CLAUSE";
+               break;
+
+       case LICENSE_MIT:
+               shortname = "BSD-MIT";
+               break;
+
+       case LICENSE_CC0:
+               shortname = "CC0";
+               break;
+
+       default:
+               return NULL;
+       }
+
+       return tal_strcat(ctx, prefix, shortname);
 }
 
 static void handle_license_link(struct manifest *m, struct score *score)
 {
-       const char *link = talloc_asprintf(m, "%s/LICENSE", m->dir);
-       struct doc_section *d = find_license(m);
-       const char *ldest = expected_link(m, d);
+       struct doc_section *d = find_license_tag(m);
+       const char *prefix = link_prefix(m);
+       const char *link = path_join(m, m->dir, "LICENSE");
+       const char *ldest = expected_link(score, prefix, m->license);
        char *q;
 
        printf(
        "Most modules want a copy of their license, so usually we create a\n"
-       "LICENSE symlink into ../../licenses to avoid too many copies.\n");
+       "LICENSE symlink into %s to avoid too many copies.\n", prefix);
 
        /* FIXME: make ask printf-like */
-       q = talloc_asprintf(m, "Set up link to %s (license is %s)?",
-                           ldest, d->lines[0]);
+       q = tal_fmt(m, "Set up link to %s (license is %s)?",
+                   ldest, d->lines[0]);
        if (ask(q)) {
                if (symlink(ldest, link) != 0)
                        err(1, "Creating symlink %s -> %s", link, ldest);
        }
 }
 
+extern struct ccanlint license_exists;
+
 static void check_has_license(struct manifest *m,
-                             bool keep,
-                             unsigned int *timeleft, struct score *score)
+                             unsigned int *timeleft UNNEEDED,
+                             struct score *score)
 {
        char buf[PATH_MAX];
        ssize_t len;
-       char *license = talloc_asprintf(m, "%s/LICENSE", m->dir);
+       char *license = path_join(m, m->dir, "LICENSE");
        const char *expected;
        struct doc_section *d;
+       const char *prefix = link_prefix(m);
 
-       d = find_license(m);
+       d = find_license_tag(m);
        if (!d) {
-               score->error = talloc_strdup(score, "No License: tag in _info");
+               score->error = tal_strdup(score, "No License: tag in _info");
+               return;
+       }
+
+       m->license = which_license(d);
+       if (m->license == LICENSE_UNKNOWN) {
+               score_file_error(score, m->info_file, d->srcline,
+                                "WARNING: unknown License: in _info: %s",
+                                d->lines[0]);
+               /* FIXME: For historical reasons, don't fail here. */
+               score->pass = true;
                return;
        }
-       expected = expected_link(m, d);
+
+       /* If they have a license tag at all, we pass. */
+       score->pass = true;
+
+       expected = expected_link(m, prefix, m->license);
 
        len = readlink(license, buf, sizeof(buf));
        if (len < 0) {
                /* Could be a real file... OK if not a standard license. */
                if (errno == EINVAL) {
                        if (!expected) {
-                               score->pass = true;
+                               score->score = score->total;
                                return;
                        }
                        score->error
-                               = talloc_asprintf(score,
+                               = tal_fmt(score,
                                          "License in _info is '%s',"
                                          " expect LICENSE symlink '%s'",
                                          d->lines[0], expected);
                        return;
                }
                if (errno == ENOENT) {
-                       score->error = talloc_strdup(score,
+                       /* Public domain doesn't really need a file. */
+                       if (m->license == LICENSE_PUBLIC_DOMAIN) {
+                               score->score = score->total;
+                               return;
+                       }
+                       score->error = tal_strdup(score,
                                                     "LICENSE does not exist");
                        if (expected)
-                               has_license.handle = handle_license_link;
+                               license_exists.handle = handle_license_link;
                        return;
                }
                err(1, "readlink on %s", license);
@@ -124,24 +159,23 @@ static void check_has_license(struct manifest *m,
 
        buf[len] = '\0';
 
-       if (!strstarts(buf, "../../licenses/")) {
-               score->error = talloc_asprintf(score,
-                                              "Expected symlink to"
-                                              " ../../licenses/..."
-                                              " not %s", buf);
+       if (!strstarts(buf, prefix)) {
+               score->error = tal_fmt(score,
+                                      "Expected symlink into %s not %s",
+                                      prefix, buf);
                return;
        }
 
        if (!expected) {
-               score->error = talloc_asprintf(score,
-                                         "License in _info is unknown '%s',"
-                                         " but LICENSE symlink is '%s'",
-                                         d->lines[0], buf);
+               score->error = tal_fmt(score,
+                                      "License in _info is unknown '%s',"
+                                      " but LICENSE symlink is '%s'",
+                                      d->lines[0], buf);
                return;
        }
 
        if (!streq(buf, expected)) {
-               score->error = talloc_asprintf(score,
+               score->error = tal_fmt(score,
                                       "Expected symlink to %s not %s",
                                       expected, buf);
                return;
@@ -156,5 +190,4 @@ struct ccanlint license_exists = {
        .check = check_has_license,
        .needs = "info_exists"
 };
-
 REGISTER_TEST(license_exists);