devctl.py 27.1 KB
Newer Older
Adrien Di Mascio's avatar
Adrien Di Mascio committed
1
2
3
4
"""additional cubicweb-ctl commands and command handlers for cubicweb and cubicweb's
cubes development

:organization: Logilab
5
:copyright: 2001-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
6
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
7
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
Adrien Di Mascio's avatar
Adrien Di Mascio committed
8
9
10
11
"""
__docformat__ = "restructuredtext en"

import sys
12
from datetime import datetime
13
from os import mkdir, chdir, getcwd
Adrien Di Mascio's avatar
Adrien Di Mascio committed
14
from os.path import join, exists, abspath, basename, normpath, split, isdir
15
from copy import deepcopy
16
from warnings import warn
17
18
from tempfile import NamedTemporaryFile
from subprocess import Popen
Adrien Di Mascio's avatar
Adrien Di Mascio committed
19
20
21

from logilab.common import STD_BLACKLIST
from logilab.common.modutils import get_module_files
22
from logilab.common.textutils import splitstrip
23
from logilab.common.shellutils import ASK
24
25
26
from logilab.common.clcommands import register_commands, pop_arg

from yams import schema2dot
Adrien Di Mascio's avatar
Adrien Di Mascio committed
27
28

from cubicweb.__pkginfo__ import version as cubicwebversion
29
from cubicweb import CW_SOFTWARE_ROOT as BASEDIR, BadCommandUsage
30
from cubicweb.toolsutils import Command, copy_skeleton, underline_title
31
from cubicweb.schema import CONSTRAINTS
Adrien Di Mascio's avatar
Adrien Di Mascio committed
32
33
from cubicweb.web.webconfig import WebConfiguration
from cubicweb.server.serverconfig import ServerConfiguration
34
35
36
from yams import BASE_TYPES
from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                             WORKFLOW_TYPES, INTERNAL_TYPES)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
37

38

39
40
41
42
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
43
    creating = True
44
45
46
47
48
49
    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
50

51
    def __init__(self, *cubes):
52
53
54
55
56
57
        super(DevConfiguration, self).__init__(cubes and cubes[0] or None)
        if cubes:
            self._cubes = self.reorder_cubes(
                self.expand_cubes(cubes, with_recommends=True))
        else:
            self._cubes = ()
58

Adrien Di Mascio's avatar
Adrien Di Mascio committed
59
60
    @property
    def apphome(self):
Sylvain Thenault's avatar
Sylvain Thenault committed
61
62
63
        return None
    def main_config_file(self):
        return None
Adrien Di Mascio's avatar
Adrien Di Mascio committed
64
65
66
67
    def init_log(self, debug=None):
        pass
    def load_configuration(self):
        pass
Sylvain Thenault's avatar
Sylvain Thenault committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
    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
85
86
87
88
89
    # fresh rtags
    from cubicweb import rtags
    from cubicweb.web import uicfg
    rtags.RTAGS[:] = []
    reload(uicfg)
90

