/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
 
# TODO: Maybe a 'mv' command that has the combined move/rename
200
 
# special behaviour of Unix?
201
 
 
202
 
def cmd_move(source_list, dest):
203
 
    b = Branch('.')
204
 
 
205
 
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
206
 
 
207
 
 
208
 
 
209
 
def cmd_rename(from_name, to_name):
210
 
    """Change the name of an entry.
211
 
 
212
 
usage: bzr rename FROM_NAME TO_NAME
213
 
 
214
 
examples:
215
 
  bzr rename frob.c frobber.c
216
 
  bzr rename src/frob.c lib/frob.c
217
 
 
218
 
It is an error if the destination name exists.
219
 
 
220
 
See also the 'move' command, which moves files into a different
221
 
directory without changing their name.
222
 
 
223
 
TODO: Some way to rename multiple files without invoking bzr for each
224
 
one?"""
225
 
    b = Branch('.')
226
 
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
227
 
    
228
 
 
229
 
 
230
 
 
231
 
def cmd_renames(dir='.'):
232
 
    """Show list of renamed files.
233
 
 
234
 
usage: bzr renames [BRANCH]
235
 
 
236
 
TODO: Option to show renames between two historical versions.
237
 
 
238
 
TODO: Only show renames under dir, rather than in the whole branch.
239
 
"""
240
 
    b = Branch(dir)
241
 
    old_inv = b.basis_tree().inventory
242
 
    new_inv = b.read_working_inventory()
243
 
    
244
 
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
245
 
    renames.sort()
246
 
    for old_name, new_name in renames:
247
 
        print "%s => %s" % (old_name, new_name)        
248
 
 
249
 
 
250
 
 
251
 
def cmd_info():
252
 
    """info: Show statistical information for this branch
253
 
 
254
 
usage: bzr info"""
255
 
    import info
256
 
    info.show_info(Branch('.'))        
257
 
    
258
 
 
259
 
 
260
 
def cmd_remove(file_list, verbose=False):
261
 
    b = Branch(file_list[0])
262
 
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
263
 
 
264
 
 
265
 
 
266
 
def cmd_file_id(filename):
267
 
    """Print file_id of a particular file or directory.
268
 
 
269
 
usage: bzr file-id FILE
270
 
 
271
 
The file_id is assigned when the file is first added and remains the
272
 
same through all revisions where the file exists, even when it is
273
 
moved or renamed.
274
 
"""
275
 
    b = Branch(filename)
276
 
    i = b.inventory.path2id(b.relpath(filename))
277
 
    if i == None:
278
 
        bailout("%r is not a versioned file" % filename)
279
 
    else:
280
 
        print i
281
 
 
282
 
 
283
 
def cmd_file_id_path(filename):
284
 
    """Print path of file_ids to a file or directory.
285
 
 
286
 
usage: bzr file-id-path FILE
287
 
 
288
 
This prints one line for each directory down to the target,
289
 
starting at the branch root."""
290
 
    b = Branch(filename)
291
 
    inv = b.inventory
292
 
    fid = inv.path2id(b.relpath(filename))
293
 
    if fid == None:
294
 
        bailout("%r is not a versioned file" % filename)
295
 
    for fip in inv.get_idpath(fid):
296
 
        print fip
297
 
 
298
 
 
299
 
def cmd_find_filename(fileid):
300
 
    n = find_filename(fileid)
301
 
    if n is None:
302
 
        bailout("%s is not a live file id" % fileid)
303
 
    else:
304
 
        print n
305
 
 
306
 
 
307
 
def cmd_revision_history():
308
 
    for patchid in Branch('.').revision_history():
309
 
        print patchid
310
 
 
311
 
 
312
 
def cmd_directories():
313
 
    for name, ie in Branch('.').read_working_inventory().directories():
314
 
        if name == '':
315
 
            print '.'
316
 
        else:
317
 
            print name
318
 
 
319
 
 
320
 
def cmd_missing():
321
 
    for name, ie in Branch('.').working_tree().missing():
322
 
        print name
323
 
 
324
 
 
325
 
def cmd_init():
326
 
    # TODO: Check we're not already in a working directory?  At the
