DirectoryValidator.cpp

// 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
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidKernel/DirectoryValidator.h"
#include "MantidKernel/IValidator.h"
#include <Poco/Exception.h>
#include <Poco/File.h>
#include <Poco/Path.h>
#include <boost/make_shared.hpp>

namespace Mantid {
namespace Kernel {

/** Constructor
 *  @param testDirectoryExists :: Flag indicating whether to test for existence
 * of directory (default: yes)
 */
DirectoryValidator::DirectoryValidator(bool testDirectoryExists)
    : FileValidator() {
  this->m_testExist = testDirectoryExists;
}

/// Returns the set of valid values
std::vector<std::string> DirectoryValidator::allowedValues() const {
  return std::vector<std::string>();
}

/**
 * Clone the validator
 * @returns A pointer to a new validator with the same properties as this one
 */
IValidator_sptr DirectoryValidator::clone() const {
  return boost::make_shared<DirectoryValidator>(*this);
}

/** If m_fullTest=true if checks that the files exists, otherwise just that path
 * syntax looks valid
 *  @param value :: file name
 *  @returns An error message to display to users or an empty string on no error
 */
std::string DirectoryValidator::checkValidity(const std::string &value) const {
  // Check if the path is syntactically valid
  if (!Poco::Path().tryParse(value)) {
    return "Error in path syntax: \"" + value + "\".";
  }

  // If the path is required to exist check it is there
  if (m_testExist) {
    try {
      if (value.empty() || !Poco::File(value).exists())
        return "Directory \"" + value + "\" not found";
      if (!Poco::File(value).isDirectory())
        return "Directory \"" + value + "\" specified is actually a file";
    } catch (Poco::FileException &) {
      return "Error accessing directory \"" + value + "\"";
    }
  }

  // Otherwise we are okay, file extensions are just a suggestion so no
  // validation on them is necessary
  return "";
}

} // namespace Kernel
} // namespace Mantid