Seattle-Django_settings.py

"""
These are the django settings for the Seattle Clearinghouse project. See the README.txt
file for details on what needs to be set in this file. At a minimum for
development, it will be the database connection info and the SECRET_KEY value.

For public deployment, see the README.txt file for information about which
additional changes you'll need to make to this file.
"""

import os


from clearinghouse.common.util import log



# If DEBUG is True, then error details will be shown on the website and ADMINS
# will not receive an email when an error occurs. So, this should be False in
# production.
DEBUG = True
TEMPLATE_DEBUG = DEBUG

# The log level used by the clearinghouse log module. All messages at this level
# or more severe will be logged.
SEATTLECLEARINGHOUSE_LOG_LEVEL = log.LOG_LEVEL_DEBUG

# Rather than make the log module have to import this settings file to set the
# log level, just set it right here.
log.set_log_level(SEATTLECLEARINGHOUSE_LOG_LEVEL)

# This is needed to allow xmlrpc requests to work when they don't have a slash
# on the end of the url.
APPEND_SLASH = False

# Required for mod_wsgi (which replaces mod_python), the Apache Python interface
WSGI_APPLICATION = "clearinghouse.wsgi.wsgi.application"

# The directory the settings.py file is in is what we consider the root of the website. 
SEATTLECLEARINGHOUSE_WEBSITE_ROOT = os.path.dirname(__file__)

# The directory where we keep the public keys of the node state keys.
SEATTLECLEARINGHOUSE_STATE_KEYS_DIR = os.path.join(SEATTLECLEARINGHOUSE_WEBSITE_ROOT, '..', 'node_state_transitions', 'statekeys')

# The XML-RPC interface to the Custom Installer Builder.
SEATTLECLEARINGHOUSE_INSTALLER_BUILDER_XMLRPC = "https://custombuilder.poly.edu/custom_install/xmlrpc/"

# Not currently used. This is left in for legacy installs
# The directory where the base installers named seattle_linux.tgz, seattle_mac.tgz,
# and seattle_win.zip are located.
#SEATTLECLEARINGHOUSE_BASE_INSTALLERS_DIR = "/var/www/dist"

# Not currently used. This is left in for legacy installs
# The directory in which customized installers created by clearinghouse will be
# stored. A directory within this directory will be created for each user.
#SEATTLECLEARINGHOUSE_USER_INSTALLERS_DIR = os.path.join(SEATTLECLEARINGHOUSE_BASE_INSTALLERS_DIR, "geni")

# Not currently used. This is left in for legacy installs
#The url that corresponds to SEATTLECLEARINGHOUSE_USER_INSTALLERS_DIR
#SEATTLECLEARINGHOUSE_USER_INSTALLERS_URL = "https://blackbox.cs.washington.edu/dist/geni"

# Need to specify the LOGIN_URL, as our login page isn't at the default login
# location (the default is /accounts/login).
LOGIN_URL = 'login'

# Users will be redirected to SOCIAL_AUTH_LOGIN_ERROR_URL in case of backend error/user cancellation
# during login or association (account linking).
SOCIAL_AUTH_LOGIN_ERROR_URL ='error'
SOCIAL_AUTH_BACKEND_ERROR_URL = 'error'

# When a user logs in with OpenID/OAuth send them to the profile page
SOCIAL_AUTH_LOGIN_REDIRECT_URL = 'profile'

# A new user created through OpenID/OAuth gets sent here upon creation. 
# currently not used
#SOCIAL_AUTH_NEW_USER_REDIRECT_URL = 'new_auto_register_user'

# fields specificed here will not be automatically changed/updated by social_auth
SOCIAL_AUTH_PROTECTED_USER_FIELDS = ['email',]

# Email addresses of people that should be emailed when a 500 error occurs on
# the site when DEBUG = False (that is, in production). Leave this to be empty
# if nobody should receive an email. 
ADMINS = (
    # ('Your Name', 'your_email@domain.com'),
)

# To be able to send mail to ADMINS when there is an error, django needs to
# know about an SMTP server it can use. That info is defined here.
#EMAIL_HOST = 'smtp.gmail.com'
#EMAIL_HOST_USER = 'an.error.sending.account@gmail.com'
#EMAIL_HOST_PASSWORD = 'PASSWORD_HERE'
#EMAIL_PORT = 587
#EMAIL_USE_TLS = True

# Email address that error notifications will be sent from.
#SERVER_EMAIL = "error@clearinghouse.server.hostname"

