devctl.py 30.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
# 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.
#
11
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
12
13
14
15
16
17
# 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/>.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
18
19
20
21
22
23
"""additional cubicweb-ctl commands and command handlers for cubicweb and cubicweb's
cubes development

"""
__docformat__ = "restructuredtext en"

24
25
26
# *ctl module should limit the number of import to be imported as quickly as
# possible (for cubicweb-ctl reactivity, necessary for instance for usable bash
# completion). So import locally in command helpers.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
27
import sys
28
from datetime import datetime
29
from os import mkdir, chdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
30
from os.path import join, exists, abspath, basename, normpath, split, isdir
31
from warnings import warn
Adrien Di Mascio's avatar
Adrien Di Mascio committed
32
33

from logilab.common import STD_BLACKLIST
34
35
from logilab.common.clcommands import register_commands, pop_arg

Adrien Di Mascio's avatar
Adrien Di Mascio committed
36
from cubicweb.__pkginfo__ import version as cubicwebversion
37
from cubicweb import CW_SOFTWARE_ROOT as BASEDIR, BadCommandUsage
38
39
from cubicweb.toolsutils import (SKEL_EXCLUDE, Command,
                                 copy_skeleton, underline_title)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
40
41
42
from cubicweb.web.webconfig import WebConfiguration
from cubicweb.server.serverconfig import ServerConfiguration

43

44
45
46
47
class DevConfiguration(ServerConfiguration, WebConfiguration):
    """dummy config to get full library schema and appobjects for
    a cube or for cubicweb (without a home)
    """
Adrien Di Mascio's avatar
Adrien Di Mascio committed
48
    creating = True
49
50
51
52
53
54
    cleanup_interface_sobjects = False

    cubicweb_appobject_path = (ServerConfiguration.cubicweb_appobject_path
                               | WebConfiguration.cubicweb_appobject_path)
    cube_appobject_path = (ServerConfiguration.cube_appobject_path
                           | WebConfiguration.cube_appobject_path)
Sylvain Thenault's avatar
Sylvain Thenault committed
55

56
    def __init__(self, *cubes):
57
58
59
60
        super(DevConfiguration, self).__init__(cubes and cubes[0] or None)
        if cubes:
            self._cubes = self.reorder_cubes(
                self.expand_cubes(cubes, with_recommends=True))
61
            self.load_site_cubicweb()
62
63
        else:
            self._cubes = ()
64

Adrien Di Mascio's avatar
Adrien Di Mascio committed
65
66
    @property
    def apphome(self):
Sylvain Thenault's avatar
Sylvain Thenault committed
67
68
69
        return None
    def main_config_file(self):
        return None
70
    def init_log(self):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
71
72
73
        pass
    def load_configuration(self):
        pass
Sylvain Thenault's avatar
Sylvain Thenault committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
    def default_log_file(self):
        return None


def cleanup_sys_modules(config):
    # cleanup sys.modules, required when we're updating multiple cubes
    for name, mod in sys.modules.items():
        if mod is None:
            # duh ? logilab.common.os for instance
            del sys.modules[name]
            continue
        if not hasattr(mod, '__file__'):
            continue
        for path in config.vregistry_path():
            if mod.__file__.startswith(path):
                del sys.modules[name]
                break
Sylvain Thénault's avatar
Sylvain Thénault committed
91
92
93
94
95
    # fresh rtags
    from cubicweb import rtags
    from cubicweb.web import uicfg
    rtags.RTAGS[:] = []
    reload(uicfg)
96

Adrien Di Mascio's avatar
Adrien Di Mascio committed
97
98
99
100
101
102
def generate_schema_pot(w, cubedir=None):
    """generate a pot file with schema specific i18n messages

    notice that relation definitions description and static vocabulary
    should be marked using '_' and extracted using xgettext
    """
103
    from cubicweb.cwvreg import CubicWebVRegistry
Adrien Di Mascio's avatar
Adrien Di Mascio committed
104
    if cubedir:
105
106
107
108
109
        cube = split(cubedir)[-1]
        config = DevConfiguration(cube)
        depcubes = list(config._cubes)
        depcubes.remove(cube)
        libconfig = DevConfiguration(*depcubes)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
110
    else:
111
112
113
        config = DevConfiguration()
        cube = libconfig = None
    cleanup_sys_modules(config)
