src/logger.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 #include "filelogger.h"
  17
  18 /*
  19  * Suggested implementation...
  20  *      class LogManager
  21  *              bool AddLogType(const std::string &type, enum loglevel, LogStream *)
  22  *              bool DelLogType(const std::string &type, LogStream *)
  23  *              Log(const std::string &type, enum loglevel, const std::string &msg)
  24  *              std::map<std::string, std::vector<LogStream *> > logstreams (holds a 'chain' of logstreams for each type that are all notified when a log happens)
  25  *
  26  *  class LogStream
  27  *              std::string type
  28  *      virtual void OnLog(enum loglevel, const std::string &msg)
  29  *
  30  * How it works:
  31  *  Modules create their own logstream types (core will create one for 'file logging' for example) and create instances of these logstream types
  32  *  and register interest in a certain logtype. Globbing is not here, with the exception of * - for all events.. loglevel is used to drop
  33  *  events that are of no interest to a logstream.
  34  *
  35  *  When Log is called, the vector of logstreams for that type is iterated (along with the special vector for "*"), and all registered logstreams
  36  *  are called back ("OnLog" or whatever) to do whatever they like with the message. In the case of the core, this will write to a file.
  37  *  In the case of the module I plan to write (m_logtochannel or something), it will log to the channel(s) for that logstream, etc.
  38  *
  39  * NOTE: Somehow we have to let LogManager manage the non-blocking file streams and provide an interface to share them with various LogStreams,
  40  *       as, for example, a user may want to let 'KILL' and 'XLINE' snotices go to /home/ircd/inspircd/logs/operactions.log, or whatever. How
  41  *       can we accomplish this easily? I guess with a map of pre-loved logpaths, and a pointer of FILE *..
  42  *
  43  */
  44
  45 LogManager::LogManager()
  46 {
  47         Logging = false;
  48 }
  49
  50 LogManager::~LogManager()
  51 {
  52 }
  53
  54 void LogManager::OpenFileLogs()
  55 {
  56         /* Skip rest of logfile opening if we are running -nolog. */
  57         if (!ServerInstance->Config->cmdline.writelog)
  58                 return;
  59         std::map<std::string, FileWriter*> logmap;
  60         ConfigTagList tags = ServerInstance->Config->ConfTags("log");
  61         for(ConfigIter i = tags.first; i != tags.second; ++i)
  62         {
  63                 ConfigTag* tag = i->second;
  64                 std::string method = tag->getString("method");
  65                 if (method != "file")
  66                 {
  67                         continue;
  68                 }
  69                 std::string type = tag->getString("type");
  70                 std::string level = tag->getString("level");
  71                 int loglevel = DEFAULT;
  72                 if (level == "debug")
  73                 {
  74                         loglevel = DEBUG;
  75                 }
  76                 else if (level == "verbose")
  77                 {
  78                         loglevel = VERBOSE;
  79                 }
  80                 else if (level == "default")
  81                 {
  82                         loglevel = DEFAULT;
  83                 }
  84                 else if (level == "sparse")
  85                 {
  86                         loglevel = SPARSE;
  87                 }
  88                 else if (level == "none")
  89                 {
  90                         loglevel = NONE;
  91                 }
  92                 FileWriter* fw;
  93                 std::string target = tag->getString("target");
  94                 std::map<std::string, FileWriter*>::iterator fwi = logmap.find(target);
  95                 if (fwi == logmap.end())
  96                 {
  97                         FILE* f = fopen(target.c_str(), "a");
  98                         fw = new FileWriter(f);
  99                         logmap.insert(std::make_pair(target, fw));
 100                 }
 101                 else
 102                 {
 103                         fw = fwi->second;
 104                 }
 105                 FileLogStream* fls = new FileLogStream(loglevel, fw);
 106                 AddLogTypes(type, fls, true);
 107         }
 108 }
 109
 110 void LogManager::CloseLogs()
 111 {
 112         std::map<std::string, std::vector<LogStream*> >().swap(LogStreams); /* Clear it */
 113         std::map<LogStream*, std::vector<std::string> >().swap(GlobalLogStreams); /* Clear it */
 114         for (std::map<LogStream*, int>::iterator i = AllLogStreams.begin(); i != AllLogStreams.end(); ++i)
 115         {
 116                 delete i->first;
 117         }
 118         std::map<LogStream*, int>().swap(AllLogStreams); /* And clear it */
 119 }
 120
 121 void LogManager::AddLogTypes(const std::string &types, LogStream* l, bool autoclose)
 122 {
 123         irc::spacesepstream css(types);
 124         std::string tok;
 125         std::vector<std::string> excludes;
 126         while (css.GetToken(tok))
 127         {
 128                 if (tok.empty())
 129                 {
 130                         continue;
 131                 }
 132                 if (tok.at(0) == '-')
 133                 {
 134                         /* Exclude! */
 135                         excludes.push_back(tok.substr(1));
 136                 }
 137                 else
 138                 {
 139                         AddLogType(tok, l, autoclose);
 140                 }
 141         }
 142         // Handle doing things like: USERINPUT USEROUTPUT -USERINPUT should be the same as saying just USEROUTPUT.
 143         // (This is so modules could, for example, inject exclusions for logtypes they can't handle.)
 144         for (std::vector<std::string>::iterator i = excludes.begin(); i != excludes.end(); ++i)
 145         {
 146                 if (*i == "*")
 147                 {
 148                         /* -* == Exclude all. Why someone would do this, I dunno. */
 149                         DelLogStream(l);
 150                         return;
 151                 }
 152                 DelLogType(*i, l);
 153         }
 154         // Now if it's registered as a global, add the exclusions there too.
 155         std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
 156         if (gi != GlobalLogStreams.end())
 157         {
 158                 gi->second.swap(excludes); // Swap with the vector in the hash.
 159         }
 160 }
 161
 162 bool LogManager::AddLogType(const std::string &type, LogStream *l, bool autoclose)
 163 {
 164         std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
 165
 166         if (i != LogStreams.end())
 167         {
 168                 i->second.push_back(l);
 169         }
 170         else
 171         {
 172                 std::vector<LogStream *> v;
 173                 v.push_back(l);
 174                 LogStreams[type] = v;
 175         }
 176
 177         if (type == "*")
 178         {
 179                 GlobalLogStreams.insert(std::make_pair(l, std::vector<std::string>()));
 180         }
 181
 182         if (autoclose)
 183         {
 184                 std::map<LogStream*, int>::iterator ai = AllLogStreams.find(l);
 185                 if (ai == AllLogStreams.end())
 186                 {
 187                         AllLogStreams.insert(std::make_pair(l, 1));
 188                 }
 189                 else
 190                 {
 191                         ++ai->second;
 192                 }
 193         }
 194
 195         return true;
 196 }
 197
 198 void LogManager::DelLogStream(LogStream* l)
 199 {
 200         for (std::map<std::string, std::vector<LogStream*> >::iterator i = LogStreams.begin(); i != LogStreams.end(); ++i)
 201         {
 202                 std::vector<LogStream*>::iterator it;
 203                 while ((it = std::find(i->second.begin(), i->second.end(), l)) != i->second.end())
 204                 {
 205                         if (it == i->second.end())
 206                                 continue;
 207                         i->second.erase(it);
 208                 }
 209         }
 210         std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
 211         if (gi != GlobalLogStreams.end())
 212         {
 213                 GlobalLogStreams.erase(gi);
 214         }
 215         std::map<LogStream*, int>::iterator ai = AllLogStreams.begin();
 216         if (ai == AllLogStreams.end())
 217         {
 218                 return; /* Done. */
 219         }
 220         delete ai->first;
 221         AllLogStreams.erase(ai);
 222 }
 223
 224 bool LogManager::DelLogType(const std::string &type, LogStream *l)
 225 {
 226         std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
 227         if (type == "*")
 228         {
 229                 std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
 230                 if (gi != GlobalLogStreams.end()) GlobalLogStreams.erase(gi);
 231         }
 232
 233         if (i != LogStreams.end())
 234         {
 235                 std::vector<LogStream *>::iterator it = std::find(i->second.begin(), i->second.end(), l);
 236
 237                 if (it != i->second.end())
 238                 {
 239                         i->second.erase(it);
 240                         if (i->second.size() == 0)
 241                         {
 242                                 LogStreams.erase(i);
 243                         }
 244                 }
 245                 else
 246                 {
 247                         return false;
 248                 }
 249         }
 250         else
 251         {
 252                 return false;
 253         }
 254
 255         std::map<LogStream*, int>::iterator ai = AllLogStreams.find(l);
 256         if (ai == AllLogStreams.end())
 257         {
 258                 return true;
 259         }
 260
 261         if ((--ai->second) < 1)
 262         {
 263                 AllLogStreams.erase(ai);
 264                 delete l;
 265         }
 266
 267         return true;
 268 }
 269
 270 void LogManager::Log(const std::string &type, int loglevel, const char *fmt, ...)
 271 {
 272         if (Logging)
 273         {
 274                 return;
 275         }
 276
 277         va_list a;
 278         static char buf[65536];
 279
 280         va_start(a, fmt);
 281         vsnprintf(buf, 65536, fmt, a);
 282         va_end(a);
 283
 284         this->Log(type, loglevel, std::string(buf));
 285 }
 286
 287 void LogManager::Log(const std::string &type, int loglevel, const std::string &msg)
 288 {
 289         if (Logging)
 290         {
 291                 return;
 292         }
 293
 294         Logging = true;
 295
 296         for (std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.begin(); gi != GlobalLogStreams.end(); ++gi)
 297         {
 298                 if (std::find(gi->second.begin(), gi->second.end(), type) != gi->second.end())
 299                 {
 300                         continue;
 301                 }
 302                 gi->first->OnLog(loglevel, type, msg);
 303         }
 304
 305         std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
 306
 307         if (i != LogStreams.end())
 308         {
 309                 for (std::vector<LogStream *>::iterator it = i->second.begin(); it != i->second.end(); ++it)
 310                 {
 311                         (*it)->OnLog(loglevel, type, msg);
 312                 }
 313         }
 314
 315         Logging = false;
 316 }
 317
 318
 319 FileWriter::FileWriter(FILE* logfile)
 320 : log(logfile), writeops(0)
 321 {
 322 }
 323
 324 void FileWriter::WriteLogLine(const std::string &line)
 325 {
 326         if (log == NULL)
 327                 return;
 328 // XXX: For now, just return. Don't throw an exception. It'd be nice to find out if this is happening, but I'm terrified of breaking so close to final release. -- w00t
 329 //              throw CoreException("FileWriter::WriteLogLine called with a closed logfile");
 330
 331         fprintf(log,"%s",line.c_str());
 332         if (writeops++ % 20)
 333         {
 334                 fflush(log);
 335         }
 336 }
 337
 338 FileWriter::~FileWriter()
 339 {
 340         if (log)
 341         {
 342                 fflush(log);
 343                 fclose(log);
 344                 log = NULL;
 345         }
 346 }