MAINT-8087: Use env vars from VMP for AppData\Roaming and Local.

On Windows, when logged in with a non-ASCII username, every one of the three
documented APIs -- SHGetSpecialFolderPath(), SHGetFolderPath() and
SHGetKnownFolderPath() -- fails to retrieve any pathname at all. We cannot
account for the fact that the oldest of these continues to work with the
release viewer and within a Python script (though not, curiously, from a
Python interactive session). With a non-ASCII username, they consistently fail
when called from an Alex Ivy viewer build: "The filename, directory name, or
volume label syntax is incorrect."

Empirically, with a non-ASCII username, the preset APPDATA and LOCALAPPDATA
environment variables are also useless, e.g. c:\Users\??????\AppData\Roaming
where those are, yup, actual question marks.

Empirically, the VMP is able to successfully call SHGetFolderPath() to
retrieve both AppData\Roaming and AppData\Local. Therefore, we make the VMP
set the APPDATA and LOCALAPPDATA environment variables to the UTF-8 encoded
correct pathnames. Instead of calling SHGetSomethingFolderPath() at all, make
LLDir_Win32 retrieve those environment variables.

Make LLFile::mkdir() treat "directory already exists" as a success case. Every
single call fell into one of two categories: either it didn't check success at
all, or it tested specially to exempt errno == EEXIST. Migrate that test into
mkdir(); eliminate it from call sites.

Make LLDir::append() and add() convenience functions accept variadic
arguments. Replace add(add()...) constructs, as well as clumsy concatenations
of directory names and getDirDelimiter(), with simple variadic add() calls.

5 files changed, 94 insertions, 126 deletions

diff --git a/indra/llvfs/lldir.cpp b/indra/llvfs/lldir.cpp
index b845de71fa..2069888774 100644
--- a/indra/llvfs/lldir.cpp
+++ b/indra/llvfs/lldir.cpp
@@ -597,7 +597,7 @@ std::string LLDir::getExpandedFilename(ELLPath location, const std::string& subd
 				<< "': prefix is empty, possible bad filename" << LL_ENDL;
 	}
 
