~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-04-28 07:24:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050428072453-7b99afa993a1e549
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/python
2
 
 
3
 
 
4
1
# Copyright (C) 2004, 2005 by Martin Pool
5
2
# Copyright (C) 2005 by Canonical Ltd
6
3
 
20
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
18
 
22
19
"""Bazaar-NG -- a free distributed version-control tool
 
20
http://bazaar-ng.org/
23
21
 
24
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
25
23
 
26
 
Current limitation include:
27
 
 
28
24
* Metadata format is not stable yet -- you may need to
29
25
  discard history in the future.
30
26
 
31
 
* No handling of subdirectories, symlinks or any non-text files.
32
 
 
33
 
* Insufficient error handling.
34
 
 
35
27
* Many commands unimplemented or partially implemented.
36
28
 
37
29
* Space-inefficient storage.
38
30
 
39
31
* No merge operators yet.
40
32
 
41
 
Interesting commands::
 
33
Interesting commands:
42
34
 
43
 
  bzr help
44
 
       Show summary help screen
 
35
  bzr help [COMMAND]
 
36
      Show help screen
45
37
  bzr version
46
 
       Show software version/licence/non-warranty.
 
38
      Show software version/licence/non-warranty.
47
39
  bzr init
48
 
       Start versioning the current directory
 
40
      Start versioning the current directory
49
41
  bzr add FILE...
50
 
       Make files versioned.
 
42
      Make files versioned.
51
43
  bzr log
52
 
       Show revision history.
53
 
  bzr diff
54
 
       Show changes from last revision to working copy.
 
44
      Show revision history.
 
45
  bzr rename FROM TO
 
46
      Rename one file.
 
47
  bzr move FROM... DESTDIR
 
48
      Move one or more files to a different directory.
 
49
  bzr diff [FILE...]
 
50
      Show changes from last revision to working copy.
55
51
  bzr commit -m 'MESSAGE'
56
 
       Store current state as new revision.
 
52
      Store current state as new revision.
57
53
  bzr export REVNO DESTINATION
58
 
       Export the branch state at a previous version.
 
54
      Export the branch state at a previous version.
59
55
  bzr status
60
 
       Show summary of pending changes.
 
56
      Show summary of pending changes.
61
57
  bzr remove FILE...
62
 
       Make a file not versioned.
 
58
      Make a file not versioned.
 
59
  bzr info
 
60
      Show statistics about this branch.
 
61
  bzr check
 
62
      Verify history is stored safely. 
 
63
  (for more type 'bzr help commands')
63
64
"""
64
65
 
65
 
# not currently working:
66
 
#  bzr info
67
 
#       Show some information about this branch.
68
 
 
69
 
 
70
 
 
71
 
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
 
__author__ = "Martin Pool <mbp@canonical.com>"
73
 
__docformat__ = "restructuredtext en"
74
 
__version__ = '0.0.0'
75
 
 
76
 
 
77
 
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
 
import traceback, socket, fnmatch, difflib
79
 
from os import path
 
66
 
 
67
 
 
68
 
 
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
80
70
from sets import Set
81
71
from pprint import pprint
82
72
from stat import *
83
73
from glob import glob
 
74
from inspect import getdoc
84
75
 
85
76
import bzrlib
86
77
from bzrlib.store import ImmutableStore
87
78
from bzrlib.trace import mutter, note, log_error
88
 
from bzrlib.errors import bailout, BzrError
 
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
89
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
82
from bzrlib.revision import Revision
118
109
## can be taken either from their parameters or their working
119
110
## directory.
120
111
 
121
 
## TODO: rename command, needed soon: check destination doesn't exist
122
 
## either in working copy or tree; move working copy; update
123
 
## inventory; write out
124
 
 
125
 
## TODO: move command; check destination is a directory and will not
126
 
## clash; move it.
127
 
 
128
 
## TODO: command to show renames, one per line, as to->from
129
 
 
 
112
 
 
113
 
 
114
cmd_aliases = {
 
115
    '?':         'help',
 
116
    'ci':        'commit',
 
117
    'checkin':   'commit',
 
118
    'di':        'diff',
 
119
    'st':        'status',
 
120
    'stat':      'status',
 
121
    }
 
122
 
 
123
 
 
124
def get_cmd_handler(cmd):
 
125
    cmd = str(cmd)
 
126
    
 
127
    cmd = cmd_aliases.get(cmd, cmd)
 
128
    
 
129
    try:
 
130
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
131
    except KeyError:
 
132
        raise BzrError("unknown command %r" % cmd)
 
133
 
 
134
    return cmd, cmd_handler
130
135
 
131
136
 
132
137
 
136
141
    For each file there is a single line giving its file state and name.
137
142
    The name is that in the current revision unless it is deleted or
138
143
    missing, in which case the old name is shown.
139
 
 
140
 
    :todo: Don't show unchanged files unless ``--all`` is given?
