~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-09-01 09:17:38 UTC
  • Revision ID: mbp@sourcefrog.net-20050901091738-5aafcae38c6c945c
- change Command infrastructure to use (mostly stateless) objects to
  represent commands; rather cleaner particularly for representing
  external commands

- clean up the way --profile is done

- various other bzrlib.commands and .help cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Martin Pool
2
 
# Copyright (C) 2005 by Canonical Ltd
3
 
 
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
4
2
 
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
 
"""Bazaar-NG -- a free distributed version-control tool
20
 
http://bazaar-ng.org/
21
 
 
22
 
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
 
 
24
 
* Metadata format is not stable yet -- you may need to
25
 
  discard history in the future.
26
 
 
27
 
* Many commands unimplemented or partially implemented.
28
 
 
29
 
* Space-inefficient storage.
30
 
 
31
 
* No merge operators yet.
32
 
 
33
 
Interesting commands:
34
 
 
35
 
  bzr help [COMMAND]
36
 
      Show help screen
37
 
  bzr version
38
 
      Show software version/licence/non-warranty.
39
 
  bzr init
40
 
      Start versioning the current directory
41
 
  bzr add FILE...
42
 
      Make files versioned.
43
 
  bzr log
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.
51
 
  bzr commit -m 'MESSAGE'
52
 
      Store current state as new revision.
53
 
  bzr export REVNO DESTINATION
54
 
      Export the branch state at a previous version.
55
 
  bzr status
56
 
      Show summary of pending changes.
57
 
  bzr remove FILE...
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')
64
 
"""
65
 
 
66
 
 
67
 
 
68
 
 
69
 
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
70
 
from sets import Set
71
 
from pprint import pprint
72
 
from stat import *
73
 
from glob import glob
 
17
 
 
18
# TODO: probably should say which arguments are candidates for glob
 
19
# expansion on windows and do that at the command level.
 
20
 
 
21
# TODO: Help messages for options.
 
22
 
 
23
# TODO: Define arguments by objects, rather than just using names.
 
24
# Those objects can specify the expected type of the argument, which
 
25
# would help with validation and shell completion.
 
26
 
 
27
 
 
28
 
 
29
import sys
 
30
import os
 
31
from warnings import warn
74
32
from inspect import getdoc
75
33
 
76
34
import bzrlib
77
 
from bzrlib.store import ImmutableStore
78
 
from bzrlib.trace import mutter, note, log_error
79
 
from bzrlib.errors import bailout, BzrError, BzrCheckError
80
 
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
 
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
 
from bzrlib.revision import Revision
83
 
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
84
 
     format_date
85
 
 
86
 
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
87
 
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
88
 
 
89
 
## standard representation
90
 
NONE_STRING = '(none)'
91
 
EMPTY = 'empty'
92
 
 
93
 
 
94
 
## TODO: Perhaps a different version of inventory commands that
95
 
## returns iterators...
96
 
 
97
 
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
98
 
 
99
 
## TODO: Some kind of locking on branches.  Perhaps there should be a
100
 
## parameter to the branch object saying whether we want a read or
101
 
## write lock; release it from destructor.  Perhaps don't even need a
102
 
## read lock to look at immutable objects?
103
 
 
104
 
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
 
## to compare output?
106
 
 
107
 
## TODO: Some kind of global code to generate the right Branch object
108
 
## to work on.  Almost, but not quite all, commands need one, and it
109
 
## can be taken either from their parameters or their working
110
 
## directory.
111
 
 
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
135
 
 
136
 
 
137
 
 
138
 
def cmd_status(all=False):
139
 
    """Display status summary.
140
 
 
141
 
    For each file there is a single line giving its file state and name.
142
 
    The name is that in the current revision unless it is deleted or
143
 
    missing, in which case the old name is shown.
144
 
    """
145
 
    #import bzrlib.status
146
 
    #bzrlib.status.tree_status(Branch('.'))
147
 
    Branch('.').show_status(show_all=all)
148
 
 
149
 
 
150
 
 
151
 
######################################################################
152
 
# examining history
153
 
def cmd_get_revision(revision_id):
154
 
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
155
 
 
156
 
 
157
 
def cmd_get_file_text(text_id):
158
 
    """Get contents of a file by hash."""
159
 
    sf = Branch('.').text_store[text_id]
160
 
    pumpfile(sf, sys.stdout)
161
 
 
162
 
 
163
 
 
164
 
######################################################################
165
 
# commands
166
 
    
167
 
 
168
 
def cmd_revno():
169
 
    """Show number of revisions on this branch"""
170
 
    print Branch('.').revno()
171
 
    
172
 
 
173
 
    
174
 
def cmd_add(file_list, verbose=False):
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)
196
 
    
197
 
 
198
 
def cmd_relpath(filename):
199
 
    """Show path of file relative to root"""
200
 
    print Branch(filename).relpath(filename)
201
 
 
202
 
 
203
 
 
204
 
def cmd_inventory(revision=None):
205
 
    """Show inventory of the current working copy."""
206
 
    ## TODO: Also optionally show a previous inventory
207
 
    ## TODO: Format options
208
 
    b = Branch('.')
209
 
    if revision == None:
210
 
        inv = b.read_working_inventory()
211
 
    else:
212
 
        inv = b.get_revision_inventory(b.lookup_revision(revision))
213
 
        
214
 
    for path, entry in inv.iter_entries():
215
 
        print '%-50s %s' % (entry.file_id, path)
216
 
 
217
 
 
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
 
 
271
 
