]>
Commit | Line | Data |
---|---|---|
1087485c JT |
1 | /* |
2 | * ircd-ratbox: an advanced Internet Relay Chat Daemon(ircd). | |
3 | * cache.c - code for caching files | |
4 | * | |
5 | * Copyright (C) 2003 Lee Hardy <lee@leeh.co.uk> | |
6 | * Copyright (C) 2003-2005 ircd-ratbox development team | |
7 | * | |
8 | * Redistribution and use in source and binary forms, with or without | |
9 | * modification, are permitted provided that the following conditions are | |
10 | * met: | |
11 | * | |
12 | * 1.Redistributions of source code must retain the above copyright notice, | |
13 | * this list of conditions and the following disclaimer. | |
14 | * 2.Redistributions in binary form must reproduce the above copyright | |
15 | * notice, this list of conditions and the following disclaimer in the | |
16 | * documentation and/or other materials provided with the distribution. | |
17 | * 3.The name of the author may not be used to endorse or promote products | |
18 | * derived from this software without specific prior written permission. | |
19 | * | |
20 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
21 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
22 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
23 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, | |
24 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
25 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
26 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
28 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
29 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
30 | * POSSIBILITY OF SUCH DAMAGE. | |
31 | * | |
32 | * $Id: cache.c 25119 2008-03-13 16:57:05Z androsyn $ | |
33 | */ | |
34 | ||
91e2f81c VY |
35 | #include "stdinc.h" |
36 | #include "ircd_defs.h" | |
37 | #include "common.h" | |
38 | #include "s_conf.h" | |
39 | #include "client.h" | |
40 | #include "hash.h" | |
41 | #include "cache.h" | |
91e2f81c | 42 | #include "irc_dictionary.h" |
1087485c JT |
43 | #include "numeric.h" |
44 | ||
45 | struct cachefile *user_motd = NULL; | |
46 | struct cachefile *oper_motd = NULL; | |
47 | struct cacheline *emptyline = NULL; | |
48 | rb_dlink_list links_cache_list; | |
49 | char user_motd_changed[MAX_DATE_STRING]; | |
50 | ||
85550587 | 51 | struct Dictionary *help_dict_oper = NULL; |
1087485c JT |
52 | struct Dictionary *help_dict_user = NULL; |
53 | ||
54 | /* init_cache() | |
55 | * | |
56 | * inputs - | |
57 | * outputs - | |
58 | * side effects - inits the file/line cache blockheaps, loads motds | |
59 | */ | |
60 | void | |
61 | init_cache(void) | |
62 | { | |
63 | /* allocate the emptyline */ | |
64 | emptyline = rb_malloc(sizeof(struct cacheline)); | |
3dae60ef AC |
65 | emptyline->data = rb_strdup(" "); |
66 | ||
1087485c JT |
67 | user_motd_changed[0] = '\0'; |
68 | ||
69 | user_motd = cache_file(MPATH, "ircd.motd", 0); | |
70 | oper_motd = cache_file(OPATH, "opers.motd", 0); | |
71 | memset(&links_cache_list, 0, sizeof(links_cache_list)); | |
72 | ||
85550587 | 73 | help_dict_oper = irc_dictionary_create(strcasecmp); |
1087485c JT |
74 | help_dict_user = irc_dictionary_create(strcasecmp); |
75 | } | |
76 | ||
22b98b1e VY |
77 | /* |
78 | * removes tabs from src, replaces with 8 spaces, and returns the length | |
79 | * of the new string. if the new string would be greater than destlen, | |
80 | * it is truncated to destlen - 1 | |
81 | */ | |
82 | static size_t | |
83 | untabify(char *dest, const char *src, size_t destlen) | |
84 | { | |
85 | size_t x = 0, i; | |
86 | const char *s = src; | |
87 | char *d = dest; | |
88 | ||
89 | while(*s != '\0' && x < destlen - 1) | |
90 | { | |
91 | if(*s == '\t') | |
92 | { | |
93 | for(i = 0; i < 8 && x < destlen - 1; i++, x++, d++) | |
94 | *d = ' '; | |
95 | s++; | |
96 | } else | |
97 | { | |
98 | *d++ = *s++; | |
99 | x++; | |
100 | } | |
101 | } | |
102 | *d = '\0'; | |
103 | return x; | |
104 | } | |
105 | ||
1087485c JT |
106 | /* cache_file() |
107 | * | |
108 | * inputs - file to cache, files "shortname", flags to set | |
109 | * outputs - pointer to file cached, else NULL | |
110 | * side effects - | |
111 | */ | |
112 | struct cachefile * | |
113 | cache_file(const char *filename, const char *shortname, int flags) | |
114 | { | |
115 | FILE *in; | |
116 | struct cachefile *cacheptr; | |
117 | struct cacheline *lineptr; | |
118 | char line[BUFSIZE]; | |
119 | char *p; | |
120 | ||
121 | if((in = fopen(filename, "r")) == NULL) | |
122 | return NULL; | |
123 | ||
124 | ||
125 | cacheptr = rb_malloc(sizeof(struct cachefile)); | |
126 | ||
127 | rb_strlcpy(cacheptr->name, shortname, sizeof(cacheptr->name)); | |
128 | cacheptr->flags = flags; | |
129 | ||
130 | /* cache the file... */ | |
131 | while(fgets(line, sizeof(line), in) != NULL) | |
132 | { | |
133 | if((p = strpbrk(line, "\r\n")) != NULL) | |
134 | *p = '\0'; | |
135 | ||
136 | if(!EmptyString(line)) | |
137 | { | |
3dae60ef AC |
138 | char untabline[BUFSIZE]; |
139 | ||
1087485c | 140 | lineptr = rb_malloc(sizeof(struct cacheline)); |
3dae60ef AC |
141 | |
142 | untabify(untabline, line, sizeof(untabline)); | |
143 | lineptr->data = rb_strdup(untabline); | |
144 | ||
1087485c JT |
145 | rb_dlinkAddTail(lineptr, &lineptr->linenode, &cacheptr->contents); |
146 | } | |
147 | else | |
148 | rb_dlinkAddTailAlloc(emptyline, &cacheptr->contents); | |
149 | } | |
150 | ||
d06f3da9 SB |
151 | if (0 == rb_dlink_list_length(&cacheptr->contents)) |
152 | { | |
153 | /* No contents. Don't cache it after all. */ | |
154 | rb_free(cacheptr); | |
155 | cacheptr = NULL; | |
156 | } | |
157 | ||
1087485c JT |
158 | fclose(in); |
159 | return cacheptr; | |
160 | } | |
161 | ||
162 | void | |
163 | cache_links(void *unused) | |
164 | { | |
165 | struct Client *target_p; | |
166 | rb_dlink_node *ptr; | |
167 | rb_dlink_node *next_ptr; | |
168 | char *links_line; | |
169 | ||
170 | RB_DLINK_FOREACH_SAFE(ptr, next_ptr, links_cache_list.head) | |
171 | { | |
172 | rb_free(ptr->data); | |
173 | rb_free_rb_dlink_node(ptr); | |
174 | } | |
175 | ||
176 | links_cache_list.head = links_cache_list.tail = NULL; | |
177 | links_cache_list.length = 0; | |
178 | ||
179 | RB_DLINK_FOREACH(ptr, global_serv_list.head) | |
180 | { | |
181 | target_p = ptr->data; | |
182 | ||
183 | /* skip ourselves (done in /links) and hidden servers */ | |
184 | if(IsMe(target_p) || | |
185 | (IsHidden(target_p) && !ConfigServerHide.disable_hidden)) | |
186 | continue; | |
187 | ||
188 | /* if the below is ever modified, change LINKSLINELEN */ | |
189 | links_line = rb_malloc(LINKSLINELEN); | |
190 | rb_snprintf(links_line, LINKSLINELEN, "%s %s :1 %s", | |
191 | target_p->name, me.name, | |
192 | target_p->info[0] ? target_p->info : | |
193 | "(Unknown Location)"); | |
194 | ||
195 | rb_dlinkAddTailAlloc(links_line, &links_cache_list); | |
196 | } | |
197 | } | |
198 | ||
199 | /* free_cachefile() | |
200 | * | |
201 | * inputs - cachefile to free | |
202 | * outputs - | |
203 | * side effects - cachefile and its data is free'd | |
204 | */ | |
205 | void | |
206 | free_cachefile(struct cachefile *cacheptr) | |
207 | { | |
208 | rb_dlink_node *ptr; | |
209 | rb_dlink_node *next_ptr; | |
210 | ||
211 | if(cacheptr == NULL) | |
212 | return; | |
213 | ||
214 | RB_DLINK_FOREACH_SAFE(ptr, next_ptr, cacheptr->contents.head) | |
215 | { | |
216 | if(ptr->data != emptyline) | |
3dae60ef AC |
217 | { |
218 | struct cacheline *line = ptr->data; | |
219 | rb_free(line->data); | |
220 | rb_free(line); | |
221 | } | |
1087485c JT |
222 | } |
223 | ||
224 | rb_free(cacheptr); | |
225 | } | |
226 | ||
212380e3 AC |
227 | /* load_help() |
228 | * | |
229 | * inputs - | |
230 | * outputs - | |
e8149a2c JT |
231 | * side effects - old help cache deleted |
232 | * - contents of help directories are loaded. | |
212380e3 AC |
233 | */ |
234 | void | |
235 | load_help(void) | |
236 | { | |
237 | DIR *helpfile_dir = NULL; | |
238 | struct dirent *ldirent= NULL; | |
d74fa5b5 | 239 | char filename[PATH_MAX]; |
212380e3 | 240 | struct cachefile *cacheptr; |
e8149a2c | 241 | struct DictionaryIter iter; |
212380e3 | 242 | |
4231cedc VY |
243 | #if defined(S_ISLNK) && defined(HAVE_LSTAT) |
244 | struct stat sb; | |
245 | #endif | |
246 | ||
85550587 | 247 | DICTIONARY_FOREACH(cacheptr, &iter, help_dict_oper) |
e8149a2c | 248 | { |
85550587 JT |
249 | irc_dictionary_delete(help_dict_oper, cacheptr->name); |
250 | free_cachefile(cacheptr); | |
251 | } | |
252 | DICTIONARY_FOREACH(cacheptr, &iter, help_dict_user) | |
253 | { | |
254 | irc_dictionary_delete(help_dict_user, cacheptr->name); | |
e8149a2c JT |
255 | free_cachefile(cacheptr); |
256 | } | |
257 | ||
212380e3 AC |
258 | helpfile_dir = opendir(HPATH); |
259 | ||
260 | if(helpfile_dir == NULL) | |
261 | return; | |
262 | ||
263 | while((ldirent = readdir(helpfile_dir)) != NULL) | |
264 | { | |
cd5d9abf JT |
265 | if(ldirent->d_name[0] == '.') |
266 | continue; | |
b2f0da88 | 267 | rb_snprintf(filename, sizeof(filename), "%s/%s", HPATH, ldirent->d_name); |
212380e3 | 268 | cacheptr = cache_file(filename, ldirent->d_name, HELP_OPER); |
85550587 | 269 | irc_dictionary_add(help_dict_oper, cacheptr->name, cacheptr); |
212380e3 AC |
270 | } |
271 | ||
272 | closedir(helpfile_dir); | |
273 | helpfile_dir = opendir(UHPATH); | |
274 | ||
275 | if(helpfile_dir == NULL) | |
276 | return; | |
277 | ||
278 | while((ldirent = readdir(helpfile_dir)) != NULL) | |
279 | { | |
cd5d9abf JT |
280 | if(ldirent->d_name[0] == '.') |
281 | continue; | |
b2f0da88 | 282 | rb_snprintf(filename, sizeof(filename), "%s/%s", UHPATH, ldirent->d_name); |
212380e3 | 283 | |
4231cedc VY |
284 | #if defined(S_ISLNK) && defined(HAVE_LSTAT) |
285 | if(lstat(filename, &sb) < 0) | |
286 | continue; | |
287 | ||
288 | /* ok, if its a symlink, we work on the presumption if an | |
289 | * oper help exists of that name, its a symlink to that --fl | |
290 | */ | |
291 | if(S_ISLNK(sb.st_mode)) | |
292 | { | |
293 | cacheptr = irc_dictionary_retrieve(help_dict_oper, ldirent->d_name); | |
294 | ||
295 | if(cacheptr != NULL) | |
296 | { | |
297 | cacheptr->flags |= HELP_USER; | |
298 | continue; | |
299 | } | |
300 | } | |
301 | #endif | |
302 | ||
212380e3 | 303 | cacheptr = cache_file(filename, ldirent->d_name, HELP_USER); |
85550587 | 304 | irc_dictionary_add(help_dict_user, cacheptr->name, cacheptr); |
212380e3 AC |
305 | } |
306 | ||
307 | closedir(helpfile_dir); | |
1087485c JT |
308 | } |
309 | ||
310 | /* send_user_motd() | |
311 | * | |
312 | * inputs - client to send motd to | |
313 | * outputs - client is sent motd if exists, else ERR_NOMOTD | |
314 | * side effects - | |
315 | */ | |
316 | void | |
317 | send_user_motd(struct Client *source_p) | |
318 | { | |
319 | struct cacheline *lineptr; | |
320 | rb_dlink_node *ptr; | |
321 | const char *myname = get_id(&me, source_p); | |
322 | const char *nick = get_id(source_p, source_p); | |
323 | if(user_motd == NULL || rb_dlink_list_length(&user_motd->contents) == 0) | |
324 | { | |
325 | sendto_one(source_p, form_str(ERR_NOMOTD), myname, nick); | |
326 | return; | |
327 | } | |
328 | ||
329 | sendto_one(source_p, form_str(RPL_MOTDSTART), myname, nick, me.name); | |
330 | ||
331 | RB_DLINK_FOREACH(ptr, user_motd->contents.head) | |
332 | { | |
333 | lineptr = ptr->data; | |
334 | sendto_one(source_p, form_str(RPL_MOTD), myname, nick, lineptr->data); | |
335 | } | |
336 | ||
337 | sendto_one(source_p, form_str(RPL_ENDOFMOTD), myname, nick); | |
338 | } | |
339 | ||
340 | void | |
341 | cache_user_motd(void) | |
342 | { | |
343 | struct stat sb; | |
344 | struct tm *local_tm; | |
345 | ||
346 | if(stat(MPATH, &sb) == 0) | |
347 | { | |
348 | local_tm = localtime(&sb.st_mtime); | |
349 | ||
350 | if(local_tm != NULL) | |
351 | { | |
352 | rb_snprintf(user_motd_changed, sizeof(user_motd_changed), | |
353 | "%d/%d/%d %d:%d", | |
354 | local_tm->tm_mday, local_tm->tm_mon + 1, | |
355 | 1900 + local_tm->tm_year, local_tm->tm_hour, | |
356 | local_tm->tm_min); | |
357 | } | |
358 | } | |
359 | free_cachefile(user_motd); | |
360 | user_motd = cache_file(MPATH, "ircd.motd", 0); | |
361 | } | |
fe18f4bc JT |
362 | |
363 | ||
364 | /* send_oper_motd() | |
365 | * | |
366 | * inputs - client to send motd to | |
367 | * outputs - client is sent oper motd if exists | |
368 | * side effects - | |
369 | */ | |
370 | void | |
371 | send_oper_motd(struct Client *source_p) | |
372 | { | |
373 | struct cacheline *lineptr; | |
374 | rb_dlink_node *ptr; | |
375 | ||
376 | if(oper_motd == NULL || rb_dlink_list_length(&oper_motd->contents) == 0) | |
377 | return; | |
378 | ||
379 | sendto_one(source_p, form_str(RPL_OMOTDSTART), | |
380 | me.name, source_p->name); | |
381 | ||
382 | RB_DLINK_FOREACH(ptr, oper_motd->contents.head) | |
383 | { | |
384 | lineptr = ptr->data; | |
385 | sendto_one(source_p, form_str(RPL_OMOTD), | |
386 | me.name, source_p->name, lineptr->data); | |
387 | } | |
388 | ||
389 | sendto_one(source_p, form_str(RPL_ENDOFOMOTD), | |
390 | me.name, source_p->name); | |
391 | } |