ardour/gtk2_ardour/plugin_manager_ui.cc

/*
 * Copyright (C) 2021 Robin Gareus <robin@gareus.org>
 *
 * 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 2 of the License, 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.
 */

#ifdef WAF_BUILD
#include "gtk2ardour-config.h"
#endif

#include <cassert>
#include <gtkmm/frame.h>
#include <gtkmm/stock.h>

#include "pbd/openuri.h"
#include "pbd/unwind.h"

#include "ardour/types_convert.h"

#include "gtkmm2ext/gui_thread.h"
#include "widgets/paths_dialog.h"
#include "widgets/tooltips.h"

#include "ardour_message.h"
#include "ardour_ui.h"
#include "plugin_manager_ui.h"
#include "plugin_scan_dialog.h"
#include "plugin_utils.h"
#include "rc_option_editor.h"

#include "pbd/i18n.h"

using namespace ARDOUR;
using namespace Gtk;
using namespace ArdourWidgets;
using namespace ARDOUR_PLUGIN_UTILS;

PluginManagerUI::PluginManagerUI ()
	: ArdourWindow (_("Plugin Manager"))
	, _btn_reindex (_("Update Index Only"))
	, _btn_rescan_all (_("Re-scan All"))
	, _btn_rescan_err (_("Re-scan Faulty"))
	, _btn_rescan_sel (_("Re-scan Selected"))
	, _btn_clear (_("Clear Stale Scan Log"))
	, _btn_prefs (_("Show Plugin Prefs"))
	, _cb_search_name (_("Name"), ArdourButton::led_default_elements, true)
	, _cb_search_type (_("Type"), ArdourButton::led_default_elements, true)
	, _cb_search_tags (_("Tags"), ArdourButton::led_default_elements, true)
	, _cb_search_creator (_("Maker"), ArdourButton::led_default_elements, true)
	, _cb_search_base_name (_("File"), ArdourButton::led_default_elements, true)
	, _cb_search_full_path (_("Path"), ArdourButton::led_default_elements, true)
	, _in_row_change (false)
	, _in_search_change (false)
{
	plugin_model = ListStore::create (plugin_columns);

	CellRendererToggle* cell_blacklist   = manage (new CellRendererToggle ());
	TreeViewColumn*     column_blacklist = manage (new TreeViewColumn ("", *cell_blacklist));

	cell_blacklist->property_activatable () = true;
	cell_blacklist->property_radio ()       = false;
	column_blacklist->add_attribute (cell_blacklist->property_active (), plugin_columns.blacklisted);
	column_blacklist->add_attribute (cell_blacklist->property_activatable (), plugin_columns.can_blacklist);

	CellRendererToggle* cell_fav   = manage (new CellRendererToggle ());
	TreeViewColumn*     column_fav = manage (new TreeViewColumn ("", *cell_fav));

	cell_fav->property_activatable () = true;
	cell_fav->property_radio ()       = true;
	column_fav->add_attribute (cell_fav->property_active (), plugin_columns.favorite);
	column_fav->add_attribute (cell_fav->property_activatable (), plugin_columns.can_fav_hide);

	CellRendererToggle* cell_hidden   = manage (new CellRendererToggle ());
	TreeViewColumn*     column_hidden = manage (new TreeViewColumn ("", *cell_hidden));

	cell_hidden->property_activatable () = true;
	cell_hidden->property_radio ()       = true;
	column_hidden->add_attribute (cell_hidden->property_active (), plugin_columns.hidden);
	column_hidden->add_attribute (cell_hidden->property_activatable (), plugin_columns.can_fav_hide);

	plugin_display.append_column ("", plugin_columns.status);
	plugin_display.append_column (*column_blacklist);
	plugin_display.append_column (*column_fav);
	plugin_display.append_column (*column_hidden);
	plugin_display.append_column ("", plugin_columns.type);
	plugin_display.append_column ("", plugin_columns.path);
	plugin_display.append_column ("", plugin_columns.name);
	plugin_display.append_column ("", plugin_columns.creator);
	plugin_display.append_column ("", plugin_columns.tags);

	struct ColumnInfo {
		AlignmentEnum al;
		bool          resizable;
		const char*   label;
		const char*   tooltip;
	} ci[] = {
		/* clang-format off */
		{ALIGN_LEFT,   false,  _("Status"),       _("Plugin Scan Result") },
		{ALIGN_CENTER, false, S_("Ignore|Ign"),   _("Ignore this plugin (and others that are loaded in the same file)") },
		{ALIGN_CENTER, false, S_("Favorite|Fav"), _("Add this plugin to to the favorite list") },
		{ALIGN_CENTER, false,  _("Hide"),         _("Hide this plugin in the plugin-selector") },
		{ALIGN_CENTER, false,  _("Type"),         _("Plugin standard") },
		{ALIGN_LEFT,   true,   _("File/ID"),      _("The plugin file (VST) or unique ID (AU, LV2)") },
		{ALIGN_CENTER, true,   _("Name"),         _("Name of the plugin") },
		{ALIGN_CENTER, true,   _("Creator"),      _("The plugin's vendor") },
		{ALIGN_CENTER, true,   _("Tags"),         _("Meta data: category and tags") },
	};
	/* clang-format on */

	for (unsigned int i = 0; i < sizeof (ci) / sizeof (ColumnInfo); ++i) {
		Label* l = manage (new Label (ci[i].label));
		l->set_alignment (ci[i].al);
		l->show ();

		TreeViewColumn* col = plugin_display.get_column (i);
		col->set_widget (*l);
		col->set_alignment (ci[i].al);
		col->set_expand (false);
		col->set_sort_column (i);
		col->set_resizable (ci[i].resizable);

		ArdourWidgets::set_tooltip (*l, ci[i].tooltip);
	}

	plugin_display.set_tooltip_column (5); // plugin_columns.tip

	plugin_display.set_model (plugin_model);
	plugin_display.set_headers_visible (true);
	plugin_display.set_headers_clickable (true);
	plugin_display.set_reorderable (false);
	plugin_display.set_rules_hint (true);
	plugin_display.set_enable_search (true);
	plugin_display.set_name ("PluginSelectorDisplay");

	plugin_model->set_sort_column (plugin_columns.name.index (), SORT_ASCENDING);

	plugin_display.get_selection ()->set_mode (SELECTION_SINGLE);
	plugin_display.get_selection ()->signal_changed ().connect (sigc::mem_fun (*this, &PluginManagerUI::selection_changed));
	plugin_display.signal_row_activated ().connect_notify (sigc::mem_fun (*this, &PluginManagerUI::row_activated));

	_scroller.add (plugin_display);
	_scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);

	_log.set_editable (false);
	_log.set_wrap_mode (WRAP_WORD);

	_log_scroller.set_shadow_type (SHADOW_NONE);
	_log_scroller.set_border_width (0);
	_log_scroller.add (_log);
	_log_scroller.set_policy (POLICY_NEVER, POLICY_AUTOMATIC);

	_pane.add (_scroller);
	_pane.add (_log_scroller);
	_pane.set_divider (0, .85);

	Label* lbl       = manage (new Label ("")); // spacer
	Frame* f_info    = manage (new Frame (_("Plugin Count")));
	Frame* f_paths   = manage (new Frame (_("Preferences")));
	Frame* f_search  = manage (new Frame (_("Search")));
	Frame* f_actions = manage (new Frame (_("Scan Actions")));
	VBox*  b_paths   = manage (new VBox ());
	VBox*  b_actions = manage (new VBox ());

	f_info->add (_tbl_nfo);
	f_actions->add (*b_actions);
	f_paths->add (*b_paths);
	f_search->add (_tbl_search);

	_tbl_nfo.set_border_width (4);
	_tbl_nfo.set_row_spacings (0);
	_tbl_nfo.set_col_spacings (3);
	_tbl_nfo.set_row_spacing (0, 3);

	b_actions->pack_start (_btn_clear);
	b_actions->pack_start (_btn_rescan_sel);
	b_actions->pack_start (_btn_rescan_err);
	b_actions->pack_start (_btn_rescan_all);
	b_actions->pack_start (_btn_reindex);
	b_actions->set_spacing (4);
	b_actions->set_border_width (4);

	/* search table */
	_tbl_search.set_border_width (4);

	_cb_search_name.set_active (true);
	_cb_search_type.set_active (false);
	_cb_search_tags.set_active (false);
	_cb_search_creator.set_active (true);
	_cb_search_base_name.set_active (true);
	_cb_search_full_path.set_active (false);

	_cb_search_name.set_led_left (true);
	_cb_search_type.set_led_left (true);
	_cb_search_tags.set_led_left (true);
	_cb_search_creator.set_led_left (true);
	_cb_search_base_name.set_led_left (true);
	_cb_search_full_path.set_led_left (true);

	_cb_search_name.set_name ("pluginlist filter button");
	_cb_search_type.set_name ("pluginlist filter button");
	_cb_search_tags.set_name ("pluginlist filter button");
	_cb_search_creator.set_name ("pluginlist filter button");
	_cb_search_base_name.set_name ("pluginlist radio button");
	_cb_search_full_path.set_name ("pluginlist radio button");

	Widget* w = manage (new Image (Stock::CLEAR, ICON_SIZE_MENU));
	w->show ();
	_btn_search_clear.add (*w);

	/* clang-format off */
	_tbl_search.attach (_entry_search,        0, 2, 0, 1, FILL | EXPAND, FILL);
	_tbl_search.attach (_btn_search_clear,    2, 3, 0, 1, FILL, FILL, 1, 0);
	_tbl_search.attach (_cb_search_name,      0, 1, 1, 2, FILL, FILL, 0, 2);
	_tbl_search.attach (_cb_search_type,      1, 2, 1, 2, FILL, FILL, 2, 2);
	_tbl_search.attach (_cb_search_creator,   0, 1, 2, 3, FILL, FILL, 0, 2);
	_tbl_search.attach (_cb_search_tags,      1, 2, 2, 3, FILL, FILL, 2, 2);
	_tbl_search.attach (_cb_search_base_name, 0, 1, 3, 4, FILL, FILL, 0, 2);
	_tbl_search.attach (_cb_search_full_path, 1, 2, 3, 4, FILL, FILL, 2, 2);
	/* clang-format on */

	/* prefs / plugin-paths buttons */
