devctl.py 31.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
# 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.
#
11
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
12
13
14
15
16
17
# 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/>.
18
19
"""additional cubicweb-ctl commands and command handlers for cubicweb and
cubicweb's cubes development
Adrien Di Mascio's avatar
Adrien Di Mascio committed
20
"""
21

Adrien Di Mascio's avatar
Adrien Di Mascio committed
22
23
__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, listdir, path as osp
30
from warnings import warn
Adrien Di Mascio's avatar
Adrien Di Mascio committed
31
32

from logilab.common import STD_BLACKLIST
33

Adrien Di Mascio's avatar
Adrien Di Mascio committed
34
from cubicweb.__pkginfo__ import version as cubicwebversion
35
from cubicweb import CW_SOFTWARE_ROOT as BASEDIR, BadCommandUsage
36
from cubicweb.cwctl import CWCTL
37
38
from cubicweb.toolsutils import (SKEL_EXCLUDE, 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
        super(DevConfiguration, self).__init__(cubes and cubes[0] or None)
        if cubes:
            self._cubes = self.reorder_cubes(
                self.expand_cubes(cubes, with_recommends=True))
60
            self.load_site_cubicweb()
61
62
        else:
            self._cubes = ()
63

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

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


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

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

235
def _iter_vreg_objids(vreg, done):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
236
    for reg, objdict in vreg.items():
237
238
        if reg in ('boxes', 'contentnavigation'):
            continue
Adrien Di Mascio's avatar
Adrien Di Mascio committed
239
240
        for objects in objdict.values():
            for obj in objects:
Sylvain Thénault's avatar
Sylvain Thénault committed
241
                objid = '%s_%s' % (reg, obj.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
242
                if objid in done:
243
                    break
Sylvain Thénault's avatar
Sylvain Thénault committed
244
245
246
247
248
                try: # XXX < 3.6 bw compat
                    pdefs = obj.property_defs
                except AttributeError:
                    pdefs = getattr(obj, 'cw_property_defs', {})
                if pdefs:
249
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
250
                    done.add(objid)
251
                    break
252

253

Adrien Di Mascio's avatar
Adrien Di Mascio committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267
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

268
269
270
271
272
def cw_languages():
    for fname in listdir(osp.join(WebConfiguration.i18n_lib_dir())):
        if fname.endswith('.po'):
            yield osp.splitext(fname)[0]

Adrien Di Mascio's avatar
Adrien Di Mascio committed
273
274
275

class UpdateCubicWebCatalogCommand(Command):
    """Update i18n catalogs for cubicweb library.
276

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

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


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

Adrien Di Mascio's avatar
Adrien Di Mascio committed
357
358
359
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
360
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
361
        else:
362
363
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
364
365
            cubes = [cubepath for cubepath in cubes
                     if osp.exists(osp.join(cubepath, 'i18n'))]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
366
367
        update_cubes_catalogs(cubes)

368

Adrien Di Mascio's avatar
Adrien Di Mascio committed
369
370
def update_cubes_catalogs(cubes):
    for cubedir in cubes:
371
        if not osp.isdir(cubedir):
372
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
373
            continue
374
        try:
375
            toedit = update_cube_catalogs(cubedir)
376
377
378
        except Exception:
            import traceback
            traceback.print_exc()
Sylvain Thénault's avatar
Sylvain Thénault committed
379
380
381
            print '-> error while updating catalogs for cube', cubedir
        else:
            # instructions pour la suite
382
383
384
385
386
387
            if toedit:
                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
388

389
390
def update_cube_catalogs(cubedir):
    import shutil
391
    import tempfile
392
393
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
394
    from cubicweb.i18n import extract_from_tal, execute
395
    cube = osp.basename(osp.normpath(cubedir))
396
    tempdir = tempfile.mkdtemp()
397
    print underline_title('Updating i18n catalogs for cube %s' % cube)
398
    chdir(cubedir)
399
    if osp.exists(osp.join('i18n', 'entities.pot')):
400
        warn('entities.pot is deprecated, rename file to static-messages.pot (%s)'
401
402
403
404
             % osp.join('i18n', 'entities.pot'), DeprecationWarning)
        potfiles = [osp.join('i18n', 'entities.pot')]
    elif osp.exists(osp.join('i18n', 'static-messages.pot')):
        potfiles = [osp.join('i18n', 'static-messages.pot')]
405
406
    else:
        potfiles = []
407
    print '-> extract schema messages'
408
    schemapot = osp.join(tempdir, 'schema.pot')
409
410
411
412
413
414
    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()
415
    print '-> extract TAL messages'
416
417
418
    tali18nfile = osp.join(tempdir, 'tali18n.py')
    ptfiles = find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',))
    extract_from_tal(ptfiles, tali18nfile)
419
    print '-> extract Javascript messages'
420
421
    jsfiles =  [jsfile for jsfile in find('.', '.js')
                if osp.basename(jsfile).startswith('cub')]
422
    if jsfiles:
423
424
425
        tmppotfile = osp.join(tempdir, 'js.pot')
        execute('xgettext --no-location --omit-header -k_ -L java '
                '--from-code=utf-8 -o %s %s' % (tmppotfile, ' '.join(jsfiles)))
426
        # no pot file created if there are no string to translate
427
        if osp.exists(tmppotfile):
428
            potfiles.append(tmppotfile)
429
    print '-> create cube-specific catalog'
430
    tmppotfile = osp.join(tempdir, 'generated.pot')
431
432
433
    cubefiles = find('.', '.py', blacklist=STD_BLACKLIST+('test',))
    cubefiles.append(tali18nfile)
    execute('xgettext --no-location --omit-header -k_ -o %s %s'
434
            % (tmppotfile, ' '.join('"%s"' % f for f in cubefiles)))
435
    if osp.exists(tmppotfile): # doesn't exists of no translation string found
436
        potfiles.append(tmppotfile)
437
    potfile = osp.join(tempdir, 'cube.pot')
438
    print '-> merging %i .pot files:' % len(potfiles)
439
440
    execute('msgcat -o %s %s' % (potfile,
                                 ' '.join('"%s"' % f for f in potfiles)))
441
    if not osp.exists(potfile):
442
443
444
445
        print 'no message catalog for cube', cube, 'nothing to translate'
        # cleanup
        rm(tempdir)
        return ()
446
    print '-> merging main pot file with existing translations:'
447
    chdir('i18n')
448
    toedit = []
449
    for lang in cw_languages():
450
        print '-> language', lang
451
        cubepo = '%s.po' % lang
452
        if not osp.exists(cubepo):
453
454
            shutil.copy(potfile, cubepo)
        else:
455
            execute('msgmerge -N -s -o %snew %s %s' % (cubepo, cubepo, potfile))
456
457
            ensure_fs_mode(cubepo)
            shutil.move('%snew' % cubepo, cubepo)
458
        toedit.append(osp.abspath(cubepo))
459
460
461
462
463
    # cleanup
    rm(tempdir)
    return toedit


464
465
466
467
468
469
470
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
471

472
473
474
475
#     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
476
477


478
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
479
480
481
    """Create a new cube.

    <cubename>
482
      the name of the new cube. It should be a valid python module name.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
483
484
485
    """
    name = 'newcube'
    arguments = '<cubename>'
486
    min_args = max_args = 1
487
    options = (
488
489
490
491
492
493
494
        ("layout",
         {'short': 'L', 'type' : 'choice', 'metavar': '<cube layout>',
          'default': 'simple', 'choices': ('simple', 'full'),
          'help': 'cube layout. You\'ll get a minimal cube with the "simple" \
layout, and a full featured cube with "full" layout.',
          }
         ),
495
496
497
498
499
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
500
501
502
503
504
505
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
        ("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',
          }
         ),
524
525
526
527
528
529
        ("license",
         {'short': 'l', 'type' : 'choice', 'metavar': '<license>',
          'default': 'LGPL', 'choices': ('GPL', 'LGPL', ''),
          'help': 'cube license',
          }
         ),
530
531
        )

532
    LICENSES = {
533
534
535
536
537
538
539
540
541
542
543
544
545
546
        'LGPL': '''\
# This program 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.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
''',
547

548
549
550
551
552
553
554
555
556
557
558
559
560
561
        'GPL': '''\
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 2.1 of the License, or (at your option) any later
# version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
''',
        '': '# INSERT LICENSE HERE'
562
        }
563

Adrien Di Mascio's avatar
Adrien Di Mascio committed
564
    def run(self, args):
565
        import re
566
        from logilab.common.shellutils import ASK
567
568
        cubename = args[0]
        if not re.match('[_A-Za-z][_A-Za-z0-9]*$', cubename):
569
570
            raise BadCommandUsage(
                'cube name must be a valid python module name')
571
        verbose = self.get('verbose')
572
        cubesdir = self.get('directory')
573
574
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
575
            if len(cubespath) > 1:
576
577
578
                raise BadCommandUsage(
                    "can't guess directory where to put the new cube."
                    " Please specify it using the --directory option")
579
            cubesdir = cubespath[0]
580
        if not osp.isdir(cubesdir):
581
            print "-> creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
582
            try:
583
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
584
            except OSError, err:
585
586
587
588
589
590
                self.fail("failed to create directory %r\n(%s)"
                          % (cubesdir, err))
        cubedir = osp.join(cubesdir, cubename)
        if osp.exists(cubedir):
            self.fail("%s already exists !" % cubedir)
        skeldir = osp.join(BASEDIR, 'skeleton')
591
        default_name = 'cubicweb-%s' % cubename.lower().replace('_', '-')
592
        if verbose:
593
594
            distname = raw_input('Debian name for your cube ? [%s]): '
                                 % default_name).strip()
595
            if not distname:
596
                distname = default_name
597
            elif not distname.startswith('cubicweb-'):
598
                if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
599
600
                    distname = 'cubicweb-' + distname
        else:
601
            distname = default_name
602
        if not re.match('[a-z][-a-z0-9]*$', distname):
603
604
605
606
            raise BadCommandUsage(
                'cube distname should be a valid debian package name')
        longdesc = shortdesc = raw_input(
            'Enter a short description for your cube: ')
607
        if verbose:
608
609
            longdesc = raw_input(
                'Enter a long description (leave empty to reuse the short one): ')
610
        dependencies = {'cubicweb': '>= %s' % cubicwebversion}
611
        if verbose:
612
            dependencies.update(self._ask_for_dependencies())
Adrien Di Mascio's avatar
Adrien Di Mascio committed
613
614
615
616
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
617
                   'dependencies' : dependencies,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
618
                   'version'  : cubicwebversion,
619
                   'year'  : str(datetime.now().year),
620
621
622
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
623
624
                   'license': self['license'],
                   'long-license': self.LICENSES[self['license']],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
625
                   }
626
627
628
        exclude = SKEL_EXCLUDE
        if self['layout'] == 'simple':
            exclude += ('sobjects.py*', 'precreate.py*', 'realdb_test*',
629
                        'cubes.*', 'uiprops.py*')
630
        copy_skeleton(skeldir, cubedir, context, exclude=exclude)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
631

632
    def _ask_for_dependencies(self):
633
634
        from logilab.common.shellutils import ASK
        from logilab.common.textutils import splitstrip
635
636
637
        depcubes = []
        for cube in ServerConfiguration.available_cubes():
            answer = ASK.ask("Depends on cube %s? " % cube,
638
639
                             ('N','y','skip','type'), 'N')
            if answer == 'y':
640
                depcubes.append(cube)
641
            if answer == 'type':
642
                depcubes = splitstrip(raw_input('type dependencies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
643
                break
644
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
645
                break
646
647
        return dict(('cubicweb-' + cube, ServerConfiguration.cube_version(cube))
                    for cube in depcubes)
648

649
650
651
652
653
654
655
656
657
658

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

659
660
    chances are the lines at the top are the ones that will bring the higher
    benefit after optimisation. Start there.
661
    """
662
    arguments = 'rql.log'
663
    name = 'exlog'
664
    options = ()
665

666
667
668
    def run(self, args):
        import re
        requests = {}
669
        for filepath in args:
670
            try:
671
672
673
674
                stream = file(filepath)
            except OSError, ex:
                raise BadCommandUsage("can't open rql log file %s: %s"
                                      % (filepath, ex))
675
            for lineno, line in enumerate(stream):
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
                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))
