about.cpp

Go to the documentation of this file.

/**************************************************************************
 *   Copyright (C) 2010-2023 by David S. Register                          *
 *                                                                         *
 *   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 <fstream>
#include <sstream>
 
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
 
#include <wx/clipbrd.h>
#include <wx/ffile.h>
#include <wx/html/htmlwin.h>
#include <wx/textfile.h>
#include <wx/tokenzr.h>
 
#include "config.h"
 
#include "model/base_platform.h"
 
#include "about.h"
#include "chcanv.h"
#include "font_mgr.h"
#include "gui_lib.h"
#include "navutil.h"
#include "ocpn_platform.h"
#include "std_filesystem.h"
#include "styles.h"
 
#ifdef __ANDROID__
#include "androidUTIL.h"
#endif
 
#define xID_OK 10009
 
About* g_pAboutDlgLegacy;
AboutFrameImpl* g_pAboutDlg;
 
static wxString OpenCPNVersion("\n      Version ");
 
// clang-format off
 
static const wxString AboutText =
    "<br>OpenCPN<br>"
    "(c) 2000-2024  The OpenCPN Authors<br><br>";
 
static const wxString OpenCPNInfo =
    "<br><br>"
    "OpenCPN is a Free Software project, built by sailors. "
    "It is freely available to download and distribute "
    "without charge at opencpn.org.<br><br>"
    "If you use OpenCPN, please consider contributing "
    "or donating funds to the project.<br><br>"
    "For more information, visit http://opencpn.org<br><br>";
 
static const wxString OpenCPNInfoAlt =
    "<br><br>"
    "OpenCPN is a Free Software project, built by sailors."
    "The complete source code and many other resources "
    "are freely available for your download and use, "
    "subject to applicable License agreements."
    "<br><br>"
    "For more information, visit http://opencpn.org<br><br>";
 
// clang-format on
 
BEGIN_EVENT_TABLE(About, wxDialog)
EVT_BUTTON(xID_OK, About::OnXidOkClick)
EVT_BUTTON(ID_DONATE, About::OnDonateClick)
EVT_BUTTON(ID_COPYINI, About::OnCopyClick)
EVT_BUTTON(ID_COPYLOG, About::OnCopyClick)
EVT_CLOSE(About::OnClose)
END_EVENT_TABLE()
 
About::About()
    : m_DataLocn(wxEmptyString), m_parent(NULL), m_btips_loaded(FALSE) {
  pAboutHTMLCtl = NULL;
  pLicenseHTMLCtl = NULL;
  pAuthorHTMLCtl = NULL;
  m_blicensePageSet = false;
}
 
About::About(wxWindow* parent, wxString Data_Locn,
             std::function<void()> launch_local_help, wxWindowID id,
             const wxString& caption, const wxPoint& pos, const wxSize& size,
             long style)
    : m_DataLocn(Data_Locn),
      m_parent(parent),
      m_launch_local_help(launch_local_help),
      m_btips_loaded(FALSE) {
  pAboutHTMLCtl = NULL;
  pLicenseHTMLCtl = NULL;
  pAuthorHTMLCtl = NULL;
  m_blicensePageSet = false;
 
  if (strlen(DEBIAN_PPA_VERSION))
    OpenCPNVersion += wxString(DEBIAN_PPA_VERSION);
  else
    OpenCPNVersion += wxString(PACKAGE_VERSION);
 
  Create(parent, id, caption, pos, size, style);
}
 
bool About::Create(wxWindow* parent, wxWindowID id, const wxString& caption,
                   const wxPoint& pos, const wxSize& size, long style) {
  m_parent = parent;
#ifdef __WXOSX__
  style |= wxSTAY_ON_TOP;
#endif
 
  SetExtraStyle(GetExtraStyle() | wxWS_EX_BLOCK_EVENTS);
  wxDialog::Create(parent, id, caption, pos, size, style);
  wxFont* qFont = GetOCPNScaledFont(_("Dialog"));
  SetFont(*qFont);
 
  m_displaySize = g_BasePlatform->getDisplaySize();
  CreateControls();
  Populate();
 
  RecalculateSize();
 
  return TRUE;
}
 
void About::SetColorScheme() {
  DimeControl(this);
  wxColor bg = GetBackgroundColour();
  if (pAboutHTMLCtl) pAboutHTMLCtl->SetBackgroundColour(bg);
  if (pLicenseHTMLCtl) pLicenseHTMLCtl->SetBackgroundColour(bg);
  if (pAuthorHTMLCtl) pAuthorHTMLCtl->SetBackgroundColour(bg);
 
  // This looks like non-sense, but is needed for __WXGTK__
  // to get colours to propagate down the control's family tree.
  SetBackgroundColour(bg);
 
#ifdef __WXQT__
  // wxQT has some trouble clearing the background of HTML window...
  wxBitmap tbm(GetSize().x, GetSize().y, -1);
  wxMemoryDC tdc(tbm);
  tdc.SetBackground(bg);
  tdc.Clear();
  if (pAboutHTMLCtl) pAboutHTMLCtl->SetBackgroundImage(tbm);
  if (pLicenseHTMLCtl) pLicenseHTMLCtl->SetBackgroundImage(tbm);
  if (pAuthorHTMLCtl) pAuthorHTMLCtl->SetBackgroundImage(tbm);
#endif
}
 
void About::Populate() {
  wxColor bg = GetBackgroundColour();
  wxColor fg = wxColour(0, 0, 0);
 
  // The HTML Header
  wxString aboutText = wxString::Format(
      "<html><body bgcolor=#%02x%02x%02x><font color=#%02x%02x%02x>", bg.Red(),
      bg.Blue(), bg.Green(), fg.Red(), fg.Blue(), fg.Green());
 
  wxFont* dFont = FontMgr::Get().GetFont(_("Dialog"));
 
  // Do weird font size calculation
  int points = dFont->GetPointSize();
#ifndef __WXOSX__
  ++points;
#endif
  int sizes[7];
  for (int i = -2; i < 5; i++) {
    sizes[i + 2] = points + i + (i > 0 ? i : 0);
  }
  wxString face = dFont->GetFaceName();
  pAboutHTMLCtl->SetFonts(face, face, sizes);
 
  if (wxFONTSTYLE_ITALIC == dFont->GetStyle()) aboutText.Append("<i>");
 
#ifdef __ANDROID__
  wxString msg;
  msg.Printf(" [%d]", androidGetVersionCode());
  wxString OpenCPNVersionAndroid =
      "OpenCPN for Android Version " + androidGetVersionName() + msg;
 
  aboutText.Append(AboutText + OpenCPNVersionAndroid + OpenCPNInfoAlt);
#else
  aboutText.Append(AboutText + OpenCPNVersion + OpenCPNInfo);
#endif
 
  // Show where the log file is going to be placed
  wxString log_string = "Logfile location: " + g_BasePlatform->GetLogFileName();
  log_string.Replace("/", "/ ");  // allow line breaks, in a cheap way...
 
  aboutText.Append(log_string);
 
  // Show where the config file is going to be placed
  wxString config_string =
      "<br><br>Config file location: " + g_BasePlatform->GetConfigFileName();
  config_string.Replace("/", "/ ");  // allow line breaks, in a cheap way...
  aboutText.Append(config_string);
 
  if (wxFONTSTYLE_ITALIC == dFont->GetStyle()) aboutText.Append("</i>");
 
  // The HTML Footer
  aboutText.Append("</font></body></html>");
 
  pAboutHTMLCtl->SetPage(aboutText);
 
  // The HTML Header
  //
  fs::path data_path(g_BasePlatform->GetSharedDataDir().ToStdString());
  std::ifstream istream(data_path / "Authors.html");
  std::stringstream ss;
  ss << istream.rdbuf();
  pAuthorHTMLCtl->SetPage(ss.str());
 
  // Deferred....
#if 0
    // The HTML Header
    wxString licenseText =
    wxString::Format(
        "<html><body bgcolor=#%02x%02x%02x><font color=#%02x%02x%02x>",
            bg.Red(), bg.Blue(), bg.Green(), fg.Red(), fg.Blue(), fg.Green() );
 
    pLicenseHTMLCtl->SetFonts( face, face, sizes );
 
    wxTextFile license_filea( m_DataLocn + "license.txt" );
    if ( license_filea.Open() ) {
        for ( wxString str = license_filea.GetFirstLine(); !license_filea.Eof() ; str = license_filea.GetNextLine() )
            licenseText.Append( str + "<br>" );
        license_filea.Close();
    } else {
        wxLogMessage( "Could not open License file: " + m_DataLocn );
    }
 
    wxString suppLicense = g_Platform->GetSupplementalLicenseString();
 
    wxStringTokenizer st(suppLicense, "\n", wxTOKEN_DEFAULT);
    while( st.HasMoreTokens() )
    {
        wxString s1 = st.GetNextToken();
        licenseText.Append( s1 + "<br>" );
    }
 
        // The HTML Footer
    licenseText.Append( "</font></body></html>" );
 
    pLicenseHTMLCtl->SetPage( licenseText );
#endif
 
  SetColorScheme();
}
 
void About::RecalculateSize() {
  //  Make an estimate of the dialog size, without scrollbars showing
 
  wxSize esize;
  esize.x = GetCharWidth() * 110;
  esize.y = GetCharHeight() * 44;
 
  wxSize dsize = GetParent()->GetSize();
  esize.y = wxMin(esize.y, dsize.y - (0 * GetCharHeight()));
  esize.x = wxMin(esize.x, dsize.x - (0 * GetCharHeight()));
  SetClientSize(esize);
 
  wxSize fsize = GetSize();
  fsize.y = wxMin(fsize.y, dsize.y - (0 * GetCharHeight()));
  fsize.x = wxMin(fsize.x, dsize.x - (0 * GetCharHeight()));
 
  SetSize(fsize);
 
  Centre();
}
 
void About::CreateControls() {
  //  Set the nominal vertical size of the embedded controls
 
  wxBoxSizer* mainSizer = new wxBoxSizer(wxVERTICAL);
  SetSizer(mainSizer);
  wxStaticText* pST1 =
      new wxStaticText(this, -1, _("The Open Source Chart Plotter/Navigator"),
                       wxDefaultPosition, wxSize(-1, 50 /* 500, 30 */),
                       wxALIGN_CENTRE /* | wxALIGN_CENTER_VERTICAL */);
 
  wxFont* qFont = GetOCPNScaledFont(_("Dialog"));
 
  wxFont* headerFont = FontMgr::Get().FindOrCreateFont(
      14, wxFONTFAMILY_DEFAULT, qFont->GetStyle(), wxFONTWEIGHT_BOLD, false,
      qFont->GetFaceName());
  pST1->SetFont(*headerFont);
  mainSizer->Add(pST1, 0, wxALL | wxEXPAND, 8);
 
  bool orient = m_displaySize.x < m_displaySize.y;
