hs_offer.cpp

/*
 * HostServ Offer
 *
 * (C) 2017-2018 - genius3000 (genius3000@g3k.solutions)
 * Please refer to the GPL License in use by Anope at:
 * https://github.com/anope/anope/blob/master/docs/COPYING
 *
 * Offer specialized vHosts to users, with substitution arguments available.
 * They can be permanent or limited time (expiry).
 *
 * Syntax (oper): OFFER {ADD | DEL | LIST | VIEW | CLEAR} +expiry vhost reason | [vhost | entry-num | list]
 * Syntax (user): OFFERLIST [TAKE] [vhost | entry-num | list]
 *
 * Configuration to put into your hostserv config:
module { name = "hs_offer"; takedelay = 7d; }
command { service = "HostServ"; name = "OFFER"; command = "hostserv/offer"; permission = "hostserv/offer"; }
command { service = "HostServ"; name = "OFFERLIST"; command = "hostserv/offerlist"; }
 *
 * takedelay: duration between allowed TAKEs
 * Don't forget to add 'hostserv/offer' to your oper permissions
 */

#include "module.h"


/* Individual host offer data */
struct HostOffer : Serializable
{
 public:
	Anope::string ident;
	Anope::string host;
	Anope::string creator;
	Anope::string reason;
	time_t created;
	time_t expires;

	HostOffer() : Serializable("HostOffer") { }

	HostOffer(const Anope::string &i, const Anope::string &h,  const Anope::string &cr, const Anope::string &r, time_t cd, time_t e)
		: Serializable("HostOffer"), ident(i), host(h), creator(cr), reason(r), created(cd), expires(e) { }

	~HostOffer();

	void Serialize(Serialize::Data &data) const anope_override
	{
		data["ident"] << this->ident;
		data["host"] << this->host;
		data["creator"] << this->creator;
		data["reason"] << this->reason;
		data["created"] << this->created;
		data["expires"] << this->expires;
	}

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

/* List of host offers */
class HostOffersList
{
 protected:
	Serialize::Checker<std::vector<HostOffer *> > offers;

 public:
	HostOffersList() : offers("HostOffer") { }

	~HostOffersList()
	{
		for (unsigned i = offers->size(); i > 0; --i)
			delete offers->at(i - 1);
	}

	void Add(HostOffer *ho)
	{
		offers->push_back(ho);
	}

	void Del(HostOffer *ho)
	{
		std::vector<HostOffer *>::iterator it = std::find(offers->begin(), offers->end(), ho);
		if (it != offers->end())
			offers->erase(it);
	}

	void Clear()
	{
		for (unsigned i = offers->size(); i > 0; --i)
			delete offers->at(i - 1);
	}

	void Expire(const HostOffer *ho)
	{
		Log(Config->GetClient("HostServ"), "expire/offer") << "Expiring vHost Offer " << (!ho->ident.empty() ? ho->ident + "@" : "") << ho->host;
		delete ho;
	}

	unsigned GetCount()
	{
		return offers->size();
	}

	const HostOffer *Get(const Anope::string &match)
	{
		for (unsigned i = offers->size(); i > 0; --i)
		{
			const HostOffer *ho = offers->at(i - 1);
			const Anope::string vhost = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;

			if (ho->expires && ho->expires <= Anope::CurTime)
				Expire(ho);
			else if (vhost.equals_ci(match))
				return ho;
		}

		return NULL;
	}

	const HostOffer *Get(const unsigned number)
	{
		if (number >= offers->size())
			return NULL;

		const HostOffer *ho = offers->at(number);
		if (ho->expires && ho->expires <= Anope::CurTime)
		{
			Expire(ho);
			return NULL;
		}

		return ho;
	}

