# Name of the class attribute to put in the AppConfig class of the Plugin App.
PLUGIN_APP_CLASS_ATTRIBUTE_NAME = u'plugin_app'


# Name of the function that belongs in the plugin Django app's settings file.
# The function should be defined as:
#     def plugin_settings(settings):
#         # enter code that should be injected into the given settings module.
PLUGIN_APP_SETTINGS_FUNC_NAME = u'plugin_settings'


class ProjectType(object):
    """
    The ProjectType enum defines the possible values for the Django Projects
    that are available in the edx-platform. Plugin apps use these values to
    declare explicitly which projects they are extending.
    """
    LMS = u'lms.djangoapp'
    CMS = u'cms.djangoapp'


class SettingsType(object):
    """
    The SettingsType enum defines the possible values for the settings files
    that are available for extension in the edx-platform. Plugin apps use these
    values (in addition to ProjectType) to declare explicitly which settings
    (in the specified project) they are extending.

    See https://github.com/edx/edx-platform/master/lms/envs/docs/README.rst for
    further information on each Settings Type.
    """
    PRODUCTION = u'production'
    COMMON = u'common'
    DEVSTACK = u'devstack'
    TEST = u'test'


class PluginSettings(object):
    """
    The PluginSettings enum defines dictionary field names (and defaults)
    that can be specified by a Plugin App in order to configure the settings
    that are injected into the project.
    """
    CONFIG = u'settings_config'
    RELATIVE_PATH = u'relative_path'
    DEFAULT_RELATIVE_PATH = u'settings'


class PluginURLs(object):
    """
    The PluginURLs enum defines dictionary field names (and defaults) that can
    be specified by a Plugin App in order to configure the URLs that are
    injected into the project.
    """
    CONFIG = u'url_config'
    APP_NAME = u'app_name'
    NAMESPACE = u'namespace'
    REGEX = u'regex'
    RELATIVE_PATH = u'relative_path'
    DEFAULT_RELATIVE_PATH = u'urls'


class PluginSignals(object):
    """
    The PluginSignals enum defines dictionary field names (and defaults)
    that can be specified by a Plugin App in order to configure the signals
    that it receives.
    """
    CONFIG = u'signals_config'

    RECEIVERS = u'receivers'
    DISPATCH_UID = u'dispatch_uid'
    RECEIVER_FUNC_NAME = u'receiver_func_name'
    SENDER_PATH = u'sender_path'
    SIGNAL_PATH = u'signal_path'

    RELATIVE_PATH = u'relative_path'
    DEFAULT_RELATIVE_PATH = u'signals'


class PluginContexts(object):
    """
    The PluginContexts enum defines dictionary field names (and defaults)
    that can be specified by a Plugin App in order to configure the
    additional views it would like to add context into.
    """
    CONFIG = u"view_context_config"