devctl.py 32.7 KB
Newer Older
1
# copyright 2003-2012 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
50
51
52
53
54
    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
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
134
    afss = vreg['uicfg']['autoform_section']
    appearsin_addmenus = vreg['uicfg']['actionbox_appearsin_addmenu']
135
    if libconfig is not None:
136
        from cubicweb.cwvreg import CWRegistryStore
137
        libschema = libconfig.load_schema(remove_unused_rtypes=False)
138
        cleanup_sys_modules(libconfig)
139
        libvreg = CWRegistryStore(libconfig)
140
        libvreg.set_schema(libschema) # trigger objects registration
141
142
        libafss = libvreg['uicfg']['autoform_section']
        libappearsin_addmenus = libvreg['uicfg']['actionbox_appearsin_addmenu']
143
144
        # prefill vregdone set
        list(_iter_vreg_objids(libvreg, vregdone))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
145
    else:
146
        libschema = {}
147
148
        for cstrtype in CONSTRAINTS:
            add_msg(w, cstrtype)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
149
    done = set()
150
151
152
    for eschema in sorted(schema.entities()):
        if eschema.type in libschema:
            done.add(eschema.description)
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
                for afs in afss:
                    fsections = afs.etype_get(eschema, rschema, role, tschema)
                    for libafs in libafss:
                        if 'main_inlined' in fsections and \
                               (libconfig is None or not
                                'main_inlined' in libafs.etype_get(
                                    eschema, rschema, role, tschema)):
                            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))

                def isinlib(eschema, rschema, role, tschema):
                    if libconfig is not None:
                        for libappearsin_addmenu in libappearsin_addmenus:
                            if (libappearsin_addmenu.etype_get(
                                    eschema, rschema, role, tschema)):
                                if eschema in libschema and tschema in libschema:
                                    return True
                    return False

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

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

257
def _iter_vreg_objids(vreg, done):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
258
    for reg, objdict in vreg.items():
259
260
        if reg in ('boxes', 'contentnavigation'):
            continue
261
        for objects in objdict.itervalues():
Adrien Di Mascio's avatar
Adrien Di Mascio committed
262
            for obj in objects:
Sylvain Thénault's avatar
Sylvain Thénault committed
263
                objid = '%s_%s' % (reg, obj.__regid__)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
264
                if objid in done:
265
                    break
266
                pdefs = getattr(obj, 'cw_property_defs', {})
Sylvain Thénault's avatar
Sylvain Thénault committed
267
                if pdefs:
268
                    yield objid
Adrien Di Mascio's avatar
Adrien Di Mascio committed
269
                    done.add(objid)
270
                    break
271

272

Adrien Di Mascio's avatar
Adrien Di Mascio committed
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
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.
290

Adrien Di Mascio's avatar
Adrien Di Mascio committed
291
292
293
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
294
    name = 'i18ncubicweb'
295
    min_args = max_args = 0
Adrien Di Mascio's avatar
Adrien Di Mascio committed
296
297
298
299

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


368
class UpdateCubeCatalogCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
369
370
371
    """Update i18n catalogs for cubes. If no cube is specified, update
    catalogs of all registered cubes.
    """
372
    name = 'i18ncube'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
373
    arguments = '[<cube>...]'
374

Adrien Di Mascio's avatar
Adrien Di Mascio committed
375
376
377
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
378
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
379
        else:
380
381
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
382
383
            cubes = [cubepath for cubepath in cubes
                     if osp.exists(osp.join(cubepath, 'i18n'))]
384
385
        if not update_cubes_catalogs(cubes):
            raise ExecutionError("update cubes i18n catalog failed")
Adrien Di Mascio's avatar
Adrien Di Mascio committed
386

387

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

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


496
497
498
499
500
501
502
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
503

504
505
506
507
#     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
508
509


510
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
511
512
513
    """Create a new cube.

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

564
    LICENSES = {
565
566
567
568
569
570
571
572
573
574
575
576
577
578
        '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/>.
''',
579

580
581
582
583
584
585
586
587
588
589
590
591
592
593
        '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'
594
        }
595

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

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

681
682
683
684

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

685
    Will print out the following table
686

687
      Percentage; Cumulative Time (clock); Cumulative Time (CPU); Occurences; Query
688

689
    sorted by descending cumulative time (clock). Time are expressed in seconds.
690

691
    Chances are the lines at the top are the ones that will bring the higher
692
    benefit after optimisation. Start there.
693
    """
694
    arguments = 'rql.log'
695
    name = 'exlog'
696
    options = ()
697

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

736

737
738
739
740
class GenerateSchema(Command):
    """Generate schema image for the given cube"""
    name = "schema"
    arguments = '<cube>'
741
    min_args = max_args = 1
742
743
    options = [
        ('output-file',
744
         {'type':'string', 'default': None,
745
746
747
748
749
750
751
752
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
          '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',
          }),
        ]
779
780

    def run(self, args):
781
782
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
783
        from logilab.common.textutils import splitstrip
784
785
786
        from yams import schema2dot, BASE_TYPES
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
787
        cubes = splitstrip(args[0])
788
        dev_conf = DevConfiguration(*cubes)
789
790
791
792
793
        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
794
795
796
797
798
799
800
801
802
803
        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)
804
805
806
807
        if viewer:
            p = Popen((viewer, out))
            p.wait()

808
809
810
811
812
813
814
815
816
817

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

818
for cmdcls in (UpdateCubicWebCatalogCommand,
819
               UpdateCubeCatalogCommand,
820
821
822
823
824
825
826
               #LiveServerCommand,
               NewCubeCommand,
               ExamineLogCommand,
               GenerateSchema,
               GenerateQUnitHTML,
               ):
    CWCTL.register(cmdcls)