Added new player settings module. Full functionality is not working, and will not until we get a menu system implemented. I also intend upon updating the storage system to use sqlite3 instead of pickle.

Fixed accidental changes committed to LangStrings.

Updated _core.settings and _core/core_settings_strings for the player settings implementation.

Author: satoon101

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

@@ -179,5 +179,44 @@ def _check_logging_settings(self):
         self['LOG_SETTINGS'].comments['areas'] = ['\n\n'] + _core_strings[
             'log_areas'].get_string(self._language).splitlines()
 
+    def _check_user_settings(self):
+        '''Adds user settings if they are missing'''
+
+        # Are there any user settings in the file?
+        if not 'USER_SETTINGS' in self:
+
+            # Add the user settings
+            self['USER_SETTINGS'] = {}
+
+        # Is there a private say commands setting?
+        if not 'private_say_commands' in self['USER_SETTINGS']:
+
+            # Add the private say commands setting
+            self['USER_SETTINGS']['private_say_commands'] = ''
+
+        # Set the private say commands comments
+        self['USER_SETTINGS'].comments['private_say_commands'] = _core_strings[
+            'private_say_commands'].get_string(self._language).splitlines()
+
+        # Is there a public say commands setting?
+        if not 'public_say_commands' in self['USER_SETTINGS']:
+
+            # Add the public say commands setting
+            self['USER_SETTINGS']['public_say_commands'] = ''
+
+        # Set the public say commands comments
+        self['USER_SETTINGS'].comments['public_say_commands'] = _core_strings[
+            'public_say_commands'].get_string(self._language).splitlines()
+
+        # Is there a client commands setting?
+        if not 'client_commands' in self['USER_SETTINGS']:
+
+            # Add the client commands setting
+            self['USER_SETTINGS']['client_commands'] = ''
+
+        # Set the client commands comments
+        self['USER_SETTINGS'].comments['client_commands'] = _core_strings[
+            'client_commands'].get_string(self._language).splitlines()
+
 # Get the _CoreSettings instance
 _CoreSettingsInstance = _CoreSettings(CFG_PATH.joinpath('core_settings.ini'))

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

@@ -0,0 +1,43 @@
+# ../settings/menu.py
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Players
+from players.helpers import uniqueid_from_playerinfo
+#   Settings
+from settings.player import _MainSettingsDictionary
+from settings.player import _SettingsDictionary
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class _SettingsMenu(object):
+    ''''''
+
+    def _private_command(self, *args):
+        ''''''
+
+        # Send the menu
+        self._send_menu(*args)
+
+        # Make the command private
+        return False
+
+    def _send_menu(self, playerinfo, *args):
+        ''''''
+
+        for name in _MainSettingsDictionary:
+            for setting in self._get_settings(_MainSettingsDictionary[name]):
+                print(setting)
+
+    def _get_setting(self, settings):
+        for setting in settings:
+            if isinstance(setting, _SettingsDictionary):
+                self._get_settings(setting)
+            else:
+                yield setting
+
+_SettingsMenuInstance = _SettingsMenu()

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

