2 * ircd-ratbox: an advanced Internet Relay Chat Daemon(ircd).
3 * cache.c - code for caching files
5 * Copyright (C) 2003 Lee Hardy <lee@leeh.co.uk>
6 * Copyright (C) 2003-2005 ircd-ratbox development team
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
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.
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.
32 * $Id: cache.c 25119 2008-03-13 16:57:05Z androsyn $
36 #include "ircd_defs.h"
42 #include "irc_dictionary.h"
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
];
51 struct Dictionary
*help_dict_oper
= NULL
;
52 struct Dictionary
*help_dict_user
= NULL
;
58 * side effects - inits the file/line cache blockheaps, loads motds
63 /* allocate the emptyline */
64 emptyline
= rb_malloc(sizeof(struct cacheline
));
65 emptyline
->data
[0] = ' ';
66 emptyline
->data
[1] = '\0';
67 user_motd_changed
[0] = '\0';
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
));
73 help_dict_oper
= irc_dictionary_create(strcasecmp
);
74 help_dict_user
= irc_dictionary_create(strcasecmp
);
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
83 untabify(char *dest
, const char *src
, size_t destlen
)
89 while(*s
!= '\0' && x
< destlen
- 1)
93 for(i
= 0; i
< 8 && x
< destlen
- 1; i
++, x
++, d
++)
108 * inputs - file to cache, files "shortname", flags to set
109 * outputs - pointer to file cached, else NULL
113 cache_file(const char *filename
, const char *shortname
, int flags
)
116 struct cachefile
*cacheptr
;
117 struct cacheline
*lineptr
;
121 if((in
= fopen(filename
, "r")) == NULL
)
125 cacheptr
= rb_malloc(sizeof(struct cachefile
));
127 rb_strlcpy(cacheptr
->name
, shortname
, sizeof(cacheptr
->name
));
128 cacheptr
->flags
= flags
;
130 /* cache the file... */
131 while(fgets(line
, sizeof(line
), in
) != NULL
)
133 if((p
= strpbrk(line
, "\r\n")) != NULL
)
136 if(!EmptyString(line
))
138 lineptr
= rb_malloc(sizeof(struct cacheline
));
139 untabify(lineptr
->data
, line
, sizeof(lineptr
->data
));
140 rb_dlinkAddTail(lineptr
, &lineptr
->linenode
, &cacheptr
->contents
);
143 rb_dlinkAddTailAlloc(emptyline
, &cacheptr
->contents
);
146 if (0 == rb_dlink_list_length(&cacheptr
->contents
))
148 /* No contents. Don't cache it after all. */
158 cache_links(void *unused
)
160 struct Client
*target_p
;
162 rb_dlink_node
*next_ptr
;
165 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, links_cache_list
.head
)
168 rb_free_rb_dlink_node(ptr
);
171 links_cache_list
.head
= links_cache_list
.tail
= NULL
;
172 links_cache_list
.length
= 0;
174 RB_DLINK_FOREACH(ptr
, global_serv_list
.head
)
176 target_p
= ptr
->data
;
178 /* skip ourselves (done in /links) and hidden servers */
180 (IsHidden(target_p
) && !ConfigServerHide
.disable_hidden
))
183 /* if the below is ever modified, change LINKSLINELEN */
184 links_line
= rb_malloc(LINKSLINELEN
);
185 rb_snprintf(links_line
, LINKSLINELEN
, "%s %s :1 %s",
186 target_p
->name
, me
.name
,
187 target_p
->info
[0] ? target_p
->info
:
188 "(Unknown Location)");
190 rb_dlinkAddTailAlloc(links_line
, &links_cache_list
);
196 * inputs - cachefile to free
198 * side effects - cachefile and its data is free'd
201 free_cachefile(struct cachefile
*cacheptr
)
204 rb_dlink_node
*next_ptr
;
209 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, cacheptr
->contents
.head
)
211 if(ptr
->data
!= emptyline
)
222 * side effects - old help cache deleted
223 * - contents of help directories are loaded.
228 DIR *helpfile_dir
= NULL
;
229 struct dirent
*ldirent
= NULL
;
230 char filename
[MAXPATHLEN
];
231 struct cachefile
*cacheptr
;
232 struct DictionaryIter iter
;
234 #if defined(S_ISLNK) && defined(HAVE_LSTAT)
238 DICTIONARY_FOREACH(cacheptr
, &iter
, help_dict_oper
)
240 irc_dictionary_delete(help_dict_oper
, cacheptr
->name
);
241 free_cachefile(cacheptr
);
243 DICTIONARY_FOREACH(cacheptr
, &iter
, help_dict_user
)
245 irc_dictionary_delete(help_dict_user
, cacheptr
->name
);
246 free_cachefile(cacheptr
);
249 helpfile_dir
= opendir(HPATH
);
251 if(helpfile_dir
== NULL
)
254 while((ldirent
= readdir(helpfile_dir
)) != NULL
)
256 if(ldirent
->d_name
[0] == '.')
258 rb_snprintf(filename
, sizeof(filename
), "%s/%s", HPATH
, ldirent
->d_name
);
259 cacheptr
= cache_file(filename
, ldirent
->d_name
, HELP_OPER
);
260 irc_dictionary_add(help_dict_oper
, cacheptr
->name
, cacheptr
);
263 closedir(helpfile_dir
);
264 helpfile_dir
= opendir(UHPATH
);
266 if(helpfile_dir
== NULL
)
269 while((ldirent
= readdir(helpfile_dir
)) != NULL
)
271 if(ldirent
->d_name
[0] == '.')
273 rb_snprintf(filename
, sizeof(filename
), "%s/%s", UHPATH
, ldirent
->d_name
);
275 #if defined(S_ISLNK) && defined(HAVE_LSTAT)
276 if(lstat(filename
, &sb
) < 0)
279 /* ok, if its a symlink, we work on the presumption if an
280 * oper help exists of that name, its a symlink to that --fl
282 if(S_ISLNK(sb
.st_mode
))
284 cacheptr
= irc_dictionary_retrieve(help_dict_oper
, ldirent
->d_name
);
288 cacheptr
->flags
|= HELP_USER
;
294 cacheptr
= cache_file(filename
, ldirent
->d_name
, HELP_USER
);
295 irc_dictionary_add(help_dict_user
, cacheptr
->name
, cacheptr
);
298 closedir(helpfile_dir
);
303 * inputs - client to send motd to
304 * outputs - client is sent motd if exists, else ERR_NOMOTD
308 send_user_motd(struct Client
*source_p
)
310 struct cacheline
*lineptr
;
312 const char *myname
= get_id(&me
, source_p
);
313 const char *nick
= get_id(source_p
, source_p
);
314 if(user_motd
== NULL
|| rb_dlink_list_length(&user_motd
->contents
) == 0)
316 sendto_one(source_p
, form_str(ERR_NOMOTD
), myname
, nick
);
320 sendto_one(source_p
, form_str(RPL_MOTDSTART
), myname
, nick
, me
.name
);
322 RB_DLINK_FOREACH(ptr
, user_motd
->contents
.head
)
325 sendto_one(source_p
, form_str(RPL_MOTD
), myname
, nick
, lineptr
->data
);
328 sendto_one(source_p
, form_str(RPL_ENDOFMOTD
), myname
, nick
);
332 cache_user_motd(void)
337 if(stat(MPATH
, &sb
) == 0)
339 local_tm
= localtime(&sb
.st_mtime
);
343 rb_snprintf(user_motd_changed
, sizeof(user_motd_changed
),
345 local_tm
->tm_mday
, local_tm
->tm_mon
+ 1,
346 1900 + local_tm
->tm_year
, local_tm
->tm_hour
,
350 free_cachefile(user_motd
);
351 user_motd
= cache_file(MPATH
, "ircd.motd", 0);
357 * inputs - client to send motd to
358 * outputs - client is sent oper motd if exists
362 send_oper_motd(struct Client
*source_p
)
364 struct cacheline
*lineptr
;
367 if(oper_motd
== NULL
|| rb_dlink_list_length(&oper_motd
->contents
) == 0)
370 sendto_one(source_p
, form_str(RPL_OMOTDSTART
),
371 me
.name
, source_p
->name
);
373 RB_DLINK_FOREACH(ptr
, oper_motd
->contents
.head
)
376 sendto_one(source_p
, form_str(RPL_OMOTD
),
377 me
.name
, source_p
->name
, lineptr
->data
);
380 sendto_one(source_p
, form_str(RPL_ENDOFOMOTD
),
381 me
.name
, source_p
->name
);