Return to log.c CVS log

Up to [local] / src / usr.bin / cvs

switch to xmalloc stuff, me and xsa@ agreed on this a long
time ago, but we were being held back by jfb. too bad for him.

next step is to use fatal() through out the code for unrecoverable
errors instead of trying to be all nice and fluffy and reach main() again.

ok niallo@ and xsa@

/*	$OpenBSD: log.c,v 1.28 2005/12/10 20:27:45 joris Exp $	*/
/*
 * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions 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/types.h>

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include <unistd.h>

#include "cvs.h"
#include "log.h"

extern char *__progname;


#ifdef unused
static char *cvs_log_levels[LP_MAX + 1] = {
	"debug",
	"info",
	"notice",
	"warning",
	"error",
	"alert",
	"error",
	"abort",
	"trace",
};
#endif

static int cvs_slpriomap[LP_MAX + 1] = {
	LOG_DEBUG,
	LOG_INFO,
	LOG_NOTICE,
	LOG_WARNING,
	LOG_ERR,
	LOG_ALERT,
	LOG_ERR,
	LOG_ERR,
	LOG_DEBUG,
};

#if !defined(RCSPROG)
static int send_m = 1;
#endif
static u_int cvs_log_dest = LD_STD;
static u_int cvs_log_flags = 0;

static struct syslog_data cvs_sl = SYSLOG_DATA_INIT;

/* filter manipulation macros */
#define CVS_LOG_FLTRRST()	(cvs_log_filters = 0)
#define CVS_LOG_FLTRSET(l)	(cvs_log_filters |= (1 << l))
#define CVS_LOG_FLTRGET(l)	(cvs_log_filters & (1 << l))
#define CVS_LOG_FLTRCLR(l)	(cvs_log_filters &= ~(1 << l))

static u_int cvs_log_filters;


/*
 * cvs_log_init()
 *
 * Initialize the logging facility of the server.
 * Returns 0 on success, or -1 on failure.
 */
int
cvs_log_init(u_int dest, u_int flags)
{
	int slopt;

	cvs_log_dest = dest;
	cvs_log_flags = flags;

	/* by default, filter only LP_DEBUG and LP_INFO levels */
	CVS_LOG_FLTRRST();
	CVS_LOG_FLTRSET(LP_DEBUG);
	CVS_LOG_FLTRSET(LP_INFO);

	/* traces are enabled with the -t command-line option */
	CVS_LOG_FLTRSET(LP_TRACE);

	if (dest & LD_SYSLOG) {
		slopt = 0;

		if (dest & LD_CONS)
			slopt |= LOG_CONS;
		if (flags & LF_PID)
			slopt |= LOG_PID;

		openlog_r(__progname, slopt, LOG_DAEMON, &cvs_sl);
	}

	return (0);
}


/*
 * cvs_log_cleanup()
 *
 * Cleanup the logging facility.
 */
void
cvs_log_cleanup(void)
{

	closelog_r(&cvs_sl);
}


/*
 * cvs_log_filter()
 *
 * Apply or remove filters on the logging facility.  The exact operation is
 * specified by the <how> and <level> arguments.  The <how> arguments tells
 * how the filters will be affected, and <level> gives the log levels that
 * will be affected by the change.
 * Returns 0 on success, or -1 on failure.
 */

int
cvs_log_filter(u_int how, u_int level)
{
	u_int i;

	if ((level > LP_MAX) && (level != LP_ALL)) {
		cvs_log(LP_ERR, "invalid log level for filter");
		return (-1);
	}

	switch (how) {
	case LP_FILTER_SET:
		if (level == LP_ALL)
			for (i = 0; i <= LP_MAX; i++)
				CVS_LOG_FLTRSET(i);
		else
			CVS_LOG_FLTRSET(level);
		break;
	case LP_FILTER_UNSET:
		if (level == LP_ALL)
			CVS_LOG_FLTRRST();
		else
			CVS_LOG_FLTRCLR(level);
		break;
	default:
		return (-1);
	}

	return (0);
}


/*
 * cvs_log()
 *
 * Log the format-string message
 * The <fmt> argument should not have a terminating newline, as this is taken
 * care of by the logging facility.
 */
int
cvs_log(u_int level, const char *fmt, ...)
{
	int ret;
	va_list vap;

	va_start(vap, fmt);
	ret = cvs_vlog(level, fmt, vap);
	va_end(vap);

	return (ret);
}


