devctl.py 28.5 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
"""
__docformat__ = "restructuredtext en"

11
12
13
# *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
14
import sys
15
from datetime import datetime
16
from os import mkdir, chdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
17
from os.path import join, exists, abspath, basename, normpath, split, isdir
18
from warnings import warn
Adrien Di Mascio's avatar
Adrien Di Mascio committed
19
20

from logilab.common import STD_BLACKLIST
21
22
from logilab.common.clcommands import register_commands, pop_arg

Adrien Di Mascio's avatar
Adrien Di Mascio committed
23
from cubicweb.__pkginfo__ import version as cubicwebversion
24
from cubicweb import CW_SOFTWARE_ROOT as BASEDIR, BadCommandUsage
25
26
from cubicweb.toolsutils import (SKEL_EXCLUDE, Command,
                                 copy_skeleton, underline_title)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
27
28
29
from cubicweb.web.webconfig import WebConfiguration
from cubicweb.server.serverconfig import ServerConfiguration

30

31
32
33
34
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
35
    creating = True
36
37
38
39
40
41
    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
42

43
    def __init__(self, *cubes):
44
45
46
47
48
49
        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 = ()
50

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

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


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

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

217
def _iter_vreg_objids(vreg, done):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
218
219
220
    for reg, objdict in vreg.items():
        for objects in objdict.values():
            for obj in objects:
Sylvain Thénault's avatar
Sylvain Thénault committed
221
                objid = '%s_%s' % (reg, obj.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
222
                if objid in done:
223
                    break
Sylvain Thénault's avatar
Sylvain Thénault committed
224
225
226
227
228
                try: # XXX < 3.6 bw compat
                    pdefs = obj.property_defs
                except AttributeError:
                    pdefs = getattr(obj, 'cw_property_defs', {})
                if pdefs:
229
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
230
                    done.add(objid)
231
                    break
232

233

234
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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.
253

Adrien Di Mascio's avatar
Adrien Di Mascio committed
254
255
256
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
257
    name = 'i18ncubicweb'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
258
259
260
261
262
263

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


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

Adrien Di Mascio's avatar
Adrien Di Mascio committed
327
328
329
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
330
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
331
        else:
332
333
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
334
            cubes = [cubepath for cubepath in cubes if exists(join(cubepath, 'i18n'))]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
335
336
        update_cubes_catalogs(cubes)

337

Adrien Di Mascio's avatar
Adrien Di Mascio committed
338
339
def update_cubes_catalogs(cubes):
    for cubedir in cubes:
Sylvain Thénault's avatar
Sylvain Thénault committed
340
        toedit = []
Adrien Di Mascio's avatar
Adrien Di Mascio committed
341
        if not isdir(cubedir):
342
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
343
            continue
344
345
346
347
348
        try:
            toedit += update_cube_catalogs(cubedir)
        except Exception:
            import traceback
            traceback.print_exc()
Sylvain Thénault's avatar
Sylvain Thénault committed
349
350
351
352
353
354
355
356
            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
357

358
359
def update_cube_catalogs(cubedir):
    import shutil
360
    import tempfile
361
362
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
363
    from cubicweb.i18n import extract_from_tal, execute
364
365
    toedit = []
    cube = basename(normpath(cubedir))
366
    tempdir = tempfile.mkdtemp()
367
    print underline_title('Updating i18n catalogs for cube %s' % cube)
368
    chdir(cubedir)
369
370
371
372
373
374
375
376
    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 = []
377
    print '-> extract schema messages'
378
379
380
381
382
383
384
    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()
385
    print '-> extract TAL messages'
386
387
    tali18nfile = join(tempdir, 'tali18n.py')
    extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
388
    print '-> extract Javascript messages'
389
390
391
392
393
394
395
396
    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)
397
    print '-> create cube-specific catalog'
398
399
400
401
    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'
402
            % (tmppotfile, ' '.join('"%s"' % f for f in cubefiles)))
403
404
405
    if exists(tmppotfile): # doesn't exists of no translation string found
        potfiles.append(tmppotfile)
    potfile = join(tempdir, 'cube.pot')
406
    print '-> merging %i .pot files:' % len(potfiles)
407
408
    execute('msgcat -o %s %s' % (potfile,
                                 ' '.join('"%s"' % f for f in potfiles)))
409
    print '-> merging main pot file with existing translations:'
410
411
    chdir('i18n')
    for lang in LANGS:
412
        print '-> language', lang
413
414
415
416
        cubepo = '%s.po' % lang
        if not exists(cubepo):
            shutil.copy(potfile, cubepo)
        else:
417
            execute('msgmerge -N -s -o %snew %s %s' % (cubepo, cubepo, potfile))
418
419
420
421
422
423
424
425
            ensure_fs_mode(cubepo)
            shutil.move('%snew' % cubepo, cubepo)
        toedit.append(abspath(cubepo))
    # cleanup
    rm(tempdir)
    return toedit


426
427
428
429
430
431
432
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
433

434
435
436
437
#     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
438
439


440
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
441
442
443
    """Create a new cube.

    <cubename>
444
      the name of the new cube. It should be a valid python module name.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
