devctl.py 30.2 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/>.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
18
19
20
21
22
23
"""additional cubicweb-ctl commands and command handlers for cubicweb and cubicweb's
cubes development

"""
__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
Adrien Di Mascio's avatar
Adrien Di Mascio committed
30
from os.path import join, exists, abspath, basename, normpath, split, isdir
31
from warnings import warn
Adrien Di Mascio's avatar
Adrien Di Mascio committed
32
33

from logilab.common import STD_BLACKLIST
34
35
from logilab.common.clcommands import register_commands, pop_arg

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

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

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

246

247
LANGS = ('en', 'fr', 'es')
Adrien Di Mascio's avatar
Adrien Di Mascio committed
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
I18NDIR = join(BASEDIR, 'i18n')
DEFAULT_POT_HEAD = r'''msgid ""
msgstr ""
"Project-Id-Version: cubicweb %s\n"
"PO-Revision-Date: 2008-03-28 18:14+0100\n"
"Last-Translator: Logilab Team <contact@logilab.fr>\n"
"Language-Team: fr <contact@logilab.fr>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: cubicweb-devtools\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

''' % cubicwebversion


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

Adrien Di Mascio's avatar
Adrien Di Mascio committed
267
268
269
    It will regenerate cubicweb/i18n/xx.po files. You'll have then to edit those
    files to add translations of newly added messages.
    """
270
    name = 'i18ncubicweb'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
271
272
273
274
275
276

    def run(self, args):
        """run the command with its specific arguments"""
        if args:
            raise BadCommandUsage('Too much arguments')
        import shutil
277
        import tempfile
Adrien Di Mascio's avatar
Adrien Di Mascio committed
278
279
        import yams
        from logilab.common.fileutils import ensure_fs_mode
280
        from logilab.common.shellutils import globfind, find, rm
281
        from logilab.common.modutils import get_module_files
282
        from cubicweb.i18n import extract_from_tal, execute
283
        tempdir = tempfile.mkdtemp()
284
        potfiles = [join(I18NDIR, 'static-messages.pot')]
285
        print '-> extract schema messages.'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
286
287
288
289
290
291
292
        schemapot = join(tempdir, 'schema.pot')
        potfiles.append(schemapot)
        # explicit close necessary else the file may not be yet flushed when
        # we'll using it below
        schemapotstream = file(schemapot, 'w')
        generate_schema_pot(schemapotstream.write, cubedir=None)
        schemapotstream.close()
293
        print '-> extract TAL messages.'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
294
295
        tali18nfile = join(tempdir, 'tali18n.py')
        extract_from_tal(find(join(BASEDIR, 'web'), ('.py', '.pt')), tali18nfile)
296
        print '-> generate .pot files.'
297
        for id, files, lang in [('pycubicweb', get_module_files(BASEDIR) + list(globfind(join(BASEDIR, 'misc', 'migration'), '*.py')), None),
298
                                ('schemadescr', globfind(join(BASEDIR, 'schemas'), '*.py'), None),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
299
300
                                ('yams', get_module_files(yams.__path__[0]), None),
                                ('tal', [tali18nfile], None),
301
                                ('js', globfind(join(BASEDIR, 'web'), 'cub*.js'), 'java'),
Adrien Di Mascio's avatar
Adrien Di Mascio committed
302
                                ]:
303
            cmd = 'xgettext --no-location --omit-header -k_ -o %s %s'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
304
305
            if lang is not None:
                cmd += ' -L %s' % lang
306
            potfile = join(tempdir, '%s.pot' % id)
307
            execute(cmd % (potfile, ' '.join('"%s"' % f for f in files)))
308
309
310
            if exists(potfile):
                potfiles.append(potfile)
            else:
311
312
                print '-> WARNING: %s file was not generated' % potfile
        print '-> merging %i .pot files' % len(potfiles)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
313
        cubicwebpot = join(tempdir, 'cubicweb.pot')
314
        execute('msgcat -o %s %s' % (cubicwebpot, ' '.join('"%s"' % f for f in potfiles)))
315
        print '-> merging main pot file with existing translations.'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
316
317
318
319
        chdir(I18NDIR)
        toedit = []
        for lang in LANGS:
            target = '%s.po' % lang
320
            execute('msgmerge -N --sort-output -o "%snew" "%s" "%s"' % (target, target, cubicwebpot))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
321
322
323
324
            ensure_fs_mode(target)
            shutil.move('%snew' % target, target)
            toedit.append(abspath(target))
        # cleanup
325
        rm(tempdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
326
        # instructions pour la suite
327
328
        print '-> regenerated CubicWeb\'s .po catalogs.'
        print '\nYou can now edit the following files:'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
329
        print '* ' + '\n* '.join(toedit)
330
        print 'when you are done, run "cubicweb-ctl i18ncube yourcube".'
Adrien Di Mascio's avatar
Adrien Di Mascio committed
331
332
333
334
335
336


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

Adrien Di Mascio's avatar
Adrien Di Mascio committed
340
341
342
    def run(self, args):
        """run the command with its specific arguments"""
        if args:
343
            cubes = [DevConfiguration.cube_dir(cube) for cube in args]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
344
        else:
345
346
            cubes = [DevConfiguration.cube_dir(cube)
                     for cube in DevConfiguration.available_cubes()]
347
            cubes = [cubepath for cubepath in cubes if exists(join(cubepath, 'i18n'))]
Adrien Di Mascio's avatar
Adrien Di Mascio committed
348
349
        update_cubes_catalogs(cubes)

350

Adrien Di Mascio's avatar
Adrien Di Mascio committed
351
352
def update_cubes_catalogs(cubes):
    for cubedir in cubes:
Sylvain Thénault's avatar
Sylvain Thénault committed
353
        toedit = []
Adrien Di Mascio's avatar
Adrien Di Mascio committed
354
        if not isdir(cubedir):
355
            print '-> ignoring %s that is not a directory.' % cubedir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
356
            continue
357
358
359
360
361
        try:
            toedit += update_cube_catalogs(cubedir)
        except Exception:
            import traceback
            traceback.print_exc()
Sylvain Thénault's avatar
Sylvain Thénault committed
362
363
364
365
366
367
368
369
            print '-> error while updating catalogs for cube', cubedir
        else:
            # instructions pour la suite
            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
370

371
372
def update_cube_catalogs(cubedir):
    import shutil
373
    import tempfile
374
375
    from logilab.common.fileutils import ensure_fs_mode
    from logilab.common.shellutils import find, rm
376
    from cubicweb.i18n import extract_from_tal, execute
377
378
    toedit = []
    cube = basename(normpath(cubedir))
379
    tempdir = tempfile.mkdtemp()
380
    print underline_title('Updating i18n catalogs for cube %s' % cube)
381
    chdir(cubedir)
382
383
384
385
386
387
388
389
    if exists(join('i18n', 'entities.pot')):
        warn('entities.pot is deprecated, rename file to static-messages.pot (%s)'
             % join('i18n', 'entities.pot'), DeprecationWarning)
        potfiles = [join('i18n', 'entities.pot')]
    elif exists(join('i18n', 'static-messages.pot')):
        potfiles = [join('i18n', 'static-messages.pot')]
    else:
        potfiles = []
390
    print '-> extract schema messages'
391
392
393
394
395
396
397
    schemapot = join(tempdir, 'schema.pot')
    potfiles.append(schemapot)
    # explicit close necessary else the file may not be yet flushed when
    # we'll using it below
    schemapotstream = file(schemapot, 'w')
    generate_schema_pot(schemapotstream.write, cubedir)
    schemapotstream.close()
398
    print '-> extract TAL messages'
399
400
    tali18nfile = join(tempdir, 'tali18n.py')
    extract_from_tal(find('.', ('.py', '.pt'), blacklist=STD_BLACKLIST+('test',)), tali18nfile)
401
    print '-> extract Javascript messages'
402
403
404
405
406
407
408
409
    jsfiles =  [jsfile for jsfile in find('.', '.js') if basename(jsfile).startswith('cub')]
    if jsfiles:
        tmppotfile = join(tempdir, 'js.pot')
        execute('xgettext --no-location --omit-header -k_ -L java --from-code=utf-8 -o %s %s'
                % (tmppotfile, ' '.join(jsfiles)))
        # no pot file created if there are no string to translate
        if exists(tmppotfile):
            potfiles.append(tmppotfile)
410
    print '-> create cube-specific catalog'
411
412
413
414
    tmppotfile = join(tempdir, 'generated.pot')
    cubefiles = find('.', '.py', blacklist=STD_BLACKLIST+('test',))
    cubefiles.append(tali18nfile)
    execute('xgettext --no-location --omit-header -k_ -o %s %s'
415
            % (tmppotfile, ' '.join('"%s"' % f for f in cubefiles)))
416
417
418
    if exists(tmppotfile): # doesn't exists of no translation string found
        potfiles.append(tmppotfile)
    potfile = join(tempdir, 'cube.pot')
419
    print '-> merging %i .pot files:' % len(potfiles)
420
421
    execute('msgcat -o %s %s' % (potfile,
                                 ' '.join('"%s"' % f for f in potfiles)))
422
    print '-> merging main pot file with existing translations:'
423
424
    chdir('i18n')
    for lang in LANGS:
425
        print '-> language', lang
426
427
428
429
        cubepo = '%s.po' % lang
        if not exists(cubepo):
            shutil.copy(potfile, cubepo)
        else:
430
            execute('msgmerge -N -s -o %snew %s %s' % (cubepo, cubepo, potfile))
431
432
433
434
435
436
437
438
            ensure_fs_mode(cubepo)
            shutil.move('%snew' % cubepo, cubepo)
        toedit.append(abspath(cubepo))
    # cleanup
    rm(tempdir)
    return toedit


439
440
441
442
443
444
445
# XXX totally broken, fix it
# class LiveServerCommand(Command):
#     """Run a server from within a cube directory.
#     """
#     name = 'live-server'
#     arguments = ''
#     options = ()
446

