os_notify.cpp

/*
 * OperServ Notify
 *
 * (C) 2017-2019 - genius3000 (genius3000@g3k.solutions)
 * Please refer to the GPL License in use by Anope at:
 * https://github.com/anope/anope/blob/master/docs/COPYING
 *
 * Allows Opers to be notified of flagged events done by Users matching a mask.
 * Masks are the same as AKILL: nick!user@host#real (only needing user@host) and allowing
 * regex matching if enabled. Channel masks can be used to track users that join them.
 * Notification is done via the log method and is therefore configurable.
 * Flags control which events are logged and are listed in the Command Help or as a
 * code comment in the DoAdd function.
 *
 * Syntax: NOTIFY ADD +expiry flags|* mask [:]reason
 *		  DEL mask | entry-num | list
 *		  LIST | VIEW | SHOW [mask | entry-num | list]
 *		  CLEAR
 *		  REMOVE nick
 *
 * Configuration to put into your operserv config:
module { name = "os_notify" }
command { service = "OperServ"; name = "NOTIFY"; command = "operserv/notify"; permission = "operserv/notify"; }
 *
 * Don't forget to add 'operserv/notify' to your oper permissions
 * Create a channel logging tag similar to:
log { target = "#services-notify"; bot = "OperServ"; other = "notify/..."; }
 * The logging is split into 3 categories:
 * notify/user
 * notify/channel
 * notify/commands
 * Expiring entries follow the log format of: expire/notify
 */

#include "module.h"


/* Dataset for each Notify mask (entry) */
struct NotifyEntry : Serializable
{
 public:
	Anope::string mask;	/* Mask to match */
	Anope::string reason;	/* Reason for this Notify */
	std::set<char> flags;	/* Flags of what to track */
	Anope::string creator;	/* Nick of creator */
	time_t created;		/* Time of creation */
	time_t expires;		/* Time of expiry */

	NotifyEntry() : Serializable("Notify") { }

	~NotifyEntry();

	void Serialize(Serialize::Data &data) const anope_override
	{
		data["mask"] << this->mask;
		data["reason"] << this->reason;
		data["flags"] << Anope::string(this->flags.begin(), this->flags.end());
		data["creator"] << this->creator;
		data["created"] << this->created;
		data["expires"] << this->expires;
	}

	static Serializable* Unserialize(Serializable *obj, Serialize::Data &data);
};

/* Maps to track matched Notify Entries and Users */
typedef std::multimap<const NotifyEntry *, const User *> PerEntryMap;
typedef std::multimap<const User *, const NotifyEntry *> PerUserMap;

/* List of Notify Entries and currently Matched users */
class NotifyList
{
 protected:
	Serialize::Checker<std::vector<NotifyEntry *> > notifies;
	PerEntryMap match_entry;	/* Multiple Users mapped to one Notify Entry */
	PerUserMap match_user;		/* Multiple Notify Entires mapped to one User */

 public:
	NotifyList() : notifies("Notify") { }

	~NotifyList()
	{
		for (unsigned i = notifies->size(); i > 0; --i)
			delete (*notifies).at(i - 1);

		match_entry.clear();
		match_user.clear();
	}

	void AddNotify(NotifyEntry *ne)
	{
		notifies->push_back(ne);
	}

	void DelNotify(NotifyEntry *ne)
	{
		/* Erase all Map items matching to this Notify Entry */
		match_entry.erase(ne);
		for (PerUserMap::reverse_iterator rit = match_user.rbegin(); rit != match_user.rend(); )
		{
			if (rit->second == ne)
				match_user.erase(--rit.base());
			else
				++rit;
		}

		/* Erase this Notify Entry from the Notify vector */
		std::vector<NotifyEntry *>::iterator it = std::find(notifies->begin(), notifies->end(), ne);
		if (it != notifies->end())
			notifies->erase(it);
	}

	void ClearNotifies()
	{
		for (unsigned i = notifies->size(); i > 0; --i)
			delete (*notifies).at(i - 1);

		match_entry.clear();
		match_user.clear();
	}

	void Expire(const NotifyEntry *ne)
	{
		Log(Config->GetClient("OperServ"), "expire/notify") << "Expiring notify entry " << ne->mask;
		delete ne;
	}

	const NotifyEntry *GetNotify(const unsigned number)
	{
		if (number >= notifies->size())
			return NULL;

		const NotifyEntry *ne = notifies->at(number);
		if (ne->expires && ne->expires <= Anope::CurTime)
		{
			Expire(ne);
			return NULL;
		}

		return ne;
	}

	const NotifyEntry *GetNotify(const Anope::string &mask)
	{
		for (unsigned i = notifies->size(); i > 0; --i)
		{
			const NotifyEntry *ne = notifies->at(i - 1);

			if (ne->expires && ne->expires <= Anope::CurTime)
				Expire(ne);
			else if (ne->mask.equals_ci(mask))
				return ne;
		}

		return NULL;
	}

