/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-09 06:09:42 UTC
  • Revision ID: mbp@sourcefrog.net-20050509060942-d9c9efd7feed0894
- more indicators at top of test output
- tidy up remotebranch stuff

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_args = ['file*']
 
123
    takes_options = ['all']
 
124
    aliases = ['st', 'stat']
 
125
    
 
126
    def run(self, all=False, file_list=None):
 
127
        b = Branch('.', lock_mode='r')
 
128
        b.show_status(show_all=all, file_list=file_list)
 
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, filename):
 
182
        print Branch(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
        from bzrlib.atomicfile import AtomicFile
 
490
        import codecs
 
491
 
 
492
        b = Branch('.')
 
493
        ifn = b.abspath('.bzrignore')
 
494
 
 
495
        # FIXME: probably doesn't handle non-ascii patterns
 
496
 
 
497
        if os.path.exists(ifn):
 
498
            f = b.controlfile(ifn, 'rt')
 
499
            igns = f.read()
 
500
            f.close()
 
501
        else:
 
502
            igns = ''
 
503
 
 
504
        if igns and igns[-1] != '\n':
 
505
            igns += '\n'
 
506
        igns += name_pattern + '\n'
 
507
 
 
508
        f = AtomicFile(ifn, 'wt')
 
509
        f.write(igns)
 
510
        f.commit()
 
511
 
 
512
        inv = b.working_tree().inventory
 
513
        if inv.path2id('.bzrignore'):
 
514
            mutter('.bzrignore is already versioned')
 
515
        else:
 
516
            mutter('need to make new .bzrignore file versioned')
 
517
            b.add(['.bzrignore'])
 
518
 
 
519
 
 
520
 
 
521
class cmd_ignored(Command):
 
522
    """List ignored files and the patterns that matched them."""
 
523
    def run(self):
 
524
        tree = Branch('.').working_tree()
 
525
        for path, file_class, kind, file_id in tree.list_files():
 
526
            if file_class != 'I':
 
527
                continue
 
528
            ## XXX: Slightly inefficient since this was already calculated
 
529
            pat = tree.is_ignored(path)
 
530
            print '%-50s %s' % (path, pat)
 
531
 
 
532
 
 
533
class cmd_lookup_revision(Command):
 
534
    """Lookup the revision-id from a revision-number
 
535
 
 
536
    example:
 
537
        bzr lookup-revision 33
 
538
        """
 
539
    hidden = True
 
540
    takes_args = ['revno']
 
541
    
 
542
    def run(self, revno):
 
543
        try:
 
544
            revno = int(revno)
 
545
        except ValueError:
 
546
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
547
 
 
548
        print Branch('.').lookup_revision(revno)
 
549
 
 
550
 
 
551
class cmd_export(Command):
 
552
    """Export past revision to destination directory.
 
553
 
 
554
    If no revision is specified this exports the last committed revision."""
 
555
    takes_args = ['dest']
 
556
    takes_options = ['revision']
 
557
    def run(self, dest, revision=None):
 
558
        b = Branch('.')
 
559
        if revision == None:
 
560
            rh = b.revision_history()[-1]
 
561
        else:
 
562
            rh = b.lookup_revision(int(revision))
 
563
        t = b.revision_tree(rh)
 
564
        t.export(dest)
 
565
 
 
566
 
 
567
class cmd_cat(Command):
 
568
    """Write a file's text from a previous revision."""
 
569
 
 
570
    takes_options = ['revision']
 
571
    takes_args = ['filename']
 
572
 
 
573
    def run(self, filename, revision=None):
 
574
        if revision == None:
 
575
            raise BzrCommandError("bzr cat requires a revision number")
 
576
        b = Branch('.')
 
577
        b.print_file(b.relpath(filename), int(revision))
 
578
 
 
579
 
 
580
class cmd_local_time_offset(Command):
 
581
    """Show the offset in seconds from GMT to local time."""
 
582
    hidden = True    
 
583
    def run(self):
 
584
        print bzrlib.osutils.local_time_offset()
 
585
 
 
586
 
 
587
 
 
588
class cmd_commit(Command):
 
589
    """Commit changes into a new revision.
 
590
 
 
591
    TODO: Commit only selected files.
 
592
 
 
593
    TODO: Run hooks on tree to-be-committed, and after commit.
 
594
 
 
595
    TODO: Strict commit that fails if there are unknown or deleted files.
 
596
    """
 
597
    takes_options = ['message', 'file', 'verbose']
 
598
    aliases = ['ci', 'checkin']
 
599
 
 
600
    def run(self, message=None, file=None, verbose=False):
 
601
        ## Warning: shadows builtin file()
 
602
        if not message and not file:
 
603
            raise BzrCommandError("please specify a commit message",
 
604
                                  ["use either --message or --file"])
 
605
        elif message and file:
 
606
            raise BzrCommandError("please specify either --message or --file")
 
607
        
 
608
        if file:
 
609
            import codecs
 
610
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
611
 
 
612
        Branch('.').commit(message, verbose=verbose)
 
613
 
 
614
 
 
615
class cmd_check(Command):
 
616
    """Validate consistency of branch history.
 
617
 
 
618
    This command checks various invariants about the branch storage to
 
619
    detect data corruption or bzr bugs.
 
620
    """
 
621
    takes_args = ['dir?']
 
622
    def run(self, dir='.'):
 
623
        import bzrlib.check
 
624
        bzrlib.check.check(Branch(dir, find_root=False))
 
625
 
 
626
 
 
627
 
 
628
class cmd_whoami(Command):
 
629
    """Show bzr user id."""
 
630
    takes_options = ['email']
 
631
    
 
632
    def run(self, email=False):
 
633
        if email:
 
634
            print bzrlib.osutils.user_email()
 
635
        else:
 
636
            print bzrlib.osutils.username()
 
637
 
 
638
 
 
639
class cmd_selftest(Command):
 
640
    """Run internal test suite"""
 
641
    hidden = True
 
642
    def run(self):
 
643
        failures, tests = 0, 0
 
644
 
 
645
        import doctest, bzrlib.store, bzrlib.tests
 
646
        bzrlib.trace.verbose = False
 
647
 
 
648
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
649
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
650
            mf, mt = doctest.testmod(m)
 
651
            failures += mf
 
652
            tests += mt
 
653
            print '%-40s %3d tests' % (m.__name__, mt),
 
654
            if mf:
 
655
                print '%3d FAILED!' % mf
 
656
            else:
 
657
                print
 
658
 
 
659
        print '%-40s %3d tests' % ('total', tests),
 
660
        if failures:
 
661
            print '%3d FAILED!' % failures
 
662
        else:
 
663
            print
 
664
 
 
665
 
 
666
 
 
667
class cmd_version(Command):
 
668
    """Show version of bzr"""
 
669
    def run(self):
 
670
        show_version()
 
671
 
 
672
def show_version():
 
673
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
674
    print bzrlib.__copyright__
 
675
    print "http://bazaar-ng.org/"
 
676
    print
 
677
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
678
    print "you may use, modify and redistribute it under the terms of the GNU"
 
679
    print "General Public License version 2 or later."
 
680
 
 
681
 
 
682
class cmd_rocks(Command):
 
683
    """Statement of optimism."""
 
684
    hidden = True
 
685
    def run(self):
 
686
        print "it sure does!"
 
687
 
 
688
 
 
689
class cmd_assert_fail(Command):
 
690
    """Test reporting of assertion failures"""
 
691
    hidden = True
 
692
    def run(self):
 
693
        assert False, "always fails"
 
694
 
 
695
 
 
696
class cmd_help(Command):
 
697
    """Show help on a command or other topic.
 
698
 
 
699
    For a list of all available commands, say 'bzr help commands'."""
 
700
    takes_args = ['topic?']
 
701
    aliases = ['?']
 
702
    
 
703
    def run(self, topic=None):
 
704
        import help
 
705
        help.help(topic)
 
706
 
 
707
 
 
708
######################################################################
 
709
# main routine
 
710
 
 
711
 
 
712
# list of all available options; the rhs can be either None for an
 
713
# option that takes no argument, or a constructor function that checks
 
714
# the type.
 
715
OPTIONS = {
 
716
    'all':                    None,
 
717
    'help':                   None,
 
718
    'file':                   unicode,
 
719
    'message':                unicode,
 
720
    'profile':                None,
 
721
    'revision':               int,
 
722
    'show-ids':               None,
 
723
    'timezone':               str,
 
724
    'verbose':                None,
 
725
    'version':                None,
 
726
    'email':                  None,
 
727
    }
 
728
 
 
729
SHORT_OPTIONS = {
 
730
    'm':                      'message',
 
731
    'F':                      'file', 
 
732
    'r':                      'revision',
 
733
    'v':                      'verbose',
 
734
}
 
735
 
 
736
 
 
737
def parse_args(argv):
 
738
    """Parse command line.
 
739
    
 
740
    Arguments and options are parsed at this level before being passed
 
741
    down to specific command handlers.  This routine knows, from a
 
742
    lookup table, something about the available options, what optargs
 
743
    they take, and which commands will accept them.
 
744
 
 
745
    >>> parse_args('--help'.split())
 
746
    ([], {'help': True})
 
747
    >>> parse_args('--version'.split())
 
748
    ([], {'version': True})
 
749
    >>> parse_args('status --all'.split())
 
750
    (['status'], {'all': True})
 
751
    >>> parse_args('commit --message=biter'.split())
 
752
    (['commit'], {'message': u'biter'})
 
753
    """
 
754
    args = []
 
755
    opts = {}
 
756
 
 
757
    # TODO: Maybe handle '--' to end options?
 
758
 
 
759
    while argv:
 
760
        a = argv.pop(0)
 
761
        if a[0] == '-':
 
762
            # option names must not be unicode
 
763
            a = str(a)
 
764
            optarg = None
 
765
            if a[1] == '-':
 
766
                mutter("  got option %r" % a)
 
767
                if '=' in a:
 
768
                    optname, optarg = a[2:].split('=', 1)
 
769
                else:
 
770
                    optname = a[2:]
 
771
                if optname not in OPTIONS:
 
772
                    bailout('unknown long option %r' % a)
 
773
            else:
 
774
                shortopt = a[1:]
 
775
                if shortopt not in SHORT_OPTIONS:
 
776
                    bailout('unknown short option %r' % a)
 
777
                optname = SHORT_OPTIONS[shortopt]
 
778
            
 
779
            if optname in opts:
 
780
                # XXX: Do we ever want to support this, e.g. for -r?
 
781
                bailout('repeated option %r' % a)
 
782
                
 
783
            optargfn = OPTIONS[optname]
 
784
            if optargfn:
 
785
                if optarg == None:
 
786
                    if not argv:
 
787
                        bailout('option %r needs an argument' % a)
 
788
                    else:
 
789
                        optarg = argv.pop(0)
 
790
                opts[optname] = optargfn(optarg)
 
791
            else:
 
792
                if optarg != None:
 
793
                    bailout('option %r takes no argument' % optname)
 
794
                opts[optname] = True
 
795
        else:
 
796
            args.append(a)
 
797
 
 
798
    return args, opts
 
799
 
 
800
 
 
801
 
 
802
 
 
803
def _match_argform(cmd, takes_args, args):
 
804
    argdict = {}
 
805
 
 
806
    # step through args and takes_args, allowing appropriate 0-many matches
 
807
    for ap in takes_args:
 
808
        argname = ap[:-1]
 
809
        if ap[-1] == '?':
 
810
            if args:
 
811
                argdict[argname] = args.pop(0)
 
812
        elif ap[-1] == '*': # all remaining arguments
 
813
            if args:
 
814
                argdict[argname + '_list'] = args[:]
 
815
                args = []
 
816
            else:
 
817
                argdict[argname + '_list'] = None
 
818
        elif ap[-1] == '+':
 
819
            if not args:
 
820
                raise BzrCommandError("command %r needs one or more %s"
 
821
                        % (cmd, argname.upper()))
 
822
            else:
 
823
                argdict[argname + '_list'] = args[:]
 
824
                args = []
 
825
        elif ap[-1] == '$': # all but one
 
826
            if len(args) < 2:
 
827
                raise BzrCommandError("command %r needs one or more %s"
 
828
                        % (cmd, argname.upper()))
 
829
            argdict[argname + '_list'] = args[:-1]
 
830
            args[:-1] = []                
 
831
        else:
 
832
            # just a plain arg
 
833
            argname = ap
 
834
            if not args:
 
835
                raise BzrCommandError("command %r requires argument %s"
 
836
                        % (cmd, argname.upper()))
 
837
            else:
 
838
                argdict[argname] = args.pop(0)
 
839
            
 
840
    if args:
 
841
        raise BzrCommandError("extra argument to command %s: %s"
 
842
                              % (cmd, args[0]))
 
843
 
 
844
    return argdict
 
845
 
 
846
 
 
847
 
 
848
def run_bzr(argv):
 
849
    """Execute a command.
 
850
 
 
851
    This is similar to main(), but without all the trappings for
 
852
    logging and error handling.  
 
853
    """
 
854
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
855
    
 
856
    try:
 
857
        args, opts = parse_args(argv[1:])
 
858
        if 'help' in opts:
 
859
            import help
 
860
            if args:
 
861
                help.help(args[0])
 
862
            else:
 
863
                help.help()
 
864
            return 0
 
865
        elif 'version' in opts:
 
866
            show_version()
 
867
            return 0
 
868
        cmd = str(args.pop(0))
 
869
    except IndexError:
 
870
        log_error('usage: bzr COMMAND')
 
871
        log_error('  try "bzr help"')
 
872
        return 1
 
873
 
 
874
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
875
 
 
876
    # global option
 
877
    if 'profile' in opts:
 
878
        profile = True
 
879
        del opts['profile']
 
880
    else:
 
881
        profile = False
 
882
 
 
883
    # check options are reasonable
 
884
    allowed = cmd_class.takes_options
 
885
    for oname in opts:
 
886
        if oname not in allowed:
 
887
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
888
                                  % (oname, cmd))
 
