common.py

# Django settings for kuma project.
from collections import namedtuple
import json
import logging
import os
from os.path import dirname
import platform

from decouple import config, Csv
import djcelery
import dj_database_url
import dj_email_url

from django.core.urlresolvers import reverse_lazy

_Language = namedtuple(u'Language', u'english native')

# Set up django-celery
djcelery.setup_loader()


def path(*parts):
    return os.path.join(ROOT, *parts)


class TupleCsv(Csv):

    def __call__(self, value):
        split_values = super(TupleCsv, self).__call__(value)
        return tuple((value, value) for value in split_values)


DEBUG = config('DEBUG', default=False, cast=bool)

ROOT = dirname(dirname(dirname(os.path.abspath(__file__))))

ADMINS = config('ADMIN_EMAILS',
                default='mdn-dev@mozilla.com',
                cast=TupleCsv())

PROTOCOL = config('PROTOCOL', default='https://')
DOMAIN = config('DOMAIN', default='developer.mozilla.org')
SITE_URL = config('SITE_URL', default=PROTOCOL + DOMAIN)
PRODUCTION_URL = SITE_URL
STAGING_DOMAIN = 'developer.allizom.org'
STAGING_URL = PROTOCOL + STAGING_DOMAIN

MANAGERS = ADMINS

DEFAULT_DATABASE = config('DATABASE_URL',
                          default='mysql://kuma:kuma@localhost:3306/kuma',
                          cast=dj_database_url.parse)
if 'mysql' in DEFAULT_DATABASE['ENGINE']:
    DEFAULT_DATABASE.update({
        'OPTIONS': {
            'sql_mode': 'TRADITIONAL',
            'charset': 'utf8',
            'use_unicode': True,
            'init_command': 'SET '
                            'innodb_strict_mode=1,'
                            'storage_engine=INNODB,'
                            'character_set_connection=utf8,'
                            'collation_connection=utf8_general_ci',
        },
        'ATOMIC_REQUESTS': True,
        'TEST': {
            'CHARSET': 'utf8',
            'COLLATION': 'utf8_general_ci',
        },
    })

DATABASES = {
    'default': DEFAULT_DATABASE,
}


SILENCED_SYSTEM_CHECKS = [
    'django_mysql.W003',
]

# Cache Settings
CACHE_PREFIX = 'kuma'
CACHE_COUNT_TIMEOUT = 60  # in seconds

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
        'TIMEOUT': CACHE_COUNT_TIMEOUT,
        'KEY_PREFIX': CACHE_PREFIX,
    },
    'memcache': {
        'BACKEND': 'memcached_hashring.backend.MemcachedHashRingCache',
        'TIMEOUT': CACHE_COUNT_TIMEOUT * 60,
        'KEY_PREFIX': CACHE_PREFIX,
        'LOCATION': config('MEMCACHE_SERVERS',
                           default='127.0.0.1:11211',
                           cast=Csv()),
    },
}

CACHEBACK_CACHE_ALIAS = 'memcache'

# Email
vars().update(config('EMAIL_URL',
                     default='console://',
                     cast=dj_email_url.parse))
EMAIL_SUBJECT_PREFIX = '[mdn] '

# Addresses email comes from
DEFAULT_FROM_EMAIL = 'notifications@developer.mozilla.org'
SERVER_EMAIL = 'server-error@developer.mozilla.org'

PLATFORM_NAME = platform.node()

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# If running in a Windows environment this must be set to the same as your
# system time zone.
TIME_ZONE = 'US/Pacific'

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = 'en-US'

# Accepted locales
MDN_LANGUAGES = (
    'en-US',    # English
    'af',       # Akrikaans
    'ar',       # Arabic
    'az',       # Azerbaijani
    'bm',       # Bambara
    'bn-BD',    # Bengali (Bangladesh)
    'bn-IN',    # Bengali (India)
    'ca',       # Catalan
    'cs',       # Czech
    'de',       # German
    'ee',       # Ewe
    'el',       # Greek
    'es',       # Spanish
    'fa',       # Persian
    'ff',       # Fulah
    'fi',       # Finnish
    'fr',       # French
    'fy-NL',    # Frisian (Netherlands)
    'ga-IE',    # Irish (Ireland)
    'ha',       # Hausa
    'he',       # Hebrew
    'hi-IN',    # Hindi (India)
    'hr',       # Croatian *** not in Pontoon
    'hu',       # Hungarian
    'id',       # Indonesian
    'ig',       # Igbo
    'it',       # Italian
    'ja',       # Japanese
    'ka',       # Georgian
    'kab',      # Kabyle
    'ko',       # Korean
    'ln',       # Lingala
    'mg',       # Malagasy
    'ml',       # Malayalam
    'ms',       # Malay
    'my',       # Burmese
    'nl',       # Dutch
    'pl',       # Polish
    'pt-BR',    # Portuguese (Brazil)
    'pt-PT',    # Portuguese (Portugal)
    'ro',       # Romanian
    'ru',       # Russian
    'son',      # Songhay
    'sq',       # Albanian
    'sr',       # Serbian
    'sr-Latn',  # Serbian (Latin)
    'sv-SE',    # Swedish (Sweden)
    'sw',       # Swahili
    'ta',       # Tamil
    'th',       # Thai
    'tl',       # Tagalog
    'tn',       # Tswana *** not in Pontoon
    'tr',       # Turkish
    'uk',       # Ukranian
    'vi',       # Vietnamese
    'wo',       # Wolof
    'xh',       # Xhosa
    'yo',       # Yoruba
    'zh-CN',    # Chinese (China)
    'zh-TW',    # Chinese (Taiwan, Province of China)
    'zu',       # Zulu
)

# Locales being considered for MDN. This makes the UI strings available for
# localization in Pontoon, but pages can not be translated into this language.
# https://developer.mozilla.org/en-US/docs/MDN/Contribute/Localize/Starting_a_localization
CANDIDATE_LANGUAGES = [
    'bg',       # Bulgarian
]

