Merge remote-tracking branch 'refs/remotes/origin/533-new-dropdown'
[mediagoblin.git] / mediagoblin / db / migrations.py
index 4cafb1a3cc64a18e4104b66ff0be404a396cb53b..80ec5269a24123c3ddfa388fb2b52e5e8ae73e47 100644 (file)
@@ -1,5 +1,5 @@
 # GNU MediaGoblin -- federated, autonomous media hosting
-# Copyright (C) 2011 Free Software Foundation, Inc
+# 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
 # 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/>.
 
-from mediagoblin.util import cleaned_markdown_conversion
-# from mediagoblin.db.util import RegisterMigration
-
-from mongokit import DocumentMigration
-
-
-# This is where the first new-style migration will be written!
-# 
-# Please see mediagoblin/tests/test_migrations.py for some examples of
-# basic migrations.
-
-# @RegisterMigration(1)
-# def do_something(database):
-#     pass
-
-
-class MediaEntryMigration(DocumentMigration):
-    def allmigration01_uploader_to_reference(self):
-        """
-        Old MediaEntry['uploader'] accidentally embedded the User instead
-        of referencing it.  Fix that!
-        """
-        # uploader is an associative array
-        self.target = {'uploader': {'$type': 3}}
-        if not self.status:
-            for doc in self.collection.find(self.target):
-                self.update = {
-                    '$set': {
-                        'uploader': doc['uploader']['_id']}}
-                self.collection.update(
-                    self.target, self.update, multi=True, safe=True)
-
-    def allmigration02_add_description_html(self):
-        """
-        Now that we can have rich descriptions via Markdown, we should
-        update all existing entries to record the rich description versions.
-        """
-        self.target = {'description_html': {'$exists': False},
-                       'description': {'$exists': True}}
-
-        if not self.status:
-            for doc in self.collection.find(self.target):
-                self.update = {
-                    '$set': {
-                        'description_html': cleaned_markdown_conversion(
-                            doc['description'])}}
-        
-class UserMigration(DocumentMigration):
-    def allmigration01_add_bio_and_url_profile(self):
-        """
-        User can elaborate profile with home page and biography
-        """
-        self.target = {'url': {'$exists': False},
-                       'bio': {'$exists': False}}
-        if not self.status:
-            for doc in self.collection.find(self.target):
-                self.update = {
-                    '$set': {'url': '', 
-                             'bio': ''}}
-                self.collection.update(
-                    self.target, self.update, multi=True, safe=True)
-                        
-                        
-MIGRATE_CLASSES = ['MediaEntry', 'User']
+import datetime
+
+from sqlalchemy import (MetaData, Table, Column, Boolean, SmallInteger,
+                        Integer, Unicode, UnicodeText, DateTime,
+                        ForeignKey)
+from sqlalchemy.exc import ProgrammingError
+from sqlalchemy.ext.declarative import declarative_base
+from migrate.changeset.constraint import UniqueConstraint
+
+from mediagoblin.db.migration_tools import RegisterMigration, inspect_table
+from mediagoblin.db.models import MediaEntry, Collection, User
+
+MIGRATIONS = {}
+
+
+@RegisterMigration(1, MIGRATIONS)
+def ogg_to_webm_audio(db_conn):
+    metadata = MetaData(bind=db_conn.bind)
+
+    file_keynames = Table('core__file_keynames', metadata, autoload=True,
+                          autoload_with=db_conn.bind)
+
+    db_conn.execute(
+        file_keynames.update().where(file_keynames.c.name == 'ogg').
+            values(name='webm_audio')
+    )
+    db_conn.commit()
+
+
+@RegisterMigration(2, MIGRATIONS)
+def add_wants_notification_column(db_conn):
+    metadata = MetaData(bind=db_conn.bind)
+
+    users = Table('core__users', metadata, autoload=True,
+            autoload_with=db_conn.bind)
+
+    col = Column('wants_comment_notification', Boolean,
+            default=True, nullable=True)
+    col.create(users, populate_defaults=True)
+    db_conn.commit()
+
+
+@RegisterMigration(3, MIGRATIONS)
+def add_transcoding_progress(db_conn):
+    metadata = MetaData(bind=db_conn.bind)
+
+    media_entry = inspect_table(metadata, 'core__media_entries')
+
+    col = Column('transcoding_progress', SmallInteger)
+    col.create(media_entry)
+    db_conn.commit()
+
+
+class Collection_v0(declarative_base()):
+    __tablename__ = "core__collections"
+
+    id = Column(Integer, primary_key=True)
+    title = Column(Unicode, nullable=False)
+    slug = Column(Unicode)
+    created = Column(DateTime, nullable=False, default=datetime.datetime.now,
+        index=True)
+    description = Column(UnicodeText)
+    creator = Column(Integer, ForeignKey(User.id), nullable=False)
+    items = Column(Integer, default=0)
+
+class CollectionItem_v0(declarative_base()):
+    __tablename__ = "core__collection_items"
+
+    id = Column(Integer, primary_key=True)
+    media_entry = Column(
+        Integer, ForeignKey(MediaEntry.id), nullable=False, index=True)
+    collection = Column(Integer, ForeignKey(Collection.id), nullable=False)
+    note = Column(UnicodeText, nullable=True)
+    added = Column(DateTime, nullable=False, default=datetime.datetime.now)
+    position = Column(Integer)
+
+    ## This should be activated, normally.
+    ## But this would change the way the next migration used to work.
+    ## So it's commented for now.
+    __table_args__ = (
+        UniqueConstraint('collection', 'media_entry'),
+        {})
+
+collectionitem_unique_constraint_done = False
+
+@RegisterMigration(4, MIGRATIONS)
+def add_collection_tables(db_conn):
+    Collection_v0.__table__.create(db_conn.bind)
+    CollectionItem_v0.__table__.create(db_conn.bind)
+
+    global collectionitem_unique_constraint_done
+    collectionitem_unique_constraint_done = True
+
+    db_conn.commit()
+
+
+@RegisterMigration(5, MIGRATIONS)
+def add_mediaentry_collected(db_conn):
+    metadata = MetaData(bind=db_conn.bind)
+
+    media_entry = inspect_table(metadata, 'core__media_entries')
+
+    col = Column('collected', Integer, default=0)
+    col.create(media_entry)
+    db_conn.commit()
+
+
+class ProcessingMetaData_v0(declarative_base()):
+    __tablename__ = 'core__processing_metadata'
+
+    id = Column(Integer, primary_key=True)
+    media_entry_id = Column(Integer, ForeignKey(MediaEntry.id), nullable=False,
+            index=True)
+    callback_url = Column(Unicode)
+
+@RegisterMigration(6, MIGRATIONS)
+def create_processing_metadata_table(db):
+    ProcessingMetaData_v0.__table__.create(db.bind)
+    db.commit()
+
+
+# Okay, problem being:
+#  Migration #4 forgot to add the uniqueconstraint for the
+#  new tables. While creating the tables from scratch had
+#  the constraint enabled.
+#
+# So we have four situations that should end up at the same
+# db layout:
+#
+# 1. Fresh install.
+#    Well, easy. Just uses the tables in models.py
+# 2. Fresh install using a git version just before this migration
+#    The tables are all there, the unique constraint is also there.
+#    This migration should do nothing.
+#    But as we can't detect the uniqueconstraint easily,
+#    this migration just adds the constraint again.
+#    And possibly fails very loud. But ignores the failure.
+# 3. old install, not using git, just releases.
+#    This one will get the new tables in #4 (now with constraint!)
+#    And this migration is just skipped silently.
+# 4. old install, always on latest git.
+#    This one has the tables, but lacks the constraint.
+#    So this migration adds the constraint.
+@RegisterMigration(7, MIGRATIONS)
+def fix_CollectionItem_v0_constraint(db_conn):
+    """Add the forgotten Constraint on CollectionItem"""
+
+    global collectionitem_unique_constraint_done
+    if collectionitem_unique_constraint_done:
+        # Reset it. Maybe the whole thing gets run again
+        # For a different db?
+        collectionitem_unique_constraint_done = False
+        return
+
+    metadata = MetaData(bind=db_conn.bind)
+
+    CollectionItem_table = inspect_table(metadata, 'core__collection_items')
+
+    constraint = UniqueConstraint('collection', 'media_entry',
+        name='core__collection_items_collection_media_entry_key',
+        table=CollectionItem_table)
+
+    try:
+        constraint.create()
+    except ProgrammingError:
+        # User probably has an install that was run since the
+        # collection tables were added, so we don't need to run this migration.
+        pass
+
+    db_conn.commit()