mythdirs.cpp

Go to the documentation of this file.

#include <iostream>
#include <cstdlib>
 
#include <QtGlobal>
#if QT_VERSION >= QT_VERSION_CHECK(6,5,0)
#include <QtEnvironmentVariables>
#include <QtSystemDetection>
#endif
#include <QDir>
#include <QCoreApplication>
 
#ifdef Q_OS_ANDROID
#include <filesystem>
#include <QStandardPaths>
#elif defined(Q_OS_WINDOWS)
#include <QStandardPaths>
#endif
 
#include "mythdirs.h"
#include "mythlogging.h"
 
static QString installprefix;
static QString appbindir;
static QString sharedir;
static QString libdir;
static QString confdir;
static QString themedir;
static QString pluginsdir;
static QString translationsdir;
static QString cachedir;
static QString remotecachedir;
static QString themebasecachedir;
static QString thumbnaildir;
 
void InitializeMythDirs(void)
{
    installprefix = qEnvironmentVariable( "MYTHTVDIR"   );
    confdir       = qEnvironmentVariable( "MYTHCONFDIR" );
 
    if (!confdir.isEmpty())
    {
        LOG(VB_GENERAL, LOG_NOTICE, QString("Read conf dir = %1").arg(confdir));
        confdir.replace("$HOME", QDir::homePath());
    }
 
#ifdef Q_OS_WINDOWS
 
    if (installprefix.isEmpty())
        installprefix = QDir{QCoreApplication::applicationDirPath()}.absolutePath();
 
    appbindir = installprefix + "/";
    libdir    = appbindir;
 
    // Turn into Canonical Path for consistent compares
 
    QDir sDir(qEnvironmentVariable("ProgramData") + "/mythtv/");
    if (sDir.exists())
        sharedir = sDir.canonicalPath() + "/";
 
    if(sharedir.isEmpty())
    {
        sharedir = appbindir + "data/mythtv/";
    }
    if (confdir.isEmpty())
    {
        confdir  = qEnvironmentVariable( "LOCALAPPDATA" ) + "/mythtv";
        confdir = QDir(confdir).canonicalPath() + "/";
    }
 
  #if 0
    // The following code only works for Qt 5.0 and above, but it may
    // be a generic solution for both windows & linux.
    // Re-evalute use oce min Qt == 5.0
 
    // QStringList sorted by least public to most.
    // Assume first is private user data and last is shared program data.
 
    qApp->setOrganizationName( "mythtv" );
 
    QStringList lstPaths = QStandardPaths::standardLocations(
                                        QStandardPaths::AppDataLocation);
 
    // Remove AppName from end of path
 
    QString sAppName = qApp->applicationName();
    if (!lstPaths.isEmpty())
    {
        for (auto &path : lstPaths)
        {
            if (path.endsWith(sAppName))
                path = path.left(path.length() - sAppName.length());
            LOG(VB_GENERAL, LOG_DEBUG, QString("app data location: %1 (%2)")
                .arg(path).arg(QDir(path).exists() ? "exists" : "doesn't exist"));
        }
 
        sharedir = lstPaths.last();
 
        if (sharedir.endsWith( sAppName ))
            sharedir = sharedir.left( sharedir.length() - sAppName.length());
    }
 
    lstPaths = QStandardPaths::standardLocations(
                                        QStandardPaths::AppConfigLocation);
    if (!lstPaths.isEmpty())
    {
        for (auto &path : lstPaths)
        {
            if (path.endsWith(sAppName))
                path = path.left(path.length() - sAppName.length());
            LOG(VB_GENERAL, LOG_DEBUG, QString("app config location: %1 (%2)")
                .arg(path).arg(QDir(path).exists() ? "exists" : "doesn't exist"));
        }
 
        // Only use if user didn't override with env variable.
        if (confdir.isEmpty())
        {
            confdir = lstPaths.first();
 
            if (confdir.endsWith( sAppName ))
                confdir = confdir.left( confdir.length() - sAppName.length());
        }
    }
 
  #endif
 
    if (sharedir.isEmpty())
        sharedir = confdir;
    sharedir = QDir(sharedir).canonicalPath() + "/";
 
#elif defined(Q_OS_ANDROID)
    if (installprefix.isEmpty())
        installprefix = QDir{QCoreApplication::applicationDirPath()}.absolutePath();
    QString extdir = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + "/Mythtv";
    if (!QDir(extdir).exists())
        QDir(extdir).mkdir(".");
 
    if (confdir.isEmpty())
        confdir = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
 
#if 0
    // TODO allow choice of base fs or the SD card for data
    QStringList appLocs = QStandardPaths::standardLocations(QStandardPaths::AppDataLocation);
    uintmax_t maxFreeSpace = 0;
    constexpr uintmax_t k_unknown_size {static_cast<std::uintmax_t>(-1)};
    for(const auto & s : appLocs)
    {
        std::filesystem::space_info space_info = std::filesystem::space(s.toStdString());
        if (!(
              (space_info.capacity == 0
               || space_info.free == 0
               || space_info.available == 0
               ) ||
              (space_info.capacity == k_unknown_size
               || space_info.free == k_unknown_size
               || space_info.available == k_unknown_size
               )
              ) && space_info.available >= maxFreeSpace
            )
        {
            maxFreeSpace = space_info.available;
            confdir = s;
        }
        LOG(VB_GENERAL, LOG_NOTICE, QString(" appdatadir      = %1 (%2, %3, %4)")
            .arg(s)
            .arg(space_info.available)
            .arg(space_info.free)
            .arg(space_info.capacity)
            );
    }
    QStringList cacheLocs = QStandardPaths::standardLocations(QStandardPaths::CacheLocation);
    maxFreeSpace = 0;
    for(const auto & s : cacheLocs)
    {
        std::filesystem::space_info space_info = std::filesystem::space(s.toStdString());
        if (!(
              (space_info.capacity == 0
               || space_info.free == 0
               || space_info.available == 0
               ) ||
              (space_info.capacity == k_unknown_size
               || space_info.free == k_unknown_size
               || space_info.available == k_unknown_size
               )
              ) && space_info.available >= maxFreeSpace
            )
        {
            maxFreeSpace = space_info.available;
            //confdir = s;
        }
        LOG(VB_GENERAL, LOG_NOTICE, QString(" cachedir      = %1 (%2, %3, %4)")
            .arg(s)
            .arg(space_info.available)
            .arg(space_info.free)
            .arg(space_info.capacity)
            );
    }
#endif
 
    appbindir = installprefix + "/";
    sharedir  = "assets:/mythtv/";
    libdir    = installprefix + "/";
 
#else
 
    if (installprefix.isEmpty())
    {
        QDir installdir {QCoreApplication::applicationDirPath()};
        installdir.cdUp();
        installprefix = installdir.absolutePath();
    }
 
    #ifdef Q_OS_DARWIN
        // Check to see if the installprefix directory exists, if it does not,
        // this is likely an APP bundle and so needs to be pointed
        // internally to the APP Bundle.
        if (! QDir(installprefix).exists())
            installprefix = QString("../Resources");
    #endif
 
    if (QDir(installprefix).isRelative())
    {
        // If the PREFIX is relative, evaluate it relative to our
        // executable directory. This can be fragile on Unix, so
        // use relative PREFIX values with care.
        QDir prefixDir {QCoreApplication::applicationDirPath()};
        LOG(VB_GENERAL, LOG_DEBUG, QString("Relative PREFIX! (%1), appDir=%2")
            .arg(installprefix, prefixDir.canonicalPath()));
 
        if (!prefixDir.cd(installprefix))
        {
            LOG(VB_GENERAL, LOG_ERR,
                QString("Relative PREFIX does not resolve, using %1")
                .arg(prefixDir.canonicalPath()));
        }
        installprefix = prefixDir.canonicalPath();
    }
 
    appbindir = installprefix + "/bin/";
    sharedir  = installprefix + "/share/mythtv/";
    libdir    = installprefix + '/' + QString(LIBDIRNAME) + "/mythtv/";
 
#endif
 
    if (confdir.isEmpty())
        confdir = QDir::homePath() + "/.mythtv";
 
    cachedir = confdir + "/cache";
    remotecachedir    = cachedir + "/remotecache";
    themebasecachedir = cachedir + "/themecache";
    thumbnaildir      = cachedir + "/thumbnails";
 
    themedir        = sharedir + "themes/";
    translationsdir = sharedir + "i18n/";
 
#ifdef Q_OS_ANDROID
    pluginsdir      = libdir;
#else
    pluginsdir      = libdir   + "plugins/";
#endif
 
    LOG(VB_GENERAL, LOG_NOTICE, "Using runtime prefix = " + installprefix);
    LOG(VB_GENERAL, LOG_NOTICE, QString("Using configuration directory = %1")
                                   .arg(confdir));
 
    LOG(VB_GENERAL, LOG_DEBUG, "appbindir         = "+ appbindir        );
    LOG(VB_GENERAL, LOG_DEBUG, "sharedir          = "+ sharedir         );
    LOG(VB_GENERAL, LOG_DEBUG, "libdir            = "+ libdir           );
    LOG(VB_GENERAL, LOG_DEBUG, "themedir          = "+ themedir         );
    LOG(VB_GENERAL, LOG_DEBUG, "pluginsdir        = "+ pluginsdir       );
    LOG(VB_GENERAL, LOG_DEBUG, "translationsdir   = "+ translationsdir  );
    LOG(VB_GENERAL, LOG_DEBUG, "confdir           = "+ confdir          );
    LOG(VB_GENERAL, LOG_DEBUG, "cachedir          = "+ cachedir         );
    LOG(VB_GENERAL, LOG_DEBUG, "remotecachedir    = "+ remotecachedir   );
    LOG(VB_GENERAL, LOG_DEBUG, "themebasecachedir = "+ themebasecachedir);
    LOG(VB_GENERAL, LOG_DEBUG, "thumbnaildir      = "+ thumbnaildir);
}
 