#if defined LXVST_SUPPORT
	ArdourWidgets::ArdourButton* btn_lxvst = manage (new ArdourWidgets::ArdourButton (_("Linux VST2 Path")));
	ArdourWidgets::set_tooltip (*btn_lxvst, _("Configure where to look for VST2 plugins."));
	btn_lxvst->signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::vst_path_cb), LXVST));
	b_paths->pack_start (*btn_lxvst);
#endif
#ifdef WINDOWS_VST_SUPPORT
	ArdourWidgets::ArdourButton* btn_winvst = manage (new ArdourWidgets::ArdourButton (_("Windows VST2 Path")));
	ArdourWidgets::set_tooltip (*btn_winvst, _("Configure where to look for VST2 plugins."));
	btn_winvst->signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::vst_path_cb), Windows_VST));
	b_paths->pack_start (*btn_winvst);
#endif
#ifdef VST3_SUPPORT
	ArdourWidgets::ArdourButton* btn_vst3 = manage (new ArdourWidgets::ArdourButton (_("VST3 Path")));
	ArdourWidgets::set_tooltip (*btn_vst3, _("Configure where to look for VST3 plugins in addition to the default VST3 locations."));
	btn_vst3->signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::vst_path_cb), VST3));
	b_paths->pack_start (*btn_vst3);
