/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: Martin Pool
  • Date: 2005-05-06 03:20:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050506032014-decf4918803147d2
- split out notes on storing annotations in revfiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
 
 
19
import sys, os, time, os.path
 
20
from sets import Set
 
21
 
 
22
import bzrlib
 
23
from bzrlib.trace import mutter, note, log_error
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
27
from bzrlib.revision import Revision
 
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
 
29
     format_date
 
30
 
 
31
 
 
32
def _squish_command_name(cmd):
 
33
    return 'cmd_' + cmd.replace('-', '_')
 
34
 
 
35
 
 
36
def _unsquish_command_name(cmd):
 
37
    assert cmd.startswith("cmd_")
 
38
    return cmd[4:].replace('_','-')
 
39
 
 
40
def get_all_cmds():
 
41
    """Return canonical name and class for all registered commands."""
 
42
    for k, v in globals().iteritems():
 
43
        if k.startswith("cmd_"):
 
44
            yield _unsquish_command_name(k), v
 
45
 
 
46
def get_cmd_class(cmd):
 
47
    """Return the canonical name and command class for a command.
 
48
    """
 
49
    cmd = str(cmd)                      # not unicode
 
50
 
 
51
    # first look up this command under the specified name
 
52
    try:
 
53
        return cmd, globals()[_squish_command_name(cmd)]
 
54
    except KeyError:
 
55
        pass
 
56
 
 
57
    # look for any command which claims this as an alias
 
58
    for cmdname, cmdclass in get_all_cmds():
 
59
        if cmd in cmdclass.aliases:
 
60
            return cmdname, cmdclass
 
61
    else:
 
62
        raise BzrCommandError("unknown command %r" % cmd)
 
63
 
 
64
 
 
65
class Command:
 
66
    """Base class for commands.
 
67
 
 
68
    The docstring for an actual command should give a single-line
 
69
    summary, then a complete description of the command.  A grammar
 
70
    description will be inserted.
 
71
 
 
72
    takes_args
 
73
        List of argument forms, marked with whether they are optional,
 
74
        repeated, etc.
 
75
 
 
76
    takes_options
 
77
        List of options that may be given for this command.
 
78
 
 
79
    hidden
 
80
        If true, this command isn't advertised.
 
81
    """
 
82
    aliases = []
 
83
    
 
84
    takes_args = []
 
85
    takes_options = []
 
86
 
 
87
    hidden = False
 
88
    
 
89
    def __init__(self, options, arguments):
 
90
        """Construct and run the command.
 
91
 
 
92
        Sets self.status to the return value of run()."""
 
93
        assert isinstance(options, dict)
 
94
        assert isinstance(arguments, dict)
 
95
        cmdargs = options.copy()
 
96
        cmdargs.update(arguments)
 
97
        assert self.__doc__ != Command.__doc__, \
 
98
               ("No help message set for %r" % self)
 
99
        self.status = self.run(**cmdargs)
 
100
 
 
101
    
 
102
    def run(self):
 
103
        """Override this in sub-classes.
 
104
 
 
105
        This is invoked with the options and arguments bound to
 
106
        keyword parameters.
 
107
 
 
108
        Return 0 or None if the command was successful, or a shell
 
109
        error code if not.
 
110
        """
 
111
        return 0
 
112
 
 
113
 
 
114
 
 
115
class cmd_status(Command):
 
116
    """Display status summary.
 
117
 
 
118
    For each file there is a single line giving its file state and name.
 
119
    The name is that in the current revision unless it is deleted or
 
120
    missing, in which case the old name is shown.
 
121
    """
 
122
    takes_options = ['all']
 
123
    aliases = ['st', 'stat']
 
124
    
 
125
    def run(self, all=False):
 
126
        #import bzrlib.status
 
127
        #bzrlib.status.tree_status(Branch('.'))
 
128
        Branch('.').show_status(show_all=all)
 
129
 
 
130
 
 
131
class cmd_cat_revision(Command):
 
132
    """Write out metadata for a revision."""
 
133
 
 
134
    hidden = True
 
135
    takes_args = ['revision_id']
 
