path: root/usr.bin/rcs/ci.c

/*	$OpenBSD: ci.c,v 1.60 2005/11/17 00:03:04 niallo Exp $	*/
/*
 * Copyright (c) 2005 Niall O'Higgins <niallo@openbsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following cinditions
 * are met:
 *
 * 1. Redistributions of source cide must retain the above cipyright
 *    notice, this list of cinditions and the following disclaimer.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/param.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/wait.h>

#include <err.h>
#include <pwd.h>
#include <errno.h>
#include <stdio.h>
#include <ctype.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <time.h>

#include "log.h"
#include "rcs.h"
#include "diff.h"
#include "rcsprog.h"

#define CI_OPTSTRING    "d::f::i::j::k:l::m:M::N:n:qr::s:u::Vw:"
#define DATE_NOW        -1
#define DATE_MTIME      -2

#define LOG_INIT        "Initial revision"
#define LOG_PROMPT      "enter log message, terminated with a single '.' " \
                        "or end of file:\n>> "
#define DESC_PROMPT     "enter description, terminated with single '.' "   \
	                "or end of file:\nNOTE: This is NOT the log message!\n"

struct checkin_params {
	int flags, openflags;
	mode_t fmode;
	time_t date;
	RCSFILE *file;
	RCSNUM *frev, *newrev;
	char fpath[MAXPATHLEN], *rcs_msg, *username, *deltatext, *filename;
	const char *symbol, *state;
};

static int    checkin_attach_symbol(struct checkin_params *pb);
static int    checkin_checklock(struct checkin_params *pb);
static char * checkin_diff_file(struct checkin_params *);
static char * checkin_getdesc(void);
static char * checkin_getinput(const char *);
static char * checkin_getlogmsg(RCSNUM *, RCSNUM *);
static void   checkin_init(struct checkin_params *);
static void   checkin_revert(struct checkin_params *pb);

void
checkin_usage(void)
{
	fprintf(stderr,
	    "usage: ci [-MNqV] [-d[date]] [-f[rev]] [-i[rev]] [-j[rev]]\n"
            "          [-kmode] [-l[rev]] [-M[rev]] [-mmsg] [-Nsymbol]\n"
            "          [-nsymbol] [-r[rev]] [-sstate] [-u[rev]] [-wusername]\n"
            "          file ...\n");
}



/*
 * checkin_main()
 *
 * Handler for the `ci' program.
 * Returns 0 on success, or >0 on error.
 */
