File.cpp

/*
 * libdigidocpp
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#include "File.h"

#include "log.h"

#include <algorithm>
#include <charconv>
#include <ctime>
#include <locale>
#include <sstream>
#include <sys/stat.h>
#include <sys/types.h>

#ifdef _WIN32
#include <Windows.h>
#include <ShlObj_core.h>
#include <direct.h>
#include <sys/utime.h>
#else
#include <dirent.h>
#include <sys/param.h>
#include <pwd.h>
#include <unistd.h>
#include <utime.h>
#endif
#ifdef __APPLE__
#include <CoreFoundation/CoreFoundation.h>
#endif

using namespace digidoc;
using namespace digidoc::util;
using namespace std;
namespace fs = filesystem;

#ifdef _WIN32
#define f_stat _wstat64
#define f_utime _wutime64
using f_statbuf = struct _stat64;
using f_utimbuf = struct __utimbuf64;
#else
#define f_stat stat
#define f_utime utime
using f_statbuf = struct stat;
using f_utimbuf = struct utimbuf;
#endif

stack<fs::path> File::tempFiles;

static string decodeName(fs::path path)
{
    auto name = path.u8string();
    return {reinterpret_cast<const char*>(name.data()), name.size()};
}

string File::confPath()
{
#if defined(__APPLE__)
    return frameworkResourcesPath("ee.ria.digidocpp");
#elif defined(_WIN32) && defined(_DEBUG)
    return dllPath("digidocppd.dll");
#elif defined(_WIN32)
    return dllPath("digidocpp.dll");
#else
    fs::path result;
    if(char *var = getenv("SNAP"))
        result = fs::path(var);
    return decodeName(result / DIGIDOCPP_CONFIG_DIR "/");
#endif
}

/**
 * Encodes path to compatible std lib
 * @param fileName path
 * @return encoded path
 */
fs::path File::encodeName(string_view fileName)
{
    return u8string_view(reinterpret_cast<const char8_t*>(fileName.data()), fileName.size());
}

/**
 * Checks whether file exists and is type of file.
 *
 * @param path path to the file, which existence is checked.
 * @return returns true if the path is a file and it exists.
 */
bool File::fileExists(const string& path)
{
    return fs::is_regular_file(encodeName(path));
}

#ifdef _WIN32
string File::dllPath(string_view dll)
{
#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
    HMODULE handle = GetModuleHandleW(encodeName(dll).c_str());
    wstring path(MAX_PATH, 0);
    path.resize(GetModuleFileNameW(handle, path.data(), DWORD(path.size())));
    return decodeName(fs::path(path).parent_path());
#else
    return {};
#endif
}
#endif

/**
 * Returns last modified time
 *
 * @param path path which modified time will be checked.
 * @return returns given path modified time.
 */
time_t File::modifiedTime(const string &path)
{
    f_statbuf fileInfo;
    return f_stat(encodeName(path).c_str(), &fileInfo) ? time(nullptr) : fileInfo.st_mtime;
}

bool File::fileExtension(string_view path, initializer_list<string_view> list)
{
    size_t pos = path.find_last_of('.');
    if(pos == string::npos)
        return false;
    string_view ext = path.substr(pos + 1);
    return any_of(list.begin(), list.end(), [ext](string_view exp) {
        return equal(ext.cbegin(), ext.cend(), exp.cbegin(), exp.cend(), [](auto a, auto b) {
            return tolower(a) == tolower(b);
        });
    });
}

/**
 * Returns file size
 */
unsigned long File::fileSize(const std::filesystem::path &path) noexcept
{
    error_code ec;
    auto result = fs::file_size(path, ec);
    return ec ? 0 : result;
}

/**
 * Parses file path and returns file name from file full path.
 *
 * @param path full path of the file.
 * @return returns file name from the file full path in UTF-8.
 */
string File::fileName(const string& path)
{
    size_t pos = path.find_last_of("/\\");
    return pos == string::npos ? path : path.substr(pos + 1);
}

#ifdef __APPLE__
string File::frameworkResourcesPath(string_view name)
{
    string result(PATH_MAX, 0);
    CFStringRef identifier = CFStringCreateWithCString(nullptr, name.data(), kCFStringEncodingUTF8);
    if(CFBundleRef bundle = CFBundleGetBundleWithIdentifier(identifier))
    {
        if(CFURLRef url = CFBundleCopyResourcesDirectoryURL(bundle))
        {
            CFURLGetFileSystemRepresentation(url, TRUE, (UInt8 *)result.data(), CFIndex(result.size()));
            CFRelease(url);
        }
    }
    CFRelease(identifier);
    result.resize(strlen(result.c_str()));
    return result;
}
#endif

/**
 * Parses file path and returns directory from file full path.
 *
 * @param path full path of the file.
 * @return returns directory part of the file full path.
 */
string File::directory(const string& path)
{
    size_t pos = path.find_last_of("/\\");
    return pos == string::npos ? string() : path.substr(0, pos);
}

/**
 * Creates full path from directory name and relative path.
 *
 * @param directory directory path.
 * @param relativePath relative path.
 * @return returns full path.
 */