QString GetInstallPrefix(void) { return installprefix; }
QString GetAppBinDir(void) { return appbindir; }
QString GetShareDir(void) { return sharedir; }
QString GetLibraryDir(void) { return libdir; }
QString GetConfDir(void) { return confdir; }
QString GetThemesParentDir(void) { return themedir; }
QString GetPluginsDir(void) { return pluginsdir; }
QString GetTranslationsDir(void) { return translationsdir; }
 
QString GetCacheDir(void) { return cachedir; }
 
QString GetRemoteCacheDir(void) { return remotecachedir; }
 
QString GetThumbnailDir(void) { return thumbnaildir; }
 
QString GetThemeBaseCacheDir(void) { return themebasecachedir; }
 
// These defines provide portability for different
// plugin file names.
#ifdef Q_OS_DARWIN
static const QString kPluginLibPrefix = "lib";
static const QString kPluginLibSuffix = ".dylib";
#elif defined(Q_OS_WINDOWS)
static const QString kPluginLibPrefix = "lib";
static const QString kPluginLibSuffix = ".dll";
#elif defined(Q_OS_ANDROID)
static const QString kPluginLibPrefix = "libmythplugin";
static const QString kPluginLibSuffix = ".so";
#else
static const QString kPluginLibPrefix = "lib";
static const QString kPluginLibSuffix = ".so";
#endif
 
QString GetPluginsNameFilter(void)
{
    return kPluginLibPrefix + '*' + kPluginLibSuffix;
}
 
QString FindPluginName(const QString &plugname)
{
    return GetPluginsDir() + kPluginLibPrefix + plugname + kPluginLibSuffix;
}
 
QString GetTranslationsNameFilter(void)
{
    return "mythfrontend_*.qm";
}
 
QString FindTranslation(const QString &translation)
{
    return GetTranslationsDir()
           + "mythfrontend_" + translation.toLower() + ".qm";
}
 
QString GetFontsDir(void)
{
    return GetShareDir() + "fonts/";
}