Application.cc

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#include <tinyxml2.h>
#include <queue>

#include <gz/common/Console.hh>
#include <gz/common/Filesystem.hh>
#include <gz/common/SignalHandler.hh>
#include <gz/common/StringUtils.hh>
#include <gz/common/SystemPaths.hh>
#include <gz/common/Util.hh>

#include <gz/plugin/Loader.hh>

#include "gz/gui/Application.hh"
#include "gz/gui/config.hh"
#include "gz/gui/Dialog.hh"
#include "gz/gui/Helpers.hh"
#include "gz/gui/MainWindow.hh"
#include "gz/gui/Plugin.hh"

#include "gz/transport/TopicUtils.hh"

namespace gz
{
  namespace gui
  {
    class ApplicationPrivate
    {
      /// \brief QML engine
      public: QQmlApplicationEngine *engine{nullptr};

      /// \brief Pointer to main window
      public: MainWindow *mainWin{nullptr};

      /// \brief Vector of pointers to dialogs
      public: std::vector<Dialog *> dialogs;

      /// \brief Queue of plugins which should be added to the window
      public: std::queue<std::shared_ptr<Plugin>> pluginsToAdd;

      /// \brief Vector of pointers to plugins already added, we hang on to
      /// these until it is ok to unload the plugin's shared library.
      public: std::vector<std::shared_ptr<Plugin>> pluginsAdded;

      /// \brief Deprecated environment variable which holds paths to look for
      /// plugins
      public: std::string pluginPathEnvDeprecated = "IGN_GUI_PLUGIN_PATH";

      /// \brief Environment variable which holds paths to look for plugins
      public: std::string pluginPathEnv = "GZ_GUI_PLUGIN_PATH";

      /// \brief Vector of paths to look for plugins
      public: std::vector<std::string> pluginPaths;

      /// \brief Holds a configuration which may be applied to mainWin once it
      /// is created by calling applyConfig(). It's no longer needed and
      /// should not be used after that.
      public: WindowConfig windowConfig;

      /// \brief The path containing the default configuration file.
      public: std::string defaultConfigPath;

      public: common::SignalHandler signalHandler;

      /// \brief QT message handler that pipes qt messages into our console
      /// system.
      public: static void MessageHandler(QtMsgType _type,
          const QMessageLogContext &_context, const QString &_msg);
    };
  }
}

using namespace gz;
using namespace gui;

enum class GZ_COMMON_HIDDEN AvailableAPIs
{
  OpenGL,
  Vulkan,
  Metal
};

