/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 04:50:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050509045010-7c32d7e3e8942540
- New AtomicFile class
- bzr ignore: Write out ignore list using AtomicFile to break hardlinks

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