Implemented datastore shared memory codebase

Changes: - Added SharedMemory module for file-backed memory-mapped storage - Added MappingInfo, FileHeader, RecordState and TrackedRecord infrastructure - Replaced CSV-based serialization with binary struct serialization - Added DataStore initialization and shutdown lifecycle management - Added datastore mutex synchronization for multi-process access - Added shared-memory mapping configuration for all datastore entities - Added generic loadRecords and saveRecords template infrastructure - Added automatic datastore directory creation and .dat file storage - Updated configuration to use binary datastore files and initial capacities - Added enum underlying types for serialization compatibility - Added password masking support for login, registration and password change flows - Added Visual Studio project configuration for shared-memory components - Added datastore-owned record caches for runtime object management - Updated datastore APIs to return cached tracked-record collections by reference - Added generic cache refresh and cleanup infrastructure - Updated save operations to persist datastore caches directly - Added automatic cache cleanup during datastore destruction - Prepared datastore for multi-process shared-memory persistence
2026-06-12 00:59:10 +05:30
parent 602b538830
commit 3b1f3301d6
22 changed files with 1502 additions and 101 deletions
@@ -9,6 +9,200 @@ Date: 19-May-2026
 */

 #include "DataStore.h"
+#include "Config.h"
+#include "SerializedRecords.h"
+#include "FileHelper.h"
+
+/*
+Function: DataStore
+Description: Constructs the DataStore singleton and initializes
+             internal handles to their default values.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+DataStore::DataStore() :
+    m_globalMutex(NULL) {}
+
+/*
+Function: ~DataStore
+Description: Destroys the DataStore singleton and releases all
+             cached application objects owned by the datastore.
+             This includes users, notifications, services,
+             combo packages, inventory items, service bookings,
+             job cards, and invoices.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+DataStore::~DataStore()
+{
+    clearCache(m_userCache);
+    clearCache(m_notificationCache);
+    clearCache(m_serviceCache);
+    clearCache(m_comboPackageCache);
+    clearCache(m_inventoryItemCache);
+    clearCache(m_serviceBookingCache);
+    clearCache(m_jobCardCache);
+    clearCache(m_invoiceCache);
+}
+
+/*
+Function: initialize
+Description: Initializes the shared-memory datastore.
+             Creates or opens the global datastore mutex,
+             configures all mapping metadata, and creates
+             or opens the file mappings used to persist
+             application data. After successful completion,
+             all datastore files are mapped into memory and
+             ready for use by the application.
+Parameter: None
+Return type: bool
+             - true  : Initialization completed successfully.
+             - false : Failed to create the mutex or open
+                       one or more file mappings.
+*/
+bool DataStore::initialize()
+{
+    m_globalMutex = CreateMutexA(NULL, FALSE, "VehicleServiceSystemMutex");
+    if (m_globalMutex == NULL)
+    {
+        return false;
+    }
+    if (!lockDataStore())
+    {
+        CloseHandle(m_globalMutex);
+        m_globalMutex = NULL;
+        return false;
+    }
+    bool success = true;
+    do
+    {
+        util::ensureDirectoryExists(config::file::DIRECTORY);
+        m_users.fileName = config::file::USER_FILE;
+        m_users.recordSize = sizeof(SerializedUser);
+        m_notifications.fileName = config::file::NOTIFICATION_FILE;
+        m_notifications.recordSize = sizeof(SerializedNotification);
+        m_services.fileName = config::file::SERVICE_FILE;
+        m_services.recordSize = sizeof(SerializedService);
+        m_comboPackages.fileName = config::file::COMBOPACKAGE_FILE;
+        m_comboPackages.recordSize = sizeof(SerializedComboPackage);
+        m_inventoryItems.fileName = config::file::INVENTORYITEM_FILE;
+        m_inventoryItems.recordSize = sizeof(SerializedInventoryItem);
+        m_serviceBookings.fileName = config::file::SERVICEBOOKING_FILE;
+        m_serviceBookings.recordSize = sizeof(SerializedServiceBooking);
+        m_jobCards.fileName = config::file::JOBCARD_FILE;
+        m_jobCards.recordSize = sizeof(SerializedJobCard);
+        m_invoices.fileName = config::file::INVOICE_FILE;
+        m_invoices.recordSize = sizeof(SerializedInvoice);
+        m_serviceManagementObservers.fileName = config::file::SERVICEMANAGEMENTOBSERVERS;
+        m_serviceManagementObservers.recordSize = sizeof(SerializedObserver);
+        m_paymentManagementObservers.fileName = config::file::PAYMENTMANAGEMENTOBSERVERS;
+        m_paymentManagementObservers.recordSize = sizeof(SerializedObserver);
+        m_inventoryManagementObservers.fileName = config::file::INVENTORYMANAGEMENTOBSERVERS;
+        m_inventoryManagementObservers.recordSize = sizeof(SerializedObserver);
+        if (!SharedMemory::createOrOpenMapping(m_users))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_notifications))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_services))
+        {
+            success = false;
+            break;
+        }
+
+        if (!SharedMemory::createOrOpenMapping(m_comboPackages))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_inventoryItems))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_serviceBookings))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_jobCards))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_invoices))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_payments))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_serviceManagementObservers))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_paymentManagementObservers))
+        {
+            success = false;
+            break;
+        }
+        if (!SharedMemory::createOrOpenMapping(m_inventoryManagementObservers))
+        {
+            success = false;
+            break;
+        }
+    } while (false);
+    unlockDataStore();
+    if (!success)
+    {
+        shutdown();
+    }
+    return success;
+}
+
+/*
+Function: shutdown
+Description: Releases all shared-memory resources owned by the
+             datastore. Closes every file mapping, unmaps all
+             mapped views, and releases the datastore mutex.
+             After this call, the datastore must be initialized
+             again before use.
+Parameter: None
+Return type: void
+*/
+void DataStore::shutdown()
+{
+    SharedMemory::closeMapping(m_users);
+    SharedMemory::closeMapping(m_notifications);
+    SharedMemory::closeMapping(m_services);
+    SharedMemory::closeMapping(m_comboPackages);
+    SharedMemory::closeMapping(m_inventoryItems);
+    SharedMemory::closeMapping(m_serviceBookings);
+    SharedMemory::closeMapping(m_jobCards);
+    SharedMemory::closeMapping(m_invoices);
+    SharedMemory::closeMapping(m_payments);
+    SharedMemory::closeMapping(m_serviceManagementObservers);
+    SharedMemory::closeMapping(m_paymentManagementObservers);
+    SharedMemory::closeMapping(m_inventoryManagementObservers);
+    if (m_globalMutex != NULL)
+    {
+        CloseHandle(m_globalMutex);
+        m_globalMutex = NULL;
+    }
+}

 /*
 Function: getInstance
@@ -26,104 +220,346 @@ DataStore& DataStore::getInstance()

 /*
 Function: getUsers
-Description: Retrieves the internal map of users.
+Description: Retrieves all user records from the datastore.
 Parameters:
    - None
 Returns:
-    - Reference to util::Map<std::string, User*> containing all users.
+    - util::Map<std::string, TrackedRecord<User>>: Collection of user records
 */
