Merge pull request #1737 from jamescowens/getdatadirfix

util: Fix braindamage in GetDefaultDataDir()

Author: jamescowens

src/init.cpp

@@ -427,7 +427,10 @@ void InitLogging()
     }
 
     if (!LogInstance().m_log_timestamps)
+    {
         LogPrintf("Startup time: %s\n", FormatISO8601DateTime(GetTime()));
+    }
+
     LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
     LogPrintf("Using data directory %s\n", GetDataDir().string());
 
@@ -741,10 +744,7 @@ bool AppInit2(ThreadHandlerPtr threads)
 #endif
 
     LogPrintf("Using OpenSSL version %s", SSLeay_version(SSLEAY_VERSION));
-    if (!fLogTimestamps)
-        LogPrintf("Startup time: %s", DateTimeStrFormat("%x %H:%M:%S",  GetAdjustedTime()));
-    LogPrintf("Default data directory %s", GetDefaultDataDir().string());
-    LogPrintf("Used data directory %s", datadir.string());
+
     std::ostringstream strErrors;
 
     fDevbuildCripple = false;

src/logging.cpp

@@ -16,8 +16,8 @@
 #include <mutex>
 #include <set>
 
-// Unavoidable because these are in util.h.
-extern fs::path &GetDataDir(bool fNetSpecific);
+// externs unavoidable because these are in util.h.
+extern fs::path &GetDataDir(bool fNetSpecific = true);
 extern bool GetBoolArg(const std::string& strArg, bool fDefault);
 extern int64_t GetArg(const std::string& strArg, int64_t nDefault);
 
@@ -374,7 +374,7 @@ bool BCLog::Logger::archive(bool fImmediate, fs::path pfile_out)
     boost::gregorian::date ArchiveCheckDate = boost::posix_time::from_time_t(nTime).date();
     fs::path plogfile;
     fs::path pfile_temp;
-    fs::path pathDataDir = GetDataDir(false);
+    fs::path pathDataDir = GetDataDir();
 
     std::stringstream ssArchiveCheckDate, ssPrevArchiveCheckDate;
 
@@ -512,4 +512,3 @@ bool BCLog::Logger::archive(bool fImmediate, fs::path pfile_out)
         return false; // archive condition was not satisfied. Do nothing and return false.
     }
 }
-

src/qt/guiutil.cpp

@@ -398,19 +398,9 @@ AutoStartupArguments GetAutoStartupArguments()
 
     AutoStartupArguments result;
 
-    // We can't use GetDataDir() here because it appends /testnet for
-    // testnet, which is correct for internal use, but not what we
-    // need for the command line argument. I think the fNetSpecific flag
-    // for GetDataDir is not coded right.
-    // TODO: Review GetDataDir() fix and replace this.
-    if (mapArgs.count("-datadir"))
-    {
-            result.data_dir = fs::system_complete(mapArgs["-datadir"]);
-            if (!fs::is_directory(result.data_dir))
-            {
-                result.data_dir = "";
-            }
-    }
+    // We do NOT want testnet appended here for the path in the autostart
+    // shortcut, so use false in GetDataDir().
+    result.data_dir = GetDataDir(false);
 
     result.arguments = "-min";
 

src/scraper/scraper.cpp

@@ -962,8 +962,7 @@ void Scraper(bool bSingleShot)
         pathScraper = pathDataDir  / "Scraper";
     }
 
-    // Initialize log singleton. Must be after the imbue.
-    ScraperLogInstance();
+    _log(logattribute::INFO, "Scraper", "Using data directory " + pathScraper.string());
 
     if (!bSingleShot)
         _log(logattribute::INFO, "Scraper", "Starting Scraper thread.");
@@ -1217,11 +1216,9 @@ void NeuralNetwork()
     {
         pathDataDir = GetDataDir();
         pathScraper = pathDataDir  / "Scraper";
-
-        // Initialize log singleton. Must be after the imbue.
-        ScraperLogInstance();
     }
 