def cmd_info():
272
 
    """info: Show statistical information for this branch
273
 
 
274
 
    usage: bzr info"""
275
 
    import info
276
 
    info.show_info(Branch('.'))        
277
 
    
278
 
 
279
 
 
280
 
def cmd_remove(file_list, verbose=False):
281
 
    b = Branch(file_list[0])
282
 
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
283
 
 
284
 
 
285
 
 
286
 
def cmd_file_id(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)
299
 
    else:
300
 
        print i
301
 
 
302
 
 
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
317
 
 
318
 
 
319
 
def cmd_revision_history():
320
 
    for patchid in Branch('.').revision_history():
321
 
        print patchid
322
 
 
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
 
 
336
 
 
337
 
def cmd_init():
338
 
    # TODO: Check we're not already in a working directory?  At the
339
 
    # moment you'll get an ugly error.
340
 
    
341
 
    # TODO: What if we're in a subdirectory of a branch?  Would like
342
 
    # to allow that, but then the parent may need to understand that
343
 
    # the children have disappeared, or should they be versioned in
344
 
    # both?
345
 
 
346
 
    # TODO: Take an argument/option for branch name.
347
 
    Branch('.', init=True)
348
 
 
349
 
 
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.
380
 
 
381
 
    b = Branch('.')
382
 
 
383
 
    if revision == None:
384
 
        old_tree = b.basis_tree()
385
 
    else:
386
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
387
 
        
388
 
    new_tree = b.working_tree()
389
 
 
390
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
391
 
    old_label = ''
392
 
    new_label = ''
393
 
 
394
 
    DEVNULL = '/dev/null'
395
 
    # Windows users, don't panic about this filename -- it is a
396
 
    # special signal to GNU patch that the file should be created or
397
 
    # deleted respectively.
398
 
 
399
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
400
 
    # be usefully made into a much faster special case.
401
 
 
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.
409
 
    
410
 
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
411
 
 
412
 
        if file_list and (new_name not in file_list):
413
 
            continue
414
 
        
415
 
        # Don't show this by default; maybe do it if an option is passed
416
 
        # idlabel = '      {%s}' % fid
417
 
        idlabel = ''
418
 
 
419
 
        # FIXME: Something about the diff format makes patch unhappy
420
 
        # with newly-added files.
421
 
 
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')
454
 
        
455
 
        if file_state in ['.', '?', 'I']:
456
 
            continue
457
 
        elif file_state == 'A':
458
 
            print '*** added %s %r' % (kind, new_name)
459
 
            if kind == 'file':
460
 
                diffit([],
461
 
                       new_tree.get_file(fid).readlines(),
462
 
                       fromfile=DEVNULL,
463
 
                       tofile=new_label + new_name + idlabel)
464
 
        elif file_state == 'D':
465
 
            assert isinstance(old_name, types.StringTypes)
466
 
            print '*** deleted %s %r' % (kind, old_name)
467
 
            if kind == 'file':
468
 
                diffit(old_tree.get_file(fid).readlines(), [],
469
 
                       fromfile=old_label + old_name + idlabel,
470
 
                       tofile=DEVNULL)
471
 
        elif file_state in ['M', 'R']:
472
 
            if file_state == 'M':
473
 
                assert kind == 'file'
474
 
                assert old_name == new_name
475
 
                print '*** modified %s %r' % (kind, new_name)
476
 
            elif file_state == 'R':
477
 
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
478
 
 
479
 
            if kind == 'file':
480
 
                diffit(old_tree.get_file(fid).readlines(),
481
 
                       new_tree.get_file(fid).readlines(),
482
 
                       fromfile=old_label + old_name + idlabel,
483
 
                       tofile=new_label + new_name)
484
 
        else:
485
 
            bailout("can't represent state %s {%s}" % (file_state, fid))
486
 
 
487
 
 
488
 
 
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):
565
 
    """Show log of this branch.
566
 
 
567
 
    TODO: Options for utc; to show ids; to limit range; etc.
568
 
    """
569
 
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
570
 
 
571
 
 
572
 
def cmd_ls(revision=None, verbose=False):
573
 
    """List files in a tree.
574
 
 
575
 
    TODO: Take a revision or remote path and list that tree instead.
576
 
    """
577
 
    b = Branch('.')
578
 
    if revision == None:
579
 
        tree = b.working_tree()
580
 
    else:
581
 
        tree = b.revision_tree(b.lookup_revision(revision))
582
 
        
583
 
    for fp, fc, kind, fid in tree.list_files():
584
 
        if verbose:
585
 
            if kind == 'directory':
586
 
                kindch = '/'
587
 
            elif kind == 'file':
588
 
                kindch = ''
589
 
            else:
590
 
                kindch = '???'
591
 
                
592
 
            print '%-8s %s%s' % (fc, fp, kindch)
593
 
        else:
594
 
            print fp
595
 
    
596
 
    
597
 
 
598
 
def cmd_unknowns():
599
 
    """List unknown files"""
600
 
    for f in Branch('.').unknowns():
601
 
        print quotefn(f)
602
 
 
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
 
 
617
 
def cmd_lookup_revision(revno):
618
 
    try:
619
 
        revno = int(revno)
620
 
    except ValueError:
621
 
        bailout("usage: lookup-revision REVNO",
622
 
                ["REVNO is a non-negative revision number for this branch"])
623
 
 
624
 
    print Branch('.').lookup_revision(revno) or NONE_STRING
625
 
 
626
 
 
627
 
 
628
 