RTL_LANGUAGES = (
    'ar',
    'fa',
    'fa-IR',
    'he'
)

# Override generic locale handling with explicit mappings.
# Keys are the requested locale; values are the delivered locale.
LOCALE_ALIASES = {
    # Treat "English (United States)" as the canonical "English".
    'en': 'en-US',

    # Create aliases for over-specific locales.
    'bn': 'bn-BD',
    'fy': 'fy-NL',
    'ga': 'ga-IE',
    'gu': 'gu-IN',
    'hi': 'hi-IN',
    'hy': 'hy-AM',
    'pa': 'pa-IN',
    'sv': 'sv-SE',
    'ta': 'ta-LK',

    # Map a prefix to one of its multiple specific locales.
    'pt': 'pt-PT',
    'sr': 'sr-Cyrl',
    'zh': 'zh-CN',

    # Create aliases for locales which do not share a prefix.
    'nb-NO': 'no',
    'nn-NO': 'no',

    # Create aliases for locales which use region subtags to assume scripts.
    'zh-Hans': 'zh-CN',
    'zh-Hant': 'zh-TW',
}

LANGUAGE_URL_MAP = dict([(i.lower(), i) for i in MDN_LANGUAGES])

for requested_lang, delivered_lang in LOCALE_ALIASES.items():
    if delivered_lang in MDN_LANGUAGES:
        LANGUAGE_URL_MAP[requested_lang.lower()] = delivered_lang


def _get_locales():
    """
    Load LOCALES data from languages.json

    languages.json is from the product-details project:
    https://product-details.mozilla.org/1.0/languages.json
    """
    lang_path = path('kuma', 'settings', 'languages.json')
    with open(lang_path, 'r') as lang_file:
        json_locales = json.load(lang_file)

    locales = {}
    for locale, meta in json_locales.items():
        locales[locale] = _Language(meta['English'], meta['native'])
    return locales


LOCALES = _get_locales()
LANGUAGES = [(locale, LOCALES[locale].native) for locale in MDN_LANGUAGES]


def enable_candidate_languages():
    # Enable candidate languages for display and translation
    for locale in CANDIDATE_LANGUAGES:
        LANGUAGE_URL_MAP[locale.lower()] = locale
        LANGUAGES.append((locale, LOCALES[locale].native))


ENABLE_CANDIDATE_LANGUAGES = config('ENABLE_CANDIDATE_LANGUAGES',
                                    default=DEBUG,
                                    cast=bool)
if ENABLE_CANDIDATE_LANGUAGES:
    enable_candidate_languages()

# List of MindTouch locales mapped to Kuma locales.
#
# Language in MindTouch pages are first determined from the locale in the page
# title, with a fallback to the language in the page record.
#
# So, first MindTouch locales were inventoried like so:
#
#     mysql --skip-column-names -uroot wikidb -B \
#           -e 'select page_title from pages  where page_namespace=0' \
#           > page-titles.txt
#
#     grep '/' page-titles.txt | cut -d'/' -f1 | sort -f | uniq -ci | sort -rn
#
# Then, the database languages were inventoried like so:
#
#     select page_language, count(page_id) as ct
#     from pages group by page_language order by ct desc;
#
# Also worth noting, these are locales configured in the prod Control Panel:
#
# en,ar,ca,cs,de,el,es,fa,fi,fr,he,hr,hu,it,ja,
# ka,ko,nl,pl,pt,ro,ru,th,tr,uk,vi,zh-cn,zh-tw
#
# The Kuma side was picked from elements of the MDN_LANGUAGES list in
# settings.py, and a few were added to match MindTouch locales.
#
# Most of these end up being direct mappings, but it's instructive to go
# through the mapping exercise.

MT_TO_KUMA_LOCALE_MAP = {
    'en': 'en-US',
    'ja': 'ja',
    'pl': 'pl',
    'fr': 'fr',
    'es': 'es',
    '': 'en-US',
    'cn': 'zh-CN',
    'zh_cn': 'zh-CN',
    'zh-cn': 'zh-CN',
    'zh_tw': 'zh-TW',
    'zh-tw': 'zh-TW',
    'ko': 'ko',
    'pt': 'pt-PT',
    'de': 'de',
    'it': 'it',
    'ca': 'ca',
    'cs': 'cs',
    'ru': 'ru',
    'nl': 'nl',
    'hu': 'hu',
    'he': 'he',
    'el': 'el',
    'fi': 'fi',
    'tr': 'tr',
    'vi': 'vi',
    'ro': 'ro',
    'ar': 'ar',
    'th': 'th',
    'fa': 'fa',
    'ka': 'ka',
}

SITE_ID = 1

MDC_PAGES_DIR = path('..', 'mdc_pages')

# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True
USE_L10N = True
LOCALE_PATHS = (
    path('locale'),
)

# Absolute path to the directory that holds media.
# Example: "/home/media/media.lawrence.com/"
MEDIA_ROOT = path('media')

# Absolute path to the directory for the humans.txt file.
HUMANSTXT_ROOT = MEDIA_ROOT

# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash if there is a path component (optional in other cases).
# Examples: "http://media.lawrence.com", "http://example.com/media/"
MEDIA_URL = '/media/'
STATIC_URL = '/static/'
STATIC_ROOT = path('static')

SERVE_MEDIA = False

# Paths that don't require a locale prefix.
LANGUAGE_URL_IGNORED_PATHS = (
    'media',
    'admin',
    'robots.txt',
    'contribute.json',
    'services',
    'static',
    '1',
    'files',
    '@api',
    '__debug__',
    '.well-known',
    'users/github/login/callback/',
)

# Make this unique, and don't share it with anybody.
SECRET_KEY = config('SECRET_KEY',
                    default='#%tc(zja8j01!r#h_y)=hy!^k)9az74k+-ib&ij&+**s3-e^_z')

