anope/modules/commands/os_set.cpp

/* OperServ core functions
 *
 * (C) 2003-2022 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 CommandOSSet : public Command
{
 private:
	void DoList(CommandSource &source)
	{
		Log(LOG_ADMIN, source, this) << "LIST";

		Anope::string index;

		index = Anope::ReadOnly ? _("%s is enabled") : _("%s is disabled");
		source.Reply(index.c_str(), "READONLY");
		index = Anope::Debug ? _("%s is enabled") : _("%s is disabled");
		source.Reply(index.c_str(), "DEBUG");
		index = Anope::NoExpire ? _("%s is enabled") : _("%s is disabled");
		source.Reply(index.c_str(), "NOEXPIRE");

		return;
	}

	void DoSetReadOnly(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const Anope::string &setting = params.size() > 1 ? params[1] : "";

		if (setting.empty())
		{
			this->OnSyntaxError(source, "READONLY");
			return;
		}

		if (setting.equals_ci("ON"))
		{
			Anope::ReadOnly = true;
			Log(LOG_ADMIN, source, this) << "READONLY ON";
			source.Reply(_("Services are now in \002read-only\002 mode."));
		}
		else if (setting.equals_ci("OFF"))
		{
			Anope::ReadOnly = false;
			Log(LOG_ADMIN, source, this) << "READONLY OFF";
			source.Reply(_("Services are now in \002read-write\002 mode."));
		}
		else
			source.Reply(_("Setting for READONLY must be \002ON\002 or \002OFF\002."));

		return;
	}

	void DoSetSuperAdmin(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const Anope::string &setting = params.size() > 1 ? params[1] : "";

		if (!source.GetUser())
			return;

		if (setting.empty())
		{
			this->OnSyntaxError(source, "SUPERADMIN");
			return;
		}

		/**
		 * Allow the user to turn super admin on/off
		 *
		 * Rob
		 **/
		bool super_admin = Config->GetModule(this->owner)->Get<bool>("superadmin");
		if (!super_admin)
			source.Reply(_("Super admin can not be set because it is not enabled in the configuration."));
		else if (setting.equals_ci("ON"))
		{
			source.GetUser()->super_admin = true;
			source.Reply(_("You are now a super admin."));
			Log(LOG_ADMIN, source, this) << "SUPERADMIN ON";
		}
		else if (setting.equals_ci("OFF"))
		{
			source.GetUser()->super_admin = false;
			source.Reply(_("You are no longer a super admin."));
			Log(LOG_ADMIN, source, this) << "SUPERADMIN OFF";
		}
		else
			source.Reply(_("Setting for super admin must be \002ON\002 or \002OFF\002."));

		return;
	}

	void DoSetDebug(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const Anope::string &setting = params.size() > 1 ? params[1] : "";

		if (setting.empty())
		{
			this->OnSyntaxError(source, "DEBUG");
			return;
		}

		if (setting.equals_ci("ON"))
		{
			Anope::Debug = 1;
			Log(LOG_ADMIN, source, this) << "DEBUG ON";
			source.Reply(_("Services are now in \002debug\002 mode."));
		}
		else if (setting.equals_ci("OFF") || setting == "0")
		{
			Log(LOG_ADMIN, source, this) << "DEBUG OFF";
			Anope::Debug = 0;
			source.Reply(_("Services are now in \002non-debug\002 mode."));
		}
		else
		{
			try
			{
				Anope::Debug = convertTo<int>(setting);
				Log(LOG_ADMIN, source, this) << "DEBUG " << Anope::Debug;
				source.Reply(_("Services are now in \002debug\002 mode (level %d)."), Anope::Debug);
				return;
			}
			catch (const ConvertException &) { }

			source.Reply(_("Setting for DEBUG must be \002ON\002, \002OFF\002, or a positive number."));
		}

		return;
	}

	void DoSetNoExpire(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const Anope::string &setting = params.size() > 1 ? params[1] : "";

		if (setting.empty())
		{
			this->OnSyntaxError(source, "NOEXPIRE");
			return;
		}

		if (setting.equals_ci("ON"))
		{
			Anope::NoExpire = true;
			Log(LOG_ADMIN, source, this) << "NOEXPIRE ON";
			source.Reply(_("Services are now in \002no expire\002 mode."));
		}
		else if (setting.equals_ci("OFF"))
		{
			Anope::NoExpire = false;
			Log(LOG_ADMIN, source, this) << "NOEXPIRE OFF";
			source.Reply(_("Services are now in \002expire\002 mode."));
		}
		else
			source.Reply(_("Setting for NOEXPIRE must be \002ON\002 or \002OFF\002."));

		return;
	}
 public:
	CommandOSSet(Module *creator) : Command(creator, "operserv/set", 1, 2)
	{
		this->SetDesc(_("Set various global Services options"));
		this->SetSyntax(_("\037option\037 \037setting\037"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) anope_override
	{
		const Anope::string &option = params[0];

		if (option.equals_ci("LIST"))
			return this->DoList(source);
		else if (option.equals_ci("READONLY"))
			return this->DoSetReadOnly(source, params);
		else if (option.equals_ci("DEBUG"))
			return this->DoSetDebug(source, params);
		else if (option.equals_ci("NOEXPIRE"))
			return this->DoSetNoExpire(source, params);
		else if (option.equals_ci("SUPERADMIN"))
			return this->DoSetSuperAdmin(source, params);
		else
			this->OnSyntaxError(source, "");

		return;
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) anope_override
	{
		if (subcommand.empty())
		{
			this->SendSyntax(source);
			source.Reply(" ");
			source.Reply(_("Sets various global Services options.  Option names\n"
					"currently defined are:\n"
					"    READONLY   Set read-only or read-write mode\n"
					"    DEBUG      Activate or deactivate debug mode\n"
					"    NOEXPIRE   Activate or deactivate no expire mode\n"
					"    SUPERADMIN Activate or deactivate super admin mode\n"
					"    LIST       List the options"));
		}
		else if (subcommand.equals_ci("LIST"))
			source.Reply(_("Syntax: \002LIST\002\n"
					" \n"
					"Display the various %s settings."), source.service->nick.c_str());
		else if (subcommand.equals_ci("READONLY"))
			source.Reply(_("Syntax: \002READONLY {ON | OFF}\002\n"
					" \n"
					"Sets read-only mode on or off.  In read-only mode, normal\n"
					"users will not be allowed to modify any Services data,\n"
					"including channel and nickname access lists, etc.  IRCops\n"
					"with sufficient Services privileges will be able to modify\n"
					"Services' AKILL, SQLINE, SNLINE and ignore lists, drop,\n"
					"suspend or forbid nicknames and channels, and manage news,\n"
					"oper info and DNS, but any such changes will not be saved\n"
					"unless read-only mode is deactivated before Services are\n"
					"terminated or restarted.\n"
					" \n"
					"This option is equivalent to the command-line option\n"
					"\002--readonly\002."));
		else if (subcommand.equals_ci("DEBUG"))
			source.Reply(_("Syntax: \002DEBUG {ON | OFF}\002\n"
					" \n"
					"Sets debug mode on or off.\n"
					" \n"
					"This option is equivalent to the command-line option\n"
					"\002--debug\002."));
		else if (subcommand.equals_ci("NOEXPIRE"))
			source.Reply(_("Syntax: \002NOEXPIRE {ON | OFF}\002\n"
					" \n"
					"Sets no expire mode on or off. In no expire mode, nicks,\n"
					"channels, akills and exceptions won't expire until the\n"
					"option is unset.\n"
					" \n"
					"This option is equivalent to the command-line option\n"
					"\002--noexpire\002."));
		else if (subcommand.equals_ci("SUPERADMIN"))
			source.Reply(_("Syntax: \002SUPERADMIN {ON | OFF}\002\n"
					" \n"
					"Setting this will grant you extra privileges such as the\n"
					"ability to be \"founder\" on all channel's etc...\n"
					" \n"
					"This option is \002not\002 persistent, and should only be used when\n"
					"needed, and set back to OFF when no longer needed."));
		else
			return false;
		return true;
	}
};

class OSSet : public Module
{
	CommandOSSet commandosset;

 public:
	OSSet(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, VENDOR),
		commandosset(this)
	{
	}
};

MODULE_INIT(OSSet)