def cmd_export(revno, dest):
629
 
    """Export past revision to destination directory."""
630
 
    b = Branch('.')
631
 
    rh = b.lookup_revision(int(revno))
632
 
    t = b.revision_tree(rh)
633
 
    t.export(dest)
634
 
 
635
 
def cmd_cat(revision, filename):
636
 
    """Print file to stdout."""
637
 
    b = Branch('.')
638
 
    b.print_file(b.relpath(filename), int(revision))
639
 
 
640
 
 
641
 
######################################################################
642
 
# internal/test commands
643
 
 
644
 
 
645
 
def cmd_uuid():
646
 
    """Print a newly-generated UUID."""
647
 
    print bzrlib.osutils.uuid()
648
 
 
649
 
 
650
 
 
651
 
def cmd_local_time_offset():
652
 
    print bzrlib.osutils.local_time_offset()
653
 
 
654
 
 
655
 
 
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")
675
 
    Branch('.').commit(message, verbose=verbose)
676
 
 
677
 
 
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))
691
 
 
692
 
 
693
 
def cmd_is(pred, *rest):
694
 
    """Test whether PREDICATE is true."""
695
 
    try:
696
 
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
697
 
    except KeyError:
698
 
        bailout("unknown predicate: %s" % quotefn(pred))
699
 
        
700
 
    try:
701
 
        cmd_handler(*rest)
702
 
    except BzrCheckError:
703
 
        # by default we don't print the message so that this can
704
 
        # be used from shell scripts without producing noise
705
 
        sys.exit(1)
706
 
 
707
 
 
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
 
        
723
 
def cmd_gen_revision_id():
724
 
    print bzrlib.branch._gen_revision_id(time.time())
725
 
 
726
 
 
727
 
def cmd_selftest():
728
 
    """Run internal test suite"""
729
 
    ## -v, if present, is seen by doctest; the argument is just here
730
 
    ## so our parser doesn't complain
731
 
 
732
 
    ## TODO: --verbose option
733
 
 
734
 
    failures, tests = 0, 0
735
 
    
736
 
    import doctest, bzrlib.store, bzrlib.tests
737
 
    bzrlib.trace.verbose = False
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
760
 
 
761
 
 
762
 
######################################################################
763
 
# help
764
 
 
765
 
 
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
 
 
797
 
 
798
 
 
799
 
def cmd_version():
800
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
801
 
    print bzrlib.__copyright__
802
 
    print "http://bazaar-ng.org/"
803
 
    print
804
 
    print \
805
 
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
806
 
you may use, modify and redistribute it under the terms of the GNU 
807
 
General Public License version 2 or later."""
808
 
 
809
 
 
810
 
def cmd_rocks():
811
 
    """Statement of optimism."""
812
 
    print "it sure does!"
813
 
 
814
 
 
815
 
 
816
 
######################################################################
817
 
# main routine
 
35
import bzrlib.trace
 
36
from bzrlib.trace import mutter, note, log_error, warning
 
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
 
38
from bzrlib.branch import find_branch
 
39
from bzrlib import BZRDIR
 
40
 
 
41
 
 
42
plugin_cmds = {}
 
43
 
 
44
 
 
45
def register_command(cmd):
 
46
    "Utility function to help register a command"
 
47
    global plugin_cmds
 
48
    k = cmd.__name__
 
49
    if k.startswith("cmd_"):
 
50
        k_unsquished = _unsquish_command_name(k)
 
51
    else:
 
52
        k_unsquished = k
 
53
    if not plugin_cmds.has_key(k_unsquished):
 
54
        plugin_cmds[k_unsquished] = cmd
 
55
        mutter('registered plugin command %s', k_unsquished)      
 
56
    else:
 
57
        log_error('Two plugins defined the same command: %r' % k)
 
58
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
59
 
 
60
 
 
61
def _squish_command_name(cmd):
 
62
    return 'cmd_' + cmd.replace('-', '_')
 
63
 
 
64
 
 
65
def _unsquish_command_name(cmd):
 
66
    assert cmd.startswith("cmd_")
 
67
    return cmd[4:].replace('_','-')
 
68
 
 
69
 
 
70
def _parse_revision_str(revstr):
 
71
    """This handles a revision string -> revno.
 
72
 
 
73
    This always returns a list.  The list will have one element for 
 
74
 
 
75
    It supports integers directly, but everything else it
 
76
    defers for passing to Branch.get_revision_info()
 
77
 
 
78
    >>> _parse_revision_str('234')
 
79
    [234]
 
80
    >>> _parse_revision_str('234..567')
 
81
    [234, 567]
 
82
    >>> _parse_revision_str('..')
 
83
    [None, None]
 
84
    >>> _parse_revision_str('..234')
 
85
    [None, 234]
 
86
    >>> _parse_revision_str('234..')
 
87
    [234, None]
 
88
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
 
89
    [234, 456, 789]
 
90
    >>> _parse_revision_str('234....789') # Error?
 
91
    [234, None, 789]
 
92
    >>> _parse_revision_str('revid:test@other.com-234234')
 
93
    ['revid:test@other.com-234234']
 
94
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
 
95
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
 
96
    >>> _parse_revision_str('revid:test@other.com-234234..23')
 
97
    ['revid:test@other.com-234234', 23]
 
98
    >>> _parse_revision_str('date:2005-04-12')
 
99
    ['date:2005-04-12']
 
100
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
 
101
    ['date:2005-04-12 12:24:33']
 
102
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
 