327
 
    # moment you'll get an ugly error.
328
 
    
329
 
    # TODO: What if we're in a subdirectory of a branch?  Would like
330
 
    # to allow that, but then the parent may need to understand that
331
 
    # the children have disappeared, or should they be versioned in
332
 
    # both?
333
 
 
334
 
    # TODO: Take an argument/option for branch name.
335
 
    Branch('.', init=True)
336
 
 
337
 
 
338
 
def cmd_diff(revision=None):
339
 
    """bzr diff: Show differences in working tree.
340
 
    
341
 
usage: bzr diff [-r REV]
342
 
 
343
 
--revision REV
344
 
    Show changes since REV, rather than predecessor.
345
 
 
346
 
TODO: Given two revision arguments, show the difference between them.
347
 
 
348
 
TODO: Allow diff across branches.
349
 
 
350
 
TODO: Option to use external diff command; could be GNU diff, wdiff,
351
 
or a graphical diff.
352
 
 
353
 
TODO: Diff selected files.
354
 
"""
355
 
 
356
 
    ## TODO: Shouldn't be in the cmd function.
357
 
 
358
 
    b = Branch('.')
359
 
 
360
 
    if revision == None:
361
 
        old_tree = b.basis_tree()
362
 
    else:
363
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
364
 
        
365
 
    new_tree = b.working_tree()
366
 
    old_inv = old_tree.inventory
367
 
    new_inv = new_tree.inventory
368
 
 
369
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
370
 
    old_label = ''
371
 
    new_label = ''
372
 
 
373
 
    DEVNULL = '/dev/null'
374
 
    # Windows users, don't panic about this filename -- it is a
375
 
    # special signal to GNU patch that the file should be created or
376
 
    # deleted respectively.
377
 
 
378
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
379
 
    # be usefully made into a much faster special case.
380
 
 
381
 
    # TODO: Better to return them in sorted order I think.
382
 
    
383
 
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
384
 
        d = None
385
 
 
386
 
        # Don't show this by default; maybe do it if an option is passed
387
 
        # idlabel = '      {%s}' % fid
388
 
        idlabel = ''
389
 
 
390
 
        # FIXME: Something about the diff format makes patch unhappy
391
 
        # with newly-added files.
392
 
 
393
 
        def diffit(oldlines, newlines, **kw):
394
 
            # FIXME: difflib is wrong if there is no trailing newline.
395
 
 
396
 
            # Special workaround for Python2.3, where difflib fails if
397
 
            # both sequences are empty.
398
 
            if oldlines or newlines:
399
 
                sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
400
 
            print
401
 
        
402
 
        if file_state in ['.', '?', 'I']:
403
 
            continue
404
 
        elif file_state == 'A':
405
 
            print '*** added %s %r' % (kind, new_name)
406
 
            if kind == 'file':
407
 
                diffit([],
408
 
                       new_tree.get_file(fid).readlines(),
409
 
                       fromfile=DEVNULL,
410
 
                       tofile=new_label + new_name + idlabel)
411
 
        elif file_state == 'D':
412
 
            assert isinstance(old_name, types.StringTypes)
413
 
            print '*** deleted %s %r' % (kind, old_name)
414
 
            if kind == 'file':
415
 
                diffit(old_tree.get_file(fid).readlines(), [],
416
 
                       fromfile=old_label + old_name + idlabel,
417
 
                       tofile=DEVNULL)
418
 
        elif file_state in ['M', 'R']:
419
 
            if file_state == 'M':
420
 
                assert kind == 'file'
421
 
                assert old_name == new_name
422
 
                print '*** modified %s %r' % (kind, new_name)
423
 
            elif file_state == 'R':
424
 
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
425
 
 
426
 
            if kind == 'file':
427
 
                diffit(old_tree.get_file(fid).readlines(),
428
 
                       new_tree.get_file(fid).readlines(),
429
 
                       fromfile=old_label + old_name + idlabel,
430
 
                       tofile=new_label + new_name)
431
 
        else:
432
 
            bailout("can't represent state %s {%s}" % (file_state, fid))
