/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

Partially fix pull.

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_added(Command):
510
 
    """List files added in working tree."""
511
 
    hidden = True
512
 
    def run(self):
513
 
        b = Branch('.')
514
 
        wt = b.working_tree()
515
 
        basis_inv = b.basis_tree().inventory
516
 
        inv = wt.inventory
517
 
        for file_id in inv:
518
 
            if file_id in basis_inv:
519
 
                continue
520
 
            path = inv.id2path(file_id)
521
 
            if not os.access(b.abspath(path), os.F_OK):
522
 
                continue
523
 
            print path
524
 
                
525
 
        
526
 
 
527
 
class cmd_root(Command):
528
 
    """Show the tree root directory.
529
 
 
530
 
    The root is the nearest enclosing directory with a .bzr control
531
 
    directory."""
532
 
    takes_args = ['filename?']
533
 
    def run(self, filename=None):
534
 
        """Print the branch root."""
535
 
        from branch import find_branch
536
 
        b = find_branch(filename)
537
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
538
 
 
539
 
 
540
 
class cmd_log(Command):
541
 
    """Show log of this branch.
542
 
 
543
 
    TODO: Option to limit range.
544
 
 
545
 
    TODO: Perhaps show most-recent first with an option for last.
546
 
    """
547
 
    takes_args = ['filename?']
548
 
    takes_options = ['timezone', 'verbose', 'show-ids']
549
 
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
550
 
        from branch import find_branch
551
 
        b = find_branch((filename or '.'), lock_mode='r')
552
 
        if filename:
553
 
            filename = b.relpath(filename)
554
 
        bzrlib.show_log(b, filename,
555
 
                        show_timezone=timezone,
556
 
                        verbose=verbose,
557
 
                        show_ids=show_ids)
558
 
 
559
 
 
560
 
 
561
 
class cmd_touching_revisions(Command):
562
 
    """Return revision-ids which affected a particular file."""
563
 
    hidden = True
564
 
    takes_args = ["filename"]
565
 
    def run(self, filename):
566
 
        b = Branch(filename, lock_mode='r')
567
 
        inv = b.read_working_inventory()
568
 
        file_id = inv.path2id(b.relpath(filename))
569
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
570
 
            print "%6d %s" % (revno, what)
571
 
 
572
 
 
573
 
class cmd_ls(Command):
574
 
    """List files in a tree.
575
 
 
576
 
    TODO: Take a revision or remote path and list that tree instead.
577
 
    """
578
 
    hidden = True
579
 
    def run(self, revision=None, verbose=False):
580
 
        b = Branch('.')
581
 
        if revision == None:
582
 
            tree = b.working_tree()
583
 
        else:
584
 
            tree = b.revision_tree(b.lookup_revision(revision))
585
 
 
586
 
        for fp, fc, kind, fid in tree.list_files():
587
 
            if verbose:
588
 
                if kind == 'directory':
589
 
                    kindch = '/'
590
 
                elif kind == 'file':
591
 
                    kindch = ''
592
 
                else:
593
 
                    kindch = '???'
594
 
 
595
 
                print '%-8s %s%s' % (fc, fp, kindch)
596
 
            else:
597
 
                print fp
598
 
 
599
 
 
600
 
 
601
 
class cmd_unknowns(Command):
602
 
    """List unknown files"""
603
 
    def run(self):
604
 
        for f in Branch('.').unknowns():
605
 
            print quotefn(f)
606
 
 
607
 
 
608
 
 
609
 
class cmd_ignore(Command):
610
 
    """Ignore a command or pattern
611
 
 
612
 
    To remove patterns from the ignore list, edit the .bzrignore file.
613
 
 
614
 
    If the pattern contains a slash, it is compared to the whole path
615
 
    from the branch root.  Otherwise, it is comapred to only the last
616
 
    component of the path.
617
 
 
618
 
    Ignore patterns are case-insensitive on case-insensitive systems.
619
 
 
620
 
    Note: wildcards must be quoted from the shell on Unix.
621
 
 
622
 
    examples:
623
 
        bzr ignore ./Makefile
624
 
        bzr ignore '*.class'
625
 
    """
626
 
    takes_args = ['name_pattern']
627
 
    
628
 
    def run(self, name_pattern):
629
 
        from bzrlib.atomicfile import AtomicFile
630
 
        import codecs
631
 
 
632
 
        b = Branch('.')
