download.cpp

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 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 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
 
#include <fc_config.h>
 
#include <cerrno>
 
// Qt
#include <QDir>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QString>
#include <QUrl>
 
// dependencies
#include "cvercmp.h"
 
// utility
#include "capability.h"
#include "fcintl.h"
#include "netfile.h"
 
// tools
#include "mpdb.h"
 
#include "download.h"
 
namespace /* anonymous */ {
class file_info {
public:
  QString source() const { return m_source; }
 
  QFileInfo destination(const QString &prefix) const
  {
    return QFileInfo(prefix + m_destination);
  }
 
  bool is_valid() const { return m_error.isEmpty(); }
 
  QString error() const { return m_error; }
 
  static file_info from_json(const QJsonValue &input);
 
private:
  file_info()
      : m_source(), m_destination(),
        m_error(QString::fromUtf8(_("Invalid file")))
  {
  }
 
  file_info(const QString &source, const QString &destination)
      : m_source(source), m_destination(destination), m_error()
  {
    validate();
  }
 
  file_info(const QString &source_destination)
      : file_info(source_destination, source_destination)
  {
  }
 
  void set_error(const QString &error) { m_error = error; }
 
  void validate()
  {
    if (m_destination.isEmpty()) {
      // Probably a mistake. Don't accept it.
      set_error(QString::fromUtf8(_("Empty path")));
    } else if (m_destination.contains(QStringLiteral(".."))) {
      // Big no, might overwrite system files...
      set_error(
          QString::fromUtf8(_("Illegal path \"%1\"")).arg(m_destination));
    }
  }
 
  QString m_source;
  QString m_destination;
  QString m_error;
};
 
file_info file_info::from_json(const QJsonValue &input)
{
  if (input.isString()) {
    // Option 1: source and destination of the same name
    return file_info(input.toString());
  } else if (input.isObject()) {
    // Option 2: source and destination separately
    // Convert to a QJsonObject
    auto obj = input.toObject();
 
    if (!obj.contains("dest") || !obj["dest"].isString()) {
      auto err = file_info();
      // TRANS: Do not translate "dest" (stands for "destination")
      err.set_error(QString::fromUtf8(_("Missing \"dest\" field")));
      return err;
    }
    auto destination = obj["dest"].toString();
 
    if (obj.contains("url")) {
      if (obj["url"].isString()) {
        return file_info(obj["url"].toString(), destination);
      } else {
        auto err = file_info();
        // TRANS: Do not translate "url"
        err.set_error(QString::fromUtf8(_("\"url\" field is not a string")));
        return err;
      }
    } else {
      return file_info(destination);
    }
  } else {
    // Invalid
    return file_info();
  }
}
 
} // anonymous namespace
 