#ifndef __ANDROID__
  wxBoxSizer* buttonSizer = new wxBoxSizer(orient ? wxVERTICAL : wxHORIZONTAL);
  mainSizer->Add(buttonSizer, 0, wxALL, 0);
 
  wxButton* donateButton = new wxBitmapButton(
      this, ID_DONATE, g_StyleManager->GetCurrentStyle()->GetIcon("donate"),
      wxDefaultPosition, wxDefaultSize, 0);
 
  buttonSizer->Add(
      new wxButton(this, ID_COPYLOG, _("Copy Log File to Clipboard")), 1,
      wxALL | wxEXPAND, 3);
  buttonSizer->Add(
      new wxButton(this, ID_COPYINI, _("Copy Settings File to Clipboard")), 1,
      wxALL | wxEXPAND, 3);
  buttonSizer->Add(
      donateButton, 1,
      wxALL |
          (buttonSizer->GetOrientation() == wxHORIZONTAL ? wxALIGN_RIGHT : 0),
      3);
#endif
 
  //  Main Notebook
  pNotebook = new wxNotebook(this, ID_NOTEBOOK_HELP, wxDefaultPosition,
                             wxSize(-1, -1), wxNB_TOP);
 
  pNotebook->Connect(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
                     wxNotebookEventHandler(About::OnNBPageChange), NULL, this);
 
  pNotebook->InheritAttributes();
  mainSizer->Add(pNotebook, 1,
                 (orient ? wxALIGN_CENTER_VERTICAL : 0) | wxEXPAND | wxALL, 5);
 
  //  About Panel
  itemPanelAbout = new wxPanel(pNotebook, -1, wxDefaultPosition, wxDefaultSize,
                               wxSUNKEN_BORDER | wxTAB_TRAVERSAL);
  itemPanelAbout->InheritAttributes();
  pNotebook->AddPage(itemPanelAbout, _("About"), TRUE /* Default page */);
 
  pAboutHTMLCtl =
      new wxHtmlWindow(itemPanelAbout, wxID_ANY, wxDefaultPosition,
                       wxDefaultSize, wxHW_SCROLLBAR_AUTO | wxHW_NO_SELECTION);
  pAboutHTMLCtl->SetBorders(5);
  wxBoxSizer* aboutSizer = new wxBoxSizer(wxVERTICAL);
  aboutSizer->Add(pAboutHTMLCtl, 1,
                  wxALIGN_CENTER_HORIZONTAL | wxEXPAND | wxALL, 5);
  itemPanelAbout->SetSizer(aboutSizer);
 
  //  Authors Panel
 
  itemPanelAuthors =
      new wxPanel(pNotebook, -1, wxDefaultPosition, wxDefaultSize,
                  wxSUNKEN_BORDER | wxTAB_TRAVERSAL);
  itemPanelAuthors->InheritAttributes();
  pNotebook->AddPage(itemPanelAuthors, _("Authors"));
 
  pAuthorHTMLCtl =
      new wxHtmlWindow(itemPanelAuthors, wxID_ANY, wxDefaultPosition,
                       wxDefaultSize, wxHW_SCROLLBAR_AUTO | wxHW_NO_SELECTION);
  pAuthorHTMLCtl->SetBorders(5);
  wxBoxSizer* authorSizer = new wxBoxSizer(wxVERTICAL);
  authorSizer->Add(pAuthorHTMLCtl, 1,
                   wxALIGN_CENTER_HORIZONTAL | wxEXPAND | wxALL, 5);
  itemPanelAuthors->SetSizer(authorSizer);
 
  //  License Panel
  itemPanelLicense =
      new wxPanel(pNotebook, -1, wxDefaultPosition, wxDefaultSize,
                  wxSUNKEN_BORDER | wxTAB_TRAVERSAL);
  itemPanelLicense->InheritAttributes();
  pNotebook->AddPage(itemPanelLicense, _("License"));
 
  pLicenseHTMLCtl =
      new wxHtmlWindow(itemPanelLicense, wxID_ANY, wxDefaultPosition,
                       wxDefaultSize, wxHW_SCROLLBAR_AUTO | wxHW_NO_SELECTION);
  pLicenseHTMLCtl->SetBorders(5);
  wxBoxSizer* licenseSizer = new wxBoxSizer(wxVERTICAL);
  licenseSizer->Add(pLicenseHTMLCtl, 1,
                    wxALIGN_CENTER_HORIZONTAL | wxEXPAND | wxALL, 5);
  itemPanelLicense->SetSizer(licenseSizer);
 
  //  Help Panel
  itemPanelTips = new wxPanel(pNotebook, -1, wxDefaultPosition, wxDefaultSize,
                              wxSUNKEN_BORDER | wxTAB_TRAVERSAL);
  itemPanelTips->InheritAttributes();
  pNotebook->AddPage(itemPanelTips, _("Help"));
 
  wxBoxSizer* helpSizer = new wxBoxSizer(wxVERTICAL);
  itemPanelTips->SetSizer(helpSizer);
 
  //  Close Button
  wxButton* closeButton = new wxButton(this, xID_OK, _("Close"),
                                       wxDefaultPosition, wxDefaultSize, 0);
  closeButton->SetDefault();
  closeButton->InheritAttributes();
  mainSizer->Add(closeButton, 0, wxALIGN_RIGHT | wxALL, 5);
}
 
