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.sql.open import setup_connection_and_db_from_config
  22 from mediagoblin.db.sql.util 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(media_types, 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.sql.models import MODELS as MAIN_MODELS
  56     from mediagoblin.db.sql.migrations import MIGRATIONS as MAIN_MIGRATIONS
  57
  58     managed_dbdata.append(
  59         DatabaseData(
  60             u'__main__', MAIN_MODELS, MAIN_MIGRATIONS))
  61
  62     # Then get all registered media managers (eventually, plugins)
  63     for media_type in media_types:
  64         models = import_component('%s.models:MODELS' % media_type)
  65         migrations = import_component('%s.migrations:MIGRATIONS' % media_type)
  66         managed_dbdata.append(
  67             DatabaseData(media_type, models, migrations))
  68
  69     for plugin in plugins:
  70         try:
  71             models = import_component('{0}.models:MODELS'.format(plugin))
  72         except ImportError as exc:
  73             _log.debug('No models found for {0}: {1}'.format(
  74                 plugin,
  75                 exc))
  76
  77             models = []
  78         except AttributeError as exc:
  79             _log.warning('Could not find MODELS in {0}.models, have you \
  80 forgotten to add it? ({1})'.format(plugin, exc))
  81
  82         try:
  83             migrations = import_component('{0}.migrations:MIGRATIONS'.format(
  84                 plugin))
  85         except ImportError as exc:
  86             _log.debug('No migrations found for {0}: {1}'.format(
  87                 plugin,
  88                 exc))
  89
  90             migrations = {}
  91         except AttributeError as exc:
  92             _log.debug('Cloud not find MIGRATIONS in {0}.migrations, have you \
  93 forgotten to add it? ({1})'.format(plugin, exc))
  94
  95         if models:
  96             managed_dbdata.append(
  97                     DatabaseData(plugin, models, migrations))
  98
  99
 100     return managed_dbdata
 101
 102
 103 def run_dbupdate(app_config, global_config):
 104     """
 105     Initialize or migrate the database as specified by the config file.
 106
 107     Will also initialize or migrate all extensions (media types, and
 108     in the future, plugins)
 109     """
 110
 111     # Gather information from all media managers / projects
 112     dbdatas = gather_database_data(
 113             app_config['media_types'],
 114             global_config.get('plugins', {}).keys())
 115
 116     # Set up the database
 117     db = setup_connection_and_db_from_config(app_config)
 118
 119     Session = sessionmaker(bind=db.engine)
 120
 121     # Setup media managers for all dbdata, run init/migrate and print info
 122     # For each component, create/migrate tables
 123     for dbdata in dbdatas:
 124         migration_manager = dbdata.make_migration_manager(Session())
 125         migration_manager.init_or_migrate()
 126
 127
 128 def dbupdate(args):
 129     global_config, app_config = setup_global_and_app_config(args.conf_file)
 130     run_dbupdate(app_config, global_config)