/////////////////////////////////////////////////
Application::Application(int &_argc, char **_argv, const WindowType _type,
                         const char *_renderEngineGuiApiBackend) :
  QApplication(_argc, _argv),
  dataPtr(new ApplicationPrivate)
{
  gzdbg << "Initializing application." << std::endl;

  this->setOrganizationName("Gazebo");
  this->setOrganizationDomain("gazebosim.org");
  this->setApplicationName("Gazebo GUI");

  // Disable deprecation messages about onFoo connections since the new way of
  // definining connections is only available as of Qt 5.12, which is not
  // available in Ubuntu Focal
  // TODO(azeey) Remove once Qt 5.12 is available in all supported platforms.
  QLoggingCategory::setFilterRules("qt.qml.connections=false");

#ifdef __APPLE__
  AvailableAPIs api = AvailableAPIs::Metal;
#else
  AvailableAPIs api = AvailableAPIs::OpenGL;
#endif
  if (_renderEngineGuiApiBackend)
  {
    const std::string renderEngineGuiApiBackend = _renderEngineGuiApiBackend;
    if (renderEngineGuiApiBackend == "vulkan")
      api = AvailableAPIs::Vulkan;
#ifdef __APPLE__
    if (renderEngineGuiApiBackend == "metal")
      api = AvailableAPIs::Metal;
#endif
  }

#ifdef __APPLE__
  if (api == AvailableAPIs::Metal)
  {
    // Use the Metal graphics API on macOS.
    gzdbg << "Qt using Metal graphics interface" << std::endl;
    QQuickWindow::setSceneGraphBackend(QSGRendererInterface::MetalRhi);
  }

  // TODO(srmainwaring): implement facility for overriding the default
  //    graphics API in macOS, in which case there are restrictions on
  //    the version of OpenGL used.
  //
  // macOS only supports OpenGL <= 4.1.
  // This must be called before the main window is shown.
  // QSurfaceFormat format(QSurfaceFormat::DeprecatedFunctions);
  // format.setDepthBufferSize(24);
  // format.setStencilBufferSize(8);
  // format.setVersion(4, 1);
  // format.setProfile(QSurfaceFormat::CoreProfile);
  // format.setRenderableType(QSurfaceFormat::OpenGL);
  // QSurfaceFormat::setDefaultFormat(format);
#else
  // Otherwise use OpenGL (or Vulkan when supported and requested)

  if (api == AvailableAPIs::Vulkan)
  {
    gzdbg << "Qt using Vulkan graphics interface" << std::endl;

#  ifdef GZ_USE_VULKAN_DEBUG_EXT
    qputenv("QT_VULKAN_INSTANCE_EXTENSIONS",
            "VK_EXT_debug_report;VK_EXT_debug_utils");
#  endif
    qputenv("QT_VULKAN_DEVICE_EXTENSIONS",
            "VK_KHR_maintenance2;VK_EXT_shader_subgroup_vote;"
            "VK_EXT_shader_viewport_index_layer;"
#  ifdef GZ_USE_VULKAN_DEBUG_EXT
            ";VK_EXT_debug_marker"
#  endif
    );

#  if QT_VERSION >= QT_VERSION_CHECK(5, 15, 2) && QT_CONFIG(vulkan)
    QQuickWindow::setSceneGraphBackend(QSGRendererInterface::VulkanRhi);
#  endif
  }
  else
  {
    gzdbg << "Qt using OpenGL graphics interface" << std::endl;
  }
#endif

  // Configure console
  common::Console::SetPrefix("[GUI] ");

  // QML engine
  this->dataPtr->engine = new QQmlApplicationEngine();
  this->dataPtr->engine->addImportPath(qmlQrcImportPath());

  // Install signal handler for graceful shutdown
  this->dataPtr->signalHandler.AddCallback(
      [](int)  // NOLINT(readability/casting)
      {
          App()->quit();
      });

  // Handle qt console messages
  qInstallMessageHandler(this->dataPtr->MessageHandler);

  // Default config path
  std::string home;
  common::env(GZ_HOMEDIR, home);
  this->dataPtr->defaultConfigPath = common::joinPaths(
        home, ".gz", "gui", "default.config");

  // If it's a main window, initialize it
  if (_type == WindowType::kMainWindow)
  {
    if (!this->InitializeMainWindow())
    {
      gzerr << "Failed to initialize main window." << std::endl;
    }
    else
    {
      switch (api)
      {
      default:
      case AvailableAPIs::OpenGL:
        this->dataPtr->mainWin->setProperty("renderEngineBackendApiName",
                                            "opengl");
        break;
      case AvailableAPIs::Vulkan:
        this->dataPtr->mainWin->setProperty("renderEngineBackendApiName",
                                            "vulkan");
        break;
      case AvailableAPIs::Metal:
        this->dataPtr->mainWin->setProperty("renderEngineBackendApiName",
                                            "metal");
        break;
      }
    }
  }
  else if (_type == WindowType::kDialog)
  {
    // Do nothing, dialogs are initialized as plugins are loaded
  }
  else
  {
    gzerr << "Unknown WindowType [" << static_cast<int>(_type) << "]\n";
  }
}

