src/cache.c

   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
  33 #include "stdinc.h"
  34 #include "ircd_defs.h"
  35 #include "common.h"
  36 #include "s_conf.h"
  37 #include "tools.h"
  38 #include "client.h"
  39 #include "memory.h"
  40 #include "balloc.h"
  41 #include "event.h"
  42 #include "hash.h"
  43 #include "cache.h"
  44 #include "sprintf_irc.h"
  45
  46 static BlockHeap *cachefile_heap = NULL;
  47 static BlockHeap *cacheline_heap = NULL;
  48
  49 struct cachefile *user_motd = NULL;
  50 struct cachefile *oper_motd = NULL;
  51 struct cacheline *emptyline = NULL;
  52 dlink_list links_cache_list;
  53 char user_motd_changed[MAX_DATE_STRING];
  54
  55 /* init_cache()
  56  *
  57  * inputs       -
  58  * outputs      -
  59  * side effects - inits the file/line cache blockheaps, loads motds
  60  */
  61 void
  62 init_cache(void)
  63 {
  64         cachefile_heap = BlockHeapCreate(sizeof(struct cachefile), CACHEFILE_HEAP_SIZE);
  65         cacheline_heap = BlockHeapCreate(sizeof(struct cacheline), CACHELINE_HEAP_SIZE);
  66
  67         /* allocate the emptyline */
  68         emptyline = BlockHeapAlloc(cacheline_heap);
  69         emptyline->data[0] = ' ';
  70         emptyline->data[1] = '\0';
  71         user_motd_changed[0] = '\0';
  72
  73         user_motd = cache_file(MPATH, "ircd.motd", 0);
  74         oper_motd = cache_file(OPATH, "opers.motd", 0);
  75         memset(&links_cache_list, 0, sizeof(links_cache_list));
  76 }
  77
  78 /* cache_file()
  79  *
  80  * inputs       - file to cache, files "shortname", flags to set
  81  * outputs      - pointer to file cached, else NULL
  82  * side effects -
  83  */
  84 struct cachefile *
  85 cache_file(const char *filename, const char *shortname, int flags)
  86 {
  87         FILE *in;
  88         struct cachefile *cacheptr;
  89         struct cacheline *lineptr;
  90         char line[BUFSIZE];
  91         char *p;
  92
  93         if((in = fopen(filename, "r")) == NULL)
  94                 return NULL;
  95
  96         if(strcmp(shortname, "ircd.motd") == 0)
  97         {
  98                 struct stat sb;
  99                 struct tm *local_tm;
 100
 101                 if(fstat(fileno(in), &sb) < 0)
 102                         return NULL;
 103
 104                 local_tm = localtime(&sb.st_mtime);
 105
 106                 if(local_tm != NULL)
 107                         ircsnprintf(user_motd_changed, sizeof(user_motd_changed),
 108                                  "%d/%d/%d %d:%d",
 109                                  local_tm->tm_mday, local_tm->tm_mon + 1,
 110                                  1900 + local_tm->tm_year, local_tm->tm_hour,
 111                                  local_tm->tm_min);
 112         }
 113
 114         cacheptr = BlockHeapAlloc(cachefile_heap);
 115
 116         strlcpy(cacheptr->name, shortname, sizeof(cacheptr->name));
 117         cacheptr->flags = flags;
 118
 119         /* cache the file... */
 120         while(fgets(line, sizeof(line), in) != NULL)
 121         {
 122                 if((p = strchr(line, '\n')) != NULL)
 123                         *p = '\0';
 124
 125                 if(!EmptyString(line))
 126                 {
 127                         lineptr = BlockHeapAlloc(cacheline_heap);
 128                         strlcpy(lineptr->data, line, sizeof(lineptr->data));
 129                         dlinkAddTail(lineptr, &lineptr->linenode, &cacheptr->contents);
 130                 }
 131                 else
 132                         dlinkAddTailAlloc(emptyline, &cacheptr->contents);
 133         }
 134
 135         fclose(in);
 136         return cacheptr;
 137 }
 138
 139 void
 140 cache_links(void *unused)
 141 {
 142         struct Client *target_p;
 143         dlink_node *ptr;
 144         dlink_node *next_ptr;
 145         char *links_line;
 146
 147         DLINK_FOREACH_SAFE(ptr, next_ptr, links_cache_list.head)
 148         {
 149                 MyFree(ptr->data);
 150                 free_dlink_node(ptr);
 151         }
 152
 153         links_cache_list.head = links_cache_list.tail = NULL;
 154         links_cache_list.length = 0;
 155
 156         DLINK_FOREACH(ptr, global_serv_list.head)
 157         {
 158                 target_p = ptr->data;
 159
 160                 /* skip ourselves (done in /links) and hidden servers */
 161                 if(IsMe(target_p) ||
 162                    (IsHidden(target_p) && !ConfigServerHide.disable_hidden))
 163                         continue;
 164
 165                 /* if the below is ever modified, change LINKSLINELEN */
 166                 links_line = MyMalloc(LINKSLINELEN);
 167                 ircsnprintf(links_line, LINKSLINELEN, "%s %s :1 %s",
 168                            target_p->name, me.name,
 169                            target_p->info[0] ? target_p->info :
 170                             "(Unknown Location)");
 171
 172                 dlinkAddTailAlloc(links_line, &links_cache_list);
 173         }
 174 }
 175
 176 /* free_cachefile()
 177  *
 178  * inputs       - cachefile to free
 179  * outputs      -
 180  * side effects - cachefile and its data is free'd
 181  */
 182 void
 183 free_cachefile(struct cachefile *cacheptr)
 184 {
 185         dlink_node *ptr;
 186         dlink_node *next_ptr;
 187
 188         if(cacheptr == NULL)
 189                 return;
 190
 191         DLINK_FOREACH_SAFE(ptr, next_ptr, cacheptr->contents.head)
 192         {
 193                 if(ptr->data != emptyline)
 194                         BlockHeapFree(cacheline_heap, ptr->data);
 195         }
 196
 197         BlockHeapFree(cachefile_heap, cacheptr);
 198 }
 199
 200 /* load_help()
 201  *
 202  * inputs       -
 203  * outputs      -
 204  * side effects - contents of help directories are loaded.
 205  */
 206 void
 207 load_help(void)
 208 {
 209         DIR *helpfile_dir = NULL;
 210         struct dirent *ldirent= NULL;
 211         char filename[MAXPATHLEN];
 212         struct cachefile *cacheptr;
 213
 214 #if defined(S_ISLNK) && defined(HAVE_LSTAT)
 215         struct stat sb;
 216 #endif
 217
 218         /* opers must be done first */
 219         helpfile_dir = opendir(HPATH);
 220
 221         if(helpfile_dir == NULL)
 222                 return;
 223
 224         while((ldirent = readdir(helpfile_dir)) != NULL)
 225         {
 226                 ircsnprintf(filename, sizeof(filename), "%s/%s", HPATH, ldirent->d_name);
 227                 cacheptr = cache_file(filename, ldirent->d_name, HELP_OPER);
 228                 add_to_help_hash(cacheptr->name, cacheptr);
 229         }
 230
 231         closedir(helpfile_dir);
 232         helpfile_dir = opendir(UHPATH);
 233
 234         if(helpfile_dir == NULL)
 235                 return;
 236
 237         while((ldirent = readdir(helpfile_dir)) != NULL)
 238         {
 239                 ircsnprintf(filename, sizeof(filename), "%s/%s", UHPATH, ldirent->d_name);
 240
 241 #if defined(S_ISLNK) && defined(HAVE_LSTAT)
 242                 if(lstat(filename, &sb) < 0)
 243                         continue;
 244
 245                 /* ok, if its a symlink, we work on the presumption if an
 246                  * oper help exists of that name, its a symlink to that --fl
 247                  */
 248                 if(S_ISLNK(sb.st_mode))
 249                 {
 250                         cacheptr = hash_find_help(ldirent->d_name, HELP_OPER);
 251
 252                         if(cacheptr != NULL)
 253                         {
 254                                 cacheptr->flags |= HELP_USER;
 255                                 continue;
 256                         }
 257                 }
 258 #endif
 259
 260                 cacheptr = cache_file(filename, ldirent->d_name, HELP_USER);
 261                 add_to_help_hash(cacheptr->name, cacheptr);
 262         }
 263
 264         closedir(helpfile_dir);
 265 }
 266
 267 /* send_user_motd()
 268  *
 269  * inputs       - client to send motd to
 270  * outputs      - client is sent motd if exists, else ERR_NOMOTD
 271  * side effects -
 272  */
 273 void
 274 send_user_motd(struct Client *source_p)
 275 {
 276         struct cacheline *lineptr;
 277         dlink_node *ptr;
 278         const char *myname = get_id(&me, source_p);
 279         const char *nick = get_id(source_p, source_p);
 280
 281         if(user_motd == NULL || dlink_list_length(&user_motd->contents) == 0)
 282         {
 283                 sendto_one(source_p, form_str(ERR_NOMOTD), myname, nick);
 284                 return;
 285         }
 286
 287         sendto_one(source_p, form_str(RPL_MOTDSTART), myname, nick, me.name);
 288
 289         DLINK_FOREACH(ptr, user_motd->contents.head)
 290         {
 291                 lineptr = ptr->data;
 292                 sendto_one(source_p, form_str(RPL_MOTD), myname, nick, lineptr->data);
 293         }
 294
 295         sendto_one(source_p, form_str(RPL_ENDOFMOTD), myname, nick);
 296 }
 297
 298 /* send_oper_motd()
 299  *
 300  * inputs       - client to send motd to
 301  * outputs      - client is sent oper motd if exists
 302  * side effects -
 303  */
 304 void
 305 send_oper_motd(struct Client *source_p)
 306 {
 307         struct cacheline *lineptr;
 308         dlink_node *ptr;
 309
 310         if(oper_motd == NULL || dlink_list_length(&oper_motd->contents) == 0)
 311                 return;
 312
 313         sendto_one(source_p, form_str(RPL_OMOTDSTART),
 314                    me.name, source_p->name);
 315
 316         DLINK_FOREACH(ptr, oper_motd->contents.head)
 317         {
 318                 lineptr = ptr->data;
 319                 sendto_one(source_p, form_str(RPL_OMOTD),
 320                            me.name, source_p->name, lineptr->data);
 321         }
 322
 323         sendto_one(source_p, form_str(RPL_ENDOFOMOTD),
 324                    me.name, source_p->name);
 325 }
 326