path: root/src/itemviewformaction.cpp

#define ENABLE_IMPLICIT_FILEPATH_CONVERSIONS

#include "itemviewformaction.h"

#include <algorithm>
#include <cstring>
#include <sstream>

#include "config.h"
#include "confighandlerexception.h"
#include "controller.h"
#include "dbexception.h"
#include "fmtstrformatter.h"
#include "itemlistformaction.h"
#include "itemrenderer.h"
#include "itemutils.h"
#include "logger.h"
#include "rssfeed.h"
#include "scopemeasure.h"
#include "strprintf.h"
#include "textformatter.h"
#include "utils.h"
#include "view.h"

namespace newsboat {

ItemViewFormAction::ItemViewFormAction(View& vv,
	std::shared_ptr<ItemListFormAction> il,
	std::string formstr,
	Cache* cc,
	ConfigContainer* cfg,
	RegexManager& r)
	: FormAction(vv, formstr, cfg)
	, show_source(false)
	, rxman(r)
	, num_lines(0)
	, itemlist(il)
	, in_search(false)
	, rsscache(cc)
	, textview("article", FormAction::f)
{
	valid_cmds.push_back("save");
	std::sort(valid_cmds.begin(), valid_cmds.end());
	register_format_styles();
}

void ItemViewFormAction::init()
{
	set_status("");
	do_redraw = true;
	textview.set_scroll_offset(0);
	links.clear();
	num_lines = 0;
	if (!cfg->get_configvalue_as_bool("display-article-progress")) {
		set_value("percentwidth", "0");
	} else {
		const size_t min_field_width = 6;
		set_value("percentwidth",
			std::to_string(
		std::max({
			min_field_width,
			strlen(_("Top")),
			strlen(_("Bottom"))})));
		update_percent();
	}
	set_keymap_hints();
	item = feed->get_item_by_guid(guid);
}

void ItemViewFormAction::update_head(RssItem& item)
{
	const std::string feedtitle = item_renderer::get_feedtitle(item);

	unsigned int unread_item_count = feed->unread_item_count();
	// we need to subtract because the current item isn't yet marked
	// as read
	if (item.unread()) {
		unread_item_count--;
	}
	set_head(utils::utf8_to_locale(item.title()),
		feedtitle,
		unread_item_count,
		feed->total_item_count());
};

void ItemViewFormAction::prepare()
{
	/*
	 * whenever necessary, the item view is regenerated. This is done
	 * by putting together the feed name, title, link, author, optional
	 * flags and podcast download URL (enclosures) and then render the
	 * HTML. The links extracted by the renderer are then appended, too.
	 */
	if (do_redraw) {
		{
			ScopeMeasure sm("itemview::prepare: rendering");
			// XXX HACK: render once so that we get a proper widget width
			recalculate_widget_dimensions();
		}

		update_head(*item);

		const unsigned int window_width = textview.get_width();

		unsigned int text_width =
			cfg->get_configvalue_as_int("text-width");
		if (text_width == 0 || text_width > window_width) {
			text_width = window_width;
			if (text_width > 5) {
				text_width -= 5;
			}
		}

		std::string formatted_text;
		if (show_source) {
			std::tie(formatted_text, num_lines) =
				item_renderer::source_to_stfl_list(
					*item,
					text_width,
					window_width,
					&rxman,
					"article");
		} else {
			links.clear();
			if (!item->enclosure_url().empty()) {
				const auto link_type = utils::podcast_mime_to_link_type(item->enclosure_type());
				if (link_type.has_value()) {
					links.add_link(item->enclosure_url(), link_type.value());
				}
			}

			std::tie(formatted_text, num_lines) =
				item_renderer::to_stfl_list(
					// cfg can't be nullptr because that's a long-lived object
					// created at the very start of the program.
					*cfg,
					*item,
					text_width,
					window_width,
					&rxman,
					"article",
					links);
		}

		textview.stfl_replace_lines(num_lines, formatted_text);
		update_percent();

		if (in_search) {
			rxman.remove_last_regex("article");
			in_search = false;
		}

		do_redraw = false;
	}
}

bool ItemViewFormAction::process_operation(Operation op,
	const std::vector<std::string>& args,
	BindingType bindingType)
{
	bool hardquit = false;
	bool quit = false;

	/*
	 * whenever we process an operation, we mark the item
	 * as read. Don't worry: when an item is already marked as
	 * read, and then marked as read again, no database update
	 * is done, since only _changes_ to the unread flag are
	 * recorded in the database.
	 */
	try {
		bool old_unread = item->unread();
		item->set_unread(false);
		if (old_unread) {
			v.get_ctrl()->mark_article_read(item->guid(), true);
		}
	} catch (const DbException& e) {
		v.get_statusline().show_error(strprintf::fmt(
				_("Error while marking article as read: %s"),
				e.what()));
	}

	switch (op) {
	case OP_TOGGLESOURCEVIEW:
		LOG(Level::INFO, "ItemViewFormAction::process_operation: toggling source view");
		show_source = !show_source;
		do_redraw = true;
		textview.set_scroll_offset(0);
		break;
	case OP_ENQUEUE:
		return enqueue_item_enclosure(*item, *feed, v, *rsscache);
	case OP_SAVE: {
		LOG(Level::INFO, "ItemViewFormAction::process_operation: saving article");
		nonstd::optional<Filepath> filename;
		switch (bindingType) {
		case BindingType::Bind:
			if (args.empty()) {
				filename = v.run_filebrowser(v.get_filename_suggestion(item->title()));
			} else {
				filename = Filepath::from_locale_string(args.front());
			}
			break;
		case BindingType::Macro:
			if (args.size() > 0) {
				filename = Filepath::from_locale_string(args.front());
			}
			break;
		case BindingType::BindKey:
			filename = v.run_filebrowser(v.get_filename_suggestion(item->title()));
			break;
		}
		if (!filename.has_value()) {
			v.get_statusline().show_error(_("Aborted saving."));
		} else {
			try {
				v.get_ctrl()->write_item(*item, filename.value());
				v.get_statusline().show_message(strprintf::fmt(
						_("Saved article to %s."), filename.value()));
			} catch (...) {
				v.get_statusline().show_error(strprintf::fmt(
						_("Error: couldn't write article to "
							"file %s"),
						filename.value()));
			}
		}
	}
	break;
	case OP_OPENINBROWSER:
	case OP_OPENBROWSER_AND_MARK: {
		LOG(Level::INFO, "ItemViewFormAction::process_operation: starting browser");
		const bool interactive = true;
		return open_link_in_browser(item->link(), "article", item->title(), interactive);
	}
	break;
	case OP_OPENINBROWSER_NONINTERACTIVE: {
		LOG(Level::INFO, "ItemViewFormAction::process_operation: starting browser");
		const bool interactive = false;
		return open_link_in_browser(item->link(), "article", item->title(), interactive);
	}
	break;
	case OP_BOOKMARK:
		switch (bindingType) {
		case BindingType::Bind:
			if (args.empty()) {
				this->start_bookmark_qna(
					utils::utf8_to_locale(item->title()),
					item->link(),
					feed->title());
			} else {
				qna_responses = {
					item->link(),
					utils::utf8_to_locale(item->title()),
					args.front(),
					feed->title(),
				};
				finished_qna(OP_INT_BM_END);
			}
			break;
		case BindingType::Macro:
			qna_responses.clear();
			qna_responses.push_back(item->link());
			qna_responses.push_back(utils::utf8_to_locale(item->title()));
			qna_responses.push_back(
				args.size() > 0 ? args.front() : "");
			qna_responses.push_back(feed->title());
			finished_qna(OP_INT_BM_END);
			break;
		case BindingType::BindKey:
			this->start_bookmark_qna(
				utils::utf8_to_locale(item->title()),
				item->link(),
				feed->title());
		}
		break;
	case OP_SEARCH: {
		std::vector<QnaPair> qna;
		switch (bindingType) {
		case BindingType::Bind:
			if (args.empty()) {
				qna.push_back(QnaPair(_("Search for: "), ""));
				this->start_qna(qna, OP_INT_START_SEARCH, &searchhistory);
			} else {
				qna_responses = { args.front() };
				finished_qna(OP_INT_START_SEARCH);
			}
			break;
		case BindingType::Macro:
			if (args.size() > 0) {
				qna_responses.clear();
				qna_responses.push_back(args.front());
				finished_qna(OP_INT_START_SEARCH);
			}
			break;
		case BindingType::BindKey:
			qna.push_back(QnaPair(_("Search for: "), ""));
			this->start_qna(
				qna, OP_INT_START_SEARCH, &searchhistory);
			break;
		}
	}
	break;
	case OP_PIPE_TO: {
		std::vector<QnaPair> qna;
		switch (bindingType) {
		case BindingType::Bind:
			if (args.empty()) {
				qna.push_back(QnaPair(_("Pipe article to command: "), ""));
				this->start_qna(qna, OP_PIPE_TO, &cmdlinehistory);
			} else {
				qna_responses = { args.front() };
				finished_qna(OP_PIPE_TO);
			}
			break;
		case BindingType::Macro:
			if (args.size() > 0) {
				qna_responses.clear();
				qna_responses.push_back(args.front());
				finished_qna(OP_PIPE_TO);
			}
			break;
		case BindingType::BindKey:
			qna.push_back(
				QnaPair(_("Pipe article to command: "), ""));
			this->start_qna(qna, OP_PIPE_TO, &cmdlinehistory);
			break;
		}
	}
	break;
	case OP_EDITFLAGS:
		switch (bindingType) {
		case BindingType::Bind:
			if (args.empty()) {
				qna_responses = { args.front() };
				this->finished_qna(OP_INT_EDITFLAGS_END);
			} else {
				std::vector<QnaPair> qna {
					QnaPair(_("Flags: "), item->flags()),
				};
				this->start_qna(qna, OP_INT_EDITFLAGS_END);
			}
			break;
		case BindingType::Macro:
			qna_responses.clear();
			if (args.size() > 0) {
				qna_responses.push_back(args.front());
				this->finished_qna(OP_INT_EDITFLAGS_END);
			}
			break;
		case BindingType::BindKey:
			std::vector<QnaPair> qna;
			qna.push_back(QnaPair(_("Flags: "), item->flags()));
			this->start_qna(qna, OP_INT_EDITFLAGS_END);
			break;
		}
		break;
	case OP_SHOWURLS: {
		std::string urlviewer =
			cfg->get_configvalue("external-url-viewer");
		LOG(Level::DEBUG, "ItemViewFormAction::process_operation: showing URLs");
		if (urlviewer == "") {
			if (links.size() > 0) {
				v.push_urlview(links, feed);
			} else {
				v.get_statusline().show_error(_("URL list empty."));
			}
		} else {
			qna_responses.clear();
			qna_responses.push_back(urlviewer);
			this->finished_qna(OP_PIPE_TO);
		}
	}
	break;
	case OP_DELETE:
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: deleting current article");
		item->set_deleted(true);
		rsscache->mark_item_deleted(guid, true);
	/* fall-through! */
	case OP_NEXTUNREAD:
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: jumping to next unread article");
		if (v.get_next_unread(*itemlist, this)) {
			do_redraw = true;
			textview.set_scroll_offset(0);
		} else {
			v.pop_current_formaction();
			v.get_statusline().show_error(_("No unread items."));
		}
		break;
	case OP_PREVUNREAD:
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: jumping to previous unread "
			"article");
		if (v.get_previous_unread(*itemlist, this)) {
			do_redraw = true;
			textview.set_scroll_offset(0);
		} else {
			v.pop_current_formaction();
			v.get_statusline().show_error(_("No unread items."));
		}
		break;
	case OP_NEXT:
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: jumping to next article");
		if (v.get_next(*itemlist, this)) {
			do_redraw = true;
			textview.set_scroll_offset(0);
		} else {
			v.pop_current_formaction();
			v.get_statusline().show_error(_("Already on last item."));
		}
		break;
	case OP_PREV:
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: jumping to previous article");
		if (v.get_previous(*itemlist, this)) {
			do_redraw = true;
			textview.set_scroll_offset(0);
		} else {
			v.pop_current_formaction();
			v.get_statusline().show_error(_("Already on first item."));
		}
		break;
	case OP_RANDOMUNREAD:
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: jumping to random unread article");
		if (v.get_random_unread(*itemlist, this)) {
			do_redraw = true;
			textview.set_scroll_offset(0);
		} else {
			v.pop_current_formaction();
			v.get_statusline().show_error(_("No unread items."));
		}
		break;
	case OP_TOGGLEITEMREAD: {
		LOG(Level::INFO,
			"ItemViewFormAction::process_operation: setting unread and quitting");
		const auto message_lifetime = v.get_statusline().show_message_until_finished(
				_("Toggling read flag for article..."));
		try {
			if (args.size() > 0) {
				if (args.front() == "read") {
					item->set_unread(false);
					v.get_ctrl()->mark_article_read(item->guid(), true);
				} else if (args.front() == "unread") {
					item->set_unread(true);
					v.get_ctrl()->mark_article_read(item->guid(), false);
				}
			} else {
				item->set_unread(true);
				v.get_ctrl()->mark_article_read(item->guid(), false);
			}
		} catch (const DbException& e) {
			v.get_statusline().show_error(strprintf::fmt(
					_("Error while marking article as unread: %s"),
					e.what()));
		}
		quit = true;
		break;
	}
	case OP_QUIT:
		LOG(Level::INFO, "ItemViewFormAction::process_operation: quitting");
		quit = true;
		break;
	case OP_HARDQUIT:
		LOG(Level::INFO, "ItemViewFormAction::process_operation: hard quitting");
		hardquit = true;
		break;
	case OP_HELP:
		v.push_help();
		break;
	case OP_OPEN_URL_1:
	case OP_OPEN_URL_2:
	case OP_OPEN_URL_3:
	case OP_OPEN_URL_4:
	case OP_OPEN_URL_5:
	case OP_OPEN_URL_6:
	case OP_OPEN_URL_7:
	case OP_OPEN_URL_8:
	case OP_OPEN_URL_9:
	case OP_OPEN_URL_10: {
		unsigned int idx = op - OP_OPEN_URL_1;
		LOG(Level::DEBUG,
			"ItemViewFormAction::process_operation: OP_OPEN_URL_1 = %d op = %d idx = %u",
			OP_OPEN_URL_1,
			op,
			idx);
		if (idx < links.size()) {
			const bool interactive = true;
			return open_link_in_browser(links[idx].url, utils::link_type_str(links[idx].type),
					item->title(), interactive);
		}
	}
	break;
	case OP_GOTO_URL: {
		std::vector<QnaPair> qna;
		switch (bindingType) {
		case BindingType::Bind:
			if (args.empty()) {
				qna.push_back(QnaPair(_("Goto URL #"), ""));
				this->start_qna(qna, OP_INT_GOTO_URL);
			} else {
				qna_responses = { args.front() };
				finished_qna(OP_INT_GOTO_URL);
			}
			break;
		case BindingType::Macro:
			if (args.size() > 0) {
				qna_responses.clear();
				qna_responses.push_back(args.front());
				finished_qna(OP_INT_GOTO_URL);
			}
			break;
		case BindingType::BindKey:
			qna.push_back(QnaPair(_("Goto URL #"), ""));
			this->start_qna(qna, OP_INT_GOTO_URL);
			break;
		}
	}
	break;
	case OP_ARTICLEFEED: {
		auto feeds = v.get_ctrl()->get_feedcontainer()->get_all_feeds();
		size_t pos;
		auto article_feed = item->get_feedptr();
		for (pos = 0; pos < feeds.size(); pos++) {
			if (feeds[pos] == article_feed) {
				break;
			}
		}
		if (pos != feeds.size()) {
			v.push_itemlist(pos);
		}
	}
	break;
	default:
		if (handle_textview_operations(textview, op)) {
			break;
		}
		break;
	}