void About::OnNBPageChange(wxNotebookEvent& event) {
  unsigned int i = event.GetSelection();
 
  if (i == 3) {
    m_launch_local_help();
    pNotebook->ChangeSelection(0);
  }
 
  else if ((i == 2) && !m_blicensePageSet) {  // license
 
    wxColor bg = GetBackgroundColour();
    wxColor fg = wxColour(0, 0, 0);
    wxFont* dFont = FontMgr::Get().GetFont(_("Dialog"));
 
    // Do weird font size calculation
    int points = dFont->GetPointSize();
#ifndef __WXOSX__
    ++points;
#endif
    int sizes[7];
    for (int j = -2; j < 5; j++) {
      sizes[j + 2] = points + j + (j > 0 ? j : 0);
    }
    wxString face = dFont->GetFaceName();
 
    g_BasePlatform->ShowBusySpinner();
 
    // The HTML Header
    wxString licenseText = wxString::Format(
        "<html><body bgcolor=#%02x%02x%02x><font color=#%02x%02x%02x>",
        bg.Red(), bg.Blue(), bg.Green(), fg.Red(), fg.Blue(), fg.Green());
 
    pLicenseHTMLCtl->SetFonts(face, face, sizes);
 
    wxTextFile license_filea(m_DataLocn + "license.txt");
    if (license_filea.Open()) {
      for (wxString str = license_filea.GetFirstLine(); !license_filea.Eof();
           str = license_filea.GetNextLine())
        licenseText.Append(str + "<br>");
      license_filea.Close();
    } else {
      wxLogMessage("Could not open License file: " + m_DataLocn);
    }
 
    wxString suppLicense = g_BasePlatform->GetSupplementalLicenseString();
 
    wxStringTokenizer st(suppLicense, "\n", wxTOKEN_DEFAULT);
    while (st.HasMoreTokens()) {
      wxString s1 = st.GetNextToken();
      licenseText.Append(s1 + "<br>");
    }
 
    // The HTML Footer
    licenseText.Append("</font></body></html>");
 
    pLicenseHTMLCtl->SetPage(licenseText);
 
    g_BasePlatform->HideBusySpinner();
 
    SetColorScheme();
    m_blicensePageSet = true;
  }
}
 
