devctl.py 22.6 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), license is LGPL v2.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
6
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
7
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
Adrien Di Mascio's avatar
Adrien Di Mascio committed
8
9
10
11
"""
__docformat__ = "restructuredtext en"

import sys
12
from datetime import datetime
Aurelien Campeas's avatar
Aurelien Campeas committed
13
from os import mkdir, chdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
14
15
16
17
18
19
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
20
from logilab.common.clcommands import register_commands
Adrien Di Mascio's avatar
Adrien Di Mascio committed
21

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


Sylvain Thenault's avatar
Sylvain Thenault committed
29
class DevCubeConfiguration(ServerConfiguration, WebConfiguration):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
30
31
    """dummy config to get full library schema and entities"""
    creating = True
Sylvain Thenault's avatar
Sylvain Thenault committed
32
33
34
35
36
37
    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
38
39
            self._cubes = ()
        else:
40
            self._cubes = self.reorder_cubes(self.expand_cubes(self.my_cubes(cube)))
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
41
42
43

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

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


Sylvain Thenault's avatar
Sylvain Thenault committed
56
57
58
59
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
60
61
62

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

Sylvain Thenault's avatar
Sylvain Thenault committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    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
81
82
83
84
85
    # fresh rtags
    from cubicweb import rtags
    from cubicweb.web import uicfg
    rtags.RTAGS[:] = []
    reload(uicfg)
86

Adrien Di Mascio's avatar
Adrien Di Mascio committed
87
88
89
90
91
92
93
94
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]
95
96
97
    libconfig = DevDepConfiguration(cube)
    libconfig.cleanup_interface_sobjects = False
    cleanup_sys_modules(libconfig)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
98
    if cubedir:
Sylvain Thenault's avatar
Sylvain Thenault committed
99
        config = DevCubeConfiguration(cube)
100
        config.cleanup_interface_sobjects = False
Adrien Di Mascio's avatar
Adrien Di Mascio committed
101
    else:
102
103
        config = libconfig
        libconfig = None
104
    schema = config.load_schema(remove_unused_rtypes=False)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
105
    vreg = CubicWebRegistry(config)
Sylvain Thenault's avatar
Sylvain Thenault committed
106
    # set_schema triggers objects registrations
Adrien Di Mascio's avatar
Adrien Di Mascio committed
107
108
    vreg.set_schema(schema)
    w(DEFAULT_POT_HEAD)
109
    _generate_schema_pot(w, vreg, schema, libconfig=libconfig, cube=cube)
110
111


112
def _generate_schema_pot(w, vreg, schema, libconfig=None, cube=None):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
113
    from cubicweb.common.i18n import add_msg
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
    if libconfig is not None:
119
        libschema = libconfig.load_schema(remove_unused_rtypes=False)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
        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')
139
    if libconfig is not None:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
140
141
142
143
144
145
        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)
146
        done.add(rtype)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
147
148
149
150
151
152
153
        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
154
    actionbox = vreg['boxes']['edit_box'][0]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
155
156
157
    for eschema in schema.entities():
        if eschema.is_final():
            continue
158
        for role, rschemas in (('subject', eschema.subject_relations()),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
159
160
161
162
                            ('object', eschema.object_relations())):
            for rschema in rschemas:
                if rschema.is_final():
                    continue
163
164
                if libconfig is not None:
                    librschema = libschema.get(rschema)
165
                for teschema in rschema.targets(eschema, role):
166
                    if libconfig is not None and librschema is not None:
167
                        if role == 'subject':
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
168
                            subjtype, objtype = eschema, teschema
169
                        else:
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
170
                            subjtype, objtype = teschema, eschema
171
                        if librschema.has_rdef(subjtype, objtype):
172
                            continue
sylvain.thenault@logilab.fr's avatar
sylvain.thenault@logilab.fr committed
173
174
                    if actionbox.appearsin_addmenu.etype_get(eschema, rschema,
                                                             role, teschema):
175
176
177
178
179
                        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
180
                        else:
181
182
183
184
                            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
185
186
                        add_msg(w, label)
                        add_msg(w, label2)
187
    #cube = (cube and 'cubes.%s.' % cube or 'cubicweb.')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
188
    done = set()
189
190
191
192
193
194
195
196
197
198
199
    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
200
201
202
203
204
    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:
205
206
207
                    break
                if obj.property_defs:
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
208
                    done.add(objid)
209
                    break
210

211

212
def defined_in_library(etype, rtype, tetype, role):
213
214
    """return true if the given relation definition exists in cubicweb's library
    """
Adrien Di Mascio's avatar
Adrien Di Mascio committed
215
216
    if libschema is None:
        return False
217
    if role == 'subject':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
218
219
220
221
222
223
224
225
226
        subjtype, objtype = etype, tetype
    else:
        subjtype, objtype = tetype, etype
    try:
        return libschema.rschema(rtype).has_rdef(subjtype, objtype)
    except KeyError:
        return False


227
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
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.
246

Adrien Di Mascio's avatar
Adrien Di Mascio committed
247
248
249
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
250
    name = 'i18ncubicweb'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
251
252
253
254
255
256

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


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

Adrien Di Mascio's avatar
Adrien Di Mascio committed
319
320
321
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
322
            cubes = [DevCubeConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
323
        else:
324
325
            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
326
327
        update_cubes_catalogs(cubes)

328

Adrien Di Mascio's avatar
Adrien Di Mascio committed
329
330
331
332
def update_cubes_catalogs(cubes):
    toedit = []
    for cubedir in cubes:
        if not isdir(cubedir):
333
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
334
            continue
335
336
337
338
339
        try:
            toedit += update_cube_catalogs(cubedir)
        except Exception:
            import traceback
            traceback.print_exc()
340
            print '-> Error while updating catalogs for cube', cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
341
    # instructions pour la suite
342
343
    print '-> regenerated this cube\'s .po catalogs.'
    print '\nYou can now edit the following files:'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
344
    print '* ' + '\n* '.join(toedit)
345
    print 'when you are done, run "cubicweb-ctl i18ninstance yourinstance".'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
346

347
348
def update_cube_catalogs(cubedir):
    import shutil
349
    import tempfile
350
351
352
353
354
    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 = []
    cube = basename(normpath(cubedir))
355
    tempdir = tempfile.mkdtemp()
356
    print underline_title('Updating i18n catalogs for cube %s' % cube)
357
358
359
    chdir(cubedir)
    potfiles = [join('i18n', scfile) for scfile in ('entities.pot',)
                if exists(join('i18n', scfile))]
360
    print '-> extract schema messages'
361
362
363
364
365
366
367
    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()
368
    print '-> extract TAL messages'
369
370
    tali18nfile = join(tempdir, 'tali18n.py')
    extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
371
    print '-> extract Javascript messages'
372
373
374
375
376
377
378
379
    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)
380
    print '-> create cube-specific catalog'
381
382
383
384
385
386
387
388
    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')
389
    print '-> merging %i .pot files:' % len(potfiles)
390
    execute('msgcat %s > %s' % (' '.join(potfiles), potfile))
391
    print '-> merging main pot file with existing translations:'
392
393
    chdir('i18n')
    for lang in LANGS:
394
        print '-> language', lang
395
396
397
398
399
400
401
402
403
404
405
406
407
        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)
    return toedit


Adrien Di Mascio's avatar
Adrien Di Mascio committed
408
409
410
411
412
413
class LiveServerCommand(Command):
    """Run a server from within a cube directory.
    """
    name = 'live-server'
    arguments = ''
    options = ()
414

Adrien Di Mascio's avatar
Adrien Di Mascio committed
415
416
417
418
419
420
    def run(self, args):
        """run the command with its specific arguments"""
        from cubicweb.devtools.livetest import runserver
        runserver()


421
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
422
423
424
425
426
427
428
429
    """Create a new cube.

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

