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