1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#include "SettingsComponent.h"
#include "CompileInfo.h"
#include "ServiceBroker.h"
#include "Util.h"
#include "application/AppParams.h"
#include "filesystem/Directory.h"
#include "filesystem/SpecialProtocol.h"
#ifdef TARGET_DARWIN_EMBEDDED
#include "platform/darwin/ios-common/DarwinEmbedUtils.h"
#endif
#ifdef TARGET_WINDOWS
#include "platform/Environment.h"
#endif
#include "profiles/ProfileManager.h"
#include "settings/AdvancedSettings.h"
#include "settings/Settings.h"
#include "settings/SubtitlesSettings.h"
#include "utils/DateLib.h"
#include "utils/StringUtils.h"
#include "utils/URIUtils.h"
#include "utils/log.h"
#ifdef TARGET_WINDOWS
#include "win32util.h"
#endif
CSettingsComponent::CSettingsComponent()
: m_settings(new CSettings()),
m_advancedSettings(new CAdvancedSettings()),
m_subtitlesSettings(new KODI::SUBTITLES::CSubtitlesSettings(m_settings)),
m_profileManager(new CProfileManager())
{
}
CSettingsComponent::~CSettingsComponent()
{
}
void CSettingsComponent::Initialize()
{
if (m_state == State::DEINITED)
{
const auto params = CServiceBroker::GetAppParams();
// only the InitDirectories* for the current platform should return true
bool inited = InitDirectoriesLinux(params->HasPlatformDirectories());
if (!inited)
inited = InitDirectoriesOSX(params->HasPlatformDirectories());
if (!inited)
inited = InitDirectoriesWin32(params->HasPlatformDirectories());
// Try loading timezone information after directories were provisioned
//!@todo check if the whole dirs logic should be moved to AppEnvironment
KODI::TIME::LoadTimeZoneDatabase();
m_settings->Initialize();
m_advancedSettings->Initialize(*m_settings->GetSettingsManager());
URIUtils::RegisterAdvancedSettings(*m_advancedSettings);
m_profileManager->Initialize(m_settings);
m_state = State::INITED;
}
}
bool CSettingsComponent::Load()
{
if (m_state == State::INITED)
{
if (!m_profileManager->Load())
{
CLog::Log(LOGFATAL, "unable to load profile");
return false;
}
CSpecialProtocol::RegisterProfileManager(*m_profileManager);
XFILE::IDirectory::RegisterProfileManager(*m_profileManager);
if (!m_settings->Load())
{
CLog::Log(LOGFATAL, "unable to load settings");
return false;
}
m_settings->SetLoaded();
m_state = State::LOADED;
return true;
}
else if (m_state == State::LOADED)
{
return true;
}
else
{
return false;
}
}
void CSettingsComponent::Deinitialize()
{
if (m_state >= State::INITED)
{
if (m_state == State::LOADED)
{
m_subtitlesSettings.reset();
m_settings->Unload();
XFILE::IDirectory::UnregisterProfileManager();
CSpecialProtocol::UnregisterProfileManager();
}
m_profileManager->Uninitialize();
URIUtils::UnregisterAdvancedSettings();
m_advancedSettings->Uninitialize(*m_settings->GetSettingsManager());
m_settings->Uninitialize();
}
m_state = State::DEINITED;
}
std::shared_ptr<CSettings> CSettingsComponent::GetSettings()
{
return m_settings;
}
std::shared_ptr<CAdvancedSettings> CSettingsComponent::GetAdvancedSettings()
{
return m_advancedSettings;
}
std::shared_ptr<KODI::SUBTITLES::CSubtitlesSettings> CSettingsComponent::GetSubtitlesSettings()
{
return m_subtitlesSettings;
}
std::shared_ptr<CProfileManager> CSettingsComponent::GetProfileManager()
{
return m_profileManager;
}
bool CSettingsComponent::InitDirectoriesLinux(bool bPlatformDirectories)
{
/*
The following is the directory mapping for Platform Specific Mode:
special://xbmc/ => [read-only] system directory (/usr/share/kodi)
special://home/ => [read-write] user's directory that will override special://kodi/ system-wide
installations like skins, screensavers, etc.
($HOME/.kodi)
NOTE: XBMC will look in both special://xbmc/addons and special://home/addons for addons.
special://masterprofile/ => [read-write] userdata of master profile. It will by default be
mapped to special://home/userdata ($HOME/.kodi/userdata)
special://profile/ => [read-write] current profile's userdata directory.
Generally special://masterprofile for the master profile or
special://masterprofile/profiles/<profile_name> for other profiles.
NOTE: All these root directories are lowercase. Some of the sub-directories
might be mixed case.
*/
#if defined(TARGET_POSIX) && !defined(TARGET_DARWIN)
std::string appPath;
std::string appName = CCompileInfo::GetAppName();
std::string dotLowerAppName = "." + appName;
StringUtils::ToLower(dotLowerAppName);
const char* envAppHome = "KODI_HOME";
const char* envAppBinHome = "KODI_BIN_HOME";
const char* envAppTemp = "KODI_TEMP";
std::string userHome;
if (getenv("KODI_DATA"))
userHome = getenv("KODI_DATA");
else if (getenv("HOME"))
{
userHome = getenv("HOME");
userHome.append("/" + dotLowerAppName);
}
else
{
userHome = "/root";
userHome.append("/" + dotLowerAppName);
}
std::string strTempPath;
if (getenv(envAppTemp))
strTempPath = getenv(envAppTemp);
else
strTempPath = userHome + "/temp";
std::string binaddonAltDir;
if (getenv("KODI_BINADDON_PATH"))
binaddonAltDir = getenv("KODI_BINADDON_PATH");
auto appBinPath = CUtil::GetHomePath(envAppBinHome);
// overridden by user
if (getenv(envAppHome))
appPath = getenv(envAppHome);
else
{
// use build time default
appPath = INSTALL_PATH;
/* Check if binaries and arch independent data files are being kept in
* separate locations. */
if (!XFILE::CDirectory::Exists(URIUtils::AddFileToFolder(appPath, "userdata")))
{
/* Attempt to locate arch independent data files. */
appPath = CUtil::GetHomePath(appBinPath);
if (!XFILE::CDirectory::Exists(URIUtils::AddFileToFolder(appPath, "userdata")))
{
fprintf(stderr, "Unable to find path to %s data files!\n", appName.c_str());
exit(1);
}
}
}
/* Set some environment variables */
setenv(envAppBinHome, appBinPath.c_str(), 0);
setenv(envAppHome, appPath.c_str(), 0);
if (bPlatformDirectories)
{
// map our special drives
CSpecialProtocol::SetXBMCBinPath(appBinPath);
CSpecialProtocol::SetXBMCAltBinAddonPath(binaddonAltDir);
CSpecialProtocol::SetXBMCPath(appPath);
CSpecialProtocol::SetHomePath(userHome);
CSpecialProtocol::SetMasterProfilePath(userHome + "/userdata");
CSpecialProtocol::SetTempPath(strTempPath);
CSpecialProtocol::SetLogPath(strTempPath);
CreateUserDirs();
}
else
{
URIUtils::AddSlashAtEnd(appPath);
CSpecialProtocol::SetXBMCBinPath(appBinPath);
CSpecialProtocol::SetXBMCAltBinAddonPath(binaddonAltDir);
CSpecialProtocol::SetXBMCPath(appPath);
CSpecialProtocol::SetHomePath(URIUtils::AddFileToFolder(appPath, "portable_data"));
CSpecialProtocol::SetMasterProfilePath(URIUtils::AddFileToFolder(appPath, "portable_data/userdata"));
std::string strTempPath = appPath;
strTempPath = URIUtils::AddFileToFolder(strTempPath, "portable_data/temp");
if (getenv(envAppTemp))
strTempPath = getenv(envAppTemp);
CSpecialProtocol::SetTempPath(strTempPath);
CSpecialProtocol::SetLogPath(strTempPath);
CreateUserDirs();
}
CSpecialProtocol::SetXBMCBinAddonPath(appBinPath + "/addons");
return true;
#else
return false;
#endif
}
bool CSettingsComponent::InitDirectoriesOSX(bool bPlatformDirectories)
{
#if defined(TARGET_DARWIN)
std::string userHome;
if (getenv("HOME"))
userHome = getenv("HOME");
else
userHome = "/root";
std::string binaddonAltDir;
if (getenv("KODI_BINADDON_PATH"))
binaddonAltDir = getenv("KODI_BINADDON_PATH");
std::string appPath = CUtil::GetHomePath();
setenv("KODI_HOME", appPath.c_str(), 0);
#if defined(TARGET_DARWIN_EMBEDDED)
std::string fontconfigPath;
fontconfigPath = appPath + "/system/players/VideoPlayer/etc/fonts/fonts.conf";
setenv("FONTCONFIG_FILE", fontconfigPath.c_str(), 0);
#endif
// setup path to our internal dylibs so loader can find them
std::string frameworksPath = CUtil::GetFrameworksPath();
CSpecialProtocol::SetXBMCFrameworksPath(frameworksPath);
if (bPlatformDirectories)
{
// map our special drives
CSpecialProtocol::SetXBMCBinPath(appPath);
CSpecialProtocol::SetXBMCAltBinAddonPath(binaddonAltDir);
CSpecialProtocol::SetXBMCPath(appPath);
#if defined(TARGET_DARWIN_EMBEDDED)
std::string appName = CCompileInfo::GetAppName();
CSpecialProtocol::SetHomePath(userHome + "/" + CDarwinEmbedUtils::GetAppRootFolder() + "/" +
appName);
CSpecialProtocol::SetMasterProfilePath(userHome + "/" + CDarwinEmbedUtils::GetAppRootFolder() +
"/" + appName + "/userdata");
#else
std::string appName = CCompileInfo::GetAppName();
CSpecialProtocol::SetHomePath(userHome + "/Library/Application Support/" + appName);
CSpecialProtocol::SetMasterProfilePath(userHome + "/Library/Application Support/" + appName + "/userdata");
#endif
std::string dotLowerAppName = "." + appName;
StringUtils::ToLower(dotLowerAppName);
// location for temp files
#if defined(TARGET_DARWIN_EMBEDDED)
std::string strTempPath = URIUtils::AddFileToFolder(
userHome, std::string(CDarwinEmbedUtils::GetAppRootFolder()) + "/" + appName + "/temp");
#else
std::string strTempPath = URIUtils::AddFileToFolder(userHome, dotLowerAppName + "/");
XFILE::CDirectory::Create(strTempPath);
strTempPath = URIUtils::AddFileToFolder(userHome, dotLowerAppName + "/temp");
#endif
CSpecialProtocol::SetTempPath(strTempPath);
// xbmc.log file location
#if defined(TARGET_DARWIN_EMBEDDED)
strTempPath = userHome + "/" + std::string(CDarwinEmbedUtils::GetAppRootFolder());
#else
strTempPath = userHome + "/Library/Logs";
#endif
CSpecialProtocol::SetLogPath(strTempPath);
CreateUserDirs();
}
else
{
URIUtils::AddSlashAtEnd(appPath);
CSpecialProtocol::SetXBMCBinPath(appPath);
CSpecialProtocol::SetXBMCAltBinAddonPath(binaddonAltDir);
CSpecialProtocol::SetXBMCPath(appPath);
CSpecialProtocol::SetHomePath(URIUtils::AddFileToFolder(appPath, "portable_data"));
CSpecialProtocol::SetMasterProfilePath(URIUtils::AddFileToFolder(appPath, "portable_data/userdata"));
std::string strTempPath = URIUtils::AddFileToFolder(appPath, "portable_data/temp");
CSpecialProtocol::SetTempPath(strTempPath);
CSpecialProtocol::SetLogPath(strTempPath);
CreateUserDirs();
}
CSpecialProtocol::SetXBMCBinAddonPath(appPath + "/addons");
return true;
#else
return false;
#endif
}
bool CSettingsComponent::InitDirectoriesWin32(bool bPlatformDirectories)
{
#ifdef TARGET_WINDOWS
std::string xbmcPath = CUtil::GetHomePath();
CEnvironment::setenv("KODI_HOME", xbmcPath);
CSpecialProtocol::SetXBMCBinPath(xbmcPath);
CSpecialProtocol::SetXBMCPath(xbmcPath);
CSpecialProtocol::SetXBMCBinAddonPath(xbmcPath + "/addons");
std::string strWin32UserFolder = CWIN32Util::GetProfilePath(bPlatformDirectories);
CSpecialProtocol::SetLogPath(strWin32UserFolder);
CSpecialProtocol::SetHomePath(strWin32UserFolder);
CSpecialProtocol::SetMasterProfilePath(URIUtils::AddFileToFolder(strWin32UserFolder, "userdata"));
CSpecialProtocol::SetTempPath(URIUtils::AddFileToFolder(strWin32UserFolder,"cache"));
CEnvironment::setenv("KODI_PROFILE_USERDATA", CSpecialProtocol::TranslatePath("special://masterprofile/"));
CreateUserDirs();
return true;
#else
return false;
#endif
}
void CSettingsComponent::CreateUserDirs() const
{
XFILE::CDirectory::Create("special://home/");
XFILE::CDirectory::Create("special://home/addons");
XFILE::CDirectory::Create("special://home/addons/packages");
XFILE::CDirectory::Create("special://home/addons/temp");
XFILE::CDirectory::Create("special://home/media");
XFILE::CDirectory::Create("special://home/system");
XFILE::CDirectory::Create("special://masterprofile/");
XFILE::CDirectory::Create("special://temp/");
XFILE::CDirectory::Create("special://logpath");
XFILE::CDirectory::Create("special://temp/temp"); // temp directory for python and dllGetTempPathA
//Let's clear our archive cache before starting up anything more
auto archiveCachePath = CSpecialProtocol::TranslatePath("special://temp/archive_cache/");
if (XFILE::CDirectory::Exists(archiveCachePath))
if (!XFILE::CDirectory::RemoveRecursive(archiveCachePath))
CLog::Log(LOGWARNING, "Failed to remove the archive cache at {}", archiveCachePath);
XFILE::CDirectory::Create(archiveCachePath);
}
|