Changeset 1327:132fbdaa8899

Timestamp:

01/10/10 15:58:34 (2 years ago)

Author:

Georg Brandl <georg@…>

Branch:

default

Parents:

1280:e7db1dd838ba (diff), 1326:4b0d1121e32c (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 zine-migrations

Files:

• external-plugins/eric_the_fish/__init__.py (modified) (1 diff)
• external-plugins/eric_the_fish/__init__.py (modified) (3 diffs)
• external-plugins/eric_the_fish/database.py (modified) (1 diff)
• scripts/_install-posix.py (modified) (1 diff)
• scripts/_install-posix.py (modified) (1 diff)
• scripts/_make-setup-virtualenv.py (modified) (1 diff)
• scripts/_make-setup-virtualenv.py (modified) (1 diff)
• scripts/manage-database (modified) (1 diff)
• zine/_core.py (modified) (4 diffs)
• zine/_core.py (modified) (3 diffs)
• zine/application.py (modified) (4 diffs)
• zine/application.py (modified) (3 diffs)
• zine/database.py (modified) (4 diffs)
• zine/database.py (modified) (1 diff)
• zine/models.py (modified) (4 diffs)
• zine/models.py (modified) (3 diffs)
• zine/templates/admin/import_blogger.html (deleted)
• zine/upgrades/__init__.py (modified) (1 diff)
• zine/upgrades/customisation.py (modified) (1 diff)
• zine/upgrades/versions/__init__.py (modified) (1 diff)
• zine/upgrades/webapp.py (modified) (1 diff)

external-plugins/eric_the_fish/__init__.py

@@ -8 +8 @@
     registration system.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

external-plugins/eric_the_fish/__init__.py

@@ -45 +45 @@
 from zine.privileges import BLOG_ADMIN
 
-# the last thing is importing the FORTUNES list from the fortunes.py file
-# from the same folder. It's just a long list with quotes.
-from zine.plugins.eric_the_fish.fortunes import FORTUNES
+# import Zine's database related stuff
+from zine.database import db
+
+# the last thing is importing the Fortunes database mapped object.
+from zine.plugins.eric_the_fish.database import Fortune
 
 # because we have an admin panel page we need to store the templates
@@ -89 +91 @@
     for link_id, url, title, children in navigation_bar:
         if link_id == 'options':
-            children.insert(-3, ('eric_the_fish', url_for('eric_the_fish/config'),
+            children.insert(-3, ('eric_the_fish',
+                                 url_for('eric_the_fish/config'),
                                  _('Eric The Fish')))
 
@@ -116 +119 @@
 
 def get_fortune(req):
-    """The servicepoint function. Just return one fortune from the list."""
-    return {'fortune': choice(FORTUNES)}
+    """The servicepoint function. Just return one fortune from the database."""
+    fortune_ids = db.session.query(Fortune.id).all()
+    return {'fortune': db.session.query(Fortune).get(choice(fortune_ids)).text}
 
 
 def setup(app, plugin):
-    """This function is called by Zine in the application initialization
+    """This function is called by Zine in the application initialisation
     phase. Here we connect to the events and register our template paths,
     url rules, views etc.
     """
+
+    # we need to register eric's database upgrades repository;
+    # Basically it should be a folder which itself has another child folder
+    # named "versions" where the upgrade script(s) should reside.
+    # In "Eric the fish" case we pass the plugin's folder which has that child
+    # folder called "versions"
+    app.register_upgrade_repository(plugin, dirname(__file__))
 
     # we want our fish to appear in the admin panel, so hook into the

external-plugins/eric_the_fish/database.py

@@ -6 +6 @@
     Database tables and objects for the "Annoying fish for the admin panel".
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

scripts/_install-posix.py

@@ -6 +6 @@
     This script is invoked by the makefile to install Zine on a POSIX system.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

scripts/_install-posix.py

@@ -18 +18 @@
 
 
-PACKAGES = '_dynamic _ext importers utils views websetup docs'.split()
+PACKAGES = '_dynamic _ext importers upgrades utils views websetup docs'.split()
 SCRIPTS = 'create-apache-config server shell'.split()
 DESTDIR = os.environ.get('DESTDIR')

scripts/_make-setup-virtualenv.py

@@ -6 +6 @@
     Execute this file to regenerate the `setup-virtualenv` script.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

scripts/_make-setup-virtualenv.py

@@ -25 +25 @@
     'SQLAlchemy==dev',
     'pytz',
-    'Babel>=0.9.4'
+    'Babel>=0.9.4',
+    'sqlalchemy-migrate==0.5.4'
 ]
 

scripts/manage-database

@@ -7 +7 @@
     Database maintenance script.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

zine/_core.py

@@ -6 +6 @@
     Internal core module that survives reloads.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -40 +40 @@
     after `timeout` seconds a `RuntimeError` is raised.
     """
-    global _application
+    global _application, _setup_failed
     _setup_failed = False
     _setup_lock.acquire()
@@ -84 +84 @@
 def _unload_zine():
     """Unload all zine libraries."""
-    global _application
+    global _application, _setup_failed
     import sys
 
@@ -111 +111 @@
                     for key, value in module.__dict__.iteritems():
                         setattr(module, key, None)
+                    # clear references
                     value = None
                 except:

zine/_core.py

@@ -27 +27 @@
     instance folder.
     """
+
+class InstanceUpgradeRequired(RuntimeError):
+    """Zine requires a database upgrade"""
+
+class MissingDependency(RuntimeError):
+    """Zine requires an external library which is not installed."""
 
 
@@ -60 +66 @@
         try:
             app.__init__(instance_folder)
+            app.upgrade_required
+        except InstanceUpgradeRequired:
+            from zine.upgrades.webapp import WebUpgrades
+            _application = app = WebUpgrades(app)
         except:
             # if an exception happened, tear down the application
@@ -92 +102 @@
                     if key not in preserve and not key.startswith('__'):
                         module.__dict__.pop(key, None)
-            elif name.startswith('zine.') and name != 'zine._core':
+            elif name.startswith('zine.') and name not in (
+                                'zine._core', 'zine.upgrades',
+                                'zine.upgrades.customisation'):
                 # get rid of the module
                 sys.modules.pop(name, None)

zine/application.py

@@ -8 +8 @@
 
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -14 +14 @@
 from os import path, remove, makedirs, walk, environ
 from time import time
-from itertools import izip
-from datetime import datetime, timedelta
-from urlparse import urlparse, urljoin
+from urlparse import urlparse
 from collections import deque
 from inspect import getdoc
@@ -1320 +1318 @@
             result = callback(request)
             if result is not None:
-                return result(environ, start_response)
+                return result
 
         # normal request dispatching
@@ -1494 +1492 @@
 from zine import i18n
 from zine.utils import log
+from zine.utils.net import NetException
 from zine.utils.http import make_external_url

zine/application.py

@@ -636 +636 @@
                             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 +834 @@
             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's 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.
+        """
+        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:
+                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()
+
+
+    @property
+    def upgrade_required(self):
+        from zine.models import SchemaVersion
+        from zine.upgrades.customisation import Repository
+
+        for sv in SchemaVersion.query.all():
+            repository = Repository(sv.repository_path, sv.repository_id)
+            try:
+                self.repository_has_upgrade(repository, sv)
+            except _core.InstanceUpgradeRequired:
+                # Set Zine in maintenance mode
+                cfg = self.cfg.edit()
+                cfg['maintenance_mode'] = True
+                cfg.commit()
+                raise _core.InstanceUpgradeRequired()
+
+        # 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):
+        try:
+            if schema_version.version < repository.latest:
+                raise _core.InstanceUpgradeRequired()
+        except (SQLAlchemyError, AttributeError):
+            self.log.error('WE EVEN GOT HERE??? schema_versions table does not '
+                           'yet exist at this stage?')
+            # 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)))
+            db.session.commit()
+            raise _core.InstanceUpgradeRequired()
 
     @property
@@ -1211 +1282 @@
         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/database.py

@@ -11 +11 @@
 
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -18 +18 @@
 import sys
 import time
-import urlparse
 from os import path
-from datetime import datetime, timedelta
 from types import ModuleType
 from copy import deepcopy
@@ -30 +28 @@
 from sqlalchemy.exc import ArgumentError
 from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.util import to_list
 from sqlalchemy.engine.url import make_url, URL
-from sqlalchemy.types import MutableType, TypeDecorator
+from sqlalchemy.types import TypeDecorator
 from sqlalchemy.ext.associationproxy import association_proxy
 
@@ -159 +156 @@
         if value is None:
             return
-        from zine.utils.zeml import dump_parser_data, RootElement
+        from zine.utils.zeml import dump_parser_data
         return dump_parser_data(value)
 

zine/database.py

@@ -248 +248 @@
 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/models.py

@@ -6 +6 @@
     The core models and query helper functions.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """
@@ -25 +25 @@
 from zine.utils.crypto import gen_pwhash, check_pwhash
 from zine.utils.http import make_external_url
-from zine.privileges import Privilege, _Privilege, privilege_attribute, \
+from zine.privileges import _Privilege, privilege_attribute, \
      add_admin_privilege, MODERATE_COMMENTS, ENTER_ADMIN_PANEL, BLOG_ADMIN, \
      VIEW_DRAFTS, VIEW_PROTECTED, MODERATE_OWN_ENTRIES, MODERATE_OWN_PAGES
@@ -575 +575 @@
     def set_auto_slug(self):
         """Generate a slug for this post."""
-        cfg = get_application().cfg
+        #cfg = get_application().cfg
         slug = gen_slug(self.title)
         if not slug:
@@ -1083 +1083 @@
         if user is None:
             user = request.user
-        if user.has_privilege(MODERATE_OWN_ENTRIES | MODERATE_OWN_PAGES):
-            # Comment belongs to a post the user is the author. It's visible.
-            return self.post.author is user
+        if self.post.author is user and \
+           user.has_privilege(MODERATE_OWN_ENTRIES | MODERATE_OWN_PAGES):
+            return True
         elif user.has_privilege(MODERATE_COMMENTS):
             # User is able to manage comments. It's visible.

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
 
 
@@ -1256 +1267 @@
 
 # connect the tables.
+db.mapper(SchemaVersion, schema_versions)
 db.mapper(User, users, properties={
     'id':               users.c.user_id,

zine/upgrades/__init__.py

@@ -6 +6 @@
     database.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

zine/upgrades/customisation.py

@@ -6 +6 @@
     to do our job.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

zine/upgrades/versions/__init__.py

@@ -6 +6 @@
     to maintain the database schema changes.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """

zine/upgrades/webapp.py

@@ -7 +7 @@
     for upgrading Zine to the latest schema changes.
 
-    :copyright: (c) 2009 by the Zine Team, see AUTHORS for more details.
+    :copyright: (c) 2010 by the Zine Team, see AUTHORS for more details.
     :license: BSD, see LICENSE for more details.
 """