114
    schema = config.load_schema(remove_unused_rtypes=False)
115
    vreg = CubicWebVRegistry(config)
Sylvain Thenault's avatar
Sylvain Thenault committed
116
    # set_schema triggers objects registrations
Adrien Di Mascio's avatar
Adrien Di Mascio committed
117
118
    vreg.set_schema(schema)
    w(DEFAULT_POT_HEAD)
119
    _generate_schema_pot(w, vreg, schema, libconfig=libconfig)
120
121


122
123
def _generate_schema_pot(w, vreg, schema, libconfig=None):
    from copy import deepcopy
124
    from cubicweb.i18n import add_msg
125
    from cubicweb.web import uicfg
126
    from cubicweb.schema import META_RTYPES, SYSTEM_RTYPES, CONSTRAINTS
127
    no_context_rtypes = META_RTYPES | SYSTEM_RTYPES
128
    w('# schema pot file, generated on %s\n' % datetime.now().strftime('%Y-%m-%d %H:%M:%S'))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
129
130
131
    w('# \n')
    w('# singular and plural forms for each entity type\n')
    w('\n')
132
    vregdone = set()
133
    if libconfig is not None:
134
        from cubicweb.cwvreg import CubicWebVRegistry, clear_rtag_objects
135
        libschema = libconfig.load_schema(remove_unused_rtypes=False)
136
        afs = deepcopy(uicfg.autoform_section)
137
138
139
140
141
        appearsin_addmenu = deepcopy(uicfg.actionbox_appearsin_addmenu)
        clear_rtag_objects()
        cleanup_sys_modules(libconfig)
        libvreg = CubicWebVRegistry(libconfig)
        libvreg.set_schema(libschema) # trigger objects registration
142
        libafs = uicfg.autoform_section
143
144
145
        libappearsin_addmenu = uicfg.actionbox_appearsin_addmenu
        # prefill vregdone set
        list(_iter_vreg_objids(libvreg, vregdone))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
146
    else:
147
        libschema = {}
148
        afs = uicfg.autoform_section
149
        appearsin_addmenu = uicfg.actionbox_appearsin_addmenu
150
151
        for cstrtype in CONSTRAINTS:
            add_msg(w, cstrtype)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
152
    done = set()
153
    for eschema in sorted(schema.entities()):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
154
        etype = eschema.type
155
156
157
        if etype not in libschema:
            add_msg(w, etype)
            add_msg(w, '%s_plural' % etype)
158
            if not eschema.final:
159
160
161
162
163
                add_msg(w, 'This %s' % etype)
                add_msg(w, 'New %s' % etype)
            if eschema.description and not eschema.description in done:
                done.add(eschema.description)
                add_msg(w, eschema.description)
164
        if eschema.final:
165
166
            continue
        for rschema, targetschemas, role in eschema.relation_definitions(True):
167
168
            if rschema.final:
                continue
169
            for tschema in targetschemas:
170
                fsections = afs.etype_get(eschema, rschema, role, tschema)
171
                if 'main_inlined' in fsections and \
172
                       (libconfig is None or not
173
                        'main_inlined' in libafs.etype_get(
174
                            eschema, rschema, role, tschema)):
175
176
                    add_msg(w, 'add a %s' % tschema,
                            'inlined:%s.%s.%s' % (etype, rschema, role))
177
                    add_msg(w, str(tschema),
178
                            'inlined:%s.%s.%s' % (etype, rschema, role))
179
180
181
182
                if appearsin_addmenu.etype_get(eschema, rschema, role, tschema):
                    if libconfig is not None and libappearsin_addmenu.etype_get(eschema, rschema, role, tschema):
                        if eschema in libschema and tschema in libschema:
                            continue
183
184
185
186
187
188
189
190
191
192
193
194
                    if role == 'subject':
                        label = 'add %s %s %s %s' % (eschema, rschema,
                                                     tschema, role)
                        label2 = "creating %s (%s %%(linkto)s %s %s)" % (
                            tschema, eschema, rschema, tschema)
                    else:
                        label = 'add %s %s %s %s' % (tschema, rschema,
                                                     eschema, role)
                        label2 = "creating %s (%s %s %s %%(linkto)s)" % (
                            tschema, tschema, rschema, eschema)
                    add_msg(w, label)
                    add_msg(w, label2)