445
446
447
448
    """
    name = 'newcube'
    arguments = '<cubename>'

449
    options = (
450
451
452
453
454
455
456
        ("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.',
          }
         ),
457
458
459
460
461
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
462
463
464
465
466
467
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
        ("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',
          }
         ),
486
487
488
489
490
491
        ("license",
         {'short': 'l', 'type' : 'choice', 'metavar': '<license>',
          'default': 'LGPL', 'choices': ('GPL', 'LGPL', ''),
          'help': 'cube license',
          }
         ),
492
493
        )

494
495
496
497
498
    LICENSES = {
        'LGPL': 'GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses',
        'GPL': 'GNU General Public License, v2.1 - http://www.gnu.org/licenses',
        '': 'closed source'
        }
499

Adrien Di Mascio's avatar
Adrien Di Mascio committed
500
    def run(self, args):
501
        import re
502
        from logilab.common.shellutils import ASK
Adrien Di Mascio's avatar
Adrien Di Mascio committed
503
504
        if len(args) != 1:
            raise BadCommandUsage("exactly one argument (cube name) is expected")
505
506
507
        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")
508
        verbose = self.get('verbose')
509
        cubesdir = self.get('directory')
510
511
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
512
513
514
515
516
            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):
517
            print "-> creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
518
            try:
519
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
520
            except OSError, err:
521
                self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
522
        cubedir = join(cubesdir, cubename)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
523
524
525
        if exists(cubedir):
            self.fail("%s already exists !" % (cubedir))
        skeldir = join(BASEDIR, 'skeleton')
526
        default_name = 'cubicweb-%s' % cubename.lower().replace('_', '-')
527
        if verbose:
528
            distname = raw_input('Debian name for your cube ? [%s]): ' % default_name).strip()
529
            if not distname:
530
                distname = default_name
531
            elif not distname.startswith('cubicweb-'):
532
                if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
533
534
                    distname = 'cubicweb-' + distname
        else:
535
            distname = default_name
536
537
        if not re.match('[a-z][-a-z0-9]*$', distname):
            raise BadCommandUsage("cube distname should be a valid debian package name")
538
539
        longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
        if verbose:
540
            longdesc = raw_input('Enter a long description (leave empty to reuse the short one): ')
541
        dependencies = {'cubicweb': '>= %s' % cubicwebversion}
542
        if verbose:
543
            dependencies.update(self._ask_for_dependencies())
Adrien Di Mascio's avatar
Adrien Di Mascio committed
544
545
546
547
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
548
                   'dependencies' : dependencies,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
549
                   'version'  : cubicwebversion,
550
                   'year'  : str(datetime.now().year),
551
552
553
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
554
555
                   'license': self['license'],
                   'long-license': self.LICENSES[self['license']],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
556
                   }
557
558
559
560
561
        exclude = SKEL_EXCLUDE
        if self['layout'] == 'simple':
            exclude += ('sobjects.py*', 'precreate.py*', 'realdb_test*',
                        'cubes.*', 'external_resources*')
        copy_skeleton(skeldir, cubedir, context, exclude=exclude)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
562

563
    def _ask_for_dependencies(self):
564
565
        from logilab.common.shellutils import ASK
        from logilab.common.textutils import splitstrip
566
567
568
        depcubes = []
        for cube in ServerConfiguration.available_cubes():
            answer = ASK.ask("Depends on cube %s? " % cube,
569
570
                             ('N','y','skip','type'), 'N')
            if answer == 'y':
571
                depcubes.append(cube)
572
            if answer == 'type':
573
                depcubes = splitstrip(raw_input('type dependencies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
574
                break
575
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
576
                break
577
578
        return dict(('cubicweb-' + cube, ServerConfiguration.cube_version(cube))
                    for cube in depcubes)
579

580
581
582
583
584
585
586
587
588
589

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

590
591
    chances are the lines at the top are the ones that will bring the higher
    benefit after optimisation. Start there.
592
    """
593
    arguments = 'rql.log'
594
595
596
    name = 'exlog'
    options = (
        )
597

598
599
600
    def run(self, args):
        import re
        requests = {}
601
        for filepath in args:
602
            try:
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
                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))
623
        stat = []
624
        for rql, times in requests.iteritems():
625
626
627
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
628
629
        stat.sort()
        stat.reverse()
630
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat) * 0.01
631
632
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
633
634
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime,
                                            cputime, occ, rql)
635

636

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

    def run(self, args):
671
672
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
673
        from logilab.common.textutils import splitstrip
674
675
676
        from yams import schema2dot, BASE_TYPES
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
677
        cubes = splitstrip(pop_arg(args, 1))
678
        dev_conf = DevConfiguration(*cubes)
679
680
681
682
683
        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
684
685
686
687
688
689
690
691
692
693
        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)
694
695
696
697
        if viewer:
            p = Popen((viewer, out))
            p.wait()

Adrien Di Mascio's avatar
Adrien Di Mascio committed
698
699
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
700
                   #LiveServerCommand,
701
                   NewCubeCommand,
702
                   ExamineLogCommand,
703
                   GenerateSchema,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
704
                   ))