# We use this so we know which server the email came from by the subject line.
#EMAIL_SUBJECT_PREFIX = "[localhost] "

MANAGERS = ADMINS

# Database
# https://docs.djangoproject.com/en/1.6/ref/settings/#databases
DATABASES = {
    'default': {
        # you can use django.db.backends.sqlite3 instead of mysql. If you
        # decide to do so, you can leave the other fields empty
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'clearinghouse',
        'USER': 'clearinghouse',
        'PASSWORD': 'clearinghouse',
        'HOST': '',
        'PORT': '',
    }
}

if DATABASES['default']['ENGINE'] == 'django.db.backends.mysql':
    DATABASES['default']['OPTIONS'] = {}
    DATABASES['default']['OPTIONS']['init_command'] = \
            'SET storage_engine=INNODB'

# Make this unique, and don't share it with anybody.
# Fill this in!
SECRET_KEY = 'abhishekmalvankar9!@#'

# 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 = 'America/Los_Angeles'

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

SITE_ID = 1

# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True

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

# 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 = '/site_media/'

# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
# trailing slash.
# Examples: "http://foo.com/media/", "/media/".
ADMIN_MEDIA_PREFIX = '/admin_media/'

# List of callables that know how to import templates from various sources.
TEMPLATE_LOADERS = (
  'django.template.loaders.filesystem.Loader',
  'django.template.loaders.app_directories.Loader',
# 'django.template.loaders.eggs.load_template_source',
)

MIDDLEWARE_CLASSES = (
  'django.middleware.common.CommonMiddleware',
  'django.middleware.csrf.CsrfViewMiddleware',
  'django.contrib.sessions.middleware.SessionMiddleware',
  'django.contrib.auth.middleware.AuthenticationMiddleware',
  'django.contrib.messages.middleware.MessageMiddleware',
  'django.middleware.clickjacking.XFrameOptionsMiddleware',
  #'django.middleware.doc.XViewMiddleware',

  # Our own middleware that logs when a request is initially received and
  # sets up the logger to log other messages with per-request unique ids.
  'clearinghouse.website.middleware.logrequest.LogRequestMiddleware',
  # Our own middleware that logs when unhandled exceptions happen.
  'clearinghouse.website.middleware.logexception.LogExceptionMiddleware',
)

ROOT_URLCONF = 'clearinghouse.website.urls'

TEMPLATE_DIRS = (
  # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
  # Always use forward slashes, even on Windows.
  # Don't forget to use absolute paths, not relative paths.
  SEATTLECLEARINGHOUSE_WEBSITE_ROOT + '/html/templates',
)

INSTALLED_APPS = (
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.sites',
  'django.contrib.messages',
  # Needed for OpenID/OAuth login so must be listed. 
  'social_auth',

  # We have our maindb model defined here, so it must be listed.
  'clearinghouse.website.control',
  'clearinghouse.website.django_pph'
)

# set the django hasher as the default hasher, make it appear in the top
# of the list (if the list already exists...)
PASSWORD_HASHERS = (
    'clearinghouse.website.django_pph.hashers.PolyPasswordHasher',
)


# We will add a custom cache object ('pph') to store the shares locally.
CACHES={
    'default': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
    },
    # this will store non-persistent information (you can use the memcache if
    # desired
    'pph': {
        'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
        'LOCATION': 'pph_cache',
        'TIMEOUT': None,
    },
    # for persistent storage, only non sensitive information will be stored here
    'share_cache': {
            'BACKEND': 'django.core.cache.backends.db.DatabaseCache',
            'LOCATION': 'share_cache',
    },
}

# this is a default logger configuration with a file handler, you can copy
# all of this over
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s',
        },
        'simple': {
            'format': '%(levelname)s %(message)s',
        },
    },
    'handlers': {
        'file': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            # set this path to a location specific to your project
            'filename': '/home/ch/deployment/clearinghouse/website/log.log',
            'formatter':'verbose',
        },
    },
    'loggers': {
        'django.security.PPH': {
            'handlers': ['file'],
            'level': 'DEBUG',
            'propagate': True,
        },
    },
}
  # Seattle Clearinghouse uses a django plugin called "django social auth" to handle
  # OpenID and OAuth.  The desired OpenID/OAuth providers must be listed here 
  # in order to be used.  Seattle Clearinghouse uses Facebook, Github, Windows Live
  # Google and Yahoo.  For more info visit https://github.com/omab/django-social-auth       
  # Google and Yahoo work without keys so they are enabled by default