/////////////////////////////////////////////////
Application::~Application()
{
  gzdbg << "Terminating application." << std::endl;

  if (this->dataPtr->mainWin && this->dataPtr->mainWin->QuickWindow())
  {
    // Detach object from main window and leave libraries for gz-common
    auto plugins = this->dataPtr->mainWin->findChildren<Plugin *>();
    for (auto plugin : plugins)
    {
      auto pluginName = plugin->CardItem()->objectName();
      this->RemovePlugin(pluginName.toStdString());
    }
    if (this->dataPtr->mainWin->QuickWindow()->isVisible())
      this->dataPtr->mainWin->QuickWindow()->close();
    delete this->dataPtr->mainWin;
    this->dataPtr->mainWin = nullptr;
  }

  for (auto dialog : this->dataPtr->dialogs)
  {
    if (dialog->QuickWindow())
      dialog->QuickWindow()->close();
    dialog->deleteLater();
  }
  this->dataPtr->dialogs.clear();

  if (this->dataPtr->engine)
  {
    this->dataPtr->engine->deleteLater();
  }

  std::queue<std::shared_ptr<Plugin>> empty;
  std::swap(this->dataPtr->pluginsToAdd, empty);
  this->dataPtr->pluginsAdded.clear();
  this->dataPtr->pluginPaths.clear();
  this->dataPtr->pluginPathEnv = "GZ_GUI_PLUGIN_PATH";
}

/////////////////////////////////////////////////
QQmlApplicationEngine *Application::Engine() const
{
  return this->dataPtr->engine;
}

/////////////////////////////////////////////////
Application *gz::gui::App()
{
  return qobject_cast<Application *>(qGuiApp);
}

/////////////////////////////////////////////////
bool Application::RemovePlugin(const std::string &_pluginName)
{
  auto plugin = this->PluginByName(_pluginName);
  if (nullptr == plugin)
    return false;

  auto cardItem = plugin->CardItem();
  if (nullptr == cardItem)
    return false;

  // Remove on QML
  cardItem->deleteLater();

  // Remove split on QML
  auto bgItem = this->dataPtr->mainWin->QuickWindow()
      ->findChild<QQuickItem *>("background");
  if (bgItem && cardItem->parentItem())
  {
    QMetaObject::invokeMethod(bgItem, "removeSplitItem",
        Q_ARG(QVariant, cardItem->parentItem()->objectName()));
  }

  // Unload shared library
  this->RemovePlugin(plugin);

  return true;
}

