User directory config files #534
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /** @file | ||
| @brief Auto-generated configuration header - do not edit! | ||
|
There was a problem hiding this comment. This header file isn't auto-generated. There was a problem hiding this comment. updated the comment |
||
|
|
||
| @date 2015 | ||
|
|
||
| @author | ||
| Sensics, Inc. | ||
| <http://sensics.com/osvr> | ||
| */ | ||
|
|
||
| // Copyright 2015 Sensics, Inc. | ||
|
|
||
| // | ||
| // 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. | ||
|
|
||
| #ifndef INCLUDED_ConfigFilePaths_h_GUID_241E9C9C_0E0E_46B0_9DED_8F8059306192 | ||
| #define INCLUDED_ConfigFilePaths_h_GUID_241E9C9C_0E0E_46B0_9DED_8F8059306192 | ||
|
|
||
| // Internal Includes | ||
| #include <osvr/Server/Export.h> | ||
|
|
||
| // Library/third-party includes | ||
| // - none | ||
|
|
||
| // Standard includes | ||
| #include <vector> | ||
|
|
||
|
There was a problem hiding this comment. Don't forget |
||
| namespace osvr { | ||
| namespace server { | ||
|
|
||
| /// @brief this returns a vector of default server configuration file paths. | ||
| OSVR_SERVER_EXPORT std::vector<std::string> getDefaultConfigFilePaths(); | ||
| } | ||
| } | ||
| #endif // INCLUDED_ConfigFilePaths_h_GUID_241E9C9C_0E0E_46B0_9DED_8F8059306192 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| // Internal Includes | ||
|
There was a problem hiding this comment. Add standard copyright header. There was a problem hiding this comment. date and indentation don't match but... |
||
| #include <osvr/Util/PlatformConfig.h> | ||
| #include <osvr/Server/ConfigFilePaths.h> | ||
| #include <osvr/Server/ConfigureServerFromFile.h> | ||
| #include <osvr/Util/GetEnvironmentVariable.h> | ||
|
|
||
| // Library/third-party includes | ||
| #include <boost/filesystem.hpp> | ||
|
|
||
| // Standard includes | ||
| #include <vector> | ||
|
|
||
| namespace osvr { | ||
| namespace server { | ||
|
|
||
| inline std::string getUserConfigDirectory() { | ||
| namespace fs = boost::filesystem; | ||
| using osvr::util::getEnvironmentVariable; | ||
|
|
||
| fs::path configDir; | ||
| std::string configSubpath = "config"; | ||
|
|
||
| #if defined(OSVR_LINUX) | ||
| // There's currently no great location for storing log files in the | ||
|
There was a problem hiding this comment. We can delete the first paragraph of the comment and update the second para to reflect |
||
| // XDG system. (See the STATE proposal by Debian | ||
| // <https://wiki.debian.org/XDGBaseDirectorySpecification#Proposal:_STATE_directory>.) | ||
| // So for now, we'll store our log files in the $XDG_CACHE_HOME | ||
| // directory. | ||
| // | ||
| // $XDG_CACHE_HOME defines the base directory relative to which user | ||
| // specific non-essential data files should be stored. If | ||
| // $XDG_CACHE_HOME is either not set or empty, a default equal to | ||
|
There was a problem hiding this comment.
|
||
| // $HOME/.cache should be used. | ||
|
There was a problem hiding this comment.
|
||
| auto xdg_cache_dir = getEnvironmentVariable("XDG_CONFIG_HOME"); | ||
|
There was a problem hiding this comment. On Linux, if you're searching for an existing configuration file (as opposed to determining where to write a new one), then you will want to check the
There was a problem hiding this comment. I'm going to put this as a TODO for now. The function this is in currently only returns one directory, and this change would require it to return multiple directories. |
||
| if (xdg_cache_dir) { | ||
| configDir = *xdg_cache_dir; | ||
| } | ||
| else { | ||
| auto home_dir = getEnvironmentVariable("HOME"); | ||
| configDir = fs::path(*home_dir) / ".config"; | ||
| } | ||
| configDir /= fs::path("osvr"); | ||
| #elif defined(OSVR_MACOSX) | ||
| auto home_dir = getEnvironmentVariable("HOME"); | ||
| if (home_dir) { | ||
| configDir = *home_dir; | ||
| } | ||
| configDir /= "Library" / fs::path("Application Support") / fs::path("OSVR") / configSubpath; | ||
| #elif defined(OSVR_WINDOWS) | ||
| /// @todo there's actually a win32 api call to get localappdata | ||
| /// that's preferred to the env var. | ||
| auto local_app_dir = getEnvironmentVariable("LocalAppData"); | ||
| if (local_app_dir) { | ||
| configDir = *local_app_dir; | ||
| } | ||
| else { | ||
| configDir = "c:/"; | ||
| } | ||
| configDir /= fs::path("OSVR") / configSubpath; | ||
| #endif | ||
|
|
||
| return configDir.string(); | ||
| } | ||
|
|
||
| std::vector<std::string> getDefaultConfigFilePaths() { | ||
| namespace fs = boost::filesystem; | ||
| std::vector<std::string> names; | ||
| std::string configFileName = getDefaultConfigFilename(); | ||
|
|
||
| fs::path userConfigDirectory(getUserConfigDirectory()); | ||
| auto userConfig = userConfigDirectory / configFileName; | ||
|
|
||
| names.push_back(userConfig.string()); | ||
| names.push_back(configFileName); | ||
|
|
||
|
There was a problem hiding this comment. There are more places worth checking, too. On Linux:
On macOS:
There was a problem hiding this comment. Moved to new issue: #537 |
||
| return names; | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is the word "files" here a typo?