430
    options = (
431
432
433
434
435
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
436
437
438
439
440
441
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
        ("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',
          }
         ),
460
461
        )

462

Adrien Di Mascio's avatar
Adrien Di Mascio committed
463
464
465
466
    def run(self, args):
        if len(args) != 1:
            raise BadCommandUsage("exactly one argument (cube name) is expected")
        cubename, = args
467
468
        #if ServerConfiguration.mode != "dev":
        #    self.fail("you can only create new cubes in development mode")
469
        verbose = self.get('verbose')
470
        cubesdir = self.get('directory')
471
472
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
473
474
475
476
477
478
            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
479
            try:
480
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
481
            except OSError, err:
482
                self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
483
        cubedir = join(cubesdir, cubename)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
484
485
486
        if exists(cubedir):
            self.fail("%s already exists !" % (cubedir))
        skeldir = join(BASEDIR, 'skeleton')
487
488
489
490
491
492
493
494
        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
495
            distname = 'cubicweb-%s' % cubename.lower()
496

497
498
499
500
501
502
503
504
505
        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
506
        else:
507
            dependancies = ''
Adrien Di Mascio's avatar
Adrien Di Mascio committed
508
509
510
511
512
513
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
                   'dependancies' : dependancies,
                   'version'  : cubicwebversion,
514
                   'year'  : str(datetime.now().year),
515
516
517
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
                   }
        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
534

535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552

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 = (
        )
553

554
555
556
557
558
    def run(self, args):
        if args:
            raise BadCommandUsage("no argument expected")
        import re
        requests = {}
559
        for lineno, line in enumerate(sys.stdin):
560
561
562
            if not ' WHERE ' in line:
                continue
            #sys.stderr.write( line )
563
564
565
            try:
                rql, time = line.split('--')
                rql = re.sub("(\'\w+': \d*)", '', rql)
566
567
                if '{' in rql:
                    rql = rql[:rql.index('{')]
568
569
570
                req = requests.setdefault(rql, [])
                time.strip()
                chunks = time.split()
571
                clocktime = float(chunks[0][1:])
572
                cputime = float(chunks[-3])
573
                req.append( (clocktime, cputime) )
574
            except Exception, exc:
575
                sys.stderr.write('Line %s: %s (%s)\n' % (lineno, exc, line))
576
577
578

        stat = []
        for rql, times in requests.items():
579
580
581
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
582
583
584

        stat.sort()
        stat.reverse()
585

586
587
588
589
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat)*0.01
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime, cputime, occ, rql)
590

Adrien Di Mascio's avatar
Adrien Di Mascio committed
591
592
593
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
                   LiveServerCommand,
594
                   NewCubeCommand,
595
                   ExamineLogCommand,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
596
                   ))