141
144
    """
 
145
    #import bzrlib.status
 
146
    #bzrlib.status.tree_status(Branch('.'))
142
147
    Branch('.').show_status(show_all=all)
143
148
 
144
149
 
165
170
    print Branch('.').revno()
166
171
    
167
172
 
 
173
    
168
174
def cmd_add(file_list, verbose=False):
169
 
    """Add specified files.
 
175
    """Add specified files or directories.
 
176
 
 
177
    In non-recursive mode, all the named items are added, regardless
 
178
    of whether they were previously ignored.  A warning is given if
 
179
    any of the named files are already versioned.
 
180
 
 
181
    In recursive mode (the default), files are treated the same way
 
182
    but the behaviour for directories is different.  Directories that
 
183
    are already versioned do not give a warning.  All directories,
 
184
    whether already versioned or not, are searched for files or
 
185
    subdirectories that are neither versioned or ignored, and these
 
186
    are added.  This search proceeds recursively into versioned
 
187
    directories.
 
188
 
 
189
    Therefore simply saying 'bzr add .' will version all files that
 
190
    are currently unknown.
 
191
 
 
192
    TODO: Perhaps adding a file whose directly is not versioned should
 
193
    recursively add that parent, rather than giving an error?
 
194
    """
 
195
    bzrlib.add.smart_add(file_list, verbose)
170
196
    
171
 
    Fails if the files are already added.
172
 
    """
173
 
    Branch('.').add(file_list, verbose=verbose)
 
197
 
 
198
def cmd_relpath(filename):
 
199
    """Show path of file relative to root"""
 
200
    print Branch(filename).relpath(filename)
 
201
 
174
202
 
175
203
 
176
204
def cmd_inventory(revision=None):
188
216
 
189
217
 
190
218
 
 
219
# TODO: Maybe a 'mv' command that has the combined move/rename
 
220
# special behaviour of Unix?
 
221
 
 
222
def cmd_move(source_list, dest):
 
223
    b = Branch('.')
 
224
 
 
225
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
226
 
 
227
 
 
228
 
 
229
def cmd_rename(from_name, to_name):
 
230
    """Change the name of an entry.
 
231
 
 
232
    usage: bzr rename FROM_NAME TO_NAME
 
233
 
 
234
    examples:
 
235
      bzr rename frob.c frobber.c
 
236
      bzr rename src/frob.c lib/frob.c
 
237
 
 
238
    It is an error if the destination name exists.
 
239
 
 
240
    See also the 'move' command, which moves files into a different
 
241
    directory without changing their name.
 
242
 
 
243
    TODO: Some way to rename multiple files without invoking bzr for each
 
244
    one?"""
 
245
    b = Branch('.')
 
246
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
247
    
 
248
 
 
249
 
 
250
 
 
251
def cmd_renames(dir='.'):
 
252
    """Show list of renamed files.
 
253
 
 
254
    usage: bzr renames [BRANCH]
 
255
 
 
256
    TODO: Option to show renames between two historical versions.
 
257
 
 
258
    TODO: Only show renames under dir, rather than in the whole branch.
 
259
    """
 
260
    b = Branch(dir)
 
261
    old_inv = b.basis_tree().inventory
 
262
    new_inv = b.read_working_inventory()
 
263
    
 
264
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
265
    renames.sort()
 
266
    for old_name, new_name in renames:
 
267
        print "%s => %s" % (old_name, new_name)        
 
268
 
 
269
 
 
270
 
191
271
def cmd_info():
192
 
    b = Branch('.')
193
 
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
194
 
 
195
 
    def plural(n, base='', pl=None):
196
 
        if n == 1:
197
 
            return base
198
 
        elif pl is not None:
199
 
            return pl
200
 
        else:
201
 
            return 's'
202
 
 
203
 
    count_version_dirs = 0
204
 
 
205
 
    count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
206
 
    for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
207
 
        fs = st_tup[0]
208
 
        count_status[fs] += 1
209
 
        if fs not in ['I', '?'] and st_tup[4] == 'directory':
210
 
            count_version_dirs += 1
211
 
 
212
 
    print
213
 
    print 'in the working tree:'
214
 
    for name, fs in (('unchanged', '.'),
215
 
                     ('modified', 'M'), ('added', 'A'), ('removed', 'D'),
216
 
                     ('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
217
 
                     ):
218
 
        print '  %5d %s' % (count_status[fs], name)
219
 
    print '  %5d versioned subdirector%s' % (count_version_dirs,
220
 
                                             plural(count_version_dirs, 'y', 'ies'))
221
 
 
222
 
    print
223
 
    print 'branch history:'
224
 
    history = b.revision_history()
225
 
    revno = len(history)
226
 
    print '  %5d revision%s' % (revno, plural(revno))
227
 
    committers = Set()
228
 
    for rev in history:
229
 
        committers.add(b.get_revision(rev).committer)
230
 
    print '  %5d committer%s' % (len(committers), plural(len(committers)))
231
 
    if revno > 0:
232
 
        firstrev = b.get_revision(history[0])
233
 
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
234
 
        print '  %5d day%s old' % (age, plural(age))
235
 
        print '  first revision: %s' % format_date(firstrev.timestamp,
236
 
                                                 firstrev.timezone)
237
 
 
238
 
        lastrev = b.get_revision(history[-1])
239
 
        print '  latest revision: %s' % format_date(lastrev.timestamp,
240
 
                                                    lastrev.timezone)
241
 
        
 
272
    """info: Show statistical information for this branch
 