136
    
 
137
    def run(self, revision_id):
 
138
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
139
 
 
140
 
 
141
class cmd_revno(Command):
 
142
    """Show current revision number.
 
143
 
 
144
    This is equal to the number of revisions on this branch."""
 
145
    def run(self):
 
146
        print Branch('.').revno()
 
147
 
 
148
    
 
149
class cmd_add(Command):
 
150
    """Add specified files or directories.
 
151
 
 
152
    In non-recursive mode, all the named items are added, regardless
 
153
    of whether they were previously ignored.  A warning is given if
 
154
    any of the named files are already versioned.
 
155
 
 
156
    In recursive mode (the default), files are treated the same way
 
157
    but the behaviour for directories is different.  Directories that
 
158
    are already versioned do not give a warning.  All directories,
 
159
    whether already versioned or not, are searched for files or
 
160
    subdirectories that are neither versioned or ignored, and these
 
161
    are added.  This search proceeds recursively into versioned
 
162
    directories.
 
163
 
 
164
    Therefore simply saying 'bzr add .' will version all files that
 
165
    are currently unknown.
 
166
 
 
167
    TODO: Perhaps adding a file whose directly is not versioned should
 
168
    recursively add that parent, rather than giving an error?
 
169
    """
 
170
    takes_args = ['file+']
 
171
    takes_options = ['verbose']
 
172
    
 
173
    def run(self, file_list, verbose=False):
 
174
        bzrlib.add.smart_add(file_list, verbose)
 
175
 
 
176
 
 
177
class cmd_relpath(Command):
 
178
    """Show path of a file relative to root"""
 
179
    takes_args = ('filename')
 
180
    
 
181
    def run(self):
 
182
        print Branch(self.args['filename']).relpath(filename)
 
183
 
 
184
 
 
185
 
 
186
class cmd_inventory(Command):
 
187
    """Show inventory of the current working copy or a revision."""
 
188
    takes_options = ['revision']
 
189
    
 
190
    def run(self, revision=None):
 
191
        b = Branch('.')
 
192
        if revision == None:
 
193
            inv = b.read_working_inventory()
 
194
        else:
 
195
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
196
 
 
197
        for path, entry in inv.iter_entries():
 
198
            print '%-50s %s' % (entry.file_id, path)
 
199
 
 
200
 
 
201
class cmd_move(Command):
 
202
    """Move files to a different directory.
 
203
 
 
204
    examples:
 
205
        bzr move *.txt doc
 
206
 
 
207
    The destination must be a versioned directory in the same branch.
 
208
    """
 
209
    takes_args = ['source$', 'dest']
 
210
    def run(self, source_list, dest):
 
211
        b = Branch('.')
 
212
 
 
213
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
214
 
 
215
 
 
216
class cmd_rename(Command):
 
217
    """Change the name of an entry.
 
218
 
 
219
    examples:
 
220
      bzr rename frob.c frobber.c
 
221
      bzr rename src/frob.c lib/frob.c
 
222
 
 
223
    It is an error if the destination name exists.
 
224
 
 
225
    See also the 'move' command, which moves files into a different
 
226
    directory without changing their name.
 
227
 
 
228
    TODO: Some way to rename multiple files without invoking bzr for each
 
229
    one?"""
 
230
    takes_args = ['from_name', 'to_name']
 
231
    
 
232
    def run(self, from_name, to_name):
 
233
        b = Branch('.')
 
234
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
235
 
 
236
 
 
237
 
 
238
class cmd_renames(Command):
 
239
    """Show list of renamed files.
 
240
 
 
241
    TODO: Option to show renames between two historical versions.
 
242
 
 
243
    TODO: Only show renames under dir, rather than in the whole branch.
 
244
    """
 
245
    takes_args = ['dir?']
 
246
 
 
247
    def run(self, dir='.'):
 
248
        b = Branch(dir)
 
249
        old_inv = b.basis_tree().inventory
 
250
        new_inv = b.read_working_inventory()
 
251
 
 
252
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
253
        renames.sort()
 
254
        for old_name, new_name in renames:
 