633
 
        ifn = b.abspath('.bzrignore')
634
 
 
635
 
        # FIXME: probably doesn't handle non-ascii patterns
636
 
 
637
 
        if os.path.exists(ifn):
638
 
            f = b.controlfile(ifn, 'rt')
639
 
            igns = f.read()
640
 
            f.close()
641
 
        else:
642
 
            igns = ''
643
 
 
644
 
        if igns and igns[-1] != '\n':
645
 
            igns += '\n'
646
 
        igns += name_pattern + '\n'
647
 
 
648
 
        f = AtomicFile(ifn, 'wt')
649
 
        f.write(igns)
650
 
        f.commit()
651
 
 
652
 
        inv = b.working_tree().inventory
653
 
        if inv.path2id('.bzrignore'):
654
 
            mutter('.bzrignore is already versioned')
655
 
        else:
656
 
            mutter('need to make new .bzrignore file versioned')
657
 
            b.add(['.bzrignore'])
658
 
 
659
 
 
660
 
 
661
 
class cmd_ignored(Command):
662
 
    """List ignored files and the patterns that matched them.
663
 
 
664
 
    See also: bzr ignore"""
665
 
    def run(self):
666
 
        tree = Branch('.').working_tree()
667
 
        for path, file_class, kind, file_id in tree.list_files():
668
 
            if file_class != 'I':
669
 
                continue
670
 
            ## XXX: Slightly inefficient since this was already calculated
671
 
            pat = tree.is_ignored(path)
672
 
            print '%-50s %s' % (path, pat)
673
 
 
674
 
 
675
 
class cmd_lookup_revision(Command):
676
 
    """Lookup the revision-id from a revision-number
677
 
 
678
 
    example:
679
 
        bzr lookup-revision 33
680
 
    """
681
 
    hidden = True
682
 
    takes_args = ['revno']
683
 
    
684
 
    def run(self, revno):
685
 
        try:
686
 
            revno = int(revno)
687
 
        except ValueError:
688
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
689
 
 
690
 
        print Branch('.').lookup_revision(revno)
691
 
 
692
 
 
693
 
class cmd_export(Command):
694
 
    """Export past revision to destination directory.
695
 
 
696
 
    If no revision is specified this exports the last committed revision."""
697
 
    takes_args = ['dest']
698
 
    takes_options = ['revision']
699
 
    def run(self, dest, revision=None):
700
 
        b = Branch('.')
701
 
        if revision == None:
702
 
            rh = b.revision_history()[-1]
703
 
        else:
704
 
            rh = b.lookup_revision(int(revision))
705
 
        t = b.revision_tree(rh)
706
 
        t.export(dest)
707
 
 
708
 
 
709
 
class cmd_cat(Command):
710
 
    """Write a file's text from a previous revision."""
711
 
 
712
 
    takes_options = ['revision']
713
 
    takes_args = ['filename']
714
 
 
715
 
    def run(self, filename, revision=None):
716
 
        if revision == None:
717
 
            raise BzrCommandError("bzr cat requires a revision number")
718
 
        b = Branch('.')
719
 
        b.print_file(b.relpath(filename), int(revision))
720
 
 
721
 
 
722
 
class cmd_local_time_offset(Command):
723
 
    """Show the offset in seconds from GMT to local time."""
724
 
    hidden = True    
725
 
    def run(self):
726
 
        print bzrlib.osutils.local_time_offset()
727
 
 
728
 
 
729
 
 
730
 
class cmd_commit(Command):
731
 
    """Commit changes into a new revision.
732
 
 
733
 
    TODO: Commit only selected files.
734
 
 
735
 
    TODO: Run hooks on tree to-be-committed, and after commit.
736
 
 
737
 
    TODO: Strict commit that fails if there are unknown or deleted files.
738
 
    """
739
 
    takes_options = ['message', 'file', 'verbose']
740
 
    aliases = ['ci', 'checkin']
741
 
 
742
 
    def run(self, message=None, file=None, verbose=False):
743
 
        ## Warning: shadows builtin file()
744
 
        if not message and not file:
745
 
            raise BzrCommandError("please specify a commit message",
746
 
                                  ["use either --message or --file"])
747
 
        elif message and file:
748
 
            raise BzrCommandError("please specify either --message or --file")
749
 
        
750
 
        if file:
751
 
            import codecs
