2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019-2021 Sadie Powell <sadie@witchery.services>
5 * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
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/>.
20 /// $CompilerFlags: require_version("libmaxminddb" "0" "1.2.1") warning("The version of libmaxminddb you are using may cause a segmentation fault if given a corrupt database file!")
21 /// $CompilerFlags: find_compiler_flags("libmaxminddb" "")
23 /// $LinkerFlags: find_linker_flags("libmaxminddb" "-lmaxminddb")
25 /// $PackageInfo: require_system("arch") libmaxminddb pkgconf
26 /// $PackageInfo: require_system("darwin") libmaxminddb pkg-config
27 /// $PackageInfo: require_system("debian" "9.0") libmaxminddb-dev pkg-config
28 /// $PackageInfo: require_system("ubuntu" "16.04") libmaxminddb-dev pkg-config
31 # pragma comment(lib, "libmaxminddb.lib")
35 #include "modules/geolocation.h"
36 #include <maxminddb.h>
38 class GeolocationExtItem : public ExtensionItem
41 GeolocationExtItem(Module* parent)
42 : ExtensionItem("geolocation", ExtensionItem::EXT_USER, parent)
46 std::string ToHuman(const Extensible* container, void* item) const CXX11_OVERRIDE
48 Geolocation::Location* location = static_cast<Geolocation::Location*>(item);
49 return location->GetName() + " [" + location->GetCode() + "]";
52 void free(Extensible* container, void* item) CXX11_OVERRIDE
54 Geolocation::Location* old = static_cast<Geolocation::Location*>(item);
59 Geolocation::Location* get(const Extensible* item) const
61 return static_cast<Geolocation::Location*>(get_raw(item));
64 void set(Extensible* item, Geolocation::Location* value)
66 value->refcount_inc();
67 free(item, set_raw(item, value));
70 void unset(Extensible* container)
72 free(container, unset_raw(container));
76 typedef insp::flat_map<std::string, Geolocation::Location*> LocationMap;
78 class GeolocationAPIImpl : public Geolocation::APIBase
81 GeolocationExtItem ext;
82 LocationMap locations;
85 GeolocationAPIImpl(Module* parent)
86 : Geolocation::APIBase(parent)
91 Geolocation::Location* GetLocation(User* user) CXX11_OVERRIDE
93 // If we have the location cached then use that instead.
94 Geolocation::Location* location = ext.get(user);
98 // Attempt to locate this user.
99 location = GetLocation(user->client_sa);
103 // We found the user. Cache their location for future use.
104 ext.set(user, location);
108 Geolocation::Location* GetLocation(irc::sockets::sockaddrs& sa) CXX11_OVERRIDE
110 // Skip trying to look up a UNIX socket.
111 if (sa.family() != AF_INET && sa.family() != AF_INET6)
114 // Attempt to look up the socket address.
116 MMDB_lookup_result_s lookup = MMDB_lookup_sockaddr(&mmdb, &sa.sa, &result);
117 if (result != MMDB_SUCCESS || !lookup.found_entry)
120 // Attempt to retrieve the country code.
121 MMDB_entry_data_s country_code;
122 result = MMDB_get_value(&lookup.entry, &country_code, "country", "iso_code", NULL);
123 if (result != MMDB_SUCCESS || !country_code.has_data || country_code.type != MMDB_DATA_TYPE_UTF8_STRING || country_code.data_size != 2)
126 // If the country has been seen before then use our cached Location object.
127 const std::string code(country_code.utf8_string, country_code.data_size);
128 LocationMap::iterator liter = locations.find(code);
129 if (liter != locations.end())
130 return liter->second;
132 // Attempt to retrieve the country name.
133 MMDB_entry_data_s country_name;
134 result = MMDB_get_value(&lookup.entry, &country_name, "country", "names", "en", NULL);
135 if (result != MMDB_SUCCESS || !country_name.has_data || country_name.type != MMDB_DATA_TYPE_UTF8_STRING)
138 // Create a Location object and cache it.
139 const std::string cname(country_name.utf8_string, country_name.data_size);
140 Geolocation::Location* location = new Geolocation::Location(code, cname);
141 locations[code] = location;
146 class ModuleGeoMaxMind : public Module
149 GeolocationAPIImpl geoapi;
155 memset(&geoapi.mmdb, 0, sizeof(geoapi.mmdb));
160 MMDB_close(&geoapi.mmdb);
163 Version GetVersion() CXX11_OVERRIDE
165 return Version("Allows the server to perform geolocation lookups on both IP addresses and users.", VF_VENDOR);
168 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
170 ConfigTag* tag = ServerInstance->Config->ConfValue("maxmind");
171 const std::string file = ServerInstance->Config->Paths.PrependConfig(tag->getString("file", "GeoLite2-Country.mmdb", 1));
173 // Try to read the new database.
175 int result = MMDB_open(file.c_str(), MMDB_MODE_MMAP, &mmdb);
176 if (result != MMDB_SUCCESS)
177 throw ModuleException(InspIRCd::Format("Unable to load the MaxMind database (%s): %s",
178 file.c_str(), MMDB_strerror(result)));
180 // Swap the new database with the old database.
181 std::swap(mmdb, geoapi.mmdb);
183 // Free the old database.
187 void OnGarbageCollect() CXX11_OVERRIDE
189 for (LocationMap::iterator iter = geoapi.locations.begin(); iter != geoapi.locations.end(); )
191 Geolocation::Location* location = iter->second;
192 if (location->GetUseCount())
194 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Preserving geolocation data for %s (%s) with use count %u... ",
195 location->GetName().c_str(), location->GetCode().c_str(), location->GetUseCount());
200 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Deleting unused geolocation data for %s (%s)",
201 location->GetName().c_str(), location->GetCode().c_str());
203 iter = geoapi.locations.erase(iter);
208 void OnSetUserIP(LocalUser* user) CXX11_OVERRIDE
210 // Unset the extension so that the location of this user is looked
211 // up again next time it is requested.
212 geoapi.ext.unset(user);
216 MODULE_INIT(ModuleGeoMaxMind)