255
            print "%s => %s" % (old_name, new_name)        
 
256
 
 
257
 
 
258
class cmd_info(Command):
 
259
    """Show statistical information for this branch"""
 
260
    def run(self):
 
261
        import info
 
262
        info.show_info(Branch('.'))        
 
263
 
 
264
 
 
265
class cmd_remove(Command):
 
266
    """Make a file unversioned.
 
267
 
 
268
    This makes bzr stop tracking changes to a versioned file.  It does
 
269
    not delete the working copy.
 
270
    """
 
271
    takes_args = ['file+']
 
272
    takes_options = ['verbose']
 
273
    
 
274
    def run(self, file_list, verbose=False):
 
275
        b = Branch(file_list[0])
 
276
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
277
 
 
278
 
 
279
class cmd_file_id(Command):
 
280
    """Print file_id of a particular file or directory.
 
281
 
 
282
    The file_id is assigned when the file is first added and remains the
 
283
    same through all revisions where the file exists, even when it is
 
284
    moved or renamed.
 
285
    """
 
286
    hidden = True
 
287
    takes_args = ['filename']
 
288
    def run(self, filename):
 
289
        b = Branch(filename)
 
290
        i = b.inventory.path2id(b.relpath(filename))
 
291
        if i == None:
 
292
            bailout("%r is not a versioned file" % filename)
 
293
        else:
 
294
            print i
 
295
 
 
296
 
 
297
class cmd_file_path(Command):
 
298
    """Print path of file_ids to a file or directory.
 
299
 
 
300
    This prints one line for each directory down to the target,
 
301
    starting at the branch root."""
 
302
    hidden = True
 
303
    takes_args = ['filename']
 
304
    def run(self, filename):
 
305
        b = Branch(filename)
 
306
        inv = b.inventory
 
307
        fid = inv.path2id(b.relpath(filename))
 
308
        if fid == None:
 
309
            bailout("%r is not a versioned file" % filename)
 
310
        for fip in inv.get_idpath(fid):
 
311
            print fip
 
312
 
 
313
 
 
314
class cmd_revision_history(Command):
 
315
    """Display list of revision ids on this branch."""
 
316
    def run(self):
 
317
        for patchid in Branch('.').revision_history():
 
318
            print patchid
 
319
 
 
320
 
 
321
class cmd_directories(Command):
 
322
    """Display list of versioned directories in this branch."""
 
323
    def run(self):
 
324
        for name, ie in Branch('.').read_working_inventory().directories():
 
325
            if name == '':
 
326
                print '.'
 
327
            else:
 
328
                print name
 
329
 
 
330
 
 
331
class cmd_init(Command):
 
332
    """Make a directory into a versioned branch.
 
333
 
 
334
    Use this to create an empty branch, or before importing an
 
335
    existing project.
 
336
 
 
337
    Recipe for importing a tree of files:
 
338
        cd ~/project
 
339
        bzr init
 
340
        bzr add -v .
 
341
        bzr status
 
342
        bzr commit -m 'imported project'
 
343
    """
 
344
    def run(self):
 
345
        Branch('.', init=True)
 
346
 
 
347
 
 
348
class cmd_diff(Command):
 
349
    """Show differences in working tree.
 
350
    
 
351
    If files are listed, only the changes in those files are listed.
 
352
    Otherwise, all changes for the tree are listed.
 
353
 
 
354
    TODO: Given two revision arguments, show the difference between them.
 
355
 
 
356
    TODO: Allow diff across branches.
 
357
 
 
358
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
359
          or a graphical diff.
 
360
 
 
361
    TODO: Python difflib is not exactly the same as unidiff; should
 
362
          either fix it up or prefer to use an external diff.
 
363
 
 
364
    TODO: If a directory is given, diff everything under that.
 
365
 
 
366
    TODO: Selected-file diff is inefficient and doesn't show you
 
367
          deleted files.
 
368
 
 
369
    TODO: This probably handles non-Unix newlines poorly.
 
370
    """
 
371
    
 
372
    takes_args = ['file*']
 
373
    takes_options = ['revision']
 