691
        stat = []
692
        for rql, times in requests.iteritems():
693
694
695
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
696
697
        stat.sort()
        stat.reverse()
698
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat) * 0.01
699
700
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
701
702
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime,
                                            cputime, occ, rql)
703

704

705
706
707
708
class GenerateSchema(Command):
    """Generate schema image for the given cube"""
    name = "schema"
    arguments = '<cube>'
709
    min_args = max_args = 1
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
    options = [
        ('output-file',
         {'type':'file', 'default': None,
          'metavar': '<file>', 'short':'o', 'help':'output image file',
          'input':False,
          }),
        ('viewer',
         {'type': 'string', 'default':None,
          'short': "d", 'metavar':'<cmd>',
          'help':'command use to view the generated file (empty for none)',
          }),
        ('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',
          }),
        ]
747
748

    def run(self, args):
749
750
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
751
        from logilab.common.textutils import splitstrip
752
753
754
        from yams import schema2dot, BASE_TYPES
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
755
        cubes = splitstrip(args[0])
756
        dev_conf = DevConfiguration(*cubes)
757
758
759
760
761
        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
762
763
764
765
766
767
768
769
770
771
        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)
772
773
774
775
        if viewer:
            p = Popen((viewer, out))
            p.wait()

776
777
778
779
780
781
782
783
784
785

class GenerateQUnitHTML(Command):
    """Generate a QUnit html file to see test in your browser"""
    name = "qunit-html"
    arguments = '<test file> [<dependancy js file>...]'

    def run(self, args):
        from cubicweb.devtools.qunit import make_qunit_html
        print make_qunit_html(args[0], args[1:])

786
787
788
789
790
791
792
793
794
for cmdcls in (UpdateCubicWebCatalogCommand,
               UpdateTemplateCatalogCommand,
               #LiveServerCommand,
               NewCubeCommand,
               ExamineLogCommand,
               GenerateSchema,
               GenerateQUnitHTML,
               ):
    CWCTL.register(cmdcls)