path: root/mu/mu-cmd-cfind.cc

/*
** Copyright (C) 2022-2025 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** This program is free software; you can redistribute it and/or modify it
** under the terms of the GNU General Public License as published by the
** Free Software Foundation; either version 3, or (at your option) any
** later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software Foundation,
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**
*/
#include "mu-cmd.hh"

#include <cstdint>
#include <string>
#include <functional>
#include <unordered_map>

#include <utils/mu-utils.hh>
#include <utils/mu-regex.hh>
#include <utils/mu-option.hh>

using namespace Mu;

enum struct ItemType { Header, Footer, Normal };
using OutputFunc = std::function<void(ItemType itype, Option<const Contact&>, const Options&)>;
using OptContact = Option<const Contact&>;
using Format = Options::Cfind::Format;

// simplistic guess of first & last names, for setting
// some initial value.
static std::pair<std::string, std::string>
guess_first_last_name(const std::string& name)
{
	if (name.empty())
		return {};

	const auto lastspc = name.find_last_of(' ');
	if (lastspc == name.npos)
		return { name, "" }; // no last name
	else
		return { name.substr(0, lastspc), name.substr(lastspc + 1)};
}


// candidate nick and a _count_ for that given nick, to uniquify them.
static std::unordered_map<std::string, size_t> nicks;
static std::string
guess_nick(const Contact& contact)
{
	auto cleanup = [](const std::string& str) {
		std::string clean;
		for (auto& c: str) // XXX: support non-ascii
			if (!::ispunct(c) && !::isspace(c))
				clean += c;
		return clean;
	};

	auto nick = cleanup(std::invoke([&]()->std::string {

		// no name? use the user part from the addr
		if (contact.name.empty()) {
			const auto pos{contact.email.find('@')};
			if (pos == std::string::npos)
				return contact.email; // no '@'
			else
				return contact.email.substr(0, pos);
		}

		const auto names{guess_first_last_name(contact.name)};
		/* if there's no last name, use first name as the nick */
		if (names.second.empty())
			return names.first;

		char initial[7] = {};
		if (g_unichar_to_utf8(g_utf8_get_char(names.second.c_str()), initial) == 0) {
			    /* couldn't we get an initial for the last name?
			     * just use the first name*/
			    return names.first;
		} else // prepend the initial
			return names.first + initial;
	}));

	// uniquify.
	if (auto it = nicks.find(nick); it == nicks.cend())
		nicks.emplace(nick, 0);
	else {
		++it->second;
		nick = mu_format("{}{}", nick, ++it->second);
	}

	return nick;
}


static void
output_plain(ItemType itype, OptContact contact, const Options& opts)
{
	if (!contact)
		return;

	const auto col1{opts.nocolor ? "" : MU_COLOR_MAGENTA};
	const auto col2{opts.nocolor ? "" : MU_COLOR_GREEN};
	const auto coldef{opts.nocolor ? "" : MU_COLOR_DEFAULT};

	mu_print_encoded("{}{}{}{}{}{}{}\n",
			 col1, contact->name, coldef,
			 contact->name.empty() ? "" : " ",
			 col2, contact->email, coldef);
}

static void
output_mutt_alias(ItemType itype, OptContact contact, const Options& opts)
{
	if (!contact)
		return;

	const auto nick{guess_nick(*contact)};
	mu_print_encoded("alias {} {} <{}>\n", nick, contact->name, contact->email);

}

static void
output_mutt_address_book(ItemType itype, OptContact contact, const Options& opts)
{
	if (itype == ItemType::Header)
		mu_print ("Matching addresses in the mu database:\n");

	if (contact)
		mu_print_encoded("{}\t{}\t\n", contact->email, contact->name);
}

static void
output_wanderlust(ItemType itype, OptContact contact, const Options& opts)
{
	if (!contact || contact->name.empty())
		return;

	auto nick=guess_nick(*contact);

	mu_print_encoded("{} \"{}\" \"{}\"\n", contact->email, nick, contact->name);

}

