Skip to content

Commit

Permalink
add xsyslog_ev()
Browse files Browse the repository at this point in the history
  • Loading branch information
@ksmurchison
ksmurchison committed Dec 10, 2024
1 parent e101315 commit 99dbfd7
Show file tree
Hide file tree
Showing 4 changed files with 353 additions and 0 deletions.
1 change: 1 addition & 0 deletions Makefile.am
View file
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,7 @@ cunit_TESTS += \
cunit/stristr.testc \
cunit/times.testc \
cunit/tok.testc \
cunit/util.testc \
cunit/vparse.testc \
cunit/dynarray.testc \
cunit/xsha1.testc
Expand Down
106 changes: 106 additions & 0 deletions cunit/util.testc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
#include "cunit/cyrunit.h"
#include "util.h"

extern char *__test_xsyslog_ev_fmt(const char *, ...);

static void test_xsyslog_ev_fmt(void)
{
// basic tests
{
char *result;

result = __test_xsyslog_ev_fmt("event-name", NULL);
CU_ASSERT_STRING_EQUAL(result, "event=event-name");
free(result);

result = __test_xsyslog_ev_fmt(
"event-name",
"firstname", "%s", "Fred",
NULL);
CU_ASSERT_STRING_EQUAL(result, "event=event-name firstname=Fred");
free(result);

result = __test_xsyslog_ev_fmt(
"event-name",
"firstname", "%s", "Fred",
"lastname", "%s", "Flintstone",
NULL);
CU_ASSERT_STRING_EQUAL(result, "event=event-name firstname=Fred lastname=Flintstone");
free(result);

// now with escaping
result = __test_xsyslog_ev_fmt(
"announce name",
"name", "%s", "Fred Flintstone",
NULL);
CU_ASSERT_STRING_EQUAL(result, "event=\"announce name\" name=\"Fred Flintstone\"");
free(result);

// now with various formats
result = __test_xsyslog_ev_fmt(
"formats",
"strlt", "%-10s", "foo",
"strrt", "%10s", "bar",
"int", "%d", -12,
"ulong", "%ld", 2147483647L,
"double", "%f", 4.2,
"double-fmt", "%5.2f", 4.2,
NULL);
CU_ASSERT_STRING_EQUAL(result,
"event=formats "
"strlt=\"foo \" "
"strrt=\" bar\" "
"int=-12 "
"ulong=2147483647 "
"double=4.200000 "
"double-fmt=\" 4.20\"");
free(result);

// common case: multiline text output
result = __test_xsyslog_ev_fmt(
"multiline",
"text", "%s", "I\r\nlike\r\npie!\r\n",
NULL
);
CU_ASSERT_STRING_EQUAL(result, "event=multiline text=\"I\\r\\nlike\\r\\npie!\\r\\n\"");
free(result);
}

// tests for weird __sep__ feature
{
char *result;
result = __test_xsyslog_ev_fmt(
"sep-test",
"__sep__", "!!!",
"name", "%s", "Fred Flintstone",
"occupation", "%s", "caveman",
NULL);
CU_ASSERT_STRING_EQUAL(result, "event=sep-test!!!name=\"Fred Flintstone\"!!!occupation=caveman");
free(result);
}
}

extern char *__test_xsyslog_ev_escape_value(const char *);

static void test_xsyslog_ev_escape_value(void)
{
const char *test[] = {
/* input, expected output */
"foo", "foo",
"foo bar", "\"foo bar\"",
"call me \"fred\"", "\"call me \\\"fred\\\"\"",
"\n", "\"\\n\"",
"\r", "\"\\r\"",
"\r\n", "\"\\r\\n\"",
"break-my-cranck", "break-my-cranck",
NULL,
};
unsigned i;
for (i=0; test[i]; i += 2) {
const char *in = test[i];
const char *expected = test[i+1];
char *actual = __test_xsyslog_ev_escape_value(in);
CU_ASSERT_STRING_EQUAL(actual, expected);
free(actual);
}
}
244 changes: 244 additions & 0 deletions lib/util.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2193,3 +2193,247 @@ EXPORTED char *modseqtoa(modseq_t modseq)
buf_printf(&buf, MODSEQ_FMT, modseq);
return buf_release(&buf);
}