752
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
753
 
 
754
 
        Branch('.').commit(message, verbose=verbose)
755
 
 
756
 
 
757
 
class cmd_check(Command):
758
 
    """Validate consistency of branch history.
759
 
 
760
 
    This command checks various invariants about the branch storage to
761
 
    detect data corruption or bzr bugs.
762
 
    """
763
 
    takes_args = ['dir?']
764
 
    def run(self, dir='.'):
765
 
        import bzrlib.check
766
 
        bzrlib.check.check(Branch(dir, find_root=False))
767
 
 
768
 
 
769
 
 
770
 
class cmd_whoami(Command):
771
 
    """Show bzr user id."""
772
 
    takes_options = ['email']
773
 
    
774
 
    def run(self, email=False):
775
 
        if email:
776
 
            print bzrlib.osutils.user_email()
777
 
        else:
778
 
            print bzrlib.osutils.username()
779
 
 
780
 
 
781
 
class cmd_selftest(Command):
782
 
    """Run internal test suite"""
783
 
    hidden = True
784
 
    def run(self):
785
 
        failures, tests = 0, 0
786
 
 
787
 
        import doctest, bzrlib.store, bzrlib.tests
788
 
        bzrlib.trace.verbose = False
789
 
 
790
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
791
 
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
792
 
            mf, mt = doctest.testmod(m)
793
 
            failures += mf
794
 
            tests += mt
795
 
            print '%-40s %3d tests' % (m.__name__, mt),
796
 
            if mf:
797
 
                print '%3d FAILED!' % mf
798
 
            else:
799
 
                print
800
 
 
801
 
        print '%-40s %3d tests' % ('total', tests),
802
 
        if failures:
803
 
            print '%3d FAILED!' % failures
804
 
        else:
805
 
            print
806
 
 
807
 
 
808
 
 
809
 
class cmd_version(Command):
810
 
    """Show version of bzr"""
811
 
    def run(self):
812
 
        show_version()
813
 
 
814
 
def show_version():
815
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
816
 
    print bzrlib.__copyright__
817
 
    print "http://bazaar-ng.org/"
818
 
    print
819
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
820
 
    print "you may use, modify and redistribute it under the terms of the GNU"
821
 
    print "General Public License version 2 or later."
822
 
 
823
 
 
824
 
class cmd_rocks(Command):
825
 
    """Statement of optimism."""
826
 
    hidden = True
827
 
    def run(self):
828
 
        print "it sure does!"
829
 
 
830
 
 
831
 
class cmd_assert_fail(Command):
832
 
    """Test reporting of assertion failures"""
833
 
    hidden = True
834
 
    def run(self):
835
 
        assert False, "always fails"
836
 
 
837
 
 
838
 
class cmd_help(Command):
839
 
    """Show help on a command or other topic.
840
 
 
841
 
    For a list of all available commands, say 'bzr help commands'."""
842
 
    takes_args = ['topic?']
843
 
    aliases = ['?']
844
 
    
845
 
    def run(self, topic=None):
846
 
        import help
847
 
        help.help(topic)
848
 
 
849
 
 
850
 
class cmd_update_stat_cache(Command):
851
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
852
 
 
853
 
    For testing only."""
854
 
    hidden = True
855
 
    def run(self):
856
 
        import statcache
857
 
        b = Branch('.')
858
 
        statcache.update_cache(b)
859
 
 
860
 
 
861
 
######################################################################
862
 
# main routine
863
 
 
864
 
 
865
 
# list of all available options; the rhs can be either None for an
866
 
# option that takes no argument, or a constructor function that checks
867
 
# the type.
868
 
OPTIONS = {
869
 
    'all':                    None,
870
 
    'help':                   None,
871
 
    'file':                   unicode,
872
 
    'message':                unicode,
873
 
    'profile':                None,
874
 
    'revision':               int,
875
 
    'show-ids':               None,
876
 
    'timezone':               str,
877
 
    'verbose':                None,
878
 
    'version':                None,
879
 
    'email':                  None,
880
 
    }
881
 
 
882
 
SHORT_OPTIONS = {
883
 
    'm':                      'message',
884
 
    'F':                      'file', 
885
 
    'r':                      'revision',
886
 
    'v':                      'verbose',
887
 
}
888
 
 
889
 
 
890
 
def parse_args(argv):
891
 
    """Parse command line.
892
 
    
893
 
    Arguments and options are parsed at this level before being passed
