/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

More work on roundtrip push support.

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
 
 
4
 
 
5
 
# This program is free software; you can redistribute it and/or modify
6
 
# it under the terms of the GNU General Public License as published by
7
 
# the Free Software Foundation; either version 2 of the License, or
8
 
# (at your option) any later version.
9
 
 
10
 
# This program is distributed in the hope that it will be useful,
11
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
# GNU General Public License for more details.
14
 
 
15
 
# You should have received a copy of the GNU General Public License
16
 
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
 
 
19
 
"""Bazaar-NG -- a free distributed version-control tool
20
 
 
21
 
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
 
 
23
 
Current limitation include:
24
 
 
25
 
* Metadata format is not stable yet -- you may need to
26
 
  discard history in the future.
27
 
 
28
 
* Insufficient error handling.
29
 
 
30
 
* Many commands unimplemented or partially implemented.
31
 
 
32
 
* Space-inefficient storage.
33
 
 
34
 
* No merge operators yet.
35
 
 
36
 
Interesting commands::
37
 
 
38
 
  bzr help [COMMAND]
39
 
       Show help screen
40
 
  bzr version
41
 
       Show software version/licence/non-warranty.
42
 
  bzr init
43
 
       Start versioning the current directory
44
 
  bzr add FILE...
45
 
       Make files versioned.
46
 
  bzr log
47
 
       Show revision history.
48
 
  bzr diff
49
 
       Show changes from last revision to working copy.
50
 
  bzr commit -m 'MESSAGE'
51
 
       Store current state as new revision.
52
 
  bzr export REVNO DESTINATION
53
 
       Export the branch state at a previous version.
54
 
  bzr status
55
 
       Show summary of pending changes.
56
 
  bzr remove FILE...
57
 
       Make a file not versioned.
58
 
  bzr info
59
 
       Show statistics about this branch.
60
 
"""
61
 
 
62
 
 
63
 
 
64
 
 
65
 
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
 
import traceback, socket, fnmatch, difflib
67
 
from os import path
68
 
from sets import Set
69
 
from pprint import pprint
70
 
from stat import *
71
 
from glob import glob
72
 
 
73
 
import bzrlib
74
 
from bzrlib.store import ImmutableStore
75
 
from bzrlib.trace import mutter, note, log_error
76
 
from bzrlib.errors import bailout, BzrError
77
 
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
 
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
 
from bzrlib.revision import Revision
80
 
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
 
     format_date
82
 
 
83
 
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
 
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
 
 
86
 
## standard representation
87
 
NONE_STRING = '(none)'
88
 
EMPTY = 'empty'
89
 
 
90
 
 
91
 
## TODO: Perhaps a different version of inventory commands that
92
 
## returns iterators...
93
 
 
94
 
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
 
 
96
 
## TODO: Some kind of locking on branches.  Perhaps there should be a
97
 
## parameter to the branch object saying whether we want a read or
98
 
## write lock; release it from destructor.  Perhaps don't even need a
99
 
## read lock to look at immutable objects?
100
 
 
101
 
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
 
## to compare output?
103
 
 
104
 
## TODO: Some kind of global code to generate the right Branch object
105
 
## to work on.  Almost, but not quite all, commands need one, and it
106
 
## can be taken either from their parameters or their working
107
 
## directory.
108
 
 
109
 
## TODO: rename command, needed soon: check destination doesn't exist
110
 
## either in working copy or tree; move working copy; update
111
 
## inventory; write out
112
 
 
113
 
## TODO: move command; check destination is a directory and will not
114
 
## clash; move it.
115
 
 
116
 
## TODO: command to show renames, one per line, as to->from
117
 
 
118
 
 
119
 
 
120
 
 
121
 
def cmd_status(all=False):
122
 
    """Display status summary.
123
 
 
124
 
    For each file there is a single line giving its file state and name.
125
 
    The name is that in the current revision unless it is deleted or
126
 
    missing, in which case the old name is shown.
127
 
 
128
 
    :todo: Don't show unchanged files unless ``--all`` is given?
129
 
    """
130
 
    Branch('.').show_status(show_all=all)