+    _log(logattribute::INFO, "Scraper", "Using data directory " + pathScraper.string());
 
     _log(logattribute::INFO, "NeuralNetwork", "Starting Neural Network housekeeping thread (new C++ implementation). \n"
                                               "Note that this does NOT mean the NN is active. This simply does housekeeping "

src/util.cpp

@@ -545,98 +545,80 @@ fs::path AbsPathForConfigVal(const fs::path& path, bool net_specific)
 
 fs::path GetDefaultDataDir()
 {
-    // Windows < Vista: C:\Documents and Settings\Username\Application Data\gridcoinresearch
-    // Windows >= Vista: C:\Users\Username\AppData\Roaming\gridcoinresearch
-    // Mac: ~/Library/Application Support/gridcoinresearch
-    // Unix: ~/.gridcoin
+    // Windows < Vista: C:\Documents and Settings\Username\Application Data\GridcoinResearch
+    // Windows >= Vista: C:\Users\Username\AppData\Roaming\GridcoinResearch
+    // Mac: ~/Library/Application Support/GridcoinResearch
+    // Linux/Unix: ~/.GridcoinResearch
 #ifdef WIN32
     // Windows
+
+    // This is the user's base roaming AppData path with GridcoinResearch added.
     return GetSpecialFolderPath(CSIDL_APPDATA) / "GridcoinResearch";
 #else
-        //2-25-2015
-        fs::path pathRet;
-        char* pszHome = getenv("HOME");
+    fs::path pathRet;
 
-        if (mapArgs.count("-datadir"))
-        {
-            fs::path path2015 = fs::system_complete(mapArgs["-datadir"]);
-            if (fs::is_directory(path2015))
-            {
-                pathRet = path2015;
-            }
-        }
-        else
-        {
-            if (pszHome == NULL || strlen(pszHome) == 0)
-                pathRet = fs::path("/");
-            else
-                pathRet = fs::path(pszHome);
-        }
-#ifdef MAC_OSX
-    // Mac
-    pathRet /= "Library/Application Support";
-    fs::create_directory(pathRet);
+    // For everything except for Windows, use the environment variable to get
+    // the home path.
+    char* pszHome = getenv("HOME");
 
-    if (mapArgs.count("-datadir"))
-    {
-        return pathRet;
-    }
-    else
-    {
-        return pathRet / "GridcoinResearch";
+    // There is no home path, so default to the root directory.
+    if (pszHome == nullptr || strlen(pszHome) == 0) {
+        pathRet = fs::path("/");
+    } else {
+        pathRet = fs::path(pszHome);
     }
+#ifdef MAC_OSX
+    // The pathRet here represents the HOME directory. Apple
+    // applications are expected to store their files in
+    // "~/Library/Application Support/[AppDir].
+    return pathRet / "Library" / "Application Support" / "GridcoinResearch";
 #else
-    // Unix
-    if (mapArgs.count("-datadir"))
-    {
-        return pathRet;
-    }
-    else
-    {
-        return pathRet / ".GridcoinResearch";
-    }
-#endif
-#endif
+    // Linux/Unix
+    return pathRet / ".GridcoinResearch";
+#endif // MAC_OSX
+#endif // WIN32
 }
 
 const fs::path &GetDataDir(bool fNetSpecific)
 {
     static fs::path pathCached[2];
-    static CCriticalSection csPathCached;
+    static CCriticalSection cs_PathCached;
     static bool cachedPath[2] = {false, false};
-    //2-25-2015
+
     fs::path &path = pathCached[fNetSpecific];
 
     // This can be called during exceptions by LogPrintf, so we cache the
     // value so we don't have to do memory allocations after that.
-    if (cachedPath[fNetSpecific]  && (fs::is_directory(path))  )
+    if (cachedPath[fNetSpecific] && fs::is_directory(path))
     {
         return path;
     }
 
-    LOCK(csPathCached);
+    LOCK(cs_PathCached);
 
     if (mapArgs.count("-datadir"))
     {
             path = fs::system_complete(mapArgs["-datadir"]);
             if (!fs::is_directory(path))
             {
-                path = "";
-                return path;
+                throw std::runtime_error("Supplied datadir is invalid! "
+                                         "Please check your datadir argument. Aborting.");
             }
     }
     else
     {
         path = GetDefaultDataDir();
     }
-    if ( (fNetSpecific && GetBoolArg("-testnet", false))  ||  GetBoolArg("-testnet",false) )
+
+    if (fNetSpecific && GetBoolArg("-testnet", false))
     {
         path /= "testnet";
     }
 
     if (!fs::exists(path)) fs::create_directory(path);
 
-    cachedPath[fNetSpecific]=true;
+    cachedPath[fNetSpecific] = true;
+
     return path;
 }
 
@@ -687,7 +669,7 @@ fs::path GetProgramDir()
 fs::path GetConfigFile()
 {
     fs::path pathConfigFile(GetArg("-conf", "gridcoinresearch.conf"));
-    if (!pathConfigFile.is_absolute()) pathConfigFile = GetDataDir(false) / pathConfigFile;
+    if (!pathConfigFile.is_absolute()) pathConfigFile = GetDataDir() / pathConfigFile;
     return pathConfigFile;
 }