894
 
    down to specific command handlers.  This routine knows, from a
895
 
    lookup table, something about the available options, what optargs
896
 
    they take, and which commands will accept them.
897
 
 
898
 
    >>> parse_args('--help'.split())
899
 
    ([], {'help': True})
900
 
    >>> parse_args('--version'.split())
901
 
    ([], {'version': True})
902
 
    >>> parse_args('status --all'.split())
903
 
    (['status'], {'all': True})
904
 
    >>> parse_args('commit --message=biter'.split())
905
 
    (['commit'], {'message': u'biter'})
906
 
    """
907
 
    args = []
908
 
    opts = {}
909
 
 
910
 
    # TODO: Maybe handle '--' to end options?
911
 
 
912
 
    while argv:
913
 
        a = argv.pop(0)
914
 
        if a[0] == '-':
915
 
            # option names must not be unicode
916
 
            a = str(a)
917
 
            optarg = None
918
 
            if a[1] == '-':
919
 
                mutter("  got option %r" % a)
920
 
                if '=' in a:
921
 
                    optname, optarg = a[2:].split('=', 1)
922
 
                else:
923
 
                    optname = a[2:]
924
 
                if optname not in OPTIONS:
925
 
                    bailout('unknown long option %r' % a)
926
 
            else:
927
 
                shortopt = a[1:]
928
 
                if shortopt not in SHORT_OPTIONS:
929
 
                    bailout('unknown short option %r' % a)
930
 
                optname = SHORT_OPTIONS[shortopt]
931
 
            
932
 
            if optname in opts:
933
 
                # XXX: Do we ever want to support this, e.g. for -r?
934
 
                bailout('repeated option %r' % a)
935
 
                
936
 
            optargfn = OPTIONS[optname]
937
 
            if optargfn:
938
 
                if optarg == None:
939
 
                    if not argv:
940
 
                        bailout('option %r needs an argument' % a)
941
 
                    else:
942
 
                        optarg = argv.pop(0)
943
 
                opts[optname] = optargfn(optarg)
944
 
            else:
945
 
                if optarg != None:
946
 
                    bailout('option %r takes no argument' % optname)
947
 
                opts[optname] = True
948
 
        else:
949
 
            args.append(a)
950
 
 
951
 
    return args, opts
952
 
 
953
 
 
954
 
 
955
 
 
956
 
def _match_argform(cmd, takes_args, args):
957
 
    argdict = {}
958
 
 
959
 
    # step through args and takes_args, allowing appropriate 0-many matches
960
 
    for ap in takes_args:
961
 
        argname = ap[:-1]
962
 
        if ap[-1] == '?':
963
 
            if args:
964
 
                argdict[argname] = args.pop(0)
965
 
        elif ap[-1] == '*': # all remaining arguments
966
 
            if args:
967
 
                argdict[argname + '_list'] = args[:]
968
 
                args = []
969
 
            else:
970
 
                argdict[argname + '_list'] = None
971
 
        elif ap[-1] == '+':
972
 
            if not args:
973
 
                raise BzrCommandError("command %r needs one or more %s"
974
 
                        % (cmd, argname.upper()))
975
 
            else:
976
 
                argdict[argname + '_list'] = args[:]
977
 
                args = []
978
 
        elif ap[-1] == '$': # all but one
979
 
            if len(args) < 2:
980
 
                raise BzrCommandError("command %r needs one or more %s"
981
 
                        % (cmd, argname.upper()))
982
 
            argdict[argname + '_list'] = args[:-1]
983
 
            args[:-1] = []                
984
 
        else:
985
 
            # just a plain arg
986
 
            argname = ap
987
 
            if not args:
988
 
                raise BzrCommandError("command %r requires argument %s"
989
 
                        % (cmd, argname.upper()))
990
 
            else:
991
 
                argdict[argname] = args.pop(0)
992
 
            
993
 
    if args:
994
 
        raise BzrCommandError("extra argument to command %s: %s"
995
 
                              % (cmd, args[0]))
996
 
 
997
 
    return argdict
998
 
 
999
 
 
1000
 
 
1001
 
def run_bzr(argv):
1002
 
    """Execute a command.
1003
 
 
1004
 
    This is similar to main(), but without all the trappings for
1005
 
    logging and error handling.  
