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 "sprintf_irc.h"
43 #include "irc_dictionary.h"
46 struct cachefile
*user_motd
= NULL
;
47 struct cachefile
*oper_motd
= NULL
;
48 struct cacheline
*emptyline
= NULL
;
49 rb_dlink_list links_cache_list
;
50 char user_motd_changed
[MAX_DATE_STRING
];
52 struct Dictionary
*help_dict_oper
= NULL
;
53 struct Dictionary
*help_dict_user
= NULL
;
59 * side effects - inits the file/line cache blockheaps, loads motds
64 /* allocate the emptyline */
65 emptyline
= rb_malloc(sizeof(struct cacheline
));
66 emptyline
->data
[0] = ' ';
67 emptyline
->data
[1] = '\0';
68 user_motd_changed
[0] = '\0';
70 user_motd
= cache_file(MPATH
, "ircd.motd", 0);
71 oper_motd
= cache_file(OPATH
, "opers.motd", 0);
72 memset(&links_cache_list
, 0, sizeof(links_cache_list
));
74 help_dict_oper
= irc_dictionary_create(strcasecmp
);
75 help_dict_user
= irc_dictionary_create(strcasecmp
);
80 * inputs - file to cache, files "shortname", flags to set
81 * outputs - pointer to file cached, else NULL
85 cache_file(const char *filename
, const char *shortname
, int flags
)
88 struct cachefile
*cacheptr
;
89 struct cacheline
*lineptr
;
93 if((in
= fopen(filename
, "r")) == NULL
)
97 cacheptr
= rb_malloc(sizeof(struct cachefile
));
99 rb_strlcpy(cacheptr
->name
, shortname
, sizeof(cacheptr
->name
));
100 cacheptr
->flags
= flags
;
102 /* cache the file... */
103 while(fgets(line
, sizeof(line
), in
) != NULL
)
105 if((p
= strpbrk(line
, "\r\n")) != NULL
)
108 if(!EmptyString(line
))
110 lineptr
= rb_malloc(sizeof(struct cacheline
));
111 rb_strlcpy(lineptr
->data
, line
, sizeof(lineptr
->data
));
112 rb_dlinkAddTail(lineptr
, &lineptr
->linenode
, &cacheptr
->contents
);
115 rb_dlinkAddTailAlloc(emptyline
, &cacheptr
->contents
);
123 cache_links(void *unused
)
125 struct Client
*target_p
;
127 rb_dlink_node
*next_ptr
;
130 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, links_cache_list
.head
)
133 rb_free_rb_dlink_node(ptr
);
136 links_cache_list
.head
= links_cache_list
.tail
= NULL
;
137 links_cache_list
.length
= 0;
139 RB_DLINK_FOREACH(ptr
, global_serv_list
.head
)
141 target_p
= ptr
->data
;
143 /* skip ourselves (done in /links) and hidden servers */
145 (IsHidden(target_p
) && !ConfigServerHide
.disable_hidden
))
148 /* if the below is ever modified, change LINKSLINELEN */
149 links_line
= rb_malloc(LINKSLINELEN
);
150 rb_snprintf(links_line
, LINKSLINELEN
, "%s %s :1 %s",
151 target_p
->name
, me
.name
,
152 target_p
->info
[0] ? target_p
->info
:
153 "(Unknown Location)");
155 rb_dlinkAddTailAlloc(links_line
, &links_cache_list
);
161 * inputs - cachefile to free
163 * side effects - cachefile and its data is free'd
166 free_cachefile(struct cachefile
*cacheptr
)
169 rb_dlink_node
*next_ptr
;
174 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, cacheptr
->contents
.head
)
176 if(ptr
->data
!= emptyline
)
187 * side effects - old help cache deleted
188 * - contents of help directories are loaded.
193 DIR *helpfile_dir
= NULL
;
194 struct dirent
*ldirent
= NULL
;
195 char filename
[MAXPATHLEN
];
196 struct cachefile
*cacheptr
;
197 struct DictionaryIter iter
;
199 DICTIONARY_FOREACH(cacheptr
, &iter
, help_dict_oper
)
201 irc_dictionary_delete(help_dict_oper
, cacheptr
->name
);
202 free_cachefile(cacheptr
);
204 DICTIONARY_FOREACH(cacheptr
, &iter
, help_dict_user
)
206 irc_dictionary_delete(help_dict_user
, cacheptr
->name
);
207 free_cachefile(cacheptr
);
210 helpfile_dir
= opendir(HPATH
);
212 if(helpfile_dir
== NULL
)
215 while((ldirent
= readdir(helpfile_dir
)) != NULL
)
217 rb_snprintf(filename
, sizeof(filename
), "%s/%s", HPATH
, ldirent
->d_name
);
218 cacheptr
= cache_file(filename
, ldirent
->d_name
, HELP_OPER
);
219 irc_dictionary_add(help_dict_oper
, cacheptr
->name
, cacheptr
);
222 closedir(helpfile_dir
);
223 helpfile_dir
= opendir(UHPATH
);
225 if(helpfile_dir
== NULL
)
228 while((ldirent
= readdir(helpfile_dir
)) != NULL
)
230 rb_snprintf(filename
, sizeof(filename
), "%s/%s", UHPATH
, ldirent
->d_name
);
232 cacheptr
= cache_file(filename
, ldirent
->d_name
, HELP_USER
);
233 irc_dictionary_add(help_dict_user
, cacheptr
->name
, cacheptr
);
236 closedir(helpfile_dir
);
241 * inputs - client to send motd to
242 * outputs - client is sent motd if exists, else ERR_NOMOTD
246 send_user_motd(struct Client
*source_p
)
248 struct cacheline
*lineptr
;
250 const char *myname
= get_id(&me
, source_p
);
251 const char *nick
= get_id(source_p
, source_p
);
252 if(user_motd
== NULL
|| rb_dlink_list_length(&user_motd
->contents
) == 0)
254 sendto_one(source_p
, form_str(ERR_NOMOTD
), myname
, nick
);
258 sendto_one(source_p
, form_str(RPL_MOTDSTART
), myname
, nick
, me
.name
);
260 RB_DLINK_FOREACH(ptr
, user_motd
->contents
.head
)
263 sendto_one(source_p
, form_str(RPL_MOTD
), myname
, nick
, lineptr
->data
);
266 sendto_one(source_p
, form_str(RPL_ENDOFMOTD
), myname
, nick
);
270 cache_user_motd(void)
275 if(stat(MPATH
, &sb
) == 0)
277 local_tm
= localtime(&sb
.st_mtime
);
281 rb_snprintf(user_motd_changed
, sizeof(user_motd_changed
),
283 local_tm
->tm_mday
, local_tm
->tm_mon
+ 1,
284 1900 + local_tm
->tm_year
, local_tm
->tm_hour
,
288 free_cachefile(user_motd
);
289 user_motd
= cache_file(MPATH
, "ircd.motd", 0);