	const std::vector<HostOffer *> GetAll()
	{
		std::vector<HostOffer *> list;

		for (unsigned i = offers->size(); i > 0; --i)
		{
			HostOffer *ho = offers->at(i - 1);

			if (ho->expires && ho->expires <= Anope::CurTime)
				Expire(ho);
			else
				list.insert(list.begin(), ho);
		}

		return list;
	}
}
HostOffersList;

HostOffer::~HostOffer()
{
	HostOffersList.Del(this);
}

Serializable* HostOffer::Unserialize(Serializable *obj, Serialize::Data &data)
{
	HostOffer *ho;

	if (obj)
		ho = anope_dynamic_static_cast<HostOffer *>(obj);
	else
		ho = new HostOffer;

	data["ident"] >> ho->ident;
	data["host"] >> ho->host;
	data["reason"] >> ho->reason;
	data["creator"] >> ho->creator;
	data["created"] >> ho->created;
	data["expires"] >> ho->expires;

	if (!obj)
		HostOffersList.Add(ho);

	return ho;
}

/* Handle number and list deletions */
class OfferDelCallback : public NumberList
{
	CommandSource &source;
	unsigned deleted;
	Command *cmd;

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

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

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

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

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

		const HostOffer *ho = HostOffersList.Get(number - 1);
		if (!ho)
			return;

		Log(LOG_ADMIN, source, cmd) << "to remove " << (!ho->ident.empty() ? ho->ident + "@" : "") << ho->host << " from the list";
		delete ho;
		++deleted;
	}
};

/* Ident and Host functions */
enum ValidateReturn
{
	VALIDATE_PASS,
	VALIDATE_TOOLONG,
	VALIDATE_INVCHAR
};