	/* Check if a User matches to a mask */
	bool Check(const User *u, const Anope::string &mask)
	{
		/* Regex mask: Matches against u@h and n!u@h#r only */
		if (mask.length() >= 2 && mask[0] == '/' && mask[mask.length() - 1] == '/')
		{
			const Anope::string uh = u->GetIdent() + '@' + u->host;
			const Anope::string nuhr = u->nick + '!' + uh + '#' + u->realname;
			return (Anope::Match(uh, mask, false, true) || Anope::Match(nuhr, mask, false, true));
		}

		/* Use 'modes' Entry to perform matching per item (nick, user, host, real) */
		Entry notify_mask("", mask);
		return notify_mask.Matches(const_cast<User *>(u), true);
	}

	/* Check if a Channel matches a mask */
	bool Check(const Channel *c, const Anope::string &mask)
	{
		/* Regex mask */
		if (mask.length() >= 2 && mask[0] == '/' && mask[mask.length() - 1] == '/')
		{
			return Anope::Match(c->name, mask, false, true);
		}

		return mask.equals_ci(c->name);
	}

	const std::vector<NotifyEntry *> &GetNotifies()
	{
		for (unsigned i = notifies->size(); i > 0; --i)
		{
			const NotifyEntry *ne = notifies->at(i - 1);
			if (ne->expires && ne->expires <= Anope::CurTime)
				Expire(ne);
		}

		return *notifies;
	}

	const unsigned GetNotifiesCount()
	{
		return notifies->size();
	}

	/* Check if a User is already mapped to a specific Notify Entry */
	bool ExistsAlready(const User *u, const NotifyEntry *ne)
	{
		std::pair<PerUserMap::const_iterator, PerUserMap::const_iterator> itpair = match_user.equal_range(u);
		for (PerUserMap::const_iterator it = itpair.first; it != itpair.second; ++it)
		{
			if (it->second == ne)
				return true;
		}

		return false;
	}

	/* Map a User as matched to a specific Notify Entry */
	void AddMatch(const User *u, const NotifyEntry *ne)
	{
		match_entry.insert(std::make_pair(ne, u));
		match_user.insert(std::make_pair(u, ne));
	}

	/* Remove a User from the matched Maps */
	void DelMatch(const User *u)
	{
		match_user.erase(u);
		for (PerEntryMap::reverse_iterator it = match_entry.rbegin(); it != match_entry.rend(); )
		{
			if (it->second == u)
				match_entry.erase(--it.base());
			else
				++it;
		}
	}

	/* Check if a User is matched to any Notify Entries already */
	bool IsMatch(const User *u)
	{
		return (match_user.count(u) > 0);
	}

	/* Check if a User is matched to a Notify Entry with a specific flag */
	bool HasFlag(const User *u, char flag)
	{
		std::pair<PerUserMap::const_iterator, PerUserMap::const_iterator> itpair = match_user.equal_range(u);
		for (PerUserMap::const_iterator it = itpair.first; it != itpair.second; ++it)
		{
			if (it->second->flags.count(flag) > 0)
				return true;
		}

		return false;
	}

	const PerEntryMap &GetEntryMap()
	{
		return match_entry;
	}

	const PerUserMap &GetUserMap()
	{
		return match_user;
	}
}
NotifyList;

NotifyEntry::~NotifyEntry()
{
	NotifyList.DelNotify(this);
}

Serializable* NotifyEntry::Unserialize(Serializable *obj, Serialize::Data &data)
{
	NotifyEntry *ne;

	if (obj)
		ne = anope_dynamic_static_cast<NotifyEntry *>(obj);
	else
		ne = new NotifyEntry();

	Anope::string flags;
	data["mask"] >> ne->mask;
	data["reason"] >> ne->reason;
	data["flags"] >> flags;
	data["creator"] >> ne->creator;
	data["created"] >> ne->created;
	data["expires"] >> ne->expires;
	for (unsigned f = 0; f != flags.length(); ++f)
		ne->flags.insert(flags[f]);

	if (!obj)
		NotifyList.AddNotify(ne);

	return ne;
}

/* Handle numbered (list) deletions */
class NotifyDelCallback : public NumberList
{
	CommandSource &source;
	unsigned deleted;
	Command *cmd;

 public:
	NotifyDelCallback(CommandSource &_source, const Anope::string &numlist, Command *c) : NumberList(numlist, true), source(_source), deleted(0), cmd(c) { }

	~NotifyDelCallback()
	{
		if (!deleted)
		{
			source.Reply("No matching entries on the notify list.");
			return;
		}

		if (Anope::ReadOnly)
			source.Reply(READ_ONLY_MODE);

		if (deleted == 1)
			source.Reply("Deleted 1 entry from the notify list.");
		else
			source.Reply("Deleted %d entries from the notify list.", deleted);
	}

	void HandleNumber(unsigned number) anope_override
	{
		if (!number)
			return;

		const NotifyEntry *ne = NotifyList.GetNotify(number - 1);
		if (!ne)
			return;

		Log(LOG_ADMIN, source, cmd) << "to remove " << ne->mask << " from the list";
		delete ne;
		++deleted;
	}
};

