From 3dd446de4155227d423e83628a10195e46b385aa Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Tue, 7 Jan 2020 16:55:25 +0000 Subject: Add a replacement for the nationalchars module. --- docs/conf/codepages/ascii.conf.example | 37 +++++ docs/conf/codepages/latin1.conf.example | 42 +++++ docs/conf/codepages/rfc1459.conf.example | 41 +++++ docs/conf/codepages/strict-rfc1459.conf.example | 40 +++++ docs/conf/modules.conf.example | 17 ++ make/template/main.mk | 2 + src/modules/m_codepage.cpp | 212 ++++++++++++++++++++++++ 7 files changed, 391 insertions(+) create mode 100644 docs/conf/codepages/ascii.conf.example create mode 100644 docs/conf/codepages/latin1.conf.example create mode 100644 docs/conf/codepages/rfc1459.conf.example create mode 100644 docs/conf/codepages/strict-rfc1459.conf.example create mode 100644 src/modules/m_codepage.cpp diff --git a/docs/conf/codepages/ascii.conf.example b/docs/conf/codepages/ascii.conf.example new file mode 100644 index 000000000..7c5ecdd85 --- /dev/null +++ b/docs/conf/codepages/ascii.conf.example @@ -0,0 +1,37 @@ +# This file contains ASCII codepage rules for use with the codepage module. + + + + # - + # 01234567899 + # ABCDEFGHIJKLMNOPQRSTUVWXYZ + # [\]^_` + # abcdefghijklmnopqrstuvwxyz + # {|} + + # a => A + # b => B + # c => C + # d => D + # e => E + # f => F + # g => G + # h => H + # i => I + # j => J + # k => K + # l => L + # m => M + # n => N + # o => O + # p => P + # q => Q + # r => R + # s => S + # t => T + # u => U + # v => V + # w => W + # x => X + # y => Y + # z => Z diff --git a/docs/conf/codepages/latin1.conf.example b/docs/conf/codepages/latin1.conf.example new file mode 100644 index 000000000..3beb002fd --- /dev/null +++ b/docs/conf/codepages/latin1.conf.example @@ -0,0 +1,42 @@ +# This file contains ISO 8859-1 codepage rules for use with the codepage module. + + + + # ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ + # ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö + # øùúûüýþÿ + + # ß => S + # à => À + # á => Á + # â => Â + # ã => Ã + # ä => Ä + # å => Å + # æ => Æ + # ç => Ç + # è => È + # é => É + # ê => Ê + # ë => Ë + # ì => Ì + # í => Í + # î => Î + # ï => Ï + # ð => Ð + # ñ => Ñ + # ò => Ò + # ó => Ó + # ô => Ô + # õ => Õ + # ö => Ö + # ø => Ø + # ù => Ù + # ú => Ú + # û => Û + # ü => Ü + # ý => Ý + # þ => Þ + +# Include the ASCII rules to avoid duplication. + diff --git a/docs/conf/codepages/rfc1459.conf.example b/docs/conf/codepages/rfc1459.conf.example new file mode 100644 index 000000000..32f453044 --- /dev/null +++ b/docs/conf/codepages/rfc1459.conf.example @@ -0,0 +1,41 @@ +# This file contains RFC 1459 codepage rules for use with the codepage module. + + + + # - + # 01234567899 + # ABCDEFGHIJKLMNOPQRSTUVWXYZ + # [\]^_` + # abcdefghijklmnopqrstuvwxyz + # {|} + + # a => A + # b => B + # c => C + # d => D + # e => E + # f => F + # g => G + # h => H + # i => I + # j => J + # k => K + # l => L + # m => M + # n => N + # o => O + # p => P + # q => Q + # r => R + # s => S + # t => T + # u => U + # v => V + # w => W + # x => X + # y => Y + # z => Z + # { => [ + # | => \ + # } => ] + # ~ => ^ diff --git a/docs/conf/codepages/strict-rfc1459.conf.example b/docs/conf/codepages/strict-rfc1459.conf.example new file mode 100644 index 000000000..b14e477e8 --- /dev/null +++ b/docs/conf/codepages/strict-rfc1459.conf.example @@ -0,0 +1,40 @@ +# This file contains strict RFC 1459 codepage rules for use with the codepage module. + + + + # - + # 01234567899 + # ABCDEFGHIJKLMNOPQRSTUVWXYZ + # [\]^_` + # abcdefghijklmnopqrstuvwxyz + # {|} + + # a => A + # b => B + # c => C + # d => D + # e => E + # f => F + # g => G + # h => H + # i => I + # j => J + # k => K + # l => L + # m => M + # n => N + # o => O + # p => P + # q => Q + # r => R + # s => S + # t => T + # u => U + # v => V + # w => W + # x => X + # y => Y + # z => Z + # { => [ + # | => \ + # } => ] diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 215f66137..29adff840 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -571,6 +571,20 @@ # To use, CLONES must be in one of your oper class blocks. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Codepage module: Allows using a custom 8-bit codepage for nicknames +# and case mapping. +# +# You should include one of the following files to set your codepage: +# +# +# +# +# +# You can also define a custom codepage. For details on how to do this +# please refer to the docs site: +# https://docs.inspircd.org/3/modules/codepage + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Common channels module: Adds user mode +c, which, when set, requires # that users must share a common channel with you to PRIVMSG or NOTICE @@ -1414,6 +1428,9 @@ # National characters module: # 1) Allows using national characters in nicknames. # 2) Allows using custom (national) casemapping over the network. +# +# This module is incredibly poorly written and documented. You should +# probably use the codepage module instead for 8-bit codepages. # # # file - Location of the file which contains casemapping rules. If this diff --git a/make/template/main.mk b/make/template/main.mk index 1e6ba5cd0..f71852aa5 100644 --- a/make/template/main.mk +++ b/make/template/main.mk @@ -210,6 +210,7 @@ install: target @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(BINPATH) @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(CONPATH) @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(DATPATH) + @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(EXAPATH)/codepages @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(EXAPATH)/providers @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(EXAPATH)/services @-$(INSTALL) -d -g @GID@ -o @UID@ -m $(INSTMODE_DIR) $(EXAPATH)/sql @@ -230,6 +231,7 @@ endif -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) @CONFIGURE_DIRECTORY@/inspircd-genssl.1 $(MANPATH) 2>/dev/null -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_BIN) tools/genssl $(BINPATH)/inspircd-genssl 2>/dev/null -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/conf/*.example $(EXAPATH) + -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/conf/codepages/*.example $(EXAPATH)/codepages -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/conf/providers/*.example $(EXAPATH)/providers -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/conf/services/*.example $(EXAPATH)/services -$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/sql/*.sql $(EXAPATH)/sql diff --git a/src/modules/m_codepage.cpp b/src/modules/m_codepage.cpp new file mode 100644 index 000000000..1c3ac02da --- /dev/null +++ b/src/modules/m_codepage.cpp @@ -0,0 +1,212 @@ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2020 Sadie Powell + * Copyright (C) 2014 Googolplexed + * + * 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 . + */ + + +#include "inspircd.h" + +typedef std::bitset AllowedChars; + +namespace +{ + // The characters which are allowed in nicknames. + AllowedChars allowedchars; + + // The characters which are allowed at the front of a nickname. + AllowedChars allowedfrontchars; + + // The mapping of lower case characters to upper case characters. + unsigned char casemap[UCHAR_MAX]; + + bool IsValidNick(const std::string& nick) + { + if (nick.empty() || nick.length() > ServerInstance->Config->Limits.NickMax) + return false; + + for (std::string::const_iterator iter = nick.begin(); iter != nick.end(); ++iter) + { + unsigned char chr = static_cast(*iter); + + // Check that the character is allowed at the front of the nick. + if (iter == nick.begin() && !allowedfrontchars[chr]) + return false; + + // Check that the character is allowed in the nick. + if (!allowedchars[chr]) + return false; + } + + return true; + } +} + +class ModuleCodepage + : public Module +{ + private: + // The character map which was set before this module was loaded. + const unsigned char* origcasemap; + + // The IsNick handler which was set before this module was loaded. + TR1NS::function origisnick; + + template + void RehashHashmap(T& hashmap) + { + T newhash(hashmap.bucket_count()); + for (typename T::const_iterator i = hashmap.begin(); i != hashmap.end(); ++i) + newhash.insert(std::make_pair(i->first, i->second)); + hashmap.swap(newhash); + } + + void CheckInvalidNick() + { + const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers(); + for (UserManager::LocalList::const_iterator iter = list.begin(); iter != list.end(); ++iter) + { + LocalUser* user = *iter; + if (user->nick != user->uuid && !ServerInstance->IsNick(user->nick)) + user->ChangeNick(user->uuid); + } + } + + void CheckRehash(unsigned char* prevmap) + { + if (!memcmp(prevmap, national_case_insensitive_map, sizeof(origcasemap))) + return; + + RehashHashmap(ServerInstance->Users.clientlist); + RehashHashmap(ServerInstance->Users.uuidlist); + RehashHashmap(ServerInstance->chanlist); + } + + public: + ModuleCodepage() + : origcasemap(national_case_insensitive_map) + , origisnick(ServerInstance->IsNick) + { + } + + ~ModuleCodepage() + { + ServerInstance->IsNick = origisnick; + CheckInvalidNick(); + + national_case_insensitive_map = origcasemap; + CheckRehash(casemap); + } + + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE + { + const std::string name = ServerInstance->Config->ConfValue("codepage")->getString("name"); + if (name.empty()) + throw ModuleException(" is a required field!"); + + AllowedChars newallowedchars; + AllowedChars newallowedfrontchars; + ConfigTagList cpchars = ServerInstance->Config->ConfTags("cpchars"); + for (ConfigIter i = cpchars.first; i != cpchars.second; ++i) + { + ConfigTag* tag = i->second; + + unsigned char begin = tag->getUInt("begin", tag->getUInt("index", 0), 1, UCHAR_MAX); + if (!begin) + throw ModuleException(" tag without index or begin specified at " + tag->getTagLocation()); + + unsigned char end = tag->getUInt("end", begin, 1, UCHAR_MAX); + if (begin > end) + throw ModuleException(" must be lower than at " + tag->getTagLocation()); + + bool front = tag->getBool("front", false); + for (unsigned short pos = begin; pos <= end; ++pos) + { + if (pos == '\n' || pos == '\r' || pos == ' ') + { + throw ModuleException(InspIRCd::Format(" tag contains a forbidden character: %u at %s", + pos, tag->getTagLocation().c_str())); + } + + if (front && (pos == ':' || isdigit(pos))) + { + throw ModuleException(InspIRCd::Format(" tag contains a forbidden front character: %u at %s", + pos, tag->getTagLocation().c_str())); + } + + newallowedchars.set(pos); + newallowedfrontchars.set(pos, front); + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Marked %u (%c) as allowed (front: %s)", + pos, pos, front ? "yes" : "no"); + } + } + + unsigned char newcasemap[UCHAR_MAX]; + for (size_t i = 0; i < UCHAR_MAX; ++i) + newcasemap[i] = i; + ConfigTagList cpcase = ServerInstance->Config->ConfTags("cpcase"); + for (ConfigIter i = cpcase.first; i != cpcase.second; ++i) + { + ConfigTag* tag = i->second; + + unsigned char lower = tag->getUInt("lower", 0, 1, UCHAR_MAX); + if (!lower) + throw ModuleException(" is required at " + tag->getTagLocation()); + + unsigned char upper = tag->getUInt("upper", 0, 1, UCHAR_MAX); + if (!upper) + throw ModuleException(" is required at " + tag->getTagLocation()); + + newcasemap[upper] = lower; + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Marked %u (%c) as the lower case version of %u (%c)", + lower, lower, upper, upper); + } + + std::swap(allowedchars, newallowedchars); + std::swap(allowedfrontchars, newallowedfrontchars); + std::swap(casemap, newcasemap); + + ServerInstance->IsNick = &IsValidNick; + CheckInvalidNick(); + + ServerInstance->Config->CaseMapping = name; + national_case_insensitive_map = casemap; + CheckRehash(newcasemap); + } + + Version GetVersion() CXX11_OVERRIDE + { + std::stringstream linkdata; + + linkdata << "front="; + for (size_t i = 0; i < allowedfrontchars.size(); ++i) + if (allowedfrontchars[i]) + linkdata << static_cast(i); + + linkdata << "&middle="; + for (size_t i = 0; i < allowedchars.size(); ++i) + if (allowedchars[i]) + linkdata << static_cast(i); + + linkdata << "&map="; + for (size_t i = 0; i < sizeof(casemap); ++i) + if (casemap[i] != i) + linkdata << static_cast(i) << casemap[i] << ','; + + return Version("Provides support for custom 8-bit codepages", VF_COMMON | VF_VENDOR, linkdata.str()); + } +}; +MODULE_INIT(ModuleCodepage) -- cgit v1.2.3