_CONTEXT_PROCESSORS = (
    'django.contrib.auth.context_processors.auth',
    'django.core.context_processors.debug',
    'django.core.context_processors.media',
    'django.core.context_processors.static',
    'django.core.context_processors.request',
    'django.core.context_processors.csrf',
    'django.contrib.messages.context_processors.messages',

    'kuma.core.context_processors.global_settings',
    'kuma.core.context_processors.i18n',
    'kuma.core.context_processors.next_url',

    'constance.context_processors.config',
)

MIDDLEWARE_CLASSES = (
    # LocaleURLMiddleware must be before any middleware that uses
    # kuma.core.urlresolvers.reverse() to add locale prefixes to URLs:
    'kuma.core.middleware.SetRemoteAddrFromForwardedFor',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'kuma.core.middleware.LocaleURLMiddleware',
    'kuma.wiki.middleware.DocumentZoneMiddleware',
    'kuma.wiki.middleware.ReadOnlyMiddleware',
    'kuma.core.middleware.Forbidden403Middleware',
    'django.middleware.common.CommonMiddleware',
    'kuma.core.middleware.RemoveSlashMiddleware',
    'commonware.middleware.NoVarySessionMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'kuma.core.anonymous.AnonymousIdentityMiddleware',
    'kuma.users.middleware.BanMiddleware',
    'waffle.middleware.WaffleMiddleware',
)

# Auth
AUTHENTICATION_BACKENDS = (
    'allauth.account.auth_backends.AuthenticationBackend',
)
AUTH_USER_MODEL = 'users.User'


PASSWORD_HASHERS = (
    'kuma.users.backends.Sha256Hasher',
    'django.contrib.auth.hashers.SHA1PasswordHasher',
    'django.contrib.auth.hashers.MD5PasswordHasher',
    'django.contrib.auth.hashers.UnsaltedMD5PasswordHasher',
)

USER_AVATAR_PATH = 'uploads/avatars/'
DEFAULT_AVATAR = STATIC_URL + 'img/avatar.png'
AVATAR_SIZES = [  # in pixels
    34,   # wiki document page
    48,   # user_link helper
    200,  # user pages
    220,  # default, e.g. used in feeds
]
ACCOUNT_ACTIVATION_DAYS = 30
MAX_AVATAR_FILE_SIZE = 131072  # 100k, in bytes

ROOT_URLCONF = 'kuma.urls'

STATICFILES_FINDERS = (
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'pipeline.finders.PipelineFinder',
)

STATICFILES_STORAGE = 'pipeline.storage.PipelineCachedStorage'

STATICFILES_DIRS = (
    path('kuma', 'static'),
    path('build', 'assets'),
    path('build', 'locale'),
)

# TODO: Figure out why changing the order of apps (for example, moving taggit
# higher in the list) breaks tests.
INSTALLED_APPS = (
    # django
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
    'django.contrib.messages',
    'flat',
    'django.contrib.admin',

    'django.contrib.sitemaps',
    'django.contrib.staticfiles',
    'soapbox',  # must be before kuma.wiki, or RemovedInDjango19Warning

    # MDN
    'kuma.core',
    'kuma.feeder',
    'kuma.landing',
    'kuma.search',
    'kuma.users',
    'kuma.wiki',
    'kuma.attachments',
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
    'kuma.users.providers.github',

    # util
    'django_jinja',
    'pipeline',
    'puente',
    'constance.backends.database',
    'constance',
    'waffle',
    'kuma.authkeys',
    'tidings',
    'djcelery',
    'taggit',
    'dbgettext',
    'honeypot',
    'cacheback',
    'django_extensions',
    'captcha',

    'kuma.dashboards',
    'statici18n',
    'rest_framework',
    'django_mysql',

    # other
    'kuma.humans',
)

# Feed fetcher config
FEEDER_TIMEOUT = 6  # in seconds

TEMPLATES = [
    {
        'BACKEND': 'django_jinja.backend.Jinja2',
        'DIRS': [path('jinja2')],
        'APP_DIRS': True,
        'OPTIONS': {
            # Use jinja2/ for jinja templates
            'app_dirname': 'jinja2',
            # Don't figure out which template loader to use based on
            # file extension
            'match_extension': '',
            'newstyle_gettext': True,
            'context_processors': _CONTEXT_PROCESSORS,
            'undefined': 'jinja2.Undefined',
            'extensions': [
                'jinja2.ext.do',
                'jinja2.ext.loopcontrols',
                'jinja2.ext.with_',
                'jinja2.ext.i18n',
                'jinja2.ext.autoescape',
                'puente.ext.i18n',
                'django_jinja.builtins.extensions.CsrfExtension',
                'django_jinja.builtins.extensions.CacheExtension',
                'django_jinja.builtins.extensions.TimezoneExtension',
                'django_jinja.builtins.extensions.UrlsExtension',
                'django_jinja.builtins.extensions.StaticFilesExtension',
                'django_jinja.builtins.extensions.DjangoFiltersExtension',
                'pipeline.jinja2.PipelineExtension',
                'waffle.jinja.WaffleExtension',
            ],
        }
    },
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [path('templates')],
        'APP_DIRS': False,
        'OPTIONS': {
            'debug': DEBUG,
            'context_processors': _CONTEXT_PROCESSORS,
            'loaders': [
                'django.template.loaders.filesystem.Loader',
                'django.template.loaders.app_directories.Loader',
            ],
        }
    },
]