static void
output_org_contact(ItemType itype, OptContact contact, const Options& opts)
{
	if (!contact || contact->name.empty())
		return;

	mu_print_encoded("* {}\n:PROPERTIES:\n:EMAIL: {}\n:END:\n\n",
			 contact->name, contact->email);
}

static void
output_bbdb(ItemType itype, OptContact contact, const Options& opts)
{
	if (itype == ItemType::Header)
		mu_println (";; -*-coding: utf-8-emacs;-*-\n"
			    ";;; file-version: 6");
	if (!contact)
		return;

	const auto names{guess_first_last_name(contact->name)};
	const auto now{mu_format("{:%Y-%m-%d}", mu_time(::time({})))};
	const auto timestamp{mu_format("{:%Y-%m-%d}", mu_time(contact->message_date))};

	mu_println("[\"{}\" \"{}\" nil nil nil nil (\"{}\") "
		   "((creation-date . \"{}\") (time-stamp . \"{}\")) nil]",
		   names.first, names.second, contact->email, now, timestamp);
}

static void
output_csv(ItemType itype, OptContact contact, const Options& opts)
{
	if (!contact)
		return;

	mu_print_encoded("{},{}\n",
			 contact->name.empty() ? "" : Mu::quote(contact->name),
			 Mu::quote(contact->email));
}

static void
output_json(ItemType itype, OptContact contact, const Options& opts)
{
	if (itype == ItemType::Header)
		mu_println("[");
	if (contact) {
		mu_print("{}", itype == ItemType::Header ? "" : ",\n");
		mu_println ("  {{");

		const std::string name = contact->name.empty() ? "null" : Mu::quote(contact->name);
		mu_print_encoded(
			"    \"email\"         : \"{}\",\n"
			"    \"name\"          : {},\n"
			"    \"display\"       : {},\n"
			"    \"last-seen\"     : {},\n"
			"    \"last-seen-iso\" : \"{}\",\n"
			"    \"personal\"      : {},\n"
			"    \"frequency\"     : {}\n",
			contact->email,
			name,
			Mu::quote(contact->display_name()),
			contact->message_date,
			mu_format("{:%FT%TZ}", mu_time(contact->message_date, true/*utc*/)),
			contact->personal ? "true" : "false",
			contact->frequency);
		mu_print("  }}");
	}

	if (itype == ItemType::Footer)
		mu_println("\n]");
}

static OutputFunc
find_output_func(Format format)
{
#pragma GCC diagnostic push
#pragma GCC diagnostic error "-Wswitch"
	switch(format) {
	case Format::Plain:
		return output_plain;
	case Format::MuttAlias:
		return output_mutt_alias;
	case Format::MuttAddressBook:
		return output_mutt_address_book;
	case Format::Wanderlust:
		return output_wanderlust;
	case Format::OrgContact:
		return output_org_contact;
	case Format::Bbdb:
		return output_bbdb;
	case Format::Csv:
		return output_csv;
	case Format::Json:
		return output_json;
	default:
		mu_warning("unsupported format");
		return {};
	}
#pragma GCC diagnostic pop
}


Result<void>
Mu::mu_cmd_cfind(const Mu::Store& store, const Mu::Options& opts)
{
	size_t num{};
	OutputFunc output = find_output_func(opts.cfind.format);
	if (!output)
		return Err(Error::Code::Internal,
			   "missing output function");
	nicks.clear();

	const auto res = store.contacts_cache().for_each([&](const Contact& contact)->bool {
		const auto itype{num == 0 ? ItemType::Header : ItemType::Normal};
		output(itype, contact, opts);
		++num;
		return true;
	}, opts.cfind.rx_pattern, opts.cfind.personal,
		opts.cfind.after.value_or(0),
		opts.cfind.maxnum.value_or(0U));

	if (!res)
		return Err(res.error());
	else if (*res == 0)
		return Err(Error::Code::NoMatches, "no matching contacts found");

	output(ItemType::Footer, Nothing, opts);
	return Ok();
}