static const char *xsyslog_ev_escape_value(struct buf *val)
{
int needs_escaping = 0, orig_len, escaped_len;
const char *p;

escaped_len = orig_len = buf_len(val);

for (p = buf_cstring(val); *p; p++) {
switch (*p) {
case '\\':
case '\"':
case '\n':
case '\r':
++escaped_len; // add 1 for the backslash

// FALL THROUGH
case ' ':
needs_escaping = 1;
break;
}
}

if (needs_escaping) {
char *q;

escaped_len += 2; // add 2 for surrounding DQUOTEs

buf_truncate(val, escaped_len); // grow the buffer to escaped length

// we can now build the escaped value in place, tail to head
q = (char *) buf_base(val) + escaped_len - 1;
*q-- = '\"'; // closing DQUOTE

for (p = buf_base(val) + orig_len - 1; p >= buf_base(val); p--) {
char c = *p;

switch (c) {
case '\\':
case '\"':
needs_escaping = 1;
break;

case '\n':
needs_escaping = 1;
c = 'n';
break;

case '\r':
needs_escaping = 1;
c = 'r';
break;

default:
needs_escaping = 0;
break;
}

*q-- = c;

if (needs_escaping) *q-- = '\\';
}

assert(q == buf_base(val));
*q = '\"'; // opening DQUOTE
}

return buf_cstring(val);
}

static char *xsyslog_ev_fmt_va(const char *event_name, va_list ap)
{
struct buf log = BUF_INITIALIZER;
struct buf val = BUF_INITIALIZER;
const char *sep = " "; // string that separates kev=value pairs
const char *key;

// Add "event=(event-name)" to the log buffer
buf_setcstr(&val, event_name);
buf_printf(&log, "event=%s", xsyslog_ev_escape_value(&val));

/*
* Now handle the remaining arguments, which should come in threes:
* key, format, value
*
* value will be buf_printf'ed with the format,
* and then the result will be escaped (if necessary)
*
* finally, the resulting string "key=escaped-formatted-value"
* will be appended to the log buffer
*/
while ((key = va_arg(ap, const char *))) {
// special case: __sep__ means reconfigure the separator
if (!strcmp(key, "__sep__")) {
sep = va_arg(ap, const char *);
}
else {
const char *fmt = va_arg(ap, const char *);
va_list val_ap;

va_copy(val_ap, ap);
buf_reset(&val);
buf_vprintf(&val, fmt, val_ap);
va_end(val_ap);

buf_printf(&log, "%s%s=%s",
sep, key, xsyslog_ev_escape_value(&val));

// skip the args that printf goobled up (based on the format string)
for (const char *p = fmt; *p; p++) {
if (*p == '%') {
// flags
size_t nflags = strspn(++p, "#0- +'I");
p += nflags;

// field width and/or precision
do {
if (*p == '*') {
va_arg(ap, int);
p++;
}
else {
strtol(p, (char **) &p, 10);
}
} while (*p == '.' && *++p);

// length modifier
char len = 0;
if (strchr("hlLzt", *p)) {
len = *p++;
switch (len) {
case 'h':
if (*p == 'h') {
len = 'H';
p++;
}
break;
case 'l':
if (*p == 'l') {
len = 'L';
p++;
}
break;
}
}

// conversion specifier
switch (*p) {
case 'd': case 'i':
case 'o': case 'u':
case 'x': case 'X':
switch (len) {
case 'L':
va_arg(ap, long long int);
break;
case 'l':
va_arg(ap, long int);
break;
case 'z':
va_arg(ap, size_t);
break;
case 't':
va_arg(ap, ptrdiff_t);
break;
default:
va_arg(ap, int);
break;
}
break;

case 'e': case 'E':
case 'f': case 'F':
case 'g': case 'G':
case 'a': case 'A':
if (len == 'L')
va_arg(ap, long double);
else
va_arg(ap, double);
break;

case 'c':
va_arg(ap, int);
break;

case 's':
va_arg(ap, char *);
break;

case 'p':
va_arg(ap, void *);
break;
}
}
}
}
}

buf_free(&val);

return buf_release(&log);
}

EXPORTED void xsyslog_ev(int priority, const char *event_name, ...)
{
va_list ap;
char *s;

va_start(ap, event_name);
s = xsyslog_ev_fmt_va(event_name, ap);
va_end(ap);

if (!s) {
syslog(priority,
"COULD NOT FORMAT SYSLOG STRING FOR EVENT '%s'", event_name);
return;
}

syslog(priority, "%s", s);
free(s);
}

// for unit testing only
EXPORTED char *__test_xsyslog_ev_fmt(const char *event_name, ...)
{
va_list ap;
char *s;

va_start(ap, event_name);
s = xsyslog_ev_fmt_va(event_name, ap);
va_end(ap);

return s;
}

// for unit testing only
EXPORTED char *__test_xsyslog_ev_escape_value(const char *s)
{
struct buf val = BUF_INITIALIZER;

buf_setcstr(&val, s);
xsyslog_ev_escape_value(&val);

return buf_release(&val);
}
2 changes: 2 additions & 0 deletions lib/util.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,8 @@ void xsyslog_fn(int priority, const char *description,
#define xsyslog(pri, desc, ...) \
xsyslog_fn(pri, desc, __func__, __VA_ARGS__)

void xsyslog_ev(int priority, const char *description, ...);

/*
* GCC_VERSION macro usage:
* #if GCC_VERSION > 60909 //GCC version 7 and above
Expand Down

0 comments on commit 99dbfd7

Please sign in to comment.