int
checkin_main(int argc, char **argv)
{
	int i, ch, status;
	char  *filec;
	struct stat sb;
	struct checkin_params pb;
	BUF *bp;

	pb.date = DATE_NOW;
	pb.file = NULL;
	pb.rcs_msg = pb.username = NULL;
	pb.state = pb.symbol = NULL;
	pb.newrev =  NULL;
	pb.fmode = pb.flags = status = 0;

	pb.flags = INTERACTIVE;
	pb.openflags = RCS_RDWR|RCS_CREATE;

	while ((ch = rcs_getopt(argc, argv, CI_OPTSTRING)) != -1) {
		switch (ch) {
		case 'd':
			if (rcs_optarg == NULL)
				pb.date = DATE_MTIME;
			else if ((pb.date = cvs_date_parse(rcs_optarg)) <= 0) {
				cvs_log(LP_ERR, "invalide date");
				exit(1);
			}
			break;
		case 'f':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.flags |= FORCE;
			break;
		case 'h':
			(usage)();
			exit(0);
		case 'i':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.openflags |= RCS_CREATE;
			break;
		case 'j':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.openflags &= ~RCS_CREATE;
			break;
		case 'l':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.flags |= CO_LOCK;
			break;
		case 'M':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.flags |= CO_REVDATE;
			break;
		case 'm':
			pb.rcs_msg = rcs_optarg;
			if (pb.rcs_msg == NULL) {
				cvs_log(LP_ERR,
				    "missing message for -m option");
				exit(1);
			}
			pb.flags &= ~INTERACTIVE;
			break;
		case 'N':
			if ((pb.symbol = strdup(rcs_optarg)) == NULL) {
				cvs_log(LP_ERRNO, "out of memory");
				exit(1);
			}
			if (rcs_sym_check(pb.symbol) != 1) {
				cvs_log(LP_ERR, "invalid symbol `%s'",
				    pb.symbol);
				exit(1);
			}
			pb.flags |= CI_SYMFORCE;
			break;
		case 'n':
			if ((pb.symbol = strdup(rcs_optarg)) == NULL) {
				cvs_log(LP_ERRNO, "out of memory");
				exit(1);
			}
			if (rcs_sym_check(pb.symbol) != 1) {
				cvs_log(LP_ERR, "invalid symbol `%s'",
				    pb.symbol);
				exit(1);
			}
			break;
		case 'q':
			verbose = 0;
			break;
		case 'r':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.flags |= CI_DEFAULT;
			break;
		case 's':
			pb.state = rcs_optarg;
			if (rcs_state_check(pb.state) < 0) {
				cvs_log(LP_ERR, "invalid state `%s'",
				    pb.state);
				exit(1);
			}
			break;
		case 'u':
			rcs_set_rev(rcs_optarg, &pb.newrev);
			pb.flags |= CO_UNLOCK;
			break;
		case 'V':
			printf("%s\n", rcs_version);
			exit(0);
		case 'w':
			pb.username = rcs_optarg;
			break;
		default:
			(usage)();
			exit(1);
		}
	}

	argc -= rcs_optind;
	argv += rcs_optind;

	if (argc == 0) {
		cvs_log(LP_ERR, "no input file");
		(usage)();
		exit(1);
	}

	if ((pb.username == NULL) && (pb.username = getlogin()) == NULL) {
		cvs_log(LP_ERRNO, "failed to get username");
		exit(1);
	}


	for (i = 0; i < argc; i++) {
		pb.filename = argv[i];
		if (rcs_statfile(pb.filename, pb.fpath, sizeof(pb.fpath)) < 0)
			continue;

		/*
		 * Test for existence of ,v file. If we are expected to
		 * create one, set NEWFILE flag.
		 */
		if ((pb.openflags & RCS_CREATE) && (stat(pb.fpath, &sb) < 0))
			pb.flags |= NEWFILE;
		else
			pb.openflags &= ~RCS_CREATE;

		pb.file = rcs_open(pb.fpath, pb.openflags, pb.fmode);

		if (pb.file == NULL) {
			cvs_log(LP_ERR, "failed to open rcsfile '%s'",
			    pb.fpath);
			exit(1);
		}

		if (verbose == 1)
			printf("%s  <--  %s\n", pb.fpath, pb.filename);

		pb.frev = pb.file->rf_head;

		/*
		 * If revision passed on command line is less than HEAD, bail.
		 */
		if ((pb.newrev != NULL)
		    && (rcsnum_cmp(pb.newrev, pb.frev, 0) > 0)) {
			cvs_log(LP_ERR, "revision is too low!");
			status = 1;
			rcs_close(pb.file);
			continue;
		}

		/*
		 * Load file contents
		 */
		if ((bp = cvs_buf_load(argv[i], BUF_AUTOEXT)) == NULL) {
			cvs_log(LP_ERR, "failed to load '%s'", pb.filename);
			exit(1);
		}

		if (cvs_buf_putc(bp, '\0') < 0)
			exit(1);

		filec = (char *)cvs_buf_release(bp);

		/*
		 * Get RCS patch
		 */
		if ((pb.deltatext = checkin_diff_file(&pb)) == NULL) {
			cvs_log(LP_ERR, "failed to get diff");
			exit(1);
		}

		/*
		 * If -f is not specified and there are no differences, tell
		 * the user and revert to latest version.
		 */
		if (!(pb.flags & FORCE) && (strlen(pb.deltatext) < 1)) {
			checkin_revert(&pb);
			continue;
		}

		/*
		 * Check for a lock belonging to this user. If none,
		 * abort check-in.
		 */
		if (checkin_checklock(&pb) < 0) {
			status = 1;
			continue;
		}

		/*
		 * If no log message specified, get it interactively.
		 */
		if (pb.flags & INTERACTIVE)
			pb.rcs_msg = checkin_getlogmsg(pb.frev, pb.newrev);

		/*
		 * Remove the lock
		 */
		if (rcs_lock_remove(pb.file, pb.frev) < 0) {
			if (rcs_errno != RCS_ERR_NOENT)
			    cvs_log(LP_WARN, "failed to remove lock");
                }

		/*
		 * Current head revision gets the RCS patch as rd_text
		 */
		if (rcs_deltatext_set(pb.file, pb.frev, pb.deltatext) == -1) {
			cvs_log(LP_ERR,
			    "failed to set new rd_text for head rev");
			exit (1);
		}

		/*
		 * Set the date of the revision to be the last modification
		 * time of the working file if -d has no argument.
		 */
		if (pb.date == DATE_MTIME) {
			if (stat(pb.filename, &sb) != 0) {
				cvs_log(LP_ERRNO, "failed to stat: `%s'",
				    pb.filename);
				rcs_close(pb.file);
				continue;
			}
			pb.date = (time_t)sb.st_mtimespec.tv_sec;
		}

		/*
		 * Now add our new revision
		 */
		if (rcs_rev_add(pb.file,
			(pb.newrev == NULL ? RCS_HEAD_REV : pb.newrev),
		    pb.rcs_msg, pb.date, pb.username) != 0) {
			cvs_log(LP_ERR, "failed to add new revision");
			exit(1);
		}

		/*
		 * If we are checking in to a non-default (ie user-specified)
		 * revision, set head to this revision.
		 */
		if (pb.newrev != NULL)
			rcs_head_set(pb.file, pb.newrev);
		else
			pb.newrev = pb.file->rf_head;

		/*
		 * New head revision has to contain entire file;
		 */
                if (rcs_deltatext_set(pb.file, pb.frev, filec) == -1) {
			cvs_log(LP_ERR, "failed to set new head revision");
			exit(1);
		}

		/*
		 * Attach a symbolic name to this revision if specified.
		 */
		if (pb.symbol != NULL
		    && (checkin_attach_symbol(&pb) < 0)) {
			status = 1;
			continue;
		}

		/*
		 * Set the state of this revision if specified.
		 */
		if (pb.state != NULL)
			(void)rcs_state_set(pb.file, pb.newrev, pb.state);

		free(pb.deltatext);
		free(filec);
		(void)unlink(pb.filename);

		/*
		 * Do checkout if -u or -l are specified.
		 */
		if (((pb.flags & CO_LOCK) || (pb.flags & CO_UNLOCK))
		    && !(pb.flags & CI_DEFAULT))
			checkout_rev(pb.file, pb.newrev, pb.filename, pb.flags,
			    pb.username);

		/* File will NOW be synced */
		rcs_close(pb.file);

		if (pb.flags & INTERACTIVE) {
			free(pb.rcs_msg);
			pb.rcs_msg = NULL;
		}
	}

	return (status);
}