447
448
449
450
#     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
451
452


453
class NewCubeCommand(Command):
Adrien Di Mascio's avatar
Adrien Di Mascio committed
454
455
456
    """Create a new cube.

    <cubename>
457
      the name of the new cube. It should be a valid python module name.
Adrien Di Mascio's avatar
Adrien Di Mascio committed
458
459
460
461
    """
    name = 'newcube'
    arguments = '<cubename>'

462
    options = (
463
464
465
466
467
468
469
        ("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.',
          }
         ),
470
471
472
473
474
        ("directory",
         {'short': 'd', 'type' : 'string', 'metavar': '<cubes directory>',
          'help': 'directory where the new cube should be created',
          }
         ),
475
476
477
478
479
480
        ("verbose",
         {'short': 'v', 'type' : 'yn', 'metavar': '<verbose>',
          'default': 'n',
          'help': 'verbose mode: will ask all possible configuration questions',
          }
         ),
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
        ("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',
          }
         ),
499
500
501
502
503
504
        ("license",
         {'short': 'l', 'type' : 'choice', 'metavar': '<license>',
          'default': 'LGPL', 'choices': ('GPL', 'LGPL', ''),
          'help': 'cube license',
          }
         ),
505
506
        )

507
    LICENSES = {
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
        '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/>.
''',
        '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'
536
        }
537

Adrien Di Mascio's avatar
Adrien Di Mascio committed
538
    def run(self, args):
539
        import re
540
        from logilab.common.shellutils import ASK
Adrien Di Mascio's avatar
Adrien Di Mascio committed
541
542
        if len(args) != 1:
            raise BadCommandUsage("exactly one argument (cube name) is expected")
543
544
545
        cubename = args[0]
        if not re.match('[_A-Za-z][_A-Za-z0-9]*$', cubename):
            raise BadCommandUsage("cube name should be a valid python module name")
546
        verbose = self.get('verbose')
547
        cubesdir = self.get('directory')
548
549
        if not cubesdir:
            cubespath = ServerConfiguration.cubes_search_path()
550
551
552
553
554
            if len(cubespath) > 1:
                raise BadCommandUsage("can't guess directory where to put the new cube."
                                      " Please specify it using the --directory option")
            cubesdir = cubespath[0]
        if not isdir(cubesdir):
555
            print "-> creating cubes directory", cubesdir
Adrien Di Mascio's avatar
Adrien Di Mascio committed
556
            try:
557
                mkdir(cubesdir)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
558
            except OSError, err:
559
                self.fail("failed to create directory %r\n(%s)" % (cubesdir, err))
560
        cubedir = join(cubesdir, cubename)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
561
562
563
        if exists(cubedir):
            self.fail("%s already exists !" % (cubedir))
        skeldir = join(BASEDIR, 'skeleton')
564
        default_name = 'cubicweb-%s' % cubename.lower().replace('_', '-')
565
        if verbose:
566
            distname = raw_input('Debian name for your cube ? [%s]): ' % default_name).strip()
567
            if not distname:
568
                distname = default_name
569
            elif not distname.startswith('cubicweb-'):
570
                if ASK.confirm('Do you mean cubicweb-%s ?' % distname):
571
572
                    distname = 'cubicweb-' + distname
        else:
573
            distname = default_name
574
575
        if not re.match('[a-z][-a-z0-9]*$', distname):
            raise BadCommandUsage("cube distname should be a valid debian package name")
576
577
        longdesc = shortdesc = raw_input('Enter a short description for your cube: ')
        if verbose:
578
            longdesc = raw_input('Enter a long description (leave empty to reuse the short one): ')
579
        dependencies = {'cubicweb': '>= %s' % cubicwebversion}
580
        if verbose:
581
            dependencies.update(self._ask_for_dependencies())
Adrien Di Mascio's avatar
Adrien Di Mascio committed
582
583
584
585
        context = {'cubename' : cubename,
                   'distname' : distname,
                   'shortdesc' : shortdesc,
                   'longdesc' : longdesc or shortdesc,
586
                   'dependencies' : dependencies,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
587
                   'version'  : cubicwebversion,
588
                   'year'  : str(datetime.now().year),
589
590
591
                   'author': self['author'],
                   'author-email': self['author-email'],
                   'author-web-site': self['author-web-site'],
592
593
                   'license': self['license'],
                   'long-license': self.LICENSES[self['license']],
Adrien Di Mascio's avatar
Adrien Di Mascio committed
594
                   }
595
596
597
598
599
        exclude = SKEL_EXCLUDE
        if self['layout'] == 'simple':
            exclude += ('sobjects.py*', 'precreate.py*', 'realdb_test*',
                        'cubes.*', 'external_resources*')
        copy_skeleton(skeldir, cubedir, context, exclude=exclude)
Adrien Di Mascio's avatar
Adrien Di Mascio committed
600

601
    def _ask_for_dependencies(self):
602
603
        from logilab.common.shellutils import ASK
        from logilab.common.textutils import splitstrip
604
605
606
        depcubes = []
        for cube in ServerConfiguration.available_cubes():
            answer = ASK.ask("Depends on cube %s? " % cube,
607
608
                             ('N','y','skip','type'), 'N')
            if answer == 'y':
609
                depcubes.append(cube)
610
            if answer == 'type':
611
                depcubes = splitstrip(raw_input('type dependencies: '))
Adrien Di Mascio's avatar
Adrien Di Mascio committed
612
                break
613
            elif answer == 'skip':
Adrien Di Mascio's avatar
Adrien Di Mascio committed
614
                break
615
616
        return dict(('cubicweb-' + cube, ServerConfiguration.cube_version(cube))
                    for cube in depcubes)
617

618
619
620
621
622
623
624
625
626
627

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

628
629
    chances are the lines at the top are the ones that will bring the higher
    benefit after optimisation. Start there.
630
    """
631
    arguments = 'rql.log'
632
633
634
    name = 'exlog'
    options = (
        )
635

636
637
638
    def run(self, args):
        import re
        requests = {}
639
        for filepath in args:
640
            try:
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
                stream = file(filepath)
            except OSError, ex:
                raise BadCommandUsage("can't open rql log file %s: %s"
                                      % (filepath, ex))
            for lineno, line in enumerate(file):
                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))
661
        stat = []
662
        for rql, times in requests.iteritems():
663
664
665
            stat.append( (sum(time[0] for time in times),
                          sum(time[1] for time in times),
                          len(times), rql) )
666
667
        stat.sort()
        stat.reverse()
668
        total_time = sum(clocktime for clocktime, cputime, occ, rql in stat) * 0.01
669
670
        print 'Percentage;Cumulative Time (clock);Cumulative Time (CPU);Occurences;Query'
        for clocktime, cputime, occ, rql in stat:
671
672
            print '%.2f;%.2f;%.2f;%s;%s' % (clocktime/total_time, clocktime,
                                            cputime, occ, rql)
673

674

675
676
677
678
679
680
681
682
class GenerateSchema(Command):
    """Generate schema image for the given cube"""
    name = "schema"
    arguments = '<cube>'
    options = [('output-file', {'type':'file', 'default': None,
                 'metavar': '<file>', 'short':'o', 'help':'output image file',
                 'input':False}),
               ('viewer', {'type': 'string', 'default':None,
683
                'short': "d", 'metavar':'<cmd>',
684
685
                 'help':'command use to view the generated file (empty for none)'}
               ),
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
               ('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'}
               ),
706
707
708
              ]

    def run(self, args):
709
710
        from subprocess import Popen
        from tempfile import NamedTemporaryFile
711
        from logilab.common.textutils import splitstrip
712
713
714
        from yams import schema2dot, BASE_TYPES
        from cubicweb.schema import (META_RTYPES, SCHEMA_TYPES, SYSTEM_RTYPES,
                                     WORKFLOW_TYPES, INTERNAL_TYPES)
715
        cubes = splitstrip(pop_arg(args, 1))
716
        dev_conf = DevConfiguration(*cubes)
717
718
719
720
721
        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
722
723
724
725
726
727
728
729
730
731
        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)
732
733
734
735
        if viewer:
            p = Popen((viewer, out))
            p.wait()

Adrien Di Mascio's avatar
Adrien Di Mascio committed
736
737
register_commands((UpdateCubicWebCatalogCommand,
                   UpdateTemplateCatalogCommand,
738
                   #LiveServerCommand,
739
                   NewCubeCommand,
740
                   ExamineLogCommand,
741
                   GenerateSchema,
Adrien Di Mascio's avatar
Adrien Di Mascio committed
742
                   ))