mygpo/settings.py

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