Source

bespinserver-collab / bespin / config.py

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is Bespin.
#
# The Initial Developer of the Original Code is
# Mozilla.
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
#
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK *****
#

import os
import logging
import logging.handlers
import ConfigParser
import sys

import pkg_resources
from path import path

from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker, scoped_session

from bespin import stats, auth

class InvalidConfiguration(Exception):
    pass

class Bunch(dict):
    def __getattr__(self, attr):
        try:
            return self[attr]
        except KeyError:
            raise AttributeError("%s not found" % attr)

    def __setattr__(self, attr, value):
        self[attr] = value

c = Bunch()
c.dburl = None
c.db_pool_size = 10
c.db_pool_overflow = 10
c.secret = "This is the phrase that is used for secret stuff."
c.pw_secret = "This phrase encrypts passwords."
c.static_dir = path.getcwd() / ".." / "bespinclient" / "tmp" / "static"

c.plugin_path = []
c.loader_name = "bespin.tiki"

c.template_file_dir = None

c.docs_dir = os.path.abspath("%s/../../../docs" % os.path.dirname(__file__))
c.log_file = os.path.abspath("%s/../devserver.log" % os.path.dirname(__file__))
c.default_quota = 15
c.secure_cookie = True
c.http_only_cookie = True
c.current_domain_cookie = True
c.template_path = [path(__file__).dirname().abspath()]

c.base_url = "https://bespin.mozilla.com/"
c.server_base_url = "server/"

# Settings for sending email
c.email_from = "invalid@ThisIsNotAValidEmailAddressUseSomethingElse.com"
c.email_host = "localhost"
c.email_port = 25

# additional mappings from top-level of URL to directory
# in the config file, this can be provided as
# static_map=foo=/path/to/files;bar=/path/to/other/files
c.static_map = {}

# additionally, a directory can be specified as the tree of
# "first resort". This directory will be checked for static
# files first, and then the default Bespin static files will
# be used. This is a simple way to override Bespin's static
# resources without altering Bespin's sources.
c.static_override = None

# turns on asynchronous running of long jobs (like vcs)
c.async_jobs = True
# can be "" or False, "beanstalk" or True, or "restmq" for now

# queue host, port, and a polling interval in seconds (for now)
c.queue_host = None
c.queue_port = None
c.queue_timeout = 0.3

# holds the actual queue object
c.queue = None

# timeout for VCS jobs. Default is 5 minutes, which seems plenty generous.
# expressed in seconds
c.vcs_timeout = 300

# stats type: none, memory, redis
# memory just holds the stats in a dictionary
# redis stores the stats in a redis server
# http://code.google.com/p/redis/
c.stats_type = "none"
c.redis_host = None
c.redis_port = None

# login failure tracking: none, memory, redis
# memory holds the login failure attempts in a dictionary and should
# not be used in production
# redis holds the login failures in redis (using the same redis
# as above for stats)
c.login_failure_tracking = "none"

# number of attempts before a user is locked out
c.login_attempts = 10

# how long a user is locked out (in seconds)
c.lockout_period = 600

# The options for mobwrite_implementation are defined in controllers.py.
# Currently: MobwriteInProcess, MobwriteTelnetProxy, or MobwriteHttpProxy
c.mobwrite_implementation = "MobwriteHttpProxy"
c.mobwrite_server_port = 3017
c.mobwrite_server_address = "127.0.0.1"

# if this is true, the user's UUID will be used as their
# user directory name. If it's false, their username will
# be used. Generally, you'll only want this to be false
# in development.
c.use_uuid_as_dir_identifier = True

c.fslevels = 3

c.max_import_file_size = 20000000

c.log_requests_to_stdout = False
c.log_to_stdout = False

# should Project and User names be restricted to a subset
# of characters
# (see bespin.model._check_identifiers)
c.restrict_identifiers = True

# The set of users that are allowed to view the system stats
# at /stats/. stats_type should either be
# memory or redis for this to make any sense
# this can either be a set in Python or
# a comma separated string
c.stats_users = set()

# a list of keys to display other than the base set
c.stats_display = set()