/////////////////////////////////////////////////
bool Application::LoadConfig(const std::string &_config)
{
  if (_config.empty())
  {
    gzerr << "Missing config file" << std::endl;
    return false;
  }

  std::string configFull = _config;

  // Check if the passed in config file exists.
  // (If the default config path doesn't exist yet, it's expected behavior.
  // It will be created the first time the user presses "Save configuration".)
  if (!common::exists(configFull) && (configFull != this->DefaultConfigPath()))
  {
    // If not, then check environment variable
    std::string configPathEnv;
    common::env("GZ_GUI_RESOURCE_PATH", configPathEnv);

    if (!configPathEnv.empty())
    {
      std::vector<std::string> parentPaths = common::Split(configPathEnv, ':');
      for (auto parentPath : parentPaths)
      {
        std::string tempPath = common::joinPaths(parentPath, configFull);
        if (common::exists(tempPath))
        {
          configFull = tempPath;
          break;
        }
      }
    }
  }

  // Use tinyxml to read config
  tinyxml2::XMLDocument doc;
  auto success = !doc.LoadFile(configFull.c_str());
  if (!success)
  {
    // We do not show an error message if the default config path doesn't exist
    // yet. It's expected behavior, it will be created the first time the user
    // presses "Save configuration".
    if (configFull != this->DefaultConfigPath())
    {
      gzerr << "Failed to load file [" << configFull << "]: XMLError"
             << std::endl;
    }

    return false;
  }

  gzmsg << "Loading config [" << configFull << "]" << std::endl;

  // Clear all previous plugins
  auto plugins = this->dataPtr->mainWin->findChildren<Plugin *>();
  for (auto plugin : plugins)
  {
    auto pluginName = plugin->CardItem()->objectName();
    this->RemovePlugin(pluginName.toStdString());
  }
  if (this->dataPtr->pluginsAdded.size() > 0)
  {
    gzerr << "The plugin list was not properly cleaned up." << std::endl;
  }
  this->dataPtr->pluginsAdded.clear();

  // Process each plugin
  for (auto pluginElem = doc.FirstChildElement("plugin"); pluginElem != nullptr;
      pluginElem = pluginElem->NextSiblingElement("plugin"))
  {
    auto filename = pluginElem->Attribute("filename");
    this->LoadPlugin(filename, pluginElem);
  }

  // Process window properties
  if (auto winElem = doc.FirstChildElement("window"))
  {
    gzdbg << "Loading window config" << std::endl;

    tinyxml2::XMLPrinter printer;
    if (!winElem->Accept(&printer))
    {
      gzwarn << "There was an error parsing the <window> element"
              << std::endl;
      return false;
    }
    this->dataPtr->windowConfig.MergeFromXML(std::string(printer.CStr()));

    // Closing behavior.
    if (auto defaultExitActionElem =
      winElem->FirstChildElement("default_exit_action"))
    {
      ExitAction action{ExitAction::CLOSE_GUI};
      const auto value = common::lowercase(defaultExitActionElem->GetText());
      if (value == "shutdown_server")
      {
        action = ExitAction::SHUTDOWN_SERVER;
      }
      else if (value != "close_gui" && !value.empty())
      {
        gzwarn << "Value '" << value << "' of <default_exit_action> is "
                << "invalid. Allowed values are CLOSE_GUI and SHUTDOWN_SERVER. "
                << "Selecting CLOSE_GUI as fallback." << std::endl;
      }
      this->dataPtr->mainWin->SetDefaultExitAction(action);
    }

    // Dialog on exit
    if (auto dialogOnExitElem = winElem->FirstChildElement("dialog_on_exit"))
    {
      bool showDialogOnExit{false};
      dialogOnExitElem->QueryBoolText(&showDialogOnExit);
      this->dataPtr->mainWin->SetShowDialogOnExit(showDialogOnExit);
    }

    if (auto dialogOnExitOptionsElem =
      winElem->FirstChildElement("dialog_on_exit_options"))
    {
      if (auto promptElem =
        dialogOnExitOptionsElem->FirstChildElement("prompt_text"))
      {
        this->dataPtr->mainWin->SetDialogOnExitText(
          QString::fromStdString(promptElem->GetText()));
      }
      if (auto showShutdownElem =
        dialogOnExitOptionsElem->FirstChildElement("show_shutdown_button"))
      {
        bool showShutdownButton{false};
        showShutdownElem->QueryBoolText(&showShutdownButton);
        this->dataPtr->mainWin->SetExitDialogShowShutdown(showShutdownButton);
      }
      if (auto showCloseGuiElem =
        dialogOnExitOptionsElem->FirstChildElement("show_close_gui_button"))
      {
        bool showCloseGuiButton{false};
        showCloseGuiElem->QueryBoolText(&showCloseGuiButton);
        this->dataPtr->mainWin->SetExitDialogShowCloseGui(showCloseGuiButton);
      }
      if (auto shutdownTextElem =
        dialogOnExitOptionsElem->FirstChildElement("shutdown_button_text"))
      {
        this->dataPtr->mainWin->SetExitDialogShutdownText(
          QString::fromStdString(shutdownTextElem->GetText()));
      }
      if (auto closeGuiTextElem =
        dialogOnExitOptionsElem->FirstChildElement("close_gui_button_text"))
      {
        this->dataPtr->mainWin->SetExitDialogCloseGuiText(
          QString::fromStdString(closeGuiTextElem->GetText()));
      }
    }

    // Server control service topic
    std::string serverControlService{"/server_control"};
    auto serverControlElem =
      winElem->FirstChildElement("server_control_service");
    if (nullptr != serverControlElem && nullptr != serverControlElem->GetText())
    {
      serverControlService = transport::TopicUtils::AsValidTopic(
        serverControlElem->GetText());
    }

    if (serverControlService.empty())
    {
      gzerr << "Failed to create valid server control service" << std::endl;
    }
    else
    {
      gzmsg << "Using server control service [" << serverControlService
             << "]" << std::endl;
      this->dataPtr->mainWin->SetServerControlService(serverControlService);
    }
  }

  this->ApplyConfig();

  return true;
}

/////////////////////////////////////////////////
bool Application::LoadDefaultConfig()
{
  return this->LoadConfig(this->dataPtr->defaultConfigPath);
}

/////////////////////////////////////////////////
void Application::SetDefaultConfigPath(const std::string &_path)
{
  this->dataPtr->defaultConfigPath = _path;
}

