paths.cpp File Reference

(986a3bf)

#include "fs/paths.h"
#include "fs/virtfs/fs.h"
#include "utils/checkutils.h"
#include "utils/stringutils.h"
#include <climits>
#include <unistd.h>
#include <sys/types.h>
#include <pwd.h>
#include "debug.h"

Go to the source code of this file.

Namespaces
	anonymous_namespace{paths.cpp}

Functions
std::string	getRealPath (const std::string &str)
bool	isRealPath (const std::string &str)
bool	checkPath (const std::string &path)
void	prepareFsPath (std::string &path)
std::string &	fixDirSeparators (std::string &str)
std::string	removeLast (const std::string &str)
std::string	getSelfName ()
std::string	getPicturesDir ()
std::string	getHomePath ()
std::string	getPackageDir ()
void	setPackageDir (const std::string &dir)

Variables
std::string	anonymous_namespace{paths.cpp}::mPackageDir

Function Documentation

checkPath()

bool checkPath

(

const std::string &

path

)

Definition at line 121 of file paths.cpp.

{
    if (path.empty())
        return true;
    return path.find("../") == std::string::npos
        && path.find("..\\") == std::string::npos
        && path.find("/..") == std::string::npos
        && path.find("\\..") == std::string::npos
        && path.find("(unreachable)") == std::string::npos;
}

Referenced by VirtFs::enumerateFiles(), VirtFs::exists(), VirtFs::getDirs(), VirtFs::getFiles(), VirtFs::getFilesWithDir(), VirtFs::getRealDir(), ConfigManager::initConfiguration(), Dirs::initUpdatesDir(), VirtFs::isDirectory(), VirtFs::FsDir::isSymbolicLink(), VirtFs::loadFile(), HelpWindow::loadHelp(), HelpWindow::loadHelpSimple(), loadHostsGroup(), loadTxtFile(), loadXMLFile(), VirtFs::openAppend(), VirtFs::openRead(), VirtFs::openWrite(), parseOptions(), LoginDialog::prepareUpdate(), Ea::LoginRecv::processUpdateHost(), and EAthena::LoginRecv::processUpdateHost2().

fixDirSeparators()

std::string& fixDirSeparators

(

std::string &

str

)

Definition at line 149 of file paths.cpp.

{
#ifdef WIN32
    return replaceAll(str, "/", "\\");
#else
    return str;
#endif
}

References replaceAll().

Referenced by Font::Font(), and Font::loadFont().

getHomePath()

std::string getHomePath

(

)

Definition at line 252 of file paths.cpp.

{
#if defined(UNITTESTS) && defined(UNITESTSDIR)
    std::string dir = UNITESTSDIR;
    if (findLast(dir, std::string(dirSeparator)) == false)
        dir += dirSeparator;
    return dir;
#else  // defined(UNITTESTS) && defined(UNITESTSDIR)
#ifdef WIN32
    return getSpecialFolderLocation(CSIDL_LOCAL_APPDATA);
#elif defined(__SWITCH__)
    return VirtFs::getBaseDir();
#else
    const char *path = getenv("HOME");
    if (path == nullptr)
    {
        const uid_t uid = getuid();
        const passwd *const pw = getpwuid(uid);
        if (pw != nullptr &&
            pw->pw_dir != nullptr)
        {
            path = pw->pw_dir;
        }
        if (path == nullptr)
            return dirSeparator;
    }
    std::string dir = path;
    if (findLast(dir, std::string(dirSeparator)) == false)
        dir += dirSeparator;
    return dir;
#endif  // WIN32
#endif  // defined(UNITTESTS) && defined(UNITESTSDIR)
}

References dirSeparator, findLast(), and VirtFs::getBaseDir().

Referenced by VirtFs::FsDir::init().

getPackageDir()

std::string getPackageDir

(

)

Definition at line 293 of file paths.cpp.

{
    return mPackageDir;
}

References anonymous_namespace{paths.cpp}::mPackageDir.

Referenced by VirtFs::getPath().

getPicturesDir()

std::string getPicturesDir

(

)

Definition at line 207 of file paths.cpp.

{
#ifdef WIN32
    std::string dir = getSpecialFolderLocation(CSIDL_MYPICTURES);
    if (dir.empty())
        dir = getSpecialFolderLocation(CSIDL_DESKTOP);
    return dir;
#elif defined USE_X11
    char *xdg = getenv("XDG_CONFIG_HOME");
    std::string file;
    if (!xdg)
    {
        file = pathJoin(VirtFs::getUserDir(),
            ".config/user-dirs.dirs");
    }
    else
    {
        file = pathJoin(xdg, "user-dirs.dirs");
    }
 
    if (Files::existsLocal(file))
    {
        StringVect arr;
        Files::loadTextFileLocal(file, arr);
        FOR_EACH (StringVectCIter, it, arr)
        {
            std::string str = *it;
            if (findCutFirst(str, "XDG_PICTURES_DIR=\""))
            {
                str = str.substr(0, str.size() - 1);
                // use hack to replace $HOME var.
                // if in string other vars, fallback to default path
                replaceAll(str, "$HOME/", VirtFs::getUserDir());
                str = getRealPath(str);
                if (str.empty())
                    str = pathJoin(VirtFs::getUserDir(), "Desktop");
                return str;
            }
        }
    }
#endif  // WIN32
 
    return pathJoin(VirtFs::getUserDir(), "Desktop");
}

