blob: 04b2c8e3b308712bf1693327c3dd69e269dfcec9 [file] [log] [blame]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001/* vi: set sw=4 ts=4: */
Eric Andersen3843e961999-11-25 07:30:46 +00002/*
3 * Mini logger implementation for busybox
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
Eric Andersen3843e961999-11-25 07:30:46 +00006 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02007 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Eric Andersen3843e961999-11-25 07:30:46 +00008 */
Denys Vlasenkod34f3002015-10-18 18:42:03 +02009//config:config LOGGER
Denys Vlasenkob097a842018-12-28 03:20:17 +010010//config: bool "logger (6.3 kb)"
Denys Vlasenkod34f3002015-10-18 18:42:03 +020011//config: default y
12//config: select FEATURE_SYSLOG
13//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020014//config: The logger utility allows you to send arbitrary text
15//config: messages to the system log (i.e. the 'syslogd' utility) so
16//config: they can be logged. This is generally used to help locate
17//config: problems that occur within programs and scripts.
Denys Vlasenkod34f3002015-10-18 18:42:03 +020018
19//applet:IF_LOGGER(APPLET(logger, BB_DIR_USR_BIN, BB_SUID_DROP))
20
21//kbuild:lib-$(CONFIG_LOGGER) += syslogd_and_logger.o
Eric Andersen3843e961999-11-25 07:30:46 +000022
Pere Orga5bc8c002011-04-11 03:29:49 +020023//usage:#define logger_trivial_usage
Denys Vlasenko84d5edd2020-12-13 22:34:05 +010024//usage: "[-s] [-t TAG] [-p PRIO] [MESSAGE]"
Pere Orga5bc8c002011-04-11 03:29:49 +020025//usage:#define logger_full_usage "\n\n"
26//usage: "Write MESSAGE (or stdin) to syslog\n"
Pere Orga5bc8c002011-04-11 03:29:49 +020027//usage: "\n -s Log to stderr as well as the system log"
28//usage: "\n -t TAG Log using the specified tag (defaults to user name)"
Denys Vlasenkoe2b92152021-06-14 20:47:20 +020029//usage: "\n -p PRIO Priority (number or FACILITY.LEVEL pair)"
Pere Orga5bc8c002011-04-11 03:29:49 +020030//usage:
31//usage:#define logger_example_usage
32//usage: "$ logger \"hello\"\n"
33
Denis Vlasenkobd1aeeb2008-06-11 15:43:19 +000034/*
35 * Done in syslogd_and_logger.c:
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000036#include "libbb.h"
Eric Andersen3843e961999-11-25 07:30:46 +000037#define SYSLOG_NAMES
Bernhard Reutner-Fischerf4701962008-01-27 12:50:12 +000038#define SYSLOG_NAMES_CONST
39#include <syslog.h>
Denis Vlasenkobd1aeeb2008-06-11 15:43:19 +000040*/
Eric Andersen3843e961999-11-25 07:30:46 +000041
Eric Andersenc7bda1c2004-03-15 08:29:22 +000042/* Decode a symbolic name to a numeric value
Eric Andersen3843e961999-11-25 07:30:46 +000043 * this function is based on code
44 * Copyright (c) 1983, 1993
45 * The Regents of the University of California. All rights reserved.
Eric Andersenc7bda1c2004-03-15 08:29:22 +000046 *
Eric Andersen4e573f42000-11-14 23:29:24 +000047 * Original copyright notice is retained at the end of this file.
Eric Andersen3843e961999-11-25 07:30:46 +000048 */
Denis Vlasenkod2023282007-11-23 23:39:01 +000049static int decode(char *name, const CODE *codetab)
Eric Andersen3843e961999-11-25 07:30:46 +000050{
Denis Vlasenkod2023282007-11-23 23:39:01 +000051 const CODE *c;
Eric Andersen3843e961999-11-25 07:30:46 +000052
Erik Andersene49d5ec2000-02-08 19:58:47 +000053 if (isdigit(*name))
Denis Vlasenko13858992006-10-08 12:49:22 +000054 return atoi(name);
Erik Andersene49d5ec2000-02-08 19:58:47 +000055 for (c = codetab; c->c_name; c++) {
56 if (!strcasecmp(name, c->c_name)) {
Denis Vlasenko13858992006-10-08 12:49:22 +000057 return c->c_val;
Erik Andersene49d5ec2000-02-08 19:58:47 +000058 }
Eric Andersen3843e961999-11-25 07:30:46 +000059 }
Eric Andersen3843e961999-11-25 07:30:46 +000060
Denis Vlasenko13858992006-10-08 12:49:22 +000061 return -1;
Eric Andersen3843e961999-11-25 07:30:46 +000062}
63
Eric Andersenc7bda1c2004-03-15 08:29:22 +000064/* Decode a symbolic name to a numeric value
Eric Andersen3843e961999-11-25 07:30:46 +000065 * this function is based on code
66 * Copyright (c) 1983, 1993
67 * The Regents of the University of California. All rights reserved.
Eric Andersen4e573f42000-11-14 23:29:24 +000068 *
69 * Original copyright notice is retained at the end of this file.
Eric Andersen3843e961999-11-25 07:30:46 +000070 */
Erik Andersene49d5ec2000-02-08 19:58:47 +000071static int pencode(char *s)
Eric Andersen3843e961999-11-25 07:30:46 +000072{
Erik Andersene49d5ec2000-02-08 19:58:47 +000073 char *save;
74 int lev, fac = LOG_USER;
Eric Andersen3843e961999-11-25 07:30:46 +000075
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +000076 for (save = s; *s && *s != '.'; ++s)
77 ;
Erik Andersene49d5ec2000-02-08 19:58:47 +000078 if (*s) {
79 *s = '\0';
Denys Vlasenkocf686ae2017-08-16 15:05:36 +020080 fac = decode(save, bb_facilitynames);
Matt Kraai31804132000-10-25 16:40:21 +000081 if (fac < 0)
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +000082 bb_error_msg_and_die("unknown %s name: %s", "facility", save);
Erik Andersene49d5ec2000-02-08 19:58:47 +000083 *s++ = '.';
84 } else {
85 s = save;
Eric Andersen3843e961999-11-25 07:30:46 +000086 }
Denys Vlasenkocf686ae2017-08-16 15:05:36 +020087 lev = decode(s, bb_prioritynames);
Matt Kraai31804132000-10-25 16:40:21 +000088 if (lev < 0)
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +000089 bb_error_msg_and_die("unknown %s name: %s", "priority", save);
Erik Andersene49d5ec2000-02-08 19:58:47 +000090 return ((lev & LOG_PRIMASK) | (fac & LOG_FACMASK));
Eric Andersen3843e961999-11-25 07:30:46 +000091}
92
Denis Vlasenkobd1aeeb2008-06-11 15:43:19 +000093#define strbuf bb_common_bufsiz1
Eric Andersen3843e961999-11-25 07:30:46 +000094
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +000095int logger_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denys Vlasenko2ec91ae2010-01-04 14:15:38 +010096int logger_main(int argc UNUSED_PARAM, char **argv)
Eric Andersen3843e961999-11-25 07:30:46 +000097{
Denis Vlasenko4df81352007-01-12 21:01:05 +000098 char *str_p, *str_t;
Denis Vlasenko0c68a872008-12-02 22:56:59 +000099 int opt;
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +0000100 int i = 0;
Eric Andersen3843e961999-11-25 07:30:46 +0000101
Denys Vlasenko9de2e5a2016-04-21 18:38:51 +0200102 setup_common_bufsiz();
103
Matt Kraai1944f542001-01-02 18:13:58 +0000104 /* Fill out the name string early (may be overwritten later) */
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000105 str_t = uid2uname_utoa(geteuid());
Eric Andersen3843e961999-11-25 07:30:46 +0000106
Erik Andersene49d5ec2000-02-08 19:58:47 +0000107 /* Parse any options */
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000108 opt = getopt32(argv, "p:st:", &str_p, &str_t);
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +0000109
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000110 if (opt & 0x2) /* -s */
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +0000111 i |= LOG_PERROR;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000112 //if (opt & 0x4) /* -t */
Denis Vlasenko4df81352007-01-12 21:01:05 +0000113 openlog(str_t, i, 0);
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +0000114 i = LOG_USER | LOG_NOTICE;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000115 if (opt & 0x1) /* -p */
Denis Vlasenko4df81352007-01-12 21:01:05 +0000116 i = pencode(str_p);
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +0000117
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +0000118 argv += optind;
Denys Vlasenko2ec91ae2010-01-04 14:15:38 +0100119 if (!argv[0]) {
Denis Vlasenkoebeaea02007-10-02 09:57:41 +0000120 while (fgets(strbuf, COMMON_BUFSIZE, stdin)) {
Denis Vlasenko74324c82007-06-04 10:16:52 +0000121 if (strbuf[0]
122 && NOT_LONE_CHAR(strbuf, '\n')
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +0000123 ) {
124 /* Neither "" nor "\n" */
Denis Vlasenko74324c82007-06-04 10:16:52 +0000125 syslog(i, "%s", strbuf);
Eric Andersen20aab262001-07-19 22:28:02 +0000126 }
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +0000127 }
Eric Andersenbefda6e1999-11-25 08:06:22 +0000128 } else {
Glenn L McGrath907a2402002-11-10 21:33:28 +0000129 char *message = NULL;
Denis Vlasenkoebeaea02007-10-02 09:57:41 +0000130 int len = 0;
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +0000131 int pos = 0;
132 do {
133 len += strlen(*argv) + 1;
Denis Vlasenkoebeaea02007-10-02 09:57:41 +0000134 message = xrealloc(message, len + 1);
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +0000135 sprintf(message + pos, " %s", *argv),
136 pos = len;
137 } while (*++argv);
Bernhard Reutner-Fischer0f486632007-01-09 17:37:32 +0000138 syslog(i, "%s", message + 1); /* skip leading " " */
Eric Andersenbefda6e1999-11-25 08:06:22 +0000139 }
Eric Andersen3843e961999-11-25 07:30:46 +0000140
Eric Andersen20aab262001-07-19 22:28:02 +0000141 closelog();
Matt Kraai31804132000-10-25 16:40:21 +0000142 return EXIT_SUCCESS;
Eric Andersen3843e961999-11-25 07:30:46 +0000143}
Eric Andersen4e573f42000-11-14 23:29:24 +0000144
Denis Vlasenkobd1aeeb2008-06-11 15:43:19 +0000145/* Clean up. Needed because we are included from syslogd_and_logger.c */
146#undef strbuf
Eric Andersen4e573f42000-11-14 23:29:24 +0000147
148/*-
149 * Copyright (c) 1983, 1993
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200150 * The Regents of the University of California. All rights reserved.
Eric Andersen4e573f42000-11-14 23:29:24 +0000151 *
152 * This is the original license statement for the decode and pencode functions.
153 *
154 * Redistribution and use in source and binary forms, with or without
155 * modification, are permitted provided that the following conditions
156 * are met:
157 * 1. Redistributions of source code must retain the above copyright
158 * notice, this list of conditions and the following disclaimer.
159 * 2. Redistributions in binary form must reproduce the above copyright
160 * notice, this list of conditions and the following disclaimer in the
161 * documentation and/or other materials provided with the distribution.
162 *
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200163 * 3. BSD Advertising Clause omitted per the July 22, 1999 licensing change
164 * ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change
Eric Andersen4e573f42000-11-14 23:29:24 +0000165 *
166 * 4. Neither the name of the University nor the names of its contributors
167 * may be used to endorse or promote products derived from this software
168 * without specific prior written permission.
169 *
Denys Vlasenko95f79532017-08-02 14:26:33 +0200170 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND
Eric Andersen4e573f42000-11-14 23:29:24 +0000171 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
172 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
173 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
174 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
175 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
176 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
177 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
178 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
179 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
180 * SUCH DAMAGE.
181 */