bool isvalidchar(char c)
{
	if ((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '.' || c == '-')
		return true;

	return false;
}

ValidateReturn ValidateIdent(const Anope::string &ident)
{
	if (ident.length() > Config->GetBlock("networkinfo")->Get<unsigned>("userlen"))
		return VALIDATE_TOOLONG;

	for (Anope::string::const_iterator s = ident.begin(), s_end = ident.end(); s != s_end; ++s)
	{
		if (!isvalidchar(*s))
			return VALIDATE_INVCHAR;
	}

	return VALIDATE_PASS;
}

ValidateReturn ValidateHost(const Anope::string &host)
{
	if (host.length() > Config->GetBlock("networkinfo")->Get<unsigned>("hostlen"))
		return VALIDATE_TOOLONG;
	if (!IRCD->IsHostValid(host))
		return VALIDATE_INVCHAR;

	return VALIDATE_PASS;
}

const Anope::string ReplaceArgs(const Anope::string &ih, const Anope::string &nick)
{
	if (ih.empty() || ih.find('$') == Anope::string::npos)
		return ih;

	Anope::string str = ih;
	NickAlias *na = NickAlias::Find(nick);

	str = str.replace_all_ci("$account", (na ? na->nc->display : ""));
	str = str.replace_all_ci("$nick", (na ? na->nick : ""));
	str = str.replace_all_ci("$netname", Config->GetBlock("networkinfo")->Get<Anope::string>("networkname"));
	str = str.replace_all_ci("$regepoch", (na ? stringify(na->time_registered) : ""));

	if (Anope::Match(ih, "*$regdate*"))
	{
		if (!na)
		{
			str = str.replace_all_ci("$regdate", "");
			return str;
		}

		tm tm = *localtime(&(na->time_registered));
		char buf[BUFSIZE];
		strftime(buf, sizeof(buf), "%Y-%m-%d", &tm);
		str = str.replace_all_ci("$regdate", buf);
	}

	return str;
}

class CommandHSOffer : public Command
{
 private:
	void DoAdd(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (params.size() < 4)
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}

		Anope::string expiry, ident, host;

		expiry = params[1];
		if (expiry[0] != '+')
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}

		time_t expires = Anope::DoTime(expiry);
		if (isdigit(expiry[expiry.length() - 1]))
			expires *= 86400;
		if (expires > 0)
			expires += Anope::CurTime;

		const Anope::string &vHost = params[2];
		const Anope::string &reason = params[3];

		size_t at = vHost.find('@');
		if (at == Anope::string::npos)
			host = vHost;
		else
		{
			ident = vHost.substr(0, at);
			host = vHost.substr(at + 1);
		}

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

		if (!ident.empty())
		{
			if (!IRCD->CanSetVIdent)
			{
				source.Reply(HOST_NO_VIDENT);
				return;
			}

			/* Only allow one argument in the ident as it has a short length limit */
			size_t sigil = ident.find('$');
			if (sigil != Anope::string::npos && ident.substr(sigil + 1).find('$') != Anope::string::npos)
			{
				source.Reply("You cannot have more than one argument in the vIdent.");
				return;
			}

			Anope::string sub_ident;
			if (sigil != Anope::string::npos)
				sub_ident = ReplaceArgs(ident, source.GetNick());
			else
				sub_ident = ident;

			ValidateReturn ret = ValidateIdent(sub_ident);
			if (ret == VALIDATE_TOOLONG)
			{
				/* Let's give $account and $nick a chance, it might be good for other users */
				if (!Anope::Match(ident, "*$account*") && !Anope::Match(ident, "*$nick*"))
				{
					source.Reply(HOST_SET_IDENTTOOLONG, Config->GetBlock("networkinfo")->Get<unsigned>("userlen"));
					return;
				}
			}
			else if (ret == VALIDATE_INVCHAR)
			{
				source.Reply(HOST_SET_IDENT_ERROR);
				return;
			}
		}

		Anope::string sub_host;
		if (host.find('$') != Anope::string::npos)
			sub_host = ReplaceArgs(host, source.GetNick());
		else
			sub_host = host;

		ValidateReturn ret = ValidateHost(sub_host);
		if (ret == VALIDATE_TOOLONG)
		{
			source.Reply(HOST_SET_TOOLONG, Config->GetBlock("networkinfo")->Get<unsigned>("hostlen"));
			return;
		}
		else if (ret == VALIDATE_INVCHAR)
		{
			source.Reply(HOST_SET_ERROR);
			return;
		}

		const Anope::string full_vHost = (!ident.empty() ? ident + "@" : "") + host;
		if (HostOffersList.Get(full_vHost))
		{
			source.Reply("Host offer \002%s\002 already exists.", full_vHost.c_str());
			return;
		}

		HostOffer *ho = new HostOffer(ident, host, source.GetNick(), reason, Anope::CurTime, expires);
		HostOffersList.Add(ho);

		Log(LOG_ADMIN, source, this) << "to add a host offer of " << full_vHost << " (reason: " << reason << ")";
		source.Reply("\002%s\002 added to the host offer list.", full_vHost.c_str());
	}

	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 (HostOffersList.GetCount() == 0)
		{
			source.Reply("Host offer list is empty.");
			return;
		}

		if (isdigit(match[0]) && match.find_first_not_of("1234567890,-") == Anope::string::npos)
		{
			OfferDelCallback list(source, match, this);
			list.Process();
		}
		else
		{
			const HostOffer *ho = HostOffersList.Get(match);
			if (!ho)
			{
				source.Reply("\002%s\002 not found on the host offer list.", match.c_str());
				return;
			}

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

			const Anope::string vHost = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;
			Log(LOG_ADMIN, source, this) << "to remove " << vHost << " from the list";
			source.Reply("\002%s\002 deleted from the host offer list.", vHost.c_str());

			delete ho;
		}
	}

	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 HostOffer *ho = HostOffersList.Get(number - 1);
					if (!ho)
						return;

					ListFormatter::ListEntry entry;
					entry["Number"] = stringify(number);
					entry["vHost"] = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;
					entry["Reason"] = ho->reason;
					entry["Creator"] = ho->creator;
					entry["Created"] = Anope::strftime(ho->created, source.GetAccount(), true);
					entry["Expires"] = Anope::Expires(ho->expires, source.GetAccount());
					list.AddEntry(entry);
				}
			}
			nl_list(source, list, match);
			nl_list.Process();
		}
		else
		{
			const std::vector<HostOffer *> &list_offers = HostOffersList.GetAll();
			for (unsigned i = 0; i < list_offers.size(); ++i)
			{
				const HostOffer *ho = list_offers.at(i);
				if (!ho)
					continue;

				const Anope::string vHost = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;
				if (match.empty() || match.equals_ci(vHost) || Anope::Match(vHost, match))
				{
					ListFormatter::ListEntry entry;
					entry["Number"] = stringify(i + 1);
					entry["vHost"] = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;
					entry["Reason"] = ho->reason;
					entry["Creator"] = ho->creator;
					entry["Created"] = Anope::strftime(ho->created, source.GetAccount(), true);
					entry["Expires"] = Anope::Expires(ho->expires, source.GetAccount());
					list.AddEntry(entry);
				}
			}
		}

		if (list.IsEmpty())
			source.Reply("No matching entries on the host offer list.");
		else
		{
			source.Reply("Current host offer 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 host offer list.");
		}
	}

	void DoList(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (HostOffersList.GetCount() == 0)
		{
			source.Reply("Host offer list is empty.");
			return;
		}

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

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

	void DoView(CommandSource &source, const std::vector<Anope::string> &params)
	{
		if (HostOffersList.GetCount() == 0)
		{
			source.Reply("Host offer list is empty.");
			return;
		}

		ListFormatter list(source.GetAccount());
		list.AddColumn("Number").AddColumn("vHost").AddColumn("Reason");
		list.AddColumn("Creator").AddColumn("Created").AddColumn("Expires");

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

	void DoClear(CommandSource &source)
	{
		if (HostOffersList.GetCount() == 0)
		{
			source.Reply("Host offer list is empty.");
			return;
		}

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

		HostOffersList.Clear();

		Log(LOG_ADMIN, source, this) << "to clear the list";
		source.Reply("Host offer list has been cleared.");
	}

 public:
	CommandHSOffer(Module *creator) : Command(creator, "hostserv/offer", 1, 4)
	{
		this->SetDesc("Manipulate the host offer list");
		this->SetSyntax("ADD +\037expiry\037 \037vHost\037 \037reason\037");
		this->SetSyntax("DEL {\037vHost\037 | \037entry-num\037 | \037list\037}");
		this->SetSyntax("LIST [\037vHost mask\037 | \037entry-num\037 | \037list\037");
		this->SetSyntax("VIEW [\037vHost mask\037 | \037entry-num\037 | \037list\037");
		this->SetSyntax("CLEAR");
	}

	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);
		else
			this->OnSyntaxError(source, "");
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) anope_override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply("Offer specialized vHosts to your users. These offers can have a set\n"
			     "expiry (limited time only offers) or be permanent. Arguments can be used\n"
			     "to create unique to the user vHosts upon taking.");
		source.Reply(" ");
		source.Reply("The \002ADD\002 command requires all 3 parameters.\n"
			     "\037expiry\037 is specified as an integer followed by one of \037d\37\n"
			     "(days), \037h\037 (hours), or \037m\037 (minutes). Combinations (such as\n"
			     "\0371h30m\037) are not permitted. If a unit specifier is not included,\n"
			     "the default is days (so \037+30\037 by itself means 30 days).\n"
			     "To add an Offer which does not expire, use \037+0\037.");

		if (IRCD->CanSetVIdent)
		{
			source.Reply("vHost can be \037vIdent@vHost\037 or just \037vHost\037\n"
				     "and both can contain arguments for substitution. Note that the\n"
				     "vIdent can only contain one argument and be %d characters long.",
				     Config->GetBlock("networkinfo")->Get<unsigned>("userlen"));
		}
		else
			source.Reply("The \037vHost\037 can contain arguments for substitution.");

		source.Reply("Available arguments are:\n"
			     "$account - Display nick of the user's account\n"
			     "$nick - Nick alias\n"
			     "$regdate - Date <nick> was registered in YYYY-MM-DD\n"
			     "$regepoch - Time <nick> was registered in epoch time\n"
			     "$netname - Network Name\n"
			     "The \037reason\037 is visible to users.");
		source.Reply(" ");
		source.Reply("The \002DEL\002 command requires a parameter, one of a vHost 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 of the host offers from the list.");

		return true;
	}

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

