]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/license_exists.c
ccanlint: tighten license check.
[ccan] / tools / ccanlint / tests / license_exists.c
index 965a159ff8fff53f15bea96d4675c052eedbd9f0..dbfe29b5d7e450498c881a98dca6e81eb7ffc2bf 100644 (file)
 #include <err.h>
 #include <ccan/talloc/talloc.h>
 #include <ccan/str/str.h>
+#include <ccan/str_talloc/str_talloc.h>
 
-struct ccanlint has_license;
-
-static struct doc_section *find_license(const struct manifest *m)
+static struct doc_section *find_license_tag(const struct manifest *m)
 {
        struct doc_section *d;
 
@@ -26,43 +25,80 @@ static struct doc_section *find_license(const struct manifest *m)
        return NULL;
 }
 
-static const char *expected_link(const struct manifest *m,
-                                struct doc_section *d)
+/* See GPLv2 and v2 (basically same wording) for interpreting versions:
+ * the "any later version" means the recepient can choose. */
+static enum license which_license(struct doc_section *d)
 {
-       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)"))
+       /* This means "user chooses what version", including GPLv1! */
+       if (streq(d->lines[0], "GPL"))
+               return LICENSE_GPL;
+       /* This means "v2 only". */
+       if (streq(d->lines[0], "GPLv2"))
+               return LICENSE_GPLv2;
+       /* This means "v2 or above" at user's choice. */
+       if (streq(d->lines[0], "GPL (v2 or any later version)"))
+               return LICENSE_GPLv2_PLUS;
+       /* This means "v3 or above" at user's choice. */
+       if (streq(d->lines[0], "GPL (v3 or any later version)"))
+               return LICENSE_GPLv3;
+
+       /* This means "user chooses what version" */
+       if (streq(d->lines[0], "LGPL"))
+               return LICENSE_LGPL;
+       /* This means "v2.1 only". */
+       if (streq(d->lines[0], "LGPLv2.1"))
+               return LICENSE_LGPLv2;
+       /* This means "v2.1 or above" at user's choice. */
+       if (streq(d->lines[0], "LGPL (v2.1 or any later version)"))
+               return LICENSE_LGPLv2_PLUS;
+       /* This means "v3 or above" at user's choice. */
+       if (streq(d->lines[0], "LGPL (v3 or any later version)"))
+               return LICENSE_LGPLv3;
+
+       if (streq(d->lines[0], "BSD-MIT") || streq(d->lines[0], "MIT"))
+               return LICENSE_MIT;
+       if (streq(d->lines[0], "BSD (3 clause)"))
+               return LICENSE_BSD;
+       if (strreg(NULL, d->lines[0], "[Pp]ublic [Dd]omain"))
+               return LICENSE_PUBLIC_DOMAIN;
+
+       return LICENSE_UNKNOWN;
+}
+
+static const char *expected_link(enum license license)
+{
+       switch (license) {
+       case LICENSE_LGPLv2_PLUS:
+       case LICENSE_LGPLv2:
                return "../../licenses/LGPL-2.1";
-       if (streq(d->lines[0], "BSD")
-           || streq(d->lines[0], "BSD-MIT")
-           || streq(d->lines[0], "MIT"))
+       case LICENSE_LGPLv3:
+       case LICENSE_LGPL:
+               return "../../licenses/LGPL-3";
+
+       case LICENSE_GPLv2_PLUS:
+       case LICENSE_GPLv2:
+               return "../../licenses/GPL-2";
+
+       case LICENSE_GPLv3:
+       case LICENSE_GPL:
+               return "../../licenses/GPL-3";
+
+       case LICENSE_BSD:
+               return "../../licenses/BSD-3CLAUSE";
+
+       case LICENSE_MIT:
                return "../../licenses/BSD-MIT";
-       return NULL;
+
+       default:
+               return NULL;
+       }
 }
 
 static void handle_license_link(struct manifest *m, struct score *score)
 {
+       struct doc_section *d = find_license_tag(m);
        const char *link = talloc_asprintf(m, "%s/LICENSE", m->dir);
-       struct doc_section *d = find_license(m);
-       const char *ldest = expected_link(m, d);
+       const char *ldest = expected_link(m->license);
        char *q;
 
        printf(
@@ -78,6 +114,8 @@ static void handle_license_link(struct manifest *m, struct score *score)
        }
 }
 
+extern struct ccanlint license_exists;
+
 static void check_has_license(struct manifest *m,
                              bool keep,
                              unsigned int *timeleft, struct score *score)
@@ -88,19 +126,33 @@ static void check_has_license(struct manifest *m,
        const char *expected;
        struct doc_section *d;
 
-       d = find_license(m);
+       d = find_license_tag(m);
        if (!d) {
-               score->error = "No License: tag in _info";
+               score->error = talloc_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->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
@@ -111,9 +163,15 @@ static void check_has_license(struct manifest *m,
                        return;
                }
                if (errno == ENOENT) {
-                       score->error = "LICENSE does not exist";
+                       /* Public domain doesn't really need a file. */
+                       if (m->license == LICENSE_PUBLIC_DOMAIN) {
+                               score->score = score->total;
+                               return;
+                       }
+                       score->error = talloc_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);
@@ -155,5 +213,4 @@ struct ccanlint license_exists = {
        .check = check_has_license,
        .needs = "info_exists"
 };
-
 REGISTER_TEST(license_exists);