devctl.py 21.7 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-2009 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
6
7
8
9
10
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
"""
__docformat__ = "restructuredtext en"

import sys
11
from datetime import datetime
Aurelien Campeas's avatar
Aurelien Campeas committed
12
from os import mkdir, chdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
13
14
15
16
17
18
from os.path import join, exists, abspath, basename, normpath, split, isdir


from logilab.common import STD_BLACKLIST
from logilab.common.modutils import get_module_files
from logilab.common.textutils import get_csv
19
from logilab.common.clcommands import register_commands
Adrien Di Mascio's avatar
Adrien Di Mascio committed
20

21
from cubicweb import CW_SOFTWARE_ROOT as BASEDIR, BadCommandUsage
Adrien Di Mascio's avatar
Adrien Di Mascio committed
22
from cubicweb.__pkginfo__ import version as cubicwebversion
23
from cubicweb.toolsutils import Command, confirm, copy_skeleton
Adrien Di Mascio's avatar
Adrien Di Mascio committed
24
25
26
27
from cubicweb.web.webconfig import WebConfiguration
from cubicweb.server.serverconfig import ServerConfiguration


Sylvain Thenault's avatar
Sylvain Thenault committed
28
class DevCubeConfiguration(ServerConfiguration, WebConfiguration):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
29
30
    """dummy config to get full library schema and entities"""
    creating = True
Sylvain Thenault's avatar
Sylvain Thenault committed
31
32
33
34
35
36
    cubicweb_vobject_path = ServerConfiguration.cubicweb_vobject_path | WebConfiguration.cubicweb_vobject_path
    cube_vobject_path = ServerConfiguration.cube_vobject_path | WebConfiguration.cube_vobject_path

    def __init__(self, cube):
        super(DevCubeConfiguration, self).__init__(cube)
        if cube is None:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
37
38
            self._cubes = ()
        else:
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
39
40
41
42
            self._cubes = self.expand_cubes(self.my_cubes(cube))

    def my_cubes(self, cube):
        return (cube,) + self.cube_dependencies(cube) + self.cube_recommends(cube)
43

Adrien Di Mascio's avatar
Adrien Di Mascio committed
44
45
    @property
    def apphome(self):
Sylvain Thenault's avatar
Sylvain Thenault committed
46
47
48
        return None
    def main_config_file(self):
        return None
Adrien Di Mascio's avatar
Adrien Di Mascio committed
49
50
51
52
53
54
    def init_log(self, debug=None):
        pass
    def load_configuration(self):
        pass


Sylvain Thenault's avatar
Sylvain Thenault committed
55
56
57
58
class DevDepConfiguration(DevCubeConfiguration):
    """configuration to use to generate cubicweb po files or to use as "library" configuration
    to filter out message ids from cubicweb and dependencies of a cube
    """
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
59
60
61

    def my_cubes(self, cube):
        return self.cube_dependencies(cube) + self.cube_recommends(cube)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
62

Sylvain Thenault's avatar
Sylvain Thenault committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
    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
80

Adrien Di Mascio's avatar
Adrien Di Mascio committed
81
82
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
    """
    from cubicweb.cwvreg import CubicWebRegistry
    cube = cubedir and split(cubedir)[-1]
89
90
91
    libconfig = DevDepConfiguration(cube)
    libconfig.cleanup_interface_sobjects = False
    cleanup_sys_modules(libconfig)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
92
    if cubedir:
Sylvain Thenault's avatar
Sylvain Thenault committed
93
        config = DevCubeConfiguration(cube)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
94
95
        schema = config.load_schema()
    else:
96
        config = libconfig
97
        schema = config.load_schema()
98
        libconfig = None
Adrien Di Mascio's avatar
Adrien Di Mascio committed
99
    vreg = CubicWebRegistry(config)
Sylvain Thenault's avatar
Sylvain Thenault committed
100
    # set_schema triggers objects registrations
Adrien Di Mascio's avatar
Adrien Di Mascio committed
101
102
    vreg.set_schema(schema)
    w(DEFAULT_POT_HEAD)
103
    _generate_schema_pot(w, vreg, schema, libconfig=libconfig, cube=cube)
104
105


106
def _generate_schema_pot(w, vreg, schema, libconfig=None, cube=None):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
107
    from cubicweb.common.i18n import add_msg
108
    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
109
110
111
    w('# \n')
    w('# singular and plural forms for each entity type\n')
    w('\n')
112
113
    if libconfig is not None:
        libschema = libconfig.load_schema()
