anope/modules/operserv/os_shutdown.cpp

/* OperServ 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 CommandOSQuit final
	: public Command
{
public:
	CommandOSQuit(Module *creator) : Command(creator, "operserv/quit", 0, 1)
	{
		this->SetDesc(_("Terminate services WITHOUT saving"));
		if (Config->GetModule(this->owner)->Get<bool>("requirename"))
			this->SetSyntax(_("\037network-name\037"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		const auto requirename = Config->GetModule(this->owner)->Get<bool>("requirename");
		const auto networkname = Config->GetBlock("networkinfo")->Get<Anope::string>("networkname");
		if (requirename && (params.empty() || !params[0].equals_cs(networkname)))
		{
			OnSyntaxError(source, source.command);
			return;
		}

		Log(LOG_ADMIN, source, this);
		Anope::QuitReason = source.command + " command received from " + source.GetNick();
		Anope::Quitting = true;
		return;
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply(_("Causes services to do an immediate shutdown; databases are\n"
				"\002not\002 saved.  This command should not be used unless\n"
				"damage to the in-memory copies of the databases is feared\n"
				"and they should not be saved."));
		return true;
	}
};

class CommandOSRestart final
	: public Command
{
public:
	CommandOSRestart(Module *creator) : Command(creator, "operserv/restart", 0, 1)
	{
		this->SetDesc(_("Save databases and restart services"));
		if (Config->GetModule(this->owner)->Get<bool>("requirename"))
			this->SetSyntax(_("\037network-name\037"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		const auto requirename = Config->GetModule(this->owner)->Get<bool>("requirename");
		const auto networkname = Config->GetBlock("networkinfo")->Get<Anope::string>("networkname");
		if (requirename && (params.empty() || !params[0].equals_cs(networkname)))
		{
			OnSyntaxError(source, source.command);
			return;
		}

		Log(LOG_ADMIN, source, this);
		Anope::QuitReason = source.command + " command received from " + source.GetNick();
		Anope::Quitting = Anope::Restarting = true;
		Anope::SaveDatabases();
		return;
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
	{
		this->SendSyntax(source);
		source.Reply(_("Causes services to save all databases and then restart\n"
				"(i.e. exit and immediately re-run the executable)."));
		return true;
	}
};

class CommandOSShutdown final
	: public Command
{
public:
	CommandOSShutdown(Module *creator) : Command(creator, "operserv/shutdown", 0, 1)
	{
		this->SetDesc(_("Terminate services with save"));
		if (Config->GetModule(this->owner)->Get<bool>("requirename"))
			this->SetSyntax(_("\037network-name\037"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		const auto requirename = Config->GetModule(this->owner)->Get<bool>("requirename");
		const auto networkname = Config->GetBlock("networkinfo")->Get<Anope::string>("networkname");
		if (requirename && (params.empty() || !params[0].equals_cs(networkname)))
		{
			OnSyntaxError(source, source.command);
			return;
		}

		Log(LOG_ADMIN, source, this);
		Anope::QuitReason = source.command + " command received from " + source.GetNick();
		Anope::Quitting = true;
		Anope::SaveDatabases();
		return;
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply(_("Causes services to save all databases and then shut down."));
		return true;
	}
};

class OSShutdown final
	: public Module
{
	CommandOSQuit commandosquit;
	CommandOSRestart commandosrestart;
	CommandOSShutdown commandosshutdown;

public:
	OSShutdown(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, VENDOR),
		commandosquit(this), commandosrestart(this), commandosshutdown(this)
	{

	}
};

MODULE_INIT(OSShutdown)