PUENTE = {
    'BASE_DIR': ROOT,
    'TEXT_DOMAIN': 'django',
    # Tells the extract script what files to look for l10n in and what function
    # handles the extraction.
    'DOMAIN_METHODS': {
        'django': [
            ('kuma/**.py', 'python'),
            ('**/templates/**.html', 'django_babel.extract.extract_django'),
            ('**/jinja2/**.html', 'jinja2'),
            ('**/jinja2/**.ltxt', 'jinja2'),
        ],
        'javascript': [
            # We can't say **.js because that would dive into any libraries.
            ('kuma/static/js/*.js', 'javascript'),
            ('kuma/static/js/libs/ckeditor/source/plugins/mdn-**/*.js',
             'javascript'),
        ],
    },
    'PROJECT': 'MDN',
    'VERSION': '2017.0',
    'MSGID_BUGS_ADDRESS': 'dev-mdn@lists.mozilla.org',
}

STATICI18N_ROOT = 'build/locale'
STATICI18N_DOMAIN = 'javascript'

# Cache non-versioned static files for one week
WHITENOISE_MAX_AGE = 60 * 60 * 24 * 7

PIPELINE_CSS = {
    'mdn': {
        'source_filenames': (
            'css/font-awesome.css',
            'css/main.css',
        ),
        'output_filename': 'build/styles/mdn.css',
        'variant': 'datauri',
    },
    'jquery-ui': {
        'source_filenames': (
            'js/libs/jquery-ui-1.10.3.custom/css/ui-lightness/jquery-ui-1.10.3.custom.min.css',
            'styles/libs/jqueryui/moz-jquery-plugins.css',
            'css/jquery-ui-customizations.css',
        ),
        'output_filename': 'build/styles/jquery-ui.css',
    },
    'gaia': {
        'source_filenames': (
            'css/gaia.css',
        ),
        'output_filename': 'build/styles/gaia.css',
    },
    'home': {
        'source_filenames': (
            'css/home.css',
        ),
        'output_filename': 'build/styles/home.css',
        'variant': 'datauri',
    },
    'search': {
        'source_filenames': (
            'css/search.css',
        ),
        'output_filename': 'build/styles/search.css',
    },
    'search-suggestions': {
        'source_filenames': (
            'css/search-suggestions.css',
        ),
        'output_filename': 'build/styles/search-suggestions.css',
    },
    'wiki': {
        'source_filenames': (
            'css/wiki.css',
            'css/zones.css',
            'css/diff.css',

            # Custom build of our Prism theme
            'styles/libs/prism/prism.css',
            'styles/libs/prism/prism-line-highlight.css',
            'styles/libs/prism/prism-line-numbers.css',

            'js/prism-mdn/components/prism-json.css',
            'css/wiki-syntax.css',
        ),
        'output_filename': 'build/styles/wiki.css',
    },
    'wiki-revisions': {
        'source_filenames': (
            'css/wiki-revisions.css',
        ),
        'output_filename': 'build/styles/wiki-revisions.css',
    },
    'wiki-edit': {
        'source_filenames': (
            'css/wiki-edit.css',
        ),
        'output_filename': 'build/styles/wiki-edit.css',
    },
    'wiki-compat-tables': {
        'source_filenames': (
            'css/wiki-compat-tables.css',
        ),
        'output_filename': 'build/styles/wiki-compat-tables.css',
        'template_name': 'pipeline/javascript-array.jinja',
    },
    'sphinx': {
        'source_filenames': (
            'css/wiki.css',
            'css/sphinx.css',
        ),
        'output_filename': 'build/styles/sphinx.css',
    },
    'users': {
        'source_filenames': (
            'css/users.css',
        ),
        'output_filename': 'build/styles/users.css',
    },
    'tagit': {
        'source_filenames': (
            'styles/libs/jquery.tagit.css',
        ),
        'output_filename': 'build/styles/tagit.css',
    },
    'promote': {
        'source_filenames': (
            'css/promote.css',
        ),
        'output_filename': 'build/styles/promote.css',
    },
    'error': {
        'source_filenames': (
            'css/error.css',
        ),
        'output_filename': 'build/styles/error.css',
    },
    'error-404': {
        'source_filenames': (
            'css/error.css',
            'css/error-404.css',
        ),
        'output_filename': 'build/styles/error-404.css',
    },
    'dashboards': {
        'source_filenames': (
            'css/dashboards.css',
            'css/diff.css',
        ),
        'output_filename': 'build/styles/dashboards.css',
    },
    'submission': {
        'source_filenames': (
            'css/submission.css',
        ),
        'output_filename': 'build/styles/submission.css',
    },
    'user-banned': {
        'source_filenames': (
            'css/user-banned.css',
        ),
        'output_filename': 'build/styles/user-banned.css',
    },
    'error-403-alternate': {
        'source_filenames': (
            'css/error-403-alternate.css',
        ),
        'output_filename': 'build/styles/error-403-alternate.css',
    },
    'fellowship': {
        'source_filenames': (
            'css/fellowship.css',
        ),
        'output_filename': 'build/styles/fellowship.css',
    },
    'editor-content': {
        'source_filenames': (
            'css/main.css',
            'css/wiki.css',
            'css/wiki-wysiwyg.css',
            'css/wiki-syntax.css',
            'styles/libs/font-awesome/css/font-awesome.min.css',
        ),
        'output_filename': 'build/styles/editor-content.css',
        'template_name': 'pipeline/javascript-array.jinja',
    },
}

