/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-08 05:39:46 UTC
  • Revision ID: mbp@sourcefrog.net-20050408053946-1cb3415e1f8f58493034a5cf
- import lovely urlgrabber library

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