class CommandOSNotify : public Command
{
 private:
	void DoAdd(CommandSource &source, const std::vector<Anope::string> &params)
	{
		Anope::string expiry, str_flags, mask, reason;

		/* Expecting: ADD +expiry flags|* mask [:]reason
		 * Ex:	ADD +30d cdjp idiot!moron@somewhere.com Annoying spammer
		 * Ex:	ADD +30d * helper!help@*.isp.com#Here to help :Impersonating staff and spamming
		 */

		if (params.size() < 4)
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}

		expiry = params[1];
		time_t expires = Anope::DoTime(expiry);
		/* Like AKILL, default to days if not specified */
		if (isdigit(expiry[expiry.length() - 1]))
			expires *= 86400;
		if (expires > 0)
			expires += Anope::CurTime;

		/* Acceptable flags are:
		 * c = Connects
		 * d = Disconnects
		 * i = channel Invites
		 * j = channel Joins
		 * k = channel Kicks
		 * m = channel Modes
		 * n = Nick changes
		 * p = channel Parts
		 * s = Services commands (-SET)
		 * S = Services SET commands
		 * t = Topics
		 * u = Usermodes
		 */
		const Anope::string all_flags = "Scdijkmnpstu";
		str_flags = params[2];

		if (str_flags == "*")
		{
			str_flags = all_flags;
		}
		else if (str_flags.find_first_not_of(all_flags) != Anope::string::npos)
		{
			source.Reply("Incorrect flags character(s) given.");
			return;
		}

		std::set<char> flags;
		for (unsigned f = 0; f < str_flags.length(); ++f)
			flags.insert(str_flags[f]);

		spacesepstream sep(params[3]);
		sep.GetToken(mask);

