]> arthur.barton.de Git - netatalk.git/blobdiff - etc/cnid_dbd/cmd_dbd.c
New dbd cleanup option -c
[netatalk.git] / etc / cnid_dbd / cmd_dbd.c
index 337fea657d46e914c6506b9fc735d7c1f1a9d775..6ce3e23ac9add35cb66a6b2f02a6b0b4a1c8d3c4 100644 (file)
@@ -1,5 +1,5 @@
 /* 
-   $Id: cmd_dbd.c,v 1.1 2009-05-14 13:46:08 franklahm Exp $
+   $Id: cmd_dbd.c,v 1.25 2010-04-11 07:01:23 franklahm Exp $
 
    Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
    
    GNU General Public License for more details.
 */
 
+/*
+  dbd specs and implementation progress
+  =====================================
+
+  St := Status
+
+  Force option
+  ------------
+  
+  St Spec
+  -- ----
+  OK If -f is requested, ensure -e is too.
+     Check if volumes is using AFPVOL_CACHE, then wipe db from disk. Rebuild from ad-files.
+
+  1st pass: Scan volume
+  --------------------
+
+  St Type Check
+  -- ---- -----
+  OK F/D  Make sure ad file exists
+  OK D    Make sure .AppleDouble dir exist, create if missing. Error creating
+          it is fatal as that shouldn't happen as root.
+  OK F/D  Delete orphaned ad-files, log dirs in ad-dir
+  OK F/D  Check name encoding by roundtripping, log on error
+  OK F/D  try: read CNID from ad file (if cnid caching is on)
+          try: fetch CNID from database
+          -> on mismatch: use CNID from file, update database (deleting both found CNIDs first)
+          -> if no CNID in ad file: write CNID from database to ad file
+          -> if no CNID in database: add CNID from ad file to database
+          -> on no CNID at all: create one and store in both places
+  OK F/D  Add found CNID, DID, filename, dev/inode, stamp to rebuild database
+  OK F/D  Check/update stamp (implicitly done while checking CNIDs)
+
+
+  2nd pass: Delete unused CNIDs
+  -----------------------------
+
+  St Spec
+  -- ----
+  OK Step through dbd (the one on disk) and rebuild-db from pass 1 and delete any CNID from
+     dbd not in rebuild db. This in only done in exclusive mode.
+*/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif /* HAVE_CONFIG_H */
 #include <atalk/cnid_dbd_private.h>
 #include <atalk/volinfo.h>
 #include "cmd_dbd.h"
+#include "dbd.h"
 #include "dbif.h"
 #include "db_param.h"
 
 #define LOCKFILENAME  "lock"
 #define DBOPTIONS (DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL | DB_INIT_TXN)
 
-static DBD *dbd;
-
+int nocniddb = 0;               /* Dont open CNID database, only scan filesystem */
 volatile sig_atomic_t alarmed;