#ifdef BUILD_TESTS
/*
 * Tests.
 *
 */
#include "config.h"
#include "utils/mu-test-utils.hh"

static std::string test_mu_home;

static void
test_mu_cfind_plain(void)
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "plain", "testmu\\.xxx?"})};
	assert_valid_result(res);

	/* note, output order is unspecified */
	if (res->standard_out[0] == 'H')
		assert_equal(res->standard_out,
			     "Helmut Kröger hk@testmu.xxx\n"
			     "Mü testmu@testmu.xx\n");
	else
		assert_equal(res->standard_out,
			     "Mü testmu@testmu.xx\n"
			     "Helmut Kröger hk@testmu.xxx\n");
}

static void
test_mu_cfind_bbdb(void)
{
	const auto old_tz{set_tz("Europe/Helsinki")};
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "bbdb", "testmu\\.xxx?"})};
	assert_valid_result(res);
	g_assert_cmpuint(res->standard_out.size(), >, 52);

#define frm1                                                                                       \
	";; -*-coding: utf-8-emacs;-*-\n"                                                          \
	";;; file-version: 6\n"                                                                    \
	"[\"Helmut\" \"Kröger\" nil nil nil nil (\"hk@testmu.xxx\") "                              \
	"((creation-date . \"{}\") "                                                               \
	"(time-stamp . \"1970-01-01\")) nil]\n"                                                    \
	"[\"Mü\" \"\" nil nil nil nil (\"testmu@testmu.xx\") "                                     \
	"((creation-date . \"{}\") "                                                               \
	"(time-stamp . \"1970-01-01\")) nil]\n"

#define frm2                                                                                       \
	";; -*-coding: utf-8-emacs;-*-\n"                                                          \
	";;; file-version: 6\n"                                                                    \
	"[\"Mü\" \"\" nil nil nil nil (\"testmu@testmu.xx\") "                                     \
	"((creation-date . \"{}\") "                                                               \
	"(time-stamp . \"1970-01-01\")) nil]\n"                                                    \
	"[\"Helmut\" \"Kröger\" nil nil nil nil (\"hk@testmu.xxx\") "                              \
	"((creation-date . \"{}\") "                                                               \
	"(time-stamp . \"1970-01-01\")) nil]\n"

	auto&& today{mu_format("{:%F}", mu_time(::time({})))};
	std::string expected;
	if (res->standard_out.at(52) == 'H')
		expected = mu_format(frm1, today, today);
	else
		expected = mu_format(frm2, today, today);

	assert_equal(res->standard_out, expected);
	set_tz(old_tz);
}

static void
test_mu_cfind_wl(void)
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "wl", "testmu\\.xxx?"})};
	assert_valid_result(res);

	if (res->standard_out.at(0) == 'h')
		assert_equal(res->standard_out,
			     "hk@testmu.xxx \"HelmutK\" \"Helmut Kröger\"\n"
			     "testmu@testmu.xx \"Mü\" \"Mü\"\n");
	else
		assert_equal(res->standard_out,
				"testmu@testmu.xx \"Mü\" \"Mü\"\n"
				"hk@testmu.xxx \"HelmutK\" \"Helmut Kröger\"\n");
}

static void
test_mu_cfind_mutt_alias(void)
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "mutt-alias", "testmu\\.xxx?"})};
	assert_valid_result(res);

	if (res->standard_out.at(6) == 'H')
		assert_equal(res->standard_out,
			     "alias HelmutK Helmut Kröger <hk@testmu.xxx>\n"
			     "alias Mü Mü <testmu@testmu.xx>\n");
	else
		assert_equal(res->standard_out,
				"alias Mü Mü <testmu@testmu.xx>\n"
				"alias HelmutK Helmut Kröger <hk@testmu.xxx>\n");
}

