/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

  • Committer: mbp at sourcefrog
  • Date: 2005-04-06 02:20:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050406022039-dfbff590495c81193a32fd8b
- better output from test.sh- test.sh exercises cat command (currently broken)

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