PIPELINE_JS = {
    'main': {
        'source_filenames': (
            'js/libs/jquery/jquery.js',
            'js/components.js',
            'js/analytics.js',
            'js/main.js',
            'js/auth.js',
            'js/libs/fontfaceobserver/fontfaceobserver.js',
            'js/fonts.js',
        ),
        'output_filename': 'build/js/main.js',
    },
    'users': {
        'source_filenames': (
            'js/libs/tag-it.js',
            'js/moz-jquery-plugins.js',
            'js/users.js',
        ),
        'output_filename': 'build/js/users.js',
        'extra_context': {
            'async': True,
        },
    },
    'dashboard': {
        'source_filenames': (
            'js/dashboard.js',
        ),
        'output_filename': 'build/js/dashboard.js',
        'extra_context': {
            'async': True,
        },
    },
    'jquery-ui': {
        'source_filenames': (
            'js/libs/jquery-ui-1.10.3.custom/js/jquery-ui-1.10.3.custom.min.js',
            'js/moz-jquery-plugins.js',
        ),
        'output_filename': 'build/js/jquery-ui.js',
    },
    'search': {
        'source_filenames': (
            'js/search.js',
            'js/search-navigator.js',
        ),
        'output_filename': 'build/js/search.js',
        'extra_context': {
            'async': True,
        },
    },
    'framebuster': {
        'source_filenames': (
            'js/framebuster.js',
        ),
        'output_filename': 'build/js/framebuster.js',
    },
    'syntax-prism': {
        'source_filenames': (
            # Custom Prism build
            "js/libs/prism/prism-core.js",
            "js/libs/prism/prism-markup.js",
            "js/libs/prism/prism-css.js",
            "js/libs/prism/prism-clike.js",
            "js/libs/prism/prism-javascript.js",
            "js/libs/prism/prism-css-extras.js",
            "js/libs/prism/prism-rust.js",
            "js/libs/prism/prism-line-highlight.js",
            "js/libs/prism/prism-line-numbers.js",

            'js/prism-mdn/components/prism-json.js',
            'js/syntax-prism.js',
        ),
        'output_filename': 'build/js/syntax-prism.js',
        'template_name': 'pipeline/javascript-array.jinja',
    },
    'search-suggestions': {
        'source_filenames': (
            'js/search-suggestions.js',
        ),
        'output_filename': 'build/js/search-suggestions.js',
    },
    'wiki': {
        'source_filenames': (
            'js/search-navigator.js',
            'js/wiki.js',
            'js/wiki-samples.js',
        ),
        'output_filename': 'build/js/wiki.js',
        'extra_context': {
            'async': True,
        },
    },
    'wiki-edit': {
        'source_filenames': (
            'js/wiki-edit.js',
            'js/libs/tag-it.js',
            'js/wiki-tags-edit.js',
        ),
        'output_filename': 'build/js/wiki-edit.js',
    },
    'wiki-move': {
        'source_filenames': (
            'js/wiki-move.js',
        ),
        'output_filename': 'build/js/wiki-move.js',
        'extra_context': {
            'async': True,
        },
    },
    'wiki-compat-tables': {
        'source_filenames': (
            'js/wiki-compat-tables.js',
        ),
        'output_filename': 'build/js/wiki-compat-tables.js',
        'template_name': 'pipeline/javascript-array.jinja',
    },
    'helpfulness': {
        'source_filenames': (
            'js/helpfulness.js',
        ),
        'output_filename': 'build/js/helpfulness.js',
        'extra_context': {
            'async': True,
        },
    },
    'task-completion': {
        'source_filenames': (
            'js/task-completion.js',
        ),
        'output_filename': 'build/js/task-completion.js',
        'extra_context': {
            'async': True,
        },
    },
    'newsletter': {
        'source_filenames': (
            'js/newsletter.js',
        ),
        'output_filename': 'build/js/newsletter.js',
        'extra_context': {
            'async': True,
        },
    },
    'fellowship': {
        'source_filenames': (
            'js/fellowship.js',
        ),
        'output_filename': 'build/js/fellowship.js',
        'extra_context': {
            'async': True,
        },
    },
    'ckeditor-prod': {
        'source_filenames': (
            'js/libs/ckeditor/build/ckeditor/ckeditor.js',
            'js/libs/ckeditor/build/ckeditor/adapters/jquery.js',
        ),
        'output_filename': 'build/js/ckeditor-prod.js',
    },
    'ckeditor-dev': {
        'source_filenames': (
            'js/libs/ckeditor/source/ckeditor/ckeditor.js',
            'js/libs/ckeditor/source/ckeditor/adapters/jquery.js',
        ),
        'output_filename': 'build/js/ckeditor-dev.js',
    },
    'html5shiv': {
        'source_filenames': (
            'js/libs/html5shiv/html5shiv.js',
        ),
        'output_filename': 'build/js/html5shiv.js',
    },
    'selectivizr': {
        'source_filenames': (
            'js/libs/selectivizr/selectivizr.js',
        ),
        'output_filename': 'build/js/selectivizr.js',
    },
    'ace': {
        'source_filenames': (
            'js/libs/ace/ace.js',
            'js/libs/ace/mode-javascript.js',
            'js/libs/ace/theme-dreamweaver.js',
            'js/libs/ace/worker-javascript.js',
        ),
        'output_filename': 'build/js/ace.js',
    },
}

PIPELINE = {
    'STYLESHEETS': PIPELINE_CSS,
    'JAVASCRIPT': PIPELINE_JS,
    'DISABLE_WRAPPER': True,
    'CSS_COMPRESSOR': config('PIPELINE_CSS_COMPRESSOR',
                             default='kuma.core.pipeline.cleancss.CleanCSSCompressor'),
    'JS_COMPRESSOR': config('PIPELINE_JS_COMPRESSOR',
                            default='pipeline.compressors.uglifyjs.UglifyJSCompressor'),
    'PIPELINE_ENABLED': config('PIPELINE_ENABLED', not DEBUG, cast=bool),
    'PIPELINE_COLLECTOR_ENABLED': config('PIPELINE_COLLECTOR_ENABLED', not DEBUG, cast=bool),
}
# Pipeline compressor overrides
# For example, PIPELINE_YUGLIFY_BINARY will set YUGLIFY_BINARY
# https://django-pipeline.readthedocs.io/en/latest/compressors.html
pipeline_overrides = (
    'YUGLIFY_BINARY',
    'YUGLIFY_CSS_ARGUMENTS'
    'YUGLIFY_JS_ARGUMENTS',
    'YUI_BINARY',
    'YUI_CSS_ARGUMENTS',
    'YUI_JS_ARGUMENTS',
    'CLOSURE_BINARY',
    'CLOSURE_ARGUMENTS',
    'UGLIFYJS_BINARY',
    'UGLIFYJS_ARGUMENTS',
    'CSSTIDY_BINARY',
    'CSSTIDY_ARGUMENTS',
    'CSSMIN_BINARY',
    'CSSMIN_ARGUMENTS',
)
for override in pipeline_overrides:
    env_value = config('PIPELINE_' + override, default=None)
    if env_value is not None:
        PIPELINE[override] = env_value