Adrien Di Mascio's avatar
Adrien Di Mascio committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
        entities = [e for e in schema.entities() if not e in libschema]
    else:
        entities = schema.entities()
    done = set()
    for eschema in sorted(entities):
        etype = eschema.type
        add_msg(w, etype)
        add_msg(w, '%s_plural' % etype)
        if not eschema.is_final():
            add_msg(w, 'This %s' % etype)
            add_msg(w, 'New %s' % etype)
            add_msg(w, 'add a %s' % etype)
            add_msg(w, 'remove this %s' % etype)
        if eschema.description and not eschema.description in done:
            done.add(eschema.description)
            add_msg(w, eschema.description)
    w('# subject and object forms for each relation type\n')
    w('# (no object form for final relation types)\n')
    w('\n')
133
    if libconfig is not None:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
134
135
136
137
138
139
        relations = [r for r in schema.relations() if not r in libschema]
    else:
        relations = schema.relations()
    for rschema in sorted(set(relations)):
        rtype = rschema.type
        add_msg(w, rtype)
140
        done.add(rtype)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
141
142
143
144
145
146
147
        if not (schema.rschema(rtype).is_final() or rschema.symetric):
            add_msg(w, '%s_object' % rtype)
        if rschema.description and rschema.description not in done:
            done.add(rschema.description)
            add_msg(w, rschema.description)
    w('# add related box generated message\n')
    w('\n')
Aurelien Campeas's avatar
Aurelien Campeas committed
148
    actionbox = vreg['boxes']['edit_box'][0]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
149
150
151
    for eschema in schema.entities():
        if eschema.is_final():
            continue
152
        for role, rschemas in (('subject', eschema.subject_relations()),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
153
154
155
156
                            ('object', eschema.object_relations())):
            for rschema in rschemas:
                if rschema.is_final():
                    continue
157
                for teschema in rschema.targets(eschema, role):
158
159
                    if libconfig is not None:
                        if role == 'subject':
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
160
                            subjtype, objtype = eschema, teschema
161
                        else:
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
162
163
                            subjtype, objtype = teschema, eschema
                        if rschema.has_rdef(subjtype, objtype):
164
                            continue
165
166
167
168
169
170
                    if actionbox.relation_mode(rschema, eschema, teschema, role) == 'create':
                        if role == 'subject':
                            label = 'add %s %s %s %s' % (eschema, rschema,
                                                         teschema, role)
                            label2 = "creating %s (%s %%(linkto)s %s %s)" % (
                                teschema, eschema, rschema, teschema)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
171
                        else:
172
173
174
175
                            label = 'add %s %s %s %s' % (teschema, rschema,
                                                         eschema, role)
                            label2 = "creating %s (%s %s %s %%(linkto)s)" % (
                                teschema, teschema, rschema, eschema)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
176
177
                        add_msg(w, label)
                        add_msg(w, label2)
178
    #cube = (cube and 'cubes.%s.' % cube or 'cubicweb.')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
179
    done = set()
180
181
182
183
184
185
186
187
188
189
190
    if libconfig is not None:
        from cubicweb.cwvreg import CubicWebRegistry
        libvreg = CubicWebRegistry(libconfig)
        libvreg.set_schema(libschema) # trigger objects registration
        # prefill done set
        list(_iter_vreg_objids(libvreg, done))
    for objid in _iter_vreg_objids(vreg, done):
        add_msg(w, '%s_description' % objid)
        add_msg(w, objid)

def _iter_vreg_objids(vreg, done, prefix=None):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
191
192
193
194
195
    for reg, objdict in vreg.items():
        for objects in objdict.values():
            for obj in objects:
                objid = '%s_%s' % (reg, obj.id)
                if objid in done:
196
197
198
                    break
                if obj.property_defs:
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
199
                    done.add(objid)
200
                    break
201

202

203
def defined_in_library(etype, rtype, tetype, role):
204
205
    """return true if the given relation definition exists in cubicweb's library
    """
Adrien Di Mascio's avatar
Adrien Di Mascio committed
206
207
    if libschema is None:
        return False
208
    if role == 'subject':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
209
210
211
212
213
214
215
216
217
        subjtype, objtype = etype, tetype
    else:
        subjtype, objtype = tetype, etype
    try:
        return libschema.rschema(rtype).has_rdef(subjtype, objtype)
    except KeyError:
        return False


218
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
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.
237

Adrien Di Mascio's avatar
Adrien Di Mascio committed
238
239
240
241
242
243
244
245
246
247
248
249
250
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
    name = 'i18nlibupdate'

    def run(self, args):
        """run the command with its specific arguments"""
        if args:
            raise BadCommandUsage('Too much arguments')
        import shutil
        from tempfile import mktemp
        import yams
        from logilab.common.fileutils import ensure_fs_mode
251
        from logilab.common.shellutils import globfind, find, rm
