1
0
Fork 0
profanity/src/log.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

372 lines
8.7 KiB
C
Raw Normal View History

/*
2012-02-20 15:07:38 -05:00
* log.c
2019-11-13 06:11:05 -05:00
* vim: expandtab:ts=4:sts=4:sw=4
2012-02-20 15:07:38 -05:00
*
2019-01-22 05:31:45 -05:00
* Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
2024-01-22 10:03:48 -05:00
* Copyright (C) 2018 - 2024 Michael Vetter <jubalh@iodoru.org>
*
2012-02-20 15:07:38 -05:00
* This file is part of Profanity.
*
* Profanity is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Profanity is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
2016-07-23 20:14:49 -04:00
* along with Profanity. If not, see <https://www.gnu.org/licenses/>.
2012-02-20 15:07:38 -05:00
*
* In addition, as a special exception, the copyright holders give permission to
* link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two.
*
* You must obey the GNU General Public License in all respects for all of the
* code used other than OpenSSL. If you modify file(s) with this exception, you
* may extend this exception to your version of the file(s), but you are not
* obligated to do so. If you do not wish to do so, delete this exception
* statement from your version. If you delete this exception statement from all
* source files in the program, then also delete it here.
*
2012-02-20 15:07:38 -05:00
*/
#include "config.h"
2013-02-02 19:27:43 -05:00
#include <assert.h>
2013-01-28 15:16:18 -05:00
#include <errno.h>
#include <fcntl.h>
2012-02-05 10:10:10 -05:00
#include <stdio.h>
#include <stdlib.h>
2012-11-11 16:44:55 -05:00
#include <string.h>
2014-04-13 16:56:35 -04:00
#include <unistd.h>
#include "glib.h"
2014-10-18 16:40:11 -04:00
#include "glib/gstdio.h"
2012-02-05 10:10:10 -05:00
#include "log.h"
#include "common.h"
2016-07-24 11:22:15 -04:00
#include "config/files.h"
2013-02-02 16:59:29 -05:00
#include "config/preferences.h"
2012-02-05 10:10:10 -05:00
#define PROF "prof"
2020-07-07 08:18:57 -04:00
static FILE* logp;
static gchar* mainlogfile = NULL;
static gboolean user_provided_log = FALSE;
static log_level_t level_filter;
2012-08-18 20:51:06 -04:00
static int stderr_inited;
static log_level_t stderr_level;
static int stderr_pipe[2];
2020-07-07 08:18:57 -04:00
static char* stderr_buf;
static GString* stderr_msg;
2020-07-02 09:06:17 -04:00
enum {
STDERR_BUFSIZE = 4000,
STDERR_RETRY_NR = 5,
};
2022-06-28 14:13:55 -04:00
static void
_rotate_log_file(void)
{
auto_gchar gchar* log_file = g_strdup(mainlogfile);
2022-06-28 14:13:55 -04:00
size_t len = strlen(log_file);
auto_gchar gchar* log_file_new = malloc(len + 5);
2022-06-28 14:13:55 -04:00
// the mainlog file should always end in '.log', lets remove this last part
// so that we can have profanity.001.log later
if (len > 4) {
log_file[len - 4] = '\0';
}
// find an empty name. from .log -> log.001 -> log.999
for (int i = 1; i < 1000; i++) {
g_sprintf(log_file_new, "%s.%03d.log", log_file, i);
if (!g_file_test(log_file_new, G_FILE_TEST_EXISTS))
break;
}
log_close();
if (len > 4) {
log_file[len - 4] = '.';
}
rename(log_file, log_file_new);
log_init(log_get_filter(), NULL);
log_info("Log has been rotated");
}
// abbreviation string is the prefix that's used in the log file
2022-06-28 14:13:55 -04:00
static char*
_log_abbreviation_string_from_level(log_level_t level)
{
switch (level) {
case PROF_LEVEL_ERROR:
return "ERR";
case PROF_LEVEL_WARN:
return "WRN";
case PROF_LEVEL_INFO:
return "INF";
case PROF_LEVEL_DEBUG:
return "DBG";
default:
return "LOG";
}
}
2012-11-11 16:44:55 -05:00
2012-07-24 18:19:48 -04:00
void
2020-07-07 08:18:57 -04:00
log_debug(const char* const msg, ...)
2012-02-05 10:10:10 -05:00
{
va_list arg;
va_start(arg, msg);
2020-07-07 08:18:57 -04:00
GString* fmt_msg = g_string_new(NULL);
2012-09-09 11:23:33 -04:00
g_string_vprintf(fmt_msg, msg, arg);
log_msg(PROF_LEVEL_DEBUG, PROF, fmt_msg->str);
g_string_free(fmt_msg, TRUE);
va_end(arg);
}
2012-08-18 22:43:18 -04:00
void
2020-07-07 08:18:57 -04:00
log_info(const char* const msg, ...)
{
va_list arg;
va_start(arg, msg);
2020-07-07 08:18:57 -04:00
GString* fmt_msg = g_string_new(NULL);
2012-09-09 11:23:33 -04:00
g_string_vprintf(fmt_msg, msg, arg);
log_msg(PROF_LEVEL_INFO, PROF, fmt_msg->str);
g_string_free(fmt_msg, TRUE);
va_end(arg);
}
2012-08-18 22:43:18 -04:00
void
2020-07-07 08:18:57 -04:00
log_warning(const char* const msg, ...)
{
va_list arg;
va_start(arg, msg);
2020-07-07 08:18:57 -04:00
GString* fmt_msg = g_string_new(NULL);
2012-09-09 11:23:33 -04:00
g_string_vprintf(fmt_msg, msg, arg);
log_msg(PROF_LEVEL_WARN, PROF, fmt_msg->str);
g_string_free(fmt_msg, TRUE);
va_end(arg);
}
2012-08-18 22:43:18 -04:00
void
2020-07-07 08:18:57 -04:00
log_error(const char* const msg, ...)
{
va_list arg;
va_start(arg, msg);
2020-07-07 08:18:57 -04:00
GString* fmt_msg = g_string_new(NULL);
2012-09-09 11:23:33 -04:00
g_string_vprintf(fmt_msg, msg, arg);
log_msg(PROF_LEVEL_ERROR, PROF, fmt_msg->str);
g_string_free(fmt_msg, TRUE);
va_end(arg);
2012-02-05 10:10:10 -05:00
}
2012-07-24 18:19:48 -04:00
void
2020-07-07 08:18:57 -04:00
log_init(log_level_t filter, char* log_file)
2012-02-06 17:29:05 -05:00
{
level_filter = filter;
if (log_file) {
user_provided_log = TRUE;
}
mainlogfile = files_get_log_file(log_file);
logp = fopen(mainlogfile, "a");
g_chmod(mainlogfile, S_IRUSR | S_IWUSR);
2012-08-18 21:44:46 -04:00
}
const gchar*
2014-04-13 17:20:15 -04:00
get_log_file_location(void)
{
return mainlogfile;
2014-04-13 17:20:15 -04:00
}
2012-08-18 21:44:46 -04:00
log_level_t
log_get_filter(void)
2012-08-18 21:44:46 -04:00
{
return level_filter;
2012-02-06 19:08:59 -05:00
}
2012-07-24 18:19:48 -04:00
void
log_close(void)
2012-02-06 19:08:59 -05:00
{
g_free(mainlogfile);
2020-02-22 03:27:04 -05:00
mainlogfile = NULL;
2015-05-04 18:28:34 -04:00
if (logp) {
fclose(logp);
}
2012-02-06 17:29:05 -05:00
}
void
2020-07-07 08:18:57 -04:00
log_msg(log_level_t level, const char* const area, const char* const msg)
{
2015-05-04 18:28:34 -04:00
if (level >= level_filter && logp) {
GDateTime* dt = g_date_time_new_now_local();
char* level_str = _log_abbreviation_string_from_level(level);
2014-01-27 17:48:52 -05:00
auto_gchar gchar* date_fmt = g_date_time_format_iso8601(dt);
2014-01-27 17:48:52 -05:00
fprintf(logp, "%s: %s: %s: %s\n", date_fmt, area, level_str, msg);
g_date_time_unref(dt);
fflush(logp);
2012-11-11 16:44:55 -05:00
if (prefs_get_boolean(PREF_LOG_ROTATE) && !user_provided_log) {
2014-04-25 19:36:36 -04:00
long result = ftell(logp);
2014-04-13 15:41:11 -04:00
if (result != -1 && result >= prefs_get_max_log_size()) {
_rotate_log_file();
}
2012-11-11 16:44:55 -05:00
}
}
}
int
log_level_from_string(char* log_level, log_level_t* level)
2013-02-02 19:27:43 -05:00
{
int ret = 0;
2013-02-02 19:27:43 -05:00
assert(log_level != NULL);
assert(level != NULL);
2013-02-02 19:27:43 -05:00
if (strcmp(log_level, "DEBUG") == 0) {
*level = PROF_LEVEL_DEBUG;
2013-02-02 19:27:43 -05:00
} else if (strcmp(log_level, "INFO") == 0) {
*level = PROF_LEVEL_INFO;
2013-02-02 19:27:43 -05:00
} else if (strcmp(log_level, "WARN") == 0) {
*level = PROF_LEVEL_WARN;
2013-02-02 19:30:24 -05:00
} else if (strcmp(log_level, "ERROR") == 0) {
*level = PROF_LEVEL_ERROR;
} else { // default logging is warn
*level = PROF_LEVEL_WARN;
ret = -1;
2013-02-02 19:27:43 -05:00
}
return ret;
2013-02-02 19:27:43 -05:00
}
const char*
log_string_from_level(log_level_t level)
{
switch (level) {
case PROF_LEVEL_ERROR:
return "ERROR";
case PROF_LEVEL_WARN:
return "WARN";
case PROF_LEVEL_INFO:
return "INFO";
case PROF_LEVEL_DEBUG:
return "DEBUG";
default:
return "LOG";
}
}
void
log_stderr_handler(void)
{
2020-07-07 08:18:57 -04:00
GString* const s = stderr_msg;
char* const buf = stderr_buf;
ssize_t size;
int retry = 0;
if (!stderr_inited)
return;
do {
size = read(stderr_pipe[0], buf, STDERR_BUFSIZE);
if (size == -1 && errno == EINTR && retry++ < STDERR_RETRY_NR)
continue;
if (size <= 0 || retry++ >= STDERR_RETRY_NR)
break;
for (int i = 0; i < size; ++i) {
if (buf[i] == '\n') {
log_msg(stderr_level, "stderr", s->str);
g_string_assign(s, "");
} else
g_string_append_c(s, buf[i]);
}
} while (1);
if (s->len > 0 && s->str[0] != '\0') {
log_msg(stderr_level, "stderr", s->str);
g_string_assign(s, "");
}
}
2020-07-02 09:06:17 -04:00
static int
log_stderr_nonblock_set(int fd)
{
int rc;
rc = fcntl(fd, F_GETFL);
if (rc >= 0)
rc = fcntl(fd, F_SETFL, rc | O_NONBLOCK);
return rc;
}
void
log_stderr_init(log_level_t level)
{
int rc;
rc = pipe(stderr_pipe);
if (rc != 0)
goto err;
close(STDERR_FILENO);
rc = dup2(stderr_pipe[1], STDERR_FILENO);
if (rc < 0)
goto err_close;
rc = log_stderr_nonblock_set(stderr_pipe[0])
2020-07-07 08:18:57 -04:00
?: log_stderr_nonblock_set(stderr_pipe[1]);
if (rc != 0)
goto err_close;
stderr_buf = malloc(STDERR_BUFSIZE);
stderr_msg = g_string_sized_new(STDERR_BUFSIZE);
stderr_level = level;
stderr_inited = 1;
if (stderr_buf == NULL || stderr_msg == NULL) {
errno = ENOMEM;
goto err_free;
}
return;
err_free:
if (stderr_msg != NULL)
g_string_free(stderr_msg, TRUE);
free(stderr_buf);
err_close:
close(stderr_pipe[0]);
close(stderr_pipe[1]);
err:
stderr_inited = 0;
log_error("Unable to init stderr log handler: %s", strerror(errno));
}
void
log_stderr_close(void)
{
if (!stderr_inited)
return;
/* handle remaining logs before close */
log_stderr_handler();
stderr_inited = 0;
free(stderr_buf);
g_string_free(stderr_msg, TRUE);
close(stderr_pipe[0]);
close(stderr_pipe[1]);
}