		if (sep.StreamEnd())
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}

		size_t pound = mask.find('#');
		size_t at = mask.find('@');

		/* If '#' is after '@', we've got a real name */
		if ((pound != Anope::string::npos && at != Anope::string::npos) && pound > at)
		{
			const Anope::string remaining = sep.GetRemaining();

			size_t co = remaining[0] == ':' ? 0 : remaining.rfind(" :");
			if (co == Anope::string::npos)
			{
				this->OnSyntaxError(source, "ADD");
				return;
			}

			if (co != 0)
				++co;

			reason = remaining.substr(co + 1);
			mask += " " + remaining.substr(0, co);
			mask.trim();
		}
		else
		{
			reason = sep.GetRemaining();
		}

		if (mask.length() >= 2 && mask[0] == '/' && mask[mask.length() - 1] == '/')
		{
			const Anope::string &regexengine = Config->GetBlock("options")->Get<const Anope::string>("regexengine");

			if (regexengine.empty())
			{
				source.Reply("Regex is disabled.");
				return;
			}

			ServiceReference<RegexProvider> provider("Regex", regexengine);
			if (!provider)
			{
				source.Reply("Unable to find regex engine %s.", regexengine.c_str());
				return;
			}

			try
			{
				Anope::string stripped_mask = mask.substr(1, mask.length() - 2);
				delete provider->Compile(stripped_mask);
			}
			catch (const RegexException &ex)
			{
				source.Reply("%s", ex.GetReason().c_str());
				return;
			}
		}

		if (mask.find_first_not_of("/~@.*?#") == Anope::string::npos)
		{
			source.Reply(USERHOST_MASK_TOO_WIDE, mask.c_str());
			return;
		}

		/* Valid masks either include a '@' or have '#' first (non-regex)
		 * Regex chan matches just require '#' in the mask
		 */
		else if ((mask.find('@') == Anope::string::npos) &&
			(mask[0] != '#') &&
			(mask.length() < 2 || mask[0] != '/' || mask.find('#') == Anope::string::npos))
		{
			source.Reply("Mask must be at least \037user\037@\037host\037 or have a \037#\037 for channel masks.");
			return;
		}

		NotifyEntry *ne = const_cast<NotifyEntry *>(NotifyList.GetNotify(mask));
		bool created = true;
		if (ne)
		{
			created = false;
			delete ne;
		}
		ne = new NotifyEntry();

		ne->mask = mask;
		ne->reason = reason;
		ne->flags = flags;
		ne->creator = source.GetNick();
		ne->created = Anope::CurTime;
		ne->expires = expires;
		NotifyList.AddNotify(ne);

		if (Anope::ReadOnly)
			source.Reply(READ_ONLY_MODE);

		unsigned matches = 0;

		/* If mask contains '#' but not '@', it's a channel mask */
		if (pound != Anope::string::npos && at == Anope::string::npos)
		{
			for (channel_map::const_iterator it = ChannelList.begin(); it != ChannelList.end(); ++it)
			{
				const Channel *c = it->second;

				if (!NotifyList.Check(c, ne->mask))
					continue;

				for (Channel::ChanUserList::const_iterator i = c->users.begin(); i != c->users.end(); ++i)
				{
					const User *u = i->first;

					if (NotifyList.ExistsAlready(u, ne))
						continue;

					NotifyList.AddMatch(u, ne);
					matches++;
				}
			}
		}
		else
		{
			for (user_map::const_iterator it = UserListByNick.begin(); it != UserListByNick.end(); ++it)
			{
				const User *u = it->second;

				if (NotifyList.Check(u, ne->mask))
				{
					NotifyList.AddMatch(u, ne);
					matches++;
				}
			}
		}

		Log(LOG_ADMIN, source, this) << "to " << (created ? "add" : "modify") << " a notify on " << mask << " for reason: " << reason << " (matches: " << matches << " user(s))";
		source.Reply("%s a notify on %s which matched %d user(s).", (created ? "Added" : "Modified"), mask.c_str(), matches);
	}

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

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

		if (NotifyList.GetNotifiesCount() == 0)
		{
			source.Reply("The notify list is empty.");
			return;
		}

		if (isdigit(match[0]) && match.find_first_not_of("1234567890,-") == Anope::string::npos)
		{
			NotifyDelCallback list(source, match, this);
			list.Process();
		}
		else
		{
			const NotifyEntry *ne = NotifyList.GetNotify(match);
			if (!ne)
			{
				source.Reply("\002%s\002 not found on the notify list.", match.c_str());
				return;
			}

			if (Anope::ReadOnly)
				source.Reply(READ_ONLY_MODE);

			Log(LOG_ADMIN, source, this) << "to remove " << ne->mask << " from the list";
			source.Reply("\002%s\002 deleted from the notify list.", ne->mask.c_str());
			delete ne;
		}
	}

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

		if (!match.empty() && isdigit(match[0]) && match.find_first_not_of("1234567890,-") == Anope::string::npos)
		{
			class ListCallback : public NumberList
			{
				CommandSource &source;
				ListFormatter &list;

			 public:
				ListCallback(CommandSource &_source, ListFormatter &_list, const Anope::string &numstr) : NumberList(numstr, false), source(_source), list(_list) { }

				void HandleNumber(unsigned number) anope_override
				{
					if (!number)
						return;

					const NotifyEntry *ne = NotifyList.GetNotify(number - 1);
					if (!ne)
						return;

					ListFormatter::ListEntry entry;
					entry["Number"] = stringify(number);
					entry["Mask"] = ne->mask;
					entry["Flags"] = Anope::string(ne->flags.begin(), ne->flags.end());
					entry["Reason"] = ne->reason;
					entry["Created"] = Anope::strftime(ne->created, source.nc, true);
					entry["By"] = ne->creator;
					entry["Expires"] = Anope::Expires(ne->expires, source.nc);
					list.AddEntry(entry);
				}
			}
			nl_list(source, list, match);
			nl_list.Process();
		}
		else
		{
			const std::vector<NotifyEntry *> &notifies = NotifyList.GetNotifies();
			for (unsigned i = 0; i < notifies.size(); ++i)
			{
				const NotifyEntry *ne = notifies.at(i);
				if (!ne)
					continue;

				if (match.empty() || match.equals_ci(ne->mask) || Anope::Match(ne->mask, match, false, true))
				{
					ListFormatter::ListEntry entry;
					entry["Number"] = stringify(i + 1);
					entry["Mask"] = ne->mask;
					entry["Flags"] = Anope::string(ne->flags.begin(), ne->flags.end());
					entry["Reason"] = ne->reason;
					entry["Created"] = Anope::strftime(ne->created, source.nc, true);
					entry["By"] = ne->creator;
					entry["Expires"] = Anope::Expires(ne->expires, source.nc);
					list.AddEntry(entry);
				}
			}
		}

		if (list.IsEmpty())
			source.Reply("No matching entries on the notify list.");
		else
		{
			source.Reply("Current notify list:");

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

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

			source.Reply("End of notify list.");
		}
	}

	void DoList(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (NotifyList.GetNotifiesCount() == 0)
		{
			source.Reply("The notify list is empty.");
			return;
		}

		ListFormatter list(source.GetAccount());
		list.AddColumn("Number").AddColumn("Mask").AddColumn("Reason");

		this->ProcessList(source, params, list);
	}

	void DoView(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (NotifyList.GetNotifiesCount() == 0)
		{
			source.Reply("The notify list is empty.");
			return;
		}

		ListFormatter list(source.GetAccount());
		list.AddColumn("Number").AddColumn("Mask").AddColumn("Flags").AddColumn("Reason");
		list.AddColumn("Created").AddColumn("By").AddColumn("Expires");

		this->ProcessList(source, params, list);
	}

	void DoClear(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (NotifyList.GetNotifiesCount() == 0)
		{
			source.Reply("The notify list is empty.");
			return;
		}

		if (Anope::ReadOnly)
			source.Reply(READ_ONLY_MODE);

		NotifyList.ClearNotifies();
		Log(LOG_ADMIN, source, this) << "to clear the list";
		source.Reply("The notify list has been cleared.");
	}

	void DoShow(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const PerEntryMap &current = NotifyList.GetEntryMap();
		if (current.empty())
		{
			source.Reply("No matching Users are currently online.");
			return;
		}

		ListFormatter list(source.GetAccount());
		list.AddColumn("Flags/Nick").AddColumn("Mask").AddColumn("Reason/Online Since");

		Anope::string last_mask;
		for (PerEntryMap::const_iterator it = current.begin(); it != current.end(); ++it)
		{
			const NotifyEntry *ne = it->first;
			const User *u = it->second;
			if (!ne || !u)
				continue;

			if (last_mask != ne->mask)
			{
				ListFormatter::ListEntry entry;
				entry["Flags/Nick"] = Anope::string(ne->flags.begin(), ne->flags.end());
				entry["Mask"] = ne->mask;
				entry["Reason/Online Since"] = ne->reason;
				list.AddEntry(entry);

				last_mask = ne->mask;
			}

			ListFormatter::ListEntry subentry;
			subentry["Flags/Nick"] = u->nick;
			subentry["Mask"] = u->GetIdent() + "@" + u->host + "#" + u->realname;
			subentry["Reason/Online Since"] = Anope::strftime(u->signon, source.nc, true);
			list.AddEntry(subentry);
		}

		if (list.IsEmpty())
			source.Reply("No matching entries currently online.");
		else
		{
			source.Reply("Currently matched online users:");

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

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

			source.Reply("End of matched online users.");
		}
	}

	void DoRemove(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (NotifyList.GetNotifiesCount() == 0)
		{
			source.Reply("The notify list is empty.");
			return;
		}

		if (params.size() < 2 || params.size() > 2)
		{
			this->OnSyntaxError(source, "REMOVE");
			return;
		}

		const PerUserMap &current = NotifyList.GetUserMap();
		if (current.empty())
		{
			source.Reply("No matching Users are currently online.");
			return;
		}

		const User *u = User::Find(params[1], true);
		if (!u)
		{
			source.Reply("No user found by the nick of %s", params[1].c_str());
			return;
		}

		if (!NotifyList.IsMatch(u))
		{
			source.Reply("%s is not currently a matched User.", u->nick.c_str());
			return;
		}

		NotifyList.DelMatch(u);
		Log(LOG_ADMIN, source, this) << "to remove " << u->nick << " from the matched Users list for Notify";
		source.Reply("%s has been removed the matched Users list.", u->nick.c_str());
	}

 public:
	CommandOSNotify(Module *creator) : Command(creator, "operserv/notify", 1, 4)
	{
		this->SetDesc("Manipulate the Notify (watch) list");
		this->SetSyntax("ADD +\037expiry\037 \037flags\037 \037mask\037 [:]\037reason\037");
		this->SetSyntax("DEL [\037mask\037 | \037entry-num\037 | \037list\037]");
		this->SetSyntax("LIST [\037mask\037 | \037entry-num\037 | \037list\037]");
		this->SetSyntax("VIEW [\037mask\037 | \037entry-num\037 | \037list\037]");
		this->SetSyntax("CLEAR");
		this->SetSyntax("SHOW [\037mask\037 | \037entry-num\037 | \037list\037]");
		this->SetSyntax("REMOVE \037nick\037");
	}

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

		if (subcmd.equals_ci("ADD"))
			this->DoAdd(source, params);
		else if (subcmd.equals_ci("DEL"))
			this->DoDel(source, params);
		else if (subcmd.equals_ci("LIST"))
			this->DoList(source, params);
		else if (subcmd.equals_ci("VIEW"))
			this->DoView(source, params);
		else if (subcmd.equals_ci("CLEAR"))
			this->DoClear(source, params);
		else if (subcmd.equals_ci("SHOW"))
			this->DoShow(source, params);
		else if (subcmd.equals_ci("REMOVE"))
			this->DoRemove(source, params);
		else
			this->OnSyntaxError(source, "");
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) anope_override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply("Notify allows Opers to create a list of masks that Users are matched against.\n"
			     "Matching Users have many of their 'events' tracked and logged\n"
			     "(typically to a log channel) for Opers to monitor.");
		source.Reply(" ");
		source.Reply("The \002ADD\002 command adds the given mask to the Notify list.\n"
			     "Reason \002must\002 be given and the mask should be in the format of\n"
			     "nick!user@host#real name (though all that is required is user@host) or\n"
			     "#channel to track users that join a matching channel.\n"
			     "If a real name is specified, the reason must be prepended with a :.\n"
			     "Flags are used to decide what to track, for all use \037*\037.\n"
			     "The available flags are:\n"
			     "c - User Connections\nd - User Disconnections\n"
			     "i - Channel Invites\nj - Channel Joins\n"
			     "k - Channel Kicks\nm - Channel Modes\n"
			     "n - User Nick changes\np - Channel Parts\n"
			     "s - Most Services commands\nS - More Services commands\n"
			     "t - Channel Topics\nu - User Modes\n"
			     "\037expiry\037 is specified as an integer followed by one of \037d\37 (days),\n"
			     " \037h\037 (hours), or \037m\037 (minutes). Combinations (such as \0371h30m\037)\n"
			     "are not permitted. If a unit specifier is not included, the default is days\n"
			     "(so \037+30\037 by itself means 30 days).\n"
			     "To add a Notify which does not expire, use \037+0\037.");

		const Anope::string &regexengine = Config->GetBlock("options")->Get<const Anope::string>("regexengine");
		if (!regexengine.empty())
		{
			source.Reply(" ");
			source.Reply("Regex matches are also supported using the %s engine.\n"
				     "Note that for a user mask, this will ONLY match against\n"
				     "either \037user@host\037 or \037nick!user@host#real\037\n"
				     "Enclose your pattern in // if this is desired.", regexengine.c_str());
		}

		source.Reply(" ");
		source.Reply("The \002DEL\002 command requires a parameter, one of a mask to match,\n"
			     "an entry number, or a list of entry numbers (1-5 or 1-3,5 format).\n"
			     "The \002LIST\002 and \002VIEW\002 commands can be used with no\n"
			     "parameters or with one of the above parameters, for DEL.\n");
		source.Reply("The \002CLEAR\002 command clears all entries of the Notify list.");
		source.Reply(" ");
		source.Reply("The \002SHOW\002 command lists Notify masks with currently matched Users\n"
			     "It can accept the same parameters as the \002LIST\002 and\n"
			     "\002VIEW\002 commands, including no parameters at all.");
		source.Reply("The \002REMOVE\002 command removes a user from the matched Users list.\n"
			     "This can be useful if a user gets matched by a playful/silly nick change\n"
			     "or as a temporary removal of tracking of the user.");

		return true;
	}

	void OnSyntaxError(CommandSource &source, const Anope::string &subcommand)
	{
		if (subcommand.equals_ci("ADD"))
			source.Reply("ADD +\037expiry\037 \037flags\037 \037mask\037 [:]\037reason\037");
		else if (subcommand.equals_ci("DEL"))
			source.Reply("DEL [\037mask\037 | \037entry-num\037 | \037list\037]");
		else if (subcommand.equals_ci("REMOVE"))
			source.Reply("REMOVE \037nick\037");
		else
			this->SendSyntax(source);
	}
};