Adrien Di Mascio's avatar
Adrien Di Mascio committed
91
92
93
94
95
96
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
    """
97
    from cubicweb.cwvreg import CubicWebVRegistry
Adrien Di Mascio's avatar
Adrien Di Mascio committed
98
    if cubedir:
99
100
101
102
103
        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
104
    else:
105
106
107
        config = DevConfiguration()
        cube = libconfig = None
    cleanup_sys_modules(config)
108
    schema = config.load_schema(remove_unused_rtypes=False)
109
    vreg = CubicWebVRegistry(config)
Sylvain Thenault's avatar
Sylvain Thenault committed
110
    # set_schema triggers objects registrations
Adrien Di Mascio's avatar
Adrien Di Mascio committed
111
112
    vreg.set_schema(schema)
    w(DEFAULT_POT_HEAD)
113
    _generate_schema_pot(w, vreg, schema, libconfig=libconfig, cube=cube)
114
115


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

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

224
def _iter_vreg_objids(vreg, done, prefix=None):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
225
226
227
    for reg, objdict in vreg.items():
        for objects in objdict.values():
            for obj in objects:
Sylvain Thénault's avatar
Sylvain Thénault committed
228
                objid = '%s_%s' % (reg, obj.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
229
                if objid in done:
230
                    break
Sylvain Thénault's avatar
Sylvain Thénault committed
231
232
233
234
235
                try: # XXX < 3.6 bw compat
                    pdefs = obj.property_defs
                except AttributeError:
                    pdefs = getattr(obj, 'cw_property_defs', {})
                if pdefs:
236
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
237
                    done.add(objid)
238
                    break
239

240

241
def defined_in_library(etype, rtype, tetype, role):
242
243
    """return true if the given relation definition exists in cubicweb's library
    """
Adrien Di Mascio's avatar
Adrien Di Mascio committed
244
245
    if libschema is None:
        return False
246
    if role == 'subject':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
247
248
249
250
251
252
253
254
255
        subjtype, objtype = etype, tetype
    else:
        subjtype, objtype = tetype, etype
    try:
        return libschema.rschema(rtype).has_rdef(subjtype, objtype)
    except KeyError:
        return False


256
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
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.
275

Adrien Di Mascio's avatar
Adrien Di Mascio committed
276
277
278
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
279
    name = 'i18ncubicweb'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
280
281
282
283
284
285

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


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

Adrien Di Mascio's avatar
Adrien Di Mascio committed
348
349
350
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
351
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
352
        else:
353
354
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
355
            cubes = [cubepath for cubepath in cubes if exists(join(cubepath, 'i18n'))]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
356
357
        update_cubes_catalogs(cubes)

358

Adrien Di Mascio's avatar
Adrien Di Mascio committed
359
360
def update_cubes_catalogs(cubes):
    for cubedir in cubes:
Sylvain Thénault's avatar
Sylvain Thénault committed
361
        toedit = []
Adrien Di Mascio's avatar
Adrien Di Mascio committed
362
        if not isdir(cubedir):
363
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
364
            continue
365
366
367
368
369
        try:
            toedit += update_cube_catalogs(cubedir)
        except Exception:
            import traceback
            traceback.print_exc()
Sylvain Thénault's avatar
Sylvain Thénault committed
370
371
372
373
374
375
376
377
            print '-> error while updating catalogs for cube', cubedir
        else:
            # instructions pour la suite
            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
378

379
380
def update_cube_catalogs(cubedir):
    import shutil
381
    import tempfile
382
383
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
384
    from cubicweb.i18n import extract_from_tal, execute
385
386
    toedit = []
    cube = basename(normpath(cubedir))
387
    tempdir = tempfile.mkdtemp()
388
    print underline_title('Updating i18n catalogs for cube %s' % cube)
389
    chdir(cubedir)
390
391
392
393
394
395
396
397
    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 = []
398
    print '-> extract schema messages'
399
400
401
402
403
404
405
    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()
406
    print '-> extract TAL messages'
407
408
    tali18nfile = join(tempdir, 'tali18n.py')
    extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
409
    print '-> extract Javascript messages'
410
411
412
413
414
415
416
417
    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)
418
    print '-> create cube-specific catalog'
419
420
421
422
    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'
423
            % (tmppotfile, ' '.join('"%s"' % f for f in cubefiles)))
424
425
426
    if exists(tmppotfile): # doesn't exists of no translation string found
        potfiles.append(tmppotfile)
    potfile = join(tempdir, 'cube.pot')
427
    print '-> merging %i .pot files:' % len(potfiles)
428
429
    execute('msgcat -o %s %s' % (potfile,
                                 ' '.join('"%s"' % f for f in potfiles)))
430
    print '-> merging main pot file with existing translations:'
431
432
    chdir('i18n')
    for lang in LANGS:
433
        print '-> language', lang
434
435
436
437
        cubepo = '%s.po' % lang
        if not exists(cubepo):
            shutil.copy(potfile, cubepo)
        else:
438
            execute('msgmerge -N -s -o %snew %s %s' % (cubepo, cubepo, potfile))
439
440
441
442
443
444
445
446
            ensure_fs_mode(cubepo)
            shutil.move('%snew' % cubepo, cubepo)
        toedit.append(abspath(cubepo))
    # cleanup
    rm(tempdir)
    return toedit


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

455
456
457
458
#     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
459
460


461
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
462
463
464
465
466
467
468
469
    """Create a new cube.

    <cubename>
      the name of the new cube
    """
    name = 'newcube'
    arguments = '<cubename>'

470
    options = (
471
472
473
474
475
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
476
477
478
479
480
481
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
        ("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',
          }
         ),
500
501
        )

502

Adrien Di Mascio's avatar
Adrien Di Mascio committed
503
504
505
506
    def run(self, args):
        if len(args) != 1:
            raise BadCommandUsage("exactly one argument (cube name) is expected")
        cubename, = args
507
        verbose = self.get('verbose')
508
        cubesdir = self.get('directory')
509
510
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
511
512
513
514
515
            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):
516
            print "-> creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
517
            try:
518
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
519
            except OSError, err:
520
                self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
521
        cubedir = join(cubesdir, cubename)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
522
523
524
        if exists(cubedir):
            self.fail("%s already exists !" % (cubedir))
        skeldir = join(BASEDIR, 'skeleton')
525
        default_name = 'cubicweb-%s' % cubename.lower()
526
        if verbose:
527
            distname = raw_input('Debian name for your cube ? [%s]): ' % default_name).strip()
528
            if not distname:
529
                distname = default_name
530
            elif not distname.startswith('cubicweb-'):
531
                if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
532
533
                    distname = 'cubicweb-' + distname
        else:
534
            distname = default_name
535

536
537
        longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
        if verbose:
538
            longdesc = raw_input('Enter a long description (leave empty to reuse the short one): ')
539
540
541
542
543
544
        if verbose:
            includes = self._ask_for_dependancies()
            if len(includes) == 1:
                dependancies = '%r,' % includes[0]
            else:
                dependancies = ', '.join(repr(cube) for cube in includes)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
545
        else:
546
            dependancies = ''
Adrien Di Mascio's avatar
Adrien Di Mascio committed
547
548
549
550
551
552
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
                   'dependancies' : dependancies,
                   'version'  : cubicwebversion,
553
                   'year'  : str(datetime.now().year),
554
555
556
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
557
558
559
560
561
562
                   }
        copy_skeleton(skeldir, cubedir, context)

    def _ask_for_dependancies(self):
        includes = []
        for stdtype in ServerConfiguration.available_cubes():
563
564
565
            answer = ASK.ask("Depends on cube %s? " % stdtype,
                             ('N','y','skip','type'), 'N')
            if answer == 'y':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
566
                includes.append(stdtype)
567
            if answer == 'type':
568
                includes = splitstrip(raw_input('type dependancies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
569
                break
570
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
571
572
                break
        return includes
573

574
575
576
577
578
579
580
581
582
583

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

584
585
    chances are the lines at the top are the ones that will bring the higher
    benefit after optimisation. Start there.
586
    """