131
 
 
132
 
 
133
 
 
134
 
######################################################################
135
 
# examining history
136
 
def cmd_get_revision(revision_id):
137
 
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
 
 
139
 
 
140
 
def cmd_get_file_text(text_id):
141
 
    """Get contents of a file by hash."""
142
 
    sf = Branch('.').text_store[text_id]
143
 
    pumpfile(sf, sys.stdout)
144
 
 
145
 
 
146
 
 
147
 
######################################################################
148
 
# commands
149
 
    
150
 
 
151
 
def cmd_revno():
152
 
    """Show number of revisions on this branch"""
153
 
    print Branch('.').revno()
154
 
    
155
 
 
156
 
    
157
 
def cmd_add(file_list, verbose=False):
158
 
    """Add specified files or directories.
159
 
 
160
 
    In non-recursive mode, all the named items are added, regardless
161
 
    of whether they were previously ignored.  A warning is given if
162
 
    any of the named files are already versioned.
163
 
 
164
 
    In recursive mode (the default), files are treated the same way
165
 
    but the behaviour for directories is different.  Directories that
166
 
    are already versioned do not give a warning.  All directories,
167
 
    whether already versioned or not, are searched for files or
168
 
    subdirectories that are neither versioned or ignored, and these
169
 
    are added.  This search proceeds recursively into versioned
170
 
    directories.
171
 
 
172
 
    Therefore simply saying 'bzr add .' will version all files that
173
 
    are currently unknown.
174
 
    """
175
 
    bzrlib.add.smart_add(file_list, verbose)
176
 
    
177
 
 
178
 
def cmd_relpath(filename):
179
 
    """Show path of file relative to root"""
180
 
    print Branch(filename).relpath(filename)
181
 
 
182
 
 
183
 
 
184
 
def cmd_inventory(revision=None):
185
 
    """Show inventory of the current working copy."""
186
 
    ## TODO: Also optionally show a previous inventory
187
 
    ## TODO: Format options
188
 
    b = Branch('.')
189
 
    if revision == None:
190
 
        inv = b.read_working_inventory()
191
 
    else:
192
 
        inv = b.get_revision_inventory(b.lookup_revision(revision))
193
 
        
194
 
    for path, entry in inv.iter_entries():
195
 
        print '%-50s %s' % (entry.file_id, path)
196
 
 
197
 
 
198
 
 
199
 
def cmd_mv(source_list, dest):
200
 
    b = Branch('.')
201
 
 
202
 
    b.rename([b.relpath(s) for s in source_list], b.relpath(dest))
203
 
 
204
 
 
205
 
 
206
 
def cmd_renames(dir='.'):
207
 
    """Show list of renamed files.
208
 
 
209
 
usage: bzr renames [BRANCH]
210
 
 
211
 
TODO: Option to show renames between two historical versions.
212
 
 
213
 
TODO: Only show renames under dir, rather than in the whole branch.
214
 
"""
215
 
    b = Branch(dir)
216
 
    old_inv = b.basis_tree().inventory
217
 
    new_inv = b.read_working_inventory()
218
 
    
219
 
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
220
 
    renames.sort()
221
 
    for old_name, new_name in renames:
222
 
        print "%s => %s" % (old_name, new_name)        
223
 
 
224
 
 
225
 
 
226
 
def cmd_info():
227
 
    """info: Show statistical information for this branch
228
 
 
229
 
usage: bzr info"""
230
 
    import info
231
 
    info.show_info(Branch('.'))        
232
 
    
233
 
 
234
 
 
235
 
def cmd_remove(file_list, verbose=False):
236
 
    b = Branch(file_list[0])
237
 
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
238
 
 
239
 
 
240
 
 
241
 
def cmd_file_id(filename):
242
 
    b = Branch(filename)
243
 
    i = b.inventory.path2id(b.relpath(filename))
244
 
    if i is None:
245
 
        bailout("%s is not a versioned file" % filename)
246
 
    else:
247
 
        print i
248
 
 
249
 
 
250
 
def cmd_find_filename(fileid):
251
 
    n = find_filename(fileid)
252
 
    if n is None:
