1 /* 2 * InspIRCd -- Internet Relay Chat Daemon 3 * 4 * Copyright (C) 2021 Herman <GermanAizek@yandex.ru> 5 * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions> 6 * Copyright (C) 2014 Justin Crawford <Justasic@Gmail.com> 7 * Copyright (C) 2013, 2015, 2018-2020 Sadie Powell <sadie@witchery.services> 8 * Copyright (C) 2012-2013 Attila Molnar <attilamolnar@hush.com> 9 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be> 10 * Copyright (C) 2012, 2014 Adam <Adam@anope.org> 11 * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de> 12 * Copyright (C) 2010 Craig Edwards <brain@inspircd.org> 13 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org> 14 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net> 15 * 16 * This file is part of InspIRCd. InspIRCd is free software: you can 17 * redistribute it and/or modify it under the terms of the GNU General Public 18 * License as published by the Free Software Foundation, version 2. 19 * 20 * This program is distributed in the hope that it will be useful, but WITHOUT 21 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 22 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 23 * details. 24 * 25 * You should have received a copy of the GNU General Public License 26 * along with this program. If not, see <http://www.gnu.org/licenses/>. 27 */ 28 29 30 #include "inspircd.h" 31 #include "xline.h" 32 #include <fstream> 33 34 class ModuleXLineDB 35 : public Module 36 , public Timer 37 { 38 private: 39 bool dirty; 40 std::string xlinedbpath; 41 42 public: ModuleXLineDB()43 ModuleXLineDB() 44 : Timer(0, true) 45 { 46 } 47 init()48 void init() CXX11_OVERRIDE 49 { 50 /* Load the configuration 51 * Note: 52 * This is on purpose not changed on a rehash. It would be non-trivial to change the database on-the-fly. 53 * Imagine a scenario where the new file already exists. Merging the current XLines with the existing database is likely a bad idea 54 * ...and so is discarding all current in-memory XLines for the ones in the database. 55 */ 56 ConfigTag* Conf = ServerInstance->Config->ConfValue("xlinedb"); 57 xlinedbpath = ServerInstance->Config->Paths.PrependData(Conf->getString("filename", "xline.db", 1)); 58 SetInterval(Conf->getDuration("saveperiod", 5)); 59 60 // Read xlines before attaching to events 61 ReadDatabase(); 62 63 dirty = false; 64 } 65 66 /** Called whenever an xline is added by a local user. 67 * This method is triggered after the line is added. 68 * @param source The sender of the line or NULL for local server 69 * @param line The xline being added 70 */ OnAddLine(User * source,XLine * line)71 void OnAddLine(User* source, XLine* line) CXX11_OVERRIDE 72 { 73 if (!line->from_config) 74 dirty = true; 75 } 76 77 /** Called whenever an xline is deleted. 78 * This method is triggered after the line is deleted. 79 * @param source The user removing the line or NULL for local server 80 * @param line the line being deleted 81 */ OnDelLine(User * source,XLine * line)82 void OnDelLine(User* source, XLine* line) CXX11_OVERRIDE 83 { 84 OnAddLine(source, line); 85 } 86 Tick(time_t)87 bool Tick(time_t) CXX11_OVERRIDE 88 { 89 if (dirty) 90 { 91 if (WriteDatabase()) 92 dirty = false; 93 } 94 return true; 95 } 96 WriteDatabase()97 bool WriteDatabase() 98 { 99 /* 100 * We need to perform an atomic write so as not to fuck things up. 101 * So, let's write to a temporary file, flush it, then rename the file.. 102 * Technically, that means that this can block, but I have *never* seen that. 103 * -- w00t 104 */ 105 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Opening temporary database"); 106 std::string xlinenewdbpath = xlinedbpath + ".new"; 107 std::ofstream stream(xlinenewdbpath.c_str()); 108 if (!stream.is_open()) 109 { 110 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Cannot create database \"%s\"! %s (%d)", xlinenewdbpath.c_str(), strerror(errno), errno); 111 ServerInstance->SNO->WriteToSnoMask('x', "database: cannot create new xline db \"%s\": %s (%d)", xlinenewdbpath.c_str(), strerror(errno), errno); 112 return false; 113 } 114 115 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Opened. Writing.."); 116 117 /* 118 * Now, much as I hate writing semi-unportable formats, additional 119 * xline types may not have a conf tag, so let's just write them. 120 * In addition, let's use a file version, so we can maintain some 121 * semblance of backwards compatibility for reading on startup.. 122 * -- w00t 123 */ 124 stream << "VERSION 1" << std::endl; 125 126 // Now, let's write. 127 std::vector<std::string> types = ServerInstance->XLines->GetAllTypes(); 128 for (std::vector<std::string>::const_iterator it = types.begin(); it != types.end(); ++it) 129 { 130 XLineLookup* lookup = ServerInstance->XLines->GetAll(*it); 131 if (!lookup) 132 continue; // Not possible as we just obtained the list from XLineManager 133 134 for (LookupIter i = lookup->begin(); i != lookup->end(); ++i) 135 { 136 XLine* line = i->second; 137 if (line->from_config) 138 continue; 139 140 stream << "LINE " << line->type << " " << line->Displayable() << " " 141 << line->source << " " << line->set_time << " " 142 << line->duration << " :" << line->reason << std::endl; 143 } 144 } 145 146 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Finished writing XLines. Checking for error.."); 147 148 if (stream.fail()) 149 { 150 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Cannot write to new database \"%s\"! %s (%d)", xlinenewdbpath.c_str(), strerror(errno), errno); 151 ServerInstance->SNO->WriteToSnoMask('x', "database: cannot write to new xline db \"%s\": %s (%d)", xlinenewdbpath.c_str(), strerror(errno), errno); 152 return false; 153 } 154 stream.close(); 155 156 #ifdef _WIN32 157 remove(xlinedbpath.c_str()); 158 #endif 159 // Use rename to move temporary to new db - this is guaranteed not to fuck up, even in case of a crash. 160 if (rename(xlinenewdbpath.c_str(), xlinedbpath.c_str()) < 0) 161 { 162 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Cannot replace old database \"%s\" with new database \"%s\"! %s (%d)", xlinedbpath.c_str(), xlinenewdbpath.c_str(), strerror(errno), errno); 163 ServerInstance->SNO->WriteToSnoMask('x', "database: cannot replace old xline db \"%s\" with new db \"%s\": %s (%d)", xlinedbpath.c_str(), xlinenewdbpath.c_str(), strerror(errno), errno); 164 return false; 165 } 166 167 return true; 168 } 169 ReadDatabase()170 bool ReadDatabase() 171 { 172 // If the xline database doesn't exist then we don't need to load it. 173 if (!FileSystem::FileExists(xlinedbpath)) 174 return true; 175 176 std::ifstream stream(xlinedbpath.c_str()); 177 if (!stream.is_open()) 178 { 179 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Cannot read database \"%s\"! %s (%d)", xlinedbpath.c_str(), strerror(errno), errno); 180 ServerInstance->SNO->WriteToSnoMask('x', "database: cannot read xline db \"%s\": %s (%d)", xlinedbpath.c_str(), strerror(errno), errno); 181 return false; 182 } 183 184 std::string line; 185 while (std::getline(stream, line)) 186 { 187 // Inspired by the command parser. :) 188 irc::tokenstream tokens(line); 189 int items = 0; 190 std::string command_p[7]; 191 std::string tmp; 192 193 while (tokens.GetTrailing(tmp) && (items < 7)) 194 { 195 command_p[items] = tmp; 196 items++; 197 } 198 199 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Processing %s", line.c_str()); 200 201 if (command_p[0] == "VERSION") 202 { 203 if (command_p[1] != "1") 204 { 205 stream.close(); 206 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "I got database version %s - I don't understand it", command_p[1].c_str()); 207 ServerInstance->SNO->WriteToSnoMask('x', "database: I got a database version (%s) I don't understand", command_p[1].c_str()); 208 return false; 209 } 210 } 211 else if (command_p[0] == "LINE") 212 { 213 // Mercilessly stolen from spanningtree 214 XLineFactory* xlf = ServerInstance->XLines->GetFactory(command_p[1]); 215 216 if (!xlf) 217 { 218 ServerInstance->SNO->WriteToSnoMask('x', "database: Unknown line type (%s).", command_p[1].c_str()); 219 continue; 220 } 221 222 XLine* xl = xlf->Generate(ServerInstance->Time(), ConvToNum<unsigned long>(command_p[5]), command_p[3], command_p[6], command_p[2]); 223 xl->SetCreateTime(ConvToNum<time_t>(command_p[4])); 224 225 if (ServerInstance->XLines->AddLine(xl, NULL)) 226 { 227 ServerInstance->SNO->WriteToSnoMask('x', "database: Added a line of type %s", command_p[1].c_str()); 228 } 229 else 230 delete xl; 231 } 232 } 233 stream.close(); 234 return true; 235 } 236 GetVersion()237 Version GetVersion() CXX11_OVERRIDE 238 { 239 return Version("Allows X-lines to be saved and reloaded on restart.", VF_VENDOR); 240 } 241 }; 242 243 MODULE_INIT(ModuleXLineDB) 244