From 62bfa33464df8cc413fa4f111ab62e189be0ca32 Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Sat, 8 Mar 2025 13:36:41 +0000 Subject: Rework how nickname protection works. - Rename the command and module from kill to protect (this command hasn't actually killed users in a long time). - Replace QUICK/IMMED with a duration option. --- modules/nickserv/nickserv.cpp | 32 +++--- modules/nickserv/ns_set_kill.cpp | 189 ------------------------------------ modules/nickserv/ns_set_protect.cpp | 168 ++++++++++++++++++++++++++++++++ 3 files changed, 182 insertions(+), 207 deletions(-) delete mode 100644 modules/nickserv/ns_set_kill.cpp create mode 100644 modules/nickserv/ns_set_protect.cpp (limited to 'modules/nickserv') diff --git a/modules/nickserv/nickserv.cpp b/modules/nickserv/nickserv.cpp index 7d34061c7..c09367914 100644 --- a/modules/nickserv/nickserv.cpp +++ b/modules/nickserv/nickserv.cpp @@ -211,31 +211,27 @@ public: if (Config->GetModule("nickserv").Get("nonicknameownership")) return; - if (!na->nc->HasExt("KILL_IMMED")) + if (na->nc->HasExt("PROTECT")) { - u->SendMessage(NickServ, NICK_IS_SECURE, NickServ->GetQueryCommand().c_str()); - } - if (na->nc->HasExt("KILLPROTECT")) - { - if (na->nc->HasExt("KILL_IMMED")) - { - u->SendMessage(NickServ, FORCENICKCHANGE_NOW); - this->Collide(u, na); - } - else if (na->nc->HasExt("KILL_QUICK")) + auto &block = Config->GetModule(this); + auto protectafter = na->nc->GetExt("PROTECT_AFTER"); + + auto protect = protectafter ? *protectafter : block.Get("defaultprotect", "1m"); + protect = std::clamp(protect, block.Get("minprotect", "10s"), block.Get("maxprotect", "10m")); + + if (protect) { - time_t killquick = Config->GetModule("nickserv").Get("killquick", "20s"); - u->SendMessage(NickServ, _("If you do not change within %s, I will change your nick."), Anope::Duration(killquick, u->Account()).c_str()); - new NickServCollide(this, this, u, na, killquick); + u->SendMessage(NickServ, NICK_IS_SECURE, NickServ->GetQueryCommand().c_str()); + u->SendMessage(NickServ, _("If you do not change within %s, I will change your nick."), + Anope::Duration(protect, u->Account()).c_str()); + new NickServCollide(this, this, u, na, protect); } else { - time_t kill = Config->GetModule("nickserv").Get("kill", "60s"); - u->SendMessage(NickServ, _("If you do not change within %s, I will change your nick."), Anope::Duration(kill, u->Account()).c_str()); - new NickServCollide(this, this, u, na, kill); + u->SendMessage(NickServ, FORCENICKCHANGE_NOW); + this->Collide(u, na); } } - } void OnUserLogin(User *u) override diff --git a/modules/nickserv/ns_set_kill.cpp b/modules/nickserv/ns_set_kill.cpp deleted file mode 100644 index 0338c4bb8..000000000 --- a/modules/nickserv/ns_set_kill.cpp +++ /dev/null @@ -1,189 +0,0 @@ -/* NickServ core functions - * - * (C) 2003-2025 Anope Team - * Contact us at team@anope.org - * - * Please read COPYING and README for further details. - * - * Based on the original code of Epona by Lara. - * Based on the original code of Services by Andy Church. - */ - -#include "module.h" - -class CommandNSSetKill - : public Command -{ -public: - CommandNSSetKill(Module *creator, const Anope::string &sname = "nickserv/set/kill", size_t min = 1) - : Command(creator, sname, min, min + 1) - { - this->SetDesc(_("Turn protection on or off")); - this->SetSyntax("{ON | QUICK | IMMED | OFF}"); - } - - void Run(CommandSource &source, const Anope::string &user, const Anope::string ¶m) - { - if (Anope::ReadOnly) - { - source.Reply(READ_ONLY_MODE); - return; - } - - if (Config->GetModule("nickserv").Get("nonicknameownership")) - { - source.Reply(_("This command may not be used on this network because nickname ownership is disabled.")); - return; - } - - const NickAlias *na = NickAlias::Find(user); - if (!na) - { - source.Reply(NICK_X_NOT_REGISTERED, user.c_str()); - return; - } - NickCore *nc = na->nc; - - EventReturn MOD_RESULT; - FOREACH_RESULT(OnSetNickOption, MOD_RESULT, (source, this, nc, param)); - if (MOD_RESULT == EVENT_STOP) - return; - - if (param.equals_ci("ON")) - { - nc->Extend("KILLPROTECT"); - nc->Shrink("KILL_QUICK"); - nc->Shrink("KILL_IMMED"); - Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill on for " << nc->display; - source.Reply(_("Protection is now \002on\002 for \002%s\002."), nc->display.c_str()); - } - else if (param.equals_ci("QUICK")) - { - nc->Extend("KILLPROTECT"); - nc->Extend("KILL_QUICK"); - nc->Shrink("KILL_IMMED"); - Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill quick for " << nc->display; - source.Reply(_("Protection is now \002on\002 for \002%s\002, with a reduced delay."), nc->display.c_str()); - } - else if (param.equals_ci("IMMED")) - { - if (Config->GetModule(this->owner).Get("allowkillimmed")) - { - nc->Extend("KILLPROTECT"); - nc->Shrink("KILL_QUICK"); - nc->Extend("KILL_IMMED"); - Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill immed for " << nc->display; - source.Reply(_("Protection is now \002on\002 for \002%s\002, with no delay."), nc->display.c_str()); - } - else - source.Reply(_("The \002IMMED\002 option is not available on this network.")); - } - else if (param.equals_ci("OFF")) - { - nc->Shrink("KILLPROTECT"); - nc->Shrink("KILL_QUICK"); - nc->Shrink("KILL_IMMED"); - Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to disable kill for " << nc->display; - source.Reply(_("Protection is now \002off\002 for \002%s\002."), nc->display.c_str()); - } - else - this->OnSyntaxError(source, "KILL"); - - return; - } - - void Execute(CommandSource &source, const std::vector ¶ms) override - { - this->Run(source, source.nc->display, params[0]); - } - - bool OnHelp(CommandSource &source, const Anope::string &) override - { - this->SendSyntax(source); - source.Reply(" "); - source.Reply(_("Turns the automatic protection option for your nick\n" - "on or off. With protection on, if another user\n" - "tries to take your nick, they will be given one minute to\n" - "change to another nick, after which %s will forcibly change\n" - "their nick.\n" - " \n" - "If you select \002QUICK\002, the user will be given only 20 seconds\n" - "to change nicks instead of the usual 60. If you select\n" - "\002IMMED\002, the user's nick will be changed immediately \037without\037 being\n" - "warned first or given a chance to change their nick; please\n" - "do not use this option unless necessary. Also, your\n" - "network's administrators may have disabled this option."), source.service->nick.c_str()); - return true; - } -}; - -class CommandNSSASetKill final - : public CommandNSSetKill -{ -public: - CommandNSSASetKill(Module *creator) - : CommandNSSetKill(creator, "nickserv/saset/kill", 2) - { - this->ClearSyntax(); - this->SetSyntax(_("\037nickname\037 {ON | QUICK | IMMED | OFF}")); - } - - void Execute(CommandSource &source, const std::vector ¶ms) override - { - this->Run(source, params[0], params[1]); - } - - bool OnHelp(CommandSource &source, const Anope::string &) override - { - this->SendSyntax(source); - source.Reply(" "); - source.Reply(_("Turns the automatic protection option for the nick\n" - "on or off. With protection on, if another user\n" - "tries to take the nick, they will be given one minute to\n" - "change to another nick, after which %s will forcibly change\n" - "their nick.\n" - " \n" - "If you select \002QUICK\002, the user will be given only 20 seconds\n" - "to change nicks instead of the usual 60. If you select\n" - "\002IMMED\002, the user's nick will be changed immediately \037without\037 being\n" - "warned first or given a chance to change their nick; please\n" - "do not use this option unless necessary. Also, your\n" - "network's administrators may have disabled this option."), source.service->nick.c_str()); - return true; - } -}; - -class NSSetKill final - : public Module -{ -private: - CommandNSSetKill commandnssetkill; - CommandNSSASetKill commandnssasetkill; - SerializableExtensibleItem killprotect, kill_quick, kill_immed; - -public: - NSSetKill(const Anope::string &modname, const Anope::string &creator) - : Module(modname, creator, VENDOR) - , commandnssetkill(this) - , commandnssasetkill(this) - , killprotect(this, "KILLPROTECT") - , kill_quick(this, "KILL_QUICK") - , kill_immed(this, "KILL_IMMED") - { - } - - void OnNickInfo(CommandSource &source, NickAlias *na, InfoFormatter &info, bool show_hidden) override - { - if (!show_hidden) - return; - - if (kill_immed.HasExt(na->nc)) - info.AddOption(_("Immediate protection")); - else if (kill_quick.HasExt(na->nc)) - info.AddOption(_("Quick protection")); - else if (killprotect.HasExt(na->nc)) - info.AddOption(_("Protection")); - } -}; - -MODULE_INIT(NSSetKill) diff --git a/modules/nickserv/ns_set_protect.cpp b/modules/nickserv/ns_set_protect.cpp new file mode 100644 index 000000000..12c995486 --- /dev/null +++ b/modules/nickserv/ns_set_protect.cpp @@ -0,0 +1,168 @@ +/* NickServ core functions + * + * (C) 2003-2025 Anope Team + * Contact us at team@anope.org + * + * Please read COPYING and README for further details. + * + * Based on the original code of Epona by Lara. + * Based on the original code of Services by Andy Church. + */ + +#include "module.h" + +class CommandNSSetProtect + : public Command +{ +public: + CommandNSSetProtect(Module *creator, const Anope::string &sname = "nickserv/set/protect", size_t min = 1) + : Command(creator, sname, min, min + 1) + { + this->SetDesc(_("Turn protection on or off")); + this->SetSyntax(_("{ON | \037delay\037 | OFF}")); + } + + void Run(CommandSource &source, const Anope::string &user, const Anope::string ¶m) + { + if (Anope::ReadOnly) + { + source.Reply(READ_ONLY_MODE); + return; + } + + if (Config->GetModule("nickserv").Get("nonicknameownership")) + { + source.Reply(_("This command may not be used on this network because nickname ownership is disabled.")); + return; + } + + const auto *na = NickAlias::Find(user); + if (!na) + { + source.Reply(NICK_X_NOT_REGISTERED, user.c_str()); + return; + } + NickCore *nc = na->nc; + + EventReturn MOD_RESULT; + FOREACH_RESULT(OnSetNickOption, MOD_RESULT, (source, this, nc, param)); + if (MOD_RESULT == EVENT_STOP) + return; + + if (param.equals_ci("ON")) + { + nc->Extend("PROTECT"); + nc->Shrink("PROTECT_AFTER"); + Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to enable protection for " << nc->display; + source.Reply(_("Protection is now \002on\002 for \002%s\002."), nc->display.c_str()); + } + else if (param.equals_ci("OFF")) + { + nc->Shrink("PROTECT"); + nc->Shrink("PROTECT_AFTER"); + Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to disable protection for " << nc->display; + source.Reply(_("Protection is now \002off\002 for \002%s\002."), nc->display.c_str()); + } + else + { + auto iparam = Anope::TryConvert(param); + if (!iparam) + { + this->OnSyntaxError(source, "PROTECT"); + return; + } + + auto &block = Config->GetModule("nickserv"); + auto minprotect = block.Get("minprotect", "10s"); + auto maxprotect = block.Get("maxprotect", "10m"); + if (*iparam < minprotect || *iparam > maxprotect) + { + source.Reply(_("Protection delay must be between %s and %s."), + Anope::Duration(minprotect, source.GetAccount()).c_str(), + Anope::Duration(maxprotect, source.GetAccount()).c_str()); + return; + } + + nc->Extend("PROTECT"); + nc->Extend("PROTECT_AFTER", *iparam); + Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to enable protection after " << *iparam << " seconds for " << nc->display; + source.Reply(_("Protection is now \002on\002 after \002%lu seconds\002 for \002%s\002."), *iparam, nc->display.c_str()); + } + } + + void Execute(CommandSource &source, const std::vector ¶ms) override + { + this->Run(source, source.nc->display, params[0]); + } + + bool OnHelp(CommandSource &source, const Anope::string &) override + { + this->SendSyntax(source); + source.Reply(" "); + source.Reply(_("Turns automatic protection for your account on or off. With\n" + "protection on if another user tries to use a nickname from\n" + "your group they will be given some time to change their nick\n" + "after which %s will forcibly change their nick."), source.service->nick.c_str()); + return true; + } +}; + +class CommandNSSASetProtect final + : public CommandNSSetProtect +{ +public: + CommandNSSASetProtect(Module *creator) + : CommandNSSetProtect(creator, "nickserv/saset/protect", 2) + { + this->ClearSyntax(); + this->SetSyntax(_("\037nickname\037 {ON | \037delay\037 | OFF}")); + } + + void Execute(CommandSource &source, const std::vector ¶ms) override + { + this->Run(source, params[0], params[1]); + } + + bool OnHelp(CommandSource &source, const Anope::string &) override + { + this->SendSyntax(source); + source.Reply(" "); + source.Reply(_("Turns automatic protection for the nick on or off. With\n" + "protection on if a user tries to use a nickname from the\n" + "nick's group they will be given some time to change their\n" + "nick after which %s will forcibly change their nick."), source.service->nick.c_str()); + return true; + } +}; + +class NSSetProtect final + : public Module +{ +private: + CommandNSSetProtect commandnssetprotect; + CommandNSSASetProtect commandnssasetprotect; + + SerializableExtensibleItem protect; + SerializableExtensibleItem protectafter; + +public: + NSSetProtect(const Anope::string &modname, const Anope::string &creator) + : Module(modname, creator, VENDOR) + , commandnssetprotect(this) + , commandnssasetprotect(this) + , protect(this, "PROTECT") + , protectafter(this, "PROTECT_AFTER") + { + } + + void OnNickInfo(CommandSource &source, NickAlias *na, InfoFormatter &info, bool show_hidden) override + { + if (!show_hidden) + return; + + if (protect.HasExt(na->nc)) + info.AddOption(_("Protection")); + } +}; + +MODULE_INIT(NSSetProtect) -- cgit