Merge pull request #4412 from tino097/4291-werkzeug-dev-server

 [#4291] werkzeug dev server

ckan/cli/__init__.py

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+import os
+
+import click
+import logging
+from logging.config import fileConfig as loggingFileConfig
+
+log = logging.getLogger(__name__)
+
+
+click_config_option = click.option(
+    u'-c',
+    u'--config',
+    default=None,
+    metavar=u'CONFIG',
+    help=u'Config file to use (default: development.ini)')
+
+
+def load_config(config=None):
+    from paste.deploy import appconfig
+    if config:
+        filename = os.path.abspath(config)
+        config_source = u'-c parameter'
+    elif os.environ.get(u'CKAN_INI'):
+        filename = os.environ.get(u'CKAN_INI')
+        config_source = u'$CKAN_INI'
+    else:
+        default_filename = u'development.ini'
+        filename = os.path.join(os.getcwd(), default_filename)
+        if not os.path.exists(filename):
+            # give really clear error message for this common situation
+            msg = u'ERROR: You need to specify the CKAN config (.ini) '\
+                u'file path.'\
+                u'\nUse the --config parameter or set environment ' \
+                u'variable CKAN_INI or have {}\nin the current directory.' \
+                .format(default_filename)
+            exit(msg)
+
+    if not os.path.exists(filename):
+        msg = u'Config file not found: %s' % filename
+        msg += u'\n(Given by: %s)' % config_source
+        exit(msg)
+
+    loggingFileConfig(filename)
+    log.info(u'Using configuration file {}'.format(filename))
+    return appconfig(u'config:' + filename)

ckan/cli/cli.py

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+import logging
+
+import click
+
+from ckan.cli import click_config_option, db, load_config, search_index, server
+from ckan.config.middleware import make_app
+
+log = logging.getLogger(__name__)
+
+
+class CkanCommand(object):
+
+    def __init__(self, conf=None):
+        self.config = load_config(conf)
+        self.app = make_app(self.config.global_conf, **self.config.local_conf)
+
+
+@click.group()
+@click.help_option(u'-h', u'--help')
+@click_config_option
+@click.pass_context
+def ckan(ctx, config, *args, **kwargs):
+    ctx.obj = CkanCommand(config)
+
+
+ckan.add_command(server.run)
+ckan.add_command(db.db)
+ckan.add_command(search_index.search_index)

ckan/cli/db.py

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+import logging
+
+import click
+from werkzeug.serving import run_simple
+
+log = logging.getLogger(__name__)
+
+
+@click.group(name=u'db', short_help=u'Database commands')
+def db():
+    pass
+
+
+@db.command(u'init', short_help=u'Initialaze the database')
+def initdb():
+    u'''Initialising the database'''
+    log.info(u"Initialize the Database")
+    try:
+        import ckan.model as model
+        model.repo.init_db()
+    except Exception as e:
+        click.secho(e, err=True)
+    print(u'Initialising DB: SUCCESS')
+
+
+PROMPT_MSG = u'This will delete all of your data!\nDo you want to continue?'
+
+
+@db.command(u'clean', short_help=u'Clean the database')
+@click.confirmation_option(prompt=PROMPT_MSG)
+def cleandb():
+    u'''Cleaning  the database'''
+    try:
+        import ckan.model as model
+        model.repo.clean_db()
+    except Exception as e:
+        click.secho(e, err=True)
+    click.secho(u'Cleaning DB: SUCCESS', color=u"green", bold=True)
+
+
+@db.command(u'upgrade', short_help=u'Upgrade the database')
+@click.option(u'-v', u'--version', help=u'Migration version')
+def updatedb(version=None):
+    u'''Upgrading the database'''
+    try:
+        import ckan.model as model
+        model.repo.upgrade_db(version)
+    except Exception as e:
+        click.secho(e, err=True)
+    click.secho(u'Upgrading DB: SUCCESS', fg=u'green', bold=True)
+
+
+@db.command(u'version', short_help=u'Returns current version of data schema')
+def version():
+    u'''Return current version'''
+    log.info(u"Returning current DB version")
+    try:
+        from ckan.model import Session
+        ver = Session.execute(u'select version from '
+                              u'migrate_version;').fetchall()
+        click.secho(u"Latest data schema version: {0}".format(ver[0][0]),
+                    fg=u"green", bold=True)
+    except Exception as e:
+        click.secho(e, err=True)

ckan/cli/search_index.py

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+import multiprocessing as mp
+
+import click
+import sqlalchemy as sa
+from werkzeug.serving import run_simple
+
+
+@click.group(name=u'search-index', short_help=u'Search index commands')
+@click.help_option(u'-h', u'--help')
+def search_index():
+    pass
+
+
+@search_index.command(name=u'rebuild', short_help=u'Rebuild search index')
+@click.option(u'-v', u'--verbose', is_flag=True)
+@click.option(u'-i', u'--force', is_flag=True,
+              help=u'Ignore exceptions when rebuilding the index')
+@click.option(u'-r', u'--refresh', help=u'Refresh current index', is_flag=True)
+@click.option(u'-o', u'--only-missing',
+              help=u'Index non indexed datasets only', is_flag=True)
+@click.option(u'-q', u'--quiet', help=u'Do not output index rebuild progress',
+              is_flag=True)
+@click.option(u'-e', u'--commit-each', is_flag=True,
+              help=u'Perform a commit after indexing each dataset. This'
+                   u'ensures that changes are immediately available on the'
+                   u'search, but slows significantly the process. Default'
+                   u'is false.')
+@click.pass_context
+def rebuild(ctx, verbose, force, refresh, only_missing, quiet, commit_each):
+    u''' Rebuild search index '''
+    flask_app = ctx.obj.app.apps['flask_app']._wsgi_app
+    from ckan.lib.search import rebuild, commit
+    try:
+        with flask_app.test_request_context():
+            rebuild(only_missing=only_missing,
+                    force=force,
+                    refresh=refresh,
+                    defer_commit=(not commit_each),
+                    quiet=quiet)
+    except Exception as e:
+        click.echo(e, err=True)
+    if not commit_each:
+        commit()
+
+
+@search_index.command(name=u'check', short_help=u'Check search index')
+def check():
+    from ckan.lib.search import check
+    check()
+
+
+@search_index.command(name=u'show', short_help=u'Show index of a dataset')
+@click.argument(u'dataset_name')
+def show(dataset_name):
+    from ckan.lib.search import show
+
+    index = show(dataset_name)
+    click.echo(index)
+
+
+@search_index.command(name=u'clear', short_help=u'Clear the search index')
+@click.argument(u'dataset_name', required=False)
+def clear(dataset_name):
+    from ckan.lib.search import clear, clear_all
+
+    if dataset_name:
+        clear(dataset_name)
+    else:
+        clear_all()
+
+
+@search_index.command(name=u'rebuild-fast',
+                      short_help=u'Reindex with multiprocessing')
+@click.pass_context
+def rebuild_fast(ctx):
+    conf = ctx.obj.config
+    flask_app = ctx.obj.app.apps['flask_app']._wsgi_app
+    db_url = conf['sqlalchemy.url']
+    engine = sa.create_engine(db_url)
+    package_ids = []
+    result = engine.execute(u"select id from package where state = 'active';")
+    for row in result:
+        package_ids.append(row[0])
+
+    def start(ids):
+        from ckan.lib.search import rebuild, commit
+        rebuild(package_ids=ids)
+        commit()
+
+    def chunks(l, n):
+        u""" Yield n successive chunks from l."""
+        newn = int(len(l) / n)
+        for i in range(0, n-1):
+            yield l[i*newn:i*newn+newn]
+        yield l[n*newn-newn:]
+
+    processes = []
+    with flask_app.test_request_context():
+        try:
+            for chunk in chunks(package_ids, mp.cpu_count()):
+                process = mp.Process(target=start, args=(chunk,))
+                processes.append(process)
+                process.daemon = True
+                process.start()
+
+            for process in processes:
+                process.join()
+        except Exception as e:
+            click.echo(e.message)

ckan/cli/server.py

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+import logging
+
+import click
+from werkzeug.serving import run_simple
+
+log = logging.getLogger(__name__)
+
+
+@click.command(u'run', short_help=u'Start development server')
+@click.option(u'-H', u'--host', default=u'localhost', help=u'Set host')
+@click.option(u'-p', u'--port', default=5000, help=u'Set port')
+@click.option(u'-r', u'--reloader', default=True, help=u'Use reloader')
+@click.pass_context
+def run(ctx, host, port, reloader):
+    u'''Runs development server'''
+    log.info(u"Running server {0} on port {1}".format(host, port))
+    run_simple(host, port, ctx.obj.app, use_reloader=reloader, use_evalex=True)

ckan/config/middleware/flask_app.py

@@ -2,6 +2,7 @@
 
 import os
 import re
+import time
 import inspect
 import itertools
 import pkgutil
@@ -107,6 +108,13 @@ def make_flask_stack(conf, **app_conf):
         app.config['DEBUG_TB_INTERCEPT_REDIRECTS'] = False
         DebugToolbarExtension(app)
 
+        from werkzeug.debug import DebuggedApplication
+        app = DebuggedApplication(app, True)
+        app = app.app
+
+        log = logging.getLogger('werkzeug')
+        log.setLevel(logging.DEBUG)
+
     # Use Beaker as the Flask session interface
     class BeakerSessionInterface(SessionInterface):
         def open_session(self, app, request):
@@ -298,6 +306,8 @@ def ckan_before_request():
     # with extensions
     set_controller_and_action()
 
+    g.__timer = time.time()
+
 
 def ckan_after_request(response):
     u'''Common handler executed after all Flask requests'''
@@ -311,6 +321,11 @@ def ckan_after_request(response):
     # Set CORS headers if necessary
     response = set_cors_headers_for_response(response)
 
+    r_time = time.time() - g.__timer
+    url = request.environ['CKAN_CURRENT_URL'].split('?')[0]
+
+    log.info(' %s render time %.3f seconds' % (url, r_time))
+
     return response
 
 

setup.py

@@ -77,7 +77,7 @@ def parse_version(s):
         'jobs = ckan.lib.cli:JobsCommand',
     ],
     'console_scripts': [
-        'ckan-admin = bin.ckan_admin:Command',
+        'ckan = ckan.cli.cli:ckan',
     ],
     'paste.paster_create_template': [
         'ckanext = ckan.pastertemplates:CkanextTemplate',