@@ -0,0 +1,164 @@
+# ../settings/player.py
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Python Imports
+#   Collections
+from collections import OrderedDict
+
+# Source.Python Imports
+from public import public
+#   Settings
+from settings.types import _SettingsType
+from settings.types import _FloatSetting
+from settings.types import _IntegerSetting
+from settings.types import _StringSetting
+
+
+# =============================================================================
+# >> GLOBAL VARIABLES
+# =============================================================================
+# Create a dictionary to store all of the user settings
+_MainSettingsDictionary = dict()
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class _SettingsDictionary(OrderedDict):
+    '''Class used to store user settings'''
+
+    def __init__(self, name, text=''):
+        '''
+            Verifies the name value on instantiation and stores base attributes
+        '''
+
+        # Is the given name a proper value for a convar?
+        if not name.replace('_', '').replace(' ', '').isalpha():
+
+            # Raise an error
+            raise ValueError(
+                'Given name "{0}" is not valid'.format(name))
+
+        # Set the base attributes
+        self._name = name
+        self._text = text
+
+        # Call the super class' __init__ to initialize the OrderedDict
+        super(_SettingsDictionary, self).__init__()
+
+    def __setitem__(self, item, value):
+        '''Override __setitem__ to verify the type of value given
+            and that the item is not already in the dictionary'''
+
+        # Is the given value a proper type?
+        if not isinstance(value, (_SettingsDictionary, _SettingsType)):
+
+            # Raise an error
+            raise ValueError(
+                'Given value "{0}" is not valid'.format(value))
+
+        # Is the item already in the dictionary?
+        if item in self:
+
+            # Raise an error
+            raise ValueError(
+                'Given item "{0}" is already registered'.format(item))
+
+        # Set the item in the dictionary
+        super(_SettingsDictionary, self).__setitem__(item, value)
+
+        # Set the item's prefix
+        self[item]._prefix = self.prefix + '_'
+
+        # Does the section's name need added to the prefix?
+        if not isinstance(self, PlayerSettings):
+
+            # Add the section's name to the prefix
+            self[item]._prefix += self.name.lower().replace(' ', '_') + '_'
+
+    @property
+    def name(self):
+        '''Returns the name of the _SettingsDictionary instance'''
+        return self._name
+
+    @property
+    def prefix(self):
+        '''Returns the prefix of the _SettingsDictionary instance'''
+        return self._prefix
+
+    def add_float_setting(
+            self, name, default, text='', min_value=None, max_value=None):
+        '''Adds a new float setting to the dictionary'''
+
+        # Add the new float setting to the dictionary
+        self[name] = _FloatSetting(name, default, text, min_value, max_value)
+
+        # Return the setting
+        return self[name]
+
+    def add_int_setting(
+            self, name, default, text='', min_value=None, max_value=None):
+        '''Adds a new integer setting to the dictionary'''
+
+        # Add the new integer setting to the dictionary
+        self[name] = _IntegerSetting(name, default, text, min_value, max_value)
+
+        # Return the setting
+        return self[name]
+
+    def add_string_setting(self, name, default, text=''):
+        '''Adds a new string setting to the dictionary'''
+
+        # Add the new string setting to the dictionary
+        self[name] = _StringSetting(name, default, text)
+
+        # Return the setting
+        return self[name]
+
+    def add_section(self, name, text=''):
+        '''Adds a new section to the dictionary'''
+
+        # Add the new section to the dictionary
+        self[name] = _SettingsDictionary(name, text)
+
+        # Return the section
+        return self[name]
+
+
+@public
+class PlayerSettings(_SettingsDictionary):
+    '''Class used to register user settings'''
+
+    def __init__(self, name, prefix, text=''):
+        '''Verifies the given values, creates the instance,
+            and stores the instance in the main dictionary'''
+
+        # Is the given name already registered?
+        if name in _MainSettingsDictionary:
+
+            # Raise an error
+            raise ValueError(
+                'Given name "{0}" is already registered.'.format(name))
+
+        # Is the prefix a proper value?
+        if not prefix.replace('_', '').isalpha():
+
+            # Raise an error
+            raise ValueError(
+                'Given prefix "{0}" is not valid'.format(prefix))
+
+        # Call the super class' __init__ to verify
+        # the name and store base attributes
+        super(PlayerSettings, self).__init__(name, text)
+
+        # Set the prefix for the settings
+        self._prefix = prefix.lower()
+
+        # Add the instance to the main dictionary
+        _MainSettingsDictionary[name] = self
+
+    def unregister_settings(self):
+        '''Unregisters the given settings from the dictionary'''
+        del _MainSettingsDictionary[self.name]

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

@@ -0,0 +1,64 @@
+# ../settings/storage.py
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Python Imports
+#   Collections
+from collections import defaultdict
+#   Pickle
+import pickle
+
+# Source.Python Imports
+from paths import SP_DATA_PATH
+#   Events
+from events.manager import EventRegistry
+
+
+# =============================================================================
+# >> GLOBAL VARIABLES
+# =============================================================================
+_STORAGE_PATH = SP_DATA_PATH.joinpath('settings', 'users.db')
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class _PlayerSettingsDictionary(defaultdict):
+    '''Dictionary class used to store user specific settings values'''
+
+    def __init__(self, default_factory):
+        '''Loads all values from the database into the dictionary'''
+
+        # Has the database previously been saved?
+        if _STORAGE_PATH.isfile():
+
+            # Open/close the settings database
+            with _STORAGE_PATH.open('rb') as _user_settings:
+
+                # Load the database into the dictionary
+                super(_PlayerSettingsDictionary, self).__init__(
+                    pickle.load(_user_settings))
+
+        # Has the database never been saved?
+        else:
+
+            # Call the super class' __init__ to initialize the defaultdict
+            super(_PlayerSettingsDictionary, self).__init__(default_factory)
+
+    def server_spawn(self, game_event):
+        '''Stores the dictionary to the database on map change'''
+
+        # Open/close the settings database as write
+        with _STORAGE_PATH.open('wb') as _user_settings:
+
+            # Dump the dictionary to the database file
+            pickle.dump(self, _user_settings)
+
+# Get the _PlayerSettingsDictionary instance
+_PlayerSettingsStorage = _PlayerSettingsDictionary(dict)
+
+# Register for the event server_spawn in order
+# to store the database to file on map change
+EventRegistry.register_for_event(
+    'server_spawn', _PlayerSettingsStorage.server_spawn)