References Files::existsLocal(), findCutFirst(), FOR_EACH, getRealPath(), VirtFs::getUserDir(), Files::loadTextFileLocal(), pathJoin(), and replaceAll().

Referenced by Dirs::initScreenshotDir().

getRealPath()

std::string getRealPath

(

const std::string &

str

)

Definition at line 84 of file paths.cpp.

{
#if defined(__GLIBC__)
    if (str.find("(unreachable)") != std::string::npos)
        return "";
#endif  // defined(__GLIBC__)
 
    // possible fix for realpath overflow
    if (str.size() > SSIZE_MAX / 10)
    {
        return std::string();
    }
#if defined(__OpenBSD__) || defined(__ANDROID__) || \
    defined(__native_client__) || defined(__SWITCH__)
    char *realPath = reinterpret_cast<char*>(calloc(PATH_MAX, sizeof(char)));
    if (!realPath)
        return "";
    realpath(str.c_str(), realPath);
#else  // defined(__OpenBSD__) || defined(__ANDROID__) ||
       // defined(__native_client__)
 
    char *realPath = realpath(str.c_str(), nullptr);
    if (realPath == nullptr)
        return "";
#endif  // defined(__OpenBSD__) || defined(__ANDROID__) ||
        // defined(__native_client__)
 
    std::string path = realPath;
    free(realPath);
    return path;
}

Referenced by getPicturesDir(), Configuration::init(), VirtFs::FsDir::init(), and isRealPath().

getSelfName()

std::string getSelfName

(

)

Definition at line 200 of file paths.cpp.

{
    return "";
}

Referenced by TestMain::TestMain().

isRealPath()

bool isRealPath

(

const std::string &

str

)

Definition at line 116 of file paths.cpp.

{
    return str == getRealPath(str);
}

References getRealPath().

Referenced by Dirs::updateDataPath().

prepareFsPath()

void prepareFsPath

(

std::string &

path

)

Definition at line 132 of file paths.cpp.

{
#ifdef DEBUGFS
    std::string path2 = path;
#endif
    sanitizePath(path);
// can be enabled for debugging
#ifdef DEBUGFS
    if (path != path2)
    {
        reportAlways("Path can be improved: '%s' -> '%s'",
            path2.c_str(),
            path.c_str())
    }
#endif
}

References reportAlways, and sanitizePath().

Referenced by VirtFs::enumerateFiles(), VirtFs::exists(), VirtFs::getDirs(), VirtFs::getFiles(), VirtFs::getFilesWithDir(), VirtFs::getRealDir(), VirtFs::FsDir::init(), VirtFs::isDirectory(), VirtFs::FsDir::isSymbolicLink(), VirtFs::loadFile(), VirtFs::FsDir::mkdir(), VirtFs::mountDir(), VirtFs::mountDir2(), VirtFs::mountDirSilent(), VirtFs::mountDirSilent2(), VirtFs::mountZip(), VirtFs::mountZip2(), VirtFs::openAppend(), VirtFs::openRead(), VirtFs::openWrite(), VirtFs::ZipReader::readArchiveInfo(), VirtFs::FsDir::remove(), VirtFs::FsDir::setWriteDir(), VirtFs::unmountDir(), VirtFs::unmountDir2(), VirtFs::unmountDirSilent(), VirtFs::unmountDirSilent2(), VirtFs::unmountZip(), and VirtFs::unmountZip2().

removeLast()

std::string removeLast

(

const std::string &

str

)

Definition at line 158 of file paths.cpp.

{
    size_t pos2 = str.rfind('/');
    const size_t pos3 = str.rfind('\\');
    if (pos3 != std::string::npos)
    {
        if (pos2 == std::string::npos || pos3 > pos2)
            pos2 = pos3;
    }
    if (pos2 != std::string::npos)
        return str.substr(0, pos2);
    return str;
}

setPackageDir()

void setPackageDir

(

const std::string &

dir

)

Definition at line 298 of file paths.cpp.

{
    mPackageDir = dir;
}

References anonymous_namespace{paths.cpp}::mPackageDir.

Referenced by Dirs::mountDataDir().