anope/modules/memoserv/ms_list.cpp

// Anope IRC Services <https://www.anope.org/>
//
// Copyright (C) 2003-2026 Anope Contributors
//
// Anope is free software. You can use, modify, and/or distribute it under the
// terms of version 2 of the GNU General Public License. See docs/LICENSE.txt
// for the complete terms of this license and docs/AUTHORS.txt for a list of
// contributors.
//
// Based on the original code of Epona by Lara
// Based on the original code of Services by Andy Church
//
// SPDX-License-Identifier: GPL-2.0-only

#include "module.h"

class CommandMSList final
	: public Command
{
public:
	CommandMSList(Module *creator) : Command(creator, "memoserv/list", 0, 2)
	{
		this->SetDesc(_("List your memos"));
		this->SetSyntax(_("[\037channel\037] [\037list\037 | NEW]"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
	{

		Anope::string param = !params.empty() ? params[0] : "", chan;
		ChannelInfo *ci = NULL;
		const MemoInfo *mi;

		if (!param.empty() && param[0] == '#')
		{
			chan = param;
			param = params.size() > 1 ? params[1] : "";

			ci = ChannelInfo::Find(chan);
			if (!ci)
			{
				source.Reply(CHAN_X_NOT_REGISTERED, chan.c_str());
				return;
			}
			else if (!source.AccessFor(ci).HasPriv("MEMO"))
			{
				source.Reply(ACCESS_DENIED);
				return;
			}
			mi = &ci->memos;
		}
		else
			mi = &source.nc->memos;

		if (!param.empty() && !isdigit(param[0]) && !param.equals_ci("NEW"))
			this->OnSyntaxError(source, param);
		else if (!mi->memos->size())
		{
			if (!chan.empty())
				source.Reply(MEMO_X_HAS_NO_MEMOS, chan.c_str());
			else
				source.Reply(MEMO_HAVE_NO_MEMOS);
		}
		else
		{
			ListFormatter list(source.GetAccount());
			list.AddColumn(_("Number")).AddColumn(_("Sender")).AddColumn(_("Date/Time"));
			list.SetFlexible(_("{number}: sent by \002{sender}\002 at {date/time}"));

			if (!param.empty() && isdigit(param[0]))
			{
				class MemoListCallback final
					: public NumberList
				{
					ListFormatter &list;
					CommandSource &source;
					const MemoInfo *mi;
				public:
					MemoListCallback(ListFormatter &_list, CommandSource &_source, const MemoInfo *_mi, const Anope::string &numlist) : NumberList(numlist, false), list(_list), source(_source), mi(_mi)
					{
					}

					void HandleNumber(unsigned number) override
					{
						if (!number || number > mi->memos->size())
							return;

						const Memo *m = mi->GetMemo(number - 1);

						ListFormatter::ListEntry entry;
						entry["Number"] = (m->unread ? "* " : "  ") + Anope::ToString(number);
						entry["Sender"] = m->sender;
						entry["Date/Time"] = Anope::strftime(m->time, source.GetAccount());
						this->list.AddEntry(entry);
					}
				}
				mlc(list, source, mi, param);
				mlc.Process();
			}
			else
			{
				if (!param.empty())
				{
					unsigned i, end;
					for (i = 0, end = mi->memos->size(); i < end; ++i)
						if (mi->GetMemo(i)->unread)
							break;
					if (i == end)
					{
						if (!chan.empty())
							source.Reply(MEMO_X_HAS_NO_NEW_MEMOS, chan.c_str());
						else
							source.Reply(MEMO_HAVE_NO_NEW_MEMOS);
						return;
					}
				}

				for (unsigned i = 0, end = mi->memos->size(); i < end; ++i)
				{
					if (!param.empty() && !mi->GetMemo(i)->unread)
						continue;

					const Memo *m = mi->GetMemo(i);

					ListFormatter::ListEntry entry;
					entry["Number"] = (m->unread ? "* " : "  ") + Anope::ToString(i + 1);
					entry["Sender"] = m->sender;
					entry["Date/Time"] = Anope::strftime(m->time, source.GetAccount());
					list.AddEntry(entry);
				}
			}

			source.Reply(_("Memos for %s:"), ci ? ci->name.c_str() : source.GetNick().c_str());
			list.SendTo(source);
		}
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply(_(
			"Lists any memos you currently have. With \002NEW\002, lists only "
			"new (unread) memos. Unread memos are marked with a \"*\" "
			"to the left of the memo number. You can also specify a list "
			"of numbers."
		));

		ExampleWrapper examples;
		examples.AddEntry("NEW", _(
			"Lists any new memos."
		));
		examples.AddEntry("2-5,7-9", _(
			"Lists memos numbered 2 through 5 and 7 through 9."
		));
		examples.SendTo(source);

		return true;
	}
};

class MSList final
	: public Module
{
	CommandMSList commandmslist;

public:
	MSList(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, VENDOR),
		commandmslist(this)
	{

	}
};

MODULE_INIT(MSList)