433
 
 
434
 
 
435
 
 
436
 
def cmd_deleted(show_ids=False):
437
 
    """List files deleted in the working tree.
438
 
 
439
 
TODO: Show files deleted since a previous revision, or between two revisions.
440
 
    """
441
 
    b = Branch('.')
442
 
    old = b.basis_tree()
443
 
    new = b.working_tree()
444
 
 
445
 
    ## TODO: Much more efficient way to do this: read in new
446
 
    ## directories with readdir, rather than stating each one.  Same
447
 
    ## level of effort but possibly much less IO.  (Or possibly not,
448
 
    ## if the directories are very large...)
449
 
 
450
 
    for path, ie in old.inventory.iter_entries():
451
 
        if not new.has_id(ie.file_id):
452
 
            if show_ids:
453
 
                print '%-50s %s' % (path, ie.file_id)
454
 
            else:
455
 
                print path
456
 
 
457
 
 
458
 
 
459
 
def cmd_parse_inventory():
460
 
    import cElementTree
461
 
    
462
 
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
463
 
 
464
 
 
465
 
 
466
 
def cmd_load_inventory():
467
 
    inv = Branch('.').basis_tree().inventory
468
 
 
469
 
 
470
 
 
471
 
def cmd_dump_new_inventory():
472
 
    import bzrlib.newinventory
473
 
    inv = Branch('.').basis_tree().inventory
474
 
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
475
 
 
476
 
 
477
 
def cmd_load_new_inventory():
478
 
    import bzrlib.newinventory
479
 
    bzrlib.newinventory.read_new_inventory(sys.stdin)
480
 
                
481
 
    
482
 
def cmd_dump_slacker_inventory():
483
 
    import bzrlib.newinventory
484
 
    inv = Branch('.').basis_tree().inventory
485
 
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
486
 
                
487
 
    
488
 
 
489
 
def cmd_root(filename=None):
490
 
    """Print the branch root."""
491
 
    print bzrlib.branch.find_branch_root(filename)
492
 
    
493
 
 
494
 
def cmd_log(timezone='original'):
495
 
    """Show log of this branch.
496
 
 
497
 
    :todo: Options for utc; to show ids; to limit range; etc.
498
 
    """
499
 
    Branch('.').write_log(show_timezone=timezone)
500
 
 
501
 
 
502
 
def cmd_ls(revision=None, verbose=False):
503
 
    """List files in a tree.
504
 
 
505
 
    :todo: Take a revision or remote path and list that tree instead.
506
 
    """
507
 
    b = Branch('.')
508
 
    if revision == None:
509
 
        tree = b.working_tree()
510
 
    else:
511
 
        tree = b.revision_tree(b.lookup_revision(revision))
512
 
        
513
 
    for fp, fc, kind, fid in tree.list_files():
514
 
        if verbose:
515
 
            if kind == 'directory':
516
 
                kindch = '/'
517
 
            elif kind == 'file':
518
 
                kindch = ''
519
 
            else:
520
 
                kindch = '???'
521
 
                
522
 
            print '%-8s %s%s' % (fc, fp, kindch)
523
 
        else:
524
 
            print fp
525
 
    
526
 
    
527
 
 
528
 
def cmd_unknowns():
529
 
    """List unknown files"""
530
 
    for f in Branch('.').unknowns():
531
 
        print quotefn(f)
532
 
 
533
 
 
534
 
 
535
 
def cmd_ignored(verbose=True):
536
 
    """List ignored files and the patterns that matched them.
537
 
      """
538
 
    tree = Branch('.').working_tree()
539
 
    for path, file_class, kind, id in tree.list_files():
540
 
        if file_class != 'I':
541
 
            continue
542
 
        ## XXX: Slightly inefficient since this was already calculated
543
 
        pat = tree.is_ignored(path)
544
 
        print '%-50s %s' % (path, pat)
545
 
 
546
 
 
547
 
def cmd_lookup_revision(revno):
548
 
    try:
549
 
        revno = int(revno)
550
 
    except ValueError:
551
 
        bailout("usage: lookup-revision REVNO",
552
 
                ["REVNO is a non-negative revision number for this branch"])