/*
 * cvs_vlog()
 *
 * The <fmt> argument should not have a terminating newline, as this is taken
 * care of by the logging facility.
 */
int
cvs_vlog(u_int level, const char *fmt, va_list vap)
{
	int ecp;
	char prefix[64], buf[1024], ebuf[255];
	FILE *out;
#if !defined(RCSPROG)
	char *cmdname;
	struct cvs_cmd *cmdp;
#endif

	if (level > LP_MAX)
		return (-1);

	/* apply any filters */
	if (CVS_LOG_FLTRGET(level))
		return (0);

	if (level == LP_ERRNO)
		ecp = errno;
	else
		ecp = 0;

	/* always use the command name in error messages, not aliases */
#if !defined(RCSPROG)
	if (cvs_command == NULL)
		cmdname = " ";
	else {
		cmdp = cvs_findcmd(cvs_command);
		cmdname = cmdp->cmd_name;
	}

	/* The cvs program appends the command name to the program name */
	if (level == LP_TRACE) {
		strlcpy(prefix, " -> ", sizeof(prefix));
		if (cvs_cmdop == CVS_OP_SERVER)
			prefix[0] = 'S';
	} else if (cvs_command != NULL) {
		if (level == LP_ABORT)
			snprintf(prefix, sizeof(prefix), "%s [%s aborted]",
			    __progname, cmdname);
		else
			snprintf(prefix, sizeof(prefix), "%s %s", __progname,
			    cmdname);
	} else /* just use the standard strlcpy */
#endif
		strlcpy(prefix, __progname, sizeof(prefix));

	if ((cvs_log_flags & LF_PID) && (level != LP_TRACE)) {
		snprintf(buf, sizeof(buf), "[%d]", (int)getpid());
		strlcat(prefix, buf, sizeof(prefix));
	}

	vsnprintf(buf, sizeof(buf), fmt, vap);
	if (level == LP_ERRNO) {
		snprintf(ebuf, sizeof(ebuf), ": %s", strerror(errno));
		strlcat(buf, ebuf, sizeof(buf));
	}

	if (cvs_log_dest & LD_STD) {
		if (level < LP_NOTICE)
			out = stdout;
		else
			out = stderr;

#if !defined(RCSPROG)
		if (cvs_cmdop == CVS_OP_SERVER) {
			if (out == stdout)
				putc('M', out);
			else {
				out = stdout;
				putc('E', out);
			}
			putc(' ', out);
		}
#endif

		fputs(prefix, out);
		if (level != LP_TRACE)
			fputs(": ", out);
		fputs(buf, out);
		fputc('\n', out);
	}

	if (cvs_log_dest & LD_SYSLOG)
		syslog_r(cvs_slpriomap[level], &cvs_sl, "%s", buf);

	/* preserve it just in case we changed it? */
	if (level == LP_ERRNO)
		errno = ecp;

	return (0);
}


/*
 * cvs_printf()
 *
 * Wrapper function around printf() that prepends a 'M' command when
 * the program is acting as server.
 */
int
cvs_printf(const char *fmt, ...)
{
	int ret;
#if !defined(RCSPROG)
	char *nstr, *dp, *sp;
#endif
	va_list vap;

	va_start(vap, fmt);

#if !defined(RCSPROG)
	if (cvs_cmdop == CVS_OP_SERVER) {
		ret = vasprintf(&nstr, fmt, vap);
		if (ret != -1) {
			for (dp = nstr; *dp != '\0';) {
				sp = strchr(dp, '\n');
				if (sp == NULL)
					for (sp = dp; *sp != '\0'; sp++)
						;

				if (send_m) {
					send_m = 0;
					putc('M', stdout);
					putc(' ', stdout);
				}

				fwrite(dp, sizeof(char), (size_t)(sp - dp),
				    stdout);

				if (*sp != '\n')
					break;

				putc('\n', stdout);
				send_m = 1;
				dp = sp + 1;
			}
			xfree(nstr);
		}
	} else
#endif
		ret = vprintf(fmt, vap);

	va_end(vap);
	return (ret);
}
void
cvs_putchar(int c)
{
#if !defined(RCSPROG)
	if (cvs_cmdop == CVS_OP_SERVER && send_m) {
		send_m = 0;
		putc('M', stdout);
		putc(' ', stdout);
	}
#endif

	putc(c, stdout);

#if !defined(RCSPROG)
	if (cvs_cmdop == CVS_OP_SERVER && c == '\n')
		send_m = 1;
#endif
}