#
# Session cookies
SESSION_COOKIE_SECURE = config('SESSION_COOKIE_SECURE',
                               default=True, cast=bool)
SESSION_COOKIE_HTTPONLY = True

# bug 856061
ALLOWED_HOSTS = config('ALLOWED_HOSTS',
                       default='developer-local.allizom.org, mdn-local.mozillademos.org',
                       cast=Csv())

# Maximum length of the filename. Forms should use this and raise
# ValidationError if the length is exceeded.
# @see http://code.djangoproject.com/ticket/9893
# Columns are 250 but this leaves 50 chars for the upload_to prefix
MAX_FILENAME_LENGTH = 200
MAX_FILEPATH_LENGTH = 250

ATTACHMENT_HOST = 'mdn.mozillademos.org'

# Video settings, hard coded here for now.
# TODO: figure out a way that doesn't need these values
WIKI_VIDEO_WIDTH = 640
WIKI_VIDEO_HEIGHT = 480

IMAGE_MAX_FILESIZE = 1048576  # 1 megabyte, in bytes
THUMBNAIL_SIZE = 120  # Thumbnail size, in pixels
THUMBNAIL_UPLOAD_PATH = 'uploads/images/thumbnails/'
IMAGE_UPLOAD_PATH = 'uploads/images/'
# A string listing image mime types to accept, comma separated.
# String must not contain double quotes!
IMAGE_ALLOWED_MIMETYPES = 'image/jpeg,image/png,image/gif'

# Email
EMAIL_BACKEND = 'django.core.mail.backends.filebased.EmailBackend'
EMAIL_FILE_PATH = '/tmp/kuma-messages'

BROKER_URL = config('BROKER_URL',
                    default='amqp://kuma:kuma@developer-local:5672/kuma')

CELERY_ALWAYS_EAGER = config('CELERY_ALWAYS_EAGER', True, cast=bool)
CELERY_SEND_TASK_ERROR_EMAILS = True
CELERY_SEND_EVENTS = True
CELERY_SEND_TASK_SENT_EVENT = True
CELERY_TRACK_STARTED = True
CELERYD_LOG_LEVEL = logging.INFO
CELERYD_CONCURRENCY = config('CELERYD_CONCURRENCY', default=4, cast=int)

CELERY_RESULT_BACKEND = 'djcelery.backends.database:DatabaseBackend'
CELERYBEAT_SCHEDULER = 'djcelery.schedulers.DatabaseScheduler'

CELERY_ACCEPT_CONTENT = ['pickle']

CELERY_IMPORTS = (
    'tidings.events',
)

CELERY_ANNOTATIONS = {
    'cacheback.tasks.refresh_cache': {
        'rate_limit': '120/m',
    }
}

CELERY_ROUTES = {
    'cacheback.tasks.refresh_cache': {
        'queue': 'mdn_purgeable'
    },
    'kuma.core.tasks.clean_sessions': {
        'queue': 'mdn_purgeable'
    },
    'kuma.core.tasks.delete_old_ip_bans': {
        'queue': 'mdn_purgeable'
    },
    'kuma.humans.tasks.humans_txt': {
        'queue': 'mdn_purgeable'
    },
    'kuma.wiki.tasks.build_index_sitemap': {
        'queue': 'mdn_purgeable'
    },
    'kuma.wiki.tasks.build_locale_sitemap': {
        'queue': 'mdn_purgeable'
    },
    'kuma.wiki.tasks.build_sitemaps': {
        'queue': 'mdn_purgeable'
    },
    'kuma.wiki.tasks.delete_old_revision_ips': {
        'queue': 'mdn_purgeable'
    },
    'kuma.wiki.tasks.tidy_revision_content': {
        'queue': 'mdn_purgeable'
    },
    'kuma.wiki.tasks.update_community_stats': {
        'queue': 'mdn_purgeable'
    },
    'kuma.search.tasks.prepare_index': {
        'queue': 'mdn_search'
    },
    'kuma.search.tasks.finalize_index': {
        'queue': 'mdn_search'
    },
    'kuma.wiki.tasks.index_documents': {
        'queue': 'mdn_search'
    },
    'kuma.wiki.tasks.unindex_documents': {
        'queue': 'mdn_search'
    },
    'kuma.users.tasks.send_welcome_email': {
        'queue': 'mdn_emails'
    },
    'kuma.users.tasks.email_render_document_progress': {
        'queue': 'mdn_emails'
    },
    'kuma.wiki.tasks.send_first_edit_email': {
        'queue': 'mdn_emails'
    },
    'tidings.events._fire_task': {
        'queue': 'mdn_emails'
    },
    'tidings.events.claim_watches': {
        'queue': 'mdn_emails'
    },
    'kuma.wiki.tasks.move_page': {
        'queue': 'mdn_wiki'
    },
    'kuma.wiki.tasks.acquire_render_lock': {
        'queue': 'mdn_wiki'
    },
    'kuma.wiki.tasks.release_render_lock': {
        'queue': 'mdn_wiki'
    },
    'kuma.wiki.tasks.render_document': {
        'queue': 'mdn_wiki'
    },
    'kuma.wiki.tasks.render_document_chunk': {
        'queue': 'mdn_wiki'
    },
    'kuma.wiki.tasks.render_stale_documents': {
        'queue': 'mdn_wiki'
    },
    'kuma.wiki.tasks.build_json_data_for_document': {
        'queue': 'mdn_wiki'
    },
}