-util::Map<std::string, User*>& DataStore::getUsers()
+util::Map<std::string, TrackedRecord<User>>& DataStore::getUsers()
 {
-    return m_users;
+    return m_userCache;
+}
+
+/*
+Function: getNotifications
+Description: Retrieves all notification records from the datastore.
+Parameters:
+    - None
+Returns:
+    - util::Map<std::string, TrackedRecord<Notification>>: Collection of notification records
+*/
+util::Map<std::string, TrackedRecord<Notification>>& DataStore::getNotifications()
+{
+    return m_notificationCache;
 }

 /*
 Function: getServices
-Description: Retrieves the internal map of services.
+Description: Retrieves all service records from the datastore.
 Parameters:
    - None
 Returns:
-    - Reference to util::Map<std::string, Service*> containing all services.
+    - util::Map<std::string, TrackedRecord<Service>>: Collection of service records
 */
-util::Map<std::string, Service*>& DataStore::getServices()
+util::Map<std::string, TrackedRecord<Service>>& DataStore::getServices()
 {
-    return m_services;
+    return m_serviceCache;
 }

 /*
 Function: getComboPackages
-Description: Retrieves the internal map of combo packages.
+Description: Retrieves all combo package records from the datastore.
 Parameters:
    - None
 Returns:
-    - Reference to util::Map<std::string, ComboPackage*> containing all combo packages.
+    - util::Map<std::string, TrackedRecord<ComboPackage>>: Collection of combo package records
 */