253
 
        bailout("%s is not a live file id" % fileid)
254
 
    else:
255
 
        print n
256
 
 
257
 
 
258
 
def cmd_revision_history():
259
 
    for patchid in Branch('.').revision_history():
260
 
        print patchid
261
 
 
262
 
 
263
 
def cmd_directories():
264
 
    for name, ie in Branch('.').read_working_inventory().directories():
265
 
        if name == '':
266
 
            print '.'
267
 
        else:
268
 
            print name
269
 
 
270
 
 
271
 
def cmd_missing():
272
 
    for name, ie in Branch('.').working_tree().missing():
273
 
        print name
274
 
 
275
 
 
276
 
def cmd_init():
277
 
    # TODO: Check we're not already in a working directory?  At the
278
 
    # moment you'll get an ugly error.
279
 
    
280
 
    # TODO: What if we're in a subdirectory of a branch?  Would like
281
 
    # to allow that, but then the parent may need to understand that
282
 
    # the children have disappeared, or should they be versioned in
283
 
    # both?
284
 
 
285
 
    # TODO: Take an argument/option for branch name.
286
 
    Branch('.', init=True)
287
 
 
288
 
 
289
 
def cmd_diff(revision=None):
290
 
    """bzr diff: Show differences in working tree.
291
 
    
292
 
usage: bzr diff [-r REV]
293
 
 
294
 
--revision REV
295
 
    Show changes since REV, rather than predecessor.
296
 
 
297
 
TODO: Given two revision arguments, show the difference between them.
298
 
 
299
 
TODO: Allow diff across branches.
300
 
 
301
 
TODO: Option to use external diff command; could be GNU diff, wdiff,
302
 
or a graphical diff.
303
 
 
304
 
TODO: Diff selected files.
305
 
"""
306
 
 
307
 
    ## TODO: Shouldn't be in the cmd function.
308
 
 
309
 
    b = Branch('.')
310
 
 
311
 
    if revision == None:
312
 
        old_tree = b.basis_tree()
313
 
    else:
314
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
315
 
        
316
 
    new_tree = b.working_tree()
317
 
    old_inv = old_tree.inventory
318
 
    new_inv = new_tree.inventory
319
 
 
320
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
321
 
    old_label = ''
322
 
    new_label = ''
323
 
 
324
 
    DEVNULL = '/dev/null'
325
 
    # Windows users, don't panic about this filename -- it is a
326
 
    # special signal to GNU patch that the file should be created or
327
 
    # deleted respectively.
328
 
 
329
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
330
 
    # be usefully made into a much faster special case.
331
 
 
332
 
    # TODO: Better to return them in sorted order I think.
333
 
    
334
 
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
335
 
        d = None
336
 
 
337
 
        # Don't show this by default; maybe do it if an option is passed
338
 
        # idlabel = '      {%s}' % fid
339
 
        idlabel = ''
340
 
 
341
 
        # FIXME: Something about the diff format makes patch unhappy
342
 
        # with newly-added files.
343
 
 
344
 
        def diffit(oldlines, newlines, **kw):
345
 
            # FIXME: difflib is wrong if there is no trailing newline.
346
 
 
347
 
            # Special workaround for Python2.3, where difflib fails if
348
 
            # both sequences are empty.
349
 
            if oldlines or newlines:
350
 
                sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
351
 
            print
352
 
        
353
 
        if file_state in ['.', '?', 'I']:
354
 
            continue
355
 
        elif file_state == 'A':
356
 
            print '*** added %s %r' % (kind, new_name)
357
 
            if kind == 'file':
358
 
                diffit([],
359
 
                       new_tree.get_file(fid).readlines(),
360
 
                       fromfile=DEVNULL,
361
 
                       tofile=new_label + new_name + idlabel)
362
 
        elif file_state == 'D':
363
 
            assert isinstance(old_name, types.StringTypes)
364
 
            print '*** deleted %s %r' % (kind, old_name)
365
 
            if kind == 'file':
366
 
                diffit(old_tree.get_file(fid).readlines(), [],
367
 
                       fromfile=old_label + old_name + idlabel,
368
 
                       tofile=DEVNULL)
