FileUtilities.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2014 Sky UK
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
 * File:   FileUtilities.h
 * Author: jarek.dziedzic@bskyb.com
 *
 * Created on 11 July 2014
 *
 */
 
#ifndef FILEUTILITIES_H
#define FILEUTILITIES_H
 
#include <string>
#include <vector>
#include <dirent.h>
#include <sys/stat.h>
#include <stdio.h>
#include <limits.h>
 
#include <boost/optional.hpp>
 
 
#if !defined(SIZE_T_MAX)
#  define SIZE_T_MAX SIZE_MAX
#endif
 
 
namespace AICommon
{
 
const mode_t S_IRXALL  = S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
const mode_t S_IRALL  = S_IRUSR | S_IRGRP | S_IROTH;
 
std::vector<std::string> splitPath(const std::string& path);
 
bool mkdirRecursive(const std::string& path, mode_t mode = S_IRWXU);
 
bool mkdirRecursiveAt(const std::string& fullPath, int parentDirectoryFd, mode_t mode = S_IRWXU);
 
bool exists(const std::string& path);
 
int copyFile(const std::string & to, const std::string & from);
int copyFile(const char *to, const char *from);
 
 
void deleteDirectory(const std::string& directoryName);
 
void deleteDirectoryAt(int parentDirectoryFd, const std::string& directoryName);
 
 bool deleteFilesInDirectory(const std::string& directoryName);
 
bool deleteFile(const std::string & filePath);
 
std::vector<std::string> getFilesInDirectory(int dirFd);
std::vector<std::string> getFilesInDirectory(const std::string & dirName, bool fullPaths = false);
 
std::string resolvePath(const std::string& in);
 
std::vector<uint8_t> fileContents(const std::string& filepath);
 
std::vector<uint8_t> fileContents(int fd, size_t maxSize = SIZE_T_MAX);
std::vector<uint8_t> fileContents(int dirFd, const std::string& filepath, size_t maxSize = SIZE_T_MAX);
 
bool compareFilesExactly(const std::string & filePathApples, const std::string & filePathOranges);
 
bool createTextFile(const std::string& filePath, const std::string& contents, mode_t mode = S_IRWXU);
bool createTextFileAt(int dirFd, const std::string& filePath, const std::string& contents, mode_t mode = S_IRWXU);
 
std::string readTextStream(FILE *fp);
 
boost::optional<std::string> getXAttrib(int fileFd, const std::string& key);
 
boost::optional<std::string> getXAttrib(const std::string& filePath, const std::string& key);
 
bool setXAttrib(int fd, const std::string& key, const std::string& value, int flags = 0);
bool setXAttrib(const std::string& filePath, const std::string& key, const std::string& value, int flags = 0);
 
std::string fileMD5(const std::string & filePath);
std::string fileMD5(int fd);
 
int getDeviceFreeMegabytes(const std::string & path);
 
size_t getDirectorySizeInKb( const std::string &path );
 
}
 
#endif  /* FILEUTILITIES_H */