374
    aliases = ['di']
 
375
 
 
376
    def run(self, revision=None, file_list=None):
 
377
        from bzrlib.diff import show_diff
 
378
    
 
379
        show_diff(Branch('.'), revision, file_list)
 
380
 
 
381
 
 
382
class cmd_deleted(Command):
 
383
    """List files deleted in the working tree.
 
384
 
 
385
    TODO: Show files deleted since a previous revision, or between two revisions.
 
386
    """
 
387
    def run(self, show_ids=False):
 
388
        b = Branch('.')
 
389
        old = b.basis_tree()
 
390
        new = b.working_tree()
 
391
 
 
392
        ## TODO: Much more efficient way to do this: read in new
 
393
        ## directories with readdir, rather than stating each one.  Same
 
394
        ## level of effort but possibly much less IO.  (Or possibly not,
 
395
        ## if the directories are very large...)
 
396
 
 
397
        for path, ie in old.inventory.iter_entries():
 
398
            if not new.has_id(ie.file_id):
 
399
                if show_ids:
 
400
                    print '%-50s %s' % (path, ie.file_id)
 
401
                else:
 
402
                    print path
 
403
 
 
404
class cmd_root(Command):
 
405
    """Show the tree root directory.
 
406
 
 
407
    The root is the nearest enclosing directory with a .bzr control
 
408
    directory."""
 
409
    takes_args = ['filename?']
 
410
    def run(self, filename=None):
 
411
        """Print the branch root."""
 
412
        print bzrlib.branch.find_branch_root(filename)
 
413
 
 
414
 
 
415
 
 
416
class cmd_log(Command):
 
417
    """Show log of this branch.
 
418
 
 
419
    TODO: Option to limit range.
 
420
 
 
421
    TODO: Perhaps show most-recent first with an option for last.
 
422
    """
 
423
    takes_args = ['filename?']
 
424
    takes_options = ['timezone', 'verbose', 'show-ids']
 
425
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
 
426
        b = Branch((filename or '.'), lock_mode='r')
 
427
        if filename:
 
428
            filename = b.relpath(filename)
 
429
        bzrlib.show_log(b, filename,
 
430
                        show_timezone=timezone,
 
431
                        verbose=verbose,
 
432
                        show_ids=show_ids)
 
433
 
 
434
 
 
435
 
 
436
class cmd_touching_revisions(Command):
 
437
    """Return revision-ids which affected a particular file."""
 
438
    hidden = True
 
439
    takes_args = ["filename"]
 
440
    def run(self, filename):
 
441
        b = Branch(filename, lock_mode='r')
 
442
        inv = b.read_working_inventory()
 
443
        file_id = inv.path2id(b.relpath(filename))
 
444
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
445
            print "%6d %s" % (revno, what)
 
446
 
 
447
 
 
448
class cmd_ls(Command):
 
449
    """List files in a tree.
 
450
 
 
451
    TODO: Take a revision or remote path and list that tree instead.
 
452
    """
 
453
    hidden = True
 
454
    def run(self, revision=None, verbose=False):
 
455
        b = Branch('.')
 
456
        if revision == None:
 
457
            tree = b.working_tree()
 
458
        else:
 
459
            tree = b.revision_tree(b.lookup_revision(revision))
 
460
 
 
461
        for fp, fc, kind, fid in tree.list_files():
 
462
            if verbose:
 
463
                if kind == 'directory':
 
464
                    kindch = '/'
 
465
                elif kind == 'file':
 
466
                    kindch = ''
 
467
                else:
 
468
                    kindch = '???'
 
469
 
 
470
                print '%-8s %s%s' % (fc, fp, kindch)
 
471
            else:
 
472
                print fp
 
473
 
 
474
 
 
475
 
 
476
class cmd_unknowns(Command):
 
477
    """List unknown files"""
 
478
    def run(self):
 
479
        for f in Branch('.').unknowns():
 
480
            print quotefn(f)
 
481
 
 
482
 
 
483
 
 
484
class cmd_ignore(Command):
 
485
    """Ignore a command or pattern"""
 
486
    takes_args = ['name_pattern']
 
