Changeset 1338:e3a2b003c799

Timestamp:

01/11/10 00:42:36 (2 years ago)

Author:

Georg Brandl <georg@…>

Branch:

default

Parents:

1337:d906b50d398e (diff), 1290:bc8054777437 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

merge with trunk

Location:

zine

Files:

• application.py (modified) (4 diffs)
• application.py (modified) (1 diff)
• database.py (modified) (1 diff)
• database.py (modified) (3 diffs)
• models.py (modified) (3 diffs)
• models.py (modified) (1 diff)

zine/application.py

@@ -18 +18 @@
 from inspect import getdoc
 from traceback import format_exception
-from pprint import pprint
 from StringIO import StringIO
 
@@ -636 +635 @@
                             self.__class__.__name__)
         self.instance_folder = path.abspath(instance_folder)
+        self.upgrade_lockfile = path.join(instance_folder,
+                                          '.upgrade_in_progress')
 
         # create the event manager, this is the first thing we have to
@@ -832 +833 @@
             self.list_parsers()
 
+        # register Zine's upgrade repository
+        from zine.upgrades import REPOSITORY_PATH
+        self.register_upgrade_repository('Zine', REPOSITORY_PATH)
+        # allow plugins to register their upgrade repositories
+        emit_event('register-upgrade-repository')
+
         self.initialized = True
 
         #! called after the application and all plugins are initialized
         emit_event('application-setup-done')
+
+    def register_upgrade_repository(self, repo_id, repo_path):
+        """This function is responsible for adding upgrade repositories to the
+        database.
+
+        repo_id can be either a string or a Plugin instance, in which case the
+        plugin name is used as the repository ID.
+        """
+        from zine.models import SchemaVersion
+        from zine.pluginsystem import Plugin
+        from zine.upgrades.customisation import Repository
+        if isinstance(repo_id, Plugin):
+            repo_id = repo_id.metadata.get('name')
+        repo_path = path.abspath(repo_path)
+        try:
+            sv = SchemaVersion.query.filter_by(repository_id=repo_id).first()
+            if not sv:
+                # this always starts with version 0
+                db.session.add(SchemaVersion(Repository(repo_path, repo_id)))
+                db.session.commit()
+        except (SQLAlchemyError, AttributeError):
+            # the schema_versions table does not yet exist, let's create it
+            db.session.rollback()
+            from zine.database import metadata, schema_versions
+            metadata.bind = self.database_engine
+            if not schema_versions.exists():
+                schema_versions.create(self.database_engine)
+            db.session.add(SchemaVersion(Repository(repo_path, repo_id)))
+            db.session.commit()
+
+    def check_if_upgrade_required(self):
+        """Check if all registered schema versions are the latest.
+
+        If an upgrade is required, this will raise
+        zine._core.InstanceUpgradeRequired.
+        """
+        from zine.models import SchemaVersion
+        from zine.upgrades.customisation import Repository
+
+        to_upgrade = []
+
+        for sv in SchemaVersion.query.all():
+            repository = Repository(sv.repository_path, sv.repository_id)
+            try:
+                self.repository_has_upgrade(repository, sv)
+            except _core.InstanceUpgradeRequired:
+                to_upgrade.append(sv.repository_id)
+
+        if to_upgrade:
+            # set Zine in maintenance mode
+            cfg = self.cfg.edit()
+            cfg['maintenance_mode'] = True
+            cfg.commit()
+            raise _core.InstanceUpgradeRequired(to_upgrade)
+
+        # we got here, let's check for a bad upgrade lockfile left behind
+        if path.isfile(self.upgrade_lockfile):
+            remove(self.upgrade_lockfile)
+
+    def repository_has_upgrade(self, repository, schema_version):
+        """Check for available upgrades in one repository."""
+        from zine.models import SchemaVersion
+        try:
+            if schema_version.version < repository.latest:
+                raise _core.InstanceUpgradeRequired()
+        except (SQLAlchemyError, AttributeError):
+            self.log.error('schema_versions table missing while checking '
+                           'for upgrades?')
+            # the schema_versions table does not yet exist, let's create it
+            # XXX can this happen at all?
+            db.session.rollback()
+            from zine.database import metadata, schema_versions
+            metadata.bind = self.database_engine
+            if not schema_versions.exists():
+                schema_versions.create(self.database_engine)
+            db.session.add(SchemaVersion(repository))
+            db.session.commit()
+            raise _core.InstanceUpgradeRequired()
 
     @property
