#include "inspircd.h"
#include "xline.h"
+#include <fstream>
+/* $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() {
- Implementation eventlist[] = { I_OnAddLine, I_OnDelLine, I_OnExpireLine };
- ServerInstance->Modules->Attach(eventlist, this, 3);
+ void init() CXX11_OVERRIDE
+ {
+ /* 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;
- }
- virtual ~ModuleXLineDB()
- {
+ Implementation eventlist[] = { I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnBackgroundTimer };
+ ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
+ dirty = false;
}
/** Called whenever an xline is added by a local user.
* @param source The sender of the line or NULL for local server
* @param line The xline being added
*/
- void OnAddLine(User* source, XLine* line)
+ void OnAddLine(User* source, XLine* line) CXX11_OVERRIDE
{
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Adding a line");
- xlines.push_back(line);
-
- if (!reading_db)
- {
- WriteDatabase();
- }
+ dirty = true;
}
/** Called whenever an xline is deleted.
* @param source The user removing the line or NULL for local server
* @param line the line being deleted
*/
- void OnDelLine(User* source, XLine* line)
+ void OnDelLine(User* source, XLine* line) CXX11_OVERRIDE
{
- RemoveLine(line);
+ dirty = true;
}
- void OnExpireLine(XLine *line)
+ void OnExpireLine(XLine *line) CXX11_OVERRIDE
{
- RemoveLine(line);
+ dirty = true;
}
- void RemoveLine(XLine *line)
+ void OnBackgroundTimer(time_t now) CXX11_OVERRIDE
{
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Removing a line");
- for (std::vector<XLine *>::iterator i = xlines.begin(); i != xlines.end(); i++)
+ if (dirty)
{
- if ((*i) == line)
- {
- xlines.erase(i);
- break;
- }
+ if (WriteDatabase())
+ dirty = false;
}
-
- WriteDatabase();
}
bool WriteDatabase()
{
- FILE *f;
-
/*
* We need to perform an atomic write so as not to fuck things up.
- * So, let's write to a temporary file, flush and sync the FD, then rename the file..
+ * So, let's write to a temporary file, flush it, then rename the file..
* Technically, that means that this can block, but I have *never* seen that.
- * -- w00t
+ * -- w00t
*/
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Opening temporary database");
- f = fopen("data/xline.db.new", "w");
- if (!f)
+ ServerInstance->Logs->Log("m_xline_db", LOG_DEBUG, "xlinedb: Opening temporary database");
+ std::string xlinenewdbpath = xlinedbpath + ".new";
+ std::ofstream stream(xlinenewdbpath.c_str());
+ if (!stream.is_open())
{
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot create database! %s (%d)", strerror(errno), errno);
+ ServerInstance->Logs->Log("m_xline_db", LOG_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->Logs->Log("m_xline_db",DEBUG, "xlinedb: Opened. Writing..");
+ ServerInstance->Logs->Log("m_xline_db", LOG_DEBUG, "xlinedb: Opened. Writing..");
/*
* Now, much as I hate writing semi-unportable formats, additional
* semblance of backwards compatibility for reading on startup..
* -- w00t
*/
- fprintf(f, "VERSION 1\n");
+ stream << "VERSION 1" << std::endl;
// 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.c_str(), (unsigned long)line->set_time, (unsigned long)line->duration, line->reason.c_str());
+ 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;
+ stream << "LINE " << line->type << " " << line->Displayable() << " "
+ << ServerInstance->Config->ServerName << " " << line->set_time << " "
+ << line->duration << " " << line->reason << std::endl;
+ }
}
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Finished writing XLines. Checking for error..");
+ ServerInstance->Logs->Log("m_xline_db", LOG_DEBUG, "xlinedb: Finished writing XLines. Checking for error..");
- int write_error = 0;
- write_error = ferror(f);
- write_error |= fclose(f);
- if (write_error)
+ if (stream.fail())
{
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot write to new database! %s (%d)", strerror(errno), errno);
+ ServerInstance->Logs->Log("m_xline_db", LOG_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;
}
+ stream.close();
+#ifdef _WIN32
+ if (remove(xlinedbpath.c_str()))
+ {
+ ServerInstance->Logs->Log("m_xline_db", LOG_DEBUG, "xlinedb: Cannot remove old database! %s (%d)", strerror(errno), errno);
+ ServerInstance->SNO->WriteToSnoMask('a', "database: cannot remove old database: %s (%d)", strerror(errno), errno);
+ return false;
+ }
+#endif
// Use rename to move temporary to new db - this is guarenteed not to fuck up, even in case of a crash.
- if (rename("data/xline.db.new", "data/xline.db") < 0)
+ if (rename(xlinenewdbpath.c_str(), xlinedbpath.c_str()) < 0)
{
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot move new to old database! %s (%d)", strerror(errno), errno);
+ ServerInstance->Logs->Log("m_xline_db", LOG_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;
}
bool ReadDatabase()
{
- FILE *f;
- char linebuf[MAXBUF];
- unsigned int lineno = 0;
+ // If the xline database doesn't exist then we don't need to load it.
+ if (!ServerConfig::FileExists(xlinedbpath.c_str()))
+ return true;
- f = fopen("data/xline.db", "r");
- if (!f)
+ std::ifstream stream(xlinedbpath.c_str());
+ if (!stream.is_open())
{
- if (errno == ENOENT)
- {
- /* xline.db doesn't exist, fake good return value (we don't care about this) */
- return true;
- }
- else
- {
- /* this might be slightly more problematic. */
- 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;
- }
+ ServerInstance->Logs->Log("m_xline_db", LOG_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;
}
-
- while (fgets(linebuf, MAXBUF, f))
+
+ std::string line;
+ while (std::getline(stream, line))
{
- char *c = linebuf;
-
- while (c && *c)
- {
- if (*c == '\n')
- {
- *c = '\0';
- }
-
- 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);
+ irc::tokenstream tokens(line);
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;
items++;
}
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Processing %s", linebuf);
+ ServerInstance->Logs->Log("m_xline_db", LOG_DEBUG, "xlinedb: Processing %s", line.c_str());
if (command_p[0] == "VERSION")
{
if (command_p[1] == "1")
{
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Reading db version %s", command_p[1].c_str());
+ ServerInstance->Logs->Log("m_xline_db", LOG_DEBUG, "xlinedb: Reading db version %s", command_p[1].c_str());
}
else
{
- fclose(f);
- ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: I got database version %s - I don't understand it", command_p[1].c_str());
+ stream.close();
+ ServerInstance->Logs->Log("m_xline_db", LOG_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;
}
{
ServerInstance->SNO->WriteToSnoMask('x', "database: Added a line of type %s", command_p[1].c_str());
}
+ else
+ delete xl;
}
}
-
- fclose(f);
+ stream.close();
return true;
}
-
-
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version("Keeps a dynamic log of all XLines created, and stores them in a seperate conf file (xline.db).", VF_VENDOR);
+ return Version("Keeps a dynamic log of all XLines created, and stores them in a separate conf file (xline.db).", VF_VENDOR);
}
};
MODULE_INIT(ModuleXLineDB)
-
projects / user / henk / code / inspircd.git / blobdiff