void About::OnXidOkClick(wxCommandEvent& event) { Close(); }
 
void About::OnClose(wxCloseEvent& event) {
#ifdef __WXGTK__
  wxTheApp->GetTopWindow()->Raise();
#endif
  Destroy();
  g_pAboutDlgLegacy = NULL;
}
 
void About::OnDonateClick(wxCommandEvent& event) {
  wxLaunchDefaultBrowser(
      "https://sourceforge.net/donate/index.php?group_id=180842");
}
 
void About::OnCopyClick(wxCommandEvent& event) {
  wxString filename = event.GetId() == ID_COPYLOG
                          ? g_BasePlatform->GetLogFileName()
                          : g_BasePlatform->GetConfigFileName();
 
  wxFFile file(filename);
 
  if (!file.IsOpened()) {
    wxLogMessage("Failed to open file for Copy to Clipboard.");
    return;
  }
 
  wxString fileContent;
  char buf[1024];
  while (!file.Eof()) {
    int c = file.Read(&buf, 1024);
    if (c) fileContent += wxString(buf, wxConvUTF8, c);
  }
 
  file.Close();
  int length = fileContent.Length();
 
  if (event.GetId() == ID_COPYLOG) {
    wxString lastLogs = fileContent;
    int pos = lastLogs.Find("________");
    while (pos != wxNOT_FOUND && lastLogs.Length() > 65000) {
      lastLogs = lastLogs.Right(lastLogs.Length() - pos - 8);
      pos = lastLogs.Find("________");
    }
    fileContent = lastLogs;
  }
 
  ::wxBeginBusyCursor();
  if (wxTheClipboard->Open()) {
    if (!wxTheClipboard->SetData(new wxTextDataObject(fileContent)))
      wxLogMessage("wxTheClipboard->Open() failed.");
    wxTheClipboard->Close();
  } else {
    wxLogMessage("wxTheClipboard->Open() failed.");
  }
  ::wxEndBusyCursor();
}