#endif
	b_paths->pack_start (_btn_prefs);
	b_paths->set_spacing (4);
	b_paths->set_border_width (4);

	/* tooltips */
	/* clang-format off */
	ArdourWidgets::set_tooltip (_btn_reindex,    _("Only update plugin index, do not discover new plugins."));
	ArdourWidgets::set_tooltip (_btn_rescan_all, _("Scans all plugins, regardless if they have already been successfully scanned.\nDepending on the number of plugins installed this can take a long time."));
	ArdourWidgets::set_tooltip (_btn_rescan_err, _("Scans plugins that have not yet been successfully scanned."));
	ArdourWidgets::set_tooltip (_btn_rescan_sel, _("Scans the selected plugin."));
	ArdourWidgets::set_tooltip (_btn_clear,      _("Forget about plugins that have been removed from the system."));
	ArdourWidgets::set_tooltip (_btn_prefs,      _("Open preference window"));

	ArdourWidgets::set_tooltip (_cb_search_name,       _("Match plugin name"));
	ArdourWidgets::set_tooltip (_cb_search_type,       _("Match plugin type"));
	ArdourWidgets::set_tooltip (_cb_search_tags,       _("Match any tag"));
	ArdourWidgets::set_tooltip (_cb_search_creator,    _("Match plugin vendor"));
	ArdourWidgets::set_tooltip (_cb_search_base_name,  _("Match File/ID"));
	ArdourWidgets::set_tooltip (_cb_search_full_path,  _("Match complete file install path on disk"));
	/* clang-format on */

	/* top level packing */
	/* clang-format off */
	_top.attach (*f_search,  0, 1, 0, 1, FILL | SHRINK, SHRINK, 4, 0);
	_top.attach (*lbl,       0, 1, 1, 2, SHRINK, EXPAND | FILL, 4, 0);
	_top.attach (*f_info,    0, 1, 2, 3, FILL | SHRINK, SHRINK, 4, 4);
	_top.attach (*f_actions, 0, 1, 3, 4, FILL | SHRINK, SHRINK, 4, 4);
	_top.attach (*f_paths,   0, 1, 4, 5, FILL | SHRINK, SHRINK, 4, 4);
	_top.attach (_pane,      1, 2, 0, 5, EXPAND | FILL, EXPAND | FILL, 4, 0);
	/* clang-format on */

	add (_top);
	_top.show_all ();

	_log.set_size_request (400, -1);
	set_size_request (-1, 600);

	/* connect to signals */

	PluginManager::instance ().PluginListChanged.connect (_manager_connections, invalidator (*this), boost::bind (&PluginManagerUI::refill, this), gui_context ());
	PluginManager::instance ().PluginScanLogChanged.connect (_manager_connections, invalidator (*this), boost::bind (&PluginManagerUI::refill, this), gui_context ());
	PluginManager::instance ().PluginStatusChanged.connect (_manager_connections, invalidator (*this), boost::bind (&PluginManagerUI::plugin_status_changed, this, _1, _2, _3), gui_context ());

	_btn_reindex.signal_clicked.connect (sigc::mem_fun (*this, &PluginManagerUI::reindex));
	_btn_rescan_all.signal_clicked.connect (sigc::mem_fun (*this, &PluginManagerUI::rescan_all));
	_btn_rescan_err.signal_clicked.connect (sigc::mem_fun (*this, &PluginManagerUI::rescan_faulty));
	_btn_rescan_sel.signal_clicked.connect (sigc::mem_fun (*this, &PluginManagerUI::rescan_selected));
	_btn_clear.signal_clicked.connect (sigc::mem_fun (*this, &PluginManagerUI::clear_log));
	_btn_prefs.signal_clicked.connect (sigc::mem_fun (*this, &PluginManagerUI::show_plugin_prefs));

	cell_fav->signal_toggled ().connect (sigc::mem_fun (*this, &PluginManagerUI::favorite_changed));
	cell_hidden->signal_toggled ().connect (sigc::mem_fun (*this, &PluginManagerUI::hidden_changed));
	cell_blacklist->signal_toggled ().connect (sigc::mem_fun (*this, &PluginManagerUI::blacklist_changed));
	_entry_search.signal_changed ().connect (sigc::mem_fun (*this, &PluginManagerUI::search_entry_changed));
	_btn_search_clear.signal_clicked ().connect (sigc::mem_fun (*this, &PluginManagerUI::search_clear_button_clicked));

	_cb_search_name.signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::maybe_refill), (ArdourButton*)0));
	_cb_search_tags.signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::maybe_refill), (ArdourButton*)0));
	_cb_search_type.signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::maybe_refill), (ArdourButton*)0));
	_cb_search_creator.signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::maybe_refill), (ArdourButton*)0));
	_cb_search_base_name.signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::maybe_refill), &_cb_search_base_name));
	_cb_search_full_path.signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PluginManagerUI::maybe_refill), &_cb_search_full_path));

	/* populate */
	refill ();
}