AUTHENTICATION_BACKENDS = (
  
  #'social_auth.backends.facebook.FacebookBackend',
  'social_auth.backends.google.GoogleBackend',
  'social_auth.backends.yahoo.YahooBackend',
  #'social_auth.backends.contrib.github.GithubBackend',
  #'social_auth.backends.OpenIDBackend',
  #'social_auth.backends.browserid.BrowserIDBackend',
  #'social_auth.backends.contrib.live.LiveBackend',
  # Django default this is always needed and must always be last.
  'django.contrib.auth.backends.ModelBackend',	    
)
# Social_Auth needs OAuth keys in order to function.  Each backend provider has its
# own method to acquire keys usually requireing registering the web app with them.
# Yahoo and Google are OpenID and as such we do not need OAuth keys for them

#FACEBOOK_APP_ID                   = ''
#FACEBOOK_API_SECRET               = ''
#LIVE_CLIENT_ID                    = ''
#LIVE_CLIENT_SECRET                = ''
SOCIAL_AUTH_ERROR_KEY             = 'socialauth_error'
#GITHUB_APP_ID                     = ''
#GITHUB_API_SECRET                 = ''
# define what extra facebook permissions you would like from a user
#FACEBOOK_EXTENDED_PERMISSIONS = ['email']

TEMPLATE_CONTEXT_PROCESSORS = (
  'django.contrib.auth.context_processors.auth',
  'django.core.context_processors.debug',
  'django.core.context_processors.i18n',
  'django.core.context_processors.media',
  'django.contrib.messages.context_processors.messages',
  # Adds a social_auth dict with keys: are associated, not_associated and backends.
  # associated key is a list of UserSocialAuth instances associated with current user.
  # not_associated is a list of providers names that the current user doesn't have any association yet.
  # backends holds the list of backend names supported.  Each value is grouped by backend type openid, oauth2 and oauth
  'social_auth.context_processors.social_auth_by_type_backends',
  # Add context processor for TESTBED etc. tags; configure these below.
  'clearinghouse.website.context_processor.customizable_strings',
)
#  Social_auth follows each of these in order and passes along a object with
#  information gathered to each function.
#  Custom fns can be written and passed in here we define them in clearinghouse.website.pipeline.
#  To use a custom fn you must call .save_status_to_session before your custom fn.
SOCIAL_AUTH_PIPELINE = (
  'clearinghouse.website.pipeline.custom_social_auth_user', 
  #'social_auth.backends.pipeline.associate.associate_by_email', 
  'social_auth.backends.pipeline.misc.save_status_to_session',
  'clearinghouse.website.pipeline.redirect_to_auto_register',
  'clearinghouse.website.pipeline.username',
  'clearinghouse.website.pipeline.custom_create_user',
  'social_auth.backends.pipeline.social.associate_user',
  'social_auth.backends.pipeline.social.load_extra_data',
  'social_auth.backends.pipeline.user.update_user_details',
)

# This is important for the partial pipeline, anytime it is broken with a custom
# function, it must be redirected back to SOCIAL_AUTH_COMPLETE_URL_NAME in order
# for the pipeline to continue.
SOCIAL_AUTH_COMPLETE_URL_NAME  = 'socialauth_complete'
#SOCIAL_AUTH_PROCESS_EXCEPTIONS = 'social_auth.utils.process_exceptions'

# DEBUG should be false for production. Useful for debugging social_auth problems.
SOCIAL_AUTH_RAISE_EXCEPTIONS = DEBUG
SOCIAL_AUTH_LAST_LOGIN = 'social_auth_last_login_backend'
#SOCIAL_AUTH_REDIRECT_IS_HTTPS = True

# The number of seconds sessions are valid for. Django uses this for the
# session expiration in the database in addition to the cookie expiration,
# which is good.
SESSION_COOKIE_AGE = 3600

# Use session cookies, not persistent cookies.
SESSION_EXPIRE_AT_BROWSER_CLOSE = True

TESTBED = 'Seattle'
TESTBED_URL = 'https://seattle.poly.edu/'
TESTBED_DEVELOPERS_MAIL = 'mailto:seattle-devel@googlegroups.com'
TESTBED_USERS_MAIL = 'mailto:seattle-devel@googlegroups.com'

CLEARINGHOUSE = 'Clearinghouse'
CLEARINGHOUSE_URL = 'https://seattleclearinghouse.poly.edu/'

DEMOKIT = 'Demokit'