devctl.py 27.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 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.
#
# logilab-common is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
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
from cubicweb.toolsutils import Command, copy_skeleton, underline_title
Adrien Di Mascio's avatar
Adrien Di Mascio committed
39
40
41
from cubicweb.web.webconfig import WebConfiguration
from cubicweb.server.serverconfig import ServerConfiguration

42

43
44
45
46
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
47
    creating = True
48
49
50
51
52
53
    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
54

55
    def __init__(self, *cubes):
56
57
58
59
60
61
        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 = ()
62

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

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


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

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

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

245

246
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
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.
265

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

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


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

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

349

Adrien Di Mascio's avatar
Adrien Di Mascio committed
350
351
def update_cubes_catalogs(cubes):
    for cubedir in cubes:
Sylvain Thénault's avatar
Sylvain Thénault committed
352
        toedit = []
Adrien Di Mascio's avatar
Adrien Di Mascio committed
353
        if not isdir(cubedir):
354
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
355
            continue
356
357
358
359
360
        try:
            toedit += update_cube_catalogs(cubedir)
        except Exception:
            import traceback
            traceback.print_exc()
Sylvain Thénault's avatar
Sylvain Thénault committed
361
362
363
364
365
366
367
368
            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
369

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


438
439
440
441
442
443
444
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
445

446
447
448
449
#     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
450
451


452
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
453
454
455
456
457
458
459
460
    """Create a new cube.

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

461
    options = (
462
463
464
465
466
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
467
468
469
470
471
472
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
        ("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',
          }
         ),
491
492
        )

493

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

528
529
        longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
        if verbose:
530
            longdesc = raw_input('Enter a long description (leave empty to reuse the short one): ')
531
        dependencies = {}
532
        if verbose:
533
            dependencies = self._ask_for_dependencies()
Adrien Di Mascio's avatar
Adrien Di Mascio committed
534
535
536
537
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
538
                   'dependencies' : dict((dep, None) for dep in dependencies),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
539
                   'version'  : cubicwebversion,
540
                   'year'  : str(datetime.now().year),
541
542
543
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
544
545
546
                   }
        copy_skeleton(skeldir, cubedir, context)

547
    def _ask_for_dependencies(self):
548
549
        from logilab.common.shellutils import ASK
        from logilab.common.textutils import splitstrip
Adrien Di Mascio's avatar
Adrien Di Mascio committed
550
551
        includes = []
        for stdtype in ServerConfiguration.available_cubes():
552
553
554
            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
555
                includes.append(stdtype)
556
            if answer == 'type':
557
                includes = splitstrip(raw_input('type dependencies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
558
                break
559
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
560
561
                break
        return includes
562

563
564
565
566
567
568
569
570
571
572

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

573
574
    chances are the lines at the top are the ones that will bring the higher
    benefit after optimisation. Start there.
575
    """
576
    arguments = 'rql.log'
577
578
579
    name = 'exlog'
    options = (
        )
580

581
582
583
    def run(self, args):
        import re
        requests = {}
584
        for filepath in args:
585
            try:
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
                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))
606
        stat = []
607
        for rql, times in requests.iteritems():
608
609
610
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
611
612
        stat.sort()
        stat.reverse()
613
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat) * 0.01
614
615
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
616
617
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime,
                                            cputime, occ, rql)
618

619

620
621
622
623
624
625
626
627
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,
628
                'short': "d", 'metavar':'<cmd>',
629
630
                 'help':'command use to view the generated file (empty for none)'}
               ),
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
               ('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'}
               ),
651
652
653
              ]

    def run(self, args):
654
655
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
656
        from logilab.common.textutils import splitstrip
657
658
659
        from yams import schema2dot, BASE_TYPES
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
660
        cubes = splitstrip(pop_arg(args, 1))
661
        dev_conf = DevConfiguration(*cubes)
662
663
664
665
666
        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
667
668
669
670
671
672
673
674
675
676
        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)
677
678
679
680
        if viewer:
            p = Popen((viewer, out))
            p.wait()

Adrien Di Mascio's avatar
Adrien Di Mascio committed
681
682
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
683
                   #LiveServerCommand,
684
                   NewCubeCommand,
685
                   ExamineLogCommand,
686
                   GenerateSchema,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
687
                   ))