	if (hardquit) {
		while (v.formaction_stack_size() > 0) {
			v.pop_current_formaction();
		}
	} else if (quit) {
		v.pop_current_formaction();

		auto parent_itemlist = std::dynamic_pointer_cast<ItemListFormAction>
			(get_parent_formaction());
		if (parent_itemlist != nullptr) {
			parent_itemlist->invalidate_list();
			parent_itemlist->restore_selected_position();
		}
	}

	update_percent();

	return true;
}

bool ItemViewFormAction::open_link_in_browser(const std::string& link,
	const std::string& type, const std::string& title, bool interactive) const
{
	const std::string feedurl = item->feedurl();
	const auto exit_code = v.open_in_browser(link, feedurl, type, title, interactive);
	if (!exit_code.has_value()) {
		v.get_statusline().show_error(_("Failed to spawn browser"));
		return false;
	} else if (*exit_code != 0) {
		v.get_statusline().show_error(strprintf::fmt(_("Browser returned error code %i"),
				*exit_code));
		return false;
	}
	return true;
}

std::vector<KeyMapHintEntry> ItemViewFormAction::get_keymap_hint() const
{
	static const std::vector<KeyMapHintEntry> hints = {{OP_QUIT, _("Quit")},
		{OP_SAVE, _("Save")},
		{OP_NEXTUNREAD, _("Next Unread")},
		{OP_OPENINBROWSER, _("Open in Browser")},
		{OP_ENQUEUE, _("Enqueue")},
		{OP_HELP, _("Help")}
	};
	return hints;
}