Sylvain Thénault's avatar
Sylvain Thénault committed
195
196
            # XXX also generate "creating ...' messages for actions in the
            # addrelated submenu
Adrien Di Mascio's avatar
Adrien Di Mascio committed
197
    w('# subject and object forms for each relation type\n')
198
    w('# (no object form for final or symmetric relation types)\n')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
199
    w('\n')
200
    for rschema in sorted(schema.relations()):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
201
        rtype = rschema.type
202
203
204
205
206
207
208
209
210
211
        if rtype not in libschema:
            # bw compat, necessary until all translation of relation are done properly...
            add_msg(w, rtype)
            if rschema.description and rschema.description not in done:
                done.add(rschema.description)
                add_msg(w, rschema.description)
            done.add(rtype)
            librschema = None
        else:
            librschema = libschema.rschema(rtype)
212
        # add context information only for non-metadata rtypes
213
        if rschema not in no_context_rtypes:
214
            libsubjects = librschema and librschema.subjects() or ()
215
            for subjschema in rschema.subjects():
216
217
                if not subjschema in libsubjects:
                    add_msg(w, rtype, subjschema.type)
218
        if not (schema.rschema(rtype).final or rschema.symmetric):
219
            if rschema not in no_context_rtypes:
220
221
222
223
224
225
226
227
                libobjects = librschema and librschema.objects() or ()
                for objschema in rschema.objects():
                    if not objschema in libobjects:
                        add_msg(w, '%s_object' % rtype, objschema.type)
            if rtype not in libschema:
                # bw compat, necessary until all translation of relation are done properly...
                add_msg(w, '%s_object' % rtype)
    for objid in _iter_vreg_objids(vreg, vregdone):
228
229
230
        add_msg(w, '%s_description' % objid)
        add_msg(w, objid)

Sylvain Thénault's avatar
Sylvain Thénault committed
231

232
def _iter_vreg_objids(vreg, done):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
233
234
235
    for reg, objdict in vreg.items():
        for objects in objdict.values():
            for obj in objects:
