]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_xline_db.cpp
Fix dccallow to work with files with spaces in their names
[user/henk/code/inspircd.git] / src / modules / m_xline_db.cpp
index d77f8e91976af795608fce103bbacdc81005e223..2237b0d081e8036217606e7a3c22de29d7b0942e 100644 (file)
@@ -1,35 +1,52 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 #include "inspircd.h"
 #include "xline.h"
 
+/* $ModConfig: <xlinedb filename="data/xline.db">
+ *  Specify the filename for the xline database here*/
 /* $ModDesc: Keeps a dynamic log of all XLines created, and stores them in a seperate conf file (xline.db). */
 
 class ModuleXLineDB : public Module
 {
-       std::vector<XLine *> xlines;
-       bool reading_db;                        // If this is true, addlines are as a result of db reading, so don't bother flushing the db to disk.
-                                               // DO REMEMBER TO SET IT, otherwise it's annoying :P
+       bool dirty;
+       std::string xlinedbpath;
  public:
-       ModuleXLineDB(InspIRCd* Me) : Module(Me)
+       void init()
        {
-               Implementation eventlist[] = { I_OnAddLine, I_OnDelLine };
-               ServerInstance->Modules->Attach(eventlist, this, 2);
+               /* Load the configuration
+                * Note:
+                *              this is on purpose not in the OnRehash() method. It would be non-trivial to change the database on-the-fly.
+                *              Imagine a scenario where the new file already exists. Merging the current XLines with the existing database is likely a bad idea
+                *              ...and so is discarding all current in-memory XLines for the ones in the database.
+                */
+               ConfigTag* Conf = ServerInstance->Config->ConfValue("xlinedb");
+               xlinedbpath = Conf->getString("filename", DATA_PATH "/xline.db");
 
-               reading_db = true;
+               // Read xlines before attaching to events
                ReadDatabase();
-               reading_db = false;
+
+               Implementation eventlist[] = { I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnBackgroundTimer };
+               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
+               dirty = false;
        }
 
        virtual ~ModuleXLineDB()
@@ -43,19 +60,7 @@ class ModuleXLineDB : public Module
         */
        void OnAddLine(User* source, XLine* line)
        {
-               xlines.push_back(line);
-
-               for (std::vector<XLine *>::iterator i = xlines.begin(); i != xlines.end(); i++)
-               {
-                       line = (*i);
-                       ServerInstance->WriteOpers("%s %s %s %lu %lu :%s", line->type.c_str(), line->Displayable(),
-ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason);
-               }
-
-               if (!reading_db)
-               {
-                       WriteDatabase();
-               }
+               dirty = true;
        }
 
        /** Called whenever an xline is deleted.
@@ -65,16 +70,21 @@ ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason
         */
        void OnDelLine(User* source, XLine* line)
        {
-               for (std::vector<XLine *>::iterator i = xlines.begin(); i != xlines.end(); i++)
+               dirty = true;
+       }
+
+       void OnExpireLine(XLine *line)
+       {
+               dirty = true;
+       }
+
+       void OnBackgroundTimer(time_t now)
+       {
+               if (dirty)
                {
-                       if ((*i) == line)
-                       {
-                               xlines.erase(i);
-                               break;
-                       }
+                       if (WriteDatabase())
+                               dirty = false;
                }
-
-               WriteDatabase();
        }
 
        bool WriteDatabase()
@@ -87,16 +97,17 @@ ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason
                 * Technically, that means that this can block, but I have *never* seen that.
                 *              -- w00t
                 */
-               ServerInstance->Log(DEBUG, "xlinedb: Opening temporary database");
-               f = fopen("xline.db.new", "w");
+               ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Opening temporary database");
+               std::string xlinenewdbpath = xlinedbpath + ".new";
+               f = fopen(xlinenewdbpath.c_str(), "w");
                if (!f)
                {
-                       ServerInstance->Log(DEBUG, "xlinedb: Cannot create database! %s (%d)", strerror(errno), errno);
-                       ServerInstance->SNO->WriteToSnoMask('x', "database: cannot create new db: %s (%d)", strerror(errno), errno);
+                       ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot create database! %s (%d)", strerror(errno), errno);
+                       ServerInstance->SNO->WriteToSnoMask('a', "database: cannot create new db: %s (%d)", strerror(errno), errno);
                        return false;
                }
 
-               ServerInstance->Log(DEBUG, "xlinedb: Opened. Writing..");
+               ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Opened. Writing..");
 
                /*
                 * Now, much as I hate writing semi-unportable formats, additional
@@ -108,31 +119,41 @@ ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason
                fprintf(f, "VERSION 1\n");
 
                // Now, let's write.
-               XLine *line;
-               for (std::vector<XLine *>::iterator i = xlines.begin(); i != xlines.end(); i++)
+               std::vector<std::string> types = ServerInstance->XLines->GetAllTypes();
+               for (std::vector<std::string>::const_iterator it = types.begin(); it != types.end(); ++it)
                {
-                       line = (*i);
-                       fprintf(f, "LINE %s %s %s %lu %lu :%s\n", line->type.c_str(), line->Displayable(),
-                               ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason);
+                       XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
+                       if (!lookup)
+                               continue; // Not possible as we just obtained the list from XLineManager
+
+                       for (LookupIter i = lookup->begin(); i != lookup->end(); ++i)
+                       {
+                               XLine* line = i->second;
+                               fprintf(f, "LINE %s %s %s %lu %lu :%s\n", line->type.c_str(), line->Displayable(),
+                                       ServerInstance->Config->ServerName.c_str(), (unsigned long)line->set_time, (unsigned long)line->duration, line->reason.c_str());
+                       }
                }
 
-               ServerInstance->Log(DEBUG, "xlinedb: Finished writing XLines. Checking for error..");
+               ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Finished writing XLines. Checking for error..");
 
                int write_error = 0;
                write_error = ferror(f);
                write_error |= fclose(f);
                if (write_error)
                {
-                       ServerInstance->Log(DEBUG, "xlinedb: Cannot write to new database! %s (%d)", strerror(errno), errno);
-                       ServerInstance->SNO->WriteToSnoMask('x', "database: cannot write to new db: %s (%d)", strerror(errno), errno);
+                       ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot write to new database! %s (%d)", strerror(errno), errno);
+                       ServerInstance->SNO->WriteToSnoMask('a', "database: cannot write to new db: %s (%d)", strerror(errno), errno);
                        return false;
                }
 
+#ifdef _WIN32
+               remove(xlinedbpath.c_str());
+#endif
                // Use rename to move temporary to new db - this is guarenteed not to fuck up, even in case of a crash.
-               if (rename("xline.db.new", "xline.db") < 0)
+               if (rename(xlinenewdbpath.c_str(), xlinedbpath.c_str()) < 0)
                {
-                       ServerInstance->Log(DEBUG, "xlinedb: Cannot move new to old database! %s (%d)", strerror(errno), errno);
-                       ServerInstance->SNO->WriteToSnoMask('x', "database: cannot replace old with new db: %s (%d)", strerror(errno), errno);
+                       ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot move new to old database! %s (%d)", strerror(errno), errno);
+                       ServerInstance->SNO->WriteToSnoMask('a', "database: cannot replace old with new db: %s (%d)", strerror(errno), errno);
                        return false;
                }
 
@@ -143,9 +164,8 @@ ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason
        {
                FILE *f;
                char linebuf[MAXBUF];
-               unsigned int lineno = 0;
 
-               f = fopen("xline.db", "r");
+               f = fopen(xlinedbpath.c_str(), "r");
                if (!f)
                {
                        if (errno == ENOENT)
@@ -156,8 +176,8 @@ ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason
                        else
                        {
                                /* this might be slightly more problematic. */
-                               ServerInstance->Log(DEBUG, "xlinedb: Cannot read database! %s (%d)", strerror(errno), errno);
-                               ServerInstance->SNO->WriteToSnoMask('x', "database: cannot read db: %s (%d)", strerror(errno), errno);
+                               ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot read database! %s (%d)", strerror(errno), errno);
+                               ServerInstance->SNO->WriteToSnoMask('a', "database: cannot read db: %s (%d)", strerror(errno), errno);
                                return false;
                        }
                }