487
    
 
488
    def run(self, name_pattern):
 
489
        b = Branch('.')
 
490
 
 
491
        # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
 
492
        f = open(b.abspath('.bzrignore'), 'at')
 
493
        f.write(name_pattern + '\n')
 
494
        f.close()
 
495
 
 
496
        inv = b.working_tree().inventory
 
497
        if inv.path2id('.bzrignore'):
 
498
            mutter('.bzrignore is already versioned')
 
499
        else:
 
500
            mutter('need to make new .bzrignore file versioned')
 
501
            b.add(['.bzrignore'])
 
502
 
 
503
 
 
504
 
 
505
class cmd_ignored(Command):
 
506
    """List ignored files and the patterns that matched them."""
 
507
    def run(self):
 
508
        tree = Branch('.').working_tree()
 
509
        for path, file_class, kind, file_id in tree.list_files():
 
510
            if file_class != 'I':
 
511
                continue
 
512
            ## XXX: Slightly inefficient since this was already calculated
 
513
            pat = tree.is_ignored(path)
 
514
            print '%-50s %s' % (path, pat)
 
515
 
 
516
 
 
517
class cmd_lookup_revision(Command):
 
518
    """Lookup the revision-id from a revision-number
 
519
 
 
520
    example:
 
521
        bzr lookup-revision 33
 
522
        """
 
523
    hidden = True
 
524
    takes_args = ['revno']
 
525
    
 
526
    def run(self, revno):
 
527
        try:
 
528
            revno = int(revno)
 
529
        except ValueError:
 
530
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
531
 
 
532
        print Branch('.').lookup_revision(revno)
 
533
 
 
534
 
 
535
class cmd_export(Command):
 
536
    """Export past revision to destination directory.
 
537
 
 
538
    If no revision is specified this exports the last committed revision."""
 
539
    takes_args = ['dest']
 
540
    takes_options = ['revision']
 
541
    def run(self, dest, revno=None):
 
542
        b = Branch('.')
 
543
        if revno == None:
 
544
            rh = b.revision_history[-1]
 
545
        else:
 
546
            rh = b.lookup_revision(int(revno))
 
547
        t = b.revision_tree(rh)
 
548
        t.export(dest)
 
549
 
 
550
 
 
551
class cmd_cat(Command):
 
552
    """Write a file's text from a previous revision."""
 
553
 
 
554
    takes_options = ['revision']
 
555
    takes_args = ['filename']
 
556
 
 
557
    def run(self, filename, revision=None):
 
558
        if revision == None:
 
559
            raise BzrCommandError("bzr cat requires a revision number")
 
560
        b = Branch('.')
 
561
        b.print_file(b.relpath(filename), int(revision))
 
562
 
 
563
 
 
564
class cmd_local_time_offset(Command):
 
565
    """Show the offset in seconds from GMT to local time."""
 
566
    hidden = True    
 
567
    def run(self):
 
568
        print bzrlib.osutils.local_time_offset()
 
569
 
 
570
 
 
571
 
 
572
class cmd_commit(Command):
 
573
    """Commit changes into a new revision.
 
574
 
 
575
    TODO: Commit only selected files.
 
576
 
 
577
    TODO: Run hooks on tree to-be-committed, and after commit.
 
578
 
 
579
    TODO: Strict commit that fails if there are unknown or deleted files.
 
580
    """
 
581
    takes_options = ['message', 'file', 'verbose']
 
582
    aliases = ['ci', 'checkin']
 
583
 
 
584
    def run(self, message=None, file=None, verbose=False):
 
585
        ## Warning: shadows builtin file()
 
586
        if not message and not file:
 
587
            raise BzrCommandError("please specify a commit message",
 
588
                                  ["use either --message or --file"])
 
589
        elif message and file:
 
590
            raise BzrCommandError("please specify either --message or --file")
 
591
        
 
592
        if file:
 
593
            import codecs
 
594
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
595
 
 
596
        Branch('.').commit(message, verbose=verbose)
 
597
 
 
598
 
 
599
class cmd_check(Command):
 
