aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/init/__init__.py
blob: e314c20d9eb0cb271cfbb52016bb0fb513670ce7 (plain)
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
# GNU MediaGoblin -- federated, autonomous media hosting
# Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import jinja2

from mediagoblin.tools import staticdirect
from mediagoblin.tools.translate import set_available_locales
from mediagoblin.init.config import (
    read_mediagoblin_config, generate_validation_report)
from mediagoblin import mg_globals
from mediagoblin.mg_globals import setup_globals
from mediagoblin.db.open import setup_connection_and_db_from_config, \
    check_db_migrations_current, load_models
from mediagoblin.tools.pluginapi import hook_runall
from mediagoblin.tools.workbench import WorkbenchManager
from mediagoblin.storage import storage_system_from_config

from mediagoblin.tools.transition import DISABLE_GLOBALS


class Error(Exception):
    pass


class ImproperlyConfigured(Error):
    pass


def setup_locales():
    """Checks which language translations are available and sets them"""
    set_available_locales()


def setup_global_and_app_config(config_path):
    global_config, validation_result = read_mediagoblin_config(config_path)
    app_config = global_config['mediagoblin']
    # report errors if necessary
    validation_report = generate_validation_report(
        global_config, validation_result)
    if validation_report:
        raise ImproperlyConfigured(validation_report)

    setup_globals(
        app_config=app_config,
        global_config=global_config)

    return global_config, app_config


def setup_database(app):
    app_config = app.app_config
    global_config = app.global_config
    run_migrations = app_config['run_migrations']

    # Load all models for media types (plugins, ...)
    load_models(app_config)
    # Set up the database
    db = setup_connection_and_db_from_config(
        app_config, run_migrations, app=app)
    # run_migrations is used for tests
    if run_migrations:
        # Run the migrations to initialize/update the database.
        # We only run the alembic migrations in the case of unit
        # tests, in which case we don't need to run the legacy
        # migrations.
        from mediagoblin.gmg_commands.dbupdate import (
            run_alembic_migrations, run_foundations)
        run_alembic_migrations(db, app_config, global_config)
        run_foundations(db, global_config)
    else:
        check_db_migrations_current(db)

    setup_globals(database=db)

    return db


def get_jinja_loader(user_template_path=None, current_theme=None,
                     plugin_template_paths=None):
    """
    Set up the Jinja template loaders, possibly allowing for user
    overridden templates.

    (In the future we may have another system for providing theming;
    for now this is good enough.)
    """
    path_list = []

    # Add user path first--this takes precedence over everything.
    if user_template_path is not None:
        path_list.append(jinja2.FileSystemLoader(user_template_path))

    # Any theme directories in the registry
    if current_theme and current_theme.get('templates_dir'):
        path_list.append(
            jinja2.FileSystemLoader(
                current_theme['templates_dir']))

    # Add plugin template paths next--takes precedence over
    # core templates.
    if plugin_template_paths is not None:
        path_list.extend(jinja2.FileSystemLoader(path)
                          for path in plugin_template_paths)

    # Add core templates last.
    path_list.append(jinja2.PackageLoader('mediagoblin', 'templates'))

    return jinja2.ChoiceLoader(path_list)


def get_staticdirector(app_config):
    # At minimum, we need the direct_remote_path
    if not 'direct_remote_path' in app_config \
            or not 'theme_web_path' in app_config:
        raise ImproperlyConfigured(
            "direct_remote_path and theme_web_path must be provided")

    direct_domains = {None: app_config['direct_remote_path'].strip()}
    direct_domains['theme'] = app_config['theme_web_path'].strip()

    # Let plugins load additional paths
    for plugin_static in hook_runall("static_setup"):
        direct_domains[plugin_static.name] = "{}/{}".format(
            app_config['plugin_web_path'].rstrip('/'),
            plugin_static.name)

    return staticdirect.StaticDirect(
        direct_domains)


def setup_storage():
    global_config = mg_globals.global_config

    key_short = 'publicstore'
    key_long = "storage:" + key_short
    public_store = storage_system_from_config(global_config[key_long])

    key_short = 'queuestore'
    key_long = "storage:" + key_short
    queue_store = storage_system_from_config(global_config[key_long])

    setup_globals(
        public_store=public_store,
        queue_store=queue_store)

    return public_store, queue_store


def setup_workbench():
    app_config = mg_globals.app_config

    workbench_manager = WorkbenchManager(app_config['workbench_path'])

    if not DISABLE_GLOBALS:
        setup_globals(workbench_manager=workbench_manager)

    return workbench_manager