-util::Map<std::string, ComboPackage*>& DataStore::getComboPackages()
+util::Map<std::string, TrackedRecord<ComboPackage>>& DataStore::getComboPackages()
 {
-    return m_comboPackages;
-}
-
-/*
-Function: getServiceBookings
-Description: Retrieves the internal map of service bookings.
-Parameters:
-    - None
-Returns:
-    - Reference to util::Map<std::string, ServiceBooking*> containing all service bookings.
-*/
-util::Map<std::string, ServiceBooking*>& DataStore::getServiceBookings()
-{
-    return m_serviceBookings;
-}
-
-/*
-Function: getJobCards
-Description: Retrieves the internal map of job cards.
-Parameters:
-    - None
-Returns:
-    - Reference to util::Map<std::string, JobCard*> containing all job cards.
-*/
-util::Map<std::string, JobCard*>& DataStore::getJobCards()
-{
-    return m_jobCards;
+    return m_comboPackageCache;
 }

 /*
 Function: getInventoryItems
-Description: Retrieves the internal map of inventory items.
+Description: Retrieves all inventory item records from the datastore.
 Parameters:
    - None
 Returns:
-    - Reference to util::Map<std::string, InventoryItem*> containing all inventory items.
+    - util::Map<std::string, TrackedRecord<InventoryItem>>: Collection of inventory item records
 */
-util::Map<std::string, InventoryItem*>& DataStore::getInventoryItems()
+util::Map<std::string, TrackedRecord<InventoryItem>>& DataStore::getInventoryItems()
 {
-    return m_inventoryItems;
+    return m_inventoryItemCache;
+}
+
+/*
+Function: getServiceBookings
+Description: Retrieves all service booking records from the datastore.
+Parameters:
+    - None
+Returns:
+    - util::Map<std::string, TrackedRecord<ServiceBooking>>: Collection of service booking records
+*/
+util::Map<std::string, TrackedRecord<ServiceBooking>>& DataStore::getServiceBookings()
+{
+    return m_serviceBookingCache;
+}
+
+/*
+Function: getJobCards
+Description: Retrieves all job card records from the datastore.
+Parameters:
+    - None
+Returns:
+    - util::Map<std::string, TrackedRecord<JobCard>>: Collection of job card records
+*/
+util::Map<std::string, TrackedRecord<JobCard>>& DataStore::getJobCards()
+{
+    return m_jobCardCache;
 }

 /*
 Function: getInvoices
-Description: Retrieves the internal map of invoices.
+Description: Retrieves all invoice records from the datastore.
 Parameters:
    - None
 Returns:
-    - Reference to util::Map<std::string, Invoice*> containing all invoices.
+    - util::Map<std::string, TrackedRecord<Invoice>>: Collection of invoice records
 */
-util::Map<std::string, Invoice*>& DataStore::getInvoices()
+util::Map<std::string, TrackedRecord<Invoice>>& DataStore::getInvoices()
 {
-    return m_invoices;
+    return m_invoiceCache;
 }

 /*
-Function: getPayments
-Description: Retrieves the internal map of payments.
+Function: getServiceManagementObservers
+Description: Retrieves all service management observer records from the datastore.
 Parameters:
    - None
 Returns:
-    - Reference to util::Map<std::string, Payment*> containing all payments.
+    - util::Map<std::string, User*>: Collection of observer records
 */