# Wiki rebuild settings
WIKI_REBUILD_TOKEN = 'kuma:wiki:full-rebuild'
WIKI_REBUILD_ON_DEMAND = False

# Anonymous user cookie
ANONYMOUS_COOKIE_NAME = 'KUMA_ANONID'
ANONYMOUS_COOKIE_MAX_AGE = 30 * 86400  # Seconds

# Top contributors cache settings
TOP_CONTRIBUTORS_CACHE_KEY = 'kuma:TopContributors'
TOP_CONTRIBUTORS_CACHE_TIMEOUT = 60 * 60 * 12

# Do not change this without also deleting all wiki documents:
WIKI_DEFAULT_LANGUAGE = LANGUAGE_CODE

TIDINGS_FROM_ADDRESS = 'notifications@developer.mozilla.org'
TIDINGS_CONFIRM_ANONYMOUS_WATCHES = True

CONSTANCE_BACKEND = 'constance.backends.database.DatabaseBackend'
# must be an entry in the CACHES setting!
CONSTANCE_DATABASE_CACHE_BACKEND = 'memcache'

# Settings and defaults controllable by Constance in admin
CONSTANCE_CONFIG = dict(
    BETA_GROUP_NAME=(
        'Beta Testers',
        'Name of the django.contrib.auth.models.Group to use as beta testers'
    ),
    KUMA_DOCUMENT_RENDER_TIMEOUT=(
        180.0,
        'Maximum seconds to wait before considering a rendering in progress or '
        'scheduled as failed and allowing another attempt.'
    ),
    KUMA_DOCUMENT_FORCE_DEFERRED_TIMEOUT=(
        10.0,
        'Maximum seconds to allow a document to spend rendering during the '
        'response cycle before flagging it to be sent to the deferred rendering '
        'queue for future renders.'
    ),
    KUMASCRIPT_TIMEOUT=(
        0.0,
        'Maximum seconds to wait for a response from the kumascript service. '
        'On timeout, the document gets served up as-is and without macro '
        'evaluation as an attempt at graceful failure. NOTE: a value of 0 '
        'disables kumascript altogether.'
    ),
    KUMASCRIPT_MAX_AGE=(
        600,
        'Maximum acceptable age (in seconds) of a cached response from '
        'kumascript. Passed along in a Cache-Control: max-age={value} header, '
        'which tells kumascript whether or not to serve up a cached response.'
    ),
    KUMA_CUSTOM_SAMPLE_CSS_PATH=(
        '/en-US/docs/Template:CustomSampleCSS',
        'Path to a wiki document whose raw content will be loaded as a CSS '
        'stylesheet for live sample template. Will also cause the ?raw '
        'parameter for this path to send a Content-Type: text/css header. Empty '
        'value disables the feature altogether.',
    ),
    DIFF_CONTEXT_LINES=(
        0,
        'Number of lines of context to show in diff display.',
    ),
    FEED_DIFF_CONTEXT_LINES=(
        3,
        'Number of lines of context to show in feed diff display.',
    ),
    WIKI_ATTACHMENT_ALLOWED_TYPES=(
        'image/gif image/jpeg image/png image/svg+xml text/html image/vnd.adobe.photoshop',
        'Allowed file types for wiki file attachments',
    ),
    WIKI_ATTACHMENTS_KEEP_TRASHED_DAYS=(
        14,
        "Number of days to keep the trashed attachments files before they "
        "are removed from the file storage"
    ),
    KUMA_WIKI_HREF_BLOCKED_PROTOCOLS=(
        '(?i)^\s*(data\:?)',
        '(Deprecated) Regex for protocols that are blocked for A HREFs'
    ),
    KUMA_WIKI_IFRAME_ALLOWED_HOSTS=(
        '^https?\:\/\/(developer-local.allizom.org|developer.allizom.org|mozillademos.org|testserver|localhost\:8000|(www.)?youtube.com\/embed\/(\.*))',
        'Regex comprised of domain names that are allowed for IFRAME SRCs'
    ),
    GOOGLE_ANALYTICS_ACCOUNT=(
        '0',
        'Google Analytics Tracking Account Number (0 to disable)',
    ),
    GOOGLE_ANALYTICS_CREDENTIALS=(
        '{}',
        'Google Analytics (read-only) API credentials',
    ),
    OPTIMIZELY_PROJECT_ID=(
        '',
        'The ID value for optimizely Project Code script'
    ),
    BLEACH_ALLOWED_TAGS=(
        json.dumps([
            'a', 'p', 'div',
        ]),
        "JSON array of tags allowed through Bleach",
    ),
    BLEACH_ALLOWED_ATTRIBUTES=(
        json.dumps({
            '*': ['id', 'class', 'style', 'lang'],
        }),
        "JSON object associating tags with lists of allowed attributes",
    ),
    BLEACH_ALLOWED_STYLES=(
        json.dumps([
            'font-size', 'text-align',
        ]),
        "JSON array listing CSS styles allowed on tags",
    ),
    WIKI_DOCUMENT_TAG_SUGGESTIONS=(
        json.dumps([
            "Accessibility", "AJAX", "API", "Apps", "B2G OS",
            "Canvas", "CSS", "Device", "DOM", "Events",
            "Extensions", "Firefox", "Firefox OS", "Games",
            "Gecko", "Graphics", "Internationalization", "History", "HTML", "HTTP", "JavaScript", "Layout",
            "Localization", "MDN", "Mobile", "Mozilla",
            "Networking", "Persona", "Places", "Plugins", "Protocols",

            "Reference", "Tutorial", "Landing",

            "junk", "NeedsMarkupWork", "NeedsContent", "NeedsExample",
        ]),
        "JSON array listing tag suggestions for documents"
    ),
    COMMON_REASONS_TO_BAN_USERS=(
        json.dumps([
            'Spam', 'Profile Spam ', 'Sandboxing', 'Incorrect Translation', 'Penetration Testing',
        ]),
        "JSON array listing some common reasons to ban users",
    ),
    SESSION_CLEANUP_CHUNK_SIZE=(
        1000,
        'Number of expired sessions to cleanup up in one go.',
    ),
    WELCOME_EMAIL_FROM=(
        "Janet Swisher <no-reply@mozilla.org>",
        'Email address from which welcome emails will be sent',
    ),
    EMAIL_LIST_SPAM_WATCH=(
        "mdn-spam-watch@mozilla.com",
        "Email address to notify of possible spam (first edits, blocked edits)",
    ),
    AKISMET_KEY=(
        '',
        'API key for Akismet spam checks, leave empty to disable'
    ),
    RECAPTCHA_PUBLIC_KEY=(
        '',
        'ReCAPTCHA public key, leave empty to disable'
    ),
    RECAPTCHA_PRIVATE_KEY=(
        '',
        'ReCAPTCHA private key, leave empty to disable'
    ),
    EMAIL_LIST_MDN_ADMINS=(
        'mdn-admins@mozilla.org',
        'Email address to request admin intervention'
    ),
)

