mediagoblin/gmg_commands/dbupdate.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import logging
  18
  19 from sqlalchemy.orm import sessionmaker
  20
  21 from mediagoblin.db.open import setup_connection_and_db_from_config
  22 from mediagoblin.db.migration_tools import MigrationManager
  23 from mediagoblin.init import setup_global_and_app_config
  24 from mediagoblin.tools.common import import_component
  25
  26 _log = logging.getLogger(__name__)
  27 logging.basicConfig()
  28 _log.setLevel(logging.DEBUG)
  29
  30 def dbupdate_parse_setup(subparser):
  31     pass
  32
  33
  34 class DatabaseData(object):
  35     def __init__(self, name, models, migrations):
  36         self.name = name
  37         self.models = models
  38         self.migrations = migrations
  39
  40     def make_migration_manager(self, session):
  41         return MigrationManager(
  42             self.name, self.models, self.migrations, session)
  43
  44
  45 def gather_database_data(plugins):
  46     """
  47     Gather all database data relevant to the extensions we have
  48     installed so we can do migrations and table initialization.
  49
  50     Returns a list of DatabaseData objects.
  51     """
  52     managed_dbdata = []
  53
  54     # Add main first
  55     from mediagoblin.db.models import MODELS as MAIN_MODELS
  56     from mediagoblin.db.migrations import MIGRATIONS as MAIN_MIGRATIONS
  57
  58     managed_dbdata.append(
  59         DatabaseData(
  60             u'__main__', MAIN_MODELS, MAIN_MIGRATIONS))
  61
  62     for plugin in plugins:
  63         try:
  64             models = import_component('{0}.models:MODELS'.format(plugin))
  65         except ImportError as exc:
  66             _log.debug('No models found for {0}: {1}'.format(
  67                 plugin,
  68                 exc))
  69
  70             models = []
  71         except AttributeError as exc:
  72             _log.warning('Could not find MODELS in {0}.models, have you \
  73 forgotten to add it? ({1})'.format(plugin, exc))
  74             models = []
  75
  76         try:
  77             migrations = import_component('{0}.migrations:MIGRATIONS'.format(
  78                 plugin))
  79         except ImportError as exc:
  80             _log.debug('No migrations found for {0}: {1}'.format(
  81                 plugin,
  82                 exc))
  83
  84             migrations = {}
  85         except AttributeError as exc:
  86             _log.debug('Cloud not find MIGRATIONS in {0}.migrations, have you \
  87 forgotten to add it? ({1})'.format(plugin, exc))
  88             migrations = {}
  89
  90         if models:
  91             managed_dbdata.append(
  92                     DatabaseData(plugin, models, migrations))
  93
  94
  95     return managed_dbdata
  96
  97
  98 def run_dbupdate(app_config, global_config):
  99     """
 100     Initialize or migrate the database as specified by the config file.
 101
 102     Will also initialize or migrate all extensions (media types, and
 103     in the future, plugins)
 104     """
 105
 106     # Set up the database
 107     db = setup_connection_and_db_from_config(app_config, migrations=True)
 108     #Run the migrations
 109     run_all_migrations(db, app_config, global_config)
 110
 111
 112 def run_all_migrations(db, app_config, global_config):
 113     """
 114     Initializes or migrates a database that already has a
 115     connection setup and also initializes or migrates all
 116     extensions based on the config files.
 117
 118     It can be used to initialize an in-memory database for
 119     testing.
 120     """
 121     # Gather information from all media managers / projects
 122     dbdatas = gather_database_data(
 123             global_config.get('plugins', {}).keys())
 124
 125     Session = sessionmaker(bind=db.engine)
 126
 127     # Setup media managers for all dbdata, run init/migrate and print info
 128     # For each component, create/migrate tables
 129     for dbdata in dbdatas:
 130         migration_manager = dbdata.make_migration_manager(Session())
 131         migration_manager.init_or_migrate()
 132
 133
 134 def dbupdate(args):
 135     global_config, app_config = setup_global_and_app_config(args.conf_file)
 136     run_dbupdate(app_config, global_config)