369
 
        elif file_state in ['M', 'R']:
370
 
            if file_state == 'M':
371
 
                assert kind == 'file'
372
 
                assert old_name == new_name
373
 
                print '*** modified %s %r' % (kind, new_name)
374
 
            elif file_state == 'R':
375
 
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
376
 
 
377
 
            if kind == 'file':
378
 
                diffit(old_tree.get_file(fid).readlines(),
379
 
                       new_tree.get_file(fid).readlines(),
380
 
                       fromfile=old_label + old_name + idlabel,
381
 
                       tofile=new_label + new_name)
382
 
        else:
383
 
            bailout("can't represent state %s {%s}" % (file_state, fid))
384
 
 
385
 
 
386
 
 
387
 
def cmd_deleted(show_ids=False):
388
 
    """List files deleted in the working tree.
389
 
 
390
 
TODO: Show files deleted since a previous revision, or between two revisions.
391
 
    """
392
 
    b = Branch('.')
393
 
    old = b.basis_tree()
394
 
    new = b.working_tree()
395
 
 
396
 
    ## TODO: Much more efficient way to do this: read in new
397
 
    ## directories with readdir, rather than stating each one.  Same
398
 
    ## level of effort but possibly much less IO.  (Or possibly not,
399
 
    ## if the directories are very large...)
400
 
 
401
 
    for path, ie in old.inventory.iter_entries():
402
 
        if not new.has_id(ie.file_id):
403
 
            if show_ids:
404
 
                print '%-50s %s' % (path, ie.file_id)
405
 
            else:
406
 
                print path
407
 
 
408
 
 
409
 
 
410
 
def cmd_parse_inventory():
411
 
    import cElementTree
412
 
    
413
 
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
414
 
 
415
 
 
416
 
 
417
 
def cmd_load_inventory():
418
 
    inv = Branch('.').basis_tree().inventory
419
 
 
420
 
 
421
 
 
422
 
def cmd_dump_new_inventory():
423
 
    import bzrlib.newinventory
424
 
    inv = Branch('.').basis_tree().inventory
425
 
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
426
 
 
427
 
 
428
 
def cmd_load_new_inventory():
429
 
    import bzrlib.newinventory
430
 
    bzrlib.newinventory.read_new_inventory(sys.stdin)
431
 
                
432
 
    
433
 
def cmd_dump_slacker_inventory():
434
 
    import bzrlib.newinventory
435
 
    inv = Branch('.').basis_tree().inventory
436
 
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
437
 
                
438
 
    
439
 
 
440
 
def cmd_root(filename=None):
441
 
    """Print the branch root."""
442
 
    print bzrlib.branch.find_branch_root(filename)
443
 
    
444
 
 
445
 
def cmd_log(timezone='original'):
446
 
    """Show log of this branch.
447
 
 
448
 
    :todo: Options for utc; to show ids; to limit range; etc.
449
 
    """
450
 
    Branch('.').write_log(show_timezone=timezone)
451
 
 
452
 
 
453
 
def cmd_ls(revision=None, verbose=False):
454
 
    """List files in a tree.
455
 
 
456
 
    :todo: Take a revision or remote path and list that tree instead.
457
 
    """
458
 
    b = Branch('.')
459
 
    if revision == None:
460
 
        tree = b.working_tree()
461
 
    else:
462
 
        tree = b.revision_tree(b.lookup_revision(revision))
463
 
        
464
 
    for fp, fc, kind, fid in tree.list_files():
465
 
        if verbose:
466
 
            if kind == 'directory':
467
 
                kindch = '/'
468
 
            elif kind == 'file':
469
 
                kindch = ''
470
 
            else:
471
 
                kindch = '???'
472
 
                
473
 
            print '%-8s %s%s' % (fc, fp, kindch)
474
 
        else:
475
 
            print fp
476
 
    
477
 
    
478
 
 
479
 
def cmd_unknowns():
480
 
    """List unknown files"""
481
 
    for f in Branch('.').unknowns():
482
 
        print quotefn(f)
483
 
 
484
 
 
485
 
 
486
 
