download_mgr.cpp

/******************************************************************************
 *
 * Project:  OpenCPN
 *
 ***************************************************************************
 *   Copyright (C) 2019 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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 ***************************************************************************
 */
 
#include "config.h"
 
#include <fstream>
#include <set>
#include <sstream>
 
#include <wx/bitmap.h>
#include <wx/button.h>
#include <wx/debug.h>
#include <wx/file.h>
#include <wx/image.h>
#include <wx/log.h>
#include <wx/panel.h>
#include <wx/progdlg.h>
#include <wx/sizer.h>
#include <wx/statline.h>
#include <wx/uri.h>
 
#include "catalog_mgr.h"
#include "download_mgr.h"
#include "downloader.h"
#include "OCPNPlatform.h"
#include "picosha2.h"
#include "plugin_handler.h"
#include "plugin_cache.h"
#include "pluginmanager.h"
#include "semantic_vers.h"
#include "styles.h"
#include "svg_utils.h"
 
extern PlugInManager* g_pi_manager;
extern ocpnStyle::StyleManager* g_StyleManager;
extern OCPNPlatform* g_Platform;
 
#undef major  // walk around gnu's major() and minor() macros.
#undef minor
 
// Main window reload event
wxDEFINE_EVENT(EVT_PLUGINS_RELOAD, wxCommandEvent);
 
namespace download_mgr {
 
static bool checksum_ok(const std::string& path,
                        const PluginMetadata& metadata) {
  wxLogDebug("Checksum test on %s", metadata.name.c_str());
  if (metadata.checksum == "") {
    wxLogDebug("No metadata checksum, aborting check,");
    return true;
  }
  const size_t pos = metadata.checksum.find(':');
  std::string checksum(metadata.checksum);
  if (pos == std::string::npos) {
    checksum = std::string("sha256:") + checksum;
  }
  std::ifstream f(path, std::ios::binary);
  picosha2::hash256_one_by_one hasher;
  while (!f.eof()) {
    char buff[2048];
    f.read(buff, sizeof(buff));
    const std::string block(buff, f.gcount());
    hasher.process(block.begin(), block.end());
  }
  hasher.finish();
  std::string tarball_hash =
      std::string("sha256:") + picosha2::get_hash_hex_string(hasher);
 
  if (tarball_hash == checksum) {
    wxLogDebug("Checksum ok: %s", tarball_hash.c_str());
    return true;
  }
  wxLogMessage("Checksum fail on %s, tarball: %s, metadata: %s",
               metadata.name.c_str(), tarball_hash.c_str(), checksum.c_str());
  return false;
}
 
static ssize_t PlugInIxByName(const std::string name, ArrayOfPlugIns* plugins) {
  for (unsigned i = 0; i < plugins->GetCount(); i += 1) {
    if (name == plugins->Item(i)->m_common_name.Lower().ToStdString()) {
      return i;
    }
  }
  return -1;
}
 
static PlugInContainer* PlugInByName(const std::string name,
                                     ArrayOfPlugIns* plugins) {
  auto ix = PlugInIxByName(name, plugins);
  return ix == -1 ? 0 : plugins->Item(ix);
}
 
static void LoadPNGIcon(const char* path, int size, wxBitmap& bitmap) {
  wxPNGHandler handler;
  if (!wxImage::FindHandler(handler.GetName())) {
    wxImage::AddHandler(new wxPNGHandler());
  }
  auto img = new wxImage();
  bool ok = img->LoadFile(path, wxBITMAP_TYPE_PNG);
  if (!ok) {
    bitmap = wxBitmap();
    return;
  }
  img->Rescale(size, size);
  bitmap = wxBitmap(*img);
}
 
class PluginIconPanel : public wxPanel {
public:
  PluginIconPanel(wxWindow* parent, std::string plugin_name)
      : wxPanel(parent), m_plugin_name(plugin_name) {
    auto size = GetClientSize();
    auto minsize = GetTextExtent("OpenCPN");
    SetMinClientSize(wxSize(minsize.GetWidth(), size.GetHeight()));
    Layout();
    Bind(wxEVT_PAINT, &PluginIconPanel::OnPaint, this);
  }
 
