Changed user settings package to use sqlite3 instead of pickle. Thanks to Ash for teaching me a bit of sqlite3

Author: satoon101

addons/source-python/packages/source-python/settings/storage.py

@@ -4,10 +4,8 @@
 # >> IMPORTS
 # =============================================================================
 # Python Imports
-#   Collections
-from collections import defaultdict
-#   Pickle
-import pickle
+#   SQLite3
+from sqlite3 import connect
 
 # Source.Python Imports
 from paths import SP_DATA_PATH
@@ -21,54 +19,140 @@
 # Get the path to the user settings database file
 _STORAGE_PATH = SP_DATA_PATH.joinpath('settings', 'users.db')
 
+# Does the ../data/source-python/storage/ directory exist?
+if not _STORAGE_PATH.parent.isdir():
+
+    # Create the ../data/source-python/storage/ directory
+    _STORAGE_PATH.parent.mkdir()
+
 
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class _PlayerSettingsDictionary(defaultdict):
+class _UniqueSettings(dict):
+    '''Dictionary class used to interact with
+        the database for a specific uniqueid'''
+
+    def __init__(self, uniqueid):
+        '''Stores the given uniqueid and adds it to the players table'''
+
+        # Call the super class' __init__ to initialize the dictionary
+        super(_UniqueSettings, self).__init__()
+
+        # Store the given uniqueid
+        self._uniqueid = uniqueid
+
+        # Add the uniqueid to the players table if it is not already a member
+        _PlayerSettingsStorage.cursor.execute(
+            '''INSERT OR IGNORE INTO players VALUES(null, ?)''',
+            (self.uniqueid, ))
+
+    def __setitem__(self, variable, value):
+        '''Override __setitem__ to insert the given
+            variable and value to their respective tables'''
+
+        # Set the given variable's value in the dictionary
+        super(_UniqueSettings, self).__setitem__(variable, value)
+
+        # Add the variable to the variables table if it is not already a member
+        _PlayerSettingsStorage.cursor.execute(
+            '''INSERT OR IGNORE INTO variables VALUES(null, ?)''',
+            (variable, ))
+
+        # Set the value of the variable/uniqueid combination
+        _PlayerSettingsStorage.cursor.execute(
+            '''INSERT OR REPLACE INTO variable_values SELECT ''' +
+            '''variables.id, players.id, ? FROM variables, players ''' +
+            '''WHERE variables.name=? AND players.uniqueid=?''',
+            (value, variable, self.uniqueid))
+
+    @property
+    def uniqueid(self):
+        '''Returns the instance's uniqueid'''
+        return self._uniqueid
+
+
+class _PlayerSettingsDictionary(dict):
     '''Dictionary class used to store user specific settings values'''
 
-    def __init__(self, default_factory):
-        '''Loads all values from the database into the dictionary'''
+    def __init__(self):
+        '''Connects to the database, creates the database tables, and
+            loads all values from the database into the dictionary'''
 
-        # Call the super class' __init__ to initialize the defaultdict
-        super(_PlayerSettingsDictionary, self).__init__(default_factory)
+        # Call the super class' __init__ to initialize the dictionary
+        super(_PlayerSettingsDictionary, self).__init__()
 
-        # Has the database previously been saved?
-        if not _STORAGE_PATH.isfile():
+        # Connect to the database
+        self._connection = connect(_STORAGE_PATH)
 
-            # No need to go further
-            return
+        # Set the text factory
+        self.connection.text_factory = str
 
-        # Open/close the settings database
-        with _STORAGE_PATH.open('rb') as _user_settings:
+        # Get the cursor instance
+        self._cursor = self.connection.cursor()
 
-            # Get the stored settings
-            _settings = pickle.load(_user_settings)
+        # Create the variables table if it does not exist
+        self.cursor.execute(
+            '''CREATE TABLE IF NOT EXISTS variables (id INTEGER '''
+            '''PRIMARY KEY AUTOINCREMENT, name TEXT UNIQUE)''')
 
-            # Loop through all stored settings
-            for key, value in _settings.items():
+        # Create the players table if it does not exist
+        self.cursor.execute(
+            '''CREATE TABLE IF NOT EXISTS players (id INTEGER ''' +
+            '''PRIMARY KEY AUTOINCREMENT, uniqueid TEXT UNIQUE)''')
 
-                # Store the setting
-                self[key] = value
+        # Create the variable_values table if it does not exist
+        self.cursor.execute(
+            '''CREATE TABLE IF NOT EXISTS variable_values (vid '''
+            '''INTEGER, pid INTEGER, value, PRIMARY KEY (vid, pid))''')
 
-    def server_spawn(self, game_event):
-        '''Stores the dictionary to the database on map change'''
+        # Get all current data from the variable_values table
+        data = self.cursor.execute(
+            '''SELECT V.name, P.uniqueid, value FROM ''' +
+            '''variable_values AS R JOIN variables AS V ON ''' +
+            '''R.vid=V.id JOIN players AS P ON R.pid=P.id''')
+
+        # Fetch all objects from the result
+        data = data.fetchall()
 
-        # Are there any values stored in the dictionary?
-        if not self:
+        # Is the table empty?
+        if not data:
 
-            # If not, no need to go further
+            # No need to go further
             return
 
-        # Open/close the settings database as write
-        with _STORAGE_PATH.open('wb') as _user_settings:
+        # Loop through all values in the data
+        for variable, uniqueid, value in data:
+
+            # Store the value for the given uniqueid and variable name
+            self[uniqueid][variable] = value
+
+    def __missing__(self, uniqueid):
+        '''Adds the given uniqueid to the
+            dictionary as a _UniqueSettings instance'''
 
-            # Dump the dictionary to the database file
-            pickle.dump(self, _user_settings)
+        # Add the uniqueid to the dictionary
+        value = self[uniqueid] = _UniqueSettings(uniqueid)
+
+        # Return the _UniqueSettings instance
+        return value
+
+    @property
+    def connection(self):
+        '''Returns the connection to the database'''
+        return self._connection
+
+    @property
+    def cursor(self):
+        '''Returns the cursor instance'''
+        return self._cursor
+
+    def server_spawn(self, game_event):
+        '''Stores the dictionary to the database on map change'''
+        self.connection.commit()
 
 # Get the _PlayerSettingsDictionary instance
-_PlayerSettingsStorage = _PlayerSettingsDictionary(dict)
+_PlayerSettingsStorage = _PlayerSettingsDictionary()
 
 # Register for the event server_spawn in order
 # to store the database to file on map change