1
0
mirror of https://github.com/anope/anope.git synced 2026-06-12 17:04:47 +02:00
Files
anope/modules/chanserv/cs_xop.cpp
T

719 lines
18 KiB
C++

// Anope IRC Services <https://www.anope.org/>
//
// Copyright (C) 2003-2026 Anope Contributors
//
// Anope is free software. You can use, modify, and/or distribute it under the
// terms of version 2 of the GNU General Public License. See docs/LICENSE.txt
// for the complete terms of this license and docs/AUTHORS.txt for a list of
// contributors.
//
// Based on the original code of Epona by Lara
// Based on the original code of Services by Andy Church
//
// SPDX-License-Identifier: GPL-2.0-only
#include "module.h"
namespace
{
std::vector<Anope::string> order;
std::map<Anope::string, std::vector<Anope::string> > permissions;
}
class XOPChanAccess final
: public ChanAccess
{
public:
Anope::string type;
XOPChanAccess(AccessProvider *p) : ChanAccess(p)
{
}
bool HasPriv(const Anope::string &priv) const override
{
for (auto it = std::find(order.begin(), order.end(), this->type); it != order.end(); ++it)
{
const std::vector<Anope::string> &privs = permissions[*it];
if (std::find(privs.begin(), privs.end(), priv) != privs.end())
return true;
}
return false;
}
Anope::string AccessSerialize() const override
{
return this->type;
}
void AccessUnserialize(const Anope::string &data) override
{
this->type = data;
}
static Anope::string DetermineLevel(const ChanAccess *access)
{
if (access->provider->name == "access/xop")
{
const auto *xaccess = anope_dynamic_static_cast<const XOPChanAccess *>(access);
return xaccess->type;
}
else
{
std::map<Anope::string, int> count;
for (const auto &[name, perms] : permissions)
{
int &c = count[name];
for (const auto &perm : perms)
{
if (access->HasPriv(perm))
++c;
}
}
Anope::string maxname;
int maxpriv = 0;
for (const auto &[name, priv] : count)
{
if (priv > maxpriv)
{
maxname = name;
maxpriv = priv;
}
}
return maxname;
}
}
};
class XOPAccessProvider final
: public AccessProvider
{
public:
XOPAccessProvider(Module *o) : AccessProvider(o, "access/xop")
{
}
ChanAccess *Create() override
{
return new XOPChanAccess(this);
}
void GetAccess(CommandSource& source, const Privilege *p, Anope::map<Anope::string> &access) override
{
for (const auto& xop : order)
{
const auto &privs = permissions[xop];
if (std::find(privs.begin(), privs.end(), p->name) != privs.end())
{
access[_("XOP")] = xop;
return;
}
}
}
};
class CommandCSXOP final
: public Command
{
private:
void DoAdd(CommandSource &source, ChannelInfo *ci, const std::vector<Anope::string> &params)
{
Anope::string mask = params.size() > 2 ? params[2] : "";
Anope::string description = params.size() > 3 ? params[3] : "";
if (mask.empty())
{
this->OnSyntaxError(source, "ADD");
return;
}
if (Anope::ReadOnly)
{
source.Reply(READ_ONLY_MODE);
return;
}
AccessGroup access = source.AccessFor(ci);
const ChanAccess *highest = access.Highest();
bool override = false;
const NickAlias *na = NULL;
auto cmd_it = std::find(order.begin(), order.end(), source.command.upper()),
access_it = highest ? std::find(order.begin(), order.end(), XOPChanAccess::DetermineLevel(highest)) : order.end();
if (!access.founder && (!access.HasPriv("ACCESS_CHANGE") || cmd_it <= access_it))
{
if (source.HasPriv("chanserv/access/modify"))
override = true;
else
{
source.Reply(ACCESS_DENIED);
return;
}
}
const auto &csconf = Config->GetModule("chanserv");
if (IRCD->IsChannelValid(mask))
{
if (csconf.Get<bool>("disallow_channel_access"))
{
source.Reply(_("Channels may not be on access lists."));
return;
}
ChannelInfo *targ_ci = ChannelInfo::Find(mask);
if (targ_ci == NULL)
{
source.Reply(CHAN_X_NOT_REGISTERED, mask.c_str());
return;
}
else if (ci == targ_ci)
{
source.Reply(_("You can't add a channel to its own access list."));
return;
}
mask = targ_ci->name;
}
else
{
na = NickAlias::Find(mask);
if (na)
{
if (na->nc->HasExt("NEVEROP"))
{
source.Reply(_("\002%s\002 does not wish to be added to channel access lists."),
na->nc->display.c_str());
return;
}
mask = na->nick;
}
else
{
if (csconf.Get<bool>("disallow_hostmask_access"))
{
source.Reply(_("Masks and unregistered users may not be on access lists."));
return;
}
if (mask.find_first_of("!*@") == Anope::string::npos)
{
auto *targ = User::Find(mask, true);
if (!targ)
{
source.Reply(NICK_X_NOT_IN_USE, mask.c_str());
return;
}
auto *targnc = targ->Account();
if (!targnc)
{
source.Reply(NICK_X_NOT_REGISTERED, targ->nick.c_str());
return;
}
mask = targnc->display;
if (description.empty())
description = targ->nick;
}
else
{
// Normalize the entry mask.
const auto cleanmask = Entry(mask).GetCleanMask();
if (csconf.Get<bool>("disallow_malformed_hostmask") && cleanmask != mask)
{
source.Reply(CHAN_ACCESS_MALFORMED, cleanmask.c_str());
return;
}
mask = cleanmask;
}
}
}
for (unsigned i = 0; i < ci->GetAccessCount(); ++i)
{
const ChanAccess *a = ci->GetAccess(i);
if ((na && na->nc == a->GetAccount()) || mask.equals_ci(a->Mask()))
{
if ((!highest || *a >= *highest) && !access.founder && !source.HasPriv("chanserv/access/modify"))
{
source.Reply(ACCESS_DENIED);
return;
}
delete ci->EraseAccess(i);
break;
}
}
const auto access_count = ci->GetDeepAccessCount();
const auto access_max = Config->GetModule("chanserv").Get<unsigned>("accessmax", "1000");
if (access_max && access_count >= access_max)
{
if (access_count == ci->GetAccessCount())
source.Reply(access_max, CHAN_ACCESS_LIMIT, access_max);
else
source.Reply(access_max, CHAN_ACCESS_LIMIT_DEEP, access_max);
return;
}
ServiceReference<AccessProvider> provider("AccessProvider", "access/xop");
if (!provider)
return;
auto *acc = anope_dynamic_static_cast<XOPChanAccess *>(provider->Create());
acc->SetMask(mask, ci);
acc->creator = source.GetNick();
acc->description = description;
acc->type = source.command.upper();
acc->last_seen = 0;
acc->created = Anope::CurTime;
ci->AddAccess(acc);
Log(override ? LOG_OVERRIDE : LOG_COMMAND, source, this, ci) << "to add " << mask;
FOREACH_MOD(OnAccessAdd, (ci, source, acc, false));
source.Reply(_("\002%s\002 added to %s %s list."), acc->Mask().c_str(), ci->name.c_str(), source.command.nobreak().c_str());
}
void DoDel(CommandSource &source, ChannelInfo *ci, const std::vector<Anope::string> &params)
{
NickCore *nc = source.nc;
Anope::string mask = params.size() > 2 ? params[2] : "";
if (mask.empty())
{
this->OnSyntaxError(source, "DEL");
return;
}
if (Anope::ReadOnly)
{
source.Reply(READ_ONLY_MODE);
return;
}
if (!ci->GetAccessCount())
{
source.Reply(_("%s %s list is empty."), ci->name.c_str(), source.command.nobreak().c_str());
return;
}
AccessGroup access = source.AccessFor(ci);
const ChanAccess *highest = access.Highest();
bool override = false;
const NickAlias *na = NickAlias::Find(mask);
if (na && na->nc)
{
mask = na->nc->display;
}
else if (!isdigit(mask[0]) && mask.find_first_of("#!*@") == Anope::string::npos)
{
User *targ = User::Find(mask, true);
if (targ != NULL)
mask = "*!*@" + targ->GetDisplayedHost();
else
{
source.Reply(NICK_X_NOT_REGISTERED, mask.c_str());
return;
}
}
auto cmd_it = std::find(order.begin(), order.end(), source.command.upper()),
access_it = highest ? std::find(order.begin(), order.end(), XOPChanAccess::DetermineLevel(highest)) : order.end();
if (!mask.equals_ci(nc->display) && !access.founder && (!access.HasPriv("ACCESS_CHANGE") || cmd_it <= access_it))
{
if (source.HasPriv("chanserv/access/modify"))
override = true;
else
{
source.Reply(ACCESS_DENIED);
return;
}
}
/* Special case: is it a number/list? Only do search if it isn't. */
if (isdigit(mask[0]) && mask.find_first_not_of("1234567890,-") == Anope::string::npos)
{
class XOPDelCallback final
: public NumberList
{
CommandSource &source;
ChannelInfo *ci;
Command *c;
unsigned deleted = 0;
Anope::string nicks;
bool override;
public:
XOPDelCallback(CommandSource &_source, ChannelInfo *_ci, Command *_c, bool _override, const Anope::string &numlist) : NumberList(numlist, true), source(_source), ci(_ci), c(_c), override(_override)
{
}
~XOPDelCallback() override
{
if (!deleted)
source.Reply(_("No matching entries on %s %s list."), ci->name.c_str(), source.command.nobreak().c_str());
else
{
Log(override ? LOG_OVERRIDE : LOG_COMMAND, source, c, ci) << "to delete " << nicks;
if (deleted == 1)
source.Reply(_("Deleted %s from %s %s list."), nicks.c_str(), ci->name.c_str(), source.command.nobreak().c_str());
else
source.Reply(deleted, N_("Deleted %d entry from %s %s list.", "Deleted %d entries from %s %s list."), deleted, ci->name.c_str(), source.command.nobreak().c_str());
}
}
void HandleNumber(unsigned number) override
{
if (!number || number > ci->GetAccessCount())
return;
ChanAccess *caccess = ci->GetAccess(number - 1);
if (caccess->provider->name != "access/xop" || this->source.command.upper() != caccess->AccessSerialize())
return;
++deleted;
if (!nicks.empty())
nicks += ", ";
nicks += caccess->Mask();
ci->EraseAccess(number - 1);
FOREACH_MOD(OnAccessDel, (ci, source, caccess, false));
delete caccess;
}
}
delcallback(source, ci, this, override, mask);
delcallback.Process();
}
else
{
for (unsigned i = 0; i < ci->GetAccessCount(); ++i)
{
ChanAccess *a = ci->GetAccess(i);
if (a->provider->name != "access/xop" || source.command.upper() != a->AccessSerialize())
continue;
if (a->Mask().equals_ci(mask))
{
Log(override ? LOG_OVERRIDE : LOG_COMMAND, source, this, ci) << "to delete " << a->Mask();
source.Reply(_("\002%s\002 deleted from %s %s list."), a->Mask().c_str(), ci->name.c_str(), source.command.nobreak().c_str());
ci->EraseAccess(i);
FOREACH_MOD(OnAccessDel, (ci, source, a, false));
delete a;
return;
}
}
source.Reply(_("\002%s\002 not found on %s %s list."), mask.c_str(), ci->name.c_str(), source.command.nobreak().c_str());
}
}
void DoList(CommandSource &source, ChannelInfo *ci, const std::vector<Anope::string> &params)
{
const Anope::string &nick = params.size() > 2 ? params[2] : "";
AccessGroup access = source.AccessFor(ci);
if (!access.HasPriv("ACCESS_LIST") && !source.HasPriv("chanserv/access/list"))
{
source.Reply(ACCESS_DENIED);
return;
}
if (!ci->GetAccessCount())
{
source.Reply(_("%s %s list is empty."), ci->name.c_str(), source.command.nobreak().c_str());
return;
}
ListFormatter list(source.GetAccount());
list.AddColumn(_("Number")).AddColumn(_("Mask")).AddColumn(_("Description"));
list.SetFlexible([](ListFormatter::ListEntry &row)
{
return row["Description"].empty()
? _("{number}: \002{mask}\002")
: _("{number}: \002{mask}\002 ({description})");
});
if (!nick.empty() && nick.find_first_not_of("1234567890,-") == Anope::string::npos)
{
class XOPListCallback final
: public NumberList
{
ListFormatter &list;
ChannelInfo *ci;
CommandSource &source;
public:
XOPListCallback(ListFormatter &_list, ChannelInfo *_ci, const Anope::string &numlist, CommandSource &src) : NumberList(numlist, false), list(_list), ci(_ci), source(src)
{
}
void HandleNumber(unsigned Number) override
{
if (!Number || Number > ci->GetAccessCount())
return;
const ChanAccess *a = ci->GetAccess(Number - 1);
if (a->provider->name != "access/xop" || this->source.command.upper() != a->AccessSerialize())
return;
ListFormatter::ListEntry entry;
entry["Number"] = Anope::ToString(Number);
entry["Mask"] = a->Mask();
entry["Description"] = a->description;
this->list.AddEntry(entry);
}
} nl_list(list, ci, nick, source);
nl_list.Process();
}
else
{
for (unsigned i = 0, end = ci->GetAccessCount(); i < end; ++i)
{
const ChanAccess *a = ci->GetAccess(i);
if (a->provider->name != "access/xop" || source.command.upper() != a->AccessSerialize())
continue;
else if (!nick.empty() && !Anope::Match(a->Mask(), nick))
continue;
ListFormatter::ListEntry entry;
entry["Number"] = Anope::ToString(i + 1);
entry["Mask"] = a->Mask();
entry["Description"] = a->description;
list.AddEntry(entry);
}
}
if (list.IsEmpty())
source.Reply(_("No matching entries on %s access list."), ci->name.c_str());
else
{
source.Reply(_("%s list for %s"), source.command.nobreak().c_str(), ci->name.c_str());
list.SendTo(source);
}
}
void DoClear(CommandSource &source, ChannelInfo *ci)
{
if (Anope::ReadOnly)
{
source.Reply(READ_ONLY_MODE);
return;
}
if (!ci->GetAccessCount())
{
source.Reply(_("%s %s list is empty."), ci->name.c_str(), source.command.nobreak().c_str());
return;
}
if (!source.AccessFor(ci).HasPriv("FOUNDER") && !source.HasPriv("chanserv/access/modify"))
{
source.Reply(ACCESS_DENIED);
return;
}
bool override = !source.AccessFor(ci).HasPriv("FOUNDER");
Log(override ? LOG_OVERRIDE : LOG_COMMAND, source, this, ci) << "to clear the access list";
for (unsigned i = ci->GetAccessCount(); i > 0; --i)
{
const ChanAccess *access = ci->GetAccess(i - 1);
if (access->provider->name != "access/xop" || source.command.upper() != access->AccessSerialize())
continue;
delete ci->EraseAccess(i - 1);
}
FOREACH_MOD(OnAccessClear, (ci, source));
source.Reply(_("Channel %s %s list has been cleared."), ci->name.c_str(), source.command.nobreak().c_str());
}
public:
CommandCSXOP(Module *modname) : Command(modname, "chanserv/xop", 2, 4)
{
this->SetSyntax(_("\037channel\037 ADD \037mask\037 [\037description\037]"));
this->SetSyntax(_("\037channel\037 DEL {\037mask\037 | \037entry-num\037 | \037list\037}"));
this->SetSyntax(_("\037channel\037 LIST [\037mask\037 | \037list\037]"));
this->SetSyntax(_("\037channel\037 CLEAR"));
}
Anope::string GetDesc(CommandSource &source) const override
{
return Anope::Format(source.Translate(_("Modify the list of %s users")), source.command.nobreak().c_str());
}
void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
{
ChannelInfo *ci = ChannelInfo::Find(params[0]);
if (ci == NULL)
{
source.Reply(CHAN_X_NOT_REGISTERED, params[0].c_str());
return;
}
const Anope::string &cmd = params[1];
if (cmd.equals_ci("ADD"))
return this->DoAdd(source, ci, params);
else if (cmd.equals_ci("DEL"))
return this->DoDel(source, ci, params);
else if (cmd.equals_ci("LIST"))
return this->DoList(source, ci, params);
else if (cmd.equals_ci("CLEAR"))
return this->DoClear(source, ci);
else
this->OnSyntaxError(source, "");
}
bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
{
const Anope::string &cmd = source.command.upper();
this->SendSyntax(source);
source.Reply(" ");
source.Reply(_(
"Maintains the \002%s list\002 for a channel. Users who match an access entry "
"on the %s list receive the following privileges:"
),
cmd.c_str(),
cmd.c_str());
source.Reply(" ");
Anope::string buf;
for (const auto &permission : permissions[cmd])
{
if (!buf.empty())
buf += ", ";
buf += permission;
if (buf.length() > 75)
{
source.Reply(" %s", buf.c_str());
buf.clear();
}
}
if (!buf.empty())
{
source.Reply(" %s", buf.c_str());
buf.clear();
}
source.Reply(" ");
source.Reply(_(
"The \002%s\033ADD\002 command adds the given nickname to the "
"%s list."
"\n\n"
"The \002%s\033DEL\002 command removes the given nick from the "
"%s list. If a list of entry numbers is given, those "
"entries are deleted. (See the example for LIST below.)"
"\n\n"
"The \002%s\033LIST\002 command displays the %s list. If "
"a wildcard mask is given, only those entries matching the "
"mask are displayed. If a list of entry numbers is given, "
"only those entries are shown."
"\n\n"
"The \002%s\033CLEAR\002 command clears all entries of the "
"%s list."
),
cmd.c_str(),
cmd.c_str(),
cmd.c_str(),
cmd.c_str(),
cmd.c_str(),
cmd.c_str(),
cmd.c_str(),
cmd.c_str());
ExampleWrapper examples;
examples.AddEntry("#channel LIST 2-5,7-9", _(
"Lists access entries numbered 2 through 5 and 7 through 9."
));
examples.SendTo(source);
BotInfo *access_bi, *flags_bi;
Anope::string access_cmd, flags_cmd;
Command::FindFromService("chanserv/access", access_bi, access_cmd);
Command::FindFromService("chanserv/flags", flags_bi, flags_cmd);
if (!access_cmd.empty() || !flags_cmd.empty())
{
source.Reply(_("Alternative methods of modifying channel access lists are available."));
if (!access_cmd.empty())
{
source.Reply(_("See \002%s\002 for more information about the access list."),
access_bi->GetQueryCommand("generic/help", access_cmd).c_str());
}
if (!flags_cmd.empty())
{
source.Reply(_("See \002%s\002 for more information about the flags system."),
flags_bi->GetQueryCommand("generic/help", flags_cmd).c_str());
}
}
return true;
}
};
class CSXOP final
: public Module
{
XOPAccessProvider accessprovider;
CommandCSXOP commandcsxop;
public:
CSXOP(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, VENDOR),
accessprovider(this), commandcsxop(this)
{
this->SetPermanent(true);
}
void OnReload(Configuration::Conf &conf) override
{
order.clear();
permissions.clear();
for (const auto &[_, block] : conf.GetBlocks("privilege"))
{
const Anope::string &pname = block.Get<const Anope::string>("name");
Privilege *p = PrivilegeManager::FindPrivilege(pname);
if (p == NULL)
continue;
const Anope::string &xop = block.Get<const Anope::string>("xop");
if (pname.empty() || xop.empty())
continue;
permissions[xop].push_back(pname);
}
for (const auto &[_, block] : conf.GetBlocks("command"))
{
const Anope::string &cname = block.Get<const Anope::string>("name"),
&cserv = block.Get<const Anope::string>("command");
if (cname.empty() || cserv != "chanserv/xop")
continue;
order.push_back(cname);
}
}
};
MODULE_INIT(CSXOP)