  void OnPaint(wxPaintEvent& event) {
    auto size = GetClientSize();
    int minsize = wxMin(size.GetHeight(), size.GetWidth());
    auto offset = minsize / 10;
 
    LoadIcon(m_plugin_name.c_str(), m_bitmap, 2 * minsize / 3);
    wxPaintDC dc(this);
    if (!m_bitmap.IsOk()) {
      wxLogMessage("AddPluginPanel: bitmap is not OK!");
      return;
    }
    dc.DrawBitmap(m_bitmap, offset, offset, true);
  }
 
protected:
  wxBitmap m_bitmap;
  const std::string m_plugin_name;
 
  void LoadIcon(const char* plugin_name, wxBitmap& bitmap, int size = 32) {
    wxFileName path(g_Platform->GetSharedDataDir(), plugin_name);
    path.AppendDir("uidata");
    path.AppendDir("plugins");
    path.SetExt("svg");
    bool ok = false;
    if (path.IsFileReadable()) {
      bitmap = LoadSVG(path.GetFullPath(), size, size);
      ok = bitmap.IsOk();
    }
    if (!ok) {
      path.SetExt("png");
      if (path.IsFileReadable()) {
        LoadPNGIcon(path.GetFullPath(), size, bitmap);
        ok = bitmap.IsOk();
      }
    }
    if (!ok) {
      auto style = g_StyleManager->GetCurrentStyle();
      bitmap = wxBitmap(style->GetIcon(_T("default_pi")));
    }
  }
};
 
class InstallButton : public wxPanel {
public:
  InstallButton(wxWindow* parent, PluginMetadata metadata)
      : wxPanel(parent), m_metadata(metadata), m_remove(false) {
    PlugInContainer* found =
        PlugInByName(metadata.name,
                     PluginLoader::getInstance()->GetPlugInArray());
    std::string label(_("Install"));
    if (found) {
      label = getUpdateLabel(found, metadata);
      m_remove = true;
    }
    auto button = new wxButton(this, wxID_ANY, label);
    auto pluginHandler = PluginHandler::getInstance();
    button->Enable(pluginHandler->isPluginWritable(metadata.name));
    auto box = new wxBoxSizer(wxHORIZONTAL);
    box->Add(button);
    SetSizer(box);
    Bind(wxEVT_COMMAND_BUTTON_CLICKED, &InstallButton::OnClick, this);
  }
 
  void OnClick(wxCommandEvent& event) {
    auto path = ocpn::lookup_tarball(m_metadata.tarball_url.c_str());
    if (m_remove && path != "") {
      wxLogMessage("Uninstalling %s", m_metadata.name.c_str());
      PluginHandler::getInstance()->uninstall(m_metadata.name);
    }
    wxLogMessage("Installing %s", m_metadata.name.c_str());
 
    auto pluginHandler = PluginHandler::getInstance();
    bool cacheResult = pluginHandler->installPluginFromCache(m_metadata);
 
    if (!cacheResult) {
      auto downloader = new GuiDownloader(this, m_metadata);
      downloader->run(this, m_remove);
      auto loader = PluginLoader::getInstance();
      auto pic = PlugInByName(m_metadata.name, loader->GetPlugInArray());
      if (!pic) {
        wxLogMessage("Installation of %s failed", m_metadata.name.c_str());
        return;
      }
      auto upwards = GetParent()->GetParent()->GetParent();
      auto main_window = dynamic_cast<PluginDownloadDialog*>(upwards);
      wxASSERT(main_window != 0);
      auto listPanels = dynamic_cast<PluginListPanel*>(
          main_window->GetRealParent()->GetPrevSibling());
      wxASSERT(listPanels != 0);
      listPanels->ReloadPluginPanels();
      auto window = GetSizer()->GetItem((size_t)0)->GetWindow();
      auto btn = dynamic_cast<wxButton*>(window);
      wxASSERT(btn != 0);
      btn->SetLabel(_("Reinstall"));
    }
  }
 
private:
  PluginMetadata m_metadata;
  bool m_remove;
 