/*
 * checkin_diff_file()
 *
 * Generate the diff between the working file and a revision. 
 * Returns pointer to a char array on success, NULL on failure.
 */
static char *
checkin_diff_file(struct checkin_params *pb)
{
	char path1[MAXPATHLEN], path2[MAXPATHLEN];
	BUF *b1, *b2, *b3;
	char rbuf[64], *deltatext;

	rcsnum_tostr(pb->frev, rbuf, sizeof(rbuf));

	if ((b1 = cvs_buf_load(pb->filename, BUF_AUTOEXT)) == NULL) {
		cvs_log(LP_ERR, "failed to load file: '%s'", pb->filename);
		return (NULL);
	}

	if ((b2 = rcs_getrev(pb->file, pb->frev)) == NULL) {
		cvs_log(LP_ERR, "failed to load revision");
		cvs_buf_free(b1);
		return (NULL);
	}

	if ((b3 = cvs_buf_alloc((size_t)128, BUF_AUTOEXT)) == NULL) {
		cvs_log(LP_ERR, "failed to allocated buffer for diff");
		cvs_buf_free(b1);
		cvs_buf_free(b2);
		return (NULL);
	}

	strlcpy(path1, rcs_tmpdir, sizeof(path1));
	strlcat(path1, "/diff1.XXXXXXXXXX", sizeof(path1));
	if (cvs_buf_write_stmp(b1, path1, 0600) == -1) {
		cvs_log(LP_ERRNO, "could not write temporary file");
		cvs_buf_free(b1);
		cvs_buf_free(b2);
		return (NULL);
	}
	cvs_buf_free(b1);

	strlcpy(path2, rcs_tmpdir, sizeof(path2));
	strlcat(path2, "/diff2.XXXXXXXXXX", sizeof(path2));
	if (cvs_buf_write_stmp(b2, path2, 0600) == -1) {
		cvs_buf_free(b2);
		(void)unlink(path1);
		return (NULL);
	}
	cvs_buf_free(b2);

	diff_format = D_RCSDIFF;
	cvs_diffreg(path1, path2, b3);
	(void)unlink(path1);
	(void)unlink(path2);

	cvs_buf_putc(b3, '\0');
	deltatext = (char *)cvs_buf_release(b3);

	return (deltatext);
}

