DirectoryValidator.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 "MantidKernel/DirectoryValidator.h"
#include "MantidKernel/IValidator.h"
#include <filesystem>
#include <memory>
 
namespace Mantid::Kernel {
 
DirectoryValidator::DirectoryValidator(bool testDirectoryExists) : FileValidator() {
  this->m_testExist = testDirectoryExists;
}
 
std::vector<std::string> DirectoryValidator::allowedValues() const { return std::vector<std::string>(); }
 
IValidator_sptr DirectoryValidator::clone() const { return std::make_shared<DirectoryValidator>(*this); }
 
std::string DirectoryValidator::checkValidity(const std::string &value) const {
  // Check if the path is syntactically valid
  try {
    std::filesystem::path testPath(value);
    // Just creating a path object validates syntax in most cases
  } catch (const std::exception &) {
    return "Error in path syntax: \"" + value + "\".";
  }
 
  // If the path is required to exist check it is there
  if (m_testExist) {
    try {
      if (value.empty() || !std::filesystem::exists(value))
        return "Directory \"" + value + "\" not found";
      if (!std::filesystem::is_directory(value))
        return "Directory \"" + value + "\" specified is actually a file";
    } catch (const std::filesystem::filesystem_error &) {
      return "Error accessing directory \"" + value + "\"";
    }
  }
 
  // Otherwise we are okay, file extensions are just a suggestion so no
  // validation on them is necessary
  return "";
}
 
} // namespace Mantid::Kernel