path: root/modules/commands/os_ignore.cpp

/* OperServ core functions
 *
 * (C) 2003-2012 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"
#include "os_ignore.h"

class OSIgnoreService : public IgnoreService
{
 public:
	OSIgnoreService(Module *o) : IgnoreService(o) { }

	IgnoreData* AddIgnore(const Anope::string &mask, const Anope::string &creator, const Anope::string &reason, time_t delta = Anope::CurTime) anope_override
	{
		/* If it s an existing user, we ignore the hostmask. */
		Anope::string realmask = mask;
		size_t user, host;

		User *u = finduser(mask);
		if (u)
			realmask = "*!*@" + u->host;
		/* Determine whether we get a nick or a mask. */
		else if ((host = mask.find('@')) != Anope::string::npos)
		{
			/* Check whether we have a nick too.. */
			if ((user = mask.find('!')) != Anope::string::npos)
			{
				/* this should never happen */
				if (user > host)
					return NULL;
			}
			else
				/* We have user@host. Add nick wildcard. */
				realmask = "*!" + mask;
		}
		/* We only got a nick.. */
		else
			realmask = mask + "!*@*";

		/* Check if we already got an identical entry. */
		IgnoreData *ign = this->Find(realmask);
		if (ign != NULL)
		{
			if (!delta)
				ign->time = 0;
			else
				ign->time = Anope::CurTime + delta;
			return ign;
		}
		/* Create new entry.. */
		else
		{
			IgnoreData newign;
			newign.mask = realmask;
			newign.creator = creator;
			newign.reason = reason;
			newign.time = delta ? Anope::CurTime + delta : 0;
			this->ignores.push_back(newign);
			return &this->ignores.back();
		}
	}

	bool DelIgnore(const Anope::string &mask) anope_override
	{
		for (std::list<IgnoreData>::iterator it = this->ignores.begin(), it_end = this->ignores.end(); it != it_end; ++it)
		{
			IgnoreData &idn = *it;
			if (idn.mask.equals_ci(mask))
			{
				this->ignores.erase(it);
				return true;
			}
		}

		return false;
	}

	IgnoreData *Find(const Anope::string &mask) anope_override
	{
		User *u = finduser(mask);
		std::list<IgnoreData>::iterator ign = this->ignores.begin(), ign_end = this->ignores.end();
		
		if (u)
		{
			for (; ign != ign_end; ++ign)
			{
				Entry ignore_mask(CMODE_BEGIN, ign->mask);
				if (ignore_mask.Matches(u, true))
					break;
			}
		}
		else
		{
			size_t user, host;
			Anope::string tmp;
			/* We didn't get a user.. generate a valid mask. */
			if ((host = mask.find('@')) != Anope::string::npos)
			{
				if ((user = mask.find('!')) != Anope::string::npos)
				{
					/* this should never happen */
					if (user > host)
						return NULL;
					tmp = mask;
				}
				else
					/* We have user@host. Add nick wildcard. */
				tmp = "*!" + mask;
			}
			/* We only got a nick.. */
			else
				tmp = mask + "!*@*";

			for (; ign != ign_end; ++ign)
				if (Anope::Match(tmp, ign->mask, false, true))
					break;
		}

		/* Check whether the entry has timed out */
		if (ign != ign_end)
		{
			IgnoreData &id = *ign;

			if (id.time && id.time <= Anope::CurTime)
			{
				Log(LOG_DEBUG) << "Expiring ignore entry " << id.mask;
				this->ignores.erase(ign);
			}
			else
				return &id;
		}

		return NULL;
	}
};

class CommandOSIgnore : public Command
{
 private:
	void DoAdd(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (!ignore_service)
			return;

		const Anope::string &time = params.size() > 1 ? params[1] : "";
		const Anope::string &nick = params.size() > 2 ? params[2] : "";
		const Anope::string &reason = params.size() > 3 ? params[3] : "";

		if (time.empty() || nick.empty())
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}
		else
		{
			time_t t = dotime(time);

			if (t <= -1)
			{
				source.Reply(_("You have to enter a valid number as time."));
				return;
			}

			ignore_service->AddIgnore(nick, source.GetNick(), reason, t);
			if (!t)
				source.Reply(_("\002%s\002 will now permanently be ignored."), nick.c_str());
			else
				source.Reply(_("\002%s\002 will now be ignored for \002%s\002."), nick.c_str(), time.c_str());
		}

