[schema migration] import refactoring to fix #1109558 and enhances things on the way
the main pb demonstrated by #1109558 was due to the fact that in-memory schema
was updated in commit_event of operations. This is undesired in most cases,
since we want the modification to be taken into account in the interval between
the modification detection and the commit_event.
I've fixed this by merging in-memory schema / database alteration operations
for most important changes, doing in-memory schema changes as they are detected
and implementing a revertcommit_event method to revert them if necessary (with
exception for removal of stuff from the schema, where this is simply done in a
postcommit_event methods).
Also, I've benefited from this to support reverting of database alteration for
some operations (more to be done there), and to move so system source alteration
code to the native source code for a nicer design.
There may be some more stuff in syncschema.py that would benefit from similar
changes, but most important things are done (at least to close #1109558, w/
unittest_syncschema and unittest_migration green).
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>.
"""cubicweb on appengine plugins for cubicweb-ctl
"""
__docformat__ = "restructuredtext en"
from os.path import exists, join, split, basename, normpath, abspath
from logilab.common.clcommands import register_commands
from cubicweb import CW_SOFTWARE_ROOT, BadCommandUsage
from cubicweb.toolsutils import (Command, copy_skeleton, create_symlink,
create_dir)
from cubicweb.cwconfig import CubicWebConfiguration
def slink_directories():
import rql, yams, yapps, docutils, roman
try:
import json as simplejson
except ImportError:
import simplejson
from logilab import common as lgc
from logilab import constraint as lgcstr
from logilab import mtconverter as lgmtc
dirs = [
(lgc.__path__[0], 'logilab/common'),
(lgmtc.__path__[0], 'logilab/mtconverter'),
(lgcstr.__path__[0], 'logilab/constraint'),
(rql.__path__[0], 'rql'),
(simplejson.__path__[0], 'simplejson'),
(yams.__path__[0], 'yams'),
(yapps.__path__[0], 'yapps'),
(docutils.__path__[0], 'docutils'),
(roman.__file__.replace('.pyc', '.py'), 'roman.py'),
('/usr/share/fckeditor/', 'fckeditor'),
(join(CW_SOFTWARE_ROOT, 'web', 'data'), join('cubes', 'shared', 'data')),
(join(CW_SOFTWARE_ROOT, 'web', 'wdoc'), join('cubes', 'shared', 'wdoc')),
(join(CW_SOFTWARE_ROOT, 'i18n'), join('cubes', 'shared', 'i18n')),
(join(CW_SOFTWARE_ROOT, 'goa', 'tools'), 'tools'),
(join(CW_SOFTWARE_ROOT, 'goa', 'bin'), 'bin'),
]
try:
import dateutil
import vobject
dirs.extend([ (dateutil.__path__[0], 'dateutil'),
(vobject.__path__[0], 'vobject') ] )
except ImportError:
pass
return dirs
COPY_CW_FILES = (
'__init__.py',
'__pkginfo__.py',
'_exceptions.py',
'appobject.py',
'dbapi.py',
'cwvreg.py',
'cwconfig.py',
'entity.py',
'interfaces.py',
'i18n.py',
'mail.py',
'migration.py',
'mixins.py',
'mttransforms.py',
'rqlrewrite.py',
'rset.py',
'schema.py',
'schemaviewer.py',
'selectors.py',
'uilib.py',
'utils.py',
'vregistry.py',
'view.py',
'ext/html4zope.py',
'ext/rest.py',
'server/hookhelper.py',
'server/hooksmanager.py',
'server/hooks.py',
'server/migractions.py',
'server/pool.py',
'server/querier.py',
'server/repository.py',
'server/securityhooks.py',
'server/session.py',
'server/serverconfig.py',
'server/ssplanner.py',
'server/utils.py',
'server/sources/__init__.py',
'entities/__init__.py',
'entities/authobjs.py',
'entities/lib.py',
'entities/schemaobjs.py',
'entities/wfobjs.py',
'sobjects/__init__.py',
'sobjects/notification.py',
# XXX would be necessary for goa.testlib but require more stuff to be added
# such as server.serverconfig and so on (check devtools.__init__)
# 'devtools/__init__.py',
# 'devtools/fake.py',
'web/__init__.py',
'web/_exceptions.py',
'web/action.py',
'web/application.py',
'web/box.py',
'web/component.py',
'web/controller.py',
'web/form.py',
'web/htmlwidgets.py',
'web/httpcache.py',
'web/request.py',
'web/webconfig.py',
'web/views/__init__.py',
'web/views/actions.py',
'web/views/basecomponents.py',
'web/views/basecontrollers.py',
'web/views/baseforms.py',
'web/views/basetemplates.py',
'web/views/baseviews.py',
'web/views/boxes.py',
'web/views/calendar.py',
'web/views/error.py',
'web/views/editcontroller.py',
'web/views/ibreadcrumbs.py',
'web/views/idownloadable.py',
'web/views/magicsearch.py',
'web/views/management.py',
'web/views/navigation.py',
'web/views/startup.py',
'web/views/vcard.py',
'web/views/wdoc.py',
'web/views/urlpublishing.py',
'web/views/urlrewrite.py',
'web/views/xbel.py',
'wsgi/__init__.py',
'wsgi/handler.py',
'wsgi/request.py',
'goa/__init__.py',
'goa/db.py',
'goa/dbinit.py',
'goa/dbmyams.py',
'goa/goaconfig.py',
'goa/goavreg.py',
'goa/gaesource.py',
'goa/rqlinterpreter.py',
'goa/appobjects/__init__.py',
'goa/appobjects/components.py',
'goa/appobjects/dbmgmt.py',
'goa/appobjects/gauthservice.py',
'goa/appobjects/sessions.py',
'schemas/bootstrap.py',
'schemas/base.py',
)
OVERRIDEN_FILES = (
('toolsutils.py', 'toolsutils.py'),
('mttransforms.py', 'mttransforms.py'),
('server__init__.py', 'server/__init__.py'),
('rqlannotation.py', 'server/rqlannotation.py'),
)
def create_init_file(pkgdir, pkgname):
open(join(pkgdir, '__init__.py'), 'w').write('"""%s pkg"""' % pkgname)
class NewGoogleAppCommand(Command):
"""Create a new google appengine instance.
<instance directory>
the path to the appengine instance directory
"""
name = 'newgapp'
arguments = '<instance directory>'
def run(self, args):
if len(args) != 1:
raise BadCommandUsage("exactly one argument is expected")
appldir, = args
appldir = normpath(abspath(appldir))
appid = basename(appldir)
context = {'appname': appid}
# goa instance'skeleton
copy_skeleton(join(CW_SOFTWARE_ROOT, 'goa', 'skel'),
appldir, context, askconfirm=True)
# cubicweb core dependencies
for directory, subdirectory in slink_directories():
subdirectory = join(appldir, subdirectory)
if not exists(split(subdirectory)[0]):
create_dir(split(subdirectory)[0])
create_symlink(directory, join(appldir, subdirectory))
create_init_file(join(appldir, 'logilab'), 'logilab')
# copy supported part of cubicweb
create_dir(join(appldir, 'cubicweb'))
for fpath in COPY_CW_FILES:
target = join(appldir, 'cubicweb', fpath)
if not exists(split(target)[0]):
create_dir(split(target)[0])
create_symlink(join(CW_SOFTWARE_ROOT, fpath), target)
# overriden files
for fpath, subfpath in OVERRIDEN_FILES:
create_symlink(join(CW_SOFTWARE_ROOT, 'goa', 'overrides', fpath),
join(appldir, 'cubicweb', subfpath))
# link every supported components
packagesdir = join(appldir, 'cubes')
create_init_file(join(appldir, 'cubes'), 'cubes')
for include in ('addressbook','basket', 'blog','folder',
'tag', 'comment', 'file', 'link',
'mailinglist', 'person', 'task', 'zone',
):
create_symlink(CubicWebConfiguration.cube_dir(include),
join(packagesdir, include))
# generate sample config
from cubicweb.goa.goaconfig import GAEConfiguration
from cubicweb.migration import MigrationHelper
config = GAEConfiguration(appid, appldir)
if exists(config.main_config_file()):
mih = MigrationHelper(config)
mih.rewrite_configuration()
else:
config.save()
register_commands((NewGoogleAppCommand,
))