static void
test_mu_cfind_mutt_ab(void)
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "mutt-ab", "testmu\\.xxx?"})};
	assert_valid_result(res);

	if (res->standard_out.at(39) == 'h')
		assert_equal(res->standard_out,
			     "Matching addresses in the mu database:\n"
			     "hk@testmu.xxx\tHelmut Kröger\t\n"
			     "testmu@testmu.xx\tMü\t\n");
	else
		assert_equal(res->standard_out,
				"Matching addresses in the mu database:\n"
				"testmu@testmu.xx\tMü\t\n"
				"hk@testmu.xxx\tHelmut Kröger\t\n");
}

static void
test_mu_cfind_org_contact(void)
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "org-contact", "testmu\\.xxx?"})};
	assert_valid_result(res);

	if (res->standard_out.at(2) == 'H')
		assert_equal(res->standard_out,
				"* Helmut Kröger\n"
				":PROPERTIES:\n"
				":EMAIL: hk@testmu.xxx\n"
				":END:\n\n"
				"* Mü\n"
				":PROPERTIES:\n"
				":EMAIL: testmu@testmu.xx\n"
				":END:\n\n");
	else
		assert_equal(res->standard_out,
				"* Mü\n"
				":PROPERTIES:\n"
				":EMAIL: testmu@testmu.xx\n"
				":END:\n\n"
				"* Helmut Kröger\n"
				":PROPERTIES:\n"
				":EMAIL: hk@testmu.xxx\n"
				":END:\n\n");
}

static void
test_mu_cfind_csv(void)
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "csv", "testmu\\.xxx?"})};
	assert_valid_result(res);

	if (res->standard_out.at(1) == 'H')
		assert_equal(res->standard_out,
			     "\"Helmut Kröger\",\"hk@testmu.xxx\"\n"
			     "\"Mü\",\"testmu@testmu.xx\"\n");
	else
		assert_equal(res->standard_out,
				"\"Mü\",\"testmu@testmu.xx\"\n"
				"\"Helmut Kröger\",\"hk@testmu.xxx\"\n");
}


static void
test_mu_cfind_json()
{
	auto res{run_command({MU_PROGRAM, "--nocolor", "cfind", "--muhome", test_mu_home,
				"--format", "json", "^a@example\\.com"})};
	assert_valid_result(res);

	const auto expected = R"([
  {
    "email"         : "a@example.com",
    "name"          : null,
    "display"       : "a@example.com",
    "last-seen"     : 1463331445,
    "last-seen-iso" : "2016-05-15T16:57:25Z",
    "personal"      : false,
    "frequency"     : 1
  }
]
)";
	assert_equal(res->standard_out, expected);
}

int
main(int argc, char* argv[])
{
	mu_test_init(&argc, &argv);

	if (!set_en_us_utf8_locale())
		return 0; /* don't error out... */

	TempDir temp_dir{};
	{
		test_mu_home = temp_dir.path();

		auto res1 = run_command({MU_PROGRAM, "--quiet", "init",
				"--muhome", test_mu_home, "--maildir" , MU_TESTMAILDIR});
		assert_valid_result(res1);

		auto res2 = run_command({MU_PROGRAM, "--quiet", "index",
				"--muhome", test_mu_home});
		assert_valid_result(res2);
	}

	g_test_add_func("/cmd/find/plain", test_mu_cfind_plain);
	g_test_add_func("/cmd/find/bbdb", test_mu_cfind_bbdb);
	g_test_add_func("/cmd/find/wl", test_mu_cfind_wl);
	g_test_add_func("/cmd/find/mutt-alias", test_mu_cfind_mutt_alias);
	g_test_add_func("/cmd/find/mutt-ab", test_mu_cfind_mutt_ab);
	g_test_add_func("/cmd/find/org-contact", test_mu_cfind_org_contact);
	g_test_add_func("/cmd/find/csv", test_mu_cfind_csv);
	g_test_add_func("/cmd/find/json", test_mu_cfind_json);

	return g_test_run();
}
#endif /*BUILD_TESTS*/