2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
5 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
7 * This file is part of InspIRCd. InspIRCd is free software: you can
8 * redistribute it and/or modify it under the terms of the GNU General Public
9 * License as published by the Free Software Foundation, version 2.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /* $ModConfig: <xlinedb filename="data/xline.db">
25 * Specify the filename for the xline database here*/
26 /* $ModDesc: Keeps a dynamic log of all XLines created, and stores them in a seperate conf file (xline.db). */
28 class ModuleXLineDB : public Module
30 std::vector<XLine *> xlines;
31 bool reading_db; // If this is true, addlines are as a result of db reading, so don't bother flushing the db to disk.
32 // DO REMEMBER TO SET IT, otherwise it's annoying :P
33 std::string xlinedbpath;
37 Implementation eventlist[] = { I_OnAddLine, I_OnDelLine, I_OnExpireLine };
38 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
40 /* Load the configuration
42 * this is on purpose not in the OnRehash() method. It would be non-trivial to change the database on-the-fly.
43 * Imagine a scenario where the new file already exists. Merging the current XLines with the existing database is likely a bad idea
44 * ...and so is discarding all current in-memory XLines for the ones in the database.
46 ConfigTag* Conf = ServerInstance->Config->ConfValue("xlinedb");
47 xlinedbpath = Conf->getString("filename", DATA_PATH "/xline.db");
54 virtual ~ModuleXLineDB()
58 /** Called whenever an xline is added by a local user.
59 * This method is triggered after the line is added.
60 * @param source The sender of the line or NULL for local server
61 * @param line The xline being added
63 void OnAddLine(User* source, XLine* line)
65 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Adding a line");
66 xlines.push_back(line);
74 /** Called whenever an xline is deleted.
75 * This method is triggered after the line is deleted.
76 * @param source The user removing the line or NULL for local server
77 * @param line the line being deleted
79 void OnDelLine(User* source, XLine* line)
84 void OnExpireLine(XLine *line)
89 void RemoveLine(XLine *line)
91 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Removing a line");
92 for (std::vector<XLine *>::iterator i = xlines.begin(); i != xlines.end(); i++)
109 * We need to perform an atomic write so as not to fuck things up.
110 * So, let's write to a temporary file, flush and sync the FD, then rename the file..
111 * Technically, that means that this can block, but I have *never* seen that.
114 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Opening temporary database");
115 std::string xlinenewdbpath = xlinedbpath + ".new";
116 f = fopen(xlinenewdbpath.c_str(), "w");
119 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot create database! %s (%d)", strerror(errno), errno);
120 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot create new db: %s (%d)", strerror(errno), errno);
124 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Opened. Writing..");
127 * Now, much as I hate writing semi-unportable formats, additional
128 * xline types may not have a conf tag, so let's just write them.
129 * In addition, let's use a file version, so we can maintain some
130 * semblance of backwards compatibility for reading on startup..
133 fprintf(f, "VERSION 1\n");
137 for (std::vector<XLine *>::iterator i = xlines.begin(); i != xlines.end(); i++)
140 fprintf(f, "LINE %s %s %s %lu %lu :%s\n", line->type.c_str(), line->Displayable(),
141 ServerInstance->Config->ServerName.c_str(), (unsigned long)line->set_time, (unsigned long)line->duration, line->reason.c_str());
144 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Finished writing XLines. Checking for error..");
147 write_error = ferror(f);
148 write_error |= fclose(f);
151 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot write to new database! %s (%d)", strerror(errno), errno);
152 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot write to new db: %s (%d)", strerror(errno), errno);
157 if (remove(xlinedbpath.c_str()))
159 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot remove old database! %s (%d)", strerror(errno), errno);
160 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot remove old database: %s (%d)", strerror(errno), errno);
164 // Use rename to move temporary to new db - this is guarenteed not to fuck up, even in case of a crash.
165 if (rename(xlinenewdbpath.c_str(), xlinedbpath.c_str()) < 0)
167 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot move new to old database! %s (%d)", strerror(errno), errno);
168 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot replace old with new db: %s (%d)", strerror(errno), errno);
178 char linebuf[MAXBUF];
179 unsigned int lineno = 0;
181 f = fopen(xlinedbpath.c_str(), "r");
186 /* xline.db doesn't exist, fake good return value (we don't care about this) */
191 /* this might be slightly more problematic. */
192 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Cannot read database! %s (%d)", strerror(errno), errno);
193 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot read db: %s (%d)", strerror(errno), errno);
198 while (fgets(linebuf, MAXBUF, f))
211 // Smart man might think of initing to 1, and moving this to the bottom. Don't. We use continue in this loop.
214 // Inspired by the command parser. :)
215 irc::tokenstream tokens(linebuf);
217 std::string command_p[MAXPARAMETERS];
220 while (tokens.GetToken(tmp) && (items < MAXPARAMETERS))
222 command_p[items] = tmp;
226 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Processing %s", linebuf);
228 if (command_p[0] == "VERSION")
230 if (command_p[1] == "1")
232 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: Reading db version %s", command_p[1].c_str());
237 ServerInstance->Logs->Log("m_xline_db",DEBUG, "xlinedb: I got database version %s - I don't understand it", command_p[1].c_str());
238 ServerInstance->SNO->WriteToSnoMask('a', "database: I got a database version (%s) I don't understand", command_p[1].c_str());
242 else if (command_p[0] == "LINE")
244 // Mercilessly stolen from spanningtree
245 XLineFactory* xlf = ServerInstance->XLines->GetFactory(command_p[1]);
249 ServerInstance->SNO->WriteToSnoMask('a', "database: Unknown line type (%s).", command_p[1].c_str());
253 XLine* xl = xlf->Generate(ServerInstance->Time(), atoi(command_p[5].c_str()), command_p[3], command_p[6], command_p[2]);
254 xl->SetCreateTime(atoi(command_p[4].c_str()));
256 if (ServerInstance->XLines->AddLine(xl, NULL))
258 ServerInstance->SNO->WriteToSnoMask('x', "database: Added a line of type %s", command_p[1].c_str());
271 virtual Version GetVersion()
273 return Version("Keeps a dynamic log of all XLines created, and stores them in a separate conf file (xline.db).", VF_VENDOR);
277 MODULE_INIT(ModuleXLineDB)