def cmd_ignored(verbose=True):
487
 
    """List ignored files and the patterns that matched them.
488
 
      """
489
 
    tree = Branch('.').working_tree()
490
 
    for path, file_class, kind, id in tree.list_files():
491
 
        if file_class != 'I':
492
 
            continue
493
 
        ## XXX: Slightly inefficient since this was already calculated
494
 
        pat = tree.is_ignored(path)
495
 
        print '%-50s %s' % (path, pat)
496
 
 
497
 
 
498
 
def cmd_lookup_revision(revno):
499
 
    try:
500
 
        revno = int(revno)
501
 
    except ValueError:
502
 
        bailout("usage: lookup-revision REVNO",
503
 
                ["REVNO is a non-negative revision number for this branch"])
504
 
 
505
 
    print Branch('.').lookup_revision(revno) or NONE_STRING
506
 
 
507
 
 
508
 
 
509
 
def cmd_export(revno, dest):
510
 
    """Export past revision to destination directory."""
511
 
    b = Branch('.')
512
 
    rh = b.lookup_revision(int(revno))
513
 
    t = b.revision_tree(rh)
514
 
    t.export(dest)
515
 
 
516
 
 
517
 
 
518
 
######################################################################
519
 
# internal/test commands
520
 
 
521
 
 
522
 
def cmd_uuid():
523
 
    """Print a newly-generated UUID."""
524
 
    print bzrlib.osutils.uuid()
525
 
 
526
 
 
527
 
 
528
 
def cmd_local_time_offset():
529
 
    print bzrlib.osutils.local_time_offset()
530
 
 
531
 
 
532
 
 
533
 
def cmd_commit(message=None, verbose=False):
534
 
    """Commit changes to a new revision.
535
 
 
536
 
--message MESSAGE
537
 
    Description of changes in this revision; free form text.
538
 
    It is recommended that the first line be a single-sentence
539
 
    summary.
540
 
--verbose
541
 
    Show status of changed files,
542
 
 
543
 
TODO: Commit only selected files.
544
 
 
545
 
TODO: Run hooks on tree to-be-committed, and after commit.
546
 
 
547
 
TODO: Strict commit that fails if there are unknown or deleted files.
548
 
"""
549
 
 
550
 
    if not message:
551
 
        bailout("please specify a commit message")
552
 
    Branch('.').commit(message, verbose=verbose)
553
 
 
554
 
 
555
 
def cmd_check(dir='.'):
556
 
    """check: Consistency check of branch history.
557
 
 
558
 
usage: bzr check [-v] [BRANCH]
559
 
 
560
 
options:
561
 
  --verbose, -v         Show progress of checking.
562
 
 
563
 
This command checks various invariants about the branch storage to
564
 
detect data corruption or bzr bugs.
565
 
"""
566
 
    import bzrlib.check
567
 
    bzrlib.check.check(Branch(dir, find_root=False))
568
 
 
569
 
 
570
 
def cmd_is(pred, *rest):
571
 
    """Test whether PREDICATE is true."""
572
 
    try:
573
 
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
574
 
    except KeyError:
575
 
        bailout("unknown predicate: %s" % quotefn(pred))
576
 
        
577
 
    try:
578
 
        cmd_handler(*rest)
579
 
    except BzrCheckError:
580
 
        # by default we don't print the message so that this can
581
 
        # be used from shell scripts without producing noise
582
 
        sys.exit(1)
583
 
 
584
 
 
585
 
def cmd_username():
586
 
    print bzrlib.osutils.username()
587
 
 
588
 
 
589
 
def cmd_user_email():
590
 
    print bzrlib.osutils.user_email()
591
 
 
592
 
 
593
 
def cmd_gen_revision_id():
594
 
    import time
595
 
    print bzrlib.branch._gen_revision_id(time.time())
596
 
 
597
 
 
598
 
def cmd_selftest(verbose=False):
599
 
    """Run internal test suite"""
600
 
    ## -v, if present, is seen by doctest; the argument is just here
601
 
    ## so our parser doesn't complain
602
 
 
603
 
    ## TODO: --verbose option
