devctl.py 33.8 KB
Newer Older
1
# copyright 2003-2013 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
2
3
4
5
6
7
8
9
10
# 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, 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, ExecutionError
36
from cubicweb.cwctl import CWCTL
37
from cubicweb.cwconfig import CubicWebNoAppConfiguration
38
39
from cubicweb.toolsutils import (SKEL_EXCLUDE, Command, copy_skeleton,
                                 underline_title)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
40
41
42
from cubicweb.web.webconfig import WebConfiguration
from cubicweb.server.serverconfig import ServerConfiguration

43

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

    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
55

56
    def __init__(self, *cubes):
57
58
59
60
        super(DevConfiguration, self).__init__(cubes and cubes[0] or None)
        if cubes:
            self._cubes = self.reorder_cubes(
                self.expand_cubes(cubes, with_recommends=True))
61
            self.load_site_cubicweb()
62
63
        else:
            self._cubes = ()
64

Adrien Di Mascio's avatar
Adrien Di Mascio committed
65
66
    @property
    def apphome(self):
Sylvain Thenault's avatar
Sylvain Thenault committed
67
        return None
68
69
70
71

    def available_languages(self):
        return self.cw_languages()

Sylvain Thenault's avatar
Sylvain Thenault committed
72
73
    def main_config_file(self):
        return None
74
    def init_log(self):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
75
76
77
        pass
    def load_configuration(self):
        pass
Sylvain Thenault's avatar
Sylvain Thenault committed
78
79
80
81
82
83
84
85
86
87
88
89
90
    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
91
92
93
        if mod.__file__ is None:
            # odd/rare but real
            continue
94
        for path in config.appobjects_path():
Sylvain Thenault's avatar
Sylvain Thenault committed
95
96
97
            if mod.__file__.startswith(path):
                del sys.modules[name]
                break
98

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


124
def _generate_schema_pot(w, vreg, schema, libconfig=None):
125
    from cubicweb.i18n import add_msg
126
    from cubicweb.schema import NO_I18NCONTEXT, CONSTRAINTS
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
    afss = vreg['uicfg']['autoform_section']
134
    aiams = vreg['uicfg']['actionbox_appearsin_addmenu']
135
    if libconfig is not None:
136
137
        # processing a cube, libconfig being a config with all its dependencies
        # (cubicweb incl.)
138
        from cubicweb.cwvreg import CWRegistryStore
139
        libschema = libconfig.load_schema(remove_unused_rtypes=False)
140
        cleanup_sys_modules(libconfig)
141
        libvreg = CWRegistryStore(libconfig)
142
        libvreg.set_schema(libschema) # trigger objects registration
143
        libafss = libvreg['uicfg']['autoform_section']
144
        libaiams = libvreg['uicfg']['actionbox_appearsin_addmenu']
145
146
        # prefill vregdone set
        list(_iter_vreg_objids(libvreg, vregdone))
147
148
149
150

        def is_in_lib(rtags, eschema, rschema, role, tschema, predicate=bool):
            return any(predicate(rtag.etype_get(eschema, rschema, role, tschema))
                       for rtag in rtags)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
151
    else:
152
        # processing cubicweb itself
153
        libschema = {}
154
155
        for cstrtype in CONSTRAINTS:
            add_msg(w, cstrtype)
156
157
        libafss = libaiams = None
        is_in_lib = lambda *args: False
Adrien Di Mascio's avatar
Adrien Di Mascio committed
158
    done = set()
159
160
161
    for eschema in sorted(schema.entities()):
        if eschema.type in libschema:
            done.add(eschema.description)
162
    for eschema in sorted(schema.entities()):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
163
        etype = eschema.type
164
165
166
        if etype not in libschema:
            add_msg(w, etype)
            add_msg(w, '%s_plural' % etype)
167
            if not eschema.final:
168
                add_msg(w, 'This %s:' % etype)
169
                add_msg(w, 'New %s' % etype)
170
                add_msg(w, 'add a %s' % etype) # AddNewAction
171
172
173
174
175
                if libconfig is not None:  # processing a cube
                    # As of 3.20.3 we no longer use it, but keeping this string
                    # allows developers to run i18ncube with new cubicweb and still
                    # have the right translations at runtime for older versions
                    add_msg(w, 'This %s' % etype)