889
 
 
890
    # mix arguments and options into one dictionary
 
891
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
892
    cmdopts = {}
 
893
    for k, v in opts.items():
 
894
        cmdopts[k.replace('-', '_')] = v
 
895
 
 
896
    if profile:
 
897
        import hotshot, tempfile
 
898
        pffileno, pfname = tempfile.mkstemp()
 
899
        try:
 
900
            prof = hotshot.Profile(pfname)
 
901
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
902
            prof.close()
 
903
 
 
904
            import hotshot.stats
 
905
            stats = hotshot.stats.load(pfname)
 
906
            #stats.strip_dirs()
 
907
            stats.sort_stats('time')
 
908
            ## XXX: Might like to write to stderr or the trace file instead but
 
909
            ## print_stats seems hardcoded to stdout
 
910
            stats.print_stats(20)
 
911
            
 
912
            return ret.status
 
913
 
 
914
        finally:
 
915
            os.close(pffileno)
 
916
            os.remove(pfname)
 
917
    else:
 
918
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
919
 
 
920
 
 
921
def _report_exception(summary, quiet=False):
 
922
    import traceback
 
923
    log_error('bzr: ' + summary)
 
924
    bzrlib.trace.log_exception()
 
925
 
 
926
    if not quiet:
 
927
        tb = sys.exc_info()[2]
 