string File::path(string dir, string_view relativePath)
{
    if(!dir.empty() && dir.back() != '/' && dir.back() != '\\')
        dir += '/';
    dir.append(relativePath);
#ifdef _WIN32
    replace(dir.begin(), dir.end(), '/', '\\');
#else
    replace(dir.begin(), dir.end(), '\\', '/');
#endif
    return dir;
}

/**
 * @return returns temporary filename.
 */
fs::path File::tempFileName()
{
#ifdef _WIN32
    // requires TMP environment variable to be set
    wchar_t *fileName = _wtempnam(nullptr, nullptr); // TODO: static buffer, not thread-safe
    if(!fileName)
        THROW("Failed to create a temporary file name.");
    tempFiles.emplace(fileName);
    free(fileName);
#else
    string tmp = "XXXXXX";
    if(mkstemp(tmp.data()) == -1)
        THROW("Failed to create a temporary file name.");
    tempFiles.push(fs::temp_directory_path() / tmp);
#endif
    return tempFiles.top();
}

/**
 * Creates directory recursively. Also access rights can be omitted. Defaults are 700 in unix.
 *
 * @param path full path of the directory created.
 * @throws IOException exception is thrown if the directory creation failed.
 */
void File::createDirectory(string path)
{
    if(path.empty())
        THROW("Can not create directory with no name.");
    if(path.back() == '/' || path.back() == '\\')
        path.pop_back();
    auto _path = encodeName(path);
#ifdef _WIN32
    int result = _wmkdir(_path.c_str());
#else
    int result = mkdir(_path.c_str(), S_IRWXU);
#endif
    if(result == 0 || errno == EEXIST)
    {
        DEBUG("Created directory or directory exists '%s'", path.c_str());
        return;
    }
    if(errno != ENOENT)
        THROW("Failed to create directory '%s', errno = %d", path.c_str(), errno);
    createDirectory(directory(path));
    createDirectory(std::move(path));
}

string File::digidocppPath()
{
#ifdef _WIN32
    PWSTR knownFolder {};
    if(SHGetKnownFolderPath(FOLDERID_RoamingAppData, KF_FLAG_DONT_VERIFY, nullptr, &knownFolder) != S_OK)
        THROW("Failed to get home directory");
    auto appData = (fs::path(knownFolder) / "digidocpp");
    CoTaskMemFree(knownFolder);
    return decodeName(appData);
#elif defined(ANDROID) || TARGET_OS_SIMULATOR
    if(char *var = getenv("HOME"))
        return decodeName(fs::path(var) / ".digidocpp");
    return {};
#else
    string buf(sysconf(_SC_GETPW_R_SIZE_MAX), 0);
    passwd pwbuf {};
    passwd *pw {};
    if(getpwuid_r(geteuid(), &pwbuf, buf.data(), buf.size(), &pw) != 0 || !pw)
        THROW("Failed to get home directory");
    return path(pw->pw_dir, ".digidocpp");
#endif
}

/**
 * Tries to delete all temporary files and directories whose names were handled out with tempFileName, tempDirectory and createTempDirectory.
 * The deletion of directories is recursive.
 */
void File::deleteTempFiles()
{
    error_code ec;
    while(!tempFiles.empty())
    {
        if(!fs::remove(tempFiles.top(), ec) || ec)
            WARN("Tried to remove the temporary file or directory '%s', but failed.", decodeName(tempFiles.top()).c_str());
        tempFiles.pop();
    }
}

/**
 * Helper method for converting strings with non-ascii characters to the URI format (%HH for each non-ascii character).
 *
 * Not converting:
 * (From RFC  RFC 3986 "URI Generic Syntax")
 * unreserved    = ALPHA / DIGIT / “-” / “.” / “_” / “~”
 * gen-delims = “:” / “/” / “?” / “#” / “[” / “]” / “@”
 * sub-delims    = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
 *
 *  3.3. Path
 * pchar         = unreserved / pct-encoded / sub-delims / ":" / "@"
 * We also encode sub-delims and ":" "@" to be safe
 *
 * @param str_in the string to be converted
 * @return the string converted to the URI format
 */
string File::toUriPath(const string &path)
{
    static const string unreserved = "-._~/";
    //static string sub-delims = "!$&'()*+,;="
    static const locale locC("C");
    ostringstream dst;
    for(const char &i: path)
    {
        if(isalnum(i, locC) || unreserved.find(i) != string::npos)
            dst << i;
        else
            dst << '%' << hex << uppercase << (static_cast<int>(i) & 0xFF);
    }
    return dst.str();
}

constexpr bool fromHexChar(auto pos, auto end, auto &value)
{
    if(distance(pos, end) < 2)
        return false;
    auto *p = &*pos;
    return from_chars(p, p + 2, value, 16).ec == std::errc{};
}

string File::fromUriPath(string_view path)
{
    string ret;
    ret.reserve(path.size());
    uint8_t value = 0;
    for(auto i = path.begin(); i != path.end(); ++i)
    {
        if(*i == '%' && fromHexChar(i + 1, path.end(), value))
        {
            ret += static_cast<char>(value);
            i += 2;
        }
        else
            ret += *i;
    }
    return ret;
}

vector<unsigned char> File::hexToBin(string_view in)
{
    vector<unsigned char> out;
    out.reserve(in.size() / 2);
    uint8_t value = 0;
    for(auto i = in.begin(); fromHexChar(i,  in.end(), value); i += 2)
        out.emplace_back(value);
    return out;
}