/*
 * checkin_getlogmsg() 
 *
 * Get log message from user interactively.
 * Returns pointer to a char array on success, NULL on failure.
 */
static char *
checkin_getlogmsg(RCSNUM *rev, RCSNUM *rev2)
{
	char   *rcs_msg, nrev[16], prev[16];
	RCSNUM *tmprev;

	rcs_msg = NULL;
	tmprev = rcsnum_alloc();
	rcsnum_cpy(rev, tmprev, 16);
	rcsnum_tostr(tmprev, prev, sizeof(prev));
	if (rev2 == NULL)
		rcsnum_tostr(rcsnum_inc(tmprev), nrev, sizeof(nrev));
	else
		rcsnum_tostr(rev2, nrev, sizeof(nrev));
	rcsnum_free(tmprev);

	if (verbose == 1)
		printf("new revision: %s; previous revision: %s\n", nrev,
		    prev);

	rcs_msg = checkin_getinput(LOG_PROMPT);
	return (rcs_msg);
}


/*
 * checkin_getdesc()
 *
 * Get file description interactively.
 * Returns pointer to a char array on success, NULL on failure.
 */
static char *
checkin_getdesc()
{
	char *description;

	description = checkin_getinput(DESC_PROMPT);
	return (description);
}

/*
 * checkin_getinput()
 *
 * Get some input from the user, in RCS style, prompting with message <prompt>.
 * Returns pointer to a char array on success, NULL on failure.
 */
static char *
checkin_getinput(const char *prompt)
{
	BUF *inputbuf;
	char *input, buf[128];

	if ((inputbuf = cvs_buf_alloc((size_t)64, BUF_AUTOEXT)) == NULL) {
		cvs_log(LP_ERR, "failed to allocate input buffer");
		return (NULL);
	}

	printf(prompt);
	for (;;) {
		fgets(buf, (int)sizeof(buf), stdin);
		if (feof(stdin) || ferror(stdin) || buf[0] == '.')
			break;
		cvs_buf_append(inputbuf, buf, strlen(buf));
		printf(">> ");
	}

	cvs_buf_putc(inputbuf, '\0');
	input = (char *)cvs_buf_release(inputbuf);

	return (input);
}

/*
 * checkin_init()
 * 
 * Does an initial check in, just enough to create the new ,v file
 * XXX not fully implemented yet.
 */
