File: log.c

package info (click to toggle)
cfengine3 3.24.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 37,552 kB
  • sloc: ansic: 163,161; sh: 10,296; python: 2,950; makefile: 1,744; lex: 784; yacc: 633; perl: 211; pascal: 157; xml: 21; sed: 13
file content (165 lines) | stat: -rw-r--r-- 4,130 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
  Copyright 2024 Northern.tech AS

  This file is part of CFEngine 3 - written and maintained by Northern.tech AS.

  This program 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; version 3.

  This program 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
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA

  To the extent this program is licensed as part of the Enterprise
  versions of CFEngine, the applicable Commercial Open Source License
  (COSL) may apply to this file if you as a licensee so wish it. See
  included file COSL.txt.
*/

#include <platform.h>
#include <log.h>
#include <alloc-mini.h>
#include <time.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#include <stdarg.h>


#define MAX_LOG_ENTRY_SIZE  4096

static FILE *LOG_STREAM = NULL;
static LogLevel CURRENT_LEVEL = LogVerbose;


static char *prepare_message(char *format, va_list args)
{
    char *message = NULL;
    int message_size = 0;
    char timestamp[] = "YYYY/MM/DD HH:MM:SS";
    char buffer[MAX_LOG_ENTRY_SIZE];

    struct tm now;
    time_t now_seconds = time(NULL);
    gmtime_r(&now_seconds, &now);

    int timestamp_size = sizeof(timestamp);
    message_size = vsnprintf(buffer, MAX_LOG_ENTRY_SIZE - 1, format, args);
    strftime(timestamp, timestamp_size, "%Y/%m/%d %H:%M:%S", &now);
    /* '[' + ']' + ' ' + '\0' */
    const size_t buf_size = message_size + timestamp_size + 3 + 1;
    message = xmalloc(buf_size);
    snprintf(message, buf_size, "[%s] %s", timestamp, buffer);
    return message;
}

static void write_console_log_entry(const char *message)
{
    puts(message);
}

static void write_file_log_entry(const char *message)
{
    if (LOG_STREAM != NULL)
    {
        fputs(message, LOG_STREAM);
        fputs("\n", LOG_STREAM);
        fflush(LOG_STREAM);
    }
}

static void private_log_init()
{
    char path[] = "cf-upgrade-YYYYMMDD-HHMMSS.log";

    struct tm now;
    time_t now_seconds = time(NULL);
    gmtime_r(&now_seconds, &now);

    int log_fd = -1;

    strftime(path, sizeof(path), "cf-upgrade-%Y%m%d-%H%M%S.log", &now);
#ifndef __MINGW32__
    log_fd = open(path, O_WRONLY|O_CREAT, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
#else
    log_fd = open(path, O_WRONLY|O_CREAT, S_IRUSR|S_IWUSR);
#endif
    if (log_fd < 0)
    {
        puts("Could not initialize log file, only console messages will be printed");
        return;
    }

#ifndef __MINGW32__
    /*
     * cf-upgrade spawns itself, therefore to avoid log confusion we need to
     * make sure that the log is closed when we call exeve.
     */
    int result = 0;
    result = fcntl(log_fd, F_GETFD);
    if (result < 0)
    {
        puts("Could not initialize log file, only console messages will be printed");
        return;
    }
    result = fcntl(log_fd, F_SETFD, result | FD_CLOEXEC);
    if (result < 0)
    {
        puts("Could not initialize log file, only console messages will be printed");
        return;
    }
#endif

    LOG_STREAM = fdopen(log_fd, "a");
}

void logInit()
{
    private_log_init();
}

void logFinish()
{
    if (LOG_STREAM)
    {
        fclose(LOG_STREAM);
    }
}

void log_entry(LogLevel level, char *format, ...)
{
    if (level > CURRENT_LEVEL)
    {
        return;
    }

    va_list ap;
    va_start(ap, format);
    char *message = prepare_message(format, ap);
    va_end(ap);

    switch (level)
    {
    case LogCritical:
    case LogNormal:
    case LogVerbose:
        write_console_log_entry(message);
        write_file_log_entry(message);
        break;
    case LogDebug:
        write_file_log_entry(message);
        break;
    }

    free(message);
}