const char *download_modpack(const QUrl &url, const struct fcmp_params *fcmp,
                             const dl_msg_callback &mcb,
                             const dl_pb_callback &pbcb, int recursion)
{
  if (recursion > 5) {
    return _("Recursive dependencies too deep");
  }
 
  if (!url.isValid()) {
    return _("No valid URL given");
  }
 
  if (!url.fileName().endsWith(QStringLiteral(MODPACKDL_SUFFIX))) {
    return _("This does not look like modpack URL");
  }
 
  qInfo().noquote() << QString::fromUtf8(_("Installing modpack %1 from %2"))
                           .arg(url.fileName())
                           .arg(url.toString());
 
  if (fcmp->inst_prefix.isEmpty()) {
    return _("Cannot install to given directory hierarchy");
  }
 
  if (mcb != nullptr) {
    // TRANS: %s is a filename with suffix '.modpack'
    mcb(QString::fromUtf8(_("Downloading \"%1\" control file."))
            .arg(url.fileName()));
  }
 
  auto json = netfile_get_json_file(url, mcb);
  if (!json.isObject()) {
    return _("Cannot fetch and parse modpack list");
  }
 
  auto info_value = json["info"];
  if (!info_value.isObject()) {
    // TRANS: Do not translate "info"
    return _("\"info\" is not an object");
  }
  auto info = info_value.toObject();
 
  if (!info["options"].isString()) {
    // TRANS: Do not translate "info.options"
    return _("\"info.options\" is not a string");
  }
 
  auto list_capstr = info["options"].toString();
 
  if (!has_capabilities(MODPACK_CAPSTR, qUtf8Printable(list_capstr))) {
    qCritical() << "Incompatible control file:";
    qCritical() << "  control file options:" << list_capstr;
    qCritical() << "  supported options:" << MODPACK_CAPSTR;
 
    return _("Modpack control file is incompatible");
  }
 
  if (!info["name"].isString()) {
    // TRANS: Do not translate "info.name"
    return _("\"info.name\" is not a string");
  }
  auto mpname = info["name"].toString();
  if (mpname.isEmpty()) {
    return _("Modpack name is empty");
  }
 
  if (!info["version"].isString()) {
    // TRANS: Do not translate "info.version"
    return _("\"info.version\" is not a string");
  }
  auto mpver = info["version"].toString();
 
  if (!info["type"].isString()) {
    // TRANS: Do not translate "info.type"
    return _("\"info.type\" is not a string");
  }
  auto mptype = info["type"].toString();
  auto type = modpack_type_by_name(qUtf8Printable(mptype), fc_strcasecmp);
  if (!modpack_type_is_valid(type)) {
    return _("Illegal modpack type");
  }
 
  if (!info["base_url"].isString()) {
    // TRANS: Do not translate "info.type"
    return _("\"info.base_url\" is not a string");
  }
  auto base_url = QUrl(info["base_url"].toString());
  base_url = url.resolved(base_url);
 
  // Make sure the url is treated as a directory by resolved(). For this we
  // need to append a / if QUrl considers that there is a file name.
  if (!base_url.fileName().isEmpty()) {
    base_url.setPath(base_url.path(QUrl::FullyEncoded)
                     + QStringLiteral("/"));
  }
 
  /*
   * Fetch dependencies
   */
  auto deps = json["dependencies"];
  if (!deps.isUndefined()) {
    if (!deps.isArray()) {
      // TRANS: Do not translate "dependencies"
      return _("\"dependencies\" is not an array");
    }
 
    for (const auto &depref : deps.toArray()) {
      if (!depref.isObject()) {
        // TRANS: Do not translate "dependencies"
        return _("\"dependencies\" contains a non-object");
      }
 
      // QJsonValueRef doesn't support operator[], convert to a QJsonObject
      auto obj = depref.toObject();
 
      if (!obj.contains("url") || !obj["url"].isString()) {
        // TRANS: Do not translate "url"
        return _("Dependency has no \"url\" field or it is not a string");
      }
      auto dep_url = obj["url"].toString();
 
      if (!obj.contains("modpack") || !obj["modpack"].isString()) {
        // TRANS: Do not translate "modpack"
        return _(
            "Dependency has no \"modpack\" field or it is not a string");
      }
      auto dep_name = obj["modpack"].toString();
 
      if (!obj.contains("type") || !obj["type"].isString()) {
        // TRANS: Do not translate "modpack"
        return _("Dependency has no \"type\" field or it is not a string");
      }
      auto dep_type_str = obj["type"].toString();
 
      auto dep_type =
          modpack_type_by_name(qUtf8Printable(dep_type_str), fc_strcasecmp);
      if (!modpack_type_is_valid(type)) {
        qCritical() << "Illegal modpack type" << dep_type_str;
        return _("Illegal modpack type");
      }
 
      if (!obj.contains("version") || !obj["version"].isString()) {
        // TRANS: Do not translate "version"
        return _(
            "Dependency has no \"version\" field or it is not a string");
      }
      auto dep_version = obj["version"].toString();
 
      // We have everything
      auto inst_ver =
          mpdb_installed_version(qUtf8Printable(dep_name), dep_type);
      if (!inst_ver || !cvercmp_max(qUtf8Printable(dep_version), inst_ver)) {
        qInfo() << "Dependency modpack" << QString(inst_ver) << dep_version
                << "needed.";
 
        if (mcb != nullptr) {
          mcb(_("Download dependency modpack"));
        }
 
        auto dep_qurl = QUrl(dep_url);
        if (dep_qurl.isRelative()) {
          dep_qurl = url.resolved(dep_qurl);
        }
 
        auto msg =
            download_modpack(dep_qurl, fcmp, mcb, pbcb, recursion + 1);
 
        if (msg != nullptr) {
          return msg;
        }
      }
      delete[] inst_ver;
    }
  }
 
  /*
   * Get the list of files
   */
  std::vector<file_info> required_files;
 
  auto files = json["files"];
  if (!files.isArray()) {
    // TRANS: Do not translate "files"
    return _("\"files\" is not an array");
  }
 
  std::size_t i = 0;
  for (const auto &fref : files.toArray()) {
    auto info = file_info::from_json(fref);
    if (!info.is_valid()) {
      // This doesn't look like a valid file
      auto error = info.error();
      qWarning().noquote()
          << QString::fromUtf8(
                 _("Error parsing modpack control file: file %1:"))
                 .arg(i);
      qWarning().noquote() << error;
      if (mcb) {
        mcb(error);
      }
      return _("Error parsing modpack control file");
    }
 
    required_files.push_back(info);
    i++;
  }
 
  // Control file already downloaded
  int downloaded = 1;
  if (pbcb != nullptr) {
    pbcb(downloaded, required_files.size() + 1);
  }
 
  // Where to install?
  auto local_dir =
      fcmp->inst_prefix
      + ((type == MPT_SCENARIO) ? QStringLiteral("/scenarios/")
                                : QStringLiteral("/" DATASUBDIR "/"));
 
  // Download and install
  bool full_success = true;
  for (auto info : required_files) {
    auto destination = info.destination(local_dir);
 
    // Create the destination directory if needed
    qDebug() << "Create directory:" << destination.absolutePath();
    if (!destination.absoluteDir().mkpath(".")) {
      return _("Cannot create required directories");
    }
 
    if (mcb != nullptr) {
      mcb(QString::fromUtf8(_("Downloading %1")).arg(info.source()));
    }
 
    // Resolve the URL
    auto source = base_url.resolved(info.source());
    qDebug() << "Download" << source.toDisplayString() << "to"
             << destination.absoluteFilePath();
 
    if (!netfile_download_file(
            source, qUtf8Printable(destination.absoluteFilePath()), mcb)) {
      if (mcb != nullptr) {
        mcb(QString::fromUtf8(_("Failed to download %1"))
                .arg(info.source()));
      }
      full_success = false;
    }
 
    if (pbcb != nullptr) {
      // Count download of control file also
      downloaded++;
      pbcb(downloaded, required_files.size() + 1);
    }
  }
 
  if (!full_success) {
    return _("Some parts of the modpack failed to install.");
  }
 
  mpdb_update_modpack(qUtf8Printable(mpname), type, qUtf8Printable(mpver));
 
  return nullptr;
}
 
