git.ozlabs.org Git - ccan/blob - tools/ccanlint/tests/license_exists.c

   1 #include <tools/ccanlint/ccanlint.h>
   2 #include <sys/types.h>
   3 #include <sys/stat.h>
   4 #include <fcntl.h>
   5 #include <unistd.h>
   6 #include <limits.h>
   7 #include <errno.h>
   8 #include <stdlib.h>
   9 #include <stdio.h>
  10 #include <err.h>
  11 #include <ccan/talloc/talloc.h>
  12 #include <ccan/str/str.h>
  13
  14 static const char *expected_link(enum license license)
  15 {
  16         switch (license) {
  17         case LICENSE_LGPLv2_PLUS:
  18         case LICENSE_LGPLv2:
  19                 return "../../licenses/LGPL-2.1";
  20         case LICENSE_LGPLv3:
  21         case LICENSE_LGPL:
  22                 return "../../licenses/LGPL-3";
  23
  24         case LICENSE_GPLv2_PLUS:
  25         case LICENSE_GPLv2:
  26                 return "../../licenses/GPL-2";
  27
  28         case LICENSE_GPLv3:
  29         case LICENSE_GPL:
  30                 return "../../licenses/GPL-3";
  31
  32         case LICENSE_BSD:
  33                 return "../../licenses/BSD-3CLAUSE";
  34
  35         case LICENSE_MIT:
  36                 return "../../licenses/BSD-MIT";
  37
  38         default:
  39                 return NULL;
  40         }
  41 }
  42
  43 static void handle_license_link(struct manifest *m, struct score *score)
  44 {
  45         struct doc_section *d = find_license_tag(m);
  46         const char *link = talloc_asprintf(m, "%s/LICENSE", m->dir);
  47         const char *ldest = expected_link(m->license);
  48         char *q;
  49
  50         printf(
  51         "Most modules want a copy of their license, so usually we create a\n"
  52         "LICENSE symlink into ../../licenses to avoid too many copies.\n");
  53
  54         /* FIXME: make ask printf-like */
  55         q = talloc_asprintf(m, "Set up link to %s (license is %s)?",
  56                             ldest, d->lines[0]);
  57         if (ask(q)) {
  58                 if (symlink(ldest, link) != 0)
  59                         err(1, "Creating symlink %s -> %s", link, ldest);
  60         }
  61 }
  62
  63 extern struct ccanlint license_exists;
  64
  65 static void check_has_license(struct manifest *m,
  66                               unsigned int *timeleft, struct score *score)
  67 {
  68         char buf[PATH_MAX];
  69         ssize_t len;
  70         char *license = talloc_asprintf(m, "%s/LICENSE", m->dir);
  71         const char *expected;
  72         struct doc_section *d;
  73
  74         d = find_license_tag(m);
  75         if (!d) {
  76                 score->error = talloc_strdup(score, "No License: tag in _info");
  77                 return;
  78         }
  79
  80         m->license = which_license(d);
  81         if (m->license == LICENSE_UNKNOWN) {
  82                 score_file_error(score, m->info_file, d->srcline,
  83                                  "WARNING: unknown License: in _info: %s",
  84                                  d->lines[0]);
  85                 /* FIXME: For historical reasons, don't fail here. */
  86                 score->pass = true;
  87                 return;
  88         }
  89
  90         /* If they have a license tag at all, we pass. */
  91         score->pass = true;
  92
  93         expected = expected_link(m->license);
  94
  95         len = readlink(license, buf, sizeof(buf));
  96         if (len < 0) {
  97                 /* Could be a real file... OK if not a standard license. */
  98                 if (errno == EINVAL) {
  99                         if (!expected) {
 100                                 score->score = score->total;
 101                                 return;
 102                         }
 103                         score->error
 104                                 = talloc_asprintf(score,
 105                                           "License in _info is '%s',"
 106                                           " expect LICENSE symlink '%s'",
 107                                           d->lines[0], expected);
 108                         return;
 109                 }
 110                 if (errno == ENOENT) {
 111                         /* Public domain doesn't really need a file. */
 112                         if (m->license == LICENSE_PUBLIC_DOMAIN) {
 113                                 score->score = score->total;
 114                                 return;
 115                         }
 116                         score->error = talloc_strdup(score,
 117                                                      "LICENSE does not exist");
 118                         if (expected)
 119                                 license_exists.handle = handle_license_link;
 120                         return;
 121                 }
 122                 err(1, "readlink on %s", license);
 123         }
 124         if (len >= sizeof(buf))
 125                 errx(1, "Reading symlink %s gave huge result", license);
 126
 127         buf[len] = '\0';
 128
 129         if (!strstarts(buf, "../../licenses/")) {
 130                 score->error = talloc_asprintf(score,
 131                                                "Expected symlink to"
 132                                                " ../../licenses/..."
 133                                                " not %s", buf);
 134                 return;
 135         }
 136
 137         if (!expected) {
 138                 score->error = talloc_asprintf(score,
 139                                           "License in _info is unknown '%s',"
 140                                           " but LICENSE symlink is '%s'",
 141                                           d->lines[0], buf);
 142                 return;
 143         }
 144
 145         if (!streq(buf, expected)) {
 146                 score->error = talloc_asprintf(score,
 147                                        "Expected symlink to %s not %s",
 148                                        expected, buf);
 149                 return;
 150         }
 151         score->pass = true;
 152         score->score = score->total;
 153 }
 154
 155 struct ccanlint license_exists = {
 156         .key = "license_exists",
 157         .name = "Module has License: entry in _info, and LICENSE symlink/file",
 158         .check = check_has_license,
 159         .needs = "info_exists"
 160 };
 161 REGISTER_TEST(license_exists);