/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
* Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
*
* 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"
/* $ModDesc: Keeps a dynamic log of all XLines created, and stores them in a seperate conf file (xline.db). */
class ModuleXLineDB : public Module
{
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
public:
ModuleXLineDB() {
Implementation eventlist[] = { I_OnAddLine, I_OnDelLine, I_OnExpireLine };
ServerInstance->Modules->Attach(eventlist, this, 3);
reading_db = true;
ReadDatabase();
reading_db = false;
}
virtual ~ModuleXLineDB()
{
}
/** Called whenever an xline is added by a local user.
* This method is triggered after the line is added.
* @param source The sender of the line or NULL for local server
* @param line The xline being added
*/
void OnAddLine(User* source, XLine* line)
{
ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Adding a line");
if (!reading_db)
{
WriteDatabase();
}
}
/** Called whenever an xline is deleted.
* This method is triggered after the line 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)
{
RemoveLine(line);
}
void OnExpireLine(XLine *line)
{
RemoveLine(line);
}
void RemoveLine(XLine *line)
{
ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Removing a line");
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..
* Technically, that means that this can block, but I have *never* seen that.
* -- 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",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..");
/*
* Now, much as I hate writing semi-unportable formats, additional
* xline types may not have a conf tag, so let's just write them.
* In addition, let's use a file version, so we can maintain some
* semblance of backwards compatibility for reading on startup..
* -- w00t
*/
fprintf(f, "VERSION 1\n");
// Now, let's write.
std::vector<std::string> types = ServerInstance->XLines->GetAllTypes();
for (std::vector<std::string>::const_iterator it = types.begin(); it != types.end(); ++it)
{
XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
if (!lookup)
continue;
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->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->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;
}
// 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)
{
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;
}
return true;
}
bool ReadDatabase()
{
FILE *f;
char linebuf[MAXBUF];
unsigned int lineno = 0;
f = fopen("data/xline.db", "r");
if (!f)
{
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;
}
}
while (fgets(linebuf, MAXBUF, f))
{
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);
int items = 0;
std::string command_p[MAXPARAMETERS];
std::string tmp;
while (tokens.GetToken(tmp) && (items < MAXPARAMETERS))
{
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->Logs->Log("m_xline_db",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());
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[1]);
if (!xlf)
{
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], 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("Keeps a dynamic log of all XLines created, and stores them in a separate conf file (xline.db).", VF_VENDOR);
}
};
MODULE_INIT(ModuleXLineDB)