103
    ['date:2005-04-12T12:24:33']
 
104
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
 
105
    ['date:2005-04-12,12:24:33']
 
106
    >>> _parse_revision_str('-5..23')
 
107
    [-5, 23]
 
108
    >>> _parse_revision_str('-5')
 
109
    [-5]
 
110
    >>> _parse_revision_str('123a')
 
111
    ['123a']
 
112
    >>> _parse_revision_str('abc')
 
113
    ['abc']
 
114
    """
 
115
    import re
 
116
    old_format_re = re.compile('\d*:\d*')
 
117
    m = old_format_re.match(revstr)
 
118
    if m:
 
119
        warning('Colon separator for revision numbers is deprecated.'
 
120
                ' Use .. instead')
 
121
        revs = []
 
122
        for rev in revstr.split(':'):
 
123
            if rev:
 
124
                revs.append(int(rev))
 
125
            else:
 
126
                revs.append(None)
 
127
        return revs
 
128
    revs = []
 
129
    for x in revstr.split('..'):
 
130
        if not x:
 
131
            revs.append(None)
 
132
        else:
 
133
            try:
 
134
                revs.append(int(x))
 
135
            except ValueError:
 
136
                revs.append(x)
 
137
    return revs
 
138
 
 
139
 
 
140
def get_merge_type(typestring):
 
141
    """Attempt to find the merge class/factory associated with a string."""
 
142
    from merge import merge_types
 
143
    try:
 
144
        return merge_types[typestring][0]
 
145
    except KeyError:
 
146
        templ = '%s%%7s: %%s' % (' '*12)
 
147
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
148
        type_list = '\n'.join(lines)
 
149
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
150
            (typestring, type_list)
 
151
        raise BzrCommandError(msg)
 
152
    
 
153
 
 
154
def get_merge_type(typestring):
 
155
    """Attempt to find the merge class/factory associated with a string."""
 
156
    from merge import merge_types
 
157
    try:
 
158
        return merge_types[typestring][0]
 
159
    except KeyError:
 
160
        templ = '%s%%7s: %%s' % (' '*12)
 
161
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
162
        type_list = '\n'.join(lines)
 
163
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
164
            (typestring, type_list)
 
165
        raise BzrCommandError(msg)
 
166
 
 
167
 
 
168
def _builtin_commands():
 
169
    import bzrlib.builtins
 
170
    r = {}
 
171
    builtins = bzrlib.builtins.__dict__
 
172
    for name in builtins:
 
173
        if name.startswith("cmd_"):
 
174
            real_name = _unsquish_command_name(name)        
 
175
            r[real_name] = builtins[name]
 
176
    return r
 
177
 
 
178
            
 
179
 
 
180
def builtin_command_names():
 
181
    """Return list of builtin command names."""
 
182
    return _builtin_commands().keys()
 
183
    
 
184
 
 
185
def plugin_command_names():
 
186
    return plugin_cmds.keys()
 
187
 
 
188
 
 
189
def _get_cmd_dict(plugins_override=True):
 
190
    """Return name->class mapping for all commands."""
 
191
    d = _builtin_commands()
 
192
    if plugins_override:
 
193
        d.update(plugin_cmds)
 
194
    return d
 
195
 
 
196
    
 
197
def get_all_cmds(plugins_override=True):
 
198
    """Return canonical name and class for all registered commands."""
 
199
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
200
        yield k,v
 
201
 
 
202
 
 
203
def get_cmd_object(cmd_name, plugins_override=True):
 
204
    """Return the canonical name and command class for a command.
 
205
 
 
206
    plugins_override
 
207
        If true, plugin commands can override builtins.
 
208
    """
 
209
    cmd_name = str(cmd_name)            # not unicode
 
210
 
 
211
    # first look up this command under the specified name
 
212
    cmds = _get_cmd_dict(plugins_override=plugins_override)
 
213
    try:
 
214
        return cmds[cmd_name]()
 
215
    except KeyError:
 
216
        pass
 
217
 
 
218
    # look for any command which claims this as an alias
 
219
    for real_cmd_name, cmd_class in cmds.iteritems():
 
220
        if cmd_name in cmd_class.aliases:
 
221
            return cmd_class()
 
222
 
 
223
    cmd_obj = ExternalCommand.find_command(cmd_name)
 
224
    if cmd_obj:
 
225
        return cmd_obj
 
226
 
 
227
    raise BzrCommandError("unknown command %r" % cmd_name)
 
228
 
 
229
 
 
230
class Command(object):
 
231
    """Base class for commands.
 
232
 
 
233
    Commands are the heart of the command-line bzr interface.
 
234
 
 
235
    The command object mostly handles the mapping of command-line
 
236
    parameters into one or more bzrlib operations, and of the results
 
237
    into textual output.
 
238
 
 
239
    Commands normally don't have any state.  All their arguments are
 
240
    passed in to the run method.  (Subclasses may take a different
 
241
    policy if the behaviour of the instance needs to depend on e.g. a
 
242
    shell plugin and not just its Python class.)
 
243
 
 
244
    The docstring for an actual command should give a single-line
 
245
    summary, then a complete description of the command.  A grammar
 
246
    description will be inserted.
 
247
 
 
248
    aliases
 
249
        Other accepted names for this command.
 
250
 
 
251
    takes_args
 
252
        List of argument forms, marked with whether they are optional,
 
253
        repeated, etc.
 
254
 
 
255
    takes_options
 
256
        List of options that may be given for this command.
 
