Commit 8de1e8a6 authored by Rusty Russell's avatar Rusty Russell

ccanlint: make a license enum, and parse the license string to set it.

This improves on the current ad-hoc methods, and also fixes a bug where
we mapped "GPLv2" to the GPLv3 symlink.
parent da8558a1
...@@ -16,6 +16,21 @@ ...@@ -16,6 +16,21 @@
4 == Describe every action. */ 4 == Describe every action. */
extern int verbose; extern int verbose;
enum license {
LICENSE_LGPLv2_PLUS,
LICENSE_LGPLv2,
LICENSE_LGPLv3,
LICENSE_LGPL,
LICENSE_GPLv2_PLUS,
LICENSE_GPLv2,
LICENSE_GPLv3,
LICENSE_GPL,
LICENSE_BSD,
LICENSE_MIT,
LICENSE_PUBLIC_DOMAIN,
LICENSE_UNKNOWN
};
struct manifest { struct manifest {
char *dir; char *dir;
/* The module name, ie. final element of dir name */ /* The module name, ie. final element of dir name */
...@@ -43,6 +58,9 @@ struct manifest { ...@@ -43,6 +58,9 @@ struct manifest {
/* From tests/check_depends_exist.c */ /* From tests/check_depends_exist.c */
struct list_head deps; struct list_head deps;
/* From tests/license_exists.c */
enum license license;
}; };
/* Get the manifest for a given directory. */ /* Get the manifest for a given directory. */
......
...@@ -10,8 +10,9 @@ ...@@ -10,8 +10,9 @@
#include <err.h> #include <err.h>
#include <ccan/talloc/talloc.h> #include <ccan/talloc/talloc.h>
#include <ccan/str/str.h> #include <ccan/str/str.h>
#include <ccan/str_talloc/str_talloc.h>
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; struct doc_section *d;
...@@ -24,44 +25,76 @@ static struct doc_section *find_license(const struct manifest *m) ...@@ -24,44 +25,76 @@ static struct doc_section *find_license(const struct manifest *m)
return NULL; return NULL;
} }
static const char *expected_link(const struct manifest *m, static enum license which_license(struct doc_section *d)
struct doc_section *d)
{ {
if (streq(d->lines[0], "GPL") if (strstarts(d->lines[0], "GPL")) {
|| streq(d->lines[0], "GPLv3") if (strchr(d->lines[0], '3'))
|| streq(d->lines[0], "GPLv3 or later") return LICENSE_GPLv3;
|| streq(d->lines[0], "GPLv3 (or later)") else if (strchr(d->lines[0], '2')) {
|| streq(d->lines[0], "GPL (3 or any later version)")) if (strreg(NULL, d->lines[0], "or (any )?later", NULL))
return "../../licenses/GPL-3"; return LICENSE_GPLv2_PLUS;
if (streq(d->lines[0], "GPLv2") else
|| streq(d->lines[0], "GPLv2 or later") return LICENSE_GPLv2;
|| streq(d->lines[0], "GPLv2 (or later)") }
|| streq(d->lines[0], "GPL (2 or any later version)")) return LICENSE_GPL;
return "../../licenses/GPL-3"; }
if (streq(d->lines[0], "LGPL")
|| streq(d->lines[0], "LGPLv3") if (strstarts(d->lines[0], "LGPL")) {
|| streq(d->lines[0], "LGPLv3 or later") if (strchr(d->lines[0], '3'))
|| streq(d->lines[0], "LGPLv3 (or later)") return LICENSE_LGPLv3;
|| streq(d->lines[0], "LGPL (3 or any later version)")) else if (strchr(d->lines[0], '2')) {
return "../../licenses/LGPL-3"; if (strreg(NULL, d->lines[0], "or (any )?later", NULL))
if (streq(d->lines[0], "LGPLv2") return LICENSE_LGPLv2_PLUS;
|| streq(d->lines[0], "LGPLv2 or later") else
|| streq(d->lines[0], "LGPLv2 (or later)") return LICENSE_LGPLv2;
|| streq(d->lines[0], "LGPL (2 or any later version)")) }
return "../../licenses/LGPL-2.1"; return LICENSE_LGPL;
}
if (streq(d->lines[0], "BSD-MIT") if (streq(d->lines[0], "BSD-MIT")
|| streq(d->lines[0], "MIT")) || streq(d->lines[0], "MIT"))
return "../../licenses/BSD-MIT"; return LICENSE_MIT;
if (streq(d->lines[0], "BSD (3 clause)")) 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";
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"; return "../../licenses/BSD-3CLAUSE";
return NULL;
case LICENSE_MIT:
return "../../licenses/BSD-MIT";
default:
return NULL;
}
} }
static void handle_license_link(struct manifest *m, struct score *score) 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); const char *link = talloc_asprintf(m, "%s/LICENSE", m->dir);
struct doc_section *d = find_license(m); const char *ldest = expected_link(m->license);
const char *ldest = expected_link(m, d);
char *q; char *q;
printf( printf(
...@@ -89,22 +122,25 @@ static void check_has_license(struct manifest *m, ...@@ -89,22 +122,25 @@ static void check_has_license(struct manifest *m,
const char *expected; const char *expected;
struct doc_section *d; struct doc_section *d;
d = find_license(m); d = find_license_tag(m);
if (!d) { if (!d) {
score->error = talloc_strdup(score, "No License: tag in _info"); score->error = talloc_strdup(score, "No License: tag in _info");
return; return;
} }
m->license = which_license(d);
/* If they have a license tag at all, we pass. */ /* If they have a license tag at all, we pass. */
score->pass = true; score->pass = true;
expected = expected_link(m, d); expected = expected_link(m->license);
len = readlink(license, buf, sizeof(buf)); len = readlink(license, buf, sizeof(buf));
if (len < 0) { if (len < 0) {
/* Could be a real file... OK if not a standard license. */ /* Could be a real file... OK if not a standard license. */
if (errno == EINVAL) { if (errno == EINVAL) {
if (!expected) { if (!expected) {
score->pass = true; score->score = score->total;
return; return;
} }
score->error score->error
...@@ -115,6 +151,11 @@ static void check_has_license(struct manifest *m, ...@@ -115,6 +151,11 @@ static void check_has_license(struct manifest *m,
return; return;
} }
if (errno == ENOENT) { if (errno == ENOENT) {
/* Public domain doesn't really need a file. */
if (m->license == LICENSE_PUBLIC_DOMAIN) {
score->score = score->total;
return;
}
score->error = talloc_strdup(score, score->error = talloc_strdup(score,
"LICENSE does not exist"); "LICENSE does not exist");
if (expected) if (expected)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment