/* * Copyright (c) 1992, Brian Berliner and Jeff Polk * Copyright (c) 1989-1992, Brian Berliner * * You may distribute under the terms of the GNU General Public License as * specified in the README file that comes with the CVS kit. */ #include "cvs.h" #include "savecwd.h" #ifndef DBLKSIZ #define DBLKSIZ 4096 /* since GNU ndbm doesn't define it */ #endif static int checkout_file PROTO((char *file, char *temp)); static void make_tempfile PROTO((char *temp)); static void rename_rcsfile PROTO((char *temp, char *real)); #ifndef MY_NDBM static void rename_dbmfile PROTO((char *temp)); static void write_dbmfile PROTO((char *temp)); #endif /* !MY_NDBM */ /* Structure which describes an administrative file. */ struct admin_file { /* Name of the file, within the CVSROOT directory. */ char *filename; /* This is a one line description of what the file is for. It is not currently used, although one wonders whether it should be, somehow. If NULL, then don't process this file in mkmodules (FIXME: a bit of a kludge; probably should replace this with a flags field). */ char *errormsg; /* Contents which the file should have in a new repository. To avoid problems with brain-dead compilers which choke on long string constants, this is a pointer to an array of char * terminated by NULL--each of the strings is concatenated. */ const char * const *contents; }; static const char *const loginfo_contents[] = { "# The \"loginfo\" file is used to control where \"cvs commit\" log information\n", "# is sent. The first entry on a line is a regular expression which is tested\n", "# against the directory that the change is being made to, relative to the\n", "# $CVSROOT. For the first match that is found, then the remainder of the\n", "# line is a filter program that should expect log information on its standard\n", "# input.\n", "#\n", "# If the repository name does not match any of the regular expressions in the\n", "# first field of this file, the \"DEFAULT\" line is used, if it is specified.\n", "#\n", "# If the name \"ALL\" appears as a regular expression it is always used\n", "# in addition to the first matching regex or \"DEFAULT\".\n", "#\n", "# The filter program may use one and only one \"%s\" modifier (ala printf). If\n", "# such a \"%s\" is specified in the filter program, a brief title is included\n", "# (as one argument, enclosed in single quotes) showing the relative directory\n", "# name and listing the modified file names.\n", "#\n", "# For example:\n", "#DEFAULT (echo \"\"; who am i; date; cat) >> $CVSROOT/CVSROOT/commitlog\n", NULL }; static const char *const rcsinfo_contents[] = { "# The \"rcsinfo\" file is used to control templates with which the editor\n", "# is invoked on commit and import.\n", "#\n", "# The first entry on a line is a regular expression which is tested\n", "# against the directory that the change is being made to, relative to the\n", "# $CVSROOT. For the first match that is found, then the remainder of the\n", "# line is the name of the file that contains the template.\n", "#\n", "# If the repository name does not match any of the regular expressions in this\n", "# file, the \"DEFAULT\" line is used, if it is specified.\n", "#\n", "# If the name \"ALL\" appears as a regular expression it is always used\n", "# in addition to the first matching regex or \"DEFAULT\".\n", NULL }; static const char *const editinfo_contents[] = { "# The \"editinfo\" file is used to allow verification of logging\n", "# information. It works best when a template (as specified in the\n", "# rcsinfo file) is provided for the logging procedure. Given a\n", "# template with locations for, a bug-id number, a list of people who\n", "# reviewed the code before it can be checked in, and an external\n", "# process to catalog the differences that were code reviewed, the\n", "# following test can be applied to the code:\n", "#\n", "# Making sure that the entered bug-id number is correct.\n", "# Validating that the code that was reviewed is indeed the code being\n", "# checked in (using the bug-id number or a seperate review\n", "# number to identify this particular code set.).\n", "#\n", "# If any of the above test failed, then the commit would be aborted.\n", "#\n", "# Actions such as mailing a copy of the report to each reviewer are\n", "# better handled by an entry in the loginfo file.\n", "#\n", "# One thing that should be noted is the the ALL keyword is not\n", "# supported. There can be only one entry that matches a given\n", "# repository.\n", NULL }; static const char *const commitinfo_contents[] = { "# The \"commitinfo\" file is used to control pre-commit checks.\n", "# The filter on the right is invoked with the repository and a list \n", "# of files to check. A non-zero exit of the filter program will \n", "# cause the commit to be aborted.\n", "#\n", "# The first entry on a line is a regular expression which is tested\n", "# against the directory that the change is being committed to, relative\n", "# to the $CVSROOT. For the first match that is found, then the remainder\n", "# of the line is the name of the filter to run.\n", "#\n", "# If the repository name does not match any of the regular expressions in this\n", "# file, the \"DEFAULT\" line is used, if it is specified.\n", "#\n", "# If the name \"ALL\" appears as a regular expression it is always used\n", "# in addition to the first matching regex or \"DEFAULT\".\n", NULL }; static const char *const taginfo_contents[] = { "# The \"taginfo\" file is used to control pre-tag checks.\n", "# The filter on the right is invoked with the following arguments:\n", "#\n", "# $1 -- tagname\n", "# $2 -- operation \"add\" for tag, \"mov\" for tag -F, and \"del\" for tag -d\n", "# $3 -- repository\n", "# $4-> file revision [file revision ...]\n", "#\n", "# A non-zero exit of the filter program will cause the tag to be aborted.\n", "#\n", "# The first entry on a line is a regular expression which is tested\n", "# against the directory that the change is being committed to, relative\n", "# to the $CVSROOT. For the first match that is found, then the remainder\n", "# of the line is the name of the filter to run.\n", "#\n", "# If the repository name does not match any of the regular expressions in this\n", "# file, the \"DEFAULT\" line is used, if it is specified.\n", "#\n", "# If the name \"ALL\" appears as a regular expression it is always used\n", "# in addition to the first matching regex or \"DEFAULT\".\n", NULL }; static const char *const checkoutlist_contents[] = { "# The \"checkoutlist\" file is used to support additional version controlled\n", "# administrative files in $CVSROOT/CVSROOT, such as template files.\n", "#\n", "# The first entry on a line is a filename which will be checked out from\n", "# the corresponding RCS file in the $CVSROOT/CVSROOT directory.\n", "# The remainder of the line is an error message to use if the file cannot\n", "# be checked out.\n", "#\n", "# File format:\n", "#\n", "# []\n", "#\n", "# comment lines begin with '#'\n", NULL }; static const char *const cvswrappers_contents[] = { "# This file describes wrappers and other binary files to CVS.\n", "#\n", "# Wrappers are the concept where directories of files are to be\n", "# treated as a single file. The intended use is to wrap up a wrapper\n", "# into a single tar such that the tar archive can be treated as a\n", "# single binary file in CVS.\n", "#\n", "# To solve the problem effectively, it was also necessary to be able to\n", "# prevent rcsmerge from merging these files.\n", "#\n", "# Format of wrapper file ($CVSROOT/CVSROOT/cvswrappers or .cvswrappers)\n", "#\n", "# wildcard [option value][option value]...\n", "#\n", "# where option is one of\n", "# -f from cvs filter value: path to filter\n", "# -t to cvs filter value: path to filter\n", "# -m update methodology value: MERGE or COPY\n", "#\n", "# and value is a single-quote delimited value.\n", "#\n", "# For example:\n", NULL }; static const char *const notify_contents[] = { "# The \"notify\" file controls where notifications from watches set by\n", "# \"cvs watch add\" or \"cvs edit\" are sent. The first entry on a line is\n", "# a regular expression which is tested against the directory that the\n", "# change is being made to, relative to the $CVSROOT. If it matches,\n", "# then the remainder of the line is a filter program that should contain\n", "# one occurrence of %s for the user to notify, and information on its\n", "# standard input.\n", "#\n", "# \"ALL\" or \"DEFAULT\" can be used in place of the regular expression.\n", "#\n", "# For example:\n", "#ALL mail %s -s \"CVS notification\"\n", NULL }; static const char *const modules_contents[] = { "# Three different line formats are valid:\n", "# key -a aliases...\n", "# key [options] directory\n", "# key [options] directory files...\n", "#\n", "# Where \"options\" are composed of:\n", "# -i prog Run \"prog\" on \"cvs commit\" from top-level of module.\n", "# -o prog Run \"prog\" on \"cvs checkout\" of module.\n", "# -e prog Run \"prog\" on \"cvs export\" of module.\n", "# -t prog Run \"prog\" on \"cvs rtag\" of module.\n", "# -u prog Run \"prog\" on \"cvs update\" of module.\n", "# -d dir Place module in directory \"dir\" instead of module name.\n", "# -l Top-level directory only -- do not recurse.\n", "#\n", "# And \"directory\" is a path to a directory relative to $CVSROOT.\n", "#\n", "# The \"-a\" option specifies an alias. An alias is interpreted as if\n", "# everything on the right of the \"-a\" had been typed on the command line.\n", "#\n", "# You can encode a module within a module by using the special '&'\n", "# character to interpose another module into the current module. This\n", "# can be useful for creating a module that consists of many directories\n", "# spread out over the entire source repository.\n", NULL }; static const struct admin_file filelist[] = { {CVSROOTADM_LOGINFO, "no logging of 'cvs commit' messages is done without a %s file", &loginfo_contents[0]}, {CVSROOTADM_RCSINFO, "a %s file can be used to configure 'cvs commit' templates", rcsinfo_contents}, {CVSROOTADM_EDITINFO, "a %s file can be used to validate log messages", editinfo_contents}, {CVSROOTADM_COMMITINFO, "a %s file can be used to configure 'cvs commit' checking", commitinfo_contents}, {CVSROOTADM_TAGINFO, "a %s file can be used to configure 'cvs tag' checking", taginfo_contents}, {CVSROOTADM_IGNORE, "a %s file can be used to specify files to ignore", NULL}, {CVSROOTADM_CHECKOUTLIST, "a %s file can specify extra CVSROOT files to auto-checkout", checkoutlist_contents}, {CVSROOTADM_WRAPPER, "a %s file can be used to specify files to treat as wrappers", cvswrappers_contents}, {CVSROOTADM_NOTIFY, "a %s file can be used to specify where notifications go", notify_contents}, {CVSROOTADM_MODULES, /* modules is special-cased in mkmodules. */ NULL, modules_contents}, {NULL, NULL} }; /* Rebuild the checked out administrative files in directory DIR. */ int mkmodules (dir) char *dir; { struct saved_cwd cwd; /* FIXME: arbitrary limit */ char temp[PATH_MAX]; char *cp, *last, *fname; #ifdef MY_NDBM DBM *db; #endif FILE *fp; /* FIXME: arbitrary limit */ char line[512]; const struct admin_file *fileptr; if (save_cwd (&cwd)) exit (EXIT_FAILURE); if (chdir (dir) < 0) error (1, errno, "cannot chdir to %s", dir); /* * First, do the work necessary to update the "modules" database. */ make_tempfile (temp); switch (checkout_file (CVSROOTADM_MODULES, temp)) { case 0: /* everything ok */ #ifdef MY_NDBM /* open it, to generate any duplicate errors */ if ((db = dbm_open (temp, O_RDONLY, 0666)) != NULL) dbm_close (db); #else write_dbmfile (temp); rename_dbmfile (temp); #endif rename_rcsfile (temp, CVSROOTADM_MODULES); break; case -1: /* fork failed */ (void) unlink_file (temp); exit (EXIT_FAILURE); /* NOTREACHED */ default: error (0, 0, "'cvs checkout' is less functional without a %s file", CVSROOTADM_MODULES); break; } /* switch on checkout_file() */ (void) unlink_file (temp); /* Checkout the files that need it in CVSROOT dir */ for (fileptr = filelist; fileptr && fileptr->filename; fileptr++) { if (fileptr->errormsg == NULL) continue; make_tempfile (temp); if (checkout_file (fileptr->filename, temp) == 0) rename_rcsfile (temp, fileptr->filename); #if 0 /* * If there was some problem other than the file not existing, * checkout_file already printed a real error message. If the * file does not exist, it is harmless--it probably just means * that the repository was created with an old version of CVS * which didn't have so many files in CVSROOT. */ else if (fileptr->errormsg) error (0, 0, fileptr->errormsg, fileptr->filename); #endif (void) unlink_file (temp); } /* Use 'fopen' instead of 'open_file' because we want to ignore error */ fp = fopen (CVSROOTADM_CHECKOUTLIST, "r"); if (fp) { /* * File format: * [] * * comment lines begin with '#' */ while (fgets (line, sizeof (line), fp) != NULL) { /* skip lines starting with # */ if (line[0] == '#') continue; if ((last = strrchr (line, '\n')) != NULL) *last = '\0'; /* strip the newline */ /* Skip leading white space. */ for (fname = line; *fname && isspace(*fname); fname++) ; /* Find end of filename. */ for (cp = fname; *cp && !isspace(*cp); cp++) ; *cp = '\0'; make_tempfile (temp); if (checkout_file (fname, temp) == 0) { rename_rcsfile (temp, fname); } else { for (cp++; cp < last && *last && isspace(*last); cp++) ; if (cp < last && *cp) error (0, 0, cp, fname); } } (void) fclose (fp); } if (restore_cwd (&cwd, NULL)) exit (EXIT_FAILURE); free_cwd (&cwd); return (0); } /* * Yeah, I know, there are NFS race conditions here. */ static void make_tempfile (temp) char *temp; { static int seed = 0; int fd; if (seed == 0) seed = getpid (); while (1) { (void) sprintf (temp, "%s%d", BAKPREFIX, seed++); if ((fd = open (temp, O_CREAT|O_EXCL|O_RDWR, 0666)) != -1) break; if (errno != EEXIST) error (1, errno, "cannot create temporary file %s", temp); } if (close(fd) < 0) error(1, errno, "cannot close temporary file %s", temp); } static int checkout_file (file, temp) char *file; char *temp; { char rcs[PATH_MAX]; int retcode = 0; (void) sprintf (rcs, "%s%s", file, RCSEXT); if (!isfile (rcs)) return (1); run_setup ("%s%s -x,v/ -q -p", Rcsbin, RCS_CO); run_arg (rcs); if ((retcode = run_exec (RUN_TTY, temp, RUN_TTY, RUN_NORMAL)) != 0) { error (0, retcode == -1 ? errno : 0, "failed to check out %s file", file); } return (retcode); } #ifndef MY_NDBM static void write_dbmfile (temp) char *temp; { char line[DBLKSIZ], value[DBLKSIZ]; FILE *fp; DBM *db; char *cp, *vp; datum key, val; int len, cont, err = 0; fp = open_file (temp, "r"); if ((db = dbm_open (temp, O_RDWR | O_CREAT | O_TRUNC, 0666)) == NULL) error (1, errno, "cannot open dbm file %s for creation", temp); for (cont = 0; fgets (line, sizeof (line), fp) != NULL;) { if ((cp = strrchr (line, '\n')) != NULL) *cp = '\0'; /* strip the newline */ /* * Add the line to the value, at the end if this is a continuation * line; otherwise at the beginning, but only after any trailing * backslash is removed. */ vp = value; if (cont) vp += strlen (value); /* * See if the line we read is a continuation line, and strip the * backslash if so. */ len = strlen (line); if (len > 0) cp = &line[len - 1]; else cp = line; if (*cp == '\\') { cont = 1; *cp = '\0'; } else { cont = 0; } (void) strcpy (vp, line); if (value[0] == '#') continue; /* comment line */ vp = value; while (*vp && isspace (*vp)) vp++; if (*vp == '\0') continue; /* empty line */ /* * If this was not a continuation line, add the entry to the database */ if (!cont) { key.dptr = vp; while (*vp && !isspace (*vp)) vp++; key.dsize = vp - key.dptr; *vp++ = '\0'; /* NULL terminate the key */ while (*vp && isspace (*vp)) vp++; /* skip whitespace to value */ if (*vp == '\0') { error (0, 0, "warning: NULL value for key `%s'", key.dptr); continue; } val.dptr = vp; val.dsize = strlen (vp); if (dbm_store (db, key, val, DBM_INSERT) == 1) { error (0, 0, "duplicate key found for `%s'", key.dptr); err++; } } } dbm_close (db); (void) fclose (fp); if (err) { char dotdir[50], dotpag[50], dotdb[50]; (void) sprintf (dotdir, "%s.dir", temp); (void) sprintf (dotpag, "%s.pag", temp); (void) sprintf (dotdb, "%s.db", temp); (void) unlink_file (dotdir); (void) unlink_file (dotpag); (void) unlink_file (dotdb); error (1, 0, "DBM creation failed; correct above errors"); } } static void rename_dbmfile (temp) char *temp; { char newdir[50], newpag[50], newdb[50]; char dotdir[50], dotpag[50], dotdb[50]; char bakdir[50], bakpag[50], bakdb[50]; (void) sprintf (dotdir, "%s.dir", CVSROOTADM_MODULES); (void) sprintf (dotpag, "%s.pag", CVSROOTADM_MODULES); (void) sprintf (dotdb, "%s.db", CVSROOTADM_MODULES); (void) sprintf (bakdir, "%s%s.dir", BAKPREFIX, CVSROOTADM_MODULES); (void) sprintf (bakpag, "%s%s.pag", BAKPREFIX, CVSROOTADM_MODULES); (void) sprintf (bakdb, "%s%s.db", BAKPREFIX, CVSROOTADM_MODULES); (void) sprintf (newdir, "%s.dir", temp); (void) sprintf (newpag, "%s.pag", temp); (void) sprintf (newdb, "%s.db", temp); (void) chmod (newdir, 0666); (void) chmod (newpag, 0666); (void) chmod (newdb, 0666); /* don't mess with me */ SIG_beginCrSect (); (void) unlink_file (bakdir); /* rm .#modules.dir .#modules.pag */ (void) unlink_file (bakpag); (void) unlink_file (bakdb); (void) rename (dotdir, bakdir); /* mv modules.dir .#modules.dir */ (void) rename (dotpag, bakpag); /* mv modules.pag .#modules.pag */ (void) rename (dotdb, bakdb); /* mv modules.db .#modules.db */ (void) rename (newdir, dotdir); /* mv "temp".dir modules.dir */ (void) rename (newpag, dotpag); /* mv "temp".pag modules.pag */ (void) rename (newdb, dotdb); /* mv "temp".db modules.db */ /* OK -- make my day */ SIG_endCrSect (); } #endif /* !MY_NDBM */ static void rename_rcsfile (temp, real) char *temp; char *real; { char bak[50]; struct stat statbuf; char rcs[PATH_MAX]; /* Set "x" bits if set in original. */ (void) sprintf (rcs, "%s%s", real, RCSEXT); statbuf.st_mode = 0; /* in case rcs file doesn't exist, but it should... */ (void) stat (rcs, &statbuf); if (chmod (temp, 0444 | (statbuf.st_mode & 0111)) < 0) error (0, errno, "warning: cannot chmod %s", temp); (void) sprintf (bak, "%s%s", BAKPREFIX, real); (void) unlink_file (bak); /* rm .#loginfo */ (void) rename (real, bak); /* mv loginfo .#loginfo */ (void) rename (temp, real); /* mv "temp" loginfo */ } const char *const init_usage[] = { "Usage: %s %s\n", NULL }; /* Create directory NAME if it does not already exist; fatal error for other errors. FIXME: This should be in filesubr.c or thereabouts, probably. Perhaps it should be further abstracted, though (for example to handle CVSUMASK where appropriate?). */ static void mkdir_if_needed (name) char *name; { if (CVS_MKDIR (name, 0777) < 0) { if (errno != EEXIST #ifdef EACCESS /* OS/2; see longer comment in client.c. */ && errno != EACCESS #endif ) error (1, errno, "cannot mkdir %s", name); } } int init (argc, argv) int argc; char **argv; { /* Name of CVSROOT directory. */ char *adm; /* Name of this administrative file. */ char *info; /* Name of ,v file for this administrative file. */ char *info_v; const struct admin_file *fileptr; umask (cvsumask); if (argc == -1 || argc > 1) usage (init_usage); if (client_active) { start_server (); ign_setup (); send_init_command (); return get_responses_and_close (); } /* Note: we do *not* create parent directories as needed like the old cvsinit.sh script did. Few utilities do that, and a non-existent parent directory is as likely to be a typo as something which needs to be created. */ mkdir_if_needed (CVSroot); adm = xmalloc (strlen (CVSroot) + sizeof (CVSROOTADM) + 10); strcpy (adm, CVSroot); strcat (adm, "/"); strcat (adm, CVSROOTADM); mkdir_if_needed (adm); /* This is needed by the call to "ci" below. */ if (chdir (adm) < 0) error (1, errno, "cannot change to directory %s", adm); /* 80 is long enough for all the administrative file names, plus "/" and so on. */ info = xmalloc (strlen (adm) + 80); info_v = xmalloc (strlen (adm) + 80); for (fileptr = filelist; fileptr && fileptr->filename; ++fileptr) { if (fileptr->contents == NULL) continue; strcpy (info, adm); strcat (info, "/"); strcat (info, fileptr->filename); strcpy (info_v, info); strcat (info_v, RCSEXT); if (isfile (info_v)) /* We will check out this file in the mkmodules step. Nothing else is required. */ ; else { int retcode; if (!isfile (info)) { FILE *fp; const char * const *p; fp = open_file (info, "w"); for (p = fileptr->contents; *p != NULL; ++p) if (fputs (*p, fp) < 0) error (1, errno, "cannot write %s", info); if (fclose (fp) < 0) error (1, errno, "cannot close %s", info); } /* Now check the file in. FIXME: we could be using add_rcs_file from import.c which is faster (if it were tweaked slightly). */ run_setup ("%s%s -x,v/ -q -u -t-", Rcsbin, RCS_CI); run_args ("-minitial checkin of %s", fileptr->filename); run_arg (fileptr->filename); retcode = run_exec (RUN_TTY, RUN_TTY, RUN_TTY, RUN_NORMAL); if (retcode != 0) error (1, retcode == -1 ? errno : 0, "failed to check in %s", info); } } /* Turn on history logging by default. The user can remove the file to disable it. */ strcpy (info, adm); strcat (info, "/"); strcat (info, CVSROOTADM_HISTORY); if (!isfile (info)) { FILE *fp; fp = open_file (info, "w"); if (fclose (fp) < 0) error (1, errno, "cannot close %s", info); } free (info); free (info_v); mkmodules (adm); free (adm); return 0; }