PluginManagerUI::~PluginManagerUI ()
{
}

void
PluginManagerUI::PluginCount::set (PluginScanLogEntry const& psle)
{
	++total;
	if (!psle.recent ()) {
		++stale;
		return;
	}
	PluginScanLogEntry::PluginScanResult sr = psle.result ();
	if ((int)sr & (PluginScanLogEntry::TimeOut | PluginScanLogEntry::Updated | PluginScanLogEntry::New)) {
		++ndscn;
	} else if (sr != PluginScanLogEntry::OK) {
		++error;
	}
}

static std::string
status_text (PluginScanLogEntry const& psle, PluginManager::PluginStatusType status)
{
	if (!psle.recent ()) {
		return "Stale";
	}

	PluginScanLogEntry::PluginScanResult sr = psle.result ();
	if (sr == PluginScanLogEntry::OK || sr == PluginScanLogEntry::Blacklisted) {
		if (status == PluginManager::Concealed) {
			return _("Concealed");
		} else {
			return _("OK");
		}
	}

	if ((int)sr & PluginScanLogEntry::TimeOut) {
		return _("New");
	}
	if ((int)sr & PluginScanLogEntry::New) {
		return _("New");
	}
	if ((int)sr & PluginScanLogEntry::Updated) {
		return _("Updated");
	}
	if ((int)sr & PluginScanLogEntry::Error) {
		return _("Error");
	}
	if ((int)sr & PluginScanLogEntry::Incompatible) {
		return _("Incompatible");
	}
	assert (0);
	return "?";
}

static bool
is_blacklisted (PluginScanLogEntry const& psle)
{
	return (int)psle.result () & PluginScanLogEntry::Blacklisted;
}

static bool
can_blacklist (PluginScanLogEntry const& psle)
{
	if (psle.type () == LV2 || psle.type () == LADSPA) {
		return false;
	}
	return ((int)psle.result () & ~PluginScanLogEntry::Blacklisted) == PluginScanLogEntry::OK;
}

