Misago/misago/conf/migrationutils.py

import base64
from importlib import import_module
from misago.conf.dbsettings import CACHE_KEY
from misago.conf.hydrators import dehydrate_value
from misago.core.cache import cache as default_cache
from misago.core.migrationutils import original_message
try:
    import cPickle as pickle
except ImportError:
    import pickle


def with_conf_models(migration, this_migration=None):
    module_name = 'misago.conf.migrations.%s' % migration
    migration_module = import_module(module_name)
    conf_models = migration_module.Migration.models

    if this_migration:
        conf_models.update(this_migration)
    return conf_models


def get_custom_settings_values(orm, group):
    custom_settings_values = {}

    for setting in group.setting_set.iterator():
        if setting.has_custom_value:
            custom_settings_values[setting.setting] = setting.value

    return custom_settings_values


def get_group(orm, group_key):
    try:
        return orm['conf.SettingsGroup'].objects.get(key=group_key)
    except orm['conf.SettingsGroup'].DoesNotExist:
        return orm['conf.SettingsGroup']()


def migrate_setting(orm, group, setting_fixture, order, old_value):
    setting_fixture['group'] = group
    setting_fixture['order'] = order

    setting_fixture['name'] = original_message(setting_fixture['name'])
    if setting_fixture.get('description'):
        setting_fixture['description'] = original_message(
            setting_fixture.get('description'))

    if (setting_fixture.get('field_extra') and
            setting_fixture.get('field_extra').get('choices')):
        untranslated_choices = setting_fixture['field_extra']['choices']
        if untranslated_choices == '#TZ#':
            setting_fixture['field_extra']['choices'] = '#TZ#'
        else:
            translated_choices = []
            for val, name in untranslated_choices:
                translated_choices.append((val, original_message(name)))
            setting_fixture['field_extra']['choices'] = tuple(
                translated_choices)

    if old_value is None:
        value = setting_fixture.pop('value', None)
    else:
        value = old_value
    setting_fixture.pop('value', None)

    field_extra = setting_fixture.pop('field_extra', None)

    setting = orm['conf.Setting'](**setting_fixture)
    setting.dry_value = dehydrate_value(setting.python_type, value)

    if setting_fixture.get("default_value"):
        setting.default_value = dehydrate_value(
            setting.python_type, setting_fixture.get("default_value"))

    if field_extra:
        pickled_extra = pickle.dumps(field_extra, pickle.HIGHEST_PROTOCOL)
        setting.pickled_field_extra = base64.encodestring(pickled_extra)

    setting.save()


def migrate_settings_group(orm, group_fixture, old_group_key=None):
    group_key = group_fixture['key']

    # Fetch settings group

    if old_group_key:
        group = get_group(orm, old_group_key)
        custom_settings_values = get_custom_settings_values(orm, group)
    else:
        group = get_group(orm, group_key)
        if group.pk:
            custom_settings_values = get_custom_settings_values(orm, group)
        else:
            custom_settings_values = {}

    # Update group's attributes

    group.key = group_fixture['key']
    group.name = original_message(group_fixture['name'])
    if group_fixture.get('description'):
        group.description = original_message(group_fixture.get('description'))
    group.save()

    # Delete groups settings and make new ones
    # Its easier to create news ones and then assign them old values

    group.setting_set.all().delete()

    for order, setting_fixture in enumerate(group_fixture['settings']):
        old_value = custom_settings_values.pop(setting_fixture['name'], None)
        migrate_setting(orm, group, setting_fixture, order, old_value)


def delete_settings_cache():
    default_cache.delete(CACHE_KEY)