Adrien Di Mascio's avatar
Adrien Di Mascio committed
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
        from cubicweb.common.i18n import extract_from_tal, execute
        tempdir = mktemp()
        mkdir(tempdir)
        potfiles = [join(I18NDIR, 'entities.pot')]
        print '******** extract schema messages'
        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()
        print '******** extract TAL messages'
        tali18nfile = join(tempdir, 'tali18n.py')
        extract_from_tal(find(join(BASEDIR, 'web'), ('.py', '.pt')), tali18nfile)
        print '******** .pot files generation'
268
        for id, files, lang in [('pycubicweb', get_module_files(BASEDIR) + list(globfind(join(BASEDIR, 'misc', 'migration'), '*.py')), None),
269
                                ('schemadescr', globfind(join(BASEDIR, 'schemas'), '*.py'), None),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
270
271
                                ('yams', get_module_files(yams.__path__[0]), None),
                                ('tal', [tali18nfile], None),
272
                                ('js', globfind(join(BASEDIR, 'web'), 'cub*.js'), 'java'),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
273
                                ]:
274
            cmd = 'xgettext --no-location --omit-header -k_ -o %s %s'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
275
276
            if lang is not None:
                cmd += ' -L %s' % lang
277
278
279
280
281
282
            potfile = join(tempdir, '%s.pot' % id)
            execute(cmd % (potfile, ' '.join(files)))
            if exists(potfile):
                potfiles.append(potfile)
            else:
                print 'WARNING: %s file not generated' % potfile
Adrien Di Mascio's avatar
Adrien Di Mascio committed
283
284
285
286
287
288
289
290
291
292
293
294
295
        print '******** merging .pot files'
        cubicwebpot = join(tempdir, 'cubicweb.pot')
        execute('msgcat %s > %s' % (' '.join(potfiles), cubicwebpot))
        print '******** merging main pot file with existing translations'
        chdir(I18NDIR)
        toedit = []
        for lang in LANGS:
            target = '%s.po' % lang
            execute('msgmerge -N --sort-output  %s %s > %snew' % (target, cubicwebpot, target))
            ensure_fs_mode(target)
            shutil.move('%snew' % target, target)
            toedit.append(abspath(target))
        # cleanup