static std::string
plugin_type (const PluginType t)
{
	/* see also PluginManager::to_generic_vst */
	switch (t) {
		case Windows_VST:
		case LXVST:
		case MacVST:
			return "VST2.x";
		default:
			return enum_2_string (t);
	}
}

bool
PluginManagerUI::show_this_plugin (boost::shared_ptr<PluginScanLogEntry> psle, PluginInfoPtr pip, const std::string& searchstr)
{
	if (searchstr.empty ()) {
		return true;
	}

	std::string compstr (_cb_search_full_path.get_active () ? psle->path () : Glib::path_get_basename (psle->path ()));
	setup_search_string (compstr);
	if (match_search_strings (compstr, searchstr)) {
		return true;
	}

	if (_cb_search_type.get_active ()) {
		compstr = plugin_type ((psle)->type ());
		setup_search_string (compstr);
		if (match_search_strings (compstr, searchstr)) {
			return true;
		}
	}

	if (pip && _cb_search_name.get_active ()) {
		compstr = pip->name;
		setup_search_string (compstr);
		if (compstr != "-" && match_search_strings (compstr, searchstr)) {
			return true;
		}
	}

	if (pip && _cb_search_creator.get_active ()) {
		compstr = pip->creator;
		setup_search_string (compstr);
		if (compstr != "-" && match_search_strings (compstr, searchstr)) {
			return true;
		}
	}

	if (pip && _cb_search_tags.get_active ()) {
		compstr = PluginManager::instance ().get_tags_as_string (pip);
		setup_search_string (compstr);
		if (compstr != "-" && match_search_strings (compstr, searchstr)) {
			return true;
		}
	}

	return false;
}

void
PluginManagerUI::maybe_refill (ArdourButton* src)
{
	if (_in_search_change) {
		return;
	}
	PBD::Unwinder<bool> uw (_in_search_change, true);
	if (src == &_cb_search_base_name) {
		_cb_search_full_path.set_active (!_cb_search_base_name.get_active ());
	} else if (src == &_cb_search_full_path) {
		_cb_search_base_name.set_active (!_cb_search_full_path.get_active ());
	}
	if (!_entry_search.get_text ().empty ()) {
		refill ();
	}
}