  const char* getUpdateLabel(PlugInContainer* pic, PluginMetadata metadata) {
    SemanticVersion currentVersion(pic->m_version_major, pic->m_version_minor);
    if (pic->m_version_str != "") {
      currentVersion = SemanticVersion::parse(pic->m_version_str.ToStdString());
    }
    auto newVersion = SemanticVersion::parse(metadata.version);
    if (newVersion > currentVersion) {
      return _("Update");
    } else if (newVersion == currentVersion) {
      return _("Reinstall");
    } else {
      return _("Downgrade");
    }
  }
};
 
class CandidateButtonsPanel : public wxPanel {
public:
  CandidateButtonsPanel(wxWindow* parent, const PluginMetadata* plugin)
      : wxPanel(parent) {
    auto flags = wxSizerFlags().Border();
 
    auto vbox = new wxBoxSizer(wxVERTICAL);
    vbox->Add(new InstallButton(this, *plugin),
              flags.DoubleBorder().Top().Right());
    vbox->Add(1, 1, 1, wxEXPAND);  // Expanding, stretchable spacer
    m_info_btn = new WebsiteButton(this, plugin->info_url.c_str());
    m_info_btn->Hide();
    vbox->Add(m_info_btn, flags.DoubleBorder().Bottom().Right());
    SetSizer(vbox);
    Fit();
  }
 
  void HideDetails(bool hide) {
    m_info_btn->Show(!hide);
    GetParent()->Layout();
  }
 
private:
  WebsiteButton* m_info_btn;
};
 
class PluginTextPanel : public wxPanel {
public:
  PluginTextPanel(wxWindow* parent, const PluginMetadata* plugin,
                  CandidateButtonsPanel* buttons, bool bshowTuple = false)
      : wxPanel(parent), m_descr(0), m_buttons(buttons) {
    auto flags = wxSizerFlags().Border();
 
    MORE = "<span foreground=\'blue\'>";
    MORE += _("More");
    MORE += "...</span>";
    LESS = "<span foreground=\'blue\'>";
    LESS += _("Less");
    LESS += "...</span>";
 
    auto sum_hbox = new wxBoxSizer(wxHORIZONTAL);
    m_summary = staticText(plugin->summary);
    sum_hbox->Add(m_summary);
    sum_hbox->AddSpacer(10);
    m_more = staticText("");
    m_more->SetLabelMarkup(MORE);
    sum_hbox->Add(m_more, wxSizerFlags());
 
    auto vbox = new wxBoxSizer(wxVERTICAL);
    wxString nameText(plugin->name + "    " + plugin->version);
    if (bshowTuple) nameText += "   " + plugin->target;
    auto name = staticText(nameText);
    m_descr = staticText(plugin->description);
    m_descr->Hide();
    vbox->Add(name, flags);
    vbox->Add(sum_hbox, flags);
    vbox->Add(m_descr, flags.Expand());
    SetSizer(vbox);
 
    m_more->Bind(wxEVT_LEFT_DOWN, &PluginTextPanel::OnClick, this);
    m_descr->Bind(wxEVT_LEFT_DOWN, &PluginTextPanel::OnClick, this);
  }
 
  void OnClick(wxMouseEvent& event) {
    m_descr->Show(!m_descr->IsShown());
    m_more->SetLabelMarkup(m_descr->IsShown() ? LESS : MORE);
    m_buttons->HideDetails(!m_descr->IsShown());
    GetParent()->SendSizeEvent();
    GetParent()->GetParent()->GetParent()->Layout();
    GetParent()->GetParent()->GetParent()->Refresh(true);
    GetParent()->GetParent()->GetParent()->Update();
  }
 
protected:
  wxString MORE, LESS;
 
  wxStaticText* staticText(const wxString& text) {
    return new wxStaticText(this, wxID_ANY, text, wxDefaultPosition,
                            wxDefaultSize, wxALIGN_LEFT);
  }
 