600
    """Validate consistency of branch history.
 
601
 
 
602
    This command checks various invariants about the branch storage to
 
603
    detect data corruption or bzr bugs.
 
604
    """
 
605
    takes_args = ['dir?']
 
606
    def run(self, dir='.'):
 
607
        import bzrlib.check
 
608
        bzrlib.check.check(Branch(dir, find_root=False))
 
609
 
 
610
 
 
611
 
 
612
class cmd_whoami(Command):
 
613
    """Show bzr user id."""
 
614
    takes_options = ['email']
 
615
    
 
616
    def run(self, email=False):
 
617
        if email:
 
618
            print bzrlib.osutils.user_email()
 
619
        else:
 
620
            print bzrlib.osutils.username()
 
621
 
 
622
 
 
623
class cmd_selftest(Command):
 
624
    """Run internal test suite"""
 
625
    hidden = True
 
626
    def run(self):
 
627
        failures, tests = 0, 0
 
628
 
 
629
        import doctest, bzrlib.store, bzrlib.tests
 
630
        bzrlib.trace.verbose = False
 
631
 
 
632
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
633
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
634
            mf, mt = doctest.testmod(m)
 
635
            failures += mf
 
636
            tests += mt
 
637
            print '%-40s %3d tests' % (m.__name__, mt),
 
638
            if mf:
 
639
                print '%3d FAILED!' % mf
 
640
            else:
 
641
                print
 
642
 
 
643
        print '%-40s %3d tests' % ('total', tests),
 
644
        if failures:
 
645
            print '%3d FAILED!' % failures
 
646
        else:
 
647
            print
 
648
 
 
649
 
 
650
 
 
651
class cmd_version(Command):
 
652
    """Show version of bzr"""
 
653
    def run(self):
 
654
        show_version()
 
655
 
 
656
def show_version():
 
657
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
658
    print bzrlib.__copyright__
 
659
    print "http://bazaar-ng.org/"
 
660
    print
 
661
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
662
    print "you may use, modify and redistribute it under the terms of the GNU"
 
663
    print "General Public License version 2 or later."
 
664
 
 
665
 
 
666
class cmd_rocks(Command):
 
667
    """Statement of optimism."""
 
668
    hidden = True
 
669
    def run(self):
 
670
        print "it sure does!"
 
671
 
 
672
 
 
673
class cmd_assert_fail(Command):
 
674
    """Test reporting of assertion failures"""
 
675
    hidden = True
 
676
    def run(self):
 
677
        assert False, "always fails"
 
678
 
 
679
 
 
680
class cmd_help(Command):
 
681
    """Show help on a command or other topic.
 
682
 
 
683
    For a list of all available commands, say 'bzr help commands'."""
 
684
    takes_args = ['topic?']
 
685
    aliases = ['?']
 
686
    
 
687
    def run(self, topic=None):
 
688
        import help
 
689
        help.help(topic)
 
690
 
 
691
 
 
692
######################################################################
 
693
# main routine
 
694
 
 
695
 
 
696
# list of all available options; the rhs can be either None for an
 
697
# option that takes no argument, or a constructor function that checks
 
698
# the type.
 
699
OPTIONS = {
 
700
    'all':                    None,
 
701
    'help':                   None,
 
702
    'file':                   unicode,
 
703
    'message':                unicode,
 
704
    'profile':                None,
 
705
    'revision':               int,
 
706
    'show-ids':               None,
 
707
    'timezone':               str,
 
708
    'verbose':                None,
 
709
    'version':                None,
 
710
    'email':                  None,
 
711
    }
 
712
 
 
713
SHORT_OPTIONS = {
 
714
    'm':                      'message',
 
715
    'F':                      'file', 
 
716
    'r':                      'revision',
 
717
    'v':                      'verbose',
 
718
}
 
719
 
 
720
 
 
721
def parse_args(argv):
 