604
 
 
605
 
    failures, tests = 0, 0
606
 
    
607
 
    import doctest, bzrlib.store, bzrlib.tests
608
 
    bzrlib.trace.verbose = False
609
 
 
610
 
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
611
 
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
612
 
        mf, mt = doctest.testmod(m)
613
 
        failures += mf
614
 
        tests += mt
615
 
        print '%-40s %3d tests' % (m.__name__, mt),
616
 
        if mf:
617
 
            print '%3d FAILED!' % mf
618
 
        else:
619
 
            print
620
 
 
621
 
    print '%-40s %3d tests' % ('total', tests),
622
 
    if failures:
623
 
        print '%3d FAILED!' % failures
624
 
    else:
625
 
        print
626
 
 
627
 
 
628
 
 
629
 
# deprecated
630
 
cmd_doctest = cmd_selftest
631
 
 
632
 
 
633
 
######################################################################
634
 
# help
635
 
 
636
 
 
637
 
def cmd_help(topic=None):
638
 
    if topic == None:
639
 
        print __doc__
640
 
        return
641
 
 
642
 
    # otherwise, maybe the name of a command?
643
 
    try:
644
 
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
645
 
    except KeyError:
646
 
        bailout("no help for %r" % topic)
647
 
 
648
 
    doc = cmdfn.__doc__
649
 
    if doc == None:
650
 
        bailout("sorry, no detailed help yet for %r" % topic)
651
 
 
652
 
    print doc
653
 
        
654
 
 
655
 
 
656
 
 
657
 
def cmd_version():
658
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
659
 
    print bzrlib.__copyright__
660
 
    print "http://bazaar-ng.org/"
661
 
    print
662
 
    print \
663
 
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
664
 
you may use, modify and redistribute it under the terms of the GNU 
665
 
General Public License version 2 or later."""
666
 
 
667
 
 
668
 
def cmd_rocks():
669
 
    """Statement of optimism."""
670
 
    print "it sure does!"
671
 
 
672
 
 
673
 
 
674
 
######################################################################
675
 
# main routine
676
 
 
677
 
 
678
 
# list of all available options; the rhs can be either None for an
679
 
# option that takes no argument, or a constructor function that checks
680
 
# the type.
681
 
OPTIONS = {
682
 
    'all':                    None,
683
 
    'help':                   None,
684
 
    'message':                unicode,
685
 
    'profile':                None,
686
 
    'revision':               int,
687
 
    'show-ids':               None,
688
 
    'timezone':               str,
689
 
    'verbose':                None,
690
 
    'version':                None,
691
 
    }
692
 
 
693
 
SHORT_OPTIONS = {
694
 
    'm':                      'message',
695
 
    'r':                      'revision',
696
 
    'v':                      'verbose',
697
 
}
698
 
 
699
 
# List of options that apply to particular commands; commands not
700
 
# listed take none.
701
 
cmd_options = {
702
 
    'add':                    ['verbose'],
703
 
    'commit':                 ['message', 'verbose'],
704
 
    'deleted':                ['show-ids'],
705
 
    'diff':                   ['revision'],
706
 
    'inventory':              ['revision'],
707
 
    'log':                    ['timezone'],
708
 
    'ls':                     ['revision', 'verbose'],
709
 
    'remove':                 ['verbose'],
710
 
    'status':                 ['all'],
711
 
    }
712
 
 
713
 
 
714
 
cmd_args = {
715
 
    'add':                    ['file+'],
716
 
    'commit':                 [],
717
 
    'diff':                   [],
718
 
    'export':                 ['revno', 'dest'],
719
 
    'file-id':                ['filename'],
720
 
    'get-file-text':          ['text_id'],
721
 
    'get-inventory':          ['inventory_id'],
722
 
    'get-revision':           ['revision_id'],
723
 
    'get-revision-inventory': ['revision_id'],
724
 
    'help':                   ['topic?'],
725
 
    'init':                   [],
726
 
    'log':                    [],
727
 
    'lookup-revision':        ['revno'],
728
 
    'mv':                     ['source$', 'dest'],
729
 
    'relpath':                ['filename'],
730
 
    'remove':                 ['file+'],
731
 
    'renames':                ['dir?'],
732
 
    'root':                   ['filename?'],
733
 
    'status':                 [],
734
 
    }
735
 
 
736
 
 
737
 
def parse_args(argv):
738
 
    """Parse command line.