553
 
 
554
 
    print Branch('.').lookup_revision(revno) or NONE_STRING
555
 
 
556
 
 
557
 
 
558
 
def cmd_export(revno, dest):
559
 
    """Export past revision to destination directory."""
560
 
    b = Branch('.')
561
 
    rh = b.lookup_revision(int(revno))
562
 
    t = b.revision_tree(rh)
563
 
    t.export(dest)
564
 
 
565
 
def cmd_cat(revision, filename):
566
 
    """Print file to stdout."""
567
 
    b = Branch('.')
568
 
    b.print_file(b.relpath(filename), int(revision))
569
 
 
570
 
 
571
 
######################################################################
572
 
# internal/test commands
573
 
 
574
 
 
575
 
def cmd_uuid():
576
 
    """Print a newly-generated UUID."""
577
 
    print bzrlib.osutils.uuid()
578
 
 
579
 
 
580
 
 
581
 
def cmd_local_time_offset():
582
 
    print bzrlib.osutils.local_time_offset()
583
 
 
584
 
 
585
 
 
586
 
def cmd_commit(message=None, verbose=False):
587
 
    """Commit changes to a new revision.
588
 
 
589
 
--message MESSAGE
590
 
    Description of changes in this revision; free form text.
591
 
    It is recommended that the first line be a single-sentence
592
 
    summary.
593
 
--verbose
594
 
    Show status of changed files,
595
 
 
596
 
TODO: Commit only selected files.
597
 
 
598
 
TODO: Run hooks on tree to-be-committed, and after commit.
599
 
 
600
 
TODO: Strict commit that fails if there are unknown or deleted files.
601
 
"""
602
 
 
603
 
    if not message:
604
 
        bailout("please specify a commit message")
605
 
    Branch('.').commit(message, verbose=verbose)
606
 
 
607
 
 
608
 
def cmd_check(dir='.'):
609
 
    """check: Consistency check of branch history.
610
 
 
611
 
usage: bzr check [-v] [BRANCH]
612
 
 
613
 
options:
614
 
  --verbose, -v         Show progress of checking.
615
 
 
616
 
This command checks various invariants about the branch storage to
617
 
detect data corruption or bzr bugs.
618
 
"""
619
 
    import bzrlib.check
620
 
    bzrlib.check.check(Branch(dir, find_root=False))
621
 
 
622
 
 
623
 
def cmd_is(pred, *rest):
624
 
    """Test whether PREDICATE is true."""
625
 
    try:
626
 
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
627
 
    except KeyError:
628
 
        bailout("unknown predicate: %s" % quotefn(pred))
629
 
        
630
 
    try:
631
 
        cmd_handler(*rest)
632
 
    except BzrCheckError:
633
 
        # by default we don't print the message so that this can
634
 
        # be used from shell scripts without producing noise
635
 
        sys.exit(1)
636
 
 
637
 
 
638
 
def cmd_username():
639
 
    print bzrlib.osutils.username()
640
 
 
641
 
 
642
 
def cmd_user_email():
643
 
    print bzrlib.osutils.user_email()
644
 
 
645
 
 
646
 
def cmd_gen_revision_id():
647
 
    import time
648
 
    print bzrlib.branch._gen_revision_id(time.time())
649
 
 
650
 
 
651
 
def cmd_selftest(verbose=False):
652
 
    """Run internal test suite"""
653
 
    ## -v, if present, is seen by doctest; the argument is just here
654
 
    ## so our parser doesn't complain
655
 
 
656
 
    ## TODO: --verbose option
657
 
 
658
 
    failures, tests = 0, 0
659
 
    
660
 
    import doctest, bzrlib.store, bzrlib.tests
661
 
    bzrlib.trace.verbose = False
662
 
 
663
 
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
664
 
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
665
 
        mf, mt = doctest.testmod(m)
666
 
        failures += mf
667
 
        tests += mt
668
 
        print '%-40s %3d tests' % (m.__name__, mt),
669
 
        if mf:
670
 
            print '%3d FAILED!' % mf
671
 
        else:
672
 
            print