static void
checkin_init(struct checkin_params *pb)
{
	BUF *bp;
	char *rcs_desc, *filec;

	/*
	 * Load file contents
	 */
	if ((bp = cvs_buf_load(pb->filename, BUF_AUTOEXT)) == NULL) {
		cvs_log(LP_ERR, "failed to load '%s'", pb->filename);
		exit(1);
	}

	if (cvs_buf_putc(bp, '\0') < 0)
		exit(1);

	filec = (char *)cvs_buf_release(bp);

	/*
	 * Get description from user
	 */
	rcs_desc = checkin_getdesc();
	rcs_desc_set(pb->file, rcs_desc);

	/*
	 * Now add our new revision
	 */
	if (rcs_rev_add(pb->file, RCS_HEAD_REV, LOG_INIT,
		-1, pb->username) != 0) {
		cvs_log(LP_ERR, "failed to add new revision");
		exit(1);
	}
}

/*
 * checkin_attach_symbol()
 *
 * Attempt to attach the specified symbol to the revision.
 * On success, return 0. On error return -1.
 */
static int
checkin_attach_symbol(struct checkin_params *pb)
{
	char rbuf[16];
	int ret;
	if (verbose == 1)
		printf("symbol: %s\n", pb->symbol);
	if (pb->flags & CI_SYMFORCE)
		rcs_sym_remove(pb->file, pb->symbol);
	if ((ret = rcs_sym_add(pb->file, pb->symbol, pb->newrev) == -1)
	    && (rcs_errno == RCS_ERR_DUPENT)) {
		rcsnum_tostr(rcs_sym_getrev(pb->file, pb->symbol),
		    rbuf, sizeof(rbuf));
		cvs_log(LP_ERR,
		    "symbolic name %s already bound to %s",
		    pb->symbol, rbuf);
		rcs_close(pb->file);
		return (-1);
	} else if (ret == -1) {
		cvs_log(LP_ERR, "problem adding symbol: %s",
		    pb->symbol);
		rcs_close(pb->file);
		return (-1);
	}
	return (0);
}

/*
 * checkin_revert()
 *
 * If there are no differences between the working file and the latest revision
 * and the -f flag is not specified, simply revert to the latest version and
 * warn the user.
 *
 */
static void
checkin_revert(struct checkin_params *pb)
{
	char rbuf[16];

	rcsnum_tostr(pb->frev, rbuf, sizeof(rbuf));
	cvs_log(LP_WARN,
	    "file is unchanged; reverting to previous revision %s",
	    rbuf);
	(void)unlink(pb->filename);
	if ((pb->flags & CO_LOCK) || (pb->flags & CO_UNLOCK))
		checkout_rev(pb->file, pb->frev, pb->filename,
		    pb->flags, pb->username);
	rcs_lock_remove(pb->file, pb->frev);
	rcs_close(pb->file);
	if (verbose == 1)
		printf("done\n");
}

/*
 * checkin_checklock()
 *
 * Check for the existence of a lock on the file.  If there are no locks, or it
 * is not locked by the correct user, return -1.  Otherwise, return 0.
 */
static int
checkin_checklock(struct checkin_params *pb)
{
	int found = 0, notlocked = 1;
	struct rcs_lock *lkp;

	if (!TAILQ_EMPTY(&(pb->file->rf_locks))) {
		TAILQ_FOREACH(lkp, &(pb->file->rf_locks), rl_list) {
			if (!strcmp(lkp->rl_name, pb->username))
				notlocked = 0;

			if (!strcmp(lkp->rl_name, pb->username) &&
			    !rcsnum_cmp(lkp->rl_num, pb->frev, 0)) {
				found = 1;
				return (0);
			}
		}
	}

	if ((found == 0) && (notlocked == 0)) {
		cvs_log(LP_ERR, "no locks set for '%s'", pb->username);
		rcs_close(pb->file);
		return (-1);
	}
	return (0);
}