/////////////////////////////////////////////////
std::string Application::DefaultConfigPath()
{
  return this->dataPtr->defaultConfigPath;
}

/////////////////////////////////////////////////
bool Application::LoadPlugin(const std::string &_filename,
    const tinyxml2::XMLElement *_pluginElem)
{
  if (_filename.empty())
  {
    gzerr << "Trying to load plugin with empty filename." << std::endl;
    return false;
  }

  gzdbg << "Loading plugin [" << _filename << "]" << std::endl;

  common::SystemPaths systemPaths;
  systemPaths.SetPluginPathEnv(this->dataPtr->pluginPathEnv);

  for (const auto &path : this->dataPtr->pluginPaths)
    systemPaths.AddPluginPaths(path);

  // Add default folder and install folder
  std::string home;
  common::env(GZ_HOMEDIR, home);
  systemPaths.AddPluginPaths(home + "/.gz/gui/plugins:" +
                             GZ_GUI_PLUGIN_INSTALL_DIR);

  auto pathToLib = systemPaths.FindSharedLibrary(_filename);
  if (pathToLib.empty())
  {
    // Try deprecated environment variable
    common::SystemPaths systemPathsDep;
    systemPathsDep.SetPluginPathEnv(this->dataPtr->pluginPathEnvDeprecated);
    pathToLib = systemPathsDep.FindSharedLibrary(_filename);
    if (pathToLib.empty())
    {
      gzerr << "Failed to load plugin [" << _filename <<
                "] : couldn't find shared library." << std::endl;
      return false;
    }
    else
    {
      gzwarn << "Found plugin [" << _filename
              << "] using deprecated environment variable ["
              << this->dataPtr->pluginPathEnvDeprecated << "]. Please use ["
              << this->dataPtr->pluginPathEnv << "] instead." << std::endl;
    }
  }

  // Load plugin
  plugin::Loader pluginLoader;

  auto pluginNames = pluginLoader.LoadLib(pathToLib, true);
  if (pluginNames.empty())
  {
    gzerr << "Failed to load plugin [" << _filename <<
              "] : couldn't load library on path [" << pathToLib <<
              "]." << std::endl;
    return false;
  }

  // Go over all plugin names and get the first one that implements the
  // gz::gui::Plugin interface
  plugin::PluginPtr commonPlugin;
  std::shared_ptr<gui::Plugin> plugin{nullptr};
  for (auto pluginName : pluginNames)
  {
    commonPlugin = pluginLoader.Instantiate(pluginName);
    if (!commonPlugin)
      continue;

    plugin = commonPlugin->QueryInterfaceSharedPtr<gz::gui::Plugin>();
    if (plugin)
      break;
  }

  if (!commonPlugin)
  {
    gzerr << "Failed to load plugin [" << _filename <<
              "] : couldn't instantiate plugin on path [" << pathToLib <<
              "]. Tried plugin names: " << std::endl;

    for (auto pluginName : pluginNames)
    {
      gzerr << " * " << pluginName << std::endl;
    }
    return false;
  }

  if (!plugin)
  {
    gzerr << "Failed to load plugin [" << _filename <<
              "] : couldn't get [gz::gui::Plugin] interface."
           << std::endl;
    return false;
  }

  // Basic config in case there is none
  if (!_pluginElem)
  {
    std::string pluginStr = "<plugin filename=\"" + _filename + "\"></plugin>";

    tinyxml2::XMLDocument pluginDoc;
    pluginDoc.Parse(pluginStr.c_str());

    plugin->Load(pluginDoc.FirstChildElement("plugin"));
  }
  else
    plugin->Load(_pluginElem);

  if (nullptr == plugin->CardItem())
    return false;

  // Store plugin in queue to be added to the window
  this->dataPtr->pluginsToAdd.push(plugin);

  // Add to window or dialog
  if (this->dataPtr->mainWin)
    this->AddPluginsToWindow();
  else
    this->InitializeDialogs();

  this->PluginAdded(plugin->CardItem()->objectName());
  gzmsg << "Loaded plugin [" << _filename << "] from path [" << pathToLib
         << "]" << std::endl;

  return true;
}