class CommandHSOfferList : public Command
{
 private:
	void DoTake(CommandSource &source, const std::vector<Anope::string> &params)
	{
		NickAlias *na = NickAlias::Find(source.GetNick());
		const HostOffer *ho;

		if (!na || na->nc != source.GetAccount())
		{
			source.Reply(ACCESS_DENIED);
			return;
		}

		if (source.GetAccount()->HasExt("UNCONFIRMED"))
		{
			source.Reply("You must confirm your account before you may take a vHost.");
			return;
		}

		const time_t take_delay = Config->GetModule(this->module)->Get<time_t>("takedelay");
		if (take_delay > 0 && na->HasVhost() && na->GetVhostCreated() + take_delay > Anope::CurTime)
		{
			source.Reply("Please wait %s before taking a new vHost.", Anope::Duration(take_delay, source.GetAccount()).c_str());
			return;
		}

		const Anope::string &match = params.size() > 1 ? params[1] : "";
		if (match.empty())
		{
			this->OnSyntaxError(source, "TAKE");
			return;
		}

		if (HostOffersList.GetCount() == 0)
		{
			source.Reply("Host offer list is empty.");
			return;
		}

		if (match.find_first_not_of("1234567890") == Anope::string::npos)
		{
			try
			{
				const unsigned number = convertTo<unsigned>(match);
				if (number > 0)
					ho = HostOffersList.Get(number - 1);
			}
			catch (const ConvertException &)
			{
				source.Reply("'%s' is an invalid entry number", match.c_str());
				return;
			}

			if (!ho)
			{
				source.Reply("%s is an invalid entry number", match.c_str());
				return;
			}
		}
		else
		{
			ho = HostOffersList.Get(match);
			if (!ho)
			{
				source.Reply("\002%s\002 not found on the host offer list.", match.c_str());
				return;
			}
		}

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

		const Anope::string &ident = ReplaceArgs(ho->ident, source.GetNick());
		const Anope::string &host = ReplaceArgs(ho->host, source.GetNick());

		ValidateReturn ret;
		if ((ret = ValidateIdent(ident)) != VALIDATE_PASS)
		{
			if (ret == VALIDATE_TOOLONG)
				source.Reply(HOST_SET_IDENTTOOLONG, Config->GetBlock("networkinfo")->Get<unsigned>("userlen"));
			else if (ret == VALIDATE_INVCHAR)
				source.Reply(HOST_SET_IDENT_ERROR);

			return;
		}

		if ((ret = ValidateHost(host)) != VALIDATE_PASS)
		{
			if (ret == VALIDATE_TOOLONG)
				source.Reply(HOST_SET_TOOLONG, Config->GetBlock("networkinfo")->Get<unsigned>("hostlen"));
			else if (ret == VALIDATE_INVCHAR)
				source.Reply(HOST_SET_ERROR);

			return;
		}

		Log(LOG_COMMAND, source, this) << "to take offer " << (!ho->ident.empty() ? ho->ident + "@" : "") << ho->host << " and set their vHost to " << (!ident.empty() ? ident + "@" : "") + host;
		na->SetVhost(ident, host, ho->creator);
		FOREACH_MOD(OnSetVhost, (na));
	}

