mygpo/settings.py

   1 # Django settings for mygpo project.
   2 #
   3 # This file is part of my.gpodder.org.
   4 #
   5 # my.gpodder.org is free software: you can redistribute it and/or modify it
   6 # under the terms of the GNU Affero General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or (at your
   8 # option) any later version.
   9 #
  10 # my.gpodder.org is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
  13 # License for more details.
  14 #
  15 # You should have received a copy of the GNU Affero General Public License
  16 # along with my.gpodder.org. If not, see <http://www.gnu.org/licenses/>.
  17 #
  18
  19 import re
  20 import sys
  21 import os.path
  22 import dj_database_url
  23
  24
  25 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
  26
  27
  28 def get_bool(name, default):
  29     return os.getenv(name, str(default)).lower() == 'true'
  30
  31
  32 def get_intOrNone(name, default):
  33     """ Parses the env variable, accepts ints and literal None"""
  34     value = os.getenv(name, str(default))
  35     if value.lower() == 'none':
  36         return None
  37     return int(value)
  38
  39
  40 DEBUG = get_bool('DEBUG', False)
  41
  42 ADMINS = re.findall(r'\s*([^<]+) <([^>]+)>\s*', os.getenv('ADMINS', ''))
  43
  44 MANAGERS = ADMINS
  45
  46 DATABASES = {
  47     'default': dj_database_url.config(
  48         default='postgres://mygpo:mygpo@localhost/mygpo'),
  49 }
  50
  51
  52 _cache_used = bool(os.getenv('CACHE_BACKEND', False))
  53
  54 if _cache_used:
  55     CACHES = {}
  56     CACHES['default'] = {
  57         'BACKEND': os.getenv(
  58             'CACHE_BACKEND',
  59             'django.core.cache.backends.memcached.MemcachedCache'),
  60         'LOCATION': os.getenv('CACHE_LOCATION'),
  61     }
  62
  63
  64 # Local time zone for this installation. Choices can be found here:
  65 # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
  66 # although not all choices may be available on all operating systems.
  67 # If running in a Windows environment this must be set to the same as your
  68 # system time zone.
  69 TIME_ZONE = 'UTC'
  70
  71 # Language code for this installation. All choices can be found here:
  72 # http://www.i18nguy.com/unicode/language-identifiers.html
  73 LANGUAGE_CODE = 'en-us'
  74
  75 SITE_ID = 1
  76
  77 # If you set this to False, Django will make some optimizations so as not
  78 # to load the internationalization machinery.
  79 USE_I18N = True
  80
  81 STATIC_ROOT = 'staticfiles'
  82 STATIC_URL = '/media/'
  83
  84 STATICFILES_DIRS = (
  85     os.path.abspath(os.path.join(BASE_DIR, '..', 'htdocs', 'media')),
  86 )
  87
  88
  89 TEMPLATES = [{
  90     'BACKEND': 'django.template.backends.django.DjangoTemplates',
  91     'DIRS': [],
  92     'OPTIONS': {
  93         'debug': DEBUG,
  94         'context_processors': [
  95                 'django.contrib.auth.context_processors.auth',
  96                 'django.template.context_processors.debug',
  97                 'django.template.context_processors.i18n',
  98                 'django.template.context_processors.media',
  99                 'django.template.context_processors.static',
 100                 'django.template.context_processors.tz',
 101                 'django.contrib.messages.context_processors.messages',
 102                 'mygpo.web.google.analytics',
 103                 'mygpo.web.google.adsense',
 104                 # make the debug variable available in templates
 105                 # https://docs.djangoproject.com/en/dev/ref/templates/api/#django-core-context-processors-debug
 106                 'django.core.context_processors.debug',
 107
 108                 # required so that the request obj can be accessed from
 109                 # templates. this is used to direct users to previous
 110                 # page after login
 111                 'django.core.context_processors.request',
 112         ],
 113         'loaders': [
 114             ('django.template.loaders.cached.Loader', [
 115                 'django.template.loaders.app_directories.Loader',
 116             ]),
 117         ],
 118     },
 119 }]
 120
 121
 122 MIDDLEWARE_CLASSES = (
 123     'django.middleware.common.CommonMiddleware',
 124     'django.middleware.csrf.CsrfViewMiddleware',
 125     'django.contrib.sessions.middleware.SessionMiddleware',
 126     'django.contrib.auth.middleware.AuthenticationMiddleware',
 127     'django.middleware.locale.LocaleMiddleware',
 128     'django.contrib.messages.middleware.MessageMiddleware',
 129 )
 130
 131 ROOT_URLCONF = 'mygpo.urls'
 132
 133 INSTALLED_APPS = (
 134     'django.contrib.contenttypes',
 135     'django.contrib.messages',
 136     'django.contrib.admin',
 137     'django.contrib.humanize',
 138     'django.contrib.auth',
 139     'django.contrib.sessions',
 140     'django.contrib.staticfiles',
 141     'django.contrib.sites',
 142     'djcelery',
 143     'mygpo.core',
 144     'mygpo.podcasts',
 145     'mygpo.chapters',
 146     'mygpo.search',
 147     'mygpo.users',
 148     'mygpo.api',
 149     'mygpo.web',
 150     'mygpo.publisher',
 151     'mygpo.subscriptions',
 152     'mygpo.history',
 153     'mygpo.favorites',
 154     'mygpo.usersettings',
 155     'mygpo.data',
 156     'mygpo.userfeeds',
 157     'mygpo.suggestions',
 158     'mygpo.directory',
 159     'mygpo.categories',
 160     'mygpo.episodestates',
 161     'mygpo.maintenance',
 162     'mygpo.share',
 163     'mygpo.administration',
 164     'mygpo.pubsub',
 165     'mygpo.podcastlists',
 166     'mygpo.votes',
 167 )
 168
 169 try:
 170     import debug_toolbar
 171     INSTALLED_APPS += ('debug_toolbar', )
 172
 173 except ImportError:
 174     pass
 175
 176
 177 try:
 178     import opbeat
 179
 180     if not DEBUG:
 181         INSTALLED_APPS += ('opbeat.contrib.django', )
 182
 183         # add opbeat middleware to the beginning of the middleware classes list
 184         MIDDLEWARE_CLASSES = \
 185             ('opbeat.contrib.django.middleware.OpbeatAPMMiddleware',) + \
 186             MIDDLEWARE_CLASSES
 187
 188 except ImportError:
 189     pass
 190
 191
 192 ACCOUNT_ACTIVATION_DAYS = int(os.getenv('ACCOUNT_ACTIVATION_DAYS', 7))
 193
 194 AUTHENTICATION_BACKENDS = (
 195     'mygpo.users.backend.CaseInsensitiveModelBackend',
 196     'mygpo.web.auth.EmailAuthenticationBackend',
 197 )
 198
 199 SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"
 200
 201 # TODO: use (default) JSON serializer for security
 202 # this would currently fail as we're (de)serializing datetime objects
 203 # https://docs.djangoproject.com/en/1.5/topics/http/sessions/#session-serialization
 204 SESSION_SERIALIZER = 'django.contrib.sessions.serializers.PickleSerializer'
 205
 206
 207 MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'
 208
 209 USER_CLASS = 'mygpo.users.models.User'
 210
 211 LOGIN_URL = '/login/'
 212
 213 CSRF_FAILURE_VIEW = 'mygpo.web.views.csrf_failure'
 214
 215
 216 DEFAULT_FROM_EMAIL = os.getenv('DEFAULT_FROM_EMAIL', '')
 217
 218 SECRET_KEY = os.getenv('SECRET_KEY', '')
 219
 220 if 'test' in sys.argv:
 221     SECRET_KEY = 'test'
 222
 223 GOOGLE_ANALYTICS_PROPERTY_ID = os.getenv('GOOGLE_ANALYTICS_PROPERTY_ID', '')
 224
 225 DIRECTORY_EXCLUDED_TAGS = os.getenv('DIRECTORY_EXCLUDED_TAGS', '').split()
 226
 227 FLICKR_API_KEY = os.getenv('FLICKR_API_KEY', '')
 228
 229 SOUNDCLOUD_CONSUMER_KEY = os.getenv('SOUNDCLOUD_CONSUMER_KEY', '')
 230
 231 MAINTENANCE = get_bool('MAINTENANCE', False)
 232
 233
 234 ALLOWED_HOSTS = ['*']
 235
 236
 237 LOGGING = {
 238     'version': 1,
 239     'disable_existing_loggers': False,
 240     'formatters': {
 241         'verbose': {
 242             'format': '%(asctime)s %(name)s %(levelname)s %(message)s',
 243         },
 244     },
 245     'filters': {
 246         'require_debug_false': {
 247             '()': 'django.utils.log.RequireDebugFalse'
 248         },
 249     },
 250     'handlers': {
 251         'console': {
 252             'level': os.getenv('LOGGING_CONSOLE_LEVEL', 'DEBUG'),
 253             'class': 'logging.StreamHandler',
 254             'formatter': 'verbose',
 255         },
 256         'mail_admins': {
 257             'level': 'ERROR',
 258             'filters': ['require_debug_false'],
 259             'class': 'django.utils.log.AdminEmailHandler',
 260         },
 261     },
 262     'loggers': {
 263         'django': {
 264             'handlers': os.getenv('LOGGING_DJANGO_HANDLERS',
 265                                   'console').split(),
 266             'propagate': True,
 267             'level': os.getenv('LOGGING_DJANGO_LEVEL', 'WARN'),
 268         },
 269         'mygpo': {
 270             'handlers': os.getenv('LOGGING_MYGPO_HANDLERS', 'console').split(),
 271             'level': os.getenv('LOGGING_MYGPO_LEVEL', 'INFO'),
 272         },
 273         'celery': {
 274             'handlers': os.getenv('LOGGING_CELERY_HANDLERS',
 275                                   'console').split(),
 276             'level': os.getenv('LOGGING_CELERY_LEVEL', 'DEBUG'),
 277         },
 278     },
 279 }
 280
 281 _use_log_file = bool(os.getenv('LOGGING_FILENAME', False))
 282
 283 if _use_log_file:
 284     LOGGING['handlers']['file'] = {
 285         'level': 'INFO',
 286         'class': 'logging.handlers.RotatingFileHandler',
 287         'filename': os.getenv('LOGGING_FILENAME'),
 288         'maxBytes': 10000000,
 289         'backupCount': 10,
 290         'formatter': 'verbose',
 291     }
 292
 293
 294 # minimum number of subscribers a podcast must have to be assigned a slug
 295 PODCAST_SLUG_SUBSCRIBER_LIMIT = int(os.getenv(
 296                                     'PODCAST_SLUG_SUBSCRIBER_LIMIT', 10))
 297
 298 # minimum number of subscribers that a podcast needs to "push" one of its
 299 # categories to the top
 300 MIN_SUBSCRIBERS_CATEGORY = int(os.getenv('MIN_SUBSCRIBERS_CATEGORY', 10))
 301
 302 # maximum number of episode actions that the API processes immediatelly before
 303 # returning the response. Larger requests will be handled in background.
 304 # Handler can be set to None to disable
 305 API_ACTIONS_MAX_NONBG = int(os.getenv('API_ACTIONS_MAX_NONBG', 100))
 306 API_ACTIONS_BG_HANDLER = 'mygpo.api.tasks.episode_actions_celery_handler'
 307
 308
 309 ADSENSE_CLIENT = os.getenv('ADSENSE_CLIENT', '')
 310
 311 ADSENSE_SLOT_BOTTOM = os.getenv('ADSENSE_SLOT_BOTTOM', '')
 312
 313 # we're running behind a proxy that sets the X-Forwarded-Proto header correctly
 314 # see https://docs.djangoproject.com/en/dev/ref/settings/#secure-proxy-ssl-header
 315 SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
 316
 317
 318 # enabled access to staff-only areas with ?staff=<STAFF_TOKEN>
 319 STAFF_TOKEN = os.getenv('STAFF_TOKEN', None)
 320
 321 # Flattr settings -- available after you register your app
 322 FLATTR_KEY = os.getenv('FLATTR_KEY', '')
 323 FLATTR_SECRET = os.getenv('FLATTR_SECRET', '')
 324
 325 # Flattr thing of the webservice. Will be flattr'd when a user sets
 326 # the "Auto-Flattr gpodder.net" option
 327 FLATTR_MYGPO_THING = os.getenv(
 328     'FLATTR_MYGPO_THING',
 329     'https://flattr.com/submit/auto?user_id=stefankoegl&url=http://gpodder.net'
 330 )
 331
 332 # The User-Agent string used for outgoing HTTP requests
 333 USER_AGENT = 'gpodder.net (+https://github.com/gpodder/mygpo)'
 334
 335 # Base URL of the website that is used if the actually used parameters is not
 336 # available.  Request handlers, for example, can access the requested domain.
 337 # Code that runs in background can not do this, and therefore requires a
 338 # default value. This should be set to something like 'http://example.com'
 339 DEFAULT_BASE_URL = os.getenv('DEFAULT_BASE_URL', '')
 340
 341
 342 ### Celery
 343
 344 BROKER_URL = os.getenv('BROKER_URL', 'redis://localhost')
 345 CELERY_RESULT_BACKEND = 'djcelery.backends.database:DatabaseBackend'
 346
 347 SERVER_EMAIL = os.getenv('SERVER_EMAIL', 'no-reply@example.com')
 348
 349 CELERY_TASK_RESULT_EXPIRES = 60 * 60  # 1h expiry time in seconds
 350
 351 CELERY_ACCEPT_CONTENT = ['pickle', 'json']
 352
 353 CELERY_SEND_TASK_ERROR_EMAILS = get_bool('CELERY_SEND_TASK_ERROR_EMAILS',
 354                                          False)
 355
 356 BROKER_POOL_LIMIT = get_intOrNone('BROKER_POOL_LIMIT', 10)
 357
 358 ### Google API
 359
 360 GOOGLE_CLIENT_ID = os.getenv('GOOGLE_CLIENT_ID', '')
 361 GOOGLE_CLIENT_SECRET = os.getenv('GOOGLE_CLIENT_SECRET', '')
 362
 363 # URL where users of the site can get support
 364 SUPPORT_URL = os.getenv('SUPPORT_URL', '')
 365
 366
 367 FEEDSERVICE_URL = os.getenv('FEEDSERVICE_URL', 'http://feeds.gpodder.net/')
 368
 369 # Elasticsearch settings
 370
 371 ELASTICSEARCH_SERVER = os.getenv('ELASTICSEARCH_SERVER', '127.0.0.1:9200')
 372 ELASTICSEARCH_INDEX = os.getenv('ELASTICSEARCH_INDEX', 'mygpo')
 373 ELASTICSEARCH_TIMEOUT = float(os.getenv('ELASTICSEARCH_TIMEOUT', '2'))
 374
 375 # time for how long an activation is valid; after that, an unactivated user
 376 # will be deleted
 377 ACTIVATION_VALID_DAYS = int(os.getenv('ACTIVATION_VALID_DAYS', 10))
 378
 379
 380 OPBEAT = {
 381     "ORGANIZATION_ID": os.getenv('OPBEAT_ORGANIZATION_ID', ''),
 382     "APP_ID": os.getenv('OPBEAT_APP_ID', ''),
 383     "SECRET_TOKEN": os.getenv('OPBEAT_SECRET_TOKEN', ''),
 384 }
 385
 386
 387 INTERNAL_IPS = os.getenv('INTERNAL_IPS', '').split()
 388
 389 EMAIL_BACKEND = os.getenv('EMAIL_BACKEND',
 390                           'django.core.mail.backends.smtp.EmailBackend')
 391
 392 PODCAST_AD_ID = os.getenv('PODCAST_AD_ID')