void ItemViewFormAction::set_head(const std::string& s,
	const std::string& feedtitle,
	unsigned int unread,
	unsigned int total)
{
	FmtStrFormatter fmt;
	fmt.register_fmt('N', PROGRAM_NAME);
	fmt.register_fmt('V', utils::program_version());

	auto itemtitle = s;
	utils::remove_soft_hyphens(itemtitle);
	fmt.register_fmt('T', itemtitle);

	auto clear_feedtitle = feedtitle;
	utils::remove_soft_hyphens(clear_feedtitle);
	fmt.register_fmt('F', clear_feedtitle);

	fmt.register_fmt('u', std::to_string(unread));
	fmt.register_fmt('t', std::to_string(total));

	const unsigned int width = textview.get_width();

	set_title(fmt.do_format(cfg->get_configvalue("itemview-title-format"), width));
}

void ItemViewFormAction::handle_cmdline(const std::string& cmd)
{
	const auto command = FormAction::parse_command(cmd);
	switch (command.type) {
	case CommandType::SAVE:
		if (!command.args.empty()) {
			const auto path = Filepath::from_locale_string(command.args.front());
			handle_save(path);
		}
		break;
	default:
		FormAction::handle_parsed_command(command);
	}
}

void ItemViewFormAction::handle_save(const Filepath& filename_param)
{
	Filepath filename = utils::resolve_tilde(filename_param);
	if (filename == "") {
		v.get_statusline().show_error(_("Aborted saving."));
	} else {
		try {
			v.get_ctrl()->write_item(
				*item, filename);
			v.get_statusline().show_message(strprintf::fmt(
					_("Saved article to %s"),
					filename));
		} catch (...) {
			v.get_statusline().show_error(strprintf::fmt(
					_("Error: couldn't save "
						"article to %s"),
					filename));
		}
	}
}