+
+static DBD *dbd;
 static int verbose;             /* Logging flag */
 static int exclusive;           /* Exclusive volume access */
 static struct db_param db_param = {
     NULL,                       /* Volume dirpath */
     1,                          /* bdb logfile autoremove */
-    16384,                      /* bdb cachesize */
+    64 * 1024,                  /* bdb cachesize (64 MB) */
     -1,                         /* not used ... */
     -1,
     "",
@@ -54,6 +99,7 @@ static struct db_param db_param = {
     -1,
     -1
 };
+static char dbpath[PATH_MAX];   /* Path to the dbd database */
 
 /* 
    Provide some logging
@@ -85,7 +131,7 @@ static void sig_handler(int signo)
     return;
 }
 
-void set_signal(void)
+static void set_signal(void)
 {
     struct sigaction sv;
 
@@ -119,15 +165,35 @@ void set_signal(void)
     }        
 }
 
-int get_lock(void)
+static int get_lock(const char *dbpath)
 {
     int lockfd;
+    char lockpath[PATH_MAX];
     struct flock lock;
+    struct stat st;
+
+    if ( (strlen(dbpath) + strlen(LOCKFILENAME+1)) > (PATH_MAX - 1) ) {
+        dbd_log( LOGSTD, ".AppleDB pathname too long");
+        exit(EXIT_FAILURE);
+    }
+    strncpy(lockpath, dbpath, PATH_MAX - 1);
+    strcat(lockpath, "/");
+    strcat(lockpath, LOCKFILENAME);
 
-    if ((lockfd = open(LOCKFILENAME, O_RDWR | O_CREAT, 0644)) < 0) {
+    if ((lockfd = open(lockpath, O_RDWR | O_CREAT, 0644)) < 0) {
         dbd_log( LOGSTD, "Error opening lockfile: %s", strerror(errno));
         exit(EXIT_FAILURE);
     }
+
+    if ((stat(dbpath, &st)) != 0) {
+        dbd_log( LOGSTD, "Error statting lockfile: %s", strerror(errno));
+        exit(EXIT_FAILURE);
+    }
+
+    if ((chown(lockpath, st.st_uid, st.st_gid)) != 0) {
+        dbd_log( LOGSTD, "Error inheriting lockfile permissions: %s", strerror(errno));
+        exit(EXIT_FAILURE);
+    }
     
     lock.l_start  = 0;
     lock.l_whence = SEEK_SET;
@@ -149,7 +215,7 @@ int get_lock(void)
     return lockfd;
 }
 
-void free_lock(int lockfd)
+static void free_lock(int lockfd)
 {
     struct flock lock;
 
@@ -161,55 +227,72 @@ void free_lock(int lockfd)
     close(lockfd);
 }
 
-static void usage ()
+static void usage (void)
 {
-    printf("Usage: dbd [-e|-v|-x] -d [-i] | -s | -r [-f] <path to netatalk volume>\n"
+    printf("Usage: dbd [-e|-v|-x] -d [-i] | -s [-n]| -r [-c|-f] | -u <path to netatalk volume>\n"
            "dbd can dump, scan, reindex and rebuild Netatalk dbd CNID databases.\n"
            "dbd must be run with appropiate permissions i.e. as root.\n\n"
            "Main commands are:\n"
            "   -d Dump CNID database\n"
-           "      Option: -i dump indexes too\n"
+           "      Option: -i dump indexes too\n\n"
            "   -s Scan volume:\n"
-           "      1. Compare database with volume\n"
+           "      1. Compare CNIDs in database with volume\n"
            "      2. Check if .AppleDouble dirs exist\n"
            "      3. Check if  AppleDouble file exist\n"
            "      4. Report orphaned AppleDouble files\n"
            "      5. Check for directories inside AppleDouble directories\n"
            "      6. Check name encoding by roundtripping, log on error\n"
+           "      7. Check for orphaned CNIDs in database (requires -e)\n"
+           "      8. Open and close adouble files\n"
+           "      Options: -n Don't open CNID database, skip CNID checks\n\n"
            "   -r Rebuild volume:\n"
-           "      1. Sync database with volume\n"
+           "      1. Sync CNIDSs in database with volume\n"
            "      2. Make sure .AppleDouble dir exist, create if missing\n"
            "      3. Make sure AppleDouble file exists, create if missing\n"
            "      4. Delete orphaned AppleDouble files\n"
            "      5. Check for directories inside AppleDouble directories\n"
            "      6. Check name encoding by roundtripping, log on error\n"
-           "      Option: -f wipe database and rebuild from IDs stored in AppleDouble files,\n"
-           "                 only available for volumes with 'cachecnid' option\n\n"
+           "      7. Check for orphaned CNIDs in database (requires -e)\n"
+           "      8. Open and close adouble files\n"
+           "      Options: -f wipe database and rebuild from IDs stored in AppleDouble files,\n"
+           "                  only available for volumes without 'nocnidcache' option. Implies -e.\n"
+           "               -c Dont create .AppleDouble stuff, only cleanup orphaned.\n\n"
+           "   -u Prepare upgrade:\n"
+           "      Before installing an upgraded version of Netatalk that is linked against\n"
+           "      a newer BerkeleyDB lib, run `dbd -u ...` from the OLD Netatalk pior to\n"
+           "      upgrading on all volumes. This removes the BerkleyDB environment.\n"
+           "      On exit cnid_dbd does this automatically, so normally calling dbd -u should not be necessary.\n\n"
            "General options:\n"
            "   -e only work on inactive volumes and lock them (exclusive)\n"
-           "   -x rebuild indexes\n"
-           "   -v verbose\n"
-           "\n"
-           "05-05-2009: -s and -r already check/repair the AppleDouble stuff and encoding,\n"
-           "            no CNID database maintanance is done yet\n"
+           "   -x rebuild indexes (just for completeness, mostly useless!)\n"
+           "   -v verbose\n\n"
+           "WARNING:\n"
+           "For -r -f restore of the CNID database from the adouble files, the CNID must of course\n"
+           "be synched to them files first with a plain -r rebuild !\n"
         );
 }
 
 int main(int argc, char **argv)
 {
-    int c, lockfd;
-    int dump=0, scan=0, rebuild=0, rebuildindexes=0, dumpindexes=0, force=0;
+    int c, lockfd, ret = -1;
+    int dump=0, scan=0, rebuild=0, prep_upgrade=0, rebuildindexes=0, dumpindexes=0, force=0;
     dbd_flags_t flags = 0;
     char *volpath;
     struct volinfo volinfo;
+    int cdir;
 
     if (geteuid() != 0) {
         usage();
         exit(EXIT_FAILURE);
     }
+    /* Inhereting perms in ad_mkdir etc requires this */
+    ad_setfuid(0);
 
-    while ((c = getopt(argc, argv, ":dsrvxife")) != -1) {
+    while ((c = getopt(argc, argv, ":cdefinrsuvx")) != -1) {
         switch(c) {
+        case 'c':
+            flags |= DBD_FLAGS_CLEANUP;
+            break;
         case 'd':
             dump = 1;
             break;
@@ -218,23 +301,31 @@ int main(int argc, char **argv)
             break;
         case 's':
             scan = 1;
-            flags = DBD_FLAGS_SCAN;
+            flags |= DBD_FLAGS_SCAN;
+            break;
+        case 'n':
+            nocniddb = 1; /* FIXME: this could/should be a flag too for consistency */
             break;
         case 'r':
             rebuild = 1;
             break;
+        case 'u':
+            prep_upgrade = 1;
+            break;
         case 'v':
             verbose = 1;
             break;
         case 'e':
             exclusive = 1;
+            flags |= DBD_FLAGS_EXCL;
             break;
         case 'x':
             rebuildindexes = 1;
             break;
         case 'f':
             force = 1;
-            flags = DBD_FLAGS_FORCE;
+            exclusive = 1;
+            flags |= DBD_FLAGS_FORCE | DBD_FLAGS_EXCL;
             break;
         case ':':
         case '?':
@@ -244,7 +335,7 @@ int main(int argc, char **argv)
         }
     }
 
-    if ((dump + scan + rebuild) != 1) {
+    if ((dump + scan + rebuild + prep_upgrade) != 1) {
         usage();
         exit(EXIT_FAILURE);
     }
@@ -255,28 +346,14 @@ int main(int argc, char **argv)
     }
     volpath = argv[optind];
 
-    /* Put "/.AppleDB" at end of volpath */
-    if ( (strlen(volpath) + strlen("/.AppleDB")) > (PATH_MAX - 1) ) {
-        dbd_log( LOGSTD, "Volume pathname too long");
-        exit(EXIT_FAILURE);        
-    }
-    char dbpath[PATH_MAX];
-    strncpy(dbpath, volpath, PATH_MAX - 1);
-    strcat(dbpath, "/.AppleDB");
+    setvbuf(stdout, (char *) NULL, _IONBF, 0);
 
     /* Remember cwd */
-    int cdir;
     if ((cdir = open(".", O_RDONLY)) < 0) {
         dbd_log( LOGSTD, "Can't open dir: %s", strerror(errno));
         exit(EXIT_FAILURE);
     }
         
-    /* 
-       Before we do anything else, check if there is an instance of cnid_dbd
-       running already and silently exit if yes.
-    */
-    lockfd = get_lock();
-
     /* Setup signal handling */
     set_signal();
 
@@ -288,7 +365,7 @@ int main(int argc, char **argv)
 
     /* Load .volinfo file */
     if (loadvolinfo(volpath, &volinfo) == -1) {
-        dbd_log( LOGSTD, "Unkown volume options!");
+        dbd_log( LOGSTD, "Not a Netatalk volume at '%s', no .volinfo file at '%s/.AppleDesktop/.volinfo' or unknown volume options", volpath, volpath);
         exit(EXIT_FAILURE);
     }
     if (vol_load_charsets(&volinfo) == -1) {
@@ -296,45 +373,112 @@ int main(int argc, char **argv)
         exit(EXIT_FAILURE);
     }
 
+    /* Sanity checks to ensure we can touch this volume */
+    if (volinfo.v_vfs_ea != AFPVOL_EA_AD && volinfo.v_vfs_ea != AFPVOL_EA_SYS) {
+        dbd_log( LOGSTD, "Unknown Extended Attributes option: %u", volinfo.v_vfs_ea);
+        exit(EXIT_FAILURE);        
+    }
+
+    /* Put "/.AppleDB" at end of volpath, get path from volinfo file */
+    if ( (strlen(volinfo.v_dbpath) + strlen("/.AppleDB")) > (PATH_MAX - 1) ) {
+        dbd_log( LOGSTD, "Volume pathname too long");
+        exit(EXIT_FAILURE);        
+    }
+    strncpy(dbpath, volinfo.v_dbpath, PATH_MAX - 9 - 1);
+    strcat(dbpath, "/.AppleDB");
+
+    /* Check or create dbpath */
+    int dbdirfd = open(dbpath, O_RDONLY);
+    if (dbdirfd == -1 && errno == ENOENT) {
+        if (errno == ENOENT) {
+            if ((mkdir(dbpath, 0755)) != 0) {
+                dbd_log( LOGSTD, "Can't create .AppleDB for \"%s\": %s", dbpath, strerror(errno));
+                exit(EXIT_FAILURE);
+            }
+        } else {
+            dbd_log( LOGSTD, "Somethings wrong with .AppleDB for \"%s\", giving up: %s", dbpath, strerror(errno));
+            exit(EXIT_FAILURE);
+        }
+    } else {
+        close(dbdirfd);
+    }
+
     /* 
-       Lets start with the BerkeleyDB stuff
+       Before we do anything else, check if there is an instance of cnid_dbd
+       running already and silently exit if yes.
     */
-    if ((dbd = dbif_init(dbpath, "cnid2.db")) == NULL)
-        exit(EXIT_FAILURE);
+    lockfd = get_lock(dbpath);
 
-    if (dbif_env_open(dbd, &db_param, exclusive ? (DBOPTIONS | DB_RECOVER) : DBOPTIONS) < 0) {
-        dbd_log( LOGSTD, "error opening database!");
-        exit(EXIT_FAILURE);
+    /* Prepare upgrade ? */
+    if (prep_upgrade) {
+        if (dbif_prep_upgrade(dbpath))
+            goto exit_failure;
+        goto exit_success;
+    }        
+
+    /* Check if -f is requested and wipe db if yes */
+    if ((flags & DBD_FLAGS_FORCE) && rebuild && (volinfo.v_flags & AFPVOL_CACHE)) {
+        char cmd[8 + MAXPATHLEN];
+        snprintf(cmd, 8 + MAXPATHLEN, "rm -f %s/*", dbpath);
+        dbd_log( LOGDEBUG, "Removing old database of volume: '%s'", volpath);
+        system(cmd);
+        dbd_log( LOGDEBUG, "Removed old database.");
     }
 
-    if (exclusive)
-        dbd_log( LOGDEBUG, "Finished recovery.");
+    /* 
+       Lets start with the BerkeleyDB stuff
+    */
+    if ( ! nocniddb) {
+        if ((dbd = dbif_init(dbpath, "cnid2.db")) == NULL)
+            goto exit_failure;
+        
+        if (dbif_env_open(dbd, &db_param, exclusive ? (DBOPTIONS | DB_RECOVER) : DBOPTIONS) < 0) {
+            dbd_log( LOGSTD, "error opening database!");
+            goto exit_failure;
+        }
 
-    if (dbif_open(dbd, &db_param, rebuildindexes) < 0) {
-        dbif_close(dbd);
-        exit(EXIT_FAILURE);
+        if (exclusive)
+            dbd_log( LOGDEBUG, "Finished recovery.");
+
+        if (dbif_open(dbd, NULL, rebuildindexes) < 0) {
+            dbif_close(dbd);
+            goto exit_failure;
+        }
+
+        if (dbd_stamp(dbd) < 0) {
+            dbif_close(dbd);
+            goto exit_failure;
+        }
     }
 
-    if (dump) {
+    /* Now execute given command scan|rebuild|dump */
+    if (dump && ! nocniddb) {
         if (dbif_dump(dbd, dumpindexes) < 0) {
             dbd_log( LOGSTD, "Error dumping database");
         }
-    } else if (rebuild || scan) {
+    } else if ((rebuild && ! nocniddb) || scan) {
         if (cmd_dbd_scanvol(dbd, &volinfo, flags) < 0) {
             dbd_log( LOGSTD, "Error repairing database.");
         }
     }
 
-cleanup:
-    if (dbif_close(dbd) < 0) {
+    /* Cleanup */
+    if (! nocniddb && dbif_close(dbd) < 0) {
         dbd_log( LOGSTD, "Error closing database");
-        exit(EXIT_FAILURE);
+        goto exit_failure;
     }
 
-    free_lock(lockfd);
+exit_success:
+    ret = 0;
 
+exit_failure:
+    free_lock(lockfd);
+    
     if ((fchdir(cdir)) < 0)
         dbd_log(LOGSTD, "fchdir: %s", strerror(errno));
 
-    return 0;
+    if (ret == 0)
+        exit(EXIT_SUCCESS);
+    else
+        exit(EXIT_FAILURE);
 }