class OSNotify : public Module
{
	Serialize::Type notifyentry_type;
	CommandOSNotify commandosnotify;
	BotInfo *OperServ;

	const Anope::string BuildNUHR(const User *u)
	{
		if (!u)
			return "unknown";

		return Anope::string(u->nick + "!" + u->GetIdent() + "@" + u->host + "#" + u->realname);
	}

	void NLog(const Anope::string &t, const char *m, ...)
	{
		char buf[4096];

		va_list args;
		va_start(args, m);
		vsnprintf(buf, sizeof(buf), m, args);
		Log(LOG_NORMAL, "notify/"+t, OperServ) << "NOTIFY: " << buf;
		va_end(args);
	}

	void Init()
	{
		const std::vector<NotifyEntry *> &notifies = NotifyList.GetNotifies();
		if (notifies.empty())
			return;

		unsigned matches = 0;
		for (user_map::const_iterator uit = UserListByNick.begin(); uit != UserListByNick.end(); ++uit)
		{
			const User *u = uit->second;
			if (!u || (u && u->server && u->server->IsULined()))
				continue;

			bool matched = false;
			for (unsigned i = notifies.size(); i > 0; --i)
			{
				const NotifyEntry *ne = notifies.at(i - 1);
				if (!ne)
					continue;

				if (NotifyList.Check(u, ne->mask))
				{
					NotifyList.AddMatch(u, ne);
					matched = true;
				}
			}

			if (matched)
				matches++;
		}

		if (matches > 0)
			NLog("user", "Matched %d user(s) against the Notify list", matches);
	}

