summaryrefslogtreecommitdiff
path: root/logging.c
blob: e7a20ea5cafccde257efce69c05f874cad2520c6 (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/*
 * This file is part of blabouncer (https://www.blatech.co.uk/l_bratch/blabouncer).
 * Copyright (C) 2019 Luke Bratch <luke@bratch.co.uk>.
 *
 * Blabouncer 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.
 *
 * Blabouncer 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 blabouncer. If not, see <http://www.gnu.org/licenses/>.
*/

#include "logging.h"

// Write the line 'str' to the relevant log file such as
// '#channel.log' or 'nickname.log'.  'ournick' is our own
// nick and is used to determine which log file to write to
// if the type is LOG_PRIVMSG.
// 'basedir' is the directory in which the 'logs' directory
// will be created in which logs are to be written.
//
// If LOG_PRIVMSG then it expects a string in the format:
// :from!bar@baz PRIVMSG to :hello world
//
// LOG_PRIVMSG is also used for NOTICEs.
//
// If LOG_JOINPART then it expects a string in the format:
// :nick!bar@baz JOIN :#channel
// or
// :nick!bar@baz PART #channel
//
// If LOG_TOPIC then it expects a string in the format:
// :nick!bar@baz TOPIC #channel :bla bla bla
//
// With the ":foo!bar@baz "prefix being important for either
// type.
//
// Returns 1 on success or 0 on failure.
int logline(char *str, char *ournick, char *basedir, int type) {
  // Filename to write to, gets built as we go
  char filename[MAXCHAR];

  // Log line to ultimately write, gets built as we go
  char line[MAXCHAR];

  // Variables for LOG_JOINPART (can't define directly inside switch case)
  int pos;

  // Build array of each space-separated token
  char tokens[MAXTOKENS][MAXDATASIZE];
  char *token;

  // Whether or not this is a "/me" PRIVMSG so we can log it slightly differently later
  int meprivmsg = 0;

  // Split out the first three space-separated parts of the string, leaving the rest.
  // If LOG_PRIVMSG:
  // This gets us the prefix (containing the "from" nick), the PRIVMSG command (not needed),
  // and the "to" nick or channel.  Plus the rest of the string intact (which is the actual
  // message).
  // If LOG_JOINPART:
  // This gets us the prefix (containing the joined/parted nick), the JOIN/PART command (not needed),
  // and the channel name.
  // If LOG_TOPIC:
  // This gets us the prefix (containing the topic setting nick), the TOPIC command (not needed),
  // the channel whose topic was set, and the rest of the string intact (which is the new topic).
  for (int i = 0; i < 3; i++) {
    // Try to split
    if ((token = strsep(&str, " ")) == NULL) {
      debugprint(DEBUG_CRIT, "Error splitting string for logging, returning!\n");
      return 0;
    }
    // Copy into the token array (strlen + 1 to get the NULL terminator)
    strncpy(tokens[i], token, strlen(token) + 1);
    debugprint(DEBUG_FULL, "logline(): extracted '%s'.\n", tokens[i]);
  }

  // Make "filename safe" copies of from and to names to ensure filename ends up being safe
  char from[MAXCHAR], to[MAXCHAR];
  strcpy(from, tokens[0]);
  strcpy(to, tokens[2]);
  // Remove unsafe characters (assuming POSIX, just strip "/" and replace with "_")
  replacechar(from, '/', '_');
  replacechar(to, '/', '_');
  // Ensure filename wouldn't be too long (+ 4 for ".log")
  if (strlen(from) + 4 > NAME_MAX || strlen(to) + 4 > NAME_MAX) {
    debugprint(DEBUG_CRIT, "Filename would be too long if logging either '%s' or '%s', returning!\n", from, to);
    return 0;
  }

  switch(type) {
    case LOG_PRIVMSG:
      // Extract the username from the prefix
      extractnickfromprefix(tokens[0]);
      extractnickfromprefix(from);

      // Remove the leading ":" from the real message
      stripprefix(str);

      // Build the log filename
      // If the message was sent to us, then log it in the sender's log file
      if (strncmp(tokens[2], ournick, strlen(tokens[0])) == 0) {
        if (!snprintf(filename, MAXCHAR, "%s/logs/%s.log", basedir, from)) {
          debugprint(DEBUG_CRIT, "Error while log filename for from name, returning!\n");
          return 0;
        }
      } else {
        // Otherwise log it in the "to" log file
        if (!snprintf(filename, MAXCHAR, "%s/logs/%s.log", basedir, to)) {
          debugprint(DEBUG_CRIT, "Error while log filename for to name, returning!\n");
          return 0;
        }
      }

      // If it was a "/me" line then strip the "\1ACTION " and the trailing "\1", plus set a flag for later
      if (strstr(str, "\1ACTION ") == str) {
        debugprint(DEBUG_FULL, "logline(): /me PRIVMSG detected, stripping ACTION things.\n");
        // Skip over the first 8 characters (\1ACTION )
        str += 8;
        // And remove the trailing \1
        if (str[strlen(str) - 1] == '\1') {
          str[strlen(str) - 1] = '\0';
        }
        meprivmsg = 1;
      }

      debugprint(DEBUG_FULL, "logline(): Logging PRIVMSG from '%s' to '%s' message '%s' in filename '%s'.\n", tokens[0], tokens[2], str, filename);

      break;

    case LOG_JOINPART:
      // Find the start of the channel name

      // If it's a JOIN
      if (tokens[2][0] == ':') {
        pos = 1;
      } else if (tokens[2][0] == '#') {
        // Perhaps it's a PART
        pos = 0;
      } else {
        // If not found, return 0
        return 0;
      }

      snprintf(filename, MAXCHAR, "%s/logs/%s.log", basedir, to + pos);

      debugprint(DEBUG_FULL, "logline(): Logging JOIN/PART to/from '%s' in filename '%s'.\n", tokens[2] + pos, filename);

      // Build a friendly message (e.g. ":nick!user@host JOIN #channel" -> "nick (user@host) has joined #channel")

      // Find the bang in the prefix
      char *ret;
      int posbang;
      if ((ret = strstr(tokens[0], "!")) != NULL) {
        // Position within str of "!"
        posbang = ret - tokens[0];
      } else {
        // No idea what happened, let's abandon ship
        return 0;
      }

      // Make it a null character
      tokens[0][posbang] = '\0';

      // Swap JOINed or PARTed for a friendly word
      if (strncmp(tokens[1], "JOIN", strlen("JOIN")) == 0) {
        snprintf(tokens[1], strlen("joined") + 1, "joined");
      } else if (strncmp(tokens[1], "PART", strlen("PART")) == 0) {
        snprintf(tokens[1], strlen("left") + 1, "left");
      }

      // Copy the nick, then user@host, then whether it was a join or part, then the channel name the string to send
      snprintf(line, MAXCHAR, "%s (%s) has %s %s", tokens[0] + 1, tokens[0] + posbang + 1, tokens[1], tokens[2] + pos);

      break;

    case LOG_TOPIC:
      // Extract the username from the prefix
      extractnickfromprefix(tokens[0]);

      // Remove the leading ":" from the topic
      stripprefix(str);

      if (!snprintf(filename, MAXCHAR, "%s/logs/%s.log", basedir, to)) {
        debugprint(DEBUG_CRIT, "Error while log filename for topic, returning!\n");
        return 0;
      }

      debugprint(DEBUG_FULL, "logline(): Logging TOPIC for '%s' in filename '%s'.\n", tokens[2], filename);

      // Build a friendly message (e.g. ":nick!user@host TOPIC #channel :blah blah" -> "nick has changed the topic to: blah blah")
      snprintf(line, MAXCHAR, "%s has changed the topic to: %s", tokens[0], str);

      break;

    default :
      printf("Unknown log type '%d', returning 0.\n", type);
      return 0;
  }

  // Make sure the log directory exists
  char logdir[PATH_MAX];
  snprintf(logdir, PATH_MAX, "%s/logs/", basedir);
  struct stat st = {0};
  if (stat(logdir, &st) == -1) {
    if (mkdir(logdir, 0700)) {
      debugprint(DEBUG_CRIT, "Error creating log directory '%s.\n", logdir);
      printf("Error creating log directory '%s'.\n", logdir);
      return 0;
    } else {
      debugprint(DEBUG_FULL, "logline(): log directory '%s'.\n", logdir);
    }
  }

  FILE *fp;

  int bytes = 0;

  fp = fopen(filename, "a");

  if (fp == NULL) {
    debugprint(DEBUG_CRIT, "error: could not open log file '%s' for writing.\n", filename);
    printf("error: could not open log file '%s' for writing.\n", filename);
    fclose(fp);
    return 0;
  }

  // Get a current time string to prepend - TODO - Make this customisable.
  time_t rawtime;
  struct tm * timeinfo;
  time(&rawtime);
  timeinfo = localtime(&rawtime);
  // Strip the trailing newline
  char timestr[MAXCHAR];
  snprintf(timestr, MAXCHAR, "%s", asctime(timeinfo));
  timestr[strlen(timestr) - 1] = '\0';

  if (type == LOG_PRIVMSG) {
    // Prepend the time string and "from" nick, different formatting depending on
    // whether or not it was a "/me" message
    if (meprivmsg) {
      if (!snprintf(line, MAXCHAR, "%s * %s %s", timestr, tokens[0], str)) {
        fprintf(stderr, "Error while preparing /me log string to write!\n");
        debugprint(DEBUG_CRIT, "Error while preparing /me log string to write!\n");
        fclose(fp);
        return 0;
      }
    } else {
      if (!snprintf(line, MAXCHAR, "%s <%s> %s", timestr, tokens[0], str)) {
        fprintf(stderr, "Error while preparing log string to write!\n");
        debugprint(DEBUG_CRIT, "Error while preparing log string to write!\n");
        fclose(fp);
        return 0;
      }
    }
  } else if (type == LOG_JOINPART || type == LOG_TOPIC) {
    // Prepend the time string
    char line2[MAXCHAR];
    if (!snprintf(line2, MAXCHAR, "%s %s", timestr, line)) {
      fprintf(stderr, "Error while preparing log string to write!\n");
      debugprint(DEBUG_CRIT, "Error while preparing log string to write!\n");
      fclose(fp);
      return 0;
    }
    // Copy back to line to write
    snprintf(line, MAXCHAR, "%s", line2);
  }

  // Ensure the line finishes with CRLF
  appendcrlf(line);

  debugprint(DEBUG_FULL, "logline(): Complete log string to write: '%s', length '%ld'.\n", line, strlen(line));

  // Write complete line to file
  if ((bytes = fprintf(fp, "%s", line)) < 0) {
    printf("error: could not write to log file.\n");
    debugprint(DEBUG_CRIT, "error: could not write to log file.\n");
    fclose(fp);
    return 0;
  }

  fclose(fp);
  return bytes;
}