config.py

# -*- coding: utf-8 -*-
import os
from werkzeug.contrib.cache import RedisCache
from redis import Redis, ConnectionError

'''
    Used for finding environment variables through configuration
    if a default is not given, the site will raise an exception
'''
def get_env_variable(var_name, default=-1):
    try:
        return os.environ[var_name]
    except KeyError:
        if default != -1:
            return default
        error_msg = "Set the %s os.environment variable" % var_name
        raise Exception(error_msg)

''' Base directory of where the site is held '''
basedir = os.path.abspath(os.path.dirname(__file__))

''' CSRF (cross site forgery) for signing POST requests to server '''
CSRF_EN = True

''' Secret key should be set in environment var '''
SECRET_KEY = get_env_variable("DATAVIVA_SECRET_KEY", "default-dataviva.mg-secr3t")

''' Default debugging to True '''
DEBUG = True
ERROR_EMAIL = False
SQLALCHEMY_ECHO = True

''' Whether or not to allow User Account Activity '''
ACCOUNTS = get_env_variable("DATAVIVA_ACCOUNTS",False)

'''
    Details for connecting to the database, credentials set as environment
    variables.
'''
SQLALCHEMY_DATABASE_URI = "mysql://{0}:{1}@{2}/{3}".format(
    get_env_variable("DATAVIVA_DB_USER", "root"),
    get_env_variable("DATAVIVA_DB_PW", ""),
    get_env_variable("DATAVIVA_DB_HOST", "localhost"),
    get_env_variable("DATAVIVA_DB_NAME", "dataminas"))

''' If user prefers to connect via socket set env var '''
if "DATAVIVA_DB_SOCKET" in os.environ:
    SQLALCHEMY_DATABASE_URI += "?unix_socket=" + get_env_variable("DATAVIVA_DB_SOCKET")

''' If an env var for production is set turn off all debugging support '''
if "DATAVIVA_PRODUCTION" in os.environ:
    SQLALCHEMY_ECHO = False
    DEBUG = False
    ERROR_EMAIL = True

''' Available languages '''
LANGUAGES = {
    'en': 'English',
    'pt': 'Português'
}

''' For full text search '''
WHOOSH_BASE = os.path.join(basedir, 'search.db')

STATIC_URL = get_env_variable("DATAVIVA_STATIC_URL")

'''
    Setup redis caching connection to be used throughout the site. Credentials
    are set in their respective env vars.
'''
REDIS = Redis(host=get_env_variable("DATAVIVA_REDIS_HOST", "localhost"),
         port=get_env_variable("DATAVIVA_REDIS_PORT", 6379),
         password=get_env_variable("DATAVIVA_REDIS_PW", None))
REDIS_CACHE = RedisCache(host=get_env_variable("DATAVIVA_REDIS_HOST", "localhost"),
         port=get_env_variable("DATAVIVA_REDIS_PORT", 6379),
         password=get_env_variable("DATAVIVA_REDIS_PW", None), default_timeout=2591999)

try:
    REDIS.client_list()
except ConnectionError:
    REDIS, REDIS_CACHE = [None]*2

'''
    Oauth tokens set in environment variables from their respecive sources
'''
GOOGLE_OAUTH_ID = get_env_variable("DATAVIVA_OAUTH_GOOGLE_ID")
GOOGLE_OAUTH_SECRET = get_env_variable("DATAVIVA_OAUTH_GOOGLE_SECRET")
TWITTER_OAUTH_ID = get_env_variable("DATAVIVA_OAUTH_TWITTER_ID")
TWITTER_OAUTH_SECRET = get_env_variable("DATAVIVA_OAUTH_TWITTER_SECRET")
FACEBOOK_OAUTH_ID = get_env_variable("DATAVIVA_OAUTH_FACEBOOK_ID")
FACEBOOK_OAUTH_SECRET = get_env_variable("DATAVIVA_OAUTH_FACEBOOK_SECRET")

'''
    Mail credentials to send automatic emails to users
'''
MAIL_SERVER = 'smtp.gmail.com'
MAIL_PORT = 465
MAIL_USE_TLS = False
MAIL_USE_SSL = True
MAIL_USERNAME = 'datavivaweb@gmail.com'
MAIL_PASSWORD = 'escritorio2013'


'''
    Administrator email
'''
ADMINISTRATOR_EMAIL = 'daniela.caetano@escritorio.mg.gov.br'