739
 
    
740
 
    Arguments and options are parsed at this level before being passed
741
 
    down to specific command handlers.  This routine knows, from a
742
 
    lookup table, something about the available options, what optargs
743
 
    they take, and which commands will accept them.
744
 
 
745
 
    >>> parse_args('--help'.split())
746
 
    ([], {'help': True})
747
 
    >>> parse_args('--version'.split())
748
 
    ([], {'version': True})
749
 
    >>> parse_args('status --all'.split())
750
 
    (['status'], {'all': True})
751
 
    >>> parse_args('commit --message=biter'.split())
752
 
    (['commit'], {'message': u'biter'})
753
 
    """
754
 
    args = []
755
 
    opts = {}
756
 
 
757
 
    # TODO: Maybe handle '--' to end options?
758
 
 
759
 
    while argv:
760
 
        a = argv.pop(0)
761
 
        if a[0] == '-':
762
 
            optarg = None
763
 
            if a[1] == '-':
764
 
                mutter("  got option %r" % a)
765
 
                if '=' in a:
766
 
                    optname, optarg = a[2:].split('=', 1)
767
 
                else:
768
 
                    optname = a[2:]
769
 
                if optname not in OPTIONS:
770
 
                    bailout('unknown long option %r' % a)
771
 
            else:
772
 
                shortopt = a[1:]
773
 
                if shortopt not in SHORT_OPTIONS:
774
 
                    bailout('unknown short option %r' % a)
775
 
                optname = SHORT_OPTIONS[shortopt]
776
 
            
777
 
            if optname in opts:
778
 
                # XXX: Do we ever want to support this, e.g. for -r?
779
 
                bailout('repeated option %r' % a)
780
 
                
781
 
            optargfn = OPTIONS[optname]
782
 
            if optargfn:
783
 
                if optarg == None:
784
 
                    if not argv:
785
 
                        bailout('option %r needs an argument' % a)
786
 
                    else:
787
 
                        optarg = argv.pop(0)
788
 
                opts[optname] = optargfn(optarg)
789
 
            else:
790
 
                if optarg != None:
791
 
                    bailout('option %r takes no argument' % optname)
792
 
                opts[optname] = True
793
 
        else:
794
 
            args.append(a)
795
 
 
796
 
    return args, opts
797
 
 
798
 
 
799
 
 
800
 
def _match_args(cmd, args):
801
 
    """Check non-option arguments match required pattern.
802
 
 
803
 
    >>> _match_args('status', ['asdasdsadasd'])
804
 
    Traceback (most recent call last):
805
 
    ...
806
 
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
807
 
    >>> _match_args('add', ['asdasdsadasd'])
808
 
    {'file_list': ['asdasdsadasd']}
809
 
    >>> _match_args('add', 'abc def gj'.split())
810
 
    {'file_list': ['abc', 'def', 'gj']}
811
 
    """
812
 
    # match argument pattern
813
 
    argform = cmd_args.get(cmd, [])
814
 
    argdict = {}
815
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
816
 
    # all but one.
817
 
 
818
 
    # step through args and argform, allowing appropriate 0-many matches
819
 
    for ap in argform:
820
 
        argname = ap[:-1]
821
 
        if ap[-1] == '?':
822
 
            if args:
823
 
                argdict[argname] = args.pop(0)
824
 
        elif ap[-1] == '*':
825
 
            assert 0
826
 
        elif ap[-1] == '+':
827
 
            if not args:
828
 
                bailout("command %r needs one or more %s"
829
 
                        % (cmd, argname.upper()))
830
 
            else:
831
 
                argdict[argname + '_list'] = args[:]
832
 
                args = []
833
 
        elif ap[-1] == '$': # all but one
834
 
            if len(args) < 2:
835
 
                bailout("command %r needs one or more %s"
836
 
                        % (cmd, argname.upper()))
837
 
            argdict[argname + '_list'] = args[:-1]
838
 
            args[:-1] = []                
839
 
        else:
840
 
            # just a plain arg
841
 
            argname = ap
842
 
            if not args:
843
 
                bailout("command %r requires argument %s"
844
 
                        % (cmd, argname.upper()))
845
 
            else:
846
 
                argdict[argname] = args.pop(0)
847
 
            
848
 
    if args:
849
 
        bailout("extra arguments to command %s: %r"
850
 
                % (cmd, args))
851
 
 
852
 
    return argdict
853
 
 
854
 
 
855
 
 
856
 
def run_bzr(argv):
857
 
    """Execute a command.
