/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 08:27:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050509082749-22b1a6f4af329f7b
- bzr log and bzr root now accept an http URL
- new RemoteBranch.relpath()
- new find_branch factory method

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