anope/modules/botserv/botserv.cpp

// 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"

class BotServCore final
	: public Module
{
	Reference<BotInfo> BotServ;
	ExtensibleRef<bool> persist, inhabit;

public:
	BotServCore(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, PSEUDOCLIENT | VENDOR),
		persist("PERSIST"), inhabit("inhabit")
	{
	}

	void OnReload(Configuration::Conf &conf) override
	{
		const Anope::string &bsnick = conf.GetModule(this).Get<const Anope::string>("client");
		BotServ = BotInfo::Find(bsnick, true);
	}

	void OnSetCorrectModes(User *user, Channel *chan, AccessGroup &access, bool &give_modes, bool &take_modes) override
	{
		/* Do not allow removing bot modes on our service bots */
		if (chan->ci && chan->ci->bi == user)
		{
			const Anope::string &botmodes = Config->GetModule(this).Get<const Anope::string>("botmodes");
			for (auto botmode : botmodes)
				chan->SetMode(chan->ci->bi, ModeManager::FindChannelModeByChar(botmode), chan->ci->bi->GetUID());
		}
	}

	void OnBotAssign(User *sender, ChannelInfo *ci, BotInfo *bi) override
	{
		if (ci->c && ci->c->users.size() >= Config->GetModule(this).Get<unsigned>("minusers"))
		{
			ChannelStatus status(Config->GetModule(this).Get<const Anope::string>("botmodes"));
			bi->Join(ci->c, &status);
		}
	}

	void OnJoinChannel(User *user, Channel *c) override
	{
		if (!Config || !IRCD)
			return;

		BotInfo *bi = user->server == Me ? dynamic_cast<BotInfo *>(user) : NULL;
		if (bi && Config->GetModule(this).Get<bool>("smartjoin"))
		{
			if (IRCD->CanClearModes.count("BAN"))
			{
				// We can ask the IRCd to clear bans.
				IRCD->SendClearModes(bi, c, bi, "BAN");
			}
			else
			{
				// We have to check for bans.
				for (const auto &entry : c->GetModeList("BAN"))
				{
					Entry ban("BAN", entry);
					if (ban.Matches(user))
						c->RemoveMode(NULL, "BAN", ban.GetMask());
				}
			}

			Anope::string Limit;
			unsigned limit = 0;
			if (c->GetParam("LIMIT", Limit))
				limit = Anope::Convert<unsigned>(Limit, limit);

			/* Should we be invited? */
			if (c->HasMode("INVITE") || (limit && c->users.size() >= limit))
			{
				ChannelMode *cm = ModeManager::FindChannelModeByName("OP");
				char symbol = cm ? anope_dynamic_static_cast<ChannelModeStatus *>(cm)->symbol : 0;
				const auto message = Anope::Format("%s invited %s into the channel.", user->nick.c_str(), user->nick.c_str());
				IRCD->SendNotice(bi, (symbol ? Anope::string(symbol) : "") + c->name, message);
			}

			ModeManager::ProcessModes();
		}

		if (user->server != Me && c->ci && c->ci->bi)
		{
			/**
			 * We let the bot join even if it was an ignored user, as if we don't,
			 * and the ignored user doesn't just leave, the bot will never
			 * make it into the channel, leaving the channel botless even for
			 * legit users - Rob
			 **/
			/* This is before the user has joined the channel, so check usercount + 1 */
			if (c->users.size() + 1 >= Config->GetModule(this).Get<unsigned>("minusers") && !c->FindUser(c->ci->bi))
			{
				ChannelStatus status(Config->GetModule(this).Get<const Anope::string>("botmodes"));
				c->ci->bi->Join(c, &status);
			}
		}
	}

	void OnLeaveChannel(User *u, Channel *c) override
	{
		/* Channel is persistent, it shouldn't be deleted and the service bot should stay */
		if (c->ci && persist && persist->HasExt(c->ci))
			return;

		/* Channel is syncing from a netburst, don't destroy it as more users are probably wanting to join immediately
		 * We also don't part the bot here either, if necessary we will part it after the sync
		 */
		if (c->syncing)
			return;

		/* Additionally, do not delete this channel if ChanServ/a BotServ bot is inhabiting it */
		if (inhabit && inhabit->HasExt(c))
			return;

		/* This is called prior to removing the user from the channel, so c->users.size() - 1 should be safe */
		if (c->ci && c->ci->bi && u != *c->ci->bi && c->users.size() - 1 <= Config->GetModule(this).Get<unsigned>("minusers") && c->FindUser(c->ci->bi))
			c->ci->bi->Part(c->ci->c);
	}

	EventReturn OnPreHelp(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		if (!params.empty())
			return EVENT_CONTINUE;

		if (source.c)
		{
			source.Reply(_(
					"\002%s\002 allows you to execute \"fantasy\" commands in the channel. "
					"Fantasy commands are commands that can be executed from messaging a "
					"channel, and provide a more convenient way to execute commands. Commands that "
					"require a channel as a parameter will automatically have that parameter "
					"given."
				),
				source.service->nick.c_str());

			const Anope::string &fantasycharacters = Config->GetModule("fantasy").Get<const Anope::string>("prefix", "!");
			if (!fantasycharacters.empty())
			{
				source.Reply(" ");
				source.Reply(_("Fantasy commands may be prefixed with one of the following fantasy prefixes: %s"),
					fantasycharacters.c_str());
			}
			source.Reply(" ");
			source.Reply(_("Available commands are:"));
		}
		else if (*source.service == BotServ)
		{
			source.Reply(_(
					"\002%s\002 allows you to have a bot on your own channel. "
					"It has been created for users that can't host or "
					"configure a bot, or for use on networks that don't "
					"allow user bots. Available commands are listed "
					"below; to use them, type \002%s\032\037command\037\002. For "
					"more information on a specific command, type "
					"\002%s\032\037command\037\002."
				),
				BotServ->nick.c_str(),
				BotServ->GetQueryCommand().c_str(),
				BotServ->GetQueryCommand({}, source.command).c_str());

			source.Reply(" ");
		}

		return EVENT_CONTINUE;
	}

	void OnPostHelp(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		if (!params.empty() || source.c || source.service != *BotServ)
			return;

		source.Reply(" ");
		source.Reply(_("Bot will join a channel whenever there is at least \002%d\002 user(s) on it."),
			Config->GetModule(this).Get<unsigned>("minusers"));

		const Anope::string &fantasycharacters = Config->GetModule("fantasy").Get<const Anope::string>("prefix", "!");
		if (!fantasycharacters.empty())
		{
			source.Reply(_(
					"Additionally, if fantasy is enabled fantasy commands "
					"can be executed by prefixing the command name with "
					"one of the following fantasy prefixes: %s"
				),
				fantasycharacters.c_str());
		}
	}

	EventReturn OnChannelModeSet(Channel *c, MessageSource &source, ChannelMode *mode, const ModeData &data) override
	{
		if (source.GetUser() && !source.GetBot() && Config->GetModule(this).Get<bool>("smartjoin") && mode->name == "BAN" && c->ci && c->ci->bi && c->FindUser(c->ci->bi))
		{
			BotInfo *bi = c->ci->bi;

			Entry ban("BAN", data.value);
			if (ban.Matches(bi))
				c->RemoveMode(bi, "BAN", data.value);
		}

		return EVENT_CONTINUE;
	}

	void OnCreateChan(ChannelInfo *ci) override
	{
		/* Set default bot flags */
		spacesepstream sep(Config->GetModule(this).Get<const Anope::string>("defaults", "greet fantasy"));
		for (Anope::string token; sep.GetToken(token);)
			ci->Extend<bool>("BS_" + token.upper());
	}

	void OnUserKicked(const MessageSource &source, User *target, const Anope::string &channel, ChannelStatus &status, const Anope::string &kickmsg) override
	{
		BotInfo *bi = BotInfo::Find(target->GetUID());
		if (bi)
			/* Bots get rejoined */
			bi->Join(channel, &status);
	}

	void OnCreateBot(BotInfo *bi) override
	{
		if (bi->botmodes.empty())
			bi->botmodes = Config->GetModule(this).Get<const Anope::string>("botumodes");
	}
};

MODULE_INIT(BotServCore)