  wxStaticText* m_descr;
  wxStaticText* m_more;
  wxStaticText* m_summary;
  CandidateButtonsPanel* m_buttons;
};
 
class MainButtonsPanel : public wxPanel {
public:
  MainButtonsPanel(wxWindow* parent, wxWindow* victim)
      : wxPanel(parent, wxID_ANY, wxDefaultPosition, wxSize(200, 32)) {
    auto sizer = new wxBoxSizer(wxHORIZONTAL);
    auto spacing = GetTextExtent("m").GetWidth();
    sizer->Add(1, 1, 1, wxEXPAND);  // Expanding, stretchable space
    sizer->Add(new UpdateCatalogDialogBtn(this), wxSizerFlags());
    sizer->Add(spacing, 0);
    sizer->Add(new UpdateCatalogNowBtn(this), wxSizerFlags());
    sizer->Add(spacing, 0);
    sizer->Add(new wxButton(this, wxID_OK, _("Done")), wxSizerFlags());
    SetSizer(sizer);
  }
 
protected:
  class UpdateCatalogNowBtn : public wxButton {
  public:
    UpdateCatalogNowBtn(wxWindow* parent)
        : wxButton(parent, wxID_ANY, _("Update plugin catalog")) {
      Bind(wxEVT_COMMAND_BUTTON_CLICKED, [=](wxCommandEvent&) {
        new SimpleCatalogDialog(this);
        wxCommandEvent evt(EVT_PLUGINS_RELOAD);
        wxPostEvent(GetParent(), evt);
      });
    }
  };
 
  class UpdateCatalogDialogBtn : public wxButton {
  public:
    UpdateCatalogDialogBtn(wxWindow* parent)
        : wxButton(parent, wxID_ANY, _("Advanced catalog update...")) {
      Bind(wxEVT_COMMAND_BUTTON_CLICKED,
           [=](wxCommandEvent&) { new AdvancedCatalogDialog(this); });
    }
  };
};
 
class OcpnScrolledWindow : public wxScrolledWindow {
public:
  OcpnScrolledWindow(wxWindow* parent)
      : wxScrolledWindow(parent), m_grid(new wxFlexGridSizer(3, 0, 0)) {
    auto box = new wxBoxSizer(wxVERTICAL);
    populateGrid(m_grid);
    box->Add(m_grid, wxSizerFlags().Proportion(1).Expand());
    auto button_panel = new MainButtonsPanel(this, parent);
    box->Add(button_panel, wxSizerFlags().Right().Border().Expand());
    Bind(EVT_PLUGINS_RELOAD, [&](wxCommandEvent& ev) { Reload(); });
 
    SetSizer(box);
    FitInside();
    // TODO: Compute size using wxWindow::GetEffectiveMinSize()
    SetScrollRate(1, 1);
  };
 
  void populateGrid(wxFlexGridSizer* grid) {
    struct metadata_compare {
      bool operator()(const PluginMetadata& lhs,
                      const PluginMetadata& rhs) const {
        return lhs.key() < rhs.key();
      }
    };
 
    auto flags = wxSizerFlags();
    grid->SetCols(3);
    grid->AddGrowableCol(2);
    auto available = PluginHandler::getInstance()->getAvailable();
    std::set<PluginMetadata, metadata_compare> unique_plugins;
    for (auto plugin : PluginHandler::getInstance()->getAvailable()) {
      unique_plugins.insert(plugin);
    }
    for (auto plugin : unique_plugins) {
      if (!PluginHandler::isCompatible(plugin)) {
        continue;
      }
      grid->Add(new PluginIconPanel(this, plugin.name), flags.Expand());
      auto buttons = new CandidateButtonsPanel(this, &plugin);
      grid->Add(new PluginTextPanel(this, &plugin, buttons,
                                    unique_plugins.size() > 1),
                flags.Proportion(1).Right());
      grid->Add(buttons, flags.DoubleBorder());
      grid->Add(new wxStaticLine(this), wxSizerFlags(0).Expand());
      grid->Add(new wxStaticLine(this), wxSizerFlags(0).Expand());
      grid->Add(new wxStaticLine(this), wxSizerFlags(0).Expand());
    }
  }
 
  void Reload() {
    Hide();
    m_grid->Clear();
    populateGrid(m_grid);
    Layout();
    Show();
    FitInside();
    Refresh(true);
  }
 
private:
  wxFlexGridSizer* m_grid;
};
 
}  // namespace download_mgr
 