void ItemViewFormAction::finished_qna(Operation op)
{
	FormAction::finished_qna(op); // important!

	switch (op) {
	case OP_INT_EDITFLAGS_END:
		item->set_flags(qna_responses[0]);
		v.get_ctrl()->update_flags(item);
		v.get_statusline().show_message(_("Flags updated."));
		do_redraw = true;
		break;
	case OP_INT_START_SEARCH:
		do_search();
		break;
	case OP_PIPE_TO: {
		std::string cmd = qna_responses[0];
		std::ostringstream ostr;
		v.get_ctrl()->write_item(*feed->get_item_by_guid(guid), ostr);
		v.push_empty_formaction();
		Stfl::reset();
		FILE* f = popen(cmd.c_str(), "w");
		if (f) {
			std::string data = ostr.str();
			fwrite(data.c_str(), data.length(), 1, f);
			pclose(f);
		}
		v.drop_queued_input();
		v.pop_current_formaction();
	}
	break;
	case OP_INT_GOTO_URL: {
		unsigned int idx = 0;
		sscanf(qna_responses[0].c_str(), "%u", &idx);
		if (idx && idx - 1 < links.size()) {
			const bool interactive = true;
			open_link_in_browser(links[idx - 1].url, utils::link_type_str(links[idx - 1].type),
				item->title(), interactive);
		}
	}
	break;
	default:
		break;
	}
}

