PluginSettingsPage.cpp

//-----------------------------------------------------------------------------
// File: PluginSettingsPage.cpp
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Joni-Matti Maatta
// Date: 19.02.2013
//
// Description:
// Settings page for adjusting plugin settings.
//-----------------------------------------------------------------------------

#include "PluginSettingsPage.h"

#include <KactusAPI/include/IPlugin.h>
#include <KactusAPI/include/IGeneratorPlugin.h>
#include <KactusAPI/include/ISourceAnalyzerPlugin.h>
#include <KactusAPI/include/ImportPlugin.h>
#include <settings/PluginInfoWidget.h>
#include <settings/NewPluginsDialog.h>

#include <IPXACTmodels/utilities/XmlUtils.h>

#include <QApplication>
#include <QVBoxLayout>
#include <QLabel>
#include <QGroupBox>

namespace
{   
    //! Enumeration for model roles.
    enum Roles
    {
        PLUGIN_POINTER_ROLE = Qt::UserRole, //<! Pointer to the plugin.
        PLUGIN_STACK_INDEX_ROLE             //<! Index of the plugin in stacks.
    };
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::PluginSettingsPage()
//-----------------------------------------------------------------------------
PluginSettingsPage::PluginSettingsPage(QSettings& settings):
SettingsPage(settings),
    settings_(settings),
    pluginDirSelector_(QApplication::applicationDirPath(), 
        settings.value("Platform/PluginsPath", QStringList("Plugins")).toStringList(), this),
    pluginsTree_(this), 
    infoStack_(this),
    directoriesChanged_(false)
{
    // Initialize the widgets and create the layout.
    pluginDirSelector_.setPersistentDirectory("Plugins");
    pluginDirSelector_.setPersistentDirectory("plugins");

    pluginsTree_.setObjectName("PluginsTree");
    QString stylesheet("QTreeView#PluginsTree::indicator:unchecked {image: url(:icons/common/graphics/traffic-light_gray.png);}"
        "QTreeView#PluginsTree::indicator:checked {image: url(:icons/common/graphics/traffic-light_green.png);}");
    pluginsTree_.setStyleSheet(stylesheet);

    pluginsTree_.setHeaderHidden(true);
    pluginsTree_.setColumnCount(1);
    pluginsTree_.setSelectionBehavior(QAbstractItemView::SelectItems);    

    setupLayout();

    refreshPluginsTree();

    connect(&pluginDirSelector_, SIGNAL(contentChanged()),
        this, SLOT(onDirectoriesChanged()), Qt::UniqueConnection);    

    connect(&pluginsTree_, SIGNAL(currentItemChanged(QTreeWidgetItem*, QTreeWidgetItem*)),
        this, SLOT(onTreeItemChanged(QTreeWidgetItem*, QTreeWidgetItem*)));
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::validate()
//-----------------------------------------------------------------------------
bool PluginSettingsPage::validate()
{
    for (int i = 0; i < pluginsTree_.topLevelItemCount(); ++i)
    {
        QTreeWidgetItem* categoryRoot = pluginsTree_.topLevelItem(i);

        for (int j = 0; j < categoryRoot->childCount(); ++j)
        {
            QTreeWidgetItem* item = categoryRoot->child(j);

            // Retrieve the plugin pointer from the data.
            IPlugin* plugin = static_cast<IPlugin*>(item->data(0, PLUGIN_POINTER_ROLE).value<void*>());
            Q_ASSERT(plugin != 0);

            if (plugin->getSettingsModel() &&!plugin->getSettingsModel()->validateSettings())
            {
                return false;
            }
        }
    }

    return true;
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::apply()
//-----------------------------------------------------------------------------
void PluginSettingsPage::apply()
{
    if (directoriesChanged_ || settings_.value("Platform/PluginsPath").toString().isEmpty())
    {
        // Save the new plugins directories and update plugin manager.
        settings_.setValue("Platform/PluginsPath", pluginDirSelector_.getDirectories());
        PluginManager::getInstance().setPluginPaths(pluginDirSelector_.getDirectories());
    }

    settings_.beginGroup("PluginSettings");

    // Save settings and active state for each individual plugin.
    for (int i = 0; i < pluginsTree_.topLevelItemCount(); ++i)
    {
        QTreeWidgetItem* categoryRoot = pluginsTree_.topLevelItem(i);

        for (int j = 0; j < categoryRoot->childCount(); ++j)
        {
            QTreeWidgetItem* item = categoryRoot->child(j);

            // Retrieve the plugin pointer from the data.
            IPlugin* plugin = static_cast<IPlugin*>(item->data(0, PLUGIN_POINTER_ROLE).value<void*>());
            Q_ASSERT(plugin != 0);

            // Save the active state.
            settings_.beginGroup(XmlUtils::removeWhiteSpace(plugin->getName()));
            settings_.setValue("Active", item->checkState(0) == Qt::Checked);

            if (plugin->getSettingsModel())
            {
                plugin->getSettingsModel()->saveSettings(settings_);
            }

            settings_.endGroup();
        }
    }

    settings_.endGroup();
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::onTreeItemChanged()
//-----------------------------------------------------------------------------
void PluginSettingsPage::onTreeItemChanged(QTreeWidgetItem* current, QTreeWidgetItem* /*prev*/)
{
    int index = 0;

    if (current != nullptr)
    {
        index = current->data(0, PLUGIN_STACK_INDEX_ROLE).toInt();
    }

    Q_ASSERT(index < infoStack_.count());
    infoStack_.setCurrentIndex(index);
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::createCategoryItem()
//-----------------------------------------------------------------------------
QTreeWidgetItem* PluginSettingsPage::createCategoryItem(QString const& text, QIcon const& icon)
{
    QTreeWidgetItem* item = new QTreeWidgetItem();
    item->setText(0, text);
    item->setIcon(0, icon);
    item->setData(0, PLUGIN_STACK_INDEX_ROLE, 0);

    // Use bold font for category items.
    QFont rootFont = item->font(0);
    rootFont.setBold(true);
    item->setFont(0, rootFont);

    pluginsTree_.addTopLevelItem(item);
    return item;
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::createItem()
//-----------------------------------------------------------------------------
QTreeWidgetItem* PluginSettingsPage::createPluginItem(IPlugin* plugin)
{
    QTreeWidgetItem* item = new QTreeWidgetItem();
    item->setText(0, plugin->getName() + " (" + plugin->getVersion() + ")");

    if (settings_.value("Active", true).toBool())
    {
        item->setCheckState(0, Qt::Checked);
    }
    else
    {
        item->setCheckState(0, Qt::Unchecked);
    }

    item->setData(0, PLUGIN_POINTER_ROLE, QVariant::fromValue(static_cast<void*>(plugin)));
    item->setData(0, PLUGIN_STACK_INDEX_ROLE, infoStack_.count());

    infoStack_.addWidget(new PluginInfoWidget(plugin));

    return item;
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::onDirectoriesChanged()
//-----------------------------------------------------------------------------
void PluginSettingsPage::onDirectoriesChanged()
{
    directoriesChanged_ = true;
    refreshPluginsTree(true);
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::refreshPluginsTree()
//-----------------------------------------------------------------------------
void PluginSettingsPage::refreshPluginsTree(bool displayChanges)
{
    QApplication::setOverrideCursor(Qt::WaitCursor);
    
    QList<IPlugin*> newPlugins;
    QList<IPlugin*> oldPlugins = PluginManager::getInstance().getAllPlugins();    
    
    resetStacks();
    pluginsTree_.clear();

    // Create the category items.
    QTreeWidgetItem* generatorsItem = createCategoryItem(tr("Generators"),
        QIcon(":icons/common/graphics/configuration.png"));
    QTreeWidgetItem* analyzersItem = createCategoryItem(tr("Source Analyzers"),
        QIcon(":icons/common/graphics/plugin-source_analyzer.png"));
    QTreeWidgetItem* importItems = createCategoryItem(tr("Import Plugins"),
        QIcon(":icons/common/graphics/import.png"));

    // Enumerate all plugins and add them to the correct root.
    QList<IPlugin*> plugins = PluginManager::findPluginsInPaths(pluginDirSelector_.getDirectories());

    settings_.beginGroup("PluginSettings");
    for (IPlugin* plugin : plugins)
    {
        settings_.beginGroup(XmlUtils::removeWhiteSpace(plugin->getName()));

        // Create the tree item.
        QTreeWidgetItem* pluginItem = createPluginItem(plugin);

        // Add item under the right parent.
        if (dynamic_cast<IGeneratorPlugin*>(plugin) != 0)
        {
            pluginItem->setIcon(0, dynamic_cast<IGeneratorPlugin*>(plugin)->getIcon());
            generatorsItem->addChild(pluginItem);
        }
        else if (dynamic_cast<ISourceAnalyzerPlugin*>(plugin) != 0)
        {
            analyzersItem->addChild(pluginItem);
        }
        else if(dynamic_cast<ImportPlugin*>(plugin) != 0)
        {
            importItems->addChild(pluginItem);
        }

        // Check if the plugin has not been visible before.
        if (displayChanges && !oldPlugins.contains(plugin))
        {    
            newPlugins.append(plugin);          
        }

        settings_.endGroup();
    }

    settings_.endGroup();

    pluginsTree_.expandAll();

    QApplication::restoreOverrideCursor();

    if (displayChanges && newPlugins.size() > 0)
    {
        NewPluginsDialog pluginDialog(this);
        pluginDialog.addPlugins(newPlugins);
        pluginDialog.exec();
    }
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::resetStacks()
//-----------------------------------------------------------------------------
void PluginSettingsPage::resetStacks()
{
    while (infoStack_.count() > 0)
    {
        infoStack_.removeWidget(infoStack_.widget(0));
    }

    infoStack_.addWidget(new PluginInfoWidget());
}

//-----------------------------------------------------------------------------
// Function: PluginSettingsPage::setupLayout()
//-----------------------------------------------------------------------------
void PluginSettingsPage::setupLayout()
{
    pluginDirSelector_.setMinimumHeight(120);
    pluginDirSelector_.setMinimumWidth(240);

	auto infoLayout = new QVBoxLayout();
    infoLayout->addWidget(&infoStack_);

	auto infoGroup = new QGroupBox(tr("Plugin general information"), this);
    infoGroup->setLayout(infoLayout);
    infoGroup->setFlat(true);

    auto layout = new QGridLayout(this);
    layout->addWidget(new QLabel(tr("Plugin directories:"), this), 0, 0, 1, 1);
    layout->addWidget(new QLabel(tr("Available plugins:"), this), 0, 1, 1, 1);
    layout->addWidget(&pluginDirSelector_, 1, 0, 1, 1);
    layout->addWidget(&pluginsTree_, 1, 1, 1, 1);
    layout->addWidget(infoGroup, 2, 0, 1, 2);

    layout->setRowStretch(1, 2);
}