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
);
79 * inputs - file to cache, files "shortname", flags to set
80 * outputs - pointer to file cached, else NULL
84 cache_file(const char *filename
, const char *shortname
, int flags
)
87 struct cachefile
*cacheptr
;
88 struct cacheline
*lineptr
;
92 if((in
= fopen(filename
, "r")) == NULL
)
96 cacheptr
= rb_malloc(sizeof(struct cachefile
));
98 rb_strlcpy(cacheptr
->name
, shortname
, sizeof(cacheptr
->name
));
99 cacheptr
->flags
= flags
;
101 /* cache the file... */
102 while(fgets(line
, sizeof(line
), in
) != NULL
)
104 if((p
= strpbrk(line
, "\r\n")) != NULL
)
107 if(!EmptyString(line
))
109 lineptr
= rb_malloc(sizeof(struct cacheline
));
110 rb_strlcpy(lineptr
->data
, line
, sizeof(lineptr
->data
));
111 rb_dlinkAddTail(lineptr
, &lineptr
->linenode
, &cacheptr
->contents
);
114 rb_dlinkAddTailAlloc(emptyline
, &cacheptr
->contents
);
122 cache_links(void *unused
)
124 struct Client
*target_p
;
126 rb_dlink_node
*next_ptr
;
129 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, links_cache_list
.head
)
132 rb_free_rb_dlink_node(ptr
);
135 links_cache_list
.head
= links_cache_list
.tail
= NULL
;
136 links_cache_list
.length
= 0;
138 RB_DLINK_FOREACH(ptr
, global_serv_list
.head
)
140 target_p
= ptr
->data
;
142 /* skip ourselves (done in /links) and hidden servers */
144 (IsHidden(target_p
) && !ConfigServerHide
.disable_hidden
))
147 /* if the below is ever modified, change LINKSLINELEN */
148 links_line
= rb_malloc(LINKSLINELEN
);
149 rb_snprintf(links_line
, LINKSLINELEN
, "%s %s :1 %s",
150 target_p
->name
, me
.name
,
151 target_p
->info
[0] ? target_p
->info
:
152 "(Unknown Location)");
154 rb_dlinkAddTailAlloc(links_line
, &links_cache_list
);
160 * inputs - cachefile to free
162 * side effects - cachefile and its data is free'd
165 free_cachefile(struct cachefile
*cacheptr
)
168 rb_dlink_node
*next_ptr
;
173 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, cacheptr
->contents
.head
)
175 if(ptr
->data
!= emptyline
)
186 * side effects - old help cache deleted
187 * - contents of help directories are loaded.
192 DIR *helpfile_dir
= NULL
;
193 struct dirent
*ldirent
= NULL
;
194 char filename
[MAXPATHLEN
];
195 struct cachefile
*cacheptr
;
196 struct DictionaryIter iter
;
198 DICTIONARY_FOREACH(cacheptr
, &iter
, help_dict_oper
)
200 irc_dictionary_delete(help_dict_oper
, cacheptr
->name
);
201 free_cachefile(cacheptr
);
203 DICTIONARY_FOREACH(cacheptr
, &iter
, help_dict_user
)
205 irc_dictionary_delete(help_dict_user
, cacheptr
->name
);
206 free_cachefile(cacheptr
);
209 helpfile_dir
= opendir(HPATH
);
211 if(helpfile_dir
== NULL
)
214 while((ldirent
= readdir(helpfile_dir
)) != NULL
)
216 rb_snprintf(filename
, sizeof(filename
), "%s/%s", HPATH
, ldirent
->d_name
);
217 cacheptr
= cache_file(filename
, ldirent
->d_name
, HELP_OPER
);
218 irc_dictionary_add(help_dict_oper
, cacheptr
->name
, cacheptr
);
221 closedir(helpfile_dir
);
222 helpfile_dir
= opendir(UHPATH
);
224 if(helpfile_dir
== NULL
)
227 while((ldirent
= readdir(helpfile_dir
)) != NULL
)
229 rb_snprintf(filename
, sizeof(filename
), "%s/%s", UHPATH
, ldirent
->d_name
);
231 cacheptr
= cache_file(filename
, ldirent
->d_name
, HELP_USER
);
232 irc_dictionary_add(help_dict_user
, cacheptr
->name
, cacheptr
);
235 closedir(helpfile_dir
);
240 * inputs - client to send motd to
241 * outputs - client is sent motd if exists, else ERR_NOMOTD
245 send_user_motd(struct Client
*source_p
)
247 struct cacheline
*lineptr
;
249 const char *myname
= get_id(&me
, source_p
);
250 const char *nick
= get_id(source_p
, source_p
);
251 if(user_motd
== NULL
|| rb_dlink_list_length(&user_motd
->contents
) == 0)
253 sendto_one(source_p
, form_str(ERR_NOMOTD
), myname
, nick
);
257 sendto_one(source_p
, form_str(RPL_MOTDSTART
), myname
, nick
, me
.name
);
259 RB_DLINK_FOREACH(ptr
, user_motd
->contents
.head
)
262 sendto_one(source_p
, form_str(RPL_MOTD
), myname
, nick
, lineptr
->data
);
265 sendto_one(source_p
, form_str(RPL_ENDOFMOTD
), myname
, nick
);
269 cache_user_motd(void)
274 if(stat(MPATH
, &sb
) == 0)
276 local_tm
= localtime(&sb
.st_mtime
);
280 rb_snprintf(user_motd_changed
, sizeof(user_motd_changed
),
282 local_tm
->tm_mday
, local_tm
->tm_mon
+ 1,
283 1900 + local_tm
->tm_year
, local_tm
->tm_hour
,
287 free_cachefile(user_motd
);
288 user_motd
= cache_file(MPATH
, "ircd.motd", 0);
294 * inputs - client to send motd to
295 * outputs - client is sent oper motd if exists
299 send_oper_motd(struct Client
*source_p
)
301 struct cacheline
*lineptr
;
304 if(oper_motd
== NULL
|| rb_dlink_list_length(&oper_motd
->contents
) == 0)
307 sendto_one(source_p
, form_str(RPL_OMOTDSTART
),
308 me
.name
, source_p
->name
);
310 RB_DLINK_FOREACH(ptr
, oper_motd
->contents
.head
)
313 sendto_one(source_p
, form_str(RPL_OMOTD
),
314 me
.name
, source_p
->name
, lineptr
->data
);
317 sendto_one(source_p
, form_str(RPL_ENDOFOMOTD
),
318 me
.name
, source_p
->name
);