673
 
 
674
 
    print '%-40s %3d tests' % ('total', tests),
675
 
    if failures:
676
 
        print '%3d FAILED!' % failures
677
 
    else:
678
 
        print
679
 
 
680
 
 
681
 
 
682
 
# deprecated
683
 
cmd_doctest = cmd_selftest
684
 
 
685
 
 
686
 
######################################################################
687
 
# help
688
 
 
689
 
 
690
 
def cmd_help(topic=None):
691
 
    if topic == None:
692
 
        print __doc__
693
 
        return
694
 
 
695
 
    # otherwise, maybe the name of a command?
696
 
    try:
697
 
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
698
 
    except KeyError:
699
 
        bailout("no help for %r" % topic)
700
 
 
701
 
    doc = cmdfn.__doc__
702
 
    if doc == None:
703
 
        bailout("sorry, no detailed help yet for %r" % topic)
704
 
 
705
 
    print doc
706
 
        
707
 
 
708
 
 
709
 
 
710
 
def cmd_version():
711
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
712
 
    print bzrlib.__copyright__
713
 
    print "http://bazaar-ng.org/"
714
 
    print
715
 
    print \
716
 
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
717
 
you may use, modify and redistribute it under the terms of the GNU 
718
 
General Public License version 2 or later."""
719
 
 
720
 
 
721
 
def cmd_rocks():
722
 
    """Statement of optimism."""
723
 
    print "it sure does!"
724
 
 
725
 
 
726
 
 
727
 
######################################################################
728
 
# main routine
729
 
 
730
 
 
731
 
# list of all available options; the rhs can be either None for an
732
 
# option that takes no argument, or a constructor function that checks
733
 
# the type.
734
 
OPTIONS = {
735
 
    'all':                    None,
736
 
    'help':                   None,
737
 
    'message':                unicode,
738
 
    'profile':                None,
739
 
    'revision':               int,
740
 
    'show-ids':               None,
741
 
    'timezone':               str,
742
 
    'verbose':                None,
743
 
    'version':                None,
744
 
    }
745
 
 
746
 
SHORT_OPTIONS = {
747
 
    'm':                      'message',
748
 
    'r':                      'revision',
749
 
    'v':                      'verbose',
750
 
}
751
 
 
752
 
# List of options that apply to particular commands; commands not
753
 
# listed take none.
754
 
cmd_options = {
755
 
    'add':                    ['verbose'],
756
 
    'cat':                    ['revision'],
757
 
    'commit':                 ['message', 'verbose'],
758
 
    'deleted':                ['show-ids'],
759
 
    'diff':                   ['revision'],
760
 
    'inventory':              ['revision'],
761
 
    'log':                    ['timezone'],
762
 
    'ls':                     ['revision', 'verbose'],
763
 
    'remove':                 ['verbose'],
764
 
    'status':                 ['all'],
765
 
    }
766
 
 
767
 
 
768
 
cmd_args = {
769
 
    'add':                    ['file+'],
770
 
    'cat':                    ['filename'],
771
 
    'commit':                 [],
772
 
    'diff':                   [],
773
 
    'export':                 ['revno', 'dest'],
774
 
    'file-id':                ['filename'],
775
 
    'file-id-path':           ['filename'],
776
 
    'get-file-text':          ['text_id'],
777
 
    'get-inventory':          ['inventory_id'],
778
 
    'get-revision':           ['revision_id'],
779
 
    'get-revision-inventory': ['revision_id'],
780
 
    'help':                   ['topic?'],
781
 
    'init':                   [],
782
 
    'log':                    [],
783
 
    'lookup-revision':        ['revno'],
784
 
    'move':                   ['source$', 'dest'],
785
 
    'relpath':                ['filename'],
786
 
    'remove':                 ['file+'],
787
 
    'rename':                 ['from_name', 'to_name'],
788
 
    'renames':                ['dir?'],
789
 
    'root':                   ['filename?'],
790
 
    'status':                 [],
791
 
    }
792
 
 
793
 
 
794
 
def parse_args(argv):
795
 
    """Parse command line.
796
 
    
797
 
    Arguments and options are parsed at this level before being passed