/////////////////////////////////////////////////
std::shared_ptr<Plugin> Application::PluginByName(
    const std::string &_pluginName) const
{
  for (auto &plugin : this->dataPtr->pluginsAdded)
  {
    auto cardItem = plugin->CardItem();
    if (!cardItem)
      continue;

    if (cardItem->objectName().toStdString() != _pluginName)
      continue;

    return plugin;
  }
  return nullptr;
}

/////////////////////////////////////////////////
bool Application::CreateMainWindow()
{
  return this->InitializeMainWindow();
}

/////////////////////////////////////////////////
bool Application::InitializeMainWindow()
{
  gzdbg << "Create main window" << std::endl;

  this->dataPtr->mainWin = new MainWindow();
  if (!this->dataPtr->mainWin->QuickWindow())
    return false;

  this->dataPtr->mainWin->setParent(this);

  return true;
}

/////////////////////////////////////////////////
bool Application::ApplyConfig()
{
  gzdbg << "Applying config" << std::endl;

  if (!this->dataPtr->mainWin)
    return false;

  return this->dataPtr->mainWin->ApplyConfig(this->dataPtr->windowConfig);
}

/////////////////////////////////////////////////
bool Application::AddPluginsToWindow()
{
  if (!this->dataPtr->mainWin || !this->dataPtr->mainWin->QuickWindow())
    return false;

  // Get main window background item
  auto bgItem = this->dataPtr->mainWin->QuickWindow()
      ->findChild<QQuickItem *>("background");
  if (!this->dataPtr->pluginsToAdd.empty() && !bgItem)
  {
    gzerr << "Null background QQuickItem!" << std::endl;
    return false;
  }

  // Create a widget for each plugin
  while (!this->dataPtr->pluginsToAdd.empty())
  {
    auto plugin = this->dataPtr->pluginsToAdd.front();

    this->dataPtr->pluginsAdded.push_back(plugin);
    this->dataPtr->pluginsToAdd.pop();

    if (plugin->DeleteLaterRequested())
    {
      this->RemovePlugin(plugin);
      continue;
    }

    auto cardItem = plugin->CardItem();
    if (!cardItem)
      continue;

    // Add split item
    QVariant splitName;
    QMetaObject::invokeMethod(bgItem, "addSplitItem",
        Q_RETURN_ARG(QVariant, splitName));

    auto splitItem = bgItem->findChild<QQuickItem *>(
        splitName.toString());
    if (!splitItem)
    {
      gzerr << "Internal error: failed to create split ["
             << splitName.toString().toStdString() << "]" << std::endl;
      return false;
    }

    // Add card to main window
    cardItem->setParentItem(splitItem);
    cardItem->setParent(this->dataPtr->engine);
    plugin->setParent(this->dataPtr->mainWin);

    // Apply anchors and state changes now that it's attached to window
    plugin->PostParentChanges();

    // Signals
    this->dataPtr->mainWin->connect(cardItem, SIGNAL(close()),
        this, SLOT(OnPluginClose()));

    gzmsg << "Added plugin [" << plugin->Title() << "] to main window" <<
        std::endl;
  }

  this->dataPtr->mainWin->SetPluginCount(this->dataPtr->pluginsAdded.size());

  return true;
}

/////////////////////////////////////////////////
bool Application::InitializeDialogs()
{
  gzdbg << "Initialize dialogs" << std::endl;

  while (!this->dataPtr->pluginsToAdd.empty())
  {
    auto plugin = this->dataPtr->pluginsToAdd.front();
    this->dataPtr->pluginsToAdd.pop();

    // Create card
    auto cardItem = plugin->CardItem();
    if (!cardItem)
      continue;

    // Create dialog
    auto dialog = new Dialog();
    if (!dialog || !dialog->QuickWindow())
      continue;

    this->dataPtr->dialogs.push_back(dialog);

    // Configure card
    cardItem->setProperty("standalone", true);

    // Configure dialog
    auto cardWidth = cardItem->property("width").toInt();
    auto cardHeight = cardItem->property("height").toInt();
    dialog->QuickWindow()->setProperty("minimumWidth", cardWidth);
    dialog->QuickWindow()->setProperty("minimumHeight", cardHeight);

    cardItem->setParentItem(dialog->RootItem());

    // Signals
    this->dataPtr->mainWin->connect(cardItem, SIGNAL(close()),
        this, SLOT(OnPluginClose()));

    this->dataPtr->pluginsAdded.push_back(plugin);

    auto title = QString::fromStdString(plugin->Title());
    gzdbg << "Initialized dialog [" << title.toStdString() << "]" << std::endl;
  }

  if (this->dataPtr->pluginsAdded.empty())
    return false;

  return true;
}