const char *download_modpack_list(const struct fcmp_params *fcmp,
                                  const modpack_list_setup_cb &cb,
                                  const dl_msg_callback &mcb)
{
  auto json = netfile_get_json_file(fcmp->list_url, mcb);
  if (!json.isObject()) {
    return _("Cannot fetch and parse modpack list");
  }
 
  auto info = json["info"];
  if (!info.isObject()) {
    // TRANS: Do not translate "info"
    return _("\"info\" is not an object");
  }
 
  if (!info["options"].isString()) {
    // TRANS: Do not translate "info.options"
    return _("\"info.options\" is not a string");
  }
 
  auto list_capstr = info["options"].toString();
 
  if (!has_capabilities(MODLIST_CAPSTR, qUtf8Printable(list_capstr))) {
    qCritical() << "Incompatible modpack list file:";
    qCritical() << "  list file options:" << list_capstr;
    qCritical() << "  supported options:" << MODLIST_CAPSTR;
 
    return _("Modpack list is incompatible");
  }
 
  if (info["message"].isString()) {
    mcb(info["message"].toString());
  }
 
  auto modpacks = json["modpacks"];
  if (!modpacks.isArray()) {
    // TRANS: Do not translate "modpacks"
    return _("\"modpacks\" is not an array");
  }
 
  for (const auto &mpref : modpacks.toArray()) {
    // QJsonValueRef doesn't support operator[], convert to a QJsonObject
    if (!mpref.isObject()) {
      // TRANS: Do not translate "modpacks"
      return _("\"modpacks\" contains a non-object");
    }
    auto mp = mpref.toObject();
 
    // Modpack name (required)
    if (!mp["name"].isString()) {
      // TRANS: Do not translate "name"
      return _("Modpack \"name\" is missing or is not a string");
    }
    auto name = mp["name"].toString();
    if (name.isEmpty()) {
      return _("Modpack name is empty");
    }
 
    // Modpack version (required, can be empty)
    if (!mp["version"].isString()) {
      // TRANS: Do not translate "version"
      return _("Modpack \"version\" is missing or is not a string");
    }
    auto version = mp["version"].toString();
 
    // Modpack license (required, can be empty)
    if (!mp["license"].isString()) {
      // TRANS: Do not translate "license"
      return _("Modpack \"license\" is missing or is not a string");
    }
    auto license = mp["license"].toString();
 
    // Modpack type (required, validated)
    if (!mp["type"].isString()) {
      // TRANS: Do not translate "type"
      return _("Modpack \"type\" is missing or is not a string");
    }
    auto type_str = mp["type"].toString();
 
    auto type =
        modpack_type_by_name(qUtf8Printable(type_str), fc_strcasecmp);
    if (!modpack_type_is_valid(type)) {
      qCritical() << "Illegal modpack type" << type_str;
      return _("Illegal modpack type");
    }
 
    // Modpack subtype (optional, free text)
    if (mp.contains("subtype") && !mp["subtype"].isString()) {
      // TRANS: Do not translate "subtype"
      return _("Modpack \"subtype\" is not a string");
    }
    auto subtype = mp["subtype"].toString(QStringLiteral("-"));
 
    // Modpack URL (optional, validated)
    if (!mp["url"].isString()) {
      // TRANS: Do not translate "url"
      return _("Modpack \"url\" is missing or is not a string");
    }
    auto url = QUrl(mp["url"].toString());
    if (!url.isValid()) {
      qCritical() << "Invalid URL" << mp["url"].toString() << ":"
                  << url.errorString();
      return _("Invalid URL");
    }
    auto resolved = url.isRelative() ? fcmp->list_url.resolved(url) : url;
 
    // Modpack notes (optional)
    if (mp.contains("notes") && !mp["notes"].isString()) {
      // TRANS: Do not translate "notes"
      return _("Modpack \"notes\" is not a string");
    }
    auto notes = mp["notes"].toString(QStringLiteral(""));
 
    // Call the callback with the modpack info we just parsed
    cb(name, resolved, version, license, type,
       QString::fromUtf8(_(qUtf8Printable(subtype))), notes);
  }
 
  return nullptr;
}