798
 
    down to specific command handlers.  This routine knows, from a
799
 
    lookup table, something about the available options, what optargs
800
 
    they take, and which commands will accept them.
801
 
 
802
 
    >>> parse_args('--help'.split())
803
 
    ([], {'help': True})
804
 
    >>> parse_args('--version'.split())
805
 
    ([], {'version': True})
806
 
    >>> parse_args('status --all'.split())
807
 
    (['status'], {'all': True})
808
 
    >>> parse_args('commit --message=biter'.split())
809
 
    (['commit'], {'message': u'biter'})
810
 
    """
811
 
    args = []
812
 
    opts = {}
813
 
 
814
 
    # TODO: Maybe handle '--' to end options?
815
 
 
816
 
    while argv:
817
 
        a = argv.pop(0)
818
 
        if a[0] == '-':
819
 
            optarg = None
820
 
            if a[1] == '-':
821
 
                mutter("  got option %r" % a)
822
 
                if '=' in a:
823
 
                    optname, optarg = a[2:].split('=', 1)
824
 
                else:
825
 
                    optname = a[2:]
826
 
                if optname not in OPTIONS:
827
 
                    bailout('unknown long option %r' % a)
828
 
            else:
829
 
                shortopt = a[1:]
830
 
                if shortopt not in SHORT_OPTIONS:
831
 
                    bailout('unknown short option %r' % a)
832
 
                optname = SHORT_OPTIONS[shortopt]
833
 
            
834
 
            if optname in opts:
835
 
                # XXX: Do we ever want to support this, e.g. for -r?
836
 
                bailout('repeated option %r' % a)
837
 
                
838
 
            optargfn = OPTIONS[optname]
839
 
            if optargfn:
840
 
                if optarg == None:
841
 
                    if not argv:
842
 
                        bailout('option %r needs an argument' % a)
843
 
                    else:
844
 
                        optarg = argv.pop(0)
845
 
                opts[optname] = optargfn(optarg)
846
 
            else:
847
 
                if optarg != None:
848
 
                    bailout('option %r takes no argument' % optname)
849
 
                opts[optname] = True
850
 
        else:
851
 
            args.append(a)
852
 
 
853
 
    return args, opts
854
 
 
855
 
 
856
 
 
857
 
def _match_args(cmd, args):
858
 
    """Check non-option arguments match required pattern.
859
 
 
860
 
    >>> _match_args('status', ['asdasdsadasd'])
861
 
    Traceback (most recent call last):
862
 
    ...
863
 
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
864
 
    >>> _match_args('add', ['asdasdsadasd'])
865
 
    {'file_list': ['asdasdsadasd']}
866
 
    >>> _match_args('add', 'abc def gj'.split())
867
 
    {'file_list': ['abc', 'def', 'gj']}
868
 
    """
869
 
    # match argument pattern
870
 
    argform = cmd_args.get(cmd, [])
871
 
    argdict = {}
872
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
873
 
    # all but one.
874
 
 
875
 
    # step through args and argform, allowing appropriate 0-many matches
876
 
    for ap in argform:
877
 
        argname = ap[:-1]
878
 
        if ap[-1] == '?':
879
 
            if args:
880
 
                argdict[argname] = args.pop(0)
881
 
        elif ap[-1] == '*':
882
 
            assert 0
883
 
        elif ap[-1] == '+':
884
 
            if not args:
885
 
                bailout("command %r needs one or more %s"
886
 
                        % (cmd, argname.upper()))
887
 
            else:
888
 
                argdict[argname + '_list'] = args[:]
889
 
                args = []
890
 
        elif ap[-1] == '$': # all but one
891
 
            if len(args) < 2:
892
 
                bailout("command %r needs one or more %s"
893
 
                        % (cmd, argname.upper()))
894
 
            argdict[argname + '_list'] = args[:-1]
895
 
            args[:-1] = []                
896
 
        else:
897
 
            # just a plain arg
898
 
            argname = ap
899
 
            if not args:
900
 
                bailout("command %r requires argument %s"
901
 
                        % (cmd, argname.upper()))
902
 
            else:
903
 
                argdict[argname] = args.pop(0)
904
 
            
905
 
    if args:
906
 
        bailout("extra arguments to command %s: %r"
907
 
                % (cmd, args))
908
 
 
909
 
    return argdict
910
 
 
911
 
 
912
 
 
913
 
def run_bzr(argv):
914
 
    """Execute a command.