273
 
 
274
    usage: bzr info"""
 
275
    import info
 
276
    info.show_info(Branch('.'))        
242
277
    
243
278
 
244
279
 
245
280
def cmd_remove(file_list, verbose=False):
246
 
    Branch('.').remove(file_list, verbose=verbose)
 
281
    b = Branch(file_list[0])
 
282
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
247
283
 
248
284
 
249
285
 
250
286
def cmd_file_id(filename):
251
 
    i = Branch('.').read_working_inventory().path2id(filename)
252
 
    if i is None:
253
 
        bailout("%s is not a versioned file" % filename)
 
287
    """Print file_id of a particular file or directory.
 
288
 
 
289
    usage: bzr file-id FILE
 
290
 
 
291
    The file_id is assigned when the file is first added and remains the
 
292
    same through all revisions where the file exists, even when it is
 
293
    moved or renamed.
 
294
    """
 
295
    b = Branch(filename)
 
296
    i = b.inventory.path2id(b.relpath(filename))
 
297
    if i == None:
 
298
        bailout("%r is not a versioned file" % filename)
254
299
    else:
255
300
        print i
256
301
 
257
302
 
258
 
def cmd_find_filename(fileid):
259
 
    n = find_filename(fileid)
260
 
    if n is None:
261
 
        bailout("%s is not a live file id" % fileid)
262
 
    else:
263
 
        print n
 
303
def cmd_file_id_path(filename):
 
304
    """Print path of file_ids to a file or directory.
 
305
 
 
306
    usage: bzr file-id-path FILE
 
307
 
 
308
    This prints one line for each directory down to the target,
 
309
    starting at the branch root."""
 
310
    b = Branch(filename)
 
311
    inv = b.inventory
 
312
    fid = inv.path2id(b.relpath(filename))
 
313
    if fid == None:
 
314
        bailout("%r is not a versioned file" % filename)
 
315
    for fip in inv.get_idpath(fid):
 
316
        print fip
264
317
 
265
318
 
266
319
def cmd_revision_history():
268
321
        print patchid
269
322
 
270
323
 
 
324
def cmd_directories():
 
325
    for name, ie in Branch('.').read_working_inventory().directories():
 
326
        if name == '':
 
327
            print '.'
 
328
        else:
 
329
            print name
 
330
 
 
331
 
 
332
def cmd_missing():
 
333
    for name, ie in Branch('.').working_tree().missing():
 
334
        print name
 
335
 
271
336
 
272
337
def cmd_init():
273
338
    # TODO: Check we're not already in a working directory?  At the
282
347
    Branch('.', init=True)
283
348
 
284
349
 
285
 
def cmd_diff(revision=None):
286
 
    """Show diff from basis to working copy.
287
 
 
288
 
    :todo: Take one or two revision arguments, look up those trees,
289
 
           and diff them.
290
 
 
291
 
    :todo: Allow diff across branches.
292
 
 
293
 
    :todo: Mangle filenames in diff to be more relevant.
294
 
 
295
 
    :todo: Shouldn't be in the cmd function.
296
 
    """
 
350
def cmd_diff(revision=None, file_list=None):
 
351
    """bzr diff: Show differences in working tree.
 
352
    
 
353
    usage: bzr diff [-r REV] [FILE...]
 
354
 
 
355
    --revision REV
 
356
         Show changes since REV, rather than predecessor.
 
357
 
 
358
    If files are listed, only the changes in those files are listed.
 
359
    Otherwise, all changes for the tree are listed.
 
360
 
 
361
    TODO: Given two revision arguments, show the difference between them.
 
362
 
 
363
    TODO: Allow diff across branches.
 
364
 
 
365
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
366
          or a graphical diff.
 
367
 
 
368
    TODO: Python difflib is not exactly the same as unidiff; should
 
369
          either fix it up or prefer to use an external diff.
 
370
 
 
371
    TODO: If a directory is given, diff everything under that.
 
372
 
 
373
    TODO: Selected-file diff is inefficient and doesn't show you
 
374
          deleted files.
 
375
 
 
376
    TODO: This probably handles non-Unix newlines poorly.
 