722
    """Parse command line.
 
723
    
 
724
    Arguments and options are parsed at this level before being passed
 
725
    down to specific command handlers.  This routine knows, from a
 
726
    lookup table, something about the available options, what optargs
 
727
    they take, and which commands will accept them.
 
728
 
 
729
    >>> parse_args('--help'.split())
 
730
    ([], {'help': True})
 
731
    >>> parse_args('--version'.split())
 
732
    ([], {'version': True})
 
733
    >>> parse_args('status --all'.split())
 
734
    (['status'], {'all': True})
 
735
    >>> parse_args('commit --message=biter'.split())
 
736
    (['commit'], {'message': u'biter'})
 
737
    """
 
738
    args = []
 
739
    opts = {}
 
740
 
 
741
    # TODO: Maybe handle '--' to end options?
 
742
 
 
743
    while argv:
 
744
        a = argv.pop(0)
 
745
        if a[0] == '-':
 
746
            # option names must not be unicode
 
747
            a = str(a)
 
748
            optarg = None
 
749
            if a[1] == '-':
 
750
                mutter("  got option %r" % a)
 
751
                if '=' in a:
 
752
                    optname, optarg = a[2:].split('=', 1)
 
753
                else:
 
754
                    optname = a[2:]
 
755
                if optname not in OPTIONS:
 
756
                    bailout('unknown long option %r' % a)
 
757
            else:
 
758
                shortopt = a[1:]
 
759
                if shortopt not in SHORT_OPTIONS:
 
760
                    bailout('unknown short option %r' % a)
 
761
                optname = SHORT_OPTIONS[shortopt]
 
762
            
 
763
            if optname in opts:
 
764
                # XXX: Do we ever want to support this, e.g. for -r?
 
765
                bailout('repeated option %r' % a)
 
766
                
 
767
            optargfn = OPTIONS[optname]
 
768
            if optargfn:
 
769
                if optarg == None:
 
770
                    if not argv:
 
771
                        bailout('option %r needs an argument' % a)
 
772
                    else:
 
773
                        optarg = argv.pop(0)
 
774
                opts[optname] = optargfn(optarg)
 
775
            else:
 
776
                if optarg != None:
 
777
                    bailout('option %r takes no argument' % optname)
 
778
                opts[optname] = True
 
779
        else:
 
780
            args.append(a)
 
781
 
 
782
    return args, opts
 
783
 
 
784
 
 
785
 
 
786
 
 
787
def _match_argform(cmd, takes_args, args):
 
788
    argdict = {}
 
789
 
 
790
    # step through args and takes_args, allowing appropriate 0-many matches
 
791
    for ap in takes_args:
 
792
        argname = ap[:-1]
 
793
        if ap[-1] == '?':
 
794
            if args:
 
795
                argdict[argname] = args.pop(0)
 
796
        elif ap[-1] == '*': # all remaining arguments
 
797
            if args:
 
798
                argdict[argname + '_list'] = args[:]
 
799
                args = []
 
800
            else:
 
801
                argdict[argname + '_list'] = None
 
802
        elif ap[-1] == '+':
 
803
            if not args:
 
804
                raise BzrCommandError("command %r needs one or more %s"
 
805
                        % (cmd, argname.upper()))
 
806
            else:
 
807
                argdict[argname + '_list'] = args[:]
 
808
                args = []
 
809
        elif ap[-1] == '$': # all but one
 
810
            if len(args) < 2:
 
811
                raise BzrCommandError("command %r needs one or more %s"
 
812
                        % (cmd, argname.upper()))
 
813
            argdict[argname + '_list'] = args[:-1]
 
814
            args[:-1] = []                
 
815
        else:
 
816
            # just a plain arg
 
817
            argname = ap
 
818
            if not args:
 
819
                raise BzrCommandError("command %r requires argument %s"
 
820
                        % (cmd, argname.upper()))
 
821
            else:
 
822
                argdict[argname] = args.pop(0)
 
823
            
 
824
    if args:
 
825
        raise BzrCommandError("extra argument to command %s: %s"
 
826
                              % (cmd, args[0]))
 
827
 
 
828
    return argdict
 
829
 
 
830
 
 
831
 
 
832
def run_bzr(argv):
 
833
    """Execute a command.
 
834
 
 
835
    This is similar to main(), but without all the trappings for
 
836
    logging and error handling.  
 
837
    """
 
