ircd/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 "s_conf.h"
  36 #include "client.h"
  37 #include "hash.h"
  38 #include "cache.h"
  39 #include "rb_dictionary.h"
  40 #include "numeric.h"
  41 #include "send.h"
  42
  43 struct cachefile *user_motd = NULL;
  44 struct cachefile *oper_motd = NULL;
  45 struct cacheline *emptyline = NULL;
  46 rb_dlink_list links_cache_list;
  47 char user_motd_changed[MAX_DATE_STRING];
  48
  49 rb_dictionary *help_dict_oper = NULL;
  50 rb_dictionary *help_dict_user = NULL;
  51
  52 /* init_cache()
  53  *
  54  * inputs       -
  55  * outputs      -
  56  * side effects - inits the file/line cache blockheaps, loads motds
  57  */
  58 void
  59 init_cache(void)
  60 {
  61         /* allocate the emptyline */
  62         emptyline = rb_malloc(sizeof(struct cacheline));
  63         emptyline->data = rb_strdup(" ");
  64
  65         user_motd_changed[0] = '\0';
  66
  67         user_motd = cache_file(ircd_paths[IRCD_PATH_IRCD_MOTD], "ircd.motd", 0);
  68         oper_motd = cache_file(ircd_paths[IRCD_PATH_IRCD_OMOTD], "opers.motd", 0);
  69         memset(&links_cache_list, 0, sizeof(links_cache_list));
  70
  71         help_dict_oper = rb_dictionary_create("oper help", strcasecmp);
  72         help_dict_user = rb_dictionary_create("user help", strcasecmp);
  73 }
  74
  75 /*
  76  * removes tabs from src, replaces with 8 spaces, and returns the length
  77  * of the new string.  if the new string would be greater than destlen,
  78  * it is truncated to destlen - 1
  79  */
  80 static size_t
  81 untabify(char *dest, const char *src, size_t destlen)
  82 {
  83         size_t x = 0, i;
  84         const char *s = src;
  85         char *d = dest;
  86
  87         while(*s != '\0' && x < destlen - 1)
  88         {
  89                 if(*s == '\t')
  90                 {
  91                         for(i = 0; i < 8 && x < destlen - 1; i++, x++, d++)
  92                                 *d = ' ';
  93                         s++;
  94                 } else
  95                 {
  96                         *d++ = *s++;
  97                         x++;
  98                 }
  99         }
 100         *d = '\0';
 101         return x;
 102 }
 103
 104 /* cache_file()
 105  *
 106  * inputs       - file to cache, files "shortname", flags to set
 107  * outputs      - pointer to file cached, else NULL
 108  * side effects -
 109  */
 110 struct cachefile *
 111 cache_file(const char *filename, const char *shortname, int flags)
 112 {
 113         FILE *in;
 114         struct cachefile *cacheptr;
 115         struct cacheline *lineptr;
 116         char line[BUFSIZE];
 117         char *p;
 118
 119         if((in = fopen(filename, "r")) == NULL)
 120                 return NULL;
 121
 122
 123         cacheptr = rb_malloc(sizeof(struct cachefile));
 124
 125         rb_strlcpy(cacheptr->name, shortname, sizeof(cacheptr->name));
 126         cacheptr->flags = flags;
 127
 128         /* cache the file... */
 129         while(fgets(line, sizeof(line), in) != NULL)
 130         {
 131                 if((p = strpbrk(line, "\r\n")) != NULL)
 132                         *p = '\0';
 133
 134                 if(!EmptyString(line))
 135                 {
 136                         char untabline[BUFSIZE];
 137
 138                         lineptr = rb_malloc(sizeof(struct cacheline));
 139
 140                         untabify(untabline, line, sizeof(untabline));
 141                         lineptr->data = rb_strdup(untabline);
 142
 143                         rb_dlinkAddTail(lineptr, &lineptr->linenode, &cacheptr->contents);
 144                 }
 145                 else
 146                         rb_dlinkAddTailAlloc(emptyline, &cacheptr->contents);
 147         }
 148
 149         if (0 == rb_dlink_list_length(&cacheptr->contents))
 150         {
 151                 /* No contents. Don't cache it after all. */
 152                 rb_free(cacheptr);
 153                 cacheptr = NULL;
 154         }
 155
 156         fclose(in);
 157         return cacheptr;
 158 }
 159
 160 void
 161 cache_links(void *unused)
 162 {
 163         struct Client *target_p;
 164         rb_dlink_node *ptr;
 165         rb_dlink_node *next_ptr;
 166         char *links_line;
 167
 168         RB_DLINK_FOREACH_SAFE(ptr, next_ptr, links_cache_list.head)
 169         {
 170                 rb_free(ptr->data);
 171                 rb_free_rb_dlink_node(ptr);
 172         }
 173
 174         links_cache_list.head = links_cache_list.tail = NULL;
 175         links_cache_list.length = 0;
 176
 177         RB_DLINK_FOREACH(ptr, global_serv_list.head)
 178         {
 179                 target_p = ptr->data;
 180
 181                 /* skip ourselves (done in /links) and hidden servers */
 182                 if(IsMe(target_p) ||
 183                    (IsHidden(target_p) && !ConfigServerHide.disable_hidden))
 184                         continue;
 185
 186                 /* if the below is ever modified, change LINKSLINELEN */
 187                 links_line = rb_malloc(LINKSLINELEN);
 188                 snprintf(links_line, LINKSLINELEN, "%s %s :1 %s",
 189                            target_p->name, me.name,
 190                            target_p->info[0] ? target_p->info :
 191                             "(Unknown Location)");
 192
 193                 rb_dlinkAddTailAlloc(links_line, &links_cache_list);
 194         }
 195 }
 196
 197 /* free_cachefile()
 198  *
 199  * inputs       - cachefile to free
 200  * outputs      -
 201  * side effects - cachefile and its data is free'd
 202  */
 203 void
 204 free_cachefile(struct cachefile *cacheptr)
 205 {
 206         rb_dlink_node *ptr;
 207         rb_dlink_node *next_ptr;
 208
 209         if(cacheptr == NULL)
 210                 return;
 211
 212         RB_DLINK_FOREACH_SAFE(ptr, next_ptr, cacheptr->contents.head)
 213         {
 214                 if(ptr->data != emptyline)
 215                 {
 216                         struct cacheline *line = ptr->data;
 217                         rb_free(line->data);
 218                         rb_free(line);
 219                 }
 220         }
 221
 222         rb_free(cacheptr);
 223 }
 224
 225 /* load_help()
 226  *
 227  * inputs       -
 228  * outputs      -
 229  * side effects - old help cache deleted
 230  *              - contents of help directories are loaded.
 231  */
 232 void
 233 load_help(void)
 234 {
 235         DIR *helpfile_dir = NULL;
 236         struct dirent *ldirent= NULL;
 237         char filename[PATH_MAX];
 238         struct cachefile *cacheptr;
 239         rb_dictionary_iter iter;
 240
 241 #if defined(S_ISLNK) && defined(HAVE_LSTAT)
 242         struct stat sb;
 243 #endif
 244
 245         RB_DICTIONARY_FOREACH(cacheptr, &iter, help_dict_oper)
 246         {
 247                 rb_dictionary_delete(help_dict_oper, cacheptr->name);
 248                 free_cachefile(cacheptr);
 249         }
 250         RB_DICTIONARY_FOREACH(cacheptr, &iter, help_dict_user)
 251         {
 252                 rb_dictionary_delete(help_dict_user, cacheptr->name);
 253                 free_cachefile(cacheptr);
 254         }
 255
 256         helpfile_dir = opendir(ircd_paths[IRCD_PATH_OPERHELP]);
 257
 258         if(helpfile_dir == NULL)
 259                 return;
 260
 261         while((ldirent = readdir(helpfile_dir)) != NULL)
 262         {
 263                 if(ldirent->d_name[0] == '.')
 264                         continue;
 265                 snprintf(filename, sizeof(filename), "%s%c%s", ircd_paths[IRCD_PATH_OPERHELP], RB_PATH_SEPARATOR, ldirent->d_name);
 266                 cacheptr = cache_file(filename, ldirent->d_name, HELP_OPER);
 267                 rb_dictionary_add(help_dict_oper, cacheptr->name, cacheptr);
 268         }
 269
 270         closedir(helpfile_dir);
 271         helpfile_dir = opendir(ircd_path[IRCD_PATH_USERHELP]);
 272
 273         if(helpfile_dir == NULL)
 274                 return;
 275
 276         while((ldirent = readdir(helpfile_dir)) != NULL)
 277         {
 278                 if(ldirent->d_name[0] == '.')
 279                         continue;
 280                 snprintf(filename, sizeof(filename), "%s%c%s", ircd_paths[IRCD_PATH_USERHELP], RB_PATH_SEPARATOR, ldirent->d_name);
 281
 282 #if defined(S_ISLNK) && defined(HAVE_LSTAT)
 283                 if(lstat(filename, &sb) < 0)
 284                         continue;
 285
 286                 /* ok, if its a symlink, we work on the presumption if an
 287                  * oper help exists of that name, its a symlink to that --fl
 288                  */
 289                 if(S_ISLNK(sb.st_mode))
 290                 {
 291                         cacheptr = rb_dictionary_retrieve(help_dict_oper, ldirent->d_name);
 292
 293                         if(cacheptr != NULL)
 294                         {
 295                                 cacheptr->flags |= HELP_USER;
 296                                 continue;
 297                         }
 298                 }
 299 #endif
 300
 301                 cacheptr = cache_file(filename, ldirent->d_name, HELP_USER);
 302                 rb_dictionary_add(help_dict_user, cacheptr->name, cacheptr);
 303         }
 304
 305         closedir(helpfile_dir);
 306 }
 307
 308 /* send_user_motd()
 309  *
 310  * inputs       - client to send motd to
 311  * outputs      - client is sent motd if exists, else ERR_NOMOTD
 312  * side effects -
 313  */
 314 void
 315 send_user_motd(struct Client *source_p)
 316 {
 317         struct cacheline *lineptr;
 318         rb_dlink_node *ptr;
 319         const char *myname = get_id(&me, source_p);
 320         const char *nick = get_id(source_p, source_p);
 321         if(user_motd == NULL || rb_dlink_list_length(&user_motd->contents) == 0)
 322         {
 323                 sendto_one(source_p, form_str(ERR_NOMOTD), myname, nick);
 324                 return;
 325         }
 326
 327         sendto_one(source_p, form_str(RPL_MOTDSTART), myname, nick, me.name);
 328
 329         RB_DLINK_FOREACH(ptr, user_motd->contents.head)
 330         {
 331                 lineptr = ptr->data;
 332                 sendto_one(source_p, form_str(RPL_MOTD), myname, nick, lineptr->data);
 333         }
 334
 335         sendto_one(source_p, form_str(RPL_ENDOFMOTD), myname, nick);
 336 }
 337
 338 void
 339 cache_user_motd(void)
 340 {
 341         struct stat sb;
 342         struct tm *local_tm;
 343
 344         if(stat(ircd_paths[IRCD_PATH_IRCD_MOTD], &sb) == 0)
 345         {
 346                 local_tm = localtime(&sb.st_mtime);
 347
 348                 if(local_tm != NULL)
 349                 {
 350                         snprintf(user_motd_changed, sizeof(user_motd_changed),
 351                                  "%d/%d/%d %d:%d",
 352                                  local_tm->tm_mday, local_tm->tm_mon + 1,
 353                                  1900 + local_tm->tm_year, local_tm->tm_hour,
 354                                  local_tm->tm_min);
 355                 }
 356         }
 357         free_cachefile(user_motd);
 358         user_motd = cache_file(ircd_paths[IRCD_PATH_IRCD_MOTD], "ircd.motd", 0);
 359 }
 360
 361
 362 /* send_oper_motd()
 363  *
 364  * inputs       - client to send motd to
 365  * outputs      - client is sent oper motd if exists
 366  * side effects -
 367  */
 368 void
 369 send_oper_motd(struct Client *source_p)
 370 {
 371         struct cacheline *lineptr;
 372         rb_dlink_node *ptr;
 373
 374         if(oper_motd == NULL || rb_dlink_list_length(&oper_motd->contents) == 0)
 375                 return;
 376
 377         sendto_one(source_p, form_str(RPL_OMOTDSTART),
 378                    me.name, source_p->name);
 379
 380         RB_DLINK_FOREACH(ptr, oper_motd->contents.head)
 381         {
 382                 lineptr = ptr->data;
 383                 sendto_one(source_p, form_str(RPL_OMOTD),
 384                            me.name, source_p->name, lineptr->data);
 385         }
 386
 387         sendto_one(source_p, form_str(RPL_ENDOFOMOTD),
 388                    me.name, source_p->name);
 389 }