defaults.py

"""
Django settings for the admin project.
"""

from django.contrib import messages
from api.base.settings import *  # noqa
# TODO ALL SETTINGS FROM API WILL BE IMPORTED AND WILL NEED TO BE OVERRRIDEN
# TODO THIS IS A STEP TOWARD INTEGRATING ADMIN & API INTO ONE PROJECT

# import local  # Build own local.py (used with postgres)

# TODO - remove duplicated items, as this is now using settings from the API

BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/

# from the GakuNin RDM settings
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = osf_settings.SECRET_KEY


# Don't allow migrations
DATABASE_ROUTERS = ['admin.base.db.router.NoMigrationRouter']

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = osf_settings.DEBUG_MODE
DEBUG_PROPAGATE_EXCEPTIONS = True


# session:
SESSION_COOKIE_NAME = 'admin'
SESSION_COOKIE_SECURE = osf_settings.SECURE_MODE
SESSION_COOKIE_HTTPONLY = osf_settings.SESSION_COOKIE_HTTPONLY

# csrf:
CSRF_COOKIE_NAME = 'admin-csrf'
CSRF_COOKIE_SECURE = osf_settings.SECURE_MODE
# set to False for admin draft registration uses a SPA and ajax and grab the token to use it in the requests
CSRF_COOKIE_HTTPONLY = False

ALLOWED_HOSTS = [
    'osf.io'
]

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
        'OPTIONS': {
            'min_length': 5,
        }
    },
]

USE_L10N = False

# Email settings. Account created for testing. Password shouldn't be hardcoded
# [DEVOPS] this should be set to 'django.core.mail.backends.smtp.EmailBackend' in the > dev local.py.
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

# Sendgrid Email Settings - Using OSF credentials.
# Add settings references to local.py

EMAIL_HOST = osf_settings.MAIL_SERVER
EMAIL_HOST_USER = osf_settings.MAIL_USERNAME
EMAIL_HOST_PASSWORD = osf_settings.MAIL_PASSWORD
EMAIL_PORT = 587
EMAIL_USE_TLS = True

# Application definition

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.messages',
    'django.contrib.sessions',
    'django.contrib.staticfiles',

    # 3rd party
    'django_celery_results',
    'raven.contrib.django.raven_compat',
    'webpack_loader',
    'django_nose',
    'password_reset',
    'guardian',
    'waffle',
    'elasticsearch_metrics',

    # OSF
    'osf',

    # Addons
    'addons.osfstorage',
    'addons.wiki',
    'addons.twofactor',

    # Internal apps
    'admin.common_auth',
    'admin.base',
    'admin.spam',
    'admin.metrics',
    'admin.nodes',
    'admin.users',
    'admin.desk',
    'admin.meetings',
    'admin.institutions',
    'admin.preprint_providers',

    # Additional addons
    'addons.bitbucket',
    'addons.box',
    'addons.dataverse',
    'addons.dropbox',
    'addons.figshare',
    'addons.forward',
    'addons.github',
    'addons.googledrive',
    'addons.mendeley',
    'addons.owncloud',
    'addons.s3',
    'addons.zotero',
    'addons.swift',
    'addons.azureblobstorage',
    'addons.weko',
    'addons.s3compat',
    'addons.nextcloud',
    'addons.gitlab',
    'addons.onedrive',
    'addons.iqbrims',
    'addons.dropboxbusiness',
    'addons.nextcloudinstitutions',
    'addons.myskelton',
)

MIGRATION_MODULES = {
    'osf': None,
    'reviews': None,
    'addons_osfstorage': None,
    'addons_wiki': None,
    'addons_twofactor': None,
    'addons_bitbucket': None,
    'addons_box': None,
    'addons_dataverse': None,
    'addons_dropbox': None,
    'addons_figshare': None,
    'addons_forward': None,
    'addons_github': None,
    'addons_googledrive': None,
    'addons_mendeley': None,
    'addons_owncloud': None,
    'addons_s3': None,
    'addons_zotero': None,
    'addons_swift': None,
    'addons_azureblobstorage': None,
    'addons_weko': None,
    'addons_s3compat': None,
    'addons_nextcloud': None,
    'addons_gitlab': None,
    'addons_onedrive': None,
    'addons_iqbrims': None,
    'addons_dropboxbusiness': None,
    'addons_nextcloudinstitutions': None,
    'addons_myskelton': None,
}

UNSUPPORTED_FORCE_TO_USE_ADDONS = [
    'azureblobstorage',
    'swift',
    'weko',
    's3compat',
    'nextcloud',
    'gitlab',
    'onedrive',
    'iqbrims',
    'myskelton',
]

USE_TZ = True
TIME_ZONE = 'UTC'

# local development using https
if osf_settings.SECURE_MODE and osf_settings.DEBUG_MODE:
    INSTALLED_APPS += ('sslserver',)