377
"""
 
378
 
 
379
    ## TODO: Shouldn't be in the cmd function.
297
380
 
298
381
    b = Branch('.')
299
382
 
303
386
        old_tree = b.revision_tree(b.lookup_revision(revision))
304
387
        
305
388
    new_tree = b.working_tree()
306
 
    old_inv = old_tree.inventory
307
 
    new_inv = new_tree.inventory
308
389
 
309
390
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
310
391
    old_label = ''
319
400
    # be usefully made into a much faster special case.
320
401
 
321
402
    # TODO: Better to return them in sorted order I think.
 
403
 
 
404
    if file_list:
 
405
        file_list = [b.relpath(f) for f in file_list]
 
406
 
 
407
    # FIXME: If given a file list, compare only those files rather
 
408
    # than comparing everything and then throwing stuff away.
322
409
    
323
410
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
324
 
        d = None
325
411
 
 
412
        if file_list and (new_name not in file_list):
 
413
            continue
 
414
        
326
415
        # Don't show this by default; maybe do it if an option is passed
327
416
        # idlabel = '      {%s}' % fid
328
417
        idlabel = ''
330
419
        # FIXME: Something about the diff format makes patch unhappy
331
420
        # with newly-added files.
332
421
 
333
 
        def diffit(*a, **kw):
334
 
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
335
 
            print
 
422
        def diffit(oldlines, newlines, **kw):
 
423
            
 
424
            # FIXME: difflib is wrong if there is no trailing newline.
 
425
            # The syntax used by patch seems to be "\ No newline at
 
426
            # end of file" following the last diff line from that
 
427
            # file.  This is not trivial to insert into the
 
428
            # unified_diff output and it might be better to just fix
 
429
            # or replace that function.
 
430
 
 
431
            # In the meantime we at least make sure the patch isn't
 
432
            # mangled.
 
433
            
 
434
 
 
435
            # Special workaround for Python2.3, where difflib fails if
 
436
            # both sequences are empty.
 
437
            if not oldlines and not newlines:
 
438
                return
 
439
 
 
440
            nonl = False
 
441
 
 
442
            if oldlines and (oldlines[-1][-1] != '\n'):
 
443
                oldlines[-1] += '\n'
 
444
                nonl = True
 
445
            if newlines and (newlines[-1][-1] != '\n'):
 
446
                newlines[-1] += '\n'
 
447
                nonl = True
 
448
 
 
449
            ud = difflib.unified_diff(oldlines, newlines, **kw)
 
450
            sys.stdout.writelines(ud)
 
451
            if nonl:
 
452
                print "\\ No newline at end of file"
 
453
            sys.stdout.write('\n')
336
454
        
337
455
        if file_state in ['.', '?', 'I']:
338
456
            continue
368
486
 
369
487
 
370
488
 
371
 
def cmd_log(timezone='original'):
 
489
def cmd_deleted(show_ids=False):
 
490
    """List files deleted in the working tree.
 
491
 
 
492
    TODO: Show files deleted since a previous revision, or between two revisions.
 
493
    """
 
494
    b = Branch('.')
 
495
    old = b.basis_tree()
 
496
    new = b.working_tree()
 
497
 
 
498
    ## TODO: Much more efficient way to do this: read in new
 
499
    ## directories with readdir, rather than stating each one.  Same
 
500
    ## level of effort but possibly much less IO.  (Or possibly not,
 
501
    ## if the directories are very large...)
 
502
 
 
503
    for path, ie in old.inventory.iter_entries():
 
504
        if not new.has_id(ie.file_id):
 
505
            if show_ids:
 
506
                print '%-50s %s' % (path, ie.file_id)
 
507
            else:
 
508
                print path
 
509
 
 
510
 
 
511
 
 
512
def cmd_parse_inventory():
 
513
    import cElementTree
 
514
    
 
515
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
516
 
 
517
 
 
518
 
 
519
def cmd_load_inventory():
 
520
    """Load inventory for timing purposes"""
 
521
    Branch('.').basis_tree().inventory
 
522
 
 
523
 
 
524
def cmd_dump_inventory():
 
525
    Branch('.').read_working_inventory().write_xml(sys.stdout)
 
526
 
 
527
 
 
528
def cmd_dump_new_inventory():
 
529
    import bzrlib.newinventory
 
530
    inv = Branch('.').basis_tree().inventory
 
531
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
532
 
 
533
 
 
534
def cmd_load_new_inventory():
 
535
    import bzrlib.newinventory
 
536
    bzrlib.newinventory.read_new_inventory(sys.stdin)
 
537
                
 
538
    
 
539
def cmd_dump_slacker_inventory():
 
540
    import bzrlib.newinventory
 
541
    inv = Branch('.').basis_tree().inventory
 
542
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
543
 
 
544
 
 
545
 
 
546
def cmd_dump_text_inventory():
 
547
    import bzrlib.textinv
 
548
    inv = Branch('.').basis_tree().inventory
 
549
    bzrlib.textinv.write_text_inventory(inv, sys.stdout)
 
550
 
 
551
 
 
552
def cmd_load_text_inventory():
 
553
    import bzrlib.textinv
 
554
    inv = bzrlib.textinv.read_text_inventory(sys.stdin)
 
555
    print 'loaded %d entries' % len(inv)
 
556
    
 
557
    
 
558
 
 
559
def cmd_root(filename=None):
 
560
    """Print the branch root."""
 
561
    print bzrlib.branch.find_branch_root(filename)
 
562
    
 
563
 
 
564
def cmd_log(timezone='original', verbose=False):
372
565
    """Show log of this branch.