void ItemViewFormAction::register_format_styles()
{
	std::string attrstr = rxman.get_attrs_stfl_string("article", false);
	attrstr.append(
		"@style_b_normal[color_bold]:attr=bold "
		"@style_u_normal[color_underline]:attr=underline ");
	std::string stfl_textview = strprintf::fmt(
			"{textview[article] style_normal[article]: "
			"style_end[end-of-text-marker]:fg=blue,attr=bold %s .expand:vh "
			"offset[article_offset]:0 richtext:1}",
			attrstr);
	textview.stfl_replace_textview(0, stfl_textview);
}

void ItemViewFormAction::update_percent()
{
	if (cfg->get_configvalue_as_bool("display-article-progress")) {
		unsigned int percent = 0;
		unsigned int offset = utils::to_u(f.get("article_offset"), 0);

		if (num_lines > 0) {
			percent = (100 * (offset + 1)) / num_lines;
		} else {
			percent = 0;
		}

		LOG(Level::DEBUG,
			"ItemViewFormAction::update_percent: offset = %u "
			"num_lines = %u percent = %u",
			offset,
			num_lines,
			percent);

		if (offset == 0 || percent == 0) {
			set_value("percent", _("Top"));
		} else if (offset == (num_lines - 1)) {
			set_value("percent", _("Bottom"));
		} else {
			// i18n: `%3u` gets replaced by a number between 0 and 100.
			// The `%%` is replaced by a single percent sign.
			set_value("percent", strprintf::fmt(_("%3u %% "), percent));
		}
	}
}

