Mercurial > hg
annotate mcabber/src/histolog.c @ 1149:13d125a2020f
Update contributors
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 10 Feb 2007 18:47:01 +0100 |
parents | b8f5fe2d666a |
children | 3b9bbf6c4c93 |
rev | line source |
---|---|
110 | 1 /* |
699 | 2 * histolog.c -- File history handling |
395
3e4f2f98c0bf
Whitespace cleanup (histolog.c)
Mikael Berthe <mikael@lilotux.net>
parents:
394
diff
changeset
|
3 * |
699 | 4 * Copyright (C) 2005, 2006 Mikael Berthe <bmikael@lists.lilotux.net> |
110 | 5 * |
6 * This program is free software; you can redistribute it and/or modify | |
7 * it under the terms of the GNU General Public License as published by | |
8 * the Free Software Foundation; either version 2 of the License, or (at | |
9 * your option) any later version. | |
10 * | |
11 * This program is distributed in the hope that it will be useful, but | |
12 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 * General Public License for more details. | |
15 * | |
16 * You should have received a copy of the GNU General Public License | |
17 * along with this program; if not, write to the Free Software | |
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | |
19 * USA | |
20 */ | |
21 | |
22 #include <string.h> | |
23 #include <stdlib.h> | |
24 #include <time.h> | |
113 | 25 #include <ctype.h> |
26 #include <sys/types.h> | |
27 #include <sys/stat.h> | |
28 #include <fcntl.h> | |
110 | 29 |
30 #include "histolog.h" | |
178 | 31 #include "hbuf.h" |
113 | 32 #include "jabglue.h" |
241 | 33 #include "utils.h" |
378
2e6c7b1440d1
Improve debugging/logging
Mikael Berthe <mikael@lilotux.net>
parents:
374
diff
changeset
|
34 #include "logprint.h" |
635
d4119cb85aeb
New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents:
580
diff
changeset
|
35 #include "settings.h" |
727
1c3620668857
Expand tabs when reading history files
Mikael Berthe <mikael@lilotux.net>
parents:
699
diff
changeset
|
36 #include "utils.h" |
110 | 37 |
38 static guint UseFileLogging; | |
177 | 39 static guint FileLoadLogs; |
110 | 40 static char *RootDir; |
41 | |
42 | |
1058 | 43 // user_histo_file(jid) |
110 | 44 // Returns history filename for the given jid |
45 // Note: the caller *must* free the filename after use (if not null). | |
1058 | 46 static char *user_histo_file(const char *bjid) |
110 | 47 { |
48 char *filename; | |
1106 | 49 char *lowerid; |
50 | |
51 if (!(UseFileLogging || FileLoadLogs)) | |
52 return NULL; | |
110 | 53 |
1058 | 54 lowerid = g_strdup(bjid); |
1106 | 55 if (!lowerid) |
56 return NULL; | |
57 mc_strtolower(lowerid); | |
186 | 58 |
1106 | 59 filename = g_strdup_printf("%s%s", RootDir, lowerid); |
186 | 60 g_free(lowerid); |
110 | 61 return filename; |
62 } | |
63 | |
178 | 64 // write_histo_line() |
110 | 65 // Adds a history (multi-)line to the jid's history logfile |
1058 | 66 static void write_histo_line(const char *bjid, |
113 | 67 time_t timestamp, guchar type, guchar info, const char *data) |
110 | 68 { |
69 guint len = 0; | |
113 | 70 FILE *fp; |
110 | 71 time_t ts; |
113 | 72 const char *p; |
178 | 73 char *filename; |
241 | 74 char str_ts[20]; |
273 | 75 int err; |
110 | 76 |
1106 | 77 if (!UseFileLogging) |
78 return; | |
178 | 79 |
1144
b8f5fe2d666a
Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents:
1141
diff
changeset
|
80 // Do not log status messages when 'logging_ignore_status' is set |
b8f5fe2d666a
Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents:
1141
diff
changeset
|
81 if (type == 'S' && settings_opt_get_int("logging_ignore_status")) |
b8f5fe2d666a
Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents:
1141
diff
changeset
|
82 return; |
b8f5fe2d666a
Add option "logging_ignore_status"
Mikael Berthe <mikael@lilotux.net>
parents:
1141
diff
changeset
|
83 |
1058 | 84 filename = user_histo_file(bjid); |
110 | 85 |
86 // If timestamp is null, get current date | |
87 if (timestamp) | |
88 ts = timestamp; | |
89 else | |
90 time(&ts); | |
91 | |
92 if (!data) | |
93 data = ""; | |
94 | |
95 // Count number of extra lines | |
96 for (p=data ; *p ; p++) | |
97 if (*p == '\n') len++; | |
98 | |
241 | 99 /* Line format: "TI yyyymmddThh:mm:ssZ [data]" |
100 * (Old format: "TI DDDDDDDDDD LLL [data])" | |
101 * T=Type, I=Info, yyyymmddThh:mm:ssZ=date, LLL=0-padded-len | |
110 | 102 * |
103 * Types: | |
104 * - M message Info: S (send) R (receive) | |
352 | 105 * - S status Info: [_oifdna] |
110 | 106 * We don't check them, we'll trust the caller. |
107 */ | |
108 | |
113 | 109 fp = fopen(filename, "a"); |
155 | 110 g_free(filename); |
273 | 111 if (!fp) { |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
112 scr_LogPrint(LPRINT_LOGNORM, "Unable to write history " |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
113 "(cannot open logfile)"); |
273 | 114 return; |
115 } | |
178 | 116 |
241 | 117 to_iso8601(str_ts, ts); |
273 | 118 err = fprintf(fp, "%c%c %-18.18s %03d %s\n", type, info, str_ts, len, data); |
113 | 119 fclose(fp); |
273 | 120 if (err < 0) { |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
121 scr_LogPrint(LPRINT_LOGNORM, "Error while writing to log file: %s", |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
122 strerror(errno)); |
273 | 123 } |
110 | 124 } |
125 | |
178 | 126 // hlog_read_history() |
127 // Reads the jid's history logfile | |
1058 | 128 void hlog_read_history(const char *bjid, GList **p_buddyhbuf, guint width) |
178 | 129 { |
130 char *filename; | |
131 guchar type, info; | |
132 char *data, *tail; | |
727
1c3620668857
Expand tabs when reading history files
Mikael Berthe <mikael@lilotux.net>
parents:
699
diff
changeset
|
133 char *xtext; |
184 | 134 time_t timestamp; |
135 guint prefix_flags; | |
178 | 136 guint len; |
137 FILE *fp; | |
197 | 138 struct stat bufstat; |
193 | 139 guint err = 0; |
248 | 140 guint ln = 0; // line number |
899
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
141 time_t starttime; |
1141
5be2408a6534
Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents:
1106
diff
changeset
|
142 int max_num_of_blocks; |
178 | 143 |
1106 | 144 if (!FileLoadLogs) |
145 return; | |
178 | 146 |
1058 | 147 if ((roster_gettype(bjid) & ROSTER_TYPE_ROOM) && |
635
d4119cb85aeb
New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents:
580
diff
changeset
|
148 (settings_opt_get_int("load_muc_logs") != 1)) |
d4119cb85aeb
New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents:
580
diff
changeset
|
149 return; |
d4119cb85aeb
New "load_muc_logs" option
Mikael Berthe <mikael@lilotux.net>
parents:
580
diff
changeset
|
150 |
178 | 151 data = g_new(char, HBB_BLOCKSIZE+32); |
152 if (!data) { | |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
153 scr_LogPrint(LPRINT_LOGNORM, "Not enough memory to read history file"); |
178 | 154 return; |
155 } | |
156 | |
1058 | 157 filename = user_histo_file(bjid); |
178 | 158 |
159 fp = fopen(filename, "r"); | |
160 g_free(filename); | |
1106 | 161 if (!fp) { |
162 g_free(data); | |
163 return; | |
164 } | |
178 | 165 |
394
4617d0f029ea
Update "large file" size value to 3MB
Mikael Berthe <mikael@lilotux.net>
parents:
378
diff
changeset
|
166 // If file is large (> 3MB here), display a message to inform the user |
197 | 167 // (it can take a while...) |
168 if (!fstat(fileno(fp), &bufstat)) { | |
394
4617d0f029ea
Update "large file" size value to 3MB
Mikael Berthe <mikael@lilotux.net>
parents:
378
diff
changeset
|
169 if (bufstat.st_size > 3145728) |
1058 | 170 scr_LogPrint(LPRINT_LOGNORM, "Reading <%s> history file...", bjid); |
197 | 171 } |
172 | |
1141
5be2408a6534
Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents:
1106
diff
changeset
|
173 max_num_of_blocks = get_max_history_blocks(); |
5be2408a6534
Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents:
1106
diff
changeset
|
174 |
1106 | 175 starttime = 0L; |
899
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
176 if (settings_opt_get_int("max_history_age") > 0) { |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
177 int maxdays = settings_opt_get_int("max_history_age"); |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
178 time(&starttime); |
1106 | 179 if (maxdays >= starttime/86400L) |
180 starttime = 0L; | |
899
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
181 else |
1106 | 182 starttime -= maxdays * 86400L; |
899
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
183 } |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
184 |
178 | 185 /* See write_histo_line() for line format... */ |
186 while (!feof(fp)) { | |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
187 guint dataoffset = 25; |
1106 | 188 |
189 if (fgets(data, HBB_BLOCKSIZE+27, fp) == NULL) | |
190 break; | |
248 | 191 ln++; |
178 | 192 |
193 for (tail = data; *tail; tail++) ; | |
194 | |
195 type = data[0]; | |
196 info = data[1]; | |
241 | 197 |
395
3e4f2f98c0bf
Whitespace cleanup (histolog.c)
Mikael Berthe <mikael@lilotux.net>
parents:
394
diff
changeset
|
198 if ((type != 'M' && type != 'S') || |
259 | 199 ((data[11] != 'T') || (data[20] != 'Z') || |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
200 (data[21] != ' ') || |
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
201 (data[25] != ' ' && data[26] != ' '))) { |
193 | 202 if (!err) { |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
203 scr_LogPrint(LPRINT_LOGNORM, |
1058 | 204 "Error in history file format (%s), l.%u", bjid, ln); |
193 | 205 err = 1; |
206 } | |
186 | 207 continue; |
178 | 208 } |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
209 // The number of lines can be written with 3 or 4 bytes. |
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
210 if (data[25] != ' ') dataoffset = 26; |
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
211 data[21] = data[dataoffset] = 0; |
259 | 212 timestamp = from_iso8601(&data[3], 1); |
213 len = (guint) atoi(&data[22]); | |
395
3e4f2f98c0bf
Whitespace cleanup (histolog.c)
Mikael Berthe <mikael@lilotux.net>
parents:
394
diff
changeset
|
214 |
178 | 215 // Some checks |
216 if (((type == 'M') && (info != 'S' && info != 'R')) || | |
277
4d7040cff8ee
Remove busy/occupied status, which does not really exist
Mikael Berthe <mikael@lilotux.net>
parents:
273
diff
changeset
|
217 ((type == 'I') && (!strchr("OAIFDN", info)))) { |
193 | 218 if (!err) { |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
219 scr_LogPrint(LPRINT_LOGNORM, "Error in history file format (%s), l.%u", |
1058 | 220 bjid, ln); |
193 | 221 err = 1; |
222 } | |
186 | 223 continue; |
178 | 224 } |
225 | |
197 | 226 // XXX This will fail when a message is too big |
178 | 227 while (len--) { |
248 | 228 ln++; |
259 | 229 if (fgets(tail, HBB_BLOCKSIZE+27 - (tail-data), fp) == NULL) |
249 | 230 break; |
178 | 231 |
232 while (*tail) tail++; | |
233 } | |
248 | 234 // Small check for too long messages |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
235 if (tail >= HBB_BLOCKSIZE+dataoffset+1 + data) { |
249 | 236 // Maybe we will have a parse error on next, because this |
237 // message is big (maybe too big). | |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
238 scr_LogPrint(LPRINT_LOGNORM, "A message could be too big " |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
239 "in history file..."); |
248 | 240 } |
251 | 241 // Remove last CR (we keep it if the line is empty, too) |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
242 if ((tail > data+dataoffset+1) && (*(tail-1) == '\n')) |
178 | 243 *(tail-1) = 0; |
244 | |
899
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
245 // Check if the data is older than max_history_age |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
246 if (starttime) { |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
247 if (timestamp > starttime) |
1106 | 248 starttime = 0L; // From now on, load everything |
899
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
249 else |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
250 continue; |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
251 } |
a833f3d6119a
Add option 'max_history_age'
Mikael Berthe <mikael@lilotux.net>
parents:
795
diff
changeset
|
252 |
178 | 253 if (type == 'M') { |
772
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
254 char *converted; |
178 | 255 if (info == 'S') |
729
39f67cade02c
Use bold font for outgoing messages
Mikael Berthe <mikael@lilotux.net>
parents:
727
diff
changeset
|
256 prefix_flags = HBB_PREFIX_OUT | HBB_PREFIX_HLIGHT; |
178 | 257 else |
184 | 258 prefix_flags = HBB_PREFIX_IN; |
795
b16acadd7d53
Improve support for long messages
Mikael Berthe <mikael@lilotux.net>
parents:
774
diff
changeset
|
259 converted = from_utf8(&data[dataoffset+1]); |
772
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
260 if (converted) { |
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
261 xtext = ut_expand_tabs(converted); // Expand tabs |
1141
5be2408a6534
Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents:
1106
diff
changeset
|
262 hbuf_add_line(p_buddyhbuf, xtext, timestamp, prefix_flags, width, |
5be2408a6534
Add option "max_history_blocks"
Mikael Berthe <mikael@lilotux.net>
parents:
1106
diff
changeset
|
263 max_num_of_blocks); |
772
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
264 if (xtext != converted) |
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
265 g_free(xtext); |
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
266 g_free(converted); |
464be13343a9
Store most data in UTF-8 internally
Mikael Berthe <mikael@lilotux.net>
parents:
729
diff
changeset
|
267 } |
193 | 268 err = 0; |
178 | 269 } |
270 } | |
271 fclose(fp); | |
272 g_free(data); | |
273 } | |
274 | |
110 | 275 // hlog_enable() |
276 // Enable logging to files. If root_dir is NULL, then $HOME/.mcabber is used. | |
177 | 277 // If loadfiles is TRUE, we will try to load buddies history logs from file. |
281
f562b9af2de7
Add "const" specifier in prototypes
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
278 void hlog_enable(guint enable, const char *root_dir, guint loadfiles) |
110 | 279 { |
280 UseFileLogging = enable; | |
177 | 281 FileLoadLogs = loadfiles; |
110 | 282 |
177 | 283 if (enable || loadfiles) { |
110 | 284 if (root_dir) { |
285 int l = strlen(root_dir); | |
286 if (l < 1) { | |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
287 scr_LogPrint(LPRINT_LOGNORM, "Error: logging dir name too short"); |
362
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
288 UseFileLogging = FileLoadLogs = FALSE; |
110 | 289 return; |
290 } | |
291 // RootDir must be slash-terminated | |
292 if (root_dir[l-1] == '/') | |
293 RootDir = g_strdup(root_dir); | |
1106 | 294 else |
295 RootDir = g_strdup_printf("%s/", root_dir); | |
110 | 296 } else { |
297 char *home = getenv("HOME"); | |
1106 | 298 const char *dir = "/.mcabber/histo/"; |
299 RootDir = g_strdup_printf("%s%s", home, dir); | |
110 | 300 } |
362
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
301 // Check directory permissions (should not be readable by group/others) |
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
302 if (checkset_perm(RootDir, TRUE) == -1) { |
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
303 // The directory does not actually exists |
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
304 g_free(RootDir); |
1106 | 305 RootDir = NULL; |
374
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
306 scr_LogPrint(LPRINT_LOGNORM, "ERROR: Cannot access " |
bd5638c21834
Improve logging system (traces)
Mikael Berthe <mikael@lilotux.net>
parents:
366
diff
changeset
|
307 "history log directory, logging DISABLED"); |
362
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
308 UseFileLogging = FileLoadLogs = FALSE; |
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
309 } |
d8f147d6e872
Check directory and config file permissions
Mikael Berthe <mikael@lilotux.net>
parents:
352
diff
changeset
|
310 } else { // Disable history logging |
774
46304b773a44
Remove useless checks before g_free() calls
Mikael Berthe <mikael@lilotux.net>
parents:
772
diff
changeset
|
311 g_free(RootDir); |
1106 | 312 RootDir = NULL; |
110 | 313 } |
314 } | |
315 | |
1058 | 316 inline void hlog_write_message(const char *bjid, time_t timestamp, int sent, |
113 | 317 const char *msg) |
318 { | |
1058 | 319 write_histo_line(bjid, timestamp, 'M', ((sent) ? 'S' : 'R'), msg); |
113 | 320 } |
321 | |
1058 | 322 inline void hlog_write_status(const char *bjid, time_t timestamp, |
221 | 323 enum imstatus status, const char *status_msg) |
113 | 324 { |
325 // #1 XXX Check status value? | |
326 // #2 We could add a user-readable comment | |
1058 | 327 write_histo_line(bjid, timestamp, 'S', toupper(imstatus2char[status]), |
221 | 328 status_msg); |
113 | 329 } |
330 | |
580 | 331 /* vim: set expandtab cindent cinoptions=>2\:2(0: For Vim users... */ |