/////////////////////////////////////////////////
void Application::SetPluginPathEnv(const std::string &_env)
{
  this->dataPtr->pluginPathEnv = _env;
}

/////////////////////////////////////////////////
void Application::AddPluginPath(const std::string &_path)
{
  this->dataPtr->pluginPaths.push_back(_path);
}

/////////////////////////////////////////////////
std::vector<std::pair<std::string, std::vector<std::string>>>
    Application::PluginList()
{
  // 1. Paths from env variable
  auto paths = common::SystemPaths::PathsFromEnv(this->dataPtr->pluginPathEnv);

  // 1.5 Paths from deprecated env variable
  auto pathsDeprecated =
      common::SystemPaths::PathsFromEnv(this->dataPtr->pluginPathEnvDeprecated);

  for (auto const &path : pathsDeprecated)
    paths.push_back(path);

  // 2. Paths added by calling addPluginPath
  for (auto const &path : this->dataPtr->pluginPaths)
    paths.push_back(path);

  // 3. ~/.gz/gui/plugins
  std::string home;
  common::env(GZ_HOMEDIR, home);
  paths.push_back(home + "/.gz/gui/plugins");

  // 4. Install path
  paths.push_back(GZ_GUI_PLUGIN_INSTALL_DIR);

  // Populate map
  std::vector<std::pair<std::string, std::vector<std::string>>> plugins;

  for (auto const &path : paths)
  {
    std::vector<std::string> ps;

    common::DirIter endIter;
    for (common::DirIter dirIter(path);
        dirIter != endIter; ++dirIter)
    {
      auto plugin = common::basename(*dirIter);

      // All we verify is that the file starts with "lib", any further
      // checks would require loading the plugin.

      if (plugin.find("lib") == 0)
        ps.push_back(plugin);
    }

    plugins.push_back(std::make_pair(path, ps));
  }

  return plugins;
}

/////////////////////////////////////////////////
void Application::OnPluginClose()
{
  auto pluginName = this->sender()->objectName();
  this->RemovePlugin(pluginName.toStdString());
}

/////////////////////////////////////////////////
void Application::RemovePlugin(std::shared_ptr<Plugin> _plugin)
{
  this->dataPtr->pluginsAdded.erase(std::remove(
      this->dataPtr->pluginsAdded.begin(),
      this->dataPtr->pluginsAdded.end(), _plugin),
      this->dataPtr->pluginsAdded.end());

  auto pluginCount = this->dataPtr->pluginsAdded.size();

  // Update main window count
  if (this->dataPtr->mainWin)
  {
    this->dataPtr->mainWin->SetPluginCount(pluginCount);
  }
  // Or close app if it's the last dialog
  else if (pluginCount == 0)
  {
    this->exit();
  }
}

//////////////////////////////////////////////////
void ApplicationPrivate::MessageHandler(QtMsgType _type,
    const QMessageLogContext &_context, const QString &_msg)
{
  std::string msg = "[QT] " + _msg.toStdString();
  if (_context.function)
    msg += std::string("(") + _context.function + ")";

  switch (_type)
  {
    case QtDebugMsg:
      gzdbg << msg << std::endl;
      break;
    case QtInfoMsg:
      gzmsg << msg << std::endl;
      break;
    case QtWarningMsg:
      gzwarn << msg << std::endl;
      break;
    case QtFatalMsg:
    case QtCriticalMsg:
      gzerr << msg << std::endl;
      break;
    default:
      gzwarn << "Unknown QT Message type[" << _type << "]: "
        << msg << std::endl;
      break;
  }
}