257
 
 
258
    hidden
 
259
        If true, this command isn't advertised.  This is typically
 
260
        for commands intended for expert users.
 
261
    """
 
262
    aliases = []
 
263
    
 
264
    takes_args = []
 
265
    takes_options = []
 
266
 
 
267
    hidden = False
 
268
    
 
269
    def __init__(self):
 
270
        """Construct an instance of this command."""
 
271
        if self.__doc__ == Command.__doc__:
 
272
            warn("No help message set for %r" % self)
 
273
 
 
274
    
 
275
    def run(self):
 
276
        """Actually run the command.
 
277
 
 
278
        This is invoked with the options and arguments bound to
 
279
        keyword parameters.
 
280
 
 
281
        Return 0 or None if the command was successful, or a non-zero
 
282
        shell error code if not.  It's OK for this method to allow
 
283
        an exception to raise up.
 
284
        """
 
285
        raise NotImplementedError()
 
286
 
 
287
 
 
288
    def help(self):
 
289
        """Return help message for this class."""
 
290
        if self.__doc__ is Command.__doc__:
 
291
            return None
 
292
        return getdoc(self)
 
293
 
 
294
    def name(self):
 
295
        return _unsquish_command_name(self.__class__.__name__)
 
296
 
 
297
 
 
298
class ExternalCommand(Command):
 
299
    """Class to wrap external commands.
 
300
 
 
301
    We cheat a little here, when get_cmd_class() calls us we actually
 
302
    give it back an object we construct that has the appropriate path,
 
303
    help, options etc for the specified command.
 
304
 
 
305
    When run_bzr() tries to instantiate that 'class' it gets caught by
 
306
    the __call__ method, which we override to call the Command.__init__
 
307
    method. That then calls our run method which is pretty straight
 
308
    forward.
 
309
 
 
310
    The only wrinkle is that we have to map bzr's dictionary of options
 
311
    and arguments back into command line options and arguments for the
 
312
    script.
 
313
    """
 
314
 
 
315
    def find_command(cls, cmd):
 
316
        import os.path
 
317
        bzrpath = os.environ.get('BZRPATH', '')
 
318
 
 
319
        for dir in bzrpath.split(os.pathsep):
 
320
            path = os.path.join(dir, cmd)
 
321
            if os.path.isfile(path):
 
322
                return ExternalCommand(path)
 
323
 
 
324
        return None
 
325
 
 
326
    find_command = classmethod(find_command)
 
327
 
 
328
    def __init__(self, path):
 
329
        self.path = path
 
330
 
 
331
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
332
        self.takes_options = pipe.readline().split()
 
333
 
 
334
        for opt in self.takes_options:
 
335
            if not opt in OPTIONS:
 
336
                raise BzrError("Unknown option '%s' returned by external command %s"
 
337
                               % (opt, path))
 
338
 
 
339
        # TODO: Is there any way to check takes_args is valid here?
 
340
        self.takes_args = pipe.readline().split()
 
341
 
 
342
        if pipe.close() is not None:
 
343
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
 
344
 
 
345
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
346
        self.__doc__ = pipe.read()
 
347
        if pipe.close() is not None:
 
348
            raise BzrError("Failed funning '%s --bzr-help'" % path)
 
349
 
 
350
    def __call__(self, options, arguments):
 
351
        Command.__init__(self, options, arguments)
 
352
        return self
 
353
 
 
354
    def name(self):
 
355
        raise NotImplementedError()
 
356
 
 
357
    def run(self, **kargs):
 
358
        raise NotImplementedError()
 
359
        
 
360
        opts = []
 
361
        args = []
 
362
 
 
363
        keys = kargs.keys()
 
364
        keys.sort()
 
365
        for name in keys:
 
366
            optname = name.replace('_','-')
 
367
            value = kargs[name]
 
368
            if OPTIONS.has_key(optname):
 
369
                # it's an option
 
370
                opts.append('--%s' % optname)
 
371
                if value is not None and value is not True:
 
372
                    opts.append(str(value))
 
373
            else:
 
374
                # it's an arg, or arg list
 
375
                if type(value) is not list:
 
376
                    value = [value]
 
377
                for v in value:
 
378
                    if v is not None:
 
379
                        args.append(str(v))
 
380
 
 
381
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
382
        return self.status
 
383
 
 
384
 
 
385
 
 
386
def parse_spec(spec):
 
387
    """
 
388
    >>> parse_spec(None)
 
389
    [None, None]
 
390
    >>> parse_spec("./")
 
391
    ['./', None]
 
392
    >>> parse_spec("../@")
 
393
    ['..', -1]
 
394
    >>> parse_spec("../f/@35")
 
395
    ['../f', 35]
 
396
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
 
397
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
 
