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