-	std::string expanded_filename = add(add(prefix, subdir1), subdir2);
+	std::string expanded_filename = add(prefix, subdir1, subdir2);
 	if (expanded_filename.empty() && in_filename.empty())
 	{
 		return "";
@@ -693,7 +693,7 @@ void LLDir::walkSearchSkinDirs(const std::string& subdir,
 		std::string subdir_path(add(skindir, subdir));
 		BOOST_FOREACH(std::string subsubdir, subsubdirs)
 		{
-			std::string full_path(add(add(subdir_path, subsubdir), filename));
+			std::string full_path(add(subdir_path, subsubdir, filename));
 			if (fileExists(full_path))
 			{
 				function(subsubdir, full_path);
@@ -1052,13 +1052,6 @@ void LLDir::dumpCurrentDirectories()
 	LL_DEBUGS("AppInit","Directories") << "  SkinDir:               " << getSkinDir() << LL_ENDL;
 }
 
-std::string LLDir::add(const std::string& path, const std::string& name) const
-{
-	std::string destpath(path);
-	append(destpath, name);
-	return destpath;
-}
-
 void LLDir::append(std::string& destpath, const std::string& name) const
 {
 	// Delegate question of whether we need a separator to helper method.
diff --git a/indra/llvfs/lldir.h b/indra/llvfs/lldir.h
index b219c6e29f..e233413a7f 100644
--- a/indra/llvfs/lldir.h
+++ b/indra/llvfs/lldir.h
@@ -202,9 +202,28 @@ class LLDir
 	/// Append specified @a name to @a destpath, separated by getDirDelimiter()
 	/// if both are non-empty.
 	void append(std::string& destpath, const std::string& name) const;
-	/// Append specified @a name to @a path, separated by getDirDelimiter()
-	/// if both are non-empty. Return result, leaving @a path unmodified.
-	std::string add(const std::string& path, const std::string& name) const;
+	/// Variadic form: append @a name0 and @a name1 and arbitrary other @a
+	/// names to @a destpath, separated by getDirDelimiter() as needed.
+	template <typename... NAMES>
+	void append(std::string& destpath, const std::string& name0, const std::string& name1,
+				const NAMES& ... names) const
+	{
+		// In a typical recursion case, we'd accept (destpath, name0, names).
+		// We accept (destpath, name0, name1, names) because it's important to
+		// delegate the two-argument case to the non-template implementation.
+		append(destpath, name0);
+		append(destpath, name1, names...);
+	}
+
+	/// Append specified @a names to @a path, separated by getDirDelimiter()
+	/// as needed. Return result, leaving @a path unmodified.
+	template <typename... NAMES>
+	std::string add(const std::string& path, const NAMES& ... names) const
+	{
+		std::string destpath(path);
+		append(destpath, names...);
+		return destpath;
+	}
 
 protected:
 	// Does an add() or append() call need a directory delimiter?
diff --git a/indra/llvfs/lldir_linux.cpp b/indra/llvfs/lldir_linux.cpp
index 7a4034c228..a9f3166d41 100644
--- a/indra/llvfs/lldir_linux.cpp
+++ b/indra/llvfs/lldir_linux.cpp
@@ -185,41 +185,29 @@ void LLDir_Linux::initAppDirs(const std::string &app_name,
 	int res = LLFile::mkdir(mOSUserAppDir);
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create app user dir " << mOSUserAppDir << LL_ENDL;
-			LL_WARNS() << "Default to base dir" << mOSUserDir << LL_ENDL;
-			mOSUserAppDir = mOSUserDir;
-		}
+		LL_WARNS() << "Couldn't create app user dir " << mOSUserAppDir << LL_ENDL;
+		LL_WARNS() << "Default to base dir" << mOSUserDir << LL_ENDL;
+		mOSUserAppDir = mOSUserDir;
 	}
 
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_LOGS,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_LOGS dir " << getExpandedFilename(LL_PATH_LOGS,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_LOGS dir " << getExpandedFilename(LL_PATH_LOGS,"") << LL_ENDL;
 	}
 	
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_USER_SETTINGS,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_USER_SETTINGS dir " << getExpandedFilename(LL_PATH_USER_SETTINGS,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_USER_SETTINGS dir " << getExpandedFilename(LL_PATH_USER_SETTINGS,"") << LL_ENDL;
 	}
-	
+
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_CACHE,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << getExpandedFilename(LL_PATH_CACHE,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << getExpandedFilename(LL_PATH_CACHE,"") << LL_ENDL;
 	}
-	
+
 	mCAFile = getExpandedFilename(LL_PATH_APP_SETTINGS, "CA.pem");
 }
 
diff --git a/indra/llvfs/lldir_solaris.cpp b/indra/llvfs/lldir_solaris.cpp
index b43b2f27ce..d60237bacc 100644
--- a/indra/llvfs/lldir_solaris.cpp
+++ b/indra/llvfs/lldir_solaris.cpp
@@ -203,41 +203,29 @@ void LLDir_Solaris::initAppDirs(const std::string &app_name,
 	int res = LLFile::mkdir(mOSUserAppDir);
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create app user dir " << mOSUserAppDir << LL_ENDL;
-			LL_WARNS() << "Default to base dir" << mOSUserDir << LL_ENDL;
-			mOSUserAppDir = mOSUserDir;
-		}
+		LL_WARNS() << "Couldn't create app user dir " << mOSUserAppDir << LL_ENDL;
+		LL_WARNS() << "Default to base dir" << mOSUserDir << LL_ENDL;
+		mOSUserAppDir = mOSUserDir;
 	}
 
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_LOGS,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_LOGS dir " << getExpandedFilename(LL_PATH_LOGS,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_LOGS dir " << getExpandedFilename(LL_PATH_LOGS,"") << LL_ENDL;
 	}
 	
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_USER_SETTINGS,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_USER_SETTINGS dir " << getExpandedFilename(LL_PATH_USER_SETTINGS,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_USER_SETTINGS dir " << getExpandedFilename(LL_PATH_USER_SETTINGS,"") << LL_ENDL;
 	}
-	
+
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_CACHE,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << getExpandedFilename(LL_PATH_CACHE,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << getExpandedFilename(LL_PATH_CACHE,"") << LL_ENDL;
 	}
-	
+
 	mCAFile = getExpandedFilename(LL_PATH_APP_SETTINGS, "CA.pem");
 }
 