398
    """
 
399
    if spec is None:
 
400
        return [None, None]
 
401
    if '/@' in spec:
 
402
        parsed = spec.split('/@')
 
403
        assert len(parsed) == 2
 
404
        if parsed[1] == "":
 
405
            parsed[1] = -1
 
406
        else:
 
407
            try:
 
408
                parsed[1] = int(parsed[1])
 
409
            except ValueError:
 
410
                pass # We can allow stuff like ./@revid:blahblahblah
 
411
            else:
 
412
                assert parsed[1] >=0
 
413
    else:
 
414
        parsed = [spec, None]
 
415
    return parsed
 
416
 
 
417
 
818
418
 
819
419
 
820
420
# list of all available options; the rhs can be either None for an
822
422
# the type.
823
423
OPTIONS = {
824
424
    'all':                    None,
 
425
    'diff-options':           str,
825
426
    'help':                   None,
 
427
    'file':                   unicode,
 
428
    'force':                  None,
 
429
    'format':                 unicode,
 
430
    'forward':                None,
826
431
    'message':                unicode,
 
432
    'no-recurse':             None,
827
433
    'profile':                None,
828
 
    'revision':               int,
 
434
    'revision':               _parse_revision_str,
 
435
    'short':                  None,
829
436
    'show-ids':               None,
830
437
    'timezone':               str,
831
438
    'verbose':                None,
832
439
    'version':                None,
833
440
    'email':                  None,
 
441
    'unchanged':              None,
 
442
    'update':                 None,
 
443
    'long':                   None,
 
444
    'root':                   str,
 
445
    'no-backup':              None,
 
446
    'merge-type':             get_merge_type,
 
447
    'pattern':                str,
834
448
    }
835
449
 
836
450
SHORT_OPTIONS = {
 
451
    'F':                      'file', 
 
452
    'h':                      'help',
837
453
    'm':                      'message',
838
454
    'r':                      'revision',
839
455
    'v':                      'verbose',
 
456
    'l':                      'long',
840
457
}
841
458
 
842
 
# List of options that apply to particular commands; commands not
843
 
# listed take none.
844
 
cmd_options = {
845
 
    'add':                    ['verbose'],
846
 
    'cat':                    ['revision'],
847
 
    'commit':                 ['message', 'verbose'],
848
 
    'deleted':                ['show-ids'],
849
 
    'diff':                   ['revision'],
850
 
    'inventory':              ['revision'],
851
 
    'log':                    ['timezone', 'verbose'],
852
 
    'ls':                     ['revision', 'verbose'],
853
 
    'remove':                 ['verbose'],
854
 
    'status':                 ['all'],
855
 
    'whoami':                 ['email'],
856
 
    }
857
 
 
858
 
 
859
 
cmd_args = {
860
 
    'add':                    ['file+'],
861
 
    'cat':                    ['filename'],
862
 
    'commit':                 [],
863
 
    'diff':                   ['file*'],
864
 
    'export':                 ['revno', 'dest'],
865
 
    'file-id':                ['filename'],
866
 
    'file-id-path':           ['filename'],
867
 
    'get-file-text':          ['text_id'],
868
 
    'get-inventory':          ['inventory_id'],
869
 
    'get-revision':           ['revision_id'],
870
 
    'get-revision-inventory': ['revision_id'],
871
 
    'help':                   ['topic?'],
872
 
    'init':                   [],
873
 
    'log':                    [],
874
 
    'lookup-revision':        ['revno'],
875
 
    'move':                   ['source$', 'dest'],
876
 
    'relpath':                ['filename'],
877
 
    'remove':                 ['file+'],
878
 
    'rename':                 ['from_name', 'to_name'],
879
 
    'renames':                ['dir?'],
880
 
    'root':                   ['filename?'],
881
 
    'status':                 [],
882
 
    }
883
 
 
884
459
 
885
460
def parse_args(argv):
886
461
    """Parse command line.
892
467
 
893
468
    >>> parse_args('--help'.split())
894
469
    ([], {'help': True})
 
470
    >>> parse_args('help -- --invalidcmd'.split())
 
471
    (['help', '--invalidcmd'], {})
895
472
    >>> parse_args('--version'.split())
896
473
    ([], {'version': True})
897
474
    >>> parse_args('status --all'.split())
898
475
    (['status'], {'all': True})
899
476
    >>> parse_args('commit --message=biter'.split())
900
477
    (['commit'], {'message': u'biter'})
 
478
    >>> parse_args('log -r 500'.split())
 
479
    (['log'], {'revision': [500]})
 
480
    >>> parse_args('log -r500..600'.split())
 
481
    (['log'], {'revision': [500, 600]})
 
482
    >>> parse_args('log -vr500..600'.split())
 
483
    (['log'], {'verbose': True, 'revision': [500, 600]})
 
484
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
 
485
    (['log'], {'revision': ['v500', 600]})