std::string ItemViewFormAction::title()
{
	auto title = item->title();
	utils::remove_soft_hyphens(title);
	return strprintf::fmt(_("Article - %s"), utils::utf8_to_locale(title));
}

void ItemViewFormAction::set_highlightphrase(const std::string& text)
{
	highlight_text(text);
}

void ItemViewFormAction::do_search()
{
	std::string searchphrase = qna_responses[0];
	if (searchphrase.length() == 0) {
		return;
	}

	searchhistory.add_line(searchphrase);

	LOG(Level::DEBUG,
		"ItemViewFormAction::do_search: searchphrase = %s",
		searchphrase);

	highlight_text(searchphrase);
}

void ItemViewFormAction::highlight_text(const std::string& searchphrase)
{
	std::vector<std::string> params;
	params.push_back("article");
	params.push_back(searchphrase);

	std::vector<std::string> colors = utils::tokenize(
			cfg->get_configvalue("search-highlight-colors"), " ");
	std::copy(colors.begin(), colors.end(), std::back_inserter(params));

	try {
		rxman.handle_action("highlight", params);

		LOG(Level::DEBUG,
			"ItemViewFormAction::highlight_text: configuration "
			"manipulation was successful");

		register_format_styles();

		in_search = true;
		do_redraw = true;
	} catch (const ConfigHandlerException& e) {
		LOG(Level::ERROR,
			"ItemViewFormAction::highlight_text: handle_action "
			"failed, error = %s",
			e.what());
		v.get_statusline().show_error(_("Error: invalid regular expression!"));
	}
}

} // namespace newsboat