CheckMantidVersion.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidDataHandling/CheckMantidVersion.h"
#include "MantidJson/Json.h"
#include "MantidKernel/ConfigService.h"
#include "MantidKernel/GitHubApiHelper.h"
#include "MantidKernel/MantidVersion.h"
#include "MantidKernel/Strings.h"
 
#include "MantidKernel/StringTokenizer.h"
#include <Poco/DateTimeFormat.h>
#include <Poco/DateTimeFormatter.h>
#include <Poco/DateTimeParser.h>
 
// jsoncpp
#include <json/json.h>
 
#include <boost/lexical_cast.hpp>
 
namespace Mantid::DataHandling {
 
using namespace Mantid::Kernel;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(CheckMantidVersion)
 
 
const std::string CheckMantidVersion::name() const { return "CheckMantidVersion"; }
 
int CheckMantidVersion::version() const { return 1; }
 
const std::string CheckMantidVersion::category() const { return "Utility\\Development"; }
 
const std::string CheckMantidVersion::summary() const {
  return "Checks if there is a more recent version of Mantid available using "
         "the Github API";
}
 
void CheckMantidVersion::init() {
  declareProperty("CurrentVersion", "", Direction::Output);
  declareProperty("MostRecentVersion", "", Direction::Output);
  declareProperty("IsNewVersionAvailable", false, "True if a newer version is available, otherwise false",
                  Direction::Output);
}
 
void CheckMantidVersion::exec() {
  std::string currentVersion = getCurrentVersion();
  setProperty("CurrentVersion", currentVersion);
  std::string mostRecentVersion;
 
  std::string gitHubReleaseUrl = ConfigService::Instance().getString("CheckMantidVersion.GitHubReleaseURL");
  if (gitHubReleaseUrl.empty()) {
    gitHubReleaseUrl = "https://api.github.com/repos/mantidproject/mantid/releases/latest";
  }
  std::string downloadUrl = ConfigService::Instance().getString("CheckMantidVersion.DownloadURL");
  if (downloadUrl.empty()) {
    downloadUrl = "http://download.mantidproject.org";
  }
 
  std::string json;
  try {
    json = getVersionsFromGitHub(gitHubReleaseUrl);
  } catch (Exception::InternetError &ex) {
    if (ex.errorCode() == static_cast<int>(InternetHelper::HTTPStatus::NOT_MODIFIED)) {
      // No changes since last release
      // mostRecentVersion = getCurrentVersion();
      mostRecentVersion = "No new versions since " + std::string(MantidVersion::releaseDate());
    } else {
      // any other exception just log quietly and return
      g_log.debug("Cannot get latest version details from " + gitHubReleaseUrl);
      g_log.debug("The address can be changed using the property "
                  "CheckMantidVersion.GitHubReleaseURL");
      g_log.debug(ex.what());
      return;
    }
  }
 
  bool isNewVersionAvailable = false;
  if (!json.empty()) {
    Json::Value root;
    std::string jsonErrors;
    bool parseOK = Mantid::JsonHelpers::parse(json, &root, &jsonErrors);
    if (!parseOK) {
      // just warning. The parser is able to get relevant info even if there are
      // formatting issues like missing quotes or brackets.
      g_log.warning() << "Error found when parsing version information "
                         "retrieved from GitHub as a JSON string. "
                         "Error trying to parse this JSON string: "
                      << json << "\n. Parsing error details: " << jsonErrors << '\n';
    }
 
    std::string gitHubVersionTag;
    try {
      gitHubVersionTag = root["tag_name"].asString();
    } catch (std::runtime_error &re) {
      g_log.error() << "Error while trying to get the field 'tag_name' from "
                       "the version information retrieved from GitHub. This "
                       "algorithm cannot continue and will stop now. Error details: "
                    << re.what() << '\n';
 
      mostRecentVersion = "Could not get information from GitHub";
      setProperty("MostRecentVersion", mostRecentVersion);
      setProperty("IsNewVersionAvailable", isNewVersionAvailable);
      return;
    }
 
    mostRecentVersion = cleanVersionTag(gitHubVersionTag);
    isNewVersionAvailable = isVersionMoreRecent(currentVersion, mostRecentVersion);
    if (isNewVersionAvailable) {
      // output a notice level log
      g_log.notice("A new version of Mantid(" + mostRecentVersion + ") is available for download from " + downloadUrl);
    }
  }
 
  g_log.information("Current Mantid Version: " + currentVersion);
  g_log.information("Most Recent Mantid Version: " + mostRecentVersion);
 
  setProperty("MostRecentVersion", mostRecentVersion);
  setProperty("IsNewVersionAvailable", isNewVersionAvailable);
}
 
std::string CheckMantidVersion::cleanVersionTag(const std::string &versionTag) const {
  std::string retVal = versionTag;
 
  retVal = Strings::replaceAll(retVal, "v", "");
  retVal = Strings::replaceAll(retVal, "V", "");
  retVal = Strings::strip(retVal);
 
  return retVal;
}
 
std::vector<int> CheckMantidVersion::splitVersionString(const std::string &versionString) const {
  std::vector<int> versionNumbers;
  // Discard suffix from release candidate version numbers.
  const std::string versionStringBeforeRC = versionString.substr(0, versionString.find("rc"));
  // Discard suffix from development builds.
  const std::string versionStringBeforeDev = versionStringBeforeRC.substr(0, versionStringBeforeRC.find(".dev"));
  // Discard suffix from local release versions.
  const std::string versionStringBeforePlus = versionStringBeforeDev.substr(0, versionStringBeforeDev.find("+"));
 
  Mantid::Kernel::StringTokenizer tokenizer(versionStringBeforePlus, ".",
                                            Mantid::Kernel::StringTokenizer::TOK_TRIM |
                                                Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY);
 
  for (auto h = tokenizer.begin(); h != tokenizer.end(); ++h) {
    try {
      auto part = boost::lexical_cast<int>(*h);
      versionNumbers.emplace_back(part);
    } catch (const boost::bad_lexical_cast &) {
      g_log.error("Failed to convert the following string to an integer '" + *h +
                  "' as part of CheckMantidVersion::splitVersionString");
      versionNumbers.emplace_back(0);
    }
  }
  return versionNumbers;
}
 
bool CheckMantidVersion::isVersionMoreRecent(const std::string &localVersion, const std::string &gitHubVersion) const {
  auto localVersionParts = splitVersionString(localVersion);
  auto gitHubVersionParts = splitVersionString(gitHubVersion);
 
  for (size_t i = 0; i < gitHubVersionParts.size(); i++) {
    // sanity check
    if (i >= localVersionParts.size()) {
      // ran out of items to compare
      break;
    }
 
    // the revision number needs to be handled separately
    if (i == 2) {
      if (localVersionParts[i] > 2000) {
        // this is a date string, nightly build
        // state that the local version is up to date
        return false;
      }
    }
    if (gitHubVersionParts[i] > localVersionParts[i]) {
      return true;
    }
    if (gitHubVersionParts[i] < localVersionParts[i]) {
      return false;
    }
  }
  return false;
}
 
std::string CheckMantidVersion::getVersionsFromGitHub(const std::string &url) {
 
  Kernel::GitHubApiHelper inetHelper;
  std::ostringstream os;
  int tzd = 0;
 
  inetHelper.addHeader("if-modified-since",
                       Poco::DateTimeFormatter::format(Poco::DateTimeParser::parse(MantidVersion::releaseDate(), tzd),
                                                       Poco::DateTimeFormat::HTTP_FORMAT));
  inetHelper.sendRequest(url, os);
  std::string retVal = os.str();
 
  return retVal;
}
std::string CheckMantidVersion::getCurrentVersion() const { return Mantid::Kernel::MantidVersion::version(); }
 
} // namespace Mantid::DataHandling