901
486
    """
902
487
    args = []
903
488
    opts = {}
904
489
 
905
 
    # TODO: Maybe handle '--' to end options?
906
 
 
 
490
    argsover = False
907
491
    while argv:
908
492
        a = argv.pop(0)
909
 
        if a[0] == '-':
 
493
        if not argsover and a[0] == '-':
910
494
            # option names must not be unicode
911
495
            a = str(a)
912
496
            optarg = None
913
497
            if a[1] == '-':
 
498
                if a == '--':
 
499
                    # We've received a standalone -- No more flags
 
500
                    argsover = True
 
501
                    continue
914
502
                mutter("  got option %r" % a)
915
503
                if '=' in a:
916
504
                    optname, optarg = a[2:].split('=', 1)
917
505
                else:
918
506
                    optname = a[2:]
919
507
                if optname not in OPTIONS:
920
 
                    bailout('unknown long option %r' % a)
 
508
                    raise BzrError('unknown long option %r' % a)
921
509
            else:
922
510
                shortopt = a[1:]
923
 
                if shortopt not in SHORT_OPTIONS:
924
 
                    bailout('unknown short option %r' % a)
925
 
                optname = SHORT_OPTIONS[shortopt]
 
511
                if shortopt in SHORT_OPTIONS:
 
512
                    # Multi-character options must have a space to delimit
 
513
                    # their value
 
514
                    optname = SHORT_OPTIONS[shortopt]
 
515
                else:
 
516
                    # Single character short options, can be chained,
 
517
                    # and have their value appended to their name
 
518
                    shortopt = a[1:2]
 
519
                    if shortopt not in SHORT_OPTIONS:
 
520
                        # We didn't find the multi-character name, and we
 
521
                        # didn't find the single char name
 
522
                        raise BzrError('unknown short option %r' % a)
 
523
                    optname = SHORT_OPTIONS[shortopt]
 
524
 
 
525
                    if a[2:]:
 
526
                        # There are extra things on this option
 
527
                        # see if it is the value, or if it is another
 
528
                        # short option
 
529
                        optargfn = OPTIONS[optname]
 
530
                        if optargfn is None:
 
531
                            # This option does not take an argument, so the
 
532
                            # next entry is another short option, pack it back
 
533
                            # into the list
 
534
                            argv.insert(0, '-' + a[2:])
 
535
                        else:
 
536
                            # This option takes an argument, so pack it
 
537
                            # into the array
 
538
                            optarg = a[2:]
926
539
            
927
540
            if optname in opts:
928
541
                # XXX: Do we ever want to support this, e.g. for -r?
929
 
                bailout('repeated option %r' % a)
 
542
                raise BzrError('repeated option %r' % a)
930
543
                
931
544
            optargfn = OPTIONS[optname]
932
545
            if optargfn:
933
546
                if optarg == None:
934
547
                    if not argv:
935
 
                        bailout('option %r needs an argument' % a)
 
548
                        raise BzrError('option %r needs an argument' % a)
936
549
                    else:
937
550
                        optarg = argv.pop(0)
938
551
                opts[optname] = optargfn(optarg)
939
552
            else:
940
553
                if optarg != None:
941
 
                    bailout('option %r takes no argument' % optname)
 
554
                    raise BzrError('option %r takes no argument' % optname)
942
555
                opts[optname] = True
943
556
        else:
944
557
            args.append(a)
947
560
 
948
561
 
949
562
 
950
 
def _match_args(cmd, args):
951
 
    """Check non-option arguments match required pattern.
952
563
 
953
 
    >>> _match_args('status', ['asdasdsadasd'])
954
 
    Traceback (most recent call last):
955
 
    ...
956
 
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
957
 
    >>> _match_args('add', ['asdasdsadasd'])
958
 
    {'file_list': ['asdasdsadasd']}
959
 
    >>> _match_args('add', 'abc def gj'.split())
960
 
    {'file_list': ['abc', 'def', 'gj']}
961
 
    """
962
 
    # match argument pattern
963
 
    argform = cmd_args.get(cmd, [])
 
564
def _match_argform(cmd, takes_args, args):
964
565
    argdict = {}
965
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
966
 
    # all but one.
967
566
 
968
 
    # step through args and argform, allowing appropriate 0-many matches
969
 
    for ap in argform:
 
567
    # step through args and takes_args, allowing appropriate 0-many matches
 
568
    for ap in takes_args:
970
569
        argname = ap[:-1]
971
570
        if ap[-1] == '?':
972
571
            if args:
979
578
                argdict[argname + '_list'] = None
980
579
        elif ap[-1] == '+':
981
580
            if not args:
982
 
                bailout("command %r needs one or more %s"
 
581
                raise BzrCommandError("command %r needs one or more %s"
983
582
                        % (cmd, argname.upper()))
984
583
            else:
985
584
                argdict[argname + '_list'] = args[:]
986
585
                args = []
987
586
        elif ap[-1] == '$': # all but one
988
587
            if len(args) < 2:
989
 
                bailout("command %r needs one or more %s"
 
588
                raise BzrCommandError("command %r needs one or more %s"
990
589
                        % (cmd, argname.upper()))
991
590
            argdict[argname + '_list'] = args[:-1]
992
591
            args[:-1] = []                
994
593
            # just a plain arg
995
594
            argname = ap
996
595
            if not args:
997
 
                bailout("command %r requires argument %s"
 
596
                raise BzrCommandError("command %r requires argument %s"
998
597
                        % (cmd, argname.upper()))
999
598
            else:
1000
599
                argdict[argname] = args.pop(0)
1001
600
            
1002
601
    if args:
1003
 
        bailout("extra arguments to command %s: %r"
1004
 
                % (cmd, args))
 
602
        raise BzrCommandError("extra argument to command %s: %s"
 
603
                              % (cmd, args[0]))
1005
604
 
1006
605
    return argdict
1007
606
 
1008
607
 
1009
608
 
 
609
def apply_profiled(the_callable, *args, **kwargs):
 
610
    import hotshot
 
611
    import tempfile
 
612
    pffileno, pfname = tempfile.mkstemp()
 
613
    try:
 
614
        prof = hotshot.Profile(pfname)
 
615
        try:
 
616
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
 
617
        finally:
 
618
            prof.close()
 
619
 
 
620
        import hotshot.stats
 
621
        stats = hotshot.stats.load(pfname)
 
622
        #stats.strip_dirs()
 
623
        stats.sort_stats('time')
 
624
        ## XXX: Might like to write to stderr or the trace file instead but
 
625
        ## print_stats seems hardcoded to stdout
 
626
        stats.print_stats(20)
 
627
 
 
628
        return ret
 
629
    finally:
 
630
        os.close(pffileno)
 
631
        os.remove(pfname)
 
632
 
 
633
 
1010
634
def run_bzr(argv):
1011
635
    """Execute a command.
1012
636
 