915
 
 
916
 
    This is similar to main(), but without all the trappings for
917
 
    logging and error handling.
918
 
    """
919
 
    try:
920
 
        args, opts = parse_args(argv[1:])
921
 
        if 'help' in opts:
922
 
            # TODO: pass down other arguments in case they asked for
923
 
            # help on a command name?
924
 
            if args:
925
 
                cmd_help(args[0])
926
 
            else:
927
 
                cmd_help()
928
 
            return 0
929
 
        elif 'version' in opts:
930
 
            cmd_version()
931
 
            return 0
932
 
        cmd = args.pop(0)
933
 
    except IndexError:
934
 
        log_error('usage: bzr COMMAND\n')
935
 
        log_error('  try "bzr help"\n')
936
 
        return 1
937
 
 
938
 
    try:
939
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
940
 
    except KeyError:
941
 
        bailout("unknown command " + `cmd`)
942
 
 
943
 
    # global option
944
 
    if 'profile' in opts:
945
 
        profile = True
946
 
        del opts['profile']
947
 
    else:
948
 
        profile = False
949
 
 
950
 
    # check options are reasonable
951
 
    allowed = cmd_options.get(cmd, [])
952
 
    for oname in opts:
953
 
        if oname not in allowed:
954
 
            bailout("option %r is not allowed for command %r"
955
 
                    % (oname, cmd))
956
 
 
957
 
    # TODO: give an error if there are any mandatory options which are
958
 
    # not specified?  Or maybe there shouldn't be any "mandatory
959
 
    # options" (it is an oxymoron)
960
 
 
961
 
    # mix arguments and options into one dictionary
962
 
    cmdargs = _match_args(cmd, args)
963
 
    for k, v in opts.items():
964
 
        cmdargs[k.replace('-', '_')] = v
965
 
 
966
 
    if profile:
967
 
        import hotshot
968
 
        prof = hotshot.Profile('.bzr.profile')
969
 
        ret = prof.runcall(cmd_handler, **cmdargs) or 0
970
 
        prof.close()
971
 
 
972
 
        import hotshot.stats
973
 
        stats = hotshot.stats.load('.bzr.profile')
974
 
        #stats.strip_dirs()
975
 
        stats.sort_stats('time')
976
 
        stats.print_stats(20)
977
 
    else:
978
 
        return cmd_handler(**cmdargs) or 0
979
 
 
980
 
 
981
 
 
982
 
def main(argv):
983
 
    ## TODO: Handle command-line options; probably know what options are valid for
984
 
    ## each command
985
 
 
986
 
    ## TODO: If the arguments are wrong, give a usage message rather
987
 
    ## than just a backtrace.
988
 
 
989
 
    bzrlib.trace.create_tracefile(argv)
990
 
    
991
 
    try:
992
 
        ret = run_bzr(argv)
993
 
        return ret
994
 
    except BzrError, e:
995
 
        log_error('bzr: error: ' + e.args[0] + '\n')
996
 
        if len(e.args) > 1:
997
 
            for h in e.args[1]:
998
 
                log_error('  ' + h + '\n')
999
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
1000
 
        log_error('see ~/.bzr.log for more information\n')
1001
 
        return 1
1002
 
    except Exception, e:
1003
 
        log_error('bzr: exception: %s\n' % e)
1004
 
        log_error('    see .bzr.log for details\n')
1005
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
1006
 
        traceback.print_exc(None, sys.stderr)
1007
 
        return 1
1008
 
 
1009
 
    # TODO: Maybe nicer handling of IOError?
1010
 
 
1011
 
 
1012
 
 
1013
 
if __name__ == '__main__':
1014
 
    sys.exit(main(sys.argv))
1015
 
    ##import profile
1016
 
    ##profile.run('main(sys.argv)')
1017