	void DoList(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const NickAlias *na = NickAlias::Find(source.GetNick());

		if (!na || na->nc != source.GetAccount())
		{
			source.Reply(ACCESS_DENIED);
			return;
		}

		if (source.GetAccount()->HasExt("UNCONFIRMED"))
		{
			source.Reply("You must confirm your account before you can view the host offer list.");
			return;
		}

		if (HostOffersList.GetCount() == 0)
		{
			source.Reply("Host offer list is empty.");
			return;
		}

		ListFormatter list(source.GetAccount());
		list.AddColumn("Number").AddColumn("Offer vHost").AddColumn("Your vHost").AddColumn("Expires").AddColumn("Reason");

		const Anope::string &match = params.size() > 0 ? params[0] : "";
		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 HostOffer *ho = HostOffersList.Get(number - 1);
					if (!ho)
						return;

					const Anope::string &ident = ReplaceArgs(ho->ident, source.GetNick());
					const Anope::string &host = ReplaceArgs(ho->host, source.GetNick());
					ValidateReturn ret_ident = ValidateIdent(ident);
					ValidateReturn ret_host = ValidateHost(host);
					bool invalid = (ret_ident != VALIDATE_PASS || ret_host != VALIDATE_PASS);

					ListFormatter::ListEntry entry;
					entry["Number"] = stringify(number);
					entry["Offer vHost"] = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;
					entry["Your vHost"] = (!ident.empty() ? ident + "@" : "") + host + (invalid ? " [Invalid]" : "");
					entry["Expires"] = Anope::Expires(ho->expires, source.GetAccount());
					entry["Reason"] = ho->reason;
					list.AddEntry(entry);
				}
			}
			nl_list(source, list, match);
			nl_list.Process();
		}
		else
		{
			const std::vector<HostOffer *> &list_offers = HostOffersList.GetAll();
			for (unsigned i = 0; i < list_offers.size(); ++i)
			{
				const HostOffer *ho = list_offers.at(i);
				if (!ho)
					continue;

				const Anope::string vHost = (!ho->ident.empty() ? ho->ident + "@" : "") + ho->host;
				if (match.empty() || match.equals_ci(vHost) || Anope::Match(vHost, match, false, true))
				{
					const Anope::string &ident = ReplaceArgs(ho->ident, source.GetNick());
					const Anope::string &host = ReplaceArgs(ho->host, source.GetNick());
					ValidateReturn ret_ident = ValidateIdent(ident);
					ValidateReturn ret_host = ValidateHost(host);
					bool invalid = (ret_ident != VALIDATE_PASS || ret_host != VALIDATE_PASS);

					ListFormatter::ListEntry entry;
					entry["Number"] = stringify(i + 1);
					entry["Offer vHost"] = vHost;
					entry["Your vHost"] = (!ident.empty() ? ident + "@" : "") + host + (invalid ? " [Invalid]" : "");
					entry["Expires"] = Anope::Expires(ho->expires, source.GetAccount());
					entry["Reason"] = ho->reason;
					list.AddEntry(entry);
				}
			}
		}

		if (list.IsEmpty())
			source.Reply("No matching entries on the host offer list.");
		else
		{
			source.Reply("Current host offer 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 host offer list.");
		}
	}

 public:
	CommandHSOfferList(Module *creator) : Command(creator, "hostserv/offerlist", 0, 2)
	{
		this->SetDesc("List or take a vHost from the host offer list");
		this->SetSyntax(" [\037vHost mask\037 | \037entry-num\037 | \037list\037]");
		this->SetSyntax("TAKE {\037vHost\037 | \037entry-num\037}");
		this->RequireUser(true);
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) anope_override
	{
		if (!params.empty() && params[0].equals_ci("TAKE"))
			this->DoTake(source, params);
		else
			this->DoList(source, params);
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) anope_override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply("List or take an offered vHost.");
		source.Reply("The offers may contain substitution arguments which start with a '$':\n"
			     "$account - Your account name (main display nick)\n"
			     "$nick - Your current nick\n"
			     "$regdate - Date your nick was registered in YYYY-MM-DD\n"
			     "$regepoch - Time your nick was registered in epoch time\n"
			     "$netname - This IRC Network's Name\n");
		source.Reply("An \002[Invalid]\002 after \037Your vHost\037 means that substitution\n"
			     "specific to you causes the Offer vHost to become invalid to the network.");
		source.Reply("With no parameters a complete list is shown. You can filter that with a wildcard\n"
			     "\037user@host\037 or \037host\037 mask, an entry-number, or a list (1-5 or 1-3,5 format).");
		source.Reply("The \002TAKE\002 command requires either the exact \037Offer vHost\037 as\n"
			     "shown or the entry-number.");

		return true;
	}

	void OnSyntaxError(CommandSource &source, const Anope::string &subcommand) anope_override
	{
		if (subcommand.equals_ci("TAKE"))
			source.Reply("TAKE {\037vHost\037 | \037entry-num\037}");
		else
			this->SendSyntax(source);
	}
};

class HSOffer : public Module
{
	Serialize::Type hostoffer_type;
	CommandHSOffer commandhsoffer;
	CommandHSOfferList commandhsofferlist;

 public:
	HSOffer(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, THIRD),
		hostoffer_type("HostOffer", HostOffer::Unserialize),
		commandhsoffer(this), commandhsofferlist(this)
	{
		if (Anope::VersionMajor() != 2 || Anope::VersionMinor() != 0)
			throw ModuleException("Requires version 2.0.x of Anope.");

		this->SetAuthor("genius3000");
		this->SetVersion("1.0.2");
	}

	void OnReload(Configuration::Conf *conf) anope_override
	{
		if (!conf->GetClient("HostServ"))
			throw ModuleException("Requires HostServ to be loaded.");
	}
};

MODULE_INIT(HSOffer)