load_errors_dlg.cpp

Go to the documentation of this file.

/**************************************************************************
 *   Copyright (C) 2022 Alec Leamas                                        *
 *                                                                         *
 *   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, see <https://www.gnu.org/licenses/>. *
 **************************************************************************/
 
#include <memory>
#include <sstream>
#include <string>
#include <vector>
 
#include <wx/event.h>
#include <wx/window.h>
 
#include "observable/event.h"
 
#include "model/plugin_handler.h"
#include "model/plugin_loader.h"
 
#include "gui_lib.h"
#include "load_errors_dlg.h"
 
#ifdef __ANDROID__
#include "androidUTIL.h"
#endif
 
wxDEFINE_EVENT(EVT_LOAD_COMPLETE, ObservedEvt);
 
static const char* const kBadPluginsIntro = _(R"(
The following  plugins have encountered errors during startup:
 
)");
 
static const char* const kBadPluginIntro = _(R"(
The following plugin has encountered errors during startup:
 
)");
 
static const char* const kBadLibsIntro = _(R"(
The following libraries  have encountered errors during startup:
 
)");
 
static const char* const kBadLibIntro = _(R"(
The following library has encountered errors during startup:
 
)");
static const char* const kBadPluginsFooter = _(R"(
 
These plugins will be uninstalled. You might want to reinstall
them after updating the catalog.
)");
 
static const char* const kBadPluginFooter = _(R"(
 
This plugin will be uninstalled. You might want to reinstall
it after updating the catalog.
)");
 
static const char* const kBadLibsFooter = _(R"(
 
These libraries will be removed. You might want to reinstall their
associated plugin after updating the catalog.)");
 
static const char* const kBadLibFooter = _(R"(
 
The library will be removed. You might want to reinstall it's
associated plugin after updating the catalog.)");
 
class LoadErrorsDlg : public OCPNMessageDialog {
public:
  class FormatCtx {
  public:
    std::vector<std::string> plugins;
    std::vector<std::string> libs;
 
    FormatCtx(const std::vector<LoadError> errors) {
      auto handler = PluginHandler::GetInstance();
      for (const auto& e : errors) {
        auto plugin = handler->GetPluginByLibrary(e.lib_path);
        if (plugin != "") plugins.push_back(plugin);
        if (e.lib_path != "") libs.push_back(e.lib_path);
      }
    }
  };
 
  LoadErrorsDlg(wxWindow* parent, const FormatCtx& format_ctx)
      : OCPNMessageDialog(parent, wxString(FormatMsg(format_ctx))) {}
 
  std::string FormatMsg(const FormatCtx& ctx) {
    auto handler = PluginHandler::GetInstance();
    std::stringstream ss;
    if (ctx.plugins.size() > 0) {
      ss << (ctx.plugins.size() == 1 ? kBadPluginIntro : kBadPluginsIntro);
      for (const auto& p : ctx.plugins) {
        ss << "    " << p << "\n";
      }
      ss << (ctx.plugins.size() == 1 ? kBadPluginFooter : kBadPluginsFooter);
    }
    if (ctx.libs.size() > 0) {
      ss << (ctx.libs.size() == 1 ? kBadLibIntro : kBadLibsIntro);
      for (const auto& lib : ctx.libs) {
        ss << "    " << lib << "\n";
      }
      ss << (ctx.libs.size() == 1 ? kBadLibFooter : kBadLibsFooter);
    }
    return ss.str();
  }
};
 
static void Run(wxWindow* parent, const std::vector<LoadError>& errors) {
  LoadErrorsDlg::FormatCtx format_ctx(errors);
  LoadErrorsDlg dlg(parent, format_ctx);
 
#ifdef __ANDROID__
  std::string ss = dlg.FormatMsg(format_ctx);
  androidShowSimpleOKDialog("Error", ss);
  int sts = wxID_YES;
#else
  int sts = dlg.ShowModal();
#endif
  if (sts == wxID_YES || sts == wxID_OK) {
    for (const auto& plugin : format_ctx.plugins) {
      PluginHandler::GetInstance()->Uninstall(plugin);
    }
    for (const auto& lib : format_ctx.libs) {
      if (isRegularFile(lib.c_str())) remove(lib.c_str());
    }
  }
}
 
LoadErrorsDlgCtrl::LoadErrorsDlgCtrl(wxWindow* parent) : m_parent(parent) {
  auto loader = PluginLoader::GetInstance();
 
  load_complete_listener.Listen(loader->evt_plugin_loadall_finalize, this,
                                EVT_LOAD_COMPLETE);
  Bind(EVT_LOAD_COMPLETE, [&](ObservedEvt& ev) {
    auto errors = obs::UnpackEvtPointer<std::vector<LoadError>>(ev);
    if (errors->size() != 0) Run(m_parent, *errors);
  });
}