Io.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * libhomegear-base is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef BASELIBIO_H_
#define BASELIBIO_H_

#include <string>
#include <vector>

namespace BaseLib {
namespace Security {
template<typename T>
class SecureVector;
}

class SharedObjects;

class Io {
 public:
  Io();

  virtual ~Io();

  void init(SharedObjects *baseLib);

  static bool directoryExists(const std::string &path);

  static int32_t isDirectory(const std::string &path, bool &result);

  static bool linkExists(const std::string &path);

  static bool createDirectory(const std::string &path, uint32_t mode);

  static std::string getFileContent(const std::string &filename);

  static std::vector<char> getBinaryFileContent(const std::string &filename, uint32_t maxBytes = 0);

  static std::vector<uint8_t> getUBinaryFileContent(const std::string &filename);

  static Security::SecureVector<uint8_t> getUBinaryFileContentSecure(const std::string &filename);

  static bool fileExists(const std::string &filename);

  static void writeFile(const std::string &filename, const std::string &content);

  static void writeFile(const std::string &filename, const std::vector<char> &content, uint32_t length);

  static void writeFile(const std::string &filename, const std::vector<uint8_t> &content, uint32_t length);

  static void appendToFile(const std::string &filename, const std::string &content);

  static void appendToFile(const std::string &filename, const std::vector<char> &content, uint32_t length);

  static void appendToFile(const std::string &filename, const std::vector<uint8_t> &content, uint32_t length);

  static std::vector<std::string> getFiles(const std::string &path, bool recursive = false);

  static std::vector<std::string> getDirectories(const std::string &path, bool recursive = false);

  static int32_t getFileLastModifiedTime(const std::string &filename);

  bool copyFile(const std::string &source, const std::string &dest);

  static bool moveFile(const std::string &source, const std::string &dest);

  static bool deleteFile(const std::string &file) noexcept;

  static bool writeLockFile(int fileDescriptor, bool wait);

  static bool readLockFile(int fileDescriptor, bool wait);

  std::string sha512(const std::string &file);
 private:
  BaseLib::SharedObjects *_bl = nullptr;
};
}
#endif