176
177
178
            if eschema.description and not eschema.description in done:
                done.add(eschema.description)
                add_msg(w, eschema.description)
179
        if eschema.final:
180
181
            continue
        for rschema, targetschemas, role in eschema.relation_definitions(True):
182
183
            if rschema.final:
                continue
184
            for tschema in targetschemas:
185

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
                for afs in afss:
                    fsections = afs.etype_get(eschema, rschema, role, tschema)
                    if 'main_inlined' in fsections and not \
                            is_in_lib(libafss, eschema, rschema, role, tschema,
                                      lambda x: 'main_inlined' in x):
                        add_msg(w, 'add a %s' % tschema,
                                'inlined:%s.%s.%s' % (etype, rschema, role))
                        add_msg(w, str(tschema),
                                'inlined:%s.%s.%s' % (etype, rschema, role))
                        break

                for aiam in aiams:
                    if aiam.etype_get(eschema, rschema, role, tschema) and not \
                            is_in_lib(libaiams, eschema, rschema, role, tschema):
                        if role == 'subject':
                            label = 'add %s %s %s %s' % (eschema, rschema,
                                                         tschema, role)
                            label2 = "creating %s (%s %%(linkto)s %s %s)" % (
                                tschema, eschema, rschema, tschema)
                        else:
                            label = 'add %s %s %s %s' % (tschema, rschema,
                                                         eschema, role)
                            label2 = "creating %s (%s %s %s %%(linkto)s)" % (
                                tschema, tschema, rschema, eschema)
                        add_msg(w, label)
                        add_msg(w, label2)
                        break
Sylvain Thénault's avatar
Sylvain Thénault committed
213
214
            # XXX also generate "creating ...' messages for actions in the
            # addrelated submenu
Adrien Di Mascio's avatar
Adrien Di Mascio committed
215
    w('# subject and object forms for each relation type\n')
216
    w('# (no object form for final or symmetric relation types)\n')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
217
    w('\n')
218
219
220
221
    for rschema in sorted(schema.relations()):
        if rschema.type in libschema:
            done.add(rschema.type)
            done.add(rschema.description)
222
    for rschema in sorted(schema.relations()):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
223
        rtype = rschema.type
224
        if rtype not in libschema:
225
226
            # bw compat, necessary until all translation of relation are done
            # properly...
227
            add_msg(w, rtype)
228
            done.add(rtype)
229
230
            if rschema.description and rschema.description not in done:
                add_msg(w, rschema.description)
231
            done.add(rschema.description)
232
233
234
            librschema = None
        else:
            librschema = libschema.rschema(rtype)
235
        # add context information only for non-metadata rtypes
236
        if rschema not in NO_I18NCONTEXT:
237
            libsubjects = librschema and librschema.subjects() or ()
238
            for subjschema in rschema.subjects():
239
240
                if not subjschema in libsubjects:
                    add_msg(w, rtype, subjschema.type)
241
        if not (rschema.final or rschema.symmetric):
242
            if rschema not in NO_I18NCONTEXT:
243
244
245
246
247
                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:
248
249
                # bw compat, necessary until all translation of relation are
                # done properly...
250
                add_msg(w, '%s_object' % rtype)
251
252
253
254
255
256
257
258
        for rdef in rschema.rdefs.itervalues():
            if not rdef.description or rdef.description in done:
                continue
            if (librschema is None or
                (rdef.subject, rdef.object) not in librschema.rdefs or
                librschema.rdefs[(rdef.subject, rdef.object)].description != rdef.description):
                add_msg(w, rdef.description)
            done.add(rdef.description)
259
    for objid in _iter_vreg_objids(vreg, vregdone):
260
261
262
        add_msg(w, '%s_description' % objid)
        add_msg(w, objid)

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

264
def _iter_vreg_objids(vreg, done):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
265
    for reg, objdict in vreg.items():
266
267
        if reg in ('boxes', 'contentnavigation'):
            continue
268
        for objects in objdict.itervalues():
Adrien Di Mascio's avatar
Adrien Di Mascio committed
269
            for obj in objects:
Sylvain Thénault's avatar
Sylvain Thénault committed
270
                objid = '%s_%s' % (reg, obj.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
271
                if objid in done:
272
                    break
273
                pdefs = getattr(obj, 'cw_property_defs', {})
Sylvain Thénault's avatar
Sylvain Thénault committed
274
                if pdefs:
275
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
276
                    done.add(objid)
277
                    break
278

279

Adrien Di Mascio's avatar
Adrien Di Mascio committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
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.
297

Adrien Di Mascio's avatar
Adrien Di Mascio committed
298
299
300
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
301
    name = 'i18ncubicweb'
302
    min_args = max_args = 0
Adrien Di Mascio's avatar
Adrien Di Mascio committed
303
304
305
306

    def run(self, args):
        """run the command with its specific arguments"""
        import shutil
307
        import tempfile
Adrien Di Mascio's avatar
Adrien Di Mascio committed
308
309
        import yams
        from logilab.common.fileutils import ensure_fs_mode
310
        from logilab.common.shellutils import globfind, find, rm
311
        from logilab.common.modutils import get_module_files
312
        from cubicweb.i18n import extract_from_tal, execute2
313
        tempdir = tempfile.mkdtemp(prefix='cw-')
314
        cwi18ndir = WebConfiguration.i18n_lib_dir()
315
316
        print '-> extract messages:',
        print 'schema',
317
318
        schemapot = osp.join(tempdir, 'schema.pot')
        potfiles = [schemapot]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
319
320
321
322
323
324
        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()
325
        print 'TAL',
326
327
328
        tali18nfile = osp.join(tempdir, 'tali18n.py')
        extract_from_tal(find(osp.join(BASEDIR, 'web'), ('.py', '.pt')),
                         tali18nfile)
329
        print '-> generate .pot files.'
330
331
332
333
334
335
        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
336
337
                                ('yams', get_module_files(yams.__path__[0]), None),
                                ('tal', [tali18nfile], None),
338
                                ('js', jsfiles, 'java'),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
339
                                ]:
340
            potfile = osp.join(tempdir, '%s.pot' % id)
341
342
343
344
345
346
            cmd = ['xgettext', '--no-location', '--omit-header', '-k_']
            if lang is not None:
                cmd.extend(['-L', lang])
            cmd.extend(['-o', potfile])
            cmd.extend(files)
            execute2(cmd)
347
            if osp.exists(potfile):
348
349
                potfiles.append(potfile)
            else:
350
351
                print '-> WARNING: %s file was not generated' % potfile
        print '-> merging %i .pot files' % len(potfiles)
352
        cubicwebpot = osp.join(tempdir, 'cubicweb.pot')
353
354
        cmd = ['msgcat', '-o', cubicwebpot] + potfiles
        execute2(cmd)
355
        print '-> merging main pot file with existing translations.'