@@ -175,64 +195,67 @@ ServerInstance->Config->ServerName, line->set_time, line->duration, line->reason
 
                                c++;
                        }
-                       // Smart man might think of initing to 1, and moving this to the bottom. Don't. We use continue in this loop.
-                       lineno++;
 
                        // Inspired by the command parser. :)
                        irc::tokenstream tokens(linebuf);
                        int items = 0;
-                       std::string command_p[MAXPARAMETERS];
+                       std::string command_p[7];
                        std::string tmp;
 
-                       while (tokens.GetToken(tmp) && (items < MAXPARAMETERS))
+                       while (tokens.GetToken(tmp) && (items < 7))
                        {
-                               command_p[items] = tmp.c_str();
+                               command_p[items] = tmp;
                                items++;
                        }
 
+                       ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Processing %s", linebuf);
+
                        if (command_p[0] == "VERSION")
                        {
                                if (command_p[1] == "1")
                                {
-                                       ServerInstance->Log(DEBUG, "xlinedb: Reading db version %s", command_p[1].c_str());
+                                       ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Reading db version %s", command_p[1].c_str());
                                }
                                else
                                {
                                        fclose(f);
-                                       ServerInstance->Log(DEBUG, "xlinedb: I got database version %s - I don't understand it", command_p[1].c_str());
-                                       ServerInstance->SNO->WriteToSnoMask('x', "database: I got a database version (%s) I don't understand", command_p[1].c_str());
+                                       ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: I got database version %s - I don't understand it", command_p[1].c_str());
+                                       ServerInstance->SNO->WriteToSnoMask('a', "database: I got a database version (%s) I don't understand", command_p[1].c_str());
                                        return false;
                                }
                        }
                        else if (command_p[0] == "LINE")
                        {
-                               //mercilessly stolen from spanningtree
-                               XLineFactory* xlf = ServerInstance->XLines->GetFactory(command_p[0]);
+                               // Mercilessly stolen from spanningtree
+                               XLineFactory* xlf = ServerInstance->XLines->GetFactory(command_p[1]);
 
                                if (!xlf)
                                {
-                                       ServerInstance->SNO->WriteToSnoMask('x', "database: Unknown line type (%s).", command_p[1].c_str());
+                                       ServerInstance->SNO->WriteToSnoMask('a', "database: Unknown line type (%s).", command_p[1].c_str());
                                        continue;
                                }
 
-                               XLine* xl = xlf->Generate(ServerInstance->Time(), atoi(command_p[5].c_str()), command_p[3].c_str(), command_p[6].c_str(), command_p[2].c_str());
+                               XLine* xl = xlf->Generate(ServerInstance->Time(), atoi(command_p[5].c_str()), command_p[3], command_p[6], command_p[2]);
                                xl->SetCreateTime(atoi(command_p[4].c_str()));
 
                                if (ServerInstance->XLines->AddLine(xl, NULL))
                                {
                                        ServerInstance->SNO->WriteToSnoMask('x', "database: Added a line of type %s", command_p[1].c_str());
                                }
+                               else
+                                       delete xl;
                        }
                }
 
+               fclose(f);
                return true;
        }
 
-       
+
 
        virtual Version GetVersion()
        {
-               return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
+               return Version("Keeps a dynamic log of all XLines created, and stores them in a separate conf file (xline.db).", VF_VENDOR);
        }
 };