# Custom user model (extends AbstractBaseUser)
AUTH_USER_MODEL = 'osf.OSFUser'

# TODO: Are there more granular ways to configure reporting specifically related to the API?
RAVEN_CONFIG = {
    'tags': {'App': 'admin'},
    'dsn': osf_settings.SENTRY_DSN,
    'release': osf_settings.VERSION,
}

# Settings related to CORS Headers addon: allow API to receive authenticated requests from OSF
# CORS plugin only matches based on "netloc" part of URL, so as workaround we add that to the list
CORS_ORIGIN_ALLOW_ALL = False
CORS_ORIGIN_WHITELIST = (urlparse(osf_settings.DOMAIN).netloc,
                         osf_settings.DOMAIN,
                         )
CORS_ALLOW_CREDENTIALS = True

MIDDLEWARE = (
    # TokuMX transaction support
    # Needs to go before CommonMiddleware, so that transactions are always started,
    # even in the event of a redirect. CommonMiddleware may cause other middlewares'
    # process_request to be skipped, e.g. when a trailing slash is omitted
    'api.base.middleware.DjangoGlobalMiddleware',
    'api.base.middleware.CeleryTaskMiddleware',
    'api.base.middleware.PostcommitTaskMiddleware',

    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.locale.LocaleMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'django.middleware.security.SecurityMiddleware',
    'waffle.middleware.WaffleMiddleware',
)

MESSAGE_TAGS = {
    messages.SUCCESS: 'text-success',
    messages.ERROR: 'text-danger',
    messages.WARNING: 'text-warning',
}

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        }
    }]

ROOT_URLCONF = 'admin.base.urls'
WSGI_APPLICATION = 'admin.base.wsgi.application'
ADMIN_BASE = ''
STATIC_URL = '/static/'
LOGIN_URL = 'account/login/'
LOGIN_REDIRECT_URL = ADMIN_BASE

STATIC_ROOT = os.path.join(os.path.dirname(BASE_DIR), 'static_root')

STATICFILES_DIRS = (
    os.path.join(BASE_DIR, 'static'),
    os.path.join(BASE_DIR, '../website/static'),
)

LANGUAGE_CODE = 'en-us'

WEBPACK_LOADER = {
    'DEFAULT': {
        'BUNDLE_DIR_NAME': 'public/js/',
        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),
    }
}

TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
NOSE_ARGS = ['--verbosity=2']

# Keen.io settings in local.py
KEEN_PROJECT_ID = osf_settings.KEEN['private']['project_id']
KEEN_READ_KEY = osf_settings.KEEN['private']['read_key']
KEEN_WRITE_KEY = osf_settings.KEEN['private']['write_key']

KEEN_CREDENTIALS = {
    'keen_ready': False
}

if KEEN_CREDENTIALS['keen_ready']:
    KEEN_CREDENTIALS.update({
        'keen_project_id': KEEN_PROJECT_ID,
        'keen_read_key': KEEN_READ_KEY,
        'keen_write_key': KEEN_WRITE_KEY
    })


# Set in local.py
DESK_KEY = ''
DESK_KEY_SECRET = ''

TINYMCE_APIKEY = ''

SHARE_URL = osf_settings.SHARE_URL
API_DOMAIN = osf_settings.API_DOMAIN

if DEBUG:
    INSTALLED_APPS += ('debug_toolbar', 'nplusone.ext.django',)
    MIDDLEWARE += ('debug_toolbar.middleware.DebugToolbarMiddleware', 'nplusone.ext.django.NPlusOneMiddleware',)
    DEBUG_TOOLBAR_CONFIG = {
        'SHOW_TOOLBAR_CALLBACK': lambda _: True,
        'DISABLE_PANELS': {
            'debug_toolbar.panels.templates.TemplatesPanel',
            'debug_toolbar.panels.redirects.RedirectsPanel'
        }
    }

# If set to True, automated tests with extra queries will fail.
NPLUSONE_RAISE = False
FCM_SETTINGS = {
    'FCM_SERVER_KEY': ''
}
# separator to devide domain from eppn
SHIB_EPPN_SCOPING_SEPARATOR = '@'

# hide embededDS, login user form in Adoministrator login page
ENABLE_LOGIN_FORM = True
ENABLE_SHB_LOGIN = False
EMBEDDED_DS_URL = osf_settings.EMBEDDED_DS_URL

# mail address uses mail from rdm_announcement
ANNOUNCEMENT_EMAIL_FROM = 'noreply@rdm.rcos.nii.ac.jp'

# Addon Controls
ENABLE_FORCE_CHECK = False

def parent_dir(path):
    '''Return the parent of a directory.'''
    return os.path.abspath(os.path.join(path, os.pardir))

HERE = os.path.dirname(os.path.abspath(__file__))
BASE_PATH = parent_dir(parent_dir(HERE))  # admin/ directory

LOCALE_PATHS = (
    os.path.join(BASE_PATH, 'translations'),
)