refactored database path creation

Author: dorin-ga

source/gameanalytics/GAStore.cpp

@@ -207,48 +207,69 @@ namespace gameanalytics
             return sqlDatabase;
         }
 
-        bool GAStore::fixOldDatabase()
+        bool GAStore::fixOldDatabaseIfRequired()
         {
-            std::string oldPath = device::GADevice::getWritablePath() + "/ga.sqlite3";
-            std::string newPath = device::GADevice::getWritablePath() + "/" + state::GAState::getGameKey() + "/ga.sqlite3";
-            if(std::filesystem::exists(oldPath) && !std::filesystem::exists(newPath))
+            std::filesystem::path oldPath  = dbPath;
+            std::filesystem::path filename = oldPath.filename();
+            
+            // get location of the faulty database
+            oldPath = oldPath.parent_path() / ".." / filename;
+            
+            // check if no new database exists
+            if(std::filesystem::exists(oldPath) && !std::filesystem::exists(dbPath))
             {
-                std::filesystem::rename(oldPath, newPath);
-                return true;
+                std::error_code ec = {};
+                
+                // move the database to the correct location
+                std::filesystem::rename(oldPath, dbPath, ec);
+                
+                return ec.value() != 0;
             }
 
             return false;
         }
-
-        bool GAStore::ensureDatabase(bool dropDatabase, std::string const& key)
+    
+        bool GAStore::initDatabaseLocation()
         {
-            // lazy creation of db path
-            if(getInstance().dbPath.empty())
+            constexpr const char* DATABASE_NAME = "ga.sqlite3";
+            
+            // get writable path for this platform
+            std::filesystem::path p = device::GADevice::getWritablePath();
+            
+            // get an unique game folder using the game key
+            p /= state::GAState::getGameKey();
+            
+            dbPath = (p / DATABASE_NAME).string();
+            
+            // check if the directory already exists
+            if(!std::filesystem::exists(p))
             {
-                std::string dir  = device::GADevice::getWritablePath() + "/" + key;
-                if(!std::filesystem::exists(dir))
-                {
-                    std::filesystem::create_directory(dir);
-                }
+                // check if the directory has been created
+                if(!std::filesystem::create_directory(p))
+                    return false;
 
-                std::string path = dir + "/ga.sqlite3";
-                getInstance().dbPath = path;
+                fixOldDatabaseIfRequired();
             }
 
-            const std::string dbPath = getInstance().dbPath;
-            const bool shouldFixDb   = getInstance().fixOldDatabase();
+            return true;
+        }
 
+        bool GAStore::ensureDatabase(bool dropDatabase, std::string const& key)
+        {
+            // lazy creation of db path
+            getInstance().initDatabaseLocation();
+            
             // Open database
-            if (sqlite3_open(dbPath.c_str(), &getInstance().sqlDatabase) != SQLITE_OK)
+            if (sqlite3_open(getInstance().dbPath.c_str(), &getInstance().sqlDatabase) != SQLITE_OK)
             {
                 getInstance().dbReady = false;
-                logging::GALogger::w("Could not open database: %s", dbPath.c_str());
+                logging::GALogger::w("Could not open database: %s", getInstance().dbPath.c_str());
                 return false;
             }
             else
             {
                 getInstance().dbReady = true;
-                logging::GALogger::i("Database opened: %s", dbPath.c_str());
+                logging::GALogger::i("Database opened: %s", getInstance().dbPath.c_str());
             }
 
             if (dropDatabase)

source/gameanalytics/GAStore.h

@@ -50,8 +50,10 @@ namespace gameanalytics
 
             static GAStore& getInstance();
 
-            bool fixOldDatabase();
+            bool fixOldDatabaseIfRequired();
             bool trimEventTable();
+            
+            bool initDatabaseLocation();
 
             // set when calling "ensureDatabase"
             // using a "writablePath" that needs to be set into the C++ component before