928
        exinfo = traceback.extract_tb(tb)
 
929
        if exinfo:
 
930
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
931
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
932
 
 
933
 
 
934
 
 
935
def main(argv):
 
936
    import errno
 
937
    
 
938
    bzrlib.open_tracefile(argv)
 
939
 
 
940
    try:
 
941
        try:
 
942
            try:
 
943
                return run_bzr(argv)
 
944
            finally:
 
945
                # do this here inside the exception wrappers to catch EPIPE
 
946
                sys.stdout.flush()
 
947
        except BzrError, e:
 
948
            quiet = isinstance(e, (BzrCommandError))
 
949
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
950
            if len(e.args) > 1:
 
951
                for h in e.args[1]:
 
952
                    # some explanation or hints
 
953
                    log_error('  ' + h)
 
954
            return 1
 
955
        except AssertionError, e:
 
956
            msg = 'assertion failed'
 
957
            if str(e):
 
958
                msg += ': ' + str(e)
 
959
            _report_exception(msg)
 
960
            return 2
 
961
        except KeyboardInterrupt, e:
 
962
            _report_exception('interrupted', quiet=True)
 
963
            return 2
 
964
        except Exception, e:
 
965
            quiet = False
 
966
            if isinstance(e, IOError) and e.errno == errno.EPIPE:
 
967
                quiet = True
 
968
                msg = 'broken pipe'
 
969
            else:
 
970
                msg = str(e).rstrip('\n')
 
971
            _report_exception(msg, quiet)
 
972
            return 2
 
973
    finally:
 
974
        bzrlib.trace.close_trace()
 
975
 
 
976
 
 
977
if __name__ == '__main__':
 
978
    sys.exit(main(sys.argv))