diff --git a/indra/llvfs/lldir_win32.cpp b/indra/llvfs/lldir_win32.cpp
index 4d8aa0e189..5485349c83 100644
--- a/indra/llvfs/lldir_win32.cpp
+++ b/indra/llvfs/lldir_win32.cpp
@@ -32,10 +32,7 @@
 #include "llerror.h"
 #include "llrand.h"		// for gLindenLabRandomNumber
 #include <shlobj.h>
-#include <Knownfolders.h>
-#include <iostream>
-#include <map>
-#include <Objbase.h>                // CoTaskMemFree()
+#include <fstream>
 
 #include <direct.h>
 #include <errno.h>
@@ -46,47 +43,15 @@
 #define PACKVERSION(major,minor) MAKELONG(minor,major)
 DWORD GetDllVersion(LPCTSTR lpszDllName);
 
-namespace {
-
-std::string getKnownFolderPath(const std::string& desc, REFKNOWNFOLDERID folderid)
-{
-    // https://msdn.microsoft.com/en-us/library/windows/desktop/bb762188(v=vs.85).aspx
-    PWSTR wstrptr = 0;
-    HRESULT result = SHGetKnownFolderPath(
-        folderid,
-        KF_FLAG_DEFAULT,            // no flags
-        NULL,                       // current user, no impersonation
-        &wstrptr);
-    if (result == S_OK)
-    {
-        std::string utf8 = utf16str_to_utf8str(llutf16string(wstrptr));
-        // have to free the returned pointer after copying its data
-        CoTaskMemFree(wstrptr);
-        return utf8;
-    }
-
-    // gack, no logging yet!
-    // at least say something to a developer trying to debug this...
-    static std::map<HRESULT, const char*> codes
-    {
-        { E_FAIL, "E_FAIL; known folder does not have a path?" },
-        { E_INVALIDARG, "E_INVALIDARG; not present on system?" }
-    };
-    auto found = codes.find(result);
-    const char* text = (found == codes.end())? "unknown" : found->second;
-    std::cout << "*** SHGetKnownFolderPath(" << desc << ") failed with "
-              << result << " (" << text << ")\n";
-    return {};
-}
-
-} // anonymous namespace
-
 LLDir_Win32::LLDir_Win32()
 {
+	// set this first: used by append() and add() methods
 	mDirDelimiter = "\\";
 
-	// Application Data is where user settings go
-	mOSUserDir = getKnownFolderPath("RoamingAppData", FOLDERID_RoamingAppData);
+	// Application Data is where user settings go. We rely on $APPDATA being
+	// correct; in fact the VMP makes a point of setting it properly, since
+	// Windows itself botches the job for non-ASCII usernames (MAINT-8087).
+	mOSUserDir = ll_safe_string(getenv("APPDATA"));
 
 	// We want cache files to go on the local disk, even if the
 	// user is on a network with a "roaming profile".
@@ -96,7 +61,7 @@ LLDir_Win32::LLDir_Win32()
 	//
 	// We used to store the cache in AppData\Roaming, and the installer
 	// cleans up that version on upgrade.  JC
-	mOSCacheDir = getKnownFolderPath("LocalAppData", FOLDERID_LocalAppData);
+	mOSCacheDir = ll_safe_string(getenv("LOCALAPPDATA"));
 
 	WCHAR w_str[MAX_PATH];
 	if (GetTempPath(MAX_PATH, w_str))
@@ -122,6 +87,38 @@ LLDir_Win32::LLDir_Win32()
 		mTempDir = mOSUserDir;
 	}
 
+/*==========================================================================*|
+	// Now that we've got mOSUserDir, one way or another, let's see how we did
+	// with our environment variables.
+	{
+		auto report = [this](std::ostream& out){
+			out << "mOSUserDir  = '" << mOSUserDir  << "'\n"
+				<< "mOSCacheDir = '" << mOSCacheDir << "'\n"
+				<< "mTempDir    = '" << mTempDir    << "'" << std::endl;
+		};
+		int res = LLFile::mkdir(mOSUserDir);
+		if (res == -1)
+		{
+			// If we couldn't even create the directory, just blurt to stderr
+			report(std::cerr);
+		}
+		else
+		{
+			// successfully created logdir, plunk a log file there
+			std::string logfilename(add(mOSUserDir, "lldir.log"));
+			std::ofstream logfile(logfilename.c_str());
+			if (! logfile.is_open())
+			{
+				report(std::cerr);
+			}
+			else
+			{
+				report(logfile);
+			}
+		}
+	}
+|*==========================================================================*/
+
 //	fprintf(stderr, "mTempDir = <%s>",mTempDir);
 
 	// Set working directory, for LLDir::getWorkingDir()