838
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
839
    
 
840
    try:
 
841
        args, opts = parse_args(argv[1:])
 
842
        if 'help' in opts:
 
843
            import help
 
844
            if args:
 
845
                help.help(args[0])
 
846
            else:
 
847
                help.help()
 
848
            return 0
 
849
        elif 'version' in opts:
 
850
            show_version()
 
851
            return 0
 
852
        cmd = str(args.pop(0))
 
853
    except IndexError:
 
854
        log_error('usage: bzr COMMAND')
 
855
        log_error('  try "bzr help"')
 
856
        return 1
 
857
 
 
858
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
859
 
 
860
    # global option
 
861
    if 'profile' in opts:
 
862
        profile = True
 
863
        del opts['profile']
 
864
    else:
 
865
        profile = False
 
866
 
 
867
    # check options are reasonable
 
868
    allowed = cmd_class.takes_options
 
869
    for oname in opts:
 
870
        if oname not in allowed:
 
871
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
872
                                  % (oname, cmd))
 
873
 
 
874
    # mix arguments and options into one dictionary
 
875
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
876
    cmdopts = {}
 
877
    for k, v in opts.items():
 
878
        cmdopts[k.replace('-', '_')] = v
 
879
 
 
880
    if profile:
 
881
        import hotshot, tempfile
 
882
        pffileno, pfname = tempfile.mkstemp()
 
883
        try:
 
884
            prof = hotshot.Profile(pfname)
 
885
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
886
            prof.close()
 
887
 
 
888
            import hotshot.stats
 
889
            stats = hotshot.stats.load(pfname)
 
890
            #stats.strip_dirs()
 
891
            stats.sort_stats('time')
 
892
            ## XXX: Might like to write to stderr or the trace file instead but
 
893
            ## print_stats seems hardcoded to stdout
 
894
            stats.print_stats(20)
 
895
            
 
896
            return ret.status
 
897
 
 
898
        finally:
 
899
            os.close(pffileno)
 
900
            os.remove(pfname)
 
901
    else:
 
902
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
903
 
 
904
 
 
905
def _report_exception(summary, quiet=False):
 
906
    import traceback
 
907
    log_error('bzr: ' + summary)
 
908
    bzrlib.trace.log_exception()
 
909
 
 
910
    if not quiet:
 
911
        tb = sys.exc_info()[2]
 
912
        exinfo = traceback.extract_tb(tb)
 
913
        if exinfo:
 
914
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
915
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
916
 
 
917
 
 
918
 
 
919
def main(argv):
 
920
    import errno
 
921
    
 
922
    bzrlib.open_tracefile(argv)
 
923
 
 
924
    try:
 
925
        try:
 
926
            try:
 
927
                return run_bzr(argv)
 
928
            finally:
 
929
                # do this here inside the exception wrappers to catch EPIPE
 
930
                sys.stdout.flush()
 
931
        except BzrError, e:
 
932
            quiet = isinstance(e, (BzrCommandError))
 
933
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
934
            if len(e.args) > 1:
 
935
                for h in e.args[1]:
 
936
                    # some explanation or hints
 
937
                    log_error('  ' + h)
 
938
            return 1
 
939
        except AssertionError, e:
 
940
            msg = 'assertion failed'
 
941
            if str(e):
 
942
                msg += ': ' + str(e)
 
943
            _report_exception(msg)
 
944
            return 2
 
945
        except KeyboardInterrupt, e:
 
946
            _report_exception('interrupted', quiet=True)
 
947
            return 2
 
948
        except Exception, e:
 
949
            quiet = False
 
950
            if isinstance(e, IOError) and e.errno == errno.EPIPE:
 
951
                quiet = True
 
952
                msg = 'broken pipe'
 
953
            else:
 
954
                msg = str(e).rstrip('\n')
 
955
            _report_exception(msg, quiet)
 
956
            return 2
 
957
    finally:
 
958
        bzrlib.trace.close_trace()
 
959
 
 
960
 
 
961
if __name__ == '__main__':
 
962
    sys.exit(main(sys.argv))