		return;
	}

	void DoList(CommandSource &source)
	{
		if (!ignore_service)
			return;

		std::list<IgnoreData> &ignores = ignore_service->GetIgnores();

		for (std::list<IgnoreData>::iterator it = ignores.begin(), next_it; it != ignores.end(); it = next_it)
		{
			IgnoreData &id = *it;
			next_it = it;
			++next_it;

			if (id.time && id.time <= Anope::CurTime)
			{
				Log(LOG_DEBUG) << "Expiring ignore entry " << id.mask;
				ignores.erase(it);
			}
		}

		if (ignores.empty())
			source.Reply(_("Ignore list is empty."));
		else
		{
			ListFormatter list;
			list.addColumn("Mask").addColumn("Creator").addColumn("Reason").addColumn("Expires");
			for (std::list<IgnoreData>::const_iterator ign = ignores.begin(), ign_end = ignores.end(); ign != ign_end; ++ign)
			{
				const IgnoreData &ignore = *ign;

				ListFormatter::ListEntry entry;
				entry["Mask"] = ignore.mask;
				entry["Creator"] = ignore.creator;
				entry["Reason"] = ignore.reason;
				entry["Expires"] = do_strftime(ignore.time);
				list.addEntry(entry);
			}

			source.Reply(_("Services ignore list:"));

			std::vector<Anope::string> replies;
			list.Process(replies);

			for (unsigned i = 0; i < replies.size(); ++i)
				source.Reply(replies[i]);
		}
	}

	void DoDel(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (!ignore_service)
			return;

		const Anope::string nick = params.size() > 1 ? params[1] : "";
		if (nick.empty())
			this->OnSyntaxError(source, "DEL");
		else if (ignore_service->DelIgnore(nick))
			source.Reply(_("\002%s\002 will no longer be ignored."), nick.c_str());
		else
			source.Reply(_("Nick \002%s\002 not found on ignore list."), nick.c_str());

		return;
	}

	void DoClear(CommandSource &source)
	{
		if (!ignore_service)
			return;

		ignore_service->ClearIgnores();
		source.Reply(_("Ignore list has been cleared."));

		return;
	}

 public:
	CommandOSIgnore(Module *creator) : Command(creator, "operserv/ignore", 1, 4)
	{
		this->SetDesc(_("Modify the Services ignore list"));
		this->SetSyntax(_("ADD \037time\037 \037nick\037 \037reason\037"));
		this->SetSyntax(_("DEL \037nick\037"));
		this->SetSyntax(_("LIST"));
		this->SetSyntax(_("CLEAR"));
	}

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

		if (cmd.equals_ci("ADD"))
			return this->DoAdd(source, params);
		else if (cmd.equals_ci("LIST"))
			return this->DoList(source);
		else if (cmd.equals_ci("DEL"))
			return this->DoDel(source, params);
		else if (cmd.equals_ci("CLEAR"))
			return this->DoClear(source);
		else
			this->OnSyntaxError(source, "");

		return;
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) anope_override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply(_("Allows Services Operators to make Services ignore a nick or mask\n"
				"for a certain time or until the next restart. The default\n"
				"time format is seconds. You can specify it by using units.\n"
				"Valid units are: \037s\037 for seconds, \037m\037 for minutes, \n"
				"\037h\037 for hours and \037d\037 for days. \n"
				"Combinations of these units are not permitted.\n"
				"To make Services permanently ignore the user, type 0 as time.\n"
				"When adding a \037mask\037, it should be in the format user@host\n"
				"or nick!user@host, everything else will be considered a nick.\n"
				"Wildcards are permitted.\n"
				" \n"
				"Ignores will not be enforced on IRC Operators."));
		if (!Config->RegexEngine.empty())
			source.Reply(" \n"
					"Regex matches are also supported using the %s engine.\n"
					"Enclose your pattern in // if this desired.", Config->RegexEngine.c_str());
		return true;
	}
};

class OSIgnore : public Module
{
	SerializeType ignoredata_type;
	OSIgnoreService osignoreservice;
	CommandOSIgnore commandosignore;

 public:
	OSIgnore(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, CORE),
		ignoredata_type("IgnoreData", IgnoreData::unserialize), osignoreservice(this), commandosignore(this)
	{
		this->SetAuthor("Anope");


		Implementation i[] = { I_OnBotPrivmsg };
		ModuleManager::Attach(i, this, sizeof(i) / sizeof(Implementation));
	}

	EventReturn OnBotPrivmsg(User *u, BotInfo *bi, Anope::string &message) anope_override
	{
		if (!u->HasMode(UMODE_OPER) && this->osignoreservice.Find(u->nick))
			return EVENT_STOP;

		return EVENT_CONTINUE;
	}
};

MODULE_INIT(OSIgnore)