ISISDataArchive.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 +
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidDataHandling/ISISDataArchive.h"
#include "MantidAPI/ArchiveSearchFactory.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/InternetHelper.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/StringTokenizer.h"
#include <filesystem>
 
namespace Mantid::DataHandling {
namespace {
Kernel::Logger g_log("ISISDataArchive");
} // namespace
 
DECLARE_ARCHIVESEARCH(ISISDataArchive, ISISDataSearch)
 
namespace {
#ifdef _WIN32
constexpr std::string_view URL_PREFIX = "http://data.isis.rl.ac.uk/where.py/windir?name=";
#else
constexpr std::string_view URL_PREFIX = "http://data.isis.rl.ac.uk/where.py/unixdir?name=";
#endif
} // namespace
 
const API::Result<std::filesystem::path> ISISDataArchive::getArchivePath(const std::set<std::string> &filenames,
                                                                         const std::vector<std::string> &exts) const {
  if (g_log.is(Kernel::Logger::Priority::PRIO_DEBUG)) {
    for (const auto &filename : filenames) {
      g_log.debug() << filename << ")\n";
    }
    for (const auto &ext : exts) {
      g_log.debug() << ext << ")\n";
    }
  }
 
  std::string errors = "";
  for (const auto &filename : filenames) {
    std::string path_without_extension = getPath(filename);
    if (!path_without_extension.empty()) {
#ifdef __APPLE__
      // Replace Linux path with macOS path if we're on a Mac.
      constexpr std::string_view unixString = "/archive/";
      constexpr std::string_view macOSString = "/Volumes/inst$/";
      path_without_extension.replace(0, unixString.length(), macOSString);
#endif
      std::string fullPath = getCorrectExtension(path_without_extension, exts);
      if (!fullPath.empty())
        return API::Result<std::filesystem::path>(fullPath);
      errors += "No file found. ";
#ifdef __linux__
      errors +=
          "If you are an IDAaaS user, and your file is in the ISIS archive, then check if the archive is mounted. If it is not mounted, \
                \nthen click Applications->Data->Experiment Archive (Staff Only), and enter your federal ID credentials with 'clrc' as the domain.";
#endif // __linux__
    }
  }
  return API::Result<std::filesystem::path>("", errors);
}
 
std::string ISISDataArchive::getPath(const std::string &fName) const {
  g_log.debug() << "ISISDataArchive::getPath() - fName=" << fName << "\n";
  if (fName.empty())
    return ""; // Avoid pointless call to service
 
  std::ostringstream os = sendRequest(fName);
  os << std::string(1, std::filesystem::path::preferred_separator) << fName;
  std::string expectedPath = os.str();
  return expectedPath;
}
 
std::ostringstream ISISDataArchive::sendRequest(const std::string &fName) const {
  Kernel::InternetHelper inetHelper;
  std::ostringstream os;
  try {
    inetHelper.sendRequest(URL_PREFIX.data() + fName, os);
  } catch (Kernel::Exception::InternetError &ie) {
    g_log.warning() << "Could not access archive index." << ie.what();
  }
  return os;
}
 
std::string ISISDataArchive::getCorrectExtension(const std::string &path, const std::vector<std::string> &exts) const {
  for (const auto &ext : exts) {
    std::string temp_path = path + ext;
    if (fileExists(temp_path))
      return temp_path;
  }
  return "";
}
 
bool ISISDataArchive::fileExists(const std::string &path) const {
  try {
    if (std::filesystem::exists(path))
      return true;
  } catch (const std::filesystem::filesystem_error &) {
  }
  return false;
}
 
} // namespace Mantid::DataHandling