373
566
 
374
 
    :todo: Options for utc; to show ids; to limit range; etc.
 
567
    TODO: Options for utc; to show ids; to limit range; etc.
375
568
    """
376
 
    Branch('.').write_log(show_timezone=timezone)
 
569
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
377
570
 
378
571
 
379
572
def cmd_ls(revision=None, verbose=False):
380
573
    """List files in a tree.
381
574
 
382
 
    :todo: Take a revision or remote path and list that tree instead.
 
575
    TODO: Take a revision or remote path and list that tree instead.
383
576
    """
384
577
    b = Branch('.')
385
578
    if revision == None:
408
601
        print quotefn(f)
409
602
 
410
603
 
 
604
 
 
605
def cmd_ignored():
 
606
    """List ignored files and the patterns that matched them.
 
607
      """
 
608
    tree = Branch('.').working_tree()
 
609
    for path, file_class, kind, file_id in tree.list_files():
 
610
        if file_class != 'I':
 
611
            continue
 
612
        ## XXX: Slightly inefficient since this was already calculated
 
613
        pat = tree.is_ignored(path)
 
614
        print '%-50s %s' % (path, pat)
 
615
 
 
616
 
411
617
def cmd_lookup_revision(revno):
412
618
    try:
413
619
        revno = int(revno)
426
632
    t = b.revision_tree(rh)
427
633
    t.export(dest)
428
634
 
 
635
def cmd_cat(revision, filename):
 
636
    """Print file to stdout."""
 
637
    b = Branch('.')
 
638
    b.print_file(b.relpath(filename), int(revision))
429
639
 
430
640
 
431
641
######################################################################
434
644
 
435
645
def cmd_uuid():
436
646
    """Print a newly-generated UUID."""
437
 
    print uuid()
 
647
    print bzrlib.osutils.uuid()
438
648
 
439
649
 
440
650
 
443
653
 
444
654
 
445
655
 
446
 
def cmd_commit(message, verbose=False):
 
656
def cmd_commit(message=None, verbose=False):
 
657
    """Commit changes to a new revision.
 
658
 
 
659
    --message MESSAGE
 
660
        Description of changes in this revision; free form text.
 
661
        It is recommended that the first line be a single-sentence
 
662
        summary.
 
663
    --verbose
 
664
        Show status of changed files,
 
665
 
 
666
    TODO: Commit only selected files.
 
667
 
 
668
    TODO: Run hooks on tree to-be-committed, and after commit.
 
669
 
 
670
    TODO: Strict commit that fails if there are unknown or deleted files.
 
671
    """
 
672
 
 
673
    if not message:
 
674
        bailout("please specify a commit message")
447
675
    Branch('.').commit(message, verbose=verbose)
448
676
 
449
677
 
450
 
def cmd_check():
451
 
    """Check consistency of the branch."""
452
 
    check()
 
678
def cmd_check(dir='.'):
 
679
    """check: Consistency check of branch history.
 
680
 
 
681
    usage: bzr check [-v] [BRANCH]
 
682
 
 
683
    options:
 
684
      --verbose, -v         Show progress of checking.
 
685
 
 
686
    This command checks various invariants about the branch storage to
 
687
    detect data corruption or bzr bugs.
 
688
    """
 
689
    import bzrlib.check
 
690
    bzrlib.check.check(Branch(dir, find_root=False))
453
691
 
454
692
 
455
693
def cmd_is(pred, *rest):
467
705
        sys.exit(1)
468
706
 
469
707
 
470
 
def cmd_username():
471
 
    print bzrlib.osutils.username()
472
 
 
473
 
 
474
 
def cmd_user_email():
475
 
    print bzrlib.osutils.user_email()
476
 
 
477
 
 
 
708
def cmd_whoami(email=False):
 
709
    """Show bzr user id.
 
710
 
 
711
    usage: bzr whoami
 
712
 
 
713
    options:
 
714
        --email             Show only the email address.
 
