# Copyright (C) 2020 The Meme Factory, Inc.  http://www.karlpinc.com/

# This file is part of PGWUI_Menu.
#
# This program is free software: you can redistribute it and/or
# modify it under the terms of the GNU Affero General Public License
# as published by the Free Software Foundation, either version 3 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License along with this program.  If not, see
# <http://www.gnu.org/licenses/>.
#

# Karl O. Pinc <kop@karlpinc.com>

from pgwui_common import checkset
from pgwui_common import plugin
from . import exceptions as menu_ex


PGWUI_COMPONENT = 'pgwui_menu'
MENU_SETTINGS = ['menu_label',
                 'order',
                 ]
REQUIRED_SETTINGS = []
BOOLEAN_SETTINGS = []


def validate_order(errors, components, settings):
    '''Make sure the values are those allowed
    '''
    values = settings.get('order')
    if values is None:
        return
    if isinstance(values, list):
        for component in values:
            if component not in components:
                errors.append(menu_ex.BadOrderItemError(components, component))
    else:
        errors.append(menu_ex.BadOrderValuesError(values))


def check_settings(component_config):
    '''Check that all pgwui_upload specific settings are good.
    This includes:
      checking for unknown settings
      checking for missing required settings
      checking the boolean settings
      checking that the values of other settings are valid
    '''
    errors = []
    errors.extend(checkset.unknown_settings(
        PGWUI_COMPONENT, MENU_SETTINGS, component_config))
    errors.extend(checkset.require_settings(
        PGWUI_COMPONENT, REQUIRED_SETTINGS, component_config))
    errors.extend(checkset.boolean_settings(
        PGWUI_COMPONENT, BOOLEAN_SETTINGS, component_config))

    components = plugin.find_pgwui_components()
    validate_order(errors, components, component_config)

    return errors