	unsigned CheckUserOrChannel(User *u, Channel *c = NULL, bool wantChan = false)
	{
		const std::vector<NotifyEntry *> &notifies = NotifyList.GetNotifies();
		if (!u || (wantChan && !c) || notifies.empty() || (u->server && u->server->IsULined()))
			return 0;

		unsigned matches = 0;
		for (unsigned i = notifies.size(); i > 0; --i)
		{
			const NotifyEntry *ne = notifies.at(i - 1);
			if (!ne)
				continue;

			bool matched = false;
			if (wantChan && c)
				matched = NotifyList.Check(c, ne->mask);
			else if (!wantChan)
				matched = NotifyList.Check(u, ne->mask);

			if (matched)
			{
				if (NotifyList.ExistsAlready(u, ne))
					continue;

				NotifyList.AddMatch(u, ne);
				matches++;
			}
		}

		return matches;
	}

 public:
	OSNotify(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, THIRD),
		notifyentry_type("Notify", NotifyEntry::Unserialize), commandosnotify(this), OperServ(NULL)
	{
		if (Anope::VersionMajor() != 2 || Anope::VersionMinor() != 0)
			throw ModuleException("Requires version 2.0.x of Anope.");

		this->SetAuthor("genius3000");
		this->SetVersion("1.2.1");

		if (Me && Me->IsSynced())
			this->Init();
	}

