/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-10 06:54:12 UTC
  • Revision ID: mbp@sourcefrog.net-20050510065412-cd05087d1e4297f7
- Avoid calling Inventory.iter_entries() when finding modified
  files.  Just calculate path for files known to be changed.
- update_cache optionally takes inventory to avoid reading it twice.

Show diffs side-by-side

added added

removed removed

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