catalog_handler.h

Go to the documentation of this file.

/**************************************************************************
 *   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, see <https://www.gnu.org/licenses/>. *
 **************************************************************************/
 
#ifndef CATALOG_HANDLER_H__
#define CATALOG_HANDLER_H__
 
#include <string>
#include <memory>
#include <ostream>
#include <vector>
 
#include "model/catalog_parser.h"
 
class CatalogHandler {
public:
  enum class ServerStatus {
    UNKNOWN,
    OK,
    OK_MSG,
    CURL_ERROR,
    JSON_ERROR,
    XML_ERROR,
    OS_ERROR,
    FILE_ERROR
  };
 
  static CatalogHandler* GetInstance();
 
  ServerStatus LoadChannels(std::ostream* json);
 
  ServerStatus LoadChannels(const std::string& json);
 
  std::vector<std::string> GetChannels();
 
  bool SetActiveChannel(const char* channel);
 
  std::string GetActiveChannel();
 
  void SetCustomUrl(const char* url);
 
  std::string GetCustomUrl();
 
  std::string GetDefaultUrl();
 
  ServerStatus DownloadCatalog(std::ostream* stream);
 
  ServerStatus DownloadCatalog(std::string& path);
 
  ServerStatus DownloadCatalog(std::ostream* stream, std::string url);
 
  ServerStatus DownloadCatalog(std::string& filePath, std::string url);
 
  ServerStatus ParseCatalog(const std::string xml, bool latest = false);
 
  CatalogData DefaultCatalogData();
 
  CatalogData UserCatalogData();
 
  CatalogData LatestCatalogData();
 
  void ClearCatalogData();
 
  CatalogCtx* GetActiveCatalogContext();
 
  ServerStatus GetCatalogStatus();
 
  bool AddMetadataToActiveContext(PluginMetadata metadata);
 
  std::string LastErrorMsg();
 
  ServerStatus DoParseCatalog(const std::string xml, CatalogCtx* ctx);
 
protected:
  CatalogHandler();
 
  void LoadCatalogData(const std::string& path, CatalogData& data);
 
  const char* const GET_BRANCHES_PATH = "/repos/OpenCPN/plugins/branches";
  const char* const GITHUB_API = "https://api.github.com";
 
  const char* const REPO_URL = "https://raw.githubusercontent.com";
  const char* const REPO_PATH = "/OpenCPN/plugins/@branch@/ocpn-plugins.xml";
 
  const char* const DEFAULT_CHANNEL = "master";
 
private:
  std::vector<std::string> channels;
  ServerStatus status;
  std::ostream* stream;
  std::string error_msg;
  CatalogData latest_data;
  CatalogData default_data;
  CatalogData user_data;
  ServerStatus m_catalog_status;
  CatalogCtx m_catalogctx;
};
 
typedef CatalogHandler::ServerStatus catalog_status;
 
#endif  // CATALOG_HANDLER_H__