	void OnReload(Configuration::Conf *conf) anope_override
	{
		OperServ = conf->GetClient("OperServ");
	}

	void OnUplinkSync(Server *) anope_override
	{
		this->Init();
	}

	void OnUserConnect(User *u, bool &) anope_override
	{
		if (Me && !Me->IsSynced())
			return;

		unsigned matches = CheckUserOrChannel(u);
		if (matches > 0)
		{
			if (NotifyList.HasFlag(u, 'c'))
				NLog("user", "'%s' connected [matches %d Notify mask(s)]", BuildNUHR(u).c_str(), matches);
		}
	}

	void OnUserQuit(User *u, const Anope::string &msg) anope_override
	{
		if (NotifyList.IsMatch(u))
		{
			if (NotifyList.HasFlag(u, 'd'))
				NLog("user", "'%s' disconnected (reason: %s)", BuildNUHR(u).c_str(), msg.c_str());

			NotifyList.DelMatch(u);
		}
	}

	void OnUserNickChange(User *u, const Anope::string &oldnick) anope_override
	{
		const Anope::string nuhr = oldnick + "!" + u->GetIdent() + "@" + u->host + "#" + u->realname;
		bool oldmatch = false;

		if (NotifyList.IsMatch(u))
			oldmatch = true;

		unsigned matches = CheckUserOrChannel(u);

		if (!NotifyList.HasFlag(u, 'n'))
			return;

		if (matches > 0)
		{
			if (oldmatch)
				NLog("user", "'%s' changed nick to %s [matches an additional %d Notify mask(s)]", nuhr.c_str(), u->nick.c_str(), matches);
			else
				NLog("user", "'%s' changed nick to %s [matches %d Notify mask(s)]", nuhr.c_str(), u->nick.c_str(), matches);
		}
		else if (oldmatch)
			NLog("user", "'%s' changed nick to %s", nuhr.c_str(), u->nick.c_str());
	}

	void OnJoinChannel(User *u, Channel *c) anope_override
	{
		bool oldmatch = false;

		if (NotifyList.IsMatch(u))
			oldmatch = true;

		unsigned matches = CheckUserOrChannel(u, c, true);

		if (!NotifyList.HasFlag(u, 'j'))
			return;

		if (matches > 0)
		{
			if (oldmatch)
				NLog("channel", "'%s' joined %s [matches an additional %d Notify mask(s)]", BuildNUHR(u).c_str(), c->name.c_str(), matches);
			else
				NLog("channel", "'%s' joined %s [matches %d Notify mask(s)]", BuildNUHR(u).c_str(), c->name.c_str(), matches);
		}
		else if (oldmatch)
			NLog("channel", "'%s' joined %s", BuildNUHR(u).c_str(), c->name.c_str());
	}

	void OnPartChannel(User *u, Channel *c, const Anope::string &channel, const Anope::string &msg) anope_override
	{
		if (NotifyList.HasFlag(u, 'p'))
			NLog("channel", "'%s' parted %s (reason: %s)", BuildNUHR(u).c_str(), c->name.c_str(), msg.c_str());
	}

	void OnUserKicked(const MessageSource &source, User *target, const Anope::string &channel, ChannelStatus &status, const Anope::string &kickmsg) anope_override
	{
		User *u = source.GetUser();

		if (NotifyList.HasFlag(target, 'k'))
			NLog("channel", "'%s' was kicked from %s by %s (reason: %s)", BuildNUHR(target).c_str(), channel.c_str(), (u ? u->nick.c_str() : "unknown"), kickmsg.c_str());

		if (u && NotifyList.HasFlag(u, 'k'))
			NLog("channel", "'%s' kicked %s from %s (reason: %s)", BuildNUHR(u).c_str(), target->nick.c_str(), channel.c_str(), kickmsg.c_str());
	}

	void OnUserMode(const MessageSource &setter, User *u, const Anope::string &mname, bool setting)
	{
		const Anope::string &nuhr = BuildNUHR(u);
		UserMode *um = ModeManager::FindUserModeByName(mname);

		if (setter.GetUser() && setter.GetUser() != u)
			NLog("user", "%s %sset mode %c (%s) on '%s'", setter.GetUser()->nick.c_str(), (setting ? "" : "un"), (um ? um->mchar : '\0'), mname.c_str(), nuhr.c_str());
		else
			NLog("user", "'%s' %sset mode %c (%s)", nuhr.c_str(), (setting ? "" : "un"), (um ? um->mchar : '\0'), mname.c_str());
	}

	void OnUserModeSet(const MessageSource &setter, User *u, const Anope::string &mname) anope_override
	{
		if (NotifyList.HasFlag(u, 'u'))
			OnUserMode(setter, u, mname, true);
	}