1013
637
    This is similar to main(), but without all the trappings for
1014
638
    logging and error handling.  
 
639
    
 
640
    argv
 
641
       The command-line arguments, without the program name from argv[0]
 
642
    
 
643
    Returns a command status or raises an exception.
 
644
 
 
645
    Special master options: these must come before the command because
 
646
    they control how the command is interpreted.
 
647
 
 
648
    --no-plugins
 
649
        Do not load plugin modules at all
 
650
 
 
651
    --builtin
 
652
        Only use builtin commands.  (Plugins are still allowed to change
 
653
        other behaviour.)
 
654
 
 
655
    --profile
 
656
        Run under the Python profiler.
1015
657
    """
1016
 
 
 
658
    
1017
659
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1018
 
    
1019
 
    try:
1020
 
        args, opts = parse_args(argv[1:])
1021
 
        if 'help' in opts:
1022
 
            # TODO: pass down other arguments in case they asked for
1023
 
            # help on a command name?
1024
 
            if args:
1025
 
                cmd_help(args[0])
1026
 
            else:
1027
 
                cmd_help()
1028
 
            return 0
1029
 
        elif 'version' in opts:
1030
 
            cmd_version()
1031
 
            return 0
1032
 
        cmd = str(args.pop(0))
1033
 
    except IndexError:
1034
 
        log_error('usage: bzr COMMAND')
1035
 
        log_error('  try "bzr help"')
1036
 
        return 1
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
 
660
 
 
661
    opt_profile = opt_no_plugins = opt_builtin = False
 
662
 
 
663
    # --no-plugins is handled specially at a very early stage. We need
 
664
    # to load plugins before doing other command parsing so that they
 
665
    # can override commands, but this needs to happen first.
 
666
 
 
667
    for a in argv[:]:
 
668
        if a == '--profile':
 
669
            opt_profile = True
 
670
        elif a == '--no-plugins':
 
671
            opt_no_plugins = True
 
672
        elif a == '--builtin':
 
673
            opt_builtin = True
 
674
        else:
 
675
            break
 
676
        argv.remove(a)
 
677
 
 
678
    if not opt_no_plugins:
 
679
        from bzrlib.plugin import load_plugins
 
680
        load_plugins()
 
681
 
 
682
    args, opts = parse_args(argv)
 
683
 
 
684
    if 'help' in opts:
 
685
        from bzrlib.help import help
 
686
        if args:
 
687
            help(args[0])
 
688
        else:
 
689
            help()
 
690
        return 0            
 
691
        
 
692
    if 'version' in opts:
 
693
        from bzrlib.builtins import show_version
 
694
        show_version()
 
695
        return 0
 
696
    
 
697
    if not args:
 
698
        from bzrlib.help import help
 
699
        help(None)
 
700
        return 0
 
701
    
 
702
    cmd = str(args.pop(0))
 
703
 
 
704
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1046
705
 
1047
706
    # check options are reasonable
1048
 
    allowed = cmd_options.get(canonical_cmd, [])
 
707
    allowed = cmd_obj.takes_options
1049
708
    for oname in opts:
1050
709
        if oname not in allowed:
1051
 
            bailout("option %r is not allowed for command %r"
1052
 
                    % (oname, cmd))
1053
 
 
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)
 
710
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
711
                                  % (oname, cmd))
1057
712
 
1058
713
    # mix arguments and options into one dictionary
1059
 
    cmdargs = _match_args(canonical_cmd, args)
 
714
    cmdargs = _match_argform(cmd, cmd_obj.takes_args, args)
 
715
    cmdopts = {}
1060
716
    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)
 
717
        cmdopts[k.replace('-', '_')] = v
 
718
 
 
719
    all_cmd_args = cmdargs.copy()
 
720
    all_cmd_args.update(cmdopts)
 
721
 
 
722
    if opt_profile:
 
723
        ret = apply_profiled(cmd_obj.run, **all_cmd_args)
1084
724
    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"
 
725
        ret = cmd_obj.run(**all_cmd_args)
 
726
 
 
727
    if ret is None:
 
728
        ret = 0
 
729
    return ret
1102
730
 
1103
731
 
1104
732
def main(argv):
1105
 
    bzrlib.trace.create_tracefile(argv)
 
733
    import bzrlib.ui
 
734
    bzrlib.trace.log_startup(argv)
 
735
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1106
736
 
1107
737
    try:
1108
738
        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.
1132
 
 
 
739
            return run_bzr(argv[1:])
 
740
        finally:
 
741
            # do this here inside the exception wrappers to catch EPIPE
 
742
            sys.stdout.flush()
 
743
    except BzrCommandError, e:
 
744
        # command line syntax error, etc
 
745
        log_error(str(e))
 
746
        return 1
 
747
    except BzrError, e:
 
748
        bzrlib.trace.log_exception()
 
749
        return 1
 
750
    except AssertionError, e:
 
751
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
 
752
        return 3
 
753
    except KeyboardInterrupt, e:
 
754
        bzrlib.trace.note('interrupted')
 
755
        return 2
 
756
    except Exception, e:
 
757
        import errno
 
758
        if (isinstance(e, IOError) 
 
759
            and hasattr(e, 'errno')
 
760
            and e.errno == errno.EPIPE):
 
761
            bzrlib.trace.note('broken pipe')
 
762
            return 2
 
763
        else:
 
764
            bzrlib.trace.log_exception()
 
765
            return 2
1133
766
 
1134
767
 
1135
768
if __name__ == '__main__':