Sylvain Thénault's avatar
Sylvain Thénault committed
236
                objid = '%s_%s' % (reg, obj.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
237
                if objid in done:
238
                    break
Sylvain Thénault's avatar
Sylvain Thénault committed
239
240
241
242
243
                try: # XXX < 3.6 bw compat
                    pdefs = obj.property_defs
                except AttributeError:
                    pdefs = getattr(obj, 'cw_property_defs', {})
                if pdefs:
244
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
245
                    done.add(objid)
246
                    break
247

248

249
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
I18NDIR = join(BASEDIR, 'i18n')
DEFAULT_POT_HEAD = r'''msgid ""
msgstr ""
"Project-Id-Version: cubicweb %s\n"
"PO-Revision-Date: 2008-03-28 18:14+0100\n"
"Last-Translator: Logilab Team <contact@logilab.fr>\n"
"Language-Team: fr <contact@logilab.fr>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: cubicweb-devtools\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

''' % cubicwebversion


class UpdateCubicWebCatalogCommand(Command):
    """Update i18n catalogs for cubicweb library.
268

Adrien Di Mascio's avatar
Adrien Di Mascio committed
269
270
271
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
272
    name = 'i18ncubicweb'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
273
274
275
276
277
278

    def run(self, args):
        """run the command with its specific arguments"""
        if args:
            raise BadCommandUsage('Too much arguments')
        import shutil
279
        import tempfile
Adrien Di Mascio's avatar
Adrien Di Mascio committed
280
281
        import yams
        from logilab.common.fileutils import ensure_fs_mode
282
        from logilab.common.shellutils import globfind, find, rm
283
        from logilab.common.modutils import get_module_files
284
        from cubicweb.i18n import extract_from_tal, execute
285
        tempdir = tempfile.mkdtemp()
286
        potfiles = [join(I18NDIR, 'static-messages.pot')]
287
        print '-> extract schema messages.'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
288
289
290
291
292
293
294
        schemapot = join(tempdir, 'schema.pot')
        potfiles.append(schemapot)
        # explicit close necessary else the file may not be yet flushed when
        # we'll using it below
        schemapotstream = file(schemapot, 'w')
        generate_schema_pot(schemapotstream.write, cubedir=None)
        schemapotstream.close()
295
        print '-> extract TAL messages.'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
296
297
        tali18nfile = join(tempdir, 'tali18n.py')
        extract_from_tal(find(join(BASEDIR, 'web'), ('.py', '.pt')), tali18nfile)
298
        print '-> generate .pot files.'
299
        for id, files, lang in [('pycubicweb', get_module_files(BASEDIR) + list(globfind(join(BASEDIR, 'misc', 'migration'), '*.py')), None),
300
                                ('schemadescr', globfind(join(BASEDIR, 'schemas'), '*.py'), None),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
301
302
                                ('yams', get_module_files(yams.__path__[0]), None),
                                ('tal', [tali18nfile], None),
303
                                ('js', globfind(join(BASEDIR, 'web'), 'cub*.js'), 'java'),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
304
                                ]:
305
            cmd = 'xgettext --no-location --omit-header -k_ -o %s %s'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
306
307
            if lang is not None:
                cmd += ' -L %s' % lang
308
            potfile = join(tempdir, '%s.pot' % id)
309
            execute(cmd % (potfile, ' '.join('"%s"' % f for f in files)))
310
311
312
            if exists(potfile):
                potfiles.append(potfile)
            else:
313
314
                print '-> WARNING: %s file was not generated' % potfile
        print '-> merging %i .pot files' % len(potfiles)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
315
        cubicwebpot = join(tempdir, 'cubicweb.pot')
316
        execute('msgcat -o %s %s' % (cubicwebpot, ' '.join('"%s"' % f for f in potfiles)))
317
        print '-> merging main pot file with existing translations.'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
318
319
320
321
        chdir(I18NDIR)
        toedit = []
        for lang in LANGS:
            target = '%s.po' % lang
322
            execute('msgmerge -N --sort-output -o "%snew" "%s" "%s"' % (target, target, cubicwebpot))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
323
324
325
326
            ensure_fs_mode(target)
            shutil.move('%snew' % target, target)
            toedit.append(abspath(target))
        # cleanup
327
        rm(tempdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
328
        # instructions pour la suite
329
330
        print '-> regenerated CubicWeb\'s .po catalogs.'
        print '\nYou can now edit the following files:'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
331
        print '* ' + '\n* '.join(toedit)
332
        print 'when you are done, run "cubicweb-ctl i18ncube yourcube".'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
333
334
335
336
337
338


class UpdateTemplateCatalogCommand(Command):
    """Update i18n catalogs for cubes. If no cube is specified, update
    catalogs of all registered cubes.
    """
339
    name = 'i18ncube'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
340
    arguments = '[<cube>...]'
341

Adrien Di Mascio's avatar
Adrien Di Mascio committed
342
343
344
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
345
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
346
        else:
347
348
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
349
            cubes = [cubepath for cubepath in cubes if exists(join(cubepath, 'i18n'))]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
350
351
        update_cubes_catalogs(cubes)

352

Adrien Di Mascio's avatar
Adrien Di Mascio committed
353
354
355
def update_cubes_catalogs(cubes):
    for cubedir in cubes:
        if not isdir(cubedir):
356
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
357
            continue
358
        try:
359
            toedit = update_cube_catalogs(cubedir)
360
361
362
        except Exception:
            import traceback
            traceback.print_exc()
Sylvain Thénault's avatar
Sylvain Thénault committed
363
364
365
            print '-> error while updating catalogs for cube', cubedir
        else:
            # instructions pour la suite
366
367
368
369
370
371
            if toedit:
                print '-> regenerated .po catalogs for cube %s.' % cubedir
                print '\nYou can now edit the following files:'
                print '* ' + '\n* '.join(toedit)
                print ('When you are done, run "cubicweb-ctl i18ninstance '
                       '<yourinstance>" to see changes in your instances.')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
372

373
374
def update_cube_catalogs(cubedir):
    import shutil
375
    import tempfile
376
377
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
378
    from cubicweb.i18n import extract_from_tal, execute
379
    cube = basename(normpath(cubedir))
380
    tempdir = tempfile.mkdtemp()
381
    print underline_title('Updating i18n catalogs for cube %s' % cube)
382
    chdir(cubedir)
383
384
385
386
387
388
389
390
    if exists(join('i18n', 'entities.pot')):
        warn('entities.pot is deprecated, rename file to static-messages.pot (%s)'
             % join('i18n', 'entities.pot'), DeprecationWarning)
        potfiles = [join('i18n', 'entities.pot')]
    elif exists(join('i18n', 'static-messages.pot')):
        potfiles = [join('i18n', 'static-messages.pot')]
    else:
        potfiles = []
391
    print '-> extract schema messages'
392
393
394
395
396
397
398
    schemapot = join(tempdir, 'schema.pot')
    potfiles.append(schemapot)
    # explicit close necessary else the file may not be yet flushed when
    # we'll using it below
    schemapotstream = file(schemapot, 'w')
    generate_schema_pot(schemapotstream.write, cubedir)
    schemapotstream.close()
399
    print '-> extract TAL messages'
400
401
    tali18nfile = join(tempdir, 'tali18n.py')
    extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
402
    print '-> extract Javascript messages'
403
404
405
406
407
408
409
410
    jsfiles =  [jsfile for jsfile in find('.', '.js') if basename(jsfile).startswith('cub')]
    if jsfiles:
        tmppotfile = join(tempdir, 'js.pot')
        execute('xgettext --no-location --omit-header -k_ -L java --from-code=utf-8 -o %s %s'
                % (tmppotfile, ' '.join(jsfiles)))
        # no pot file created if there are no string to translate
        if exists(tmppotfile):
            potfiles.append(tmppotfile)
411
    print '-> create cube-specific catalog'
412
413
414
415
    tmppotfile = join(tempdir, 'generated.pot')
    cubefiles = find('.', '.py', blacklist=STD_BLACKLIST+('test',))
    cubefiles.append(tali18nfile)
    execute('xgettext --no-location --omit-header -k_ -o %s %s'
416
            % (tmppotfile, ' '.join('"%s"' % f for f in cubefiles)))
417
418
419
    if exists(tmppotfile): # doesn't exists of no translation string found
        potfiles.append(tmppotfile)
    potfile = join(tempdir, 'cube.pot')
420
    print '-> merging %i .pot files:' % len(potfiles)
421
422
    execute('msgcat -o %s %s' % (potfile,
                                 ' '.join('"%s"' % f for f in potfiles)))
423
424
425
426
427
    if not exists(potfile):
        print 'no message catalog for cube', cube, 'nothing to translate'
        # cleanup
        rm(tempdir)
        return ()
428
    print '-> merging main pot file with existing translations:'
429
    chdir('i18n')
430
    toedit = []
431
    for lang in LANGS:
432
        print '-> language', lang
433
434
435
436
        cubepo = '%s.po' % lang
        if not exists(cubepo):
            shutil.copy(potfile, cubepo)
        else:
437
            execute('msgmerge -N -s -o %snew %s %s' % (cubepo, cubepo, potfile))
438
439
440
441
442
443
444
445
            ensure_fs_mode(cubepo)
            shutil.move('%snew' % cubepo, cubepo)
        toedit.append(abspath(cubepo))
    # cleanup
    rm(tempdir)
    return toedit


446
447
448
449
450
451
452
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
453

454
455
456
457
#     def run(self, args):
#         """run the command with its specific arguments"""
#         from cubicweb.devtools.livetest import runserver
#         runserver()
Adrien Di Mascio's avatar
Adrien Di Mascio committed
458
459


460
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
461
462
463
    """Create a new cube.

    <cubename>
464
      the name of the new cube. It should be a valid python module name.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
465
466
467
468
    """
    name = 'newcube'
    arguments = '<cubename>'

469
    options = (
470
471
472
473
474
475
476
        ("layout",
         {'short': 'L', 'type' : 'choice', 'metavar': '<cube layout>',
          'default': 'simple', 'choices': ('simple', 'full'),
          'help': 'cube layout. You\'ll get a minimal cube with the "simple" \
layout, and a full featured cube with "full" layout.',
          }
         ),
477
478
479
480
481
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
482
483
484
485
486
487
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
        ("author",
         {'short': 'a', 'type' : 'string', 'metavar': '<author>',
          'default': 'LOGILAB S.A. (Paris, FRANCE)',
          'help': 'cube author',
          }
         ),
        ("author-email",
         {'short': 'e', 'type' : 'string', 'metavar': '<email>',
          'default': 'contact@logilab.fr',
          'help': 'cube author\'s email',
          }
         ),
        ("author-web-site",
         {'short': 'w', 'type' : 'string', 'metavar': '<web site>',
          'default': 'http://www.logilab.fr',
          'help': 'cube author\'s web site',
          }
         ),
506
507
508
509
510
511
        ("license",
         {'short': 'l', 'type' : 'choice', 'metavar': '<license>',
          'default': 'LGPL', 'choices': ('GPL', 'LGPL', ''),
          'help': 'cube license',
          }
         ),
512
513
        )

514
    LICENSES = {
515
516
517
518
519
520
521
522
523
524
525
526
527
528
        'LGPL': '''\
# This program 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.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
''',
529

530
531
532
533
534
535
536
537
538
539
540
541
542
543
        'GPL': '''\
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 2.1 of the License, or (at your option) any later
# version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
''',
        '': '# INSERT LICENSE HERE'
544
        }
545

Adrien Di Mascio's avatar
Adrien Di Mascio committed
546
    def run(self, args):
547
        import re
548
        from logilab.common.shellutils import ASK
Adrien Di Mascio's avatar
Adrien Di Mascio committed
549
550
        if len(args) != 1:
            raise BadCommandUsage("exactly one argument (cube name) is expected")
551
552
553
        cubename = args[0]
        if not re.match('[_A-Za-z][_A-Za-z0-9]*$', cubename):
            raise BadCommandUsage("cube name should be a valid python module name")
554
        verbose = self.get('verbose')
555
        cubesdir = self.get('directory')
556
557
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
558
559
560
561
562
            if len(cubespath) > 1:
                raise BadCommandUsage("can't guess directory where to put the new cube."
                                      " Please specify it using the --directory option")
            cubesdir = cubespath[0]
        if not isdir(cubesdir):
563
            print "-> creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
564
            try:
565
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
566
            except OSError, err:
567
                self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
568
        cubedir = join(cubesdir, cubename)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
569
570
571
        if exists(cubedir):
            self.fail("%s already exists !" % (cubedir))
        skeldir = join(BASEDIR, 'skeleton')
572
        default_name = 'cubicweb-%s' % cubename.lower().replace('_', '-')
573
        if verbose:
574
            distname = raw_input('Debian name for your cube ? [%s]): ' % default_name).strip()
575
            if not distname:
576
                distname = default_name
577
            elif not distname.startswith('cubicweb-'):
578
                if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
579
580
                    distname = 'cubicweb-' + distname
        else:
581
            distname = default_name
582
583
        if not re.match('[a-z][-a-z0-9]*$', distname):
            raise BadCommandUsage("cube distname should be a valid debian package name")
584
585
        longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
        if verbose:
586
            longdesc = raw_input('Enter a long description (leave empty to reuse the short one): ')
587
        dependencies = {'cubicweb': '>= %s' % cubicwebversion}
588
        if verbose:
589
            dependencies.update(self._ask_for_dependencies())
Adrien Di Mascio's avatar
Adrien Di Mascio committed
590
591
592
593
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
594
                   'dependencies' : dependencies,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
595
                   'version'  : cubicwebversion,
596
                   'year'  : str(datetime.now().year),
597
598
599
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
600
601
                   'license': self['license'],
                   'long-license': self.LICENSES[self['license']],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
602
                   }
603
604
605
        exclude = SKEL_EXCLUDE
        if self['layout'] == 'simple':
            exclude += ('sobjects.py*', 'precreate.py*', 'realdb_test*',
606
                        'cubes.*', 'uiprops.py*')
607
        copy_skeleton(skeldir, cubedir, context, exclude=exclude)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
608

609
    def _ask_for_dependencies(self):
610
611
        from logilab.common.shellutils import ASK
        from logilab.common.textutils import splitstrip
612
613
614
        depcubes = []
        for cube in ServerConfiguration.available_cubes():
            answer = ASK.ask("Depends on cube %s? " % cube,
615
616
                             ('N','y','skip','type'), 'N')
            if answer == 'y':
617
                depcubes.append(cube)
618
            if answer == 'type':
619
                depcubes = splitstrip(raw_input('type dependencies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
620
                break
621
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
622
                break
623
624
        return dict(('cubicweb-' + cube, ServerConfiguration.cube_version(cube))
                    for cube in depcubes)
625

626
627
628
629
630
631
632
633
634
635

class ExamineLogCommand(Command):
    """Examine a rql log file.

    will print out the following table

      total execution time || number of occurences || rql query

    sorted by descending total execution time

636
637
    chances are the lines at the top are the ones that will bring the higher
    benefit after optimisation. Start there.
638
    """
639
    arguments = 'rql.log'
640
641
642
    name = 'exlog'
    options = (
        )
643

644
645
646
    def run(self, args):
        import re
        requests = {}
647
        for filepath in args:
648
            try:
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
                stream = file(filepath)
            except OSError, ex:
                raise BadCommandUsage("can't open rql log file %s: %s"
                                      % (filepath, ex))
            for lineno, line in enumerate(file):
                if not ' WHERE ' in line:
                    continue
                try:
                    rql, time = line.split('--')
                    rql = re.sub("(\'\w+': \d*)", '', rql)
                    if '{' in rql:
                        rql = rql[:rql.index('{')]
                    req = requests.setdefault(rql, [])
                    time.strip()
                    chunks = time.split()
                    clocktime = float(chunks[0][1:])
                    cputime = float(chunks[-3])
                    req.append( (clocktime, cputime) )
                except Exception, exc:
                    sys.stderr.write('Line %s: %s (%s)\n' % (lineno, exc, line))
669
        stat = []
670
        for rql, times in requests.iteritems():
671
672
673
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
674
675
        stat.sort()
        stat.reverse()
676
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat) * 0.01
677
678
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
679
680
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime,
                                            cputime, occ, rql)
681

682

683
684
685
686
687
688
689
690
class GenerateSchema(Command):
    """Generate schema image for the given cube"""
    name = "schema"
    arguments = '<cube>'
    options = [('output-file', {'type':'file', 'default': None,
                 'metavar': '<file>', 'short':'o', 'help':'output image file',
                 'input':False}),
               ('viewer', {'type': 'string', 'default':None,
691
                'short': "d", 'metavar':'<cmd>',
692
693
                 'help':'command use to view the generated file (empty for none)'}
               ),
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
               ('show-meta', {'action': 'store_true', 'default':False,
                'short': "m", 'metavar': "<yN>",
                 'help':'include meta and internal entities in schema'}
               ),
               ('show-workflow', {'action': 'store_true', 'default':False,
                'short': "w", 'metavar': "<yN>",
                'help':'include workflow entities in schema'}
               ),
               ('show-cw-user', {'action': 'store_true', 'default':False,
                'metavar': "<yN>",
                'help':'include cubicweb user entities in schema'}
               ),
               ('exclude-type', {'type':'string', 'default':'',
                'short': "x", 'metavar': "<types>",
                 'help':'coma separated list of entity types to remove from view'}
               ),
               ('include-type', {'type':'string', 'default':'',
                'short': "i", 'metavar': "<types>",
                 'help':'coma separated list of entity types to include in view'}
               ),
714
715
716
              ]

    def run(self, args):
717
718
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
719
        from logilab.common.textutils import splitstrip
720
721
722
        from yams import schema2dot, BASE_TYPES
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
723
        cubes = splitstrip(pop_arg(args, 1))
724
        dev_conf = DevConfiguration(*cubes)
725
726
727
728
729
        schema = dev_conf.load_schema()
        out, viewer = self['output-file'], self['viewer']
        if out is None:
            tmp_file = NamedTemporaryFile(suffix=".svg")
            out = tmp_file.name
730
731
732
733
734
735
736
737
738
739
        skiptypes = BASE_TYPES | SCHEMA_TYPES
        if not self['show-meta']:
            skiptypes |=  META_RTYPES | SYSTEM_RTYPES | INTERNAL_TYPES
        if not self['show-workflow']:
            skiptypes |= WORKFLOW_TYPES
        if not self['show-cw-user']:
            skiptypes |= set(('CWUser', 'CWGroup', 'EmailAddress'))
        skiptypes |= set(self['exclude-type'].split(','))
        skiptypes -= set(self['include-type'].split(','))
        schema2dot.schema2dot(schema, out, skiptypes=skiptypes)
740
741
742
743
        if viewer:
            p = Popen((viewer, out))
            p.wait()

Adrien Di Mascio's avatar
Adrien Di Mascio committed
744
745
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
746
                   #LiveServerCommand,
747
                   NewCubeCommand,
748
                   ExamineLogCommand,
749
                   GenerateSchema,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
750
                   ))