@@ -1211 +1296 @@
         from zine.notifications import send_notification_template, ZINE_ERROR
         request_buffer = StringIO()
-        pprint(request.__dict__, request_buffer)
         request_buffer.seek(0)
         send_notification_template(

zine/application.py

@@ -980 +980 @@
     @setuponly
     def add_importer(self, importer):
-        """Register an importer.  For more informations about importers
+        """Register an importer.  For more information about importers
         see the :mod:`zine.importers`.
         """

zine/database.py

@@ -259 +259 @@
 metadata = db.MetaData()
 
+schema_versions = db.Table('schema_versions', metadata,
+    db.Column('repository_id', db.String(255), primary_key=True),
+    db.Column('repository_path', db.Text),
+    db.Column('version', db.Integer)
+)
 
 users = db.Table('users', metadata,

zine/database.py

@@ -4 +4 @@
     ~~~~~~~~~~~~~
 
-    This module is a rather complex layer on top of SQLAlchemy 0.4.
-    Basically you will never use the `zine.database` module except you
-    are a core developer, but always the high level
-    :mod:`~zine.database.db` module which you can import from the
-    :mod:`zine.api` module.
-
+    This module is a rather complex layer on top of SQLAlchemy.
+
+    Basically you will never use the `zine.database` module except if you
+    are a core developer, but always the high level :mod:`~zine.database.db`
+    module which you can import from the :mod:`zine.api` module.
 
     :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
@@ -207 +206 @@
 
 
+def mapper(cls, *args, **kwargs):
+    """Attaches a query and auto registers."""
+    if not hasattr(cls, 'query'):
+        cls.query = session.query_property(Query)
+    old_init = getattr(cls, '__init__', None)
+    def register_init(self, *args, **kwargs):
+        old_init(self, *args, **kwargs)
+        session.add(self)
+    cls.__init__ = register_init
+    return orm.mapper(cls, *args, **kwargs)
+
+
 # configure a declarative base.  This is unused in the code but makes it easier
 # for plugins to work with the database.
 class ModelBase(object):
     """Internal baseclass for `Model`."""
-Model = declarative_base(name='Model', cls=ModelBase, mapper=session.mapper)
+Model = declarative_base(name='Model', cls=ModelBase, mapper=mapper)
 ModelBase.query = session.query_property(Query)
 
@@ -237 +248 @@
 db.session = session
 db.ZEMLParserData = ZEMLParserData
-db.mapper = session.mapper
+db.mapper = mapper
 db.association_proxy = association_proxy
 db.attribute_loaded = attribute_loaded

zine/models.py

@@ -18 +18 @@
      post_categories, post_tags, tags, comments, groups, group_users, \
      privileges, user_privileges, group_privileges, texts, \
-     notification_subscriptions, db
+     notification_subscriptions, schema_versions, db
 from zine.utils import zeml
 from zine.utils.text import gen_slug, gen_timestamped_slug, build_tag_uri, \
@@ -177 +177 @@
     def authors(self):
         return self.filter_by(is_author=True)
+
+
+class SchemaVersion(object):
+    """Represents a database schema version."""
+
+    query = db.query_property(db.Query)
+
+    def __init__(self, repos, version=0):
+        self.repository_id = repos.config.get('repository_id')
+        self.repository_path = repos.path
+        self.version = version
 
 
@@ -1265 +1276 @@
 
 # connect the tables.
+db.mapper(SchemaVersion, schema_versions)
 db.mapper(User, users, properties={
     'id':               users.c.user_id,

zine/models.py

@@ -779 +779 @@
             uid = build_tag_uri(app, self.pub_date, content_type, self.slug)
         self.uid = uid
+
+    @property
+    def comments_closed(self):
+        """True if commenting is no longer possible."""
+        app = get_application()
+        open_for = app.cfg['comments_open_for']
+        if open_for == 0:
+            return False
+        return self.pub_date + timedelta(days=open_for) < datetime.utcnow()