	void OnUserModeUnset(const MessageSource &setter, User *u, const Anope::string &mname) anope_override
	{
		if (NotifyList.HasFlag(u, 'u'))
			OnUserMode(setter, u, mname, false);
	}

	void OnChannelMode(Channel *c, MessageSource &setter, ChannelMode *mode, const Anope::string &param, bool setting)
	{
		const User *u = setter.GetUser();
		if (!u)
			return;

		if (NotifyList.HasFlag(u, 'm'))
		{
			if (mode->type == MODE_STATUS)
			{
				const User *target = User::Find(param, false);
				NLog("channel", "'%s' %sset channel mode %c (%s) on %s on %s", BuildNUHR(u).c_str(), (setting ? "" : "un"), mode->mchar, mode->name.c_str(), (target ? target->nick.c_str() : "unknown"), c->name.c_str());
			}
			else
				NLog("channel", "'%s' %sset channel mode %c (%s) [%s] on %s", BuildNUHR(u).c_str(), (setting ? "" : "un"), mode->mchar, mode->name.c_str(), (param.empty() ? "" : param.c_str()), c->name.c_str());
		}
		else if (mode->type == MODE_STATUS)
		{
			const User *target = User::Find(param, false);
			if (target && NotifyList.HasFlag(target, 'm'))
				NLog("channel", "%s %sset channel mode %c (%s) on '%s' on %s", u->nick.c_str(), (setting ? "" : "un"), mode->mchar, mode->name.c_str(), BuildNUHR(target).c_str(), c->name.c_str());
		}
	}

	EventReturn OnChannelModeSet(Channel *c, MessageSource &setter, ChannelMode *mode, const Anope::string &param) anope_override
	{
		OnChannelMode(c, setter, mode, param, true);

		return EVENT_CONTINUE;
	}

	EventReturn OnChannelModeUnset(Channel *c, MessageSource &setter, ChannelMode *mode, const Anope::string &param) anope_override
	{
		OnChannelMode(c, setter, mode, param, false);

		return EVENT_CONTINUE;
	}

	void OnTopicUpdated(User *source, Channel *c, const Anope::string &user, const Anope::string &topic) anope_override
	{
		/* Ignore Services setting topic upon channel creation */
		if (c->topic_ts != Anope::CurTime && c->topic_ts != c->topic_time)
			return;

		const User *u = source ? source : User::Find(user, false);

		if (u && NotifyList.HasFlag(u, 't'))
			NLog("channel", "'%s' changed topic on %s to %s", BuildNUHR(u).c_str(), c->name.c_str(), topic.c_str());
	}

	void UserInvite(const Anope::string &source, const Anope::string &target, const Anope::string &chan)
	{
		User *src = User::Find(source, false);
		User *dst = User::Find(target, false);

		if (src && NotifyList.HasFlag(src, 'i'))
		{
			NLog("channel", "'%s' invited %s to %s", BuildNUHR(src).c_str(), (dst ? dst->nick.c_str() : target.c_str()), chan.c_str());
		}
		else if (dst && NotifyList.HasFlag(dst, 'i'))
		{
			NLog("channel", "%s invited '%s' to %s", (src ? src->nick.c_str() : source.c_str()), BuildNUHR(dst).c_str(), chan.c_str());
		}
	}

	void OnPostCommand(CommandSource &source, Command *command, const std::vector<Anope::string> &params) anope_override
	{
		const User *u = source.GetUser();
		if (!u)
			return;

		const Anope::string &cmd = command->name;
		if (cmd == "chanserv/invite" && !params.empty())
			UserInvite(source.GetNick(), (params.size() > 1 ? params[1] : source.GetNick()), params[0]);

		if ((!NotifyList.HasFlag(u, 's') && !Anope::Match(cmd, "*/set/*")) ||
		    (!NotifyList.HasFlag(u, 'S') && Anope::Match(cmd, "*/set/*")))
			return;

		Anope::string strparams;
		if (!params.empty() && cmd != "nickserv/register" && cmd != "nickserv/identify" && cmd != "nickserv/confirm" &&
		    cmd != "nickserv/group" && cmd != "nickserv/recover" && cmd != "nickserv/set/password" &&
		    cmd != "nickserv/cert" && cmd != "memoserv/send" && cmd != "memoserv/rsend" && cmd != "memoserv/staff")
		{
			for (unsigned i = 0; i < params.size(); ++i)
				strparams.append(params[i] + " ");
			strparams.rtrim(" ");
		}

		const Anope::string scmd = source.service->nick + " " + cmd.substr(cmd.find('/') + 1).replace_all_ci("/", " ").upper();

		NLog("commands", "'%s' used %s [%s]", BuildNUHR(u).c_str(), scmd.c_str(), (strparams.empty() ? "" : strparams.c_str()));
	}

	EventReturn OnMessage(MessageSource &source, Anope::string &command, std::vector<Anope::string> &params) anope_override
	{
		if (command == "INVITE" && params.size() > 1)
			UserInvite(source.GetName(), params[0], params[1]);

		return EVENT_CONTINUE;
	}
};

MODULE_INIT(OSNotify)