KUMASCRIPT_URL_TEMPLATE = config('KUMASCRIPT_URL_TEMPLATE',
                                 default='http://localhost:9080/docs/{path}')

# Elasticsearch related settings.
ES_DEFAULT_NUM_REPLICAS = 1
ES_DEFAULT_NUM_SHARDS = 5
ES_DEFAULT_REFRESH_INTERVAL = '5s'
ES_INDEX_PREFIX = 'mdn'
ES_INDEXES = {'default': 'main_index'}
# Specify the extra timeout in seconds for the indexing ES connection.
ES_INDEXING_TIMEOUT = 30
ES_LIVE_INDEX = False
ES_URLS = config('ES_URLS', default='127.0.0.1:9200', cast=Csv())

LOG_LEVEL = logging.WARN
SYSLOG_TAG = 'http_app_kuma'

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse',
        },
    },
    'formatters': {
        'default': {
            'format': '{0}: %(asctime)s %(name)s:%(levelname)s %(message)s: '
                      '%(pathname)s:%(lineno)s'.format(SYSLOG_TAG),
        }
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'default',
            'level': LOG_LEVEL,
        },
        'mail_admins': {
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['require_debug_false'],
            'level': logging.ERROR,
        },
    },
    'loggers': {
        'kuma': {
            'handlers': ['console'],
            'propagate': True,
            'level': logging.ERROR,
        },
        'django.request': {
            'handlers': ['console'],
            'propagate': True,
            'level': logging.ERROR,
        },
        'elasticsearch': {
            'handlers': ['console'],
            'level': logging.ERROR,
        },
        'urllib3': {
            'handlers': ['console'],
            'level': logging.ERROR,
        },
        'cacheback': {
            'handlers': ['console'],
            'level': logging.ERROR,
        }
    },
}

CSRF_COOKIE_SECURE = config('CSRF_COOKIE_SECURE', default=True, cast=bool)
X_FRAME_OPTIONS = 'DENY'

DBGETTEXT_PATH = 'kuma/core/'
DBGETTEXT_ROOT = 'translations'


def get_user_url(user):
    from kuma.core.urlresolvers import reverse
    return reverse('users.user_detail', args=[user.username])


ABSOLUTE_URL_OVERRIDES = {
    'users.user': get_user_url
}

USE_X_FORWARDED_HOST = True

# Honor the X-Forwarded-Proto header for environments like local dev VM that
# uses Apache mod_proxy instead of mod_wsgi
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')

# Auth and permissions related constants
LOGIN_URL = reverse_lazy('account_login')
LOGOUT_URL = reverse_lazy('account_logout')
LOGIN_REDIRECT_URL = reverse_lazy('home')

# django-allauth configuration
ACCOUNT_LOGOUT_REDIRECT_URL = '/'
ACCOUNT_DEFAULT_HTTP_PROTOCOL = config('ACCOUNT_DEFAULT_HTTP_PROTOCOL',
                                       default='https')
ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_LOGOUT_ON_GET = True
ACCOUNT_USERNAME_MIN_LENGTH = 3
ACCOUNT_ADAPTER = 'kuma.users.adapters.KumaAccountAdapter'
ACCOUNT_SIGNUP_FORM_CLASS = None
ACCOUNT_UNIQUE_EMAIL = False

SOCIALACCOUNT_ADAPTER = 'kuma.users.adapters.KumaSocialAccountAdapter'
SOCIALACCOUNT_EMAIL_VERIFICATION = 'mandatory'
SOCIALACCOUNT_EMAIL_REQUIRED = True
SOCIALACCOUNT_AUTO_SIGNUP = False  # forces the use of the signup view
SOCIALACCOUNT_QUERY_EMAIL = True  # used by the custom github provider

HONEYPOT_FIELD_NAME = 'website'

BLOCKABLE_USER_AGENTS = [
    "Yahoo! Slurp",
    "Googlebot",
    "bingbot",
    "Applebot",
    "YandexBot",
    "Baiduspider",
    "CCBot",
    "ScoutJet",
    "wget",
    "curl",
]

# TODO: Once using DRF more we need to make that exception handler more generic
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'kuma.search.utils.search_exception_handler'
}

SENTRY_DSN = config('SENTRY_DSN', default=None)

if SENTRY_DSN:
    INSTALLED_APPS = INSTALLED_APPS + (
        'raven.contrib.django.raven_compat',
    )

# Tell django-recaptcha we want to use "No CAPTCHA".
# Note: The API keys are located in Django constance.
NOCAPTCHA = True  # Note: Using No Captcha implies SSL.

# Tell django-taggit to use case-insensitive search for existing tags
TAGGIT_CASE_INSENSITIVE = True