summaryrefslogtreecommitdiffstats
path: root/src/util/logwriter.c
blob: 4a18be3143c4576e58ab4748c22e293adafd9063 (plain)
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
/*++
/* NAME
/*	logwriter 3
/* SUMMARY
/*	logfile writer
/* SYNOPSIS
/*	#include <logwriter.h>
/*
/*	VSTREAM	*logwriter_open_or_die(
/*	const char *path)
/*
/*	int	logwriter_write(
/*	VSTREAM	*file,
/*	const char *buffer.
/*	ssize_t	buflen)
/*
/*	int	logwriter_close(
/*	VSTREAM	*file)
/*
/*	int	logwriter_one_shot(
/*	const char *path,
/*	const char *buffer,
/*	ssize_t	buflen)
/*
/*	int	set_logwriter_create_perms(
/*	const char *mode)
/* DESCRIPTION
/*	This module manages a logfile writer.
/*
/*	logwriter_open_or_die() safely opens the specified file in
/*	write+append mode. File open/create errors are fatal.
/*
/*	logwriter_write() writes the buffer plus newline to the
/*	open logfile. The result is zero if successful, VSTREAM_EOF
/*	if the operation failed.
/*
/*	logwriter_close() closes the logfile and destroys the VSTREAM
/*	instance. The result is zero if there were no errors writing
/*	the file, VSTREAM_EOF otherwise.
/*
/*	logwriter_one_shot() combines all the above operations. The
/*	result is zero if successful, VSTREAM_EOF if any operation
/*	failed.
/*
/*	set_logwriter_create_perms() sets the file permissions that
/*	will be used when creating a logfile. Valid inputs are
/*	"644", "640", and "600". Leading zeros are allowed and
/*	ignored.
/* DIAGNOSTICS
/*	Fatal error: logfile create error; warning: logfile permission
/*	change error. set_logwriter_create_perms() returns the file
/*	create permission if the request is valid, -1 otherwise.
/* LICENSE
/* .ad
/* .fi
/*	The Secure Mailer license must be distributed with this software.
/* AUTHOR(S)
/*	Wietse Venema
/*	Google, Inc.
/*	111 8th Avenue
/*	New York, NY 10011, USA
/*--*/

 /*
  * System library.
  */
#include <sys_defs.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>

 /*
  * Utility library.
  */
#include <iostuff.h>
#include <logwriter.h>
#include <msg.h>
#include <mymalloc.h>
#include <safe_open.h>
#include <vstream.h>
#include <name_code.h>

 /*
  * Application-specific.
  */
static int logwriter_perms = 0600;

/* logwriter_open_or_die - open logfile */

VSTREAM *logwriter_open_or_die(const char *path)
{
    VSTREAM *fp;
    VSTRING *why = vstring_alloc(100);

#define NO_STATP	((struct stat *) 0)
#define NO_CHOWN	(-1)
#define NO_CHGRP	(-1)

    fp = safe_open(path, O_CREAT | O_WRONLY | O_APPEND, logwriter_perms,
		   NO_STATP, NO_CHOWN, NO_CHGRP, why);
    if (fp == 0)
	msg_fatal("open logfile '%s': %s", path, vstring_str(why));
    close_on_exec(vstream_fileno(fp), CLOSE_ON_EXEC);
    vstring_free(why);
    return (fp);
}

/* logwriter_write - append to logfile */

int     logwriter_write(VSTREAM *fp, const char *buf, ssize_t len)
{
    if (len < 0)
	msg_panic("logwriter_write: negative length %ld", (long) len);
    if (vstream_fwrite(fp, buf, len) != len)
	return (VSTREAM_EOF);
    VSTREAM_PUTC('\n', fp);
    return (vstream_fflush(fp));
}

/* logwriter_close - close logfile */

int     logwriter_close(VSTREAM *fp)
{
    return (vstream_fclose(fp));
}

/* logwriter_one_shot - one-shot logwriter */

int     logwriter_one_shot(const char *path, const char *buf, ssize_t len)
{
    VSTREAM *fp;
    int     err;

    fp = logwriter_open_or_die(path);
    err = logwriter_write(fp, buf, len);
    err |= logwriter_close(fp);
    return (err ? VSTREAM_EOF : 0);
}

/* set_logwriter_create_perms - logfile permission control */

int     set_logwriter_create_perms(const char *mode_str)
{
    static const NAME_CODE sane_perms[] = {
	"644", 0644,
	"640", 0640,
	"600", 0600,
	0, -1,
    };
    int     perms;

    if ((perms = name_code(sane_perms, NAME_CODE_FLAG_NONE,
			   mode_str + strspn(mode_str, "0"))) != -1)
	logwriter_perms = perms;
    return (perms);
}