CVS commit: pkgsrc/pkgtools/pkg_install/files/admin

["Jonathan Perkin" <jperkin%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   jperkin
Date:           Thu Mar  7 12:22:47 UTC 2024

Modified Files:
        pkgsrc/pkgtools/pkg_install/files/admin: main.c

Log Message:
pkg_install: Add sanity checks for pkgdb correctness.

A number of users have hit "Conflicting PLIST" errors in the past that are
almost certainly caused by duplicate PKGBASE entries in the pkgdb, most likely
as a result of unpacking a bootstrap kit over the top of an existing install.

This adds a check to ensure there are no duplicate PKGBASE entries, displaying
an error message with the list of duplicates if they are found, and is called
for the "check", "rebuild", and "rebuild-tree" commands.


To generate a diff of this commit:
cvs rdiff -u -r1.69 -r1.70 pkgsrc/pkgtools/pkg_install/files/admin/main.c

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/pkgtools/pkg_install/files/admin/main.c
diff -u pkgsrc/pkgtools/pkg_install/files/admin/main.c:1.69 pkgsrc/pkgtools/pkg_install/files/admin/main.c:1.70
--- pkgsrc/pkgtools/pkg_install/files/admin/main.c:1.69 Wed Dec  2 10:45:47 2020
+++ pkgsrc/pkgtools/pkg_install/files/admin/main.c      Thu Mar  7 12:22:47 2024
@@ -1,4 +1,4 @@
-/*     $NetBSD: main.c,v 1.69 2020/12/02 10:45:47 wiz Exp $    */
+/*     $NetBSD: main.c,v 1.70 2024/03/07 12:22:47 jperkin Exp $        */
 
 #ifdef HAVE_NBTOOL_CONFIG_H
 #include "nbtool_config.h"
@@ -11,7 +11,7 @@
 #include <sys/cdefs.h>
 #endif
 #endif
-__RCSID("$NetBSD: main.c,v 1.69 2020/12/02 10:45:47 wiz Exp $");
+__RCSID("$NetBSD: main.c,v 1.70 2024/03/07 12:22:47 jperkin Exp $");
 
 /*-
  * Copyright (c) 1999-2019 The NetBSD Foundation, Inc.
@@ -95,6 +95,17 @@ struct pkgdb_count {
 };
 
 /*
+ * A simple list of pkgname/pkgbase entries in the pkgdb to verify there are
+ * no duplicate entries.
+ */
+struct pkgbase_entry {
+       char *pkgbase;
+       char *pkgname;
+       SLIST_ENTRY(pkgbase_entry) entries;
+};
+SLIST_HEAD(pkgbase_entry_head, pkgbase_entry);
+
+/*
  * A hashed list of +REQUIRED_BY entries.
  */
 struct reqd_by_entry {
@@ -398,6 +409,49 @@ add_depends_of(const char *pkgname, void
        return 0;
 }
 
+/*
+ * It is a fatal error if the pkgdb contains multiple entries with the same
+ * PKGBASE, usually caused by inserting directories manually into the pkgdb.
+ */
+static int
+check_duplicate_pkgbase(const char *pkgname, void *cookie)
+{
+       struct pkgbase_entry_head *head = cookie;
+       struct pkgbase_entry *pkg, *pkgiter;
+       char *p;
+
+       if ((p = strrchr(pkgname, '-')) == NULL) {
+               errx(EXIT_FAILURE, "entry '%s' in pkgdb is not a valid package name.",
+                   pkgname);
+       }
+
+       pkg = xmalloc(sizeof(*pkg));
+       pkg->pkgname = xstrdup(pkgname);
+       *p = '\0';
+       pkg->pkgbase = xstrdup(pkgname);
+
+       SLIST_FOREACH(pkgiter, head, entries) {
+               if (strcmp(pkg->pkgbase, pkgiter->pkgbase) == 0) {
+                       errx(EXIT_FAILURE, "corrupt pkgdb, duplicate PKGBASE entries:\n"
+                           "\t%s\n\t%s", pkg->pkgname, pkgiter->pkgname);
+               }
+       }
+
+       SLIST_INSERT_HEAD(head, pkg, entries);
+
+       return 0;
+}
+
+static void
+check_pkgdb(void)
+{
+       struct pkgbase_entry_head pbhead;
+
+       SLIST_INIT(&pbhead);
+       if (iterate_pkg_db(check_duplicate_pkgbase, &pbhead) == -1)
+               errx(EXIT_FAILURE, "cannot iterate pkgdb");
+}
+
 static void
 rebuild_tree(void)
 {
@@ -549,18 +603,20 @@ main(int argc, char *argv[])
          
        } else if (strcasecmp(argv[0], "rebuild") == 0) {
 
+               check_pkgdb();
                rebuild();
                printf("Done.\n");
 
-         
        } else if (strcasecmp(argv[0], "rebuild-tree") == 0) {
 
+               check_pkgdb();
                rebuild_tree();
                printf("Done.\n");
 
        } else if (strcasecmp(argv[0], "check") == 0) {
                argv++;         /* "check" */
 
+               check_pkgdb();
                check(argv);
 
                if (!quiet) {