@@ -167,7 +164,7 @@ LLDir_Win32::LLDir_Win32()
 	// 'llplugin' need to go somewhere else.
 	// alas... this also gets called during static initialization 
 	// time due to the construction of gDirUtil in lldir.cpp.
-	if(! LLFile::isdir(mAppRODataDir + mDirDelimiter + "skins"))
+	if(! LLFile::isdir(add(mAppRODataDir, "skins")))
 	{
 		// What? No skins in the working dir?
 		// Try the executable's directory.
@@ -176,7 +173,7 @@ LLDir_Win32::LLDir_Win32()
 
 //	LL_INFOS() << "mAppRODataDir = " << mAppRODataDir << LL_ENDL;
 
-	mSkinBaseDir = mAppRODataDir + mDirDelimiter + "skins";
+	mSkinBaseDir = add(mAppRODataDir, "skins");
 
 	// Build the default cache directory
 	mDefaultCacheDir = buildSLOSCacheDir();
@@ -185,13 +182,10 @@ LLDir_Win32::LLDir_Win32()
 	int res = LLFile::mkdir(mDefaultCacheDir);
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << mDefaultCacheDir << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << mDefaultCacheDir << LL_ENDL;
 	}
 
-	mLLPluginDir = mExecutableDir + mDirDelimiter + "llplugin";
+	mLLPluginDir = add(mExecutableDir, "llplugin");
 }
 
 LLDir_Win32::~LLDir_Win32()
@@ -207,52 +201,38 @@ void LLDir_Win32::initAppDirs(const std::string &app_name,
 	if (!app_read_only_data_dir.empty())
 	{
 		mAppRODataDir = app_read_only_data_dir;
-		mSkinBaseDir = mAppRODataDir + mDirDelimiter + "skins";
+		mSkinBaseDir = add(mAppRODataDir, "skins");
 	}
 	mAppName = app_name;
-	mOSUserAppDir = mOSUserDir;
-	mOSUserAppDir += "\\";
-	mOSUserAppDir += app_name;
+	mOSUserAppDir = add(mOSUserDir, app_name);
 
 	int res = LLFile::mkdir(mOSUserAppDir);
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create app user dir " << mOSUserAppDir << LL_ENDL;
-			LL_WARNS() << "Default to base dir" << mOSUserDir << LL_ENDL;
-			mOSUserAppDir = mOSUserDir;
-		}
+		LL_WARNS() << "Couldn't create app user dir " << mOSUserAppDir << LL_ENDL;
+		LL_WARNS() << "Default to base dir" << mOSUserDir << LL_ENDL;
+		mOSUserAppDir = mOSUserDir;
 	}
 	//dumpCurrentDirectories();
 
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_LOGS,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_LOGS dir " << getExpandedFilename(LL_PATH_LOGS,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_LOGS dir " << getExpandedFilename(LL_PATH_LOGS,"") << LL_ENDL;
 	}
-	
+
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_USER_SETTINGS,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_USER_SETTINGS dir " << getExpandedFilename(LL_PATH_USER_SETTINGS,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_USER_SETTINGS dir " << getExpandedFilename(LL_PATH_USER_SETTINGS,"") << LL_ENDL;
 	}
-	
+
 	res = LLFile::mkdir(getExpandedFilename(LL_PATH_CACHE,""));
 	if (res == -1)
 	{
-		if (errno != EEXIST)
-		{
-			LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << getExpandedFilename(LL_PATH_CACHE,"") << LL_ENDL;
-		}
+		LL_WARNS() << "Couldn't create LL_PATH_CACHE dir " << getExpandedFilename(LL_PATH_CACHE,"") << LL_ENDL;
 	}
-	
+
 	mCAFile = getExpandedFilename(LL_PATH_APP_SETTINGS, "CA.pem");
 }