void
PluginManagerUI::refill ()
{
	/* save selection and sort-column, clear model to speed-up refill */
	TreeIter                              iter = plugin_display.get_selection ()->get_selected ();
	boost::shared_ptr<PluginScanLogEntry> sel;
	if (iter) {
		sel = (*iter)[plugin_columns.psle];
	}

	plugin_display.set_model (Glib::RefPtr<TreeStore> (0));

	int      sort_col;
	SortType sort_type;
	bool     sorted = plugin_model->get_sort_column_id (sort_col, sort_type);
	plugin_model->set_sort_column (-2, SORT_ASCENDING);
	plugin_model->clear ();

	bool rescan_err = false;
	bool have_stale = false;

	std::map<PluginType, PluginCount> plugin_count;

	std::vector<boost::shared_ptr<PluginScanLogEntry> > psl;
	PluginManager& manager (PluginManager::instance ());
	manager.scan_log (psl);

	std::string searchstr = _entry_search.get_text ();
	setup_search_string (searchstr);

	for (std::vector<boost::shared_ptr<PluginScanLogEntry> >::const_iterator i = psl.begin (); i != psl.end (); ++i) {
		PluginInfoList const& plugs = (*i)->nfo ();

		if (!(*i)->recent ()) {
			have_stale = true;
		} else if ((*i)->result () == PluginScanLogEntry::Blacklisted) {
			/* OK, but manually blacklisted */
		} else if ((*i)->result () != PluginScanLogEntry::OK) {
			if ((*i)->type () != LV2) {
				rescan_err = true;
			}
		}

		if (plugs.size () == 0) {
			plugin_count[(*i)->type ()].set (**i);

			if (!show_this_plugin (*i, ARDOUR::PluginInfoPtr (), searchstr)) {
				continue;
			}

			TreeModel::Row newrow                = *(plugin_model->append ());
			newrow[plugin_columns.path]          = Glib::path_get_basename ((*i)->path ());
			newrow[plugin_columns.type]          = plugin_type ((*i)->type ());
			newrow[plugin_columns.name]          = "-";
			newrow[plugin_columns.creator]       = "-";
			newrow[plugin_columns.tags]          = "-";
			newrow[plugin_columns.status]        = status_text (**i, PluginManager::Normal); // XXX
			newrow[plugin_columns.blacklisted]   = is_blacklisted (**i);
			newrow[plugin_columns.psle]          = *i;
			newrow[plugin_columns.plugin]        = ARDOUR::PluginInfoPtr ();
			newrow[plugin_columns.favorite]      = false;
			newrow[plugin_columns.hidden]        = false;
			newrow[plugin_columns.can_blacklist] = can_blacklist (**i);
			newrow[plugin_columns.can_fav_hide]  = false;
		} else {
			for (PluginInfoList::const_iterator j = plugs.begin (); j != plugs.end (); ++j) {
				plugin_count[(*i)->type ()].set (**i);

				if (!show_this_plugin (*i, *j, searchstr)) {
					continue;
				}

				PluginManager::PluginStatusType status = manager.get_status (*j);
				std::string                     tags   = manager.get_tags_as_string (*j);

				if (tags.length () > 32) {
					tags = tags.substr (0, 32);
					tags.append ("...");
				}

				TreeModel::Row newrow                = *(plugin_model->append ());
				newrow[plugin_columns.favorite]      = status == PluginManager::Favorite;
				newrow[plugin_columns.hidden]        = status == PluginManager::Hidden;
				newrow[plugin_columns.path]          = Glib::path_get_basename ((*i)->path ());
				newrow[plugin_columns.type]          = plugin_type ((*i)->type ());
				newrow[plugin_columns.name]          = (*j)->name;
				newrow[plugin_columns.creator]       = (*j)->creator;
				newrow[plugin_columns.tags]          = tags;
				newrow[plugin_columns.status]        = status_text (**i, status);
				newrow[plugin_columns.blacklisted]   = is_blacklisted (**i);
				newrow[plugin_columns.psle]          = *i;
				newrow[plugin_columns.plugin]        = *j;
				newrow[plugin_columns.can_blacklist] = can_blacklist (**i);
				newrow[plugin_columns.can_fav_hide]  = status != PluginManager::Concealed;
			}
		}
	}

	plugin_display.set_model (plugin_model);
	if (sorted) {
		plugin_model->set_sort_column (sort_col, sort_type);
	}

	if (sel) {
		TreeModel::Children rows = plugin_model->children ();
		for (TreeModel::Children::iterator i = rows.begin (); i != rows.end (); ++i) {
			boost::shared_ptr<PluginScanLogEntry> const& srow ((*i)[plugin_columns.psle]);
			if (*sel == *srow) {
				plugin_display.get_selection ()->select (*i);
				TreeIter iter = plugin_display.get_selection ()->get_selected ();
				assert (iter);
				plugin_display.scroll_to_row (plugin_model->get_path (iter), 0.5);
				break;
			}
		}
	}

	plugin_display.set_search_column (6); // Name

	/* refill "Plugin Count" */
	int row = 0;

	std::list<Widget*> children = _tbl_nfo.get_children ();
	for (std::list<Widget*>::iterator child = children.begin (); child != children.end (); ++child) {
		_tbl_nfo.remove (**child);
		delete *child;
	}

	PluginCount pc_max;
	for (std::map<PluginType, PluginCount>::const_iterator i = plugin_count.begin (); i != plugin_count.end (); ++i) {
		pc_max.total = std::max (pc_max.total, i->second.total);
		pc_max.error = std::max (pc_max.error, i->second.error);
		pc_max.stale = std::max (pc_max.stale, i->second.stale);
		pc_max.ndscn = std::max (pc_max.ndscn, i->second.ndscn);
	}

	Label* head_type  = new Label (_("Type"), ALIGN_LEFT, ALIGN_CENTER);
	Label* head_count = new Label (_("Total"), ALIGN_RIGHT, ALIGN_CENTER);
	_tbl_nfo.attach (*head_type,  0, 1, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
	_tbl_nfo.attach (*head_count, 1, 2, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
	if (pc_max.error > 0) {
		Label* hd = new Label (_("Err"), ALIGN_RIGHT, ALIGN_CENTER);
		_tbl_nfo.attach (*hd, 2, 3, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
	}
	if (pc_max.stale > 0) {
		Label* hd = new Label (_("Mis"), ALIGN_RIGHT, ALIGN_CENTER);
		_tbl_nfo.attach (*hd, 3, 4, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
	}
	if (pc_max.ndscn > 0) {
		Label* hd = new Label (_("New"), ALIGN_RIGHT, ALIGN_CENTER);
		_tbl_nfo.attach (*hd, 4, 5, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
	}
	++row;
	for (std::map<PluginType, PluginCount>::const_iterator i = plugin_count.begin (); i != plugin_count.end (); ++i, ++row) {
		Label* lbl_type  = new Label (plugin_type (i->first), ALIGN_LEFT, ALIGN_CENTER);
		Label* lbl_count = new Label (string_compose ("%1", i->second.total), ALIGN_RIGHT, ALIGN_CENTER);
		_tbl_nfo.attach (*lbl_type,  0, 1, row, row + 1, EXPAND | FILL, SHRINK, 2, 2);
		_tbl_nfo.attach (*lbl_count, 1, 2, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
		if (pc_max.error > 0) {
			Label* lbl = new Label (string_compose ("%1", i->second.error), ALIGN_RIGHT, ALIGN_CENTER);
			_tbl_nfo.attach (*lbl, 2, 3, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
		}
		if (pc_max.stale > 0) {
			Label* lbl = new Label (string_compose ("%1", i->second.stale), ALIGN_RIGHT, ALIGN_CENTER);
			_tbl_nfo.attach (*lbl, 3, 4, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
		}
		if (pc_max.ndscn > 0) {
			Label* lbl = new Label (string_compose ("%1", i->second.ndscn), ALIGN_RIGHT, ALIGN_CENTER);
			_tbl_nfo.attach (*lbl, 4, 5, row, row + 1, SHRINK | FILL, SHRINK, 2, 2);
		}
	}
	_tbl_nfo.show_all ();

	/* update sensitivity */
	_btn_clear.set_sensitive (have_stale);
	_btn_rescan_err.set_sensitive (rescan_err);
}

void
PluginManagerUI::selection_changed ()
{
	if (plugin_display.get_selection ()->count_selected_rows () != 1) {
		_log.get_buffer ()->set_text ("");
		_btn_rescan_sel.set_sensitive (false);
		return;
	}

	TreeIter                                     iter = plugin_display.get_selection ()->get_selected ();
	boost::shared_ptr<PluginScanLogEntry> const& psle ((*iter)[plugin_columns.psle]);

	_log.get_buffer ()->set_text (psle->log ());

	PluginScanLogEntry::PluginScanResult sr = psle->result ();
	if (sr == PluginScanLogEntry::OK || psle->type () == LV2) {
		_btn_rescan_sel.set_sensitive (false);
	} else {
		_btn_rescan_sel.set_sensitive (true);
	}
}

void
PluginManagerUI::row_activated (TreeModel::Path const& p, TreeViewColumn*)
{
#ifndef NDEBUG
	TreeModel::iterator iter = plugin_model->get_iter (p);
	if (!iter) {
		return;
	}
	boost::shared_ptr<PluginScanLogEntry> const& psle ((*iter)[plugin_columns.psle]);

	switch (psle->type ()) {
		case Windows_VST:
		case LXVST:
		case MacVST:
		case LADSPA:
			PBD::open_folder (Glib::path_get_dirname (psle->path ()));
			break;
		case VST3:
			PBD::open_folder (psle->path ());
			break;
		case AudioUnit:
		case LV2:
		default:
			printf ("%s\n", psle->path ().c_str ());
			break;
	}
#endif
}

void
PluginManagerUI::blacklist_changed (std::string const& path)
{
	TreeIter iter;
	if ((iter = plugin_model->get_iter (path))) {
		boost::shared_ptr<PluginScanLogEntry> const& psle ((*iter)[plugin_columns.psle]);
		if ((*iter)[plugin_columns.blacklisted]) {
			PluginScanDialog psd (false, true, this);
			PluginManager::instance ().rescan_plugin (psle->type (), psle->path ());
		} else {
			PluginManager::instance ().blacklist (psle->type (), psle->path ());
		}
	}
}

void
PluginManagerUI::show_plugin_prefs ()
{
	ARDOUR_UI::instance ()->show_plugin_prefs ();
}

void
PluginManagerUI::edit_vst_path (std::string const& title, std::string const& dflt, sigc::slot<std::string> get, sigc::slot<bool, std::string> set)
{
	/* see also RCOptionEditor::edit_vst_path */
	ArdourWidgets::PathsDialog pd (*this, title, get (), dflt);
	if (pd.run () != RESPONSE_ACCEPT) {
		return;
	}
	pd.hide ();
	set (pd.get_serialized_paths ());

	ArdourMessageDialog msg (_("Re-scan Plugins now?"), false, MESSAGE_QUESTION, BUTTONS_YES_NO, true);
	msg.set_default_response (RESPONSE_YES);
	if (msg.run () != RESPONSE_YES) {
		return;
	}
	msg.hide ();
	PluginScanDialog psd (false, true, this);
	psd.start ();
}

void
PluginManagerUI::vst_path_cb (ARDOUR::PluginType t)
{
	switch (t) {
#ifdef WINDOWS_VST_SUPPORT
		case Windows_VST:
			edit_vst_path (
			    _("Set Windows VST2 Search Path"),
			    PluginManager::instance ().get_default_windows_vst_path (),
			    sigc::mem_fun (*Config, &RCConfiguration::get_plugin_path_vst),
			    sigc::mem_fun (*Config, &RCConfiguration::set_plugin_path_vst));
			break;
#endif
#ifdef LXVST_SUPPORT
		case LXVST:
			edit_vst_path (
			    _("Set Linux VST2 Search Path"),
			    PluginManager::instance ().get_default_lxvst_path (),
			    sigc::mem_fun (*Config, &RCConfiguration::get_plugin_path_lxvst),
			    sigc::mem_fun (*Config, &RCConfiguration::set_plugin_path_lxvst));
			break;
#endif
#ifdef VST3_SUPPORT
		case VST3:
			edit_vst_path (
			    _("Set Additional VST3 Search Path"),
			    "", /* default is blank */
			    sigc::mem_fun (*Config, &RCConfiguration::get_plugin_path_vst3),
			    sigc::mem_fun (*Config, &RCConfiguration::set_plugin_path_vst3));
			break;
#endif
		default:
			break;
	}
}

void
PluginManagerUI::rescan_all ()
{
	ArdourMessageDialog msg (_("Are you sure you want to rescan all plugins?"), false, MESSAGE_QUESTION, BUTTONS_YES_NO, true);
	msg.set_title (_("Rescan Plugins"));
	msg.set_secondary_text (_("This starts a fresh scan, dropping all cached plugin data and backlists. Depending on the number if plugins installed this can take a long time."));

	if (msg.run () != RESPONSE_YES) {
		return;
	}

	msg.hide ();

	ARDOUR::PluginManager& manager (PluginManager::instance ());
	if (true) {
		manager.clear_au_blacklist ();
		manager.clear_vst_blacklist ();
		manager.clear_vst3_blacklist ();
	}

	manager.clear_au_cache ();
	manager.clear_vst_cache ();
	manager.clear_vst3_cache ();

	PluginScanDialog psd (false, true, this);
	psd.start ();
}

void
PluginManagerUI::rescan_faulty ()
{
	PluginScanDialog psd (false, true, this);
	PluginManager::instance ().rescan_faulty ();
	_entry_search.set_text ("");
}

void
PluginManagerUI::reindex()
{
	PluginScanDialog psd (true, true, this);
	psd.start ();
}

void
PluginManagerUI::rescan_selected ()
{
	if (plugin_display.get_selection ()->count_selected_rows () != 1) {
		return;
	}

	TreeIter                                     iter = plugin_display.get_selection ()->get_selected ();
	boost::shared_ptr<PluginScanLogEntry> const& psle ((*iter)[plugin_columns.psle]);

	PluginScanDialog psd (false, true, this);
	PluginManager::instance ().rescan_plugin (psle->type (), psle->path ());
}

void
PluginManagerUI::clear_log ()
{
	PluginManager::instance ().clear_stale_log ();
}

void
PluginManagerUI::plugin_status_changed (ARDOUR::PluginType t, std::string uid, ARDOUR::PluginManager::PluginStatusType stat)
{
	TreeModel::Children rows = plugin_model->children ();
	for (TreeModel::Children::iterator i = rows.begin (); i != rows.end (); ++i) {
		PluginInfoPtr pp = (*i)[plugin_columns.plugin];
		if (!pp || pp->type != t || pp->unique_id != uid) {
			continue;
		}

		(*i)[plugin_columns.favorite] = (stat == PluginManager::Favorite) ? true : false;
		(*i)[plugin_columns.hidden]   = (stat == PluginManager::Hidden) ? true : false;

		break;
	}
}

void
PluginManagerUI::favorite_changed (const std::string& path)
{
	if (_in_row_change) {
		return;
	}

	PBD::Unwinder<bool> uw (_in_row_change, true);

	TreeIter iter;
	if ((iter = plugin_model->get_iter (path))) {
		bool favorite = !(*iter)[plugin_columns.favorite];

		PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
		PluginInfoPtr                   pi     = (*iter)[plugin_columns.plugin];

		ARDOUR::PluginManager& manager (PluginManager::instance ());
		manager.set_status (pi->type, pi->unique_id, status);
		manager.save_statuses (); // TODO postpone
	}
}

void
PluginManagerUI::hidden_changed (const std::string& path)
{
	if (_in_row_change) {
		return;
	}

	PBD::Unwinder<bool> uw (_in_row_change, true);

	TreeIter iter;
	if ((iter = plugin_model->get_iter (path))) {
		bool hidden = !(*iter)[plugin_columns.hidden];

		PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
		PluginInfoPtr                   pi     = (*iter)[plugin_columns.plugin];

		ARDOUR::PluginManager& manager (PluginManager::instance ());
		manager.set_status (pi->type, pi->unique_id, status);
		manager.save_statuses (); // TODO postpone
	}
}

void
PluginManagerUI::search_entry_changed ()
{
	refill ();
}

void
PluginManagerUI::search_clear_button_clicked ()
{
	_entry_search.set_text ("");
}