296
        rm(tempdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
297
298
299
300
301
302
303
304
305
306
307
308
309
310
        # instructions pour la suite
        print '*' * 72
        print 'you can now edit the following files:'
        print '* ' + '\n* '.join(toedit)
        print
        print "then you'll have to update cubes catalogs using the i18nupdate command"


class UpdateTemplateCatalogCommand(Command):
    """Update i18n catalogs for cubes. If no cube is specified, update
    catalogs of all registered cubes.
    """
    name = 'i18nupdate'
    arguments = '[<cube>...]'
311

Adrien Di Mascio's avatar
Adrien Di Mascio committed
312
313
314
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
315
            cubes = [DevCubeConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
316
        else:
317
318
            cubes = [DevCubeConfiguration.cube_dir(cube) for cube in DevCubeConfiguration.available_cubes()]
            cubes = [cubepath for cubepath in cubes if exists(join(cubepath, 'i18n'))]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
        update_cubes_catalogs(cubes)

def update_cubes_catalogs(cubes):
    import shutil
    from tempfile import mktemp
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
    from cubicweb.common.i18n import extract_from_tal, execute
    toedit = []
    for cubedir in cubes:
        cube = basename(normpath(cubedir))
        if not isdir(cubedir):
            print 'unknown cube', cube
            continue
        tempdir = mktemp()
        mkdir(tempdir)
        print '*' * 72
        print 'updating %s cube...' % cube
        chdir(cubedir)
        potfiles = [join('i18n', scfile) for scfile in ('entities.pot',)
                    if exists(join('i18n', scfile))]
        print '******** extract schema messages'
        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()
        print '******** extract TAL messages'
        tali18nfile = join(tempdir, 'tali18n.py')
        extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
        print '******** extract Javascript messages'
352
        jsfiles =  [jsfile for jsfile in find('.', '.js') if basename(jsfile).startswith('cub')]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
353
354
355
356
357
        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
358
            if exists(tmppotfile):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
                potfiles.append(tmppotfile)
        print '******** create cube specific catalog'
        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'
                % (tmppotfile, ' '.join(cubefiles)))
        if exists(tmppotfile): # doesn't exists of no translation string found
            potfiles.append(tmppotfile)
        potfile = join(tempdir, 'cube.pot')
        print '******** merging .pot files'
        execute('msgcat %s > %s' % (' '.join(potfiles), potfile))
        print '******** merging main pot file with existing translations'
        chdir('i18n')
        for lang in LANGS:
            print '****', lang
            cubepo = '%s.po' % lang
            if not exists(cubepo):
                shutil.copy(potfile, cubepo)
            else:
                execute('msgmerge -N -s %s %s > %snew' % (cubepo, potfile, cubepo))
                ensure_fs_mode(cubepo)
                shutil.move('%snew' % cubepo, cubepo)
            toedit.append(abspath(cubepo))
        # cleanup
        rm(tempdir)
    # instructions pour la suite
    print '*' * 72
    print 'you can now edit the following files:'
    print '* ' + '\n* '.join(toedit)


class LiveServerCommand(Command):
    """Run a server from within a cube directory.
    """
    name = 'live-server'
    arguments = ''
    options = ()
397

Adrien Di Mascio's avatar
Adrien Di Mascio committed
398
399
400
401
402
403
    def run(self, args):
        """run the command with its specific arguments"""
        from cubicweb.devtools.livetest import runserver
        runserver()


404
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
405
406
407
408
409
410
411
412
    """Create a new cube.

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

413
    options = (
414
415
416
417
418
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
419
420
421
422
423
424
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
        ("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',
          }
         ),
443
444
        )

445

Adrien Di Mascio's avatar
Adrien Di Mascio committed
446
447
448
449
    def run(self, args):
        if len(args) != 1:
            raise BadCommandUsage("exactly one argument (cube name) is expected")
        cubename, = args
450
451
        #if ServerConfiguration.mode != "dev":
        #    self.fail("you can only create new cubes in development mode")
452
        verbose = self.get('verbose')
453
        cubesdir = self.get('directory')
454
455
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
456
457
458
459
460
461
            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):
            print "creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
462
            try:
463
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
464
            except OSError, err:
465
                self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
466
        cubedir = join(cubesdir, cubename)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
467
468
469
        if exists(cubedir):
            self.fail("%s already exists !" % (cubedir))
        skeldir = join(BASEDIR, 'skeleton')
470
471
472
473
474
475
476
477
        if verbose:
            distname = raw_input('Debian name for your cube (just type enter to use the cube name): ').strip()
            if not distname:
                distname = 'cubicweb-%s' % cubename.lower()
            elif not distname.startswith('cubicweb-'):
                if confirm('do you mean cubicweb-%s ?' % distname):
                    distname = 'cubicweb-' + distname
        else:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
478
            distname = 'cubicweb-%s' % cubename.lower()
479

480
481
482
483
484
485
486
487
488
        longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
        if verbose:
            longdesc = raw_input('Enter a long description (or nothing if you want to reuse the short one): ')
        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
489
        else:
490
            dependancies = ''
Adrien Di Mascio's avatar
Adrien Di Mascio committed
491
492
493
494
495
496
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
                   'dependancies' : dependancies,
                   'version'  : cubicwebversion,
497
                   'year'  : str(datetime.now().year),
498
499
500
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
                   }
        copy_skeleton(skeldir, cubedir, context)

    def _ask_for_dependancies(self):
        includes = []
        for stdtype in ServerConfiguration.available_cubes():
            ans = raw_input("Depends on cube %s? (N/y/s(kip)/t(ype)"
                            % stdtype).lower().strip()
            if ans == 'y':
                includes.append(stdtype)
            if ans == 't':
                includes = get_csv(raw_input('type dependancies: '))
                break
            elif ans == 's':
                break
        return includes
517

518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535

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

    usage: python exlog.py < rql.log

    will print out the following table

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

    sorted by descending total execution time

    chances are the lines at the top are the ones that will bring
    the higher benefit after optimisation. Start there.
    """
    name = 'exlog'
    options = (
        )
536

537
538
539
540
541
    def run(self, args):
        if args:
            raise BadCommandUsage("no argument expected")
        import re
        requests = {}
542
        for lineno, line in enumerate(sys.stdin):
543
544
545
            if not ' WHERE ' in line:
                continue
            #sys.stderr.write( line )
546
547
548
            try:
                rql, time = line.split('--')
                rql = re.sub("(\'\w+': \d*)", '', rql)
549
550
                if '{' in rql:
                    rql = rql[:rql.index('{')]
551
552
553
554
555
556
                req = requests.setdefault(rql, [])
                time.strip()
                chunks = time.split()
                cputime = float(chunks[-3])
                req.append( cputime )
            except Exception, exc:
557
                sys.stderr.write('Line %s: %s (%s)\n' % (lineno, exc, line))
558
559
560
561
562
563
564

        stat = []
        for rql, times in requests.items():
            stat.append( (sum(times), len(times), rql) )

        stat.sort()
        stat.reverse()
565
566
567

        total_time = sum(time for time, occ, rql in stat)*0.01
        print 'Percentage;Cumulative Time;Occurences;Query'
568
        for time, occ, rql in stat:
569
            print '%.2f;%.2f;%s;%s' % (time/total_time, time, occ, rql)
570

Adrien Di Mascio's avatar
Adrien Di Mascio committed
571
572
573
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
                   LiveServerCommand,
574
                   NewCubeCommand,
575
                   ExamineLogCommand,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
576
                   ))