715
    
 
716
    """
 
717
    if email:
 
718
        print bzrlib.osutils.user_email()
 
719
    else:
 
720
        print bzrlib.osutils.username()
 
721
        
 
722
        
478
723
def cmd_gen_revision_id():
479
 
    import time
480
724
    print bzrlib.branch._gen_revision_id(time.time())
481
725
 
482
726
 
483
 
def cmd_doctest():
484
 
    """Run internal doctest suite"""
 
727
def cmd_selftest():
 
728
    """Run internal test suite"""
485
729
    ## -v, if present, is seen by doctest; the argument is just here
486
730
    ## so our parser doesn't complain
487
731
 
488
732
    ## TODO: --verbose option
 
733
 
 
734
    failures, tests = 0, 0
489
735
    
490
 
    import bzr, doctest, bzrlib.store
 
736
    import doctest, bzrlib.store, bzrlib.tests
491
737
    bzrlib.trace.verbose = False
492
 
    doctest.testmod(bzr)
493
 
    doctest.testmod(bzrlib.store)
494
 
    doctest.testmod(bzrlib.inventory)
495
 
    doctest.testmod(bzrlib.branch)
496
 
    doctest.testmod(bzrlib.osutils)
497
 
    doctest.testmod(bzrlib.tree)
498
 
 
499
 
    # more strenuous tests;
500
 
    import bzrlib.tests
501
 
    doctest.testmod(bzrlib.tests)
 
738
 
 
739
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
740
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
741
        mf, mt = doctest.testmod(m)
 
742
        failures += mf
 
743
        tests += mt
 
744
        print '%-40s %3d tests' % (m.__name__, mt),
 
745
        if mf:
 
746
            print '%3d FAILED!' % mf
 
747
        else:
 
748
            print
 
749
 
 
750
    print '%-40s %3d tests' % ('total', tests),
 
751
    if failures:
 
752
        print '%3d FAILED!' % failures
 
753
    else:
 
754
        print
 
755
 
 
756
 
 
757
 
 
758
# deprecated
 
759
cmd_doctest = cmd_selftest
502
760
 
503
761
 
504
762
######################################################################
505
763
# help
506
764
 
507
765
 
508
 
def cmd_help():
509
 
    # TODO: Specific help for particular commands
510
 
    print __doc__
 
766
def cmd_help(topic=None):
 
767
    if topic == None:
 
768
        print __doc__
 
769
    elif topic == 'commands':
 
770
        help_commands()
 
771
    else:
 
772
        # otherwise, maybe the name of a command?
 
773
        topic, cmdfn = get_cmd_handler(topic)
 
774
 
 
775
        doc = getdoc(cmdfn)
 
776
        if doc == None:
 
777
            bailout("sorry, no detailed help yet for %r" % topic)
 
778
 
 
779
        print doc
 
780
 
 
781
 
 
782
def help_commands():
 
783
    """List all commands"""
 
784
    accu = []
 
785
    for k in globals().keys():
 
786
        if k.startswith('cmd_'):
 
787
            accu.append(k[4:].replace('_','-'))
 
788
    accu.sort()
 
789
    print "bzr commands: "
 
790
    for x in accu:
 
791
        print "   " + x
 
792
    print "note: some of these commands are internal-use or obsolete"
 
793
    # TODO: Some kind of marker for internal-use commands?
 
794
    # TODO: Show aliases?
 
795
        
 
796
 
511
797
 
512
798
 
513
799
def cmd_version():
514
 
    print "bzr (bazaar-ng) %s" % __version__
515
 
    print __copyright__
 
800
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
801
    print bzrlib.__copyright__
516
802
    print "http://bazaar-ng.org/"
517
803
    print
518
804
    print \
538
824
    'all':                    None,
539
825
    'help':                   None,
540
826
    'message':                unicode,
 
827
    'profile':                None,
541
828
    'revision':               int,
542
829
    'show-ids':               None,
543
830
    'timezone':               str,
544
831
    'verbose':                None,
545
832
    'version':                None,
 
833
    'email':                  None,
546
834
    }
547
835
 
548
836
SHORT_OPTIONS = {
555
843
# listed take none.
556
844
cmd_options = {
557
845
    'add':                    ['verbose'],
 
846
    'cat':                    ['revision'],
558
847
    'commit':                 ['message', 'verbose'],
 
848
    'deleted':                ['show-ids'],
559
849
    'diff':                   ['revision'],
560
850
    'inventory':              ['revision'],
561
 
    'log':                    ['show-ids', 'timezone'],
 
851
    'log':                    ['timezone', 'verbose'],
562
852
    'ls':                     ['revision', 'verbose'],
563
853
    'remove':                 ['verbose'],
564
854
    'status':                 ['all'],
 
855
    'whoami':                 ['email'],
565
856
    }
566
857
 
567
858
 
568
859
cmd_args = {
569
 
    'init':                   [],
570
860
    'add':                    ['file+'],
 
861
    'cat':                    ['filename'],
571
862
    'commit':                 [],
572
 
    'diff':                   [],
 
863
    'diff':                   ['file*'],
 
864
    'export':                 ['revno', 'dest'],
573
865
    'file-id':                ['filename'],
 
866
    'file-id-path':           ['filename'],
574
867
    'get-file-text':          ['text_id'],
575
868
    'get-inventory':          ['inventory_id'],
576
869
    'get-revision':           ['revision_id'],
577
870
    'get-revision-inventory': ['revision_id'],
 
871
    'help':                   ['topic?'],
 
872
    'init':                   [],
578
873
    'log':                    [],
579
874
    'lookup-revision':        ['revno'],
580
 
    'export':                 ['revno', 'dest'],
 
875
    'move':                   ['source$', 'dest'],
 
876
    'relpath':                ['filename'],
581
877
    'remove':                 ['file+'],
 
878
    'rename':                 ['from_name', 'to_name'],
 
879
    'renames':                ['dir?'],
 
880
    'root':                   ['filename?'],
582
881
    'status':                 [],
583
882
    }
584
883
 
608
907
    while argv:
609
908
        a = argv.pop(0)
610
909
        if a[0] == '-':
 
910
            # option names must not be unicode
 
911
            a = str(a)
611
912
            optarg = None
612
913
            if a[1] == '-':
613
914
                mutter("  got option %r" % a)
635
936
                    else:
636
937
                        optarg = argv.pop(0)
637
938
                opts[optname] = optargfn(optarg)
638
 
                mutter("    option argument %r" % opts[optname])
639
939
            else:
640
940
                if optarg != None:
641
941
                    bailout('option %r takes no argument' % optname)
665
965
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
666
966
    # all but one.
667
967
 
 
968
    # step through args and argform, allowing appropriate 0-many matches
668
969
    for ap in argform:
669
970
        argname = ap[:-1]
670
971
        if ap[-1] == '?':
671
 
            assert 0
672
 
        elif ap[-1] == '*':
673
 
            assert 0
 
972
            if args:
 
973
                argdict[argname] = args.pop(0)
 
974
        elif ap[-1] == '*': # all remaining arguments
 
975
            if args:
 
976
                argdict[argname + '_list'] = args[:]
 
977
                args = []
 
978
            else:
 
979
                argdict[argname + '_list'] = None
674
980
        elif ap[-1] == '+':
675
981
            if not args:
676
982
                bailout("command %r needs one or more %s"
678
984
            else:
679
985
                argdict[argname + '_list'] = args[:]
680
986
                args = []
 
987
        elif ap[-1] == '$': # all but one
 
988
            if len(args) < 2:
 
989
                bailout("command %r needs one or more %s"
 
990
                        % (cmd, argname.upper()))
 
991
            argdict[argname + '_list'] = args[:-1]
 
992
            args[:-1] = []                
681
993
        else:
682
994
            # just a plain arg
683
995
            argname = ap
699
1011
    """Execute a command.