1006
 
    """
1007
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1008
 
    
1009
 
    try:
1010
 
        args, opts = parse_args(argv[1:])
1011
 
        if 'help' in opts:
1012
 
            import help
1013
 
            if args:
1014
 
                help.help(args[0])
1015
 
            else:
1016
 
                help.help()
1017
 
            return 0
1018
 
        elif 'version' in opts:
1019
 
            show_version()
1020
 
            return 0
1021
 
        cmd = str(args.pop(0))
1022
 
    except IndexError:
1023
 
        import help
1024
 
        help.help()
1025
 
        return 1
1026
 
          
1027
 
 
1028
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
1029
 
 
1030
 
    # global option
1031
 
    if 'profile' in opts:
1032
 
        profile = True
1033
 
        del opts['profile']
1034
 
    else:
1035
 
        profile = False
1036
 
 
1037
 
    # check options are reasonable
1038
 
    allowed = cmd_class.takes_options
1039
 
    for oname in opts:
1040
 
        if oname not in allowed:
1041
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1042
 
                                  % (oname, cmd))
1043
 
 
1044
 
    # mix arguments and options into one dictionary
1045
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1046
 
    cmdopts = {}
1047
 
    for k, v in opts.items():
1048
 
        cmdopts[k.replace('-', '_')] = v
1049
 
 
1050
 
    if profile:
1051
 
        import hotshot, tempfile
1052
 
        pffileno, pfname = tempfile.mkstemp()
1053
 
        try:
1054
 
            prof = hotshot.Profile(pfname)
1055
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1056
 
            prof.close()
1057
 
 
1058
 
            import hotshot.stats
1059
 
            stats = hotshot.stats.load(pfname)
1060
 
            #stats.strip_dirs()
1061
 
            stats.sort_stats('time')
1062
 
            ## XXX: Might like to write to stderr or the trace file instead but
1063
 
            ## print_stats seems hardcoded to stdout
1064
 
            stats.print_stats(20)
1065
 
            
1066
 
            return ret.status
1067
 
 
1068
 
        finally:
1069
 
            os.close(pffileno)
1070
 
            os.remove(pfname)
1071
 
    else:
1072
 
        cmdobj = cmd_class(cmdopts, cmdargs).status 
1073
 
 
1074
 
 
1075
 
def _report_exception(summary, quiet=False):
1076
 
    import traceback
1077
 
    log_error('bzr: ' + summary)
1078
 
    bzrlib.trace.log_exception()
1079
 
 
1080
 
    if not quiet:
1081
 
        tb = sys.exc_info()[2]
1082
 
        exinfo = traceback.extract_tb(tb)
1083
 
        if exinfo:
1084
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1085
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
1086
 
 
1087
 
 
1088
 
 
1089
 
def main(argv):
1090
 
    import errno
1091
 
    
1092
 
    bzrlib.open_tracefile(argv)
1093
 
 
1094
 
    try:
1095
 
        try:
1096
 
            try:
1097
 
                return run_bzr(argv)
1098
 
            finally:
1099
 
                # do this here inside the exception wrappers to catch EPIPE
1100
 
                sys.stdout.flush()
1101
 
        except BzrError, e:
1102
 
            quiet = isinstance(e, (BzrCommandError))
1103
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
1104
 
            if len(e.args) > 1:
1105
 
                for h in e.args[1]:
1106
 
                    # some explanation or hints
1107
 
                    log_error('  ' + h)
1108
 
            return 1
1109
 
        except AssertionError, e:
1110
 
            msg = 'assertion failed'
1111
 
            if str(e):
1112
 
                msg += ': ' + str(e)
1113
 
            _report_exception(msg)
1114
 
            return 2
1115
 
        except KeyboardInterrupt, e:
1116
 
            _report_exception('interrupted', quiet=True)
1117
 
            return 2
1118
 
        except Exception, e:
1119
 
            quiet = False
1120
 
            if (isinstance(e, IOError) 
1121
 
                and hasattr(e, 'errno')
1122
 
                and e.errno == errno.EPIPE):
1123
 
                quiet = True
1124
 
                msg = 'broken pipe'
1125
 
            else:
1126
 
                msg = str(e).rstrip('\n')
1127
 
            _report_exception(msg, quiet)
1128
 
            return 2
1129
 
    finally:
1130
 
        bzrlib.trace.close_trace()
1131
 
 
1132
 
 
1133
 
if __name__ == '__main__':
1134
 
    sys.exit(main(sys.argv))