587
    arguments = '< rql.log'
588
589
590
    name = 'exlog'
    options = (
        )
591

592
593
594
595
596
    def run(self, args):
        if args:
            raise BadCommandUsage("no argument expected")
        import re
        requests = {}
597
        for lineno, line in enumerate(sys.stdin):
598
599
600
            if not ' WHERE ' in line:
                continue
            #sys.stderr.write( line )
601
602
603
            try:
                rql, time = line.split('--')
                rql = re.sub("(\'\w+': \d*)", '', rql)
604
605
                if '{' in rql:
                    rql = rql[:rql.index('{')]
606
607
608
                req = requests.setdefault(rql, [])
                time.strip()
                chunks = time.split()
609
                clocktime = float(chunks[0][1:])
610
                cputime = float(chunks[-3])
611
                req.append( (clocktime, cputime) )
612
            except Exception, exc:
613
                sys.stderr.write('Line %s: %s (%s)\n' % (lineno, exc, line))
614
615
616

        stat = []
        for rql, times in requests.items():
617
618
619
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
620
621
622

        stat.sort()
        stat.reverse()
623

624
625
626
627
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat)*0.01
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime, cputime, occ, rql)
628

629

630
631
632
633
634
635
636
637
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,
638
                'short': "d", 'metavar':'<cmd>',
639
640
                 'help':'command use to view the generated file (empty for none)'}
               ),
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
               ('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'}
               ),
661
662
663
664
665
              ]

    def run(self, args):
        from logilab.common.textutils import splitstrip
        cubes = splitstrip(pop_arg(args, 1))
666
        dev_conf = DevConfiguration(*cubes)
667
668
669
670
671
        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
672
673
674
675
676
677
678
679
680
681
        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)
682
683
684
685
        if viewer:
            p = Popen((viewer, out))
            p.wait()

Adrien Di Mascio's avatar
Adrien Di Mascio committed
686
687
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
688
                   #LiveServerCommand,
689
                   NewCubeCommand,
690
                   ExamineLogCommand,
691
                   GenerateSchema,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
692
                   ))