356
        chdir(cwi18ndir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
357
        toedit = []
358
        for lang in CubicWebNoAppConfiguration.cw_languages():
Adrien Di Mascio's avatar
Adrien Di Mascio committed
359
            target = '%s.po' % lang
360
361
362
            cmd = ['msgmerge', '-N', '--sort-output', '-o',
                   target+'new', target, cubicwebpot]
            execute2(cmd)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
363
364
            ensure_fs_mode(target)
            shutil.move('%snew' % target, target)
365
            toedit.append(osp.abspath(target))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
366
        # cleanup
367
        rm(tempdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
368
        # instructions pour la suite
369
370
        print '-> regenerated CubicWeb\'s .po catalogs.'
        print '\nYou can now edit the following files:'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
371
        print '* ' + '\n* '.join(toedit)
372
        print 'when you are done, run "cubicweb-ctl i18ncube yourcube".'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
373
374


375
class UpdateCubeCatalogCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
376
377
378
    """Update i18n catalogs for cubes. If no cube is specified, update
    catalogs of all registered cubes.
    """
379
    name = 'i18ncube'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
380
    arguments = '[<cube>...]'
381

Adrien Di Mascio's avatar
Adrien Di Mascio committed
382
383
384
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
385
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
386
        else:
387
388
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
389
390
            cubes = [cubepath for cubepath in cubes
                     if osp.exists(osp.join(cubepath, 'i18n'))]
391
392
        if not update_cubes_catalogs(cubes):
            raise ExecutionError("update cubes i18n catalog failed")
Adrien Di Mascio's avatar
Adrien Di Mascio committed
393

394

Adrien Di Mascio's avatar
Adrien Di Mascio committed
395
def update_cubes_catalogs(cubes):
396
    from subprocess import CalledProcessError
Adrien Di Mascio's avatar
Adrien Di Mascio committed
397
    for cubedir in cubes:
398
        if not osp.isdir(cubedir):
399
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
400
            continue
401
        try:
402
            toedit = update_cube_catalogs(cubedir)
403
        except CalledProcessError as exc:
404
405
406
            print '\n*** error while updating catalogs for cube', cubedir
            print 'cmd:\n%s' % exc.cmd
            print 'stdout:\n%s\nstderr:\n%s' % exc.data
407
408
409
        except Exception:
            import traceback
            traceback.print_exc()
410
            print '*** error while updating catalogs for cube', cubedir
411
            return False
Sylvain Thénault's avatar
Sylvain Thénault committed
412
413
        else:
            # instructions pour la suite
414
415
416
417
418
419
            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.')
420
            return True
Adrien Di Mascio's avatar
Adrien Di Mascio committed
421

422
423
def update_cube_catalogs(cubedir):
    import shutil
424
    import tempfile
425
426
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
427
    from cubicweb.i18n import extract_from_tal, execute2
428
    cube = osp.basename(osp.normpath(cubedir))
429
    tempdir = tempfile.mkdtemp()
430
    print underline_title('Updating i18n catalogs for cube %s' % cube)
431
    chdir(cubedir)
432
    if osp.exists(osp.join('i18n', 'entities.pot')):
433
        warn('entities.pot is deprecated, rename file to static-messages.pot (%s)'
434
435
436
437
             % 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')]
438
439
    else:
        potfiles = []
440
441
    print '-> extracting messages:',
    print 'schema',
442
    schemapot = osp.join(tempdir, 'schema.pot')
443
444
445
446
447
448
    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()
449
    print 'TAL',
450
451
452
    tali18nfile = osp.join(tempdir, 'tali18n.py')
    ptfiles = find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',))
    extract_from_tal(ptfiles, tali18nfile)
453
    print 'Javascript'
454
455
    jsfiles =  [jsfile for jsfile in find('.', '.js')
                if osp.basename(jsfile).startswith('cub')]
456
    if jsfiles:
457
        tmppotfile = osp.join(tempdir, 'js.pot')
458
459
460
        cmd = ['xgettext', '--no-location', '--omit-header', '-k_', '-L', 'java',
               '--from-code=utf-8', '-o', tmppotfile] + jsfiles
        execute2(cmd)
461
        # no pot file created if there are no string to translate
462
        if osp.exists(tmppotfile):
463
            potfiles.append(tmppotfile)
464
    print '-> creating cube-specific catalog'
465
    tmppotfile = osp.join(tempdir, 'generated.pot')
466
467
    cubefiles = find('.', '.py', blacklist=STD_BLACKLIST+('test',))
    cubefiles.append(tali18nfile)
468
469
470
    cmd = ['xgettext', '--no-location', '--omit-header', '-k_', '-o', tmppotfile]
    cmd.extend(cubefiles)
    execute2(cmd)
471
    if osp.exists(tmppotfile): # doesn't exists of no translation string found
472
        potfiles.append(tmppotfile)
473
    potfile = osp.join(tempdir, 'cube.pot')
474
475
476
477
    print '-> merging %i .pot files' % len(potfiles)
    cmd = ['msgcat', '-o', potfile]
    cmd.extend(potfiles)
    execute2(cmd)
478
    if not osp.exists(potfile):
479
480
481
482
        print 'no message catalog for cube', cube, 'nothing to translate'
        # cleanup
        rm(tempdir)
        return ()
483
    print '-> merging main pot file with existing translations:',
484
    chdir('i18n')
485
    toedit = []
486
    for lang in CubicWebNoAppConfiguration.cw_languages():
487
        print lang,
488
        cubepo = '%s.po' % lang
489
        if not osp.exists(cubepo):
490
491
            shutil.copy(potfile, cubepo)
        else:
492
493
            cmd = ['msgmerge','-N','-s','-o', cubepo+'new', cubepo, potfile]
            execute2(cmd)
494
495
            ensure_fs_mode(cubepo)
            shutil.move('%snew' % cubepo, cubepo)
496
        toedit.append(osp.abspath(cubepo))
497
    print
498
499
500
501
502
    # cleanup
    rm(tempdir)
    return toedit


503
504
505
506
507
508
509
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
510

511
512
513
514
#     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
515
516


517
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
518
519
520
    """Create a new cube.

    <cubename>
521
      the name of the new cube. It should be a valid python module name.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
522
523
524
    """
    name = 'newcube'
    arguments = '<cubename>'
525
    min_args = max_args = 1
526
    options = (
527
528
529
530
531
532
533
        ("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.',
          }
         ),
534
535
536
537
538
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
539
540
541
542
543
544
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
        ("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',
          }
         ),
563
564
565
566
567
568
        ("license",
         {'short': 'l', 'type' : 'choice', 'metavar': '<license>',
          'default': 'LGPL', 'choices': ('GPL', 'LGPL', ''),
          'help': 'cube license',
          }
         ),
569
570
        )

571
    LICENSES = {
572
573
574
575
576
577
578
579
580
581
582
        '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.
#
583
584
# 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/>.
585
''',
586

587
588
589
590
591
592
593
594
        '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
595
596
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
597
598
599
600
601
#
# 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'
602
        }
603

Adrien Di Mascio's avatar
Adrien Di Mascio committed
604
    def run(self, args):
605
        import re
606
        from logilab.common.shellutils import ASK
607
608
        cubename = args[0]
        if not re.match('[_A-Za-z][_A-Za-z0-9]*$', cubename):
609
610
            raise BadCommandUsage(
                'cube name must be a valid python module name')
611
        verbose = self.get('verbose')
612
        cubesdir = self.get('directory')
613
614
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
615
            if len(cubespath) > 1:
616
617
618
                raise BadCommandUsage(
                    "can't guess directory where to put the new cube."
                    " Please specify it using the --directory option")
619
            cubesdir = cubespath[0]
620
        if not osp.isdir(cubesdir):
621
            print "-> creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
622
            try:
623
                mkdir(cubesdir)
624
            except OSError as err:
625
626
627
628
                self.fail("failed to create directory %r\n(%s)"
                          % (cubesdir, err))
        cubedir = osp.join(cubesdir, cubename)
        if osp.exists(cubedir):
Dimitri Papadopoulos's avatar
Dimitri Papadopoulos committed
629
            self.fail("%s already exists!" % cubedir)
630
        skeldir = osp.join(BASEDIR, 'skeleton')
631
        default_name = 'cubicweb-%s' % cubename.lower().replace('_', '-')
632
        if verbose:
633
634
            distname = raw_input('Debian name for your cube ? [%s]): '
                                 % default_name).strip()
635
            if not distname:
636
                distname = default_name
637
            elif not distname.startswith('cubicweb-'):
638
                if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
639
640
                    distname = 'cubicweb-' + distname
        else:
641
            distname = default_name
642
        if not re.match('[a-z][-a-z0-9]*$', distname):
643
644
645
646
            raise BadCommandUsage(
                'cube distname should be a valid debian package name')
        longdesc = shortdesc = raw_input(
            'Enter a short description for your cube: ')
647
        if verbose:
648
649
            longdesc = raw_input(
                'Enter a long description (leave empty to reuse the short one): ')
650
        dependencies = {'cubicweb': '>= %s' % cubicwebversion}
651
        if verbose:
652
            dependencies.update(self._ask_for_dependencies())
Adrien Di Mascio's avatar
Adrien Di Mascio committed
653
654
655
656
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
657
                   'dependencies' : dependencies,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
658
                   'version'  : cubicwebversion,
659
                   'year'  : str(datetime.now().year),
660
661
662
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
663
664
                   'license': self['license'],
                   'long-license': self.LICENSES[self['license']],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
665
                   }
666
667
668
        exclude = SKEL_EXCLUDE
        if self['layout'] == 'simple':
            exclude += ('sobjects.py*', 'precreate.py*', 'realdb_test*',
669
                        'cubes.*', 'uiprops.py*')
670
        copy_skeleton(skeldir, cubedir, context, exclude=exclude)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
671

672
    def _ask_for_dependencies(self):
673
674
        from logilab.common.shellutils import ASK
        from logilab.common.textutils import splitstrip
675
676
677
        depcubes = []
        for cube in ServerConfiguration.available_cubes():
            answer = ASK.ask("Depends on cube %s? " % cube,
678
679
                             ('N','y','skip','type'), 'N')
            if answer == 'y':
680
                depcubes.append(cube)
681
            if answer == 'type':
682
                depcubes = splitstrip(raw_input('type dependencies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
683
                break
684
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
685
                break
686
687
        return dict(('cubicweb-' + cube, ServerConfiguration.cube_version(cube))
                    for cube in depcubes)
688

689
690
691
692

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

693
    Will print out the following table
694

695
      Percentage; Cumulative Time (clock); Cumulative Time (CPU); Occurences; Query
696

697
    sorted by descending cumulative time (clock). Time are expressed in seconds.
698

699
    Chances are the lines at the top are the ones that will bring the higher
700
    benefit after optimisation. Start there.
701
    """
702
    arguments = 'rql.log'
703
    name = 'exlog'
704
    options = ()
705

706
707
708
    def run(self, args):
        import re
        requests = {}
709
        for filepath in args:
710
            try:
711
                stream = file(filepath)
712
            except OSError as ex:
713
714
                raise BadCommandUsage("can't open rql log file %s: %s"
                                      % (filepath, ex))
715
            for lineno, line in enumerate(stream):
716
717
718
719
720
721
722
723
724
725
726
727
728
                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) )
729
                except Exception as exc:
730
                    sys.stderr.write('Line %s: %s (%s)\n' % (lineno, exc, line))
731
        stat = []
732
        for rql, times in requests.iteritems():
733
734
735
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
736
737
        stat.sort()
        stat.reverse()
738
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat) * 0.01
739
740
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
741
742
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime,
                                            cputime, occ, rql)
743

744

745
746
747
748
class GenerateSchema(Command):
    """Generate schema image for the given cube"""
    name = "schema"
    arguments = '<cube>'
749
    min_args = max_args = 1
750
751
    options = [
        ('output-file',
752
         {'type':'string', 'default': None,
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
          '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',
          }),
786
787
788
789
790
        ('show-etype',
         {'type':'string', 'default':'',
          'metavar': '<etype>',
          'help':'show graph of this etype and its neighbours'
          }),
791
        ]
792
793

    def run(self, args):
794
795
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
796
        from logilab.common.textutils import splitstrip
797
798
        from logilab.common.graph import GraphGenerator, DotBackend
        from yams import schema2dot as s2d, BASE_TYPES
799
800
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
801
        cubes = splitstrip(args[0])
802
        dev_conf = DevConfiguration(*cubes)
803
804
805
806
807
        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
808
809
810
811
812
813
814
815
816
        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(','))
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832

        if not self['show-etype']:
            s2d.schema2dot(schema, out, skiptypes=skiptypes)
        else:
            etype = self['show-etype']
            visitor = s2d.OneHopESchemaVisitor(schema[etype], skiptypes=skiptypes)
            propshdlr = s2d.SchemaDotPropsHandler(visitor)
            backend = DotBackend('schema', 'BT',
                                 ratio='compress',size=None,
                                 renderer='dot',
                                 additionnal_param={'overlap' : 'false',
                                                    'splines' : 'true',
                                                    'sep' : '0.2'})
            generator = s2d.GraphGenerator(backend)
            generator.generate(visitor, propshdlr, out)

833
834
835
836
        if viewer:
            p = Popen((viewer, out))
            p.wait()

837
838
839
840
841
842
843
844
845
846

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:])

847
for cmdcls in (UpdateCubicWebCatalogCommand,
848
               UpdateCubeCatalogCommand,
849
850
851
852
853
854
855
               #LiveServerCommand,
               NewCubeCommand,
               ExamineLogCommand,
               GenerateSchema,
               GenerateQUnitHTML,
               ):
    CWCTL.register(cmdcls)