700
1012
 
701
1013
    This is similar to main(), but without all the trappings for
702
 
    logging and error handling.
 
1014
    logging and error handling.  
703
1015
    """
 
1016
 
 
1017
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1018
    
704
1019
    try:
705
1020
        args, opts = parse_args(argv[1:])
706
1021
        if 'help' in opts:
707
1022
            # TODO: pass down other arguments in case they asked for
708
1023
            # help on a command name?
709
 
            cmd_help()
 
1024
            if args:
 
1025
                cmd_help(args[0])
 
1026
            else:
 
1027
                cmd_help()
710
1028
            return 0
711
1029
        elif 'version' in opts:
712
1030
            cmd_version()
713
1031
            return 0
714
 
        cmd = args.pop(0)
 
1032
        cmd = str(args.pop(0))
715
1033
    except IndexError:
716
 
        log_error('usage: bzr COMMAND\n')
717
 
        log_error('  try "bzr help"\n')
 
1034
        log_error('usage: bzr COMMAND')
 
1035
        log_error('  try "bzr help"')
718
1036
        return 1
719
 
            
720
 
    try:
721
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
722
 
    except KeyError:
723
 
        bailout("unknown command " + `cmd`)
724
 
 
725
 
    # TODO: special --profile option to turn on the Python profiler
 
1037
 
 
1038
    canonical_cmd, cmd_handler = get_cmd_handler(cmd)
 
1039
 
 
1040
    # global option
 
1041
    if 'profile' in opts:
 
1042
        profile = True
 
1043
        del opts['profile']
 
1044
    else:
 
1045
        profile = False
726
1046
 
727
1047
    # check options are reasonable
728
 
    allowed = cmd_options.get(cmd, [])
 
1048
    allowed = cmd_options.get(canonical_cmd, [])
729
1049
    for oname in opts:
730
1050
        if oname not in allowed:
731
1051
            bailout("option %r is not allowed for command %r"
732
1052
                    % (oname, cmd))
733
1053
 
734
 
    cmdargs = _match_args(cmd, args)
735
 
    cmdargs.update(opts)
736
 
 
737
 
    ret = cmd_handler(**cmdargs) or 0
738
 
 
 
1054
    # TODO: give an error if there are any mandatory options which are
 
1055
    # not specified?  Or maybe there shouldn't be any "mandatory
 
1056
    # options" (it is an oxymoron)
 
1057
 
 
1058
    # mix arguments and options into one dictionary
 
1059
    cmdargs = _match_args(canonical_cmd, args)
 
1060
    for k, v in opts.items():
 
1061
        cmdargs[k.replace('-', '_')] = v
 
1062
 
 
1063
    if profile:
 
1064
        import hotshot
 
1065
        pffileno, pfname = tempfile.mkstemp()
 
1066
        try:
 
1067
            prof = hotshot.Profile(pfname)
 
1068
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
 
1069
            prof.close()
 
1070
 
 
1071
            import hotshot.stats
 
1072
            stats = hotshot.stats.load(pfname)
 
1073
            #stats.strip_dirs()
 
1074
            stats.sort_stats('time')
 
1075
            ## XXX: Might like to write to stderr or the trace file instead but
 
1076
            ## print_stats seems hardcoded to stdout
 
1077
            stats.print_stats(20)
 
1078
            
 
1079
            return ret
 
1080
 
 
1081
        finally:
 
1082
            os.close(pffileno)
 
1083
            os.remove(pfname)
 
1084
    else:
 
1085
        return cmd_handler(**cmdargs) or 0
 
1086
 
 
1087
 
 
1088
 
 
1089
def _report_exception(e, summary):
 
1090
    import traceback
 
1091
    log_error('bzr: ' + summary)
 
1092
    bzrlib.trace.log_exception(e)
 
1093
    tb = sys.exc_info()[2]
 
1094
    exinfo = traceback.extract_tb(tb)
 
1095
    if exinfo:
 
1096
        sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1097
    sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1098
 
 
1099
 
 
1100
def cmd_assert_fail():
 
1101
    assert False, "always fails"
739
1102
 
740
1103
 
741
1104
def main(argv):
742
 
    ## TODO: Handle command-line options; probably know what options are valid for
743
 
    ## each command
744
 
 
745
 
    ## TODO: If the arguments are wrong, give a usage message rather
746
 
    ## than just a backtrace.
 
1105
    bzrlib.trace.create_tracefile(argv)
747
1106
 
748
1107
    try:
749
 
        # TODO: Lift into separate function in trace.py
750
 
        # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
751
 
        #       Perhaps that should eventually go into the platform library?
752
 
        # TODO: If the file doesn't exist, add a note describing it.
753
 
        t = bzrlib.trace._tracefile
754
 
        t.write('-' * 60 + '\n')
755
 
        t.write('bzr invoked at %s\n' % format_date(time.time()))
756
 
        t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
757
 
        t.write('  arguments: %r\n' % argv)
758
 
 
759
 
        starttime = os.times()[4]
760
 
 
761
 
        import platform
762
 
        t.write('  platform: %s\n' % platform.platform())
763
 
        t.write('  python: %s\n' % platform.python_version())
764
 
 
765
 
        ret = run_bzr(argv)
766
 
        
767
 
        times = os.times()
768
 
        mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
769
 
               % times[:4])
770
 
        mutter("    %.3f elapsed" % (times[4] - starttime))
771
 
 
772
 
        return ret
773
 
    except BzrError, e:
774
 
        log_error('bzr: error: ' + e.args[0] + '\n')
775
 
        if len(e.args) > 1:
776
 
            for h in e.args[1]:
777
 
                log_error('  ' + h + '\n')
778
 
        return 1
779
 
    except Exception, e:
780
 
        log_error('bzr: exception: %s\n' % e)
781
 
        log_error('    see .bzr.log for details\n')
782
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
783
 
        traceback.print_exc(None, sys.stderr)
784
 
        return 1
785
 
 
786
 
    # TODO: Maybe nicer handling of IOError?
 
1108
        try:
 
1109
            ret = run_bzr(argv)
 
1110
            return ret
 
1111
        except BzrError, e:
 
1112
            _report_exception(e, 'error: ' + e.args[0])
 
1113
            if len(e.args) > 1:
 
1114
                for h in e.args[1]:
 
1115
                    # some explanation or hints
 
1116
                    log_error('  ' + h)
 
1117
            return 1
 
1118
        except AssertionError, e:
 
1119
            msg = 'assertion failed'
 
1120
            if str(e):
 
1121
                msg += ': ' + str(e)
 
1122
            _report_exception(e, msg)
 
1123
        except Exception, e:
 
1124
            _report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
 
1125
            return 1
 
1126
    finally:
 
1127
        bzrlib.trace.close_trace()
 
1128
 
 
1129
    ## TODO: Trap AssertionError
 
1130
 
 
1131
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
787
1132
 
788
1133
 
789
1134
 
790
1135
if __name__ == '__main__':
791
1136
    sys.exit(main(sys.argv))
792
 
    ##import profile
793
 
    ##profile.run('main(sys.argv)')
794