# Locations that should be added to Dojo's module path for loading
# client side code.
# See http://www.dojotoolkit.org/book/dojo-book-0-9/part-3-programmatic-dijit-and-dojo/modules-and-namespaces/creating-your-own-modul
c.dojo_module_path = {}

# Client side plugin modules that should be loaded automatically by the client.
# Should be a list of dotted names
c.javascript_plugins = []

# List of capabilities provided by the server. This is just a list of strings
# to be interpreted by the client. This will adjust the user interface to
# focus the user on the capabilities provided by this server.
c.capabilities = set(["vcs", "collab"])
#c.capabilities = set(["vcs"])

# Set this variable to point to the location of a Thunderhead
# source directory and that will be used during development.
c.th_src = None

c.using_dojo_source = False

# If you want to log errors to errorstack.com, enter the
# stack key here
c.errorstack_key = None

def set_profile(profile):
    if profile == "test" or profile == "dev":
        client_plugin_path = path.getcwd() / ".." / "bespinclient" / "plugins"
        
        c.plugin_path = [dict(name="supported", 
                    path=client_plugin_path / "supported"),
                    dict(name="thirdparty", 
                        path=client_plugin_path / "thirdparty"),
                    dict(name="labs", path=client_plugin_path / "labs"),
                    dict(name="boot", path=client_plugin_path / "boot",
                        skip_unless_only=True)]

    if profile == "test":
        # this import will install the bespin_test store
        c.dburl = "sqlite://"
        c.fsroot = os.path.abspath("%s/../testfiles"
                        % os.path.dirname(__file__))
        c.async_jobs = False
        c.mobwrite_implementation = "MobwriteInProcess"
        c.fslevels = 0
    elif profile == "dev":
        c.dburl = "sqlite:///%s" % (os.path.abspath("devdata.db"))
        c.fsroot = os.path.abspath("%s/../devfiles"
                        % os.path.dirname(__file__))
        root_log = logging.getLogger()
        root_log.setLevel(logging.DEBUG)

        file_handler = logging.handlers.RotatingFileHandler(c.log_file)
        file_handler.setFormatter(logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s"))
        root_log.addHandler(file_handler)

        paste_log = logging.getLogger("paste.httpserver.ThreadPool")
        paste_log.setLevel(logging.ERROR)

        # turn off the secure cookie, because localhost connections
        # will be HTTP
        c.secure_cookie = False
        # turn off current_domain_cookie because of the development proxy setup
        c.current_domain_cookie = False
        c.use_uuid_as_dir_identifier = False
        c.default_quota = 10000
        c.log_requests_to_stdout = True
        c.log_to_stdout = True
        c.mobwrite_implementation = "MobwriteInProcess"
        c.async_jobs = False
        c.fslevels = 0
        c.base_url = "http://localhost:8080/"
        c.email_host = None
        c.vcs_timeout = -1
        
        c.test_plugin_path = [dict(name="testing", path=client_plugin_path / "testing")]
        
        c.plugin_path.extend(c.test_plugin_path)
        c.server_base_url = "/"
        

def load_config(configfile):
    cp = ConfigParser.ConfigParser()
    cp.read(configfile)
    c.update(cp.items("config"))

def load_pyconfig(configfile):
    data = open(configfile).read()
    code = compile(data, configfile, "exec")
    exec(code)
    print(c.fsroot)

def activate_profile():
    
    if c.errorstack_key:
        configure_errorstack()
    
    if c.server_base_url and not c.server_base_url.endswith("/"):
        c.server_base_url += "/"
        
    for ep in pkg_resources.iter_entry_points("bespin_extensions"):
        ep.load()

    if c.th_src:
        # in development, assume a Th directory above the bespin root
        c.static_map['js/thsrc'] = c.th_src

    if isinstance(c.email_port, basestring):
        c.email_port = int(c.email_port)

    if isinstance(c.static_map, basestring):
        static_map = {}
        mappings = c.static_map.split(";")
        for mapping in mappings:
            name, directory = mapping.split("=")
            static_map[name] = directory

    engine_options = dict()
    
    if not c.dburl.startswith("sqlite"):
        engine_options.update(pool_size=c.db_pool_size,
        max_overflow=c.db_pool_overflow)
    
    # recycle connections for MySQL's benefit (by default, a MySQL
    # server will disconnect automatically after a time.)
    if c.dburl.startswith("mysql"):
        # set it to 4 hours. default MySQL drops connection after 8 hours.
        engine_options['pool_recycle'] = 14400
        
    c.dbengine = create_engine(c.dburl, **engine_options)
    c.session_factory = scoped_session(sessionmaker(bind=c.dbengine))

    c.fsroot = path(c.fsroot)
    c.gallery_root = c.fsroot / "gallery"

    c.static_dir = path(c.static_dir)

    if not c.template_file_dir:
        c.template_file_dir = c.static_dir / "templates"

    c.template_file_dir = path(c.template_file_dir)

    if not c.fsroot.exists:
        c.fsroot.makedirs()

    if c.async_jobs:
        if c.queue_port:
            c.queue_port = int(c.queue_port)

        from bespin import queue

        if c.async_jobs is True or c.async_jobs == "beanstalk":
            c.queue = queue.BeanstalkQueue(c.queue_host, c.queue_port)
        elif c.async_jobs == "restmq":
            c.queue = queue.RestMqQueue(c.queue_host, c.queue_port, timeout=float(c.queue_timeout))

    if c.redis_port:
        c.redis_port = int(c.redis_port)

    if c.stats_type == "redis" or c.login_failure_tracking == "redis":
        from bespin import redis
        redis_client = redis.Redis(c.redis_host, c.redis_port)
    else:
        redis_client = None

    if c.stats_type == "redis":
        if not redis_client:
            raise InvalidConfiguration("Stats is set to redis, but redis is not configured")
        c.stats = stats.RedisStats(redis_client)
    elif c.stats_type == "memory":
        c.stats = stats.MemoryStats()
    else:
        c.stats = stats.DoNothingStats()

    if isinstance(c.stats_users, basestring):
        c.stats_users = set(c.stats_users.split(','))
    if isinstance(c.stats_display, basestring):
        c.stats_display = set(c.stats_display.split(','))

    if c.login_attempts:
        c.login_attempts = int(c.login_attempts)

    if c.lockout_period:
        c.lockout_period = int(c.lockout_period)

    if c.login_failure_tracking == "redis":
        if not redis_client:
            raise InvalidConfiguration("Login failure tracking is set to redis, but redis is not configured")
    elif c.login_failure_tracking == "memory":
        c.login_tracker = auth.MemoryFailedLoginTracker(c.login_attempts, 
                                                        c.lockout_period)
    else:
        c.login_tracker = auth.DoNothingFailedLoginTracker()

    if c.log_to_stdout:
        stdout_handler = logging.StreamHandler(sys.stdout)
        stdout_handler.setFormatter(logging.Formatter("%(relativeCreated)6d %(name)9s %(levelname)5s: %(message)s"))
        logging.getLogger().addHandler(stdout_handler)

def configure_errorstack():
    """Configures the logging to ErrorStack"""
    logger = logging.getLogger()

    # Define ErrorStack Handler
    class ErrorStackHandler(logging.handlers.HTTPHandler):
        def mapLogRecord(self, record):
            """ Define the values submitted to ErrorStack.com. """
            keys = ['name','msg','levelname','module','pathname','funcName','lineno',
                    'args','exc_text','threadName','thread','process','asctime']
            ErrorInfo = {}
            for key in keys:
                ErrorInfo[key] = record.__dict__[key]
            return ErrorInfo
        

    # Create ErrorStack handler, set level to error, and add it to the logger
    ESHandler = ErrorStackHandler("www.errorstack.com", "/submit?_s=%s&_r=json" % (c.errorstack_key), "POST")
    ESHandler.setLevel(logging.ERROR)
    logger.addHandler(ESHandler)



def dev_spawning_factory(spawning_config):
    spawning_config['app_factory'] = spawning_config['args'][0]
    set_profile('dev')
    here = os.path.dirname(__file__)
    dbfile = os.path.abspath(os.path.join(here, "..", "devdata.db"))
    c.dburl = "sqlite:///%s" % (dbfile)
    activate_profile()
    return spawning_config

def dev_factory(config):
    from bespin.controllers import make_app
    return make_app()