PluginDownloadDialog::PluginDownloadDialog(wxWindow* parent)
    : wxDialog(parent, wxID_ANY, _("Plugin Manager"), wxDefaultPosition,
               wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER) {
  auto vbox = new wxBoxSizer(wxVERTICAL);
  auto scrwin = new download_mgr::OcpnScrolledWindow(this);
  vbox->Add(scrwin, wxSizerFlags(1).Expand());
 
  // The list has no natural height. Allocate 20 lines of text so some
  // items are displayed initially in Layout()
  int min_height = GetTextExtent("abcdefghijklmnopqrst").GetHeight() * 20;
 
  // There seem to be no way have dynamic, wrapping text:
  // https://forums.wxwidgets.org/viewtopic.php?f=1&t=46662
  int width = GetParent()->GetClientSize().GetWidth();
  SetMinClientSize(wxSize(width, min_height));
 
  SetSizer(vbox);
  Fit();
  Layout();
}
 
GuiDownloader::GuiDownloader(wxWindow* parent, PluginMetadata plugin)
    : Downloader(plugin.tarball_url),
      m_downloaded(0),
      m_dialog(0),
      m_plugin(plugin),
      m_parent(parent) {}
 
std::string GuiDownloader::run(wxWindow* parent, bool remove_current) {
  bool ok;
  bool downloaded = false;
  std::string path = ocpn::lookup_tarball(m_plugin.tarball_url.c_str());
  if (!path.size()) {
    long size = get_filesize();
    std::string label(_("Downloading "));
    label += url;
    m_dialog =
        new wxProgressDialog(_("Downloading"), label.c_str(), size, parent,
                             wxPD_AUTO_HIDE | wxPD_APP_MODAL | wxPD_CAN_ABORT);
#ifdef __OCPN__ANDROID__
    m_dialog->SetBackgroundColour(wxColour(0x7c, 0xb0, 0xe9));  // light blue
#endif
 
    ok = download(path);
    g_Platform->HideBusySpinner();
 
    if (!ok) {
      delete m_dialog;
      showErrorDialog("Download error");
      return "";
    }
 
    // Download aborted?
    if (m_dialog == 0) {
      showErrorDialog("Download aborted");
      return "";
    } else {
      delete m_dialog;
    }
 
    if (!download_mgr::checksum_ok(path, m_plugin)) {
      showErrorDialog("Checksum error");
      return "";
    }
 
    m_dialog = 0;  // make sure that on_chunk() doesn't misbehave.
    downloaded = true;
  }
 
  auto pluginHandler = PluginHandler::getInstance();
  if (remove_current) {
    wxLogMessage("Uninstalling %s", m_plugin.name.c_str());
    pluginHandler->uninstall(m_plugin.name);
  }
  ok = pluginHandler->installPlugin(m_plugin, path);
  if (!ok) {
    showErrorDialog("Installation error");
    return "";
  }
 
  if (downloaded) {
    // Cache the tarball from the tmp location to the plugin cache.
    wxURI uri(wxString(m_plugin.tarball_url.c_str()));
    wxFileName fn(uri.GetPath());
    auto basename = fn.GetFullName().ToStdString();
    if (ocpn::store_tarball(path.c_str(), basename.c_str())) {
      wxLogMessage("Copied %s to local cache at %s", path.c_str(),
                   basename.c_str());
    }
  }
 
  wxMessageDialog* dlg = new wxMessageDialog(
      m_parent,
      m_plugin.name + " " + m_plugin.version + _(" successfully installed"),
      _("Installation complete"), wxOK | wxCENTRE | wxICON_INFORMATION);
  dlg->ShowModal();
  return path;
}
 
void GuiDownloader::on_chunk(const char* buff, unsigned bytes) {
  Downloader::on_chunk(buff, bytes);
  m_downloaded += bytes;
  if (m_dialog && !m_dialog->Update(m_downloaded)) {
    // User pushed Cancel button
    delete m_dialog;
    m_dialog = 0;
  }
}
 
void GuiDownloader::showErrorDialog(const char* msg) {
  auto dlg = new wxMessageDialog(m_parent, "", _("Installation error"),
                                 wxOK | wxICON_ERROR);
  auto last_error_msg = last_error();
  std::string text = msg;
  if (last_error_msg != "") {
    text = text + ": " + error_msg;
  }
  text = text + "\nPlease check system log for more info.";
  dlg->SetMessage(text);
  dlg->ShowModal();
  dlg->Destroy();
}