-util::Map<std::string, Payment*>& DataStore::getPayments()
+util::Map<std::string, User*> DataStore::getServiceManagementObservers()
 {
-    return m_payments;
-}
+    return util::Map<std::string, User*>();
+}
+
+/*
+Function: getPaymentManagementObservers
+Description: Retrieves all payment management observer records from the datastore.
+Parameters:
+    - None
+Returns:
+    - util::Map<std::string, User*>: Collection of observer records
+*/
+util::Map<std::string, User*> DataStore::getPaymentManagementObservers()
+{
+    return util::Map<std::string, User*>();
+}
+
+/*
+Function: getInventoryManagementObservers
+Description: Retrieves all inventory management observer records from the datastore.
+Parameters:
+    - None
+Returns:
+    - util::Map<std::string, User*>: Collection of observer records
+*/
+util::Map<std::string, User*> DataStore::getInventoryManagementObservers()
+{
+    return util::Map<std::string, User*>();
+}
+
+/*
+Function: saveUsers
+Description: Persists all user records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveUsers()
+{
+}
+
+/*
+Function: saveNotifications
+Description: Persists all notification records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveNotifications()
+{
+}
+
+/*
+Function: saveServices
+Description: Persists all service records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveServices()
+{
+}
+
+/*
+Function: saveComboPackages
+Description: Persists all combo package records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveComboPackages()
+{
+}
+
+/*
+Function: saveInventoryItems
+Description: Persists all inventory item records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveInventoryItems()
+{
+}
+
+/*
+Function: saveServiceBookings
+Description: Persists all service booking records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveServiceBookings()
+{
+}
+
+/*
+Function: saveJobCards
+Description: Persists all job card records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveJobCards()
+{
+}
+
+/*
+Function: saveInvoices
+Description: Persists all invoice records to the datastore.
+Parameters:
+    - None
+Returns:
+    - None
+*/
+void DataStore::saveInvoices()
+{
+}
+
+/*
+Function: saveServiceManagementObservers
+Description: Persists all service management observer records to the datastore.
+Parameters:
+    - observers: util::Map<std::string, TrackedRecord<std::string>>&, collection of observer records
+Returns:
+    - None
+*/
+void DataStore::saveServiceManagementObservers(util::Map<std::string, User*>& observers)
+{
+}
+
+/*
+Function: savePaymentManagementObservers
+Description: Persists all payment management observer records to the datastore.
+Parameters:
+    - observers: util::Map<std::string, User*>&, collection of observer records
+Returns:
+    - None
+*/
+void DataStore::savePaymentManagementObservers(util::Map<std::string, User*>& observers)
+{
+}
+
+/*
+Function: saveInventoryManagementObservers
+Description: Persists all inventory management observer records to the datastore.
+Parameters:
+    - observers: util::Map<std::string, User*>&, collection of observer records
+Returns:
+    - None
+*/
+void DataStore::saveInventoryManagementObservers(util::Map<std::string, User*>& observers)
+{
+}
+
+/*
+Function: lockDataStore
+Description: Acquires exclusive access to the datastore.
+Parameters:
+    - None
+Returns:
+    - bool: True if the datastore was successfully locked, otherwise false
+*/
+bool DataStore::lockDataStore()
+{
+    return false;
+}
+
+/*
+Function: unlockDataStore
+Description: Releases exclusive access to the datastore.
+Parameters:
+    - None
+Returns:
+    - bool: True if the datastore was successfully unlocked, otherwise false
+*/
+bool DataStore::unlockDataStore()
+{
+    return false;
+}
+
+/*
+Function: lockDataStore
+Description: Acquires the datastore mutex, providing
+             exclusive access to the shared-memory
+             datastore. This function blocks until
+             the mutex becomes available or an error
+             occurs.
+Parameter: None
+Return type:
+    bool
+    - true  : Mutex successfully acquired.
+    - false : Failed to acquire the mutex.
+*/
+bool DataStore::lockDataStore()
+{
+    if (m_globalMutex == NULL)
+    {
+        return false;
+    }
+    DWORD result = WaitForSingleObject(m_globalMutex, INFINITE);
+    return result == WAIT_OBJECT_0;
+}
+
+/*
+Function: unlockDataStore
+Description: Releases the datastore mutex after a
+             successful call to lockDataStore(),
+             allowing other processes to access the
+             shared-memory datastore.
+Parameter: None
+Return type:
+    bool
+    - true  : Mutex successfully released.
+    - false : Failed to release the mutex.
+*/
+bool DataStore::unlockDataStore()
+{
+    if (m_globalMutex == NULL)
+    {
+        return false;
+    }
+    return ReleaseMutex(m_globalMutex) != 0;
+}
+