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, foundations, migrations):
  36         self.name = name
  37         self.models = models
  38         self.foundations = foundations
  39         self.migrations = migrations
  40
  41     def make_migration_manager(self, session):
  42         return MigrationManager(
  43             self.name, self.models, self.foundations, self.migrations, session)
  44
  45
  46 def gather_database_data(plugins):
  47     """
  48     Gather all database data relevant to the extensions we have
  49     installed so we can do migrations and table initialization.
  50
  51     Returns a list of DatabaseData objects.
  52     """
  53     managed_dbdata = []
  54
  55     # Add main first
  56     from mediagoblin.db.models import MODELS as MAIN_MODELS
  57     from mediagoblin.db.migrations import MIGRATIONS as MAIN_MIGRATIONS
  58     from mediagoblin.db.models import FOUNDATIONS as MAIN_FOUNDATIONS
  59
  60     managed_dbdata.append(
  61         DatabaseData(
  62             u'__main__', MAIN_MODELS, MAIN_FOUNDATIONS, MAIN_MIGRATIONS))
  63
  64     for plugin in plugins:
  65         try:
  66             models = import_component('{0}.models:MODELS'.format(plugin))
  67         except ImportError as exc:
  68             _log.debug('No models found for {0}: {1}'.format(
  69                 plugin,
  70                 exc))
  71
  72             models = []
  73         except AttributeError as exc:
  74             _log.warning('Could not find MODELS in {0}.models, have you \
  75 forgotten to add it? ({1})'.format(plugin, exc))
  76             models = []
  77
  78         try:
  79             migrations = import_component('{0}.migrations:MIGRATIONS'.format(
  80                 plugin))
  81         except ImportError as exc:
  82             _log.debug('No migrations found for {0}: {1}'.format(
  83                 plugin,
  84                 exc))
  85
  86             migrations = {}
  87         except AttributeError as exc:
  88             _log.debug('Could not find MIGRATIONS in {0}.migrations, have you \
  89 forgotten to add it? ({1})'.format(plugin, exc))
  90             migrations = {}
  91
  92         try:
  93             foundations = import_component('{0}.models:FOUNDATIONS'.format(plugin))
  94         except ImportError as exc:
  95             _log.debug('No foundations found for {0}: {1}'.format(
  96                 plugin,
  97                 exc))
  98
  99             foundations = {}
 100         except AttributeError as exc:
 101             _log.debug('Could not find FOUNDATIONS in {0}.models, have you \
 102 forgotten to add it? ({1})'.format(plugin, exc))
 103             foundations = {}
 104
 105         if models:
 106             managed_dbdata.append(
 107                     DatabaseData(plugin, models, foundations, migrations))
 108
 109
 110     return managed_dbdata
 111
 112
 113 def run_dbupdate(app_config, global_config):
 114     """
 115     Initialize or migrate the database as specified by the config file.
 116
 117     Will also initialize or migrate all extensions (media types, and
 118     in the future, plugins)
 119     """
 120
 121     # Set up the database
 122     db = setup_connection_and_db_from_config(app_config, migrations=True)
 123     #Run the migrations
 124     run_all_migrations(db, app_config, global_config)
 125
 126
 127 def run_all_migrations(db, app_config, global_config):
 128     """
 129     Initializes or migrates a database that already has a
 130     connection setup and also initializes or migrates all
 131     extensions based on the config files.
 132
 133     It can be used to initialize an in-memory database for
 134     testing.
 135     """
 136     # Gather information from all media managers / projects
 137     dbdatas = gather_database_data(
 138             global_config.get('plugins', {}).keys())
 139
 140     Session = sessionmaker(bind=db.engine)
 141
 142     # Setup media managers for all dbdata, run init/migrate and print info
 143     # For each component, create/migrate tables
 144     for dbdata in dbdatas:
 145         migration_manager = dbdata.make_migration_manager(Session())
 146         migration_manager.init_or_migrate()
 147
 148
 149 def dbupdate(args):
 150     global_config, app_config = setup_global_and_app_config(args.conf_file)
 151     run_dbupdate(app_config, global_config)