858
 
 
859
 
    This is similar to main(), but without all the trappings for
860
 
    logging and error handling.
861
 
    """
862
 
    try:
863
 
        args, opts = parse_args(argv[1:])
864
 
        if 'help' in opts:
865
 
            # TODO: pass down other arguments in case they asked for
866
 
            # help on a command name?
867
 
            if args:
868
 
                cmd_help(args[0])
869
 
            else:
870
 
                cmd_help()
871
 
            return 0
872
 
        elif 'version' in opts:
873
 
            cmd_version()
874
 
            return 0
875
 
        cmd = args.pop(0)
876
 
    except IndexError:
877
 
        log_error('usage: bzr COMMAND\n')
878
 
        log_error('  try "bzr help"\n')
879
 
        return 1
880
 
 
881
 
    try:
882
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
883
 
    except KeyError:
884
 
        bailout("unknown command " + `cmd`)
885
 
 
886
 
    # global option
887
 
    if 'profile' in opts:
888
 
        profile = True
889
 
        del opts['profile']
890
 
    else:
891
 
        profile = False
892
 
 
893
 
    # check options are reasonable
894
 
    allowed = cmd_options.get(cmd, [])
895
 
    for oname in opts:
896
 
        if oname not in allowed:
897
 
            bailout("option %r is not allowed for command %r"
898
 
                    % (oname, cmd))
899
 
 
900
 
    # mix arguments and options into one dictionary
901
 
    cmdargs = _match_args(cmd, args)
902
 
    for k, v in opts.items():
903
 
        cmdargs[k.replace('-', '_')] = v
904
 
 
905
 
    if profile:
906
 
        import hotshot
907
 
        prof = hotshot.Profile('.bzr.profile')
908
 
        ret = prof.runcall(cmd_handler, **cmdargs) or 0
909
 
        prof.close()
910
 
 
911
 
        import hotshot.stats
912
 
        stats = hotshot.stats.load('.bzr.profile')
913
 
        #stats.strip_dirs()
914
 
        stats.sort_stats('time')
915
 
        stats.print_stats(20)
916
 
    else:
917
 
        return cmd_handler(**cmdargs) or 0
918
 
 
919
 
 
920
 
 
921
 
def main(argv):
922
 
    ## TODO: Handle command-line options; probably know what options are valid for
923
 
    ## each command
924
 
 
925
 
    ## TODO: If the arguments are wrong, give a usage message rather
926
 
    ## than just a backtrace.
927
 
 
928
 
    bzrlib.trace.create_tracefile(argv)
929
 
    
930
 
    try:
931
 
        ret = run_bzr(argv)
932
 
        return ret
933
 
    except BzrError, e:
934
 
        log_error('bzr: error: ' + e.args[0] + '\n')
935
 
        if len(e.args) > 1:
936
 
            for h in e.args[1]:
937
 
                log_error('  ' + h + '\n')
938
 
        return 1
939
 
    except Exception, e:
940
 
        log_error('bzr: exception: %s\n' % e)
941
 
        log_error('    see .bzr.log for details\n')
942
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
943
 
        traceback.print_exc(None, sys.stderr)
944
 
        return 1
945
 
 
946
 
    # TODO: Maybe nicer handling of IOError?
947
 
 
948
 
 
949
 
 
950
 
if __name__ == '__main__':
951
 
    sys.exit(main(sys.argv))
952
 
    ##import profile
953
 
    ##profile.run('main(sys.argv)')
954