← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2005-04-28 07:24:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050428072453-7b99afa993a1e549
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.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
 
# DO NOT change this to cStringIO - it results in control files 
18
 
# written as UCS4
19
 
# FIXIT! (Only deal with byte streams OR unicode at any one layer.)
20
 
# RBC 20051018
21
 
from StringIO import StringIO
22
 
import sys
23
 
import os
24
 
 
25
 
import bzrlib
26
 
from bzrlib import BZRDIR
27
 
from bzrlib.commands import Command, display_command
28
 
from bzrlib.branch import Branch
29
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
30
 
from bzrlib.errors import DivergedBranches, NoSuchFile, NoWorkingTree
31
 
from bzrlib.option import Option
32
 
from bzrlib.revisionspec import RevisionSpec
33
 
import bzrlib.trace
34
 
from bzrlib.trace import mutter, note, log_error, warning
35
 
from bzrlib.workingtree import WorkingTree
36
 
 
37
 
 
38
 
def branch_files(file_list, default_branch='.'):
39
 
    """\
40
 
    Return a branch and list of branch-relative paths.
41
 
    If supplied file_list is empty or None, the branch default will be used,
42
 
    and returned file_list will match the original.
43
 
    """
44
 
    if file_list is None or len(file_list) == 0:
45
 
        return Branch.open_containing(default_branch)[0], file_list
46
 
    b = Branch.open_containing(file_list[0])[0]
47
 
    
48
 
    # note that if this is a remote branch, we would want
49
 
    # relpath against the transport. RBC 20051018
50
 
    # Most branch ops can't meaningfully operate on files in remote branches;
51
 
    # the above comment was in cmd_status.  ADHB 20051026
52
 
    tree = WorkingTree(b.base, b)
53
 
    new_list = []
54
 
    for filename in file_list:
55
 
        try:
56
 
            new_list.append(tree.relpath(filename))
57
 
        except NotBranchError:
58
 
            raise BzrCommandError("%s is not in the same branch as %s" % 
59
 
                                  (filename, file_list[0]))
60
 
    return b, new_list
61
 
 
62
 
 
63
 
# TODO: Make sure no commands unconditionally use the working directory as a
64
 
# branch.  If a filename argument is used, the first of them should be used to
65
 
# specify the branch.  (Perhaps this can be factored out into some kind of
66
 
# Argument class, representing a file in a branch, where the first occurrence
67
 
# opens the branch?)
68
 
 
69
 
class cmd_status(Command):
70
 
    """Display status summary.
71
 
 
72
 
    This reports on versioned and unknown files, reporting them
73
 
    grouped by state.  Possible states are:
74
 
 
75
 
    added
76
 
        Versioned in the working copy but not in the previous revision.
77
 
 
78
 
    removed
79
 
        Versioned in the previous revision but removed or deleted
80
 
        in the working copy.
81
 
 
82
 
    renamed
83
 
        Path of this file changed from the previous revision;
84
 
        the text may also have changed.  This includes files whose
85
 
        parent directory was renamed.
86
 
 
87
 
    modified
88
 
        Text has changed since the previous revision.
89
 
 
90
 
    unchanged
91
 
        Nothing about this file has changed since the previous revision.
92
 
        Only shown with --all.
93
 
 
94
 
    unknown
95
 
        Not versioned and not matching an ignore pattern.
96
 
 
97
 
    To see ignored files use 'bzr ignored'.  For details in the
98
 
    changes to file texts, use 'bzr diff'.
99
 
 
100
 
    If no arguments are specified, the status of the entire working
101
 
    directory is shown.  Otherwise, only the status of the specified
102
 
    files or directories is reported.  If a directory is given, status
103
 
    is reported for everything inside that directory.
104
 
 
105
 
    If a revision argument is given, the status is calculated against
106
 
    that revision, or between two revisions if two are provided.
107
 
    """
108
 
    
109
 
    # XXX: FIXME: bzr status should accept a -r option to show changes
110
 
    # relative to a revision, or between revisions
111
 
 
112
 
    # TODO: --no-recurse, --recurse options
113
 
    
114
 
    takes_args = ['file*']
115
 
    takes_options = ['all', 'show-ids']
116
 
    aliases = ['st', 'stat']
117
 
    
118
 
    @display_command
119
 
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
120
 
        b, file_list = branch_files(file_list)
121
 
            
122
 
        from bzrlib.status import show_status
123
 
        show_status(b, show_unchanged=all, show_ids=show_ids,
124
 
                    specific_files=file_list, revision=revision)
125
 
 
126
 
 
127
 
class cmd_cat_revision(Command):
128
 
    """Write out metadata for a revision.
129
 
    
130
 
    The revision to print can either be specified by a specific
131
 
    revision identifier, or you can use --revision.
132
 
    """
133
 
 
134
 
    hidden = True
135
 
    takes_args = ['revision_id?']
136
 
    takes_options = ['revision']
137
 
    
138
 
    @display_command
139
 
    def run(self, revision_id=None, revision=None):
140
 
 
141
 
        if revision_id is not None and revision is not None:
142
 
            raise BzrCommandError('You can only supply one of revision_id or --revision')
143
 
        if revision_id is None and revision is None:
144
 
            raise BzrCommandError('You must supply either --revision or a revision_id')
145
 
        b = Branch.open_containing('.')[0]
146
 
        if revision_id is not None:
147
 
            sys.stdout.write(b.get_revision_xml_file(revision_id).read())
148
 
        elif revision is not None:
149
 
            for rev in revision:
150
 
                if rev is None:
151
 
                    raise BzrCommandError('You cannot specify a NULL revision.')
152
 
                revno, rev_id = rev.in_history(b)
153
 
                sys.stdout.write(b.get_revision_xml_file(rev_id).read())
154
 
    
155
 
 
156
 
class cmd_revno(Command):
157
 
    """Show current revision number.
158
 
 
159
 
    This is equal to the number of revisions on this branch."""
160
 
    @display_command
161
 
    def run(self):
162
 
        print Branch.open_containing('.')[0].revno()
163
 
 
164
 
 
165
 
class cmd_revision_info(Command):
166
 
    """Show revision number and revision id for a given revision identifier.
167
 
    """
168
 
    hidden = True
169
 
    takes_args = ['revision_info*']
170
 
    takes_options = ['revision']
171
 
    @display_command
172
 
    def run(self, revision=None, revision_info_list=[]):
173
 
 
174
 
        revs = []
175
 
        if revision is not None:
176
 
            revs.extend(revision)
177
 
        if revision_info_list is not None:
178
 
            for rev in revision_info_list:
179
 
                revs.append(RevisionSpec(rev))
180
 
        if len(revs) == 0:
181
 
            raise BzrCommandError('You must supply a revision identifier')
182
 
 
183
 
        b = Branch.open_containing('.')[0]
184
 
 
185
 
        for rev in revs:
186
 
            revinfo = rev.in_history(b)
187
 
            if revinfo.revno is None:
188
 
                print '     %s' % revinfo.rev_id
189
 
            else:
190
 
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
191
 
 
192
 
    
193
 
class cmd_add(Command):
194
 
    """Add specified files or directories.
195
 
 
196
 
    In non-recursive mode, all the named items are added, regardless
197
 
    of whether they were previously ignored.  A warning is given if
198
 
    any of the named files are already versioned.
199
 
 
200
 
    In recursive mode (the default), files are treated the same way
201
 
    but the behaviour for directories is different.  Directories that
202
 
    are already versioned do not give a warning.  All directories,
203
 
    whether already versioned or not, are searched for files or
204
 
    subdirectories that are neither versioned or ignored, and these
205
 
    are added.  This search proceeds recursively into versioned
206
 
    directories.  If no names are given '.' is assumed.
207
 
 
208
 
    Therefore simply saying 'bzr add' will version all files that
209
 
    are currently unknown.
210
 
 
211
 
    Adding a file whose parent directory is not versioned will
212
 
    implicitly add the parent, and so on up to the root. This means
213
 
    you should never need to explictly add a directory, they'll just
214
 
    get added when you add a file in the directory.
215
 
    """
216
 
    takes_args = ['file*']
217
 
    takes_options = ['no-recurse', 'quiet']
218
 
    
219
 
    def run(self, file_list, no_recurse=False, quiet=False):
220
 
        from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
221
 
        if quiet:
222
 
            reporter = add_reporter_null
223
 
        else:
224
 
            reporter = add_reporter_print
225
 
        smart_add(file_list, not no_recurse, reporter)
226
 
 
227
 
 
228
 
class cmd_mkdir(Command):
229
 
    """Create a new versioned directory.
230
 
 
231
 
    This is equivalent to creating the directory and then adding it.
232
 
    """
233
 
    takes_args = ['dir+']
234
 
 
235
 
    def run(self, dir_list):
236
 
        b = None
237
 
        
238
 
        for d in dir_list:
239
 
            os.mkdir(d)
240
 
            if not b:
241
 
                b = Branch.open_containing(d)[0]
242
 
            b.add([d])
243
 
            print 'added', d
244
 
 
245
 
 
246
 
class cmd_relpath(Command):
247
 
    """Show path of a file relative to root"""
248
 
    takes_args = ['filename']
249
 
    hidden = True
250
 
    
251
 
    @display_command
252
 
    def run(self, filename):
253
 
        branch, relpath = Branch.open_containing(filename)
254
 
        print relpath
255
 
 
256
 
 
257
 
class cmd_inventory(Command):
258
 
    """Show inventory of the current working copy or a revision."""
259
 
    takes_options = ['revision', 'show-ids']
260
 
    
261
 
    @display_command
262
 
    def run(self, revision=None, show_ids=False):
263
 
        b = Branch.open_containing('.')[0]
264
 
        if revision is None:
265
 
            inv = b.working_tree().read_working_inventory()
266
 
        else:
267
 
            if len(revision) > 1:
268
 
                raise BzrCommandError('bzr inventory --revision takes'
269
 
                    ' exactly one revision identifier')
270
 
            inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
271
 
 
272
 
        for path, entry in inv.entries():
273
 
            if show_ids:
274
 
                print '%-50s %s' % (path, entry.file_id)
275
 
            else:
276
 
                print path
277
 
 
278
 
 
279
 
class cmd_move(Command):
280
 
    """Move files to a different directory.
281
 
 
282
 
    examples:
283
 
        bzr move *.txt doc
284
 
 
285
 
    The destination must be a versioned directory in the same branch.
286
 
    """
287
 
    takes_args = ['source$', 'dest']
288
 
    def run(self, source_list, dest):
289
 
        b, source_list = branch_files(source_list)
290
 
 
291
 
        # TODO: glob expansion on windows?
292
 
        tree = WorkingTree(b.base, b)
293
 
        b.move(source_list, tree.relpath(dest))
294
 
 
295
 
 
296
 
class cmd_rename(Command):
297
 
    """Change the name of an entry.
298
 
 
299
 
    examples:
300
 
      bzr rename frob.c frobber.c
301
 
      bzr rename src/frob.c lib/frob.c
302
 
 
303
 
    It is an error if the destination name exists.
304
 
 
305
 
    See also the 'move' command, which moves files into a different
306
 
    directory without changing their name.
307
 
    """
308
 
    # TODO: Some way to rename multiple files without invoking 
309
 
    # bzr for each one?"""
310
 
    takes_args = ['from_name', 'to_name']
311
 
    
312
 
    def run(self, from_name, to_name):
313
 
        b, (from_name, to_name) = branch_files((from_name, to_name))
314
 
        b.rename_one(from_name, to_name)
315
 
 
316
 
 
317
 
class cmd_mv(Command):
318
 
    """Move or rename a file.
319
 
 
320
 
    usage:
321
 
        bzr mv OLDNAME NEWNAME
322
 
        bzr mv SOURCE... DESTINATION
323
 
 
324
 
    If the last argument is a versioned directory, all the other names
325
 
    are moved into it.  Otherwise, there must be exactly two arguments
326
 
    and the file is changed to a new name, which must not already exist.
327
 
 
328
 
    Files cannot be moved between branches.
329
 
    """
330
 
    takes_args = ['names*']
331
 
    def run(self, names_list):
332
 
        if len(names_list) < 2:
333
 
            raise BzrCommandError("missing file argument")
334
 
        b, rel_names = branch_files(names_list)
335
 
        
336
 
        if os.path.isdir(names_list[-1]):
337
 
            # move into existing directory
338
 
            for pair in b.move(rel_names[:-1], rel_names[-1]):
339
 
                print "%s => %s" % pair
340
 
        else:
341
 
            if len(names_list) != 2:
342
 
                raise BzrCommandError('to mv multiple files the destination '
343
 
                                      'must be a versioned directory')
344
 
            b.rename_one(rel_names[0], rel_names[1])
345
 
            print "%s => %s" % (rel_names[0], rel_names[1])
346
 
            
347
 
    
348
 
class cmd_pull(Command):
349
 
    """Pull any changes from another branch into the current one.
350
 
 
351
 
    If there is no default location set, the first pull will set it.  After
352
 
    that, you can omit the location to use the default.  To change the
353
 
    default, use --remember.
354
 
 
355
 
    This command only works on branches that have not diverged.  Branches are
356
 
    considered diverged if both branches have had commits without first
357
 
    pulling from the other.
358
 
 
359
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
360
 
    from one into the other.  Once one branch has merged, the other should
361
 
    be able to pull it again.
362
 
 
363
 
    If you want to forget your local changes and just update your branch to
364
 
    match the remote one, use --overwrite.
365
 
    """
366
 
    takes_options = ['remember', 'overwrite']
367
 
    takes_args = ['location?']
368
 
 
369
 
    def run(self, location=None, remember=False, overwrite=False):
370
 
        from bzrlib.merge import merge
371
 
        from shutil import rmtree
372
 
        import errno
373
 
        
374
 
        br_to = Branch.open_containing('.')[0]
375
 
        stored_loc = br_to.get_parent()
376
 
        if location is None:
377
 
            if stored_loc is None:
378
 
                raise BzrCommandError("No pull location known or specified.")
379
 
            else:
380
 
                print "Using saved location: %s" % stored_loc
381
 
                location = stored_loc
382
 
        br_from = Branch.open(location)
383
 
        try:
384
 
            br_to.working_tree().pull(br_from, overwrite)
385
 
        except DivergedBranches:
386
 
            raise BzrCommandError("These branches have diverged."
387
 
                                  "  Try merge.")
388
 
        if br_to.get_parent() is None or remember:
389
 
            br_to.set_parent(location)
390
 
 
391
 
 
392
 
class cmd_push(Command):
393
 
    """Push this branch into another branch.
394
 
    
395
 
    The remote branch will not have its working tree populated because this
396
 
    is both expensive, and may not be supported on the remote file system.
397
 
    
398
 
    Some smart servers or protocols *may* put the working tree in place.
399
 
 
400
 
    If there is no default push location set, the first push will set it.
401
 
    After that, you can omit the location to use the default.  To change the
402
 
    default, use --remember.
403
 
 
404
 
    This command only works on branches that have not diverged.  Branches are
405
 
    considered diverged if the branch being pushed to is not an older version
406
 
    of this branch.
407
 
 
408
 
    If branches have diverged, you can use 'bzr push --overwrite' to replace
409
 
    the other branch completely.
410
 
    
411
 
    If you want to ensure you have the different changes in the other branch,
412
 
    do a merge (see bzr help merge) from the other branch, and commit that
413
 
    before doing a 'push --overwrite'.
414
 
    """
415
 
    takes_options = ['remember', 'overwrite', 
416
 
                     Option('create-prefix', 
417
 
                            help='Create the path leading up to the branch '
418
 
                                 'if it does not already exist')]
419
 
    takes_args = ['location?']
420
 
 
421
 
    def run(self, location=None, remember=False, overwrite=False,
422
 
            create_prefix=False):
423
 
        import errno
424
 
        from shutil import rmtree
425
 
        from bzrlib.transport import get_transport
426
 
        
427
 
        br_from = Branch.open_containing('.')[0]
428
 
        stored_loc = br_from.get_push_location()
429
 
        if location is None:
430
 
            if stored_loc is None:
431
 
                raise BzrCommandError("No push location known or specified.")
432
 
            else:
433
 
                print "Using saved location: %s" % stored_loc
434
 
                location = stored_loc
435
 
        try:
436
 
            br_to = Branch.open(location)
437
 
        except NotBranchError:
438
 
            # create a branch.
439
 
            transport = get_transport(location).clone('..')
440
 
            if not create_prefix:
441
 
                try:
442
 
                    transport.mkdir(transport.relpath(location))
443
 
                except NoSuchFile:
444
 
                    raise BzrCommandError("Parent directory of %s "
445
 
                                          "does not exist." % location)
446
 
            else:
447
 
                current = transport.base
448
 
                needed = [(transport, transport.relpath(location))]
449
 
                while needed:
450
 
                    try:
451
 
                        transport, relpath = needed[-1]
452
 
                        transport.mkdir(relpath)
453
 
                        needed.pop()
454
 
                    except NoSuchFile:
455
 
                        new_transport = transport.clone('..')
456
 
                        needed.append((new_transport,
457
 
                                       new_transport.relpath(transport.base)))
458
 
                        if new_transport.base == transport.base:
459
 
                            raise BzrCommandError("Could not creeate "
460
 
                                                  "path prefix.")
461
 
                        
462
 
            NoSuchFile
463
 
            br_to = Branch.initialize(location)
464
 
        try:
465
 
            br_to.pull(br_from, overwrite)
466
 
        except DivergedBranches:
467
 
            raise BzrCommandError("These branches have diverged."
468
 
                                  "  Try a merge then push with overwrite.")
469
 
        if br_from.get_push_location() is None or remember:
470
 
            br_from.set_push_location(location)
471
 
 
472
 
 
473
 
class cmd_branch(Command):
474
 
    """Create a new copy of a branch.
475
 
 
476
 
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
477
 
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
478
 
 
479
 
    To retrieve the branch as of a particular revision, supply the --revision
480
 
    parameter, as in "branch foo/bar -r 5".
481
 
 
482
 
    --basis is to speed up branching from remote branches.  When specified, it
483
 
    copies all the file-contents, inventory and revision data from the basis
484
 
    branch before copying anything from the remote branch.
485
 
    """
486
 
    takes_args = ['from_location', 'to_location?']
487
 
    takes_options = ['revision', 'basis']
488
 
    aliases = ['get', 'clone']
489
 
 
490
 
    def run(self, from_location, to_location=None, revision=None, basis=None):
491
 
        from bzrlib.clone import copy_branch
492
 
        import errno
493
 
        from shutil import rmtree
494
 
        if revision is None:
495
 
            revision = [None]
496
 
        elif len(revision) > 1:
497
 
            raise BzrCommandError(
498
 
                'bzr branch --revision takes exactly 1 revision value')
499
 
        try:
500
 
            br_from = Branch.open(from_location)
501
 
        except OSError, e:
502
 
            if e.errno == errno.ENOENT:
503
 
                raise BzrCommandError('Source location "%s" does not'
504
 
                                      ' exist.' % to_location)
505
 
            else:
506
 
                raise
507
 
        br_from.lock_read()
508
 
        try:
509
 
            if basis is not None:
510
 
                basis_branch = Branch.open_containing(basis)[0]
511
 
            else:
512
 
                basis_branch = None
513
 
            if len(revision) == 1 and revision[0] is not None:
514
 
                revision_id = revision[0].in_history(br_from)[1]
515
 
            else:
516
 
                revision_id = None
517
 
            if to_location is None:
518
 
                to_location = os.path.basename(from_location.rstrip("/\\"))
519
 
                name = None
520
 
            else:
521
 
                name = os.path.basename(to_location) + '\n'
522
 
            try:
523
 
                os.mkdir(to_location)
524
 
            except OSError, e:
525
 
                if e.errno == errno.EEXIST:
526
 
                    raise BzrCommandError('Target directory "%s" already'
527
 
                                          ' exists.' % to_location)
528
 
                if e.errno == errno.ENOENT:
529
 
                    raise BzrCommandError('Parent of "%s" does not exist.' %
530
 
                                          to_location)
531
 
                else:
532
 
                    raise
533
 
            try:
534
 
                copy_branch(br_from, to_location, revision_id, basis_branch)
535
 
            except bzrlib.errors.NoSuchRevision:
536
 
                rmtree(to_location)
537
 
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
538
 
                raise BzrCommandError(msg)
539
 
            except bzrlib.errors.UnlistableBranch:
540
 
                rmtree(to_location)
541
 
                msg = "The branch %s cannot be used as a --basis"
542
 
                raise BzrCommandError(msg)
543
 
            if name:
544
 
                branch = Branch.open(to_location)
545
 
                name = StringIO(name)
546
 
                branch.put_controlfile('branch-name', name)
547
 
        finally:
548
 
            br_from.unlock()
549
 
 
550
 
 
551
 
class cmd_renames(Command):
552
 
    """Show list of renamed files.
553
 
    """
554
 
    # TODO: Option to show renames between two historical versions.
555
 
 
556
 
    # TODO: Only show renames under dir, rather than in the whole branch.
557
 
    takes_args = ['dir?']
558
 
 
559
 
    @display_command
560
 
    def run(self, dir='.'):
561
 
        b = Branch.open_containing(dir)[0]
562
 
        old_inv = b.basis_tree().inventory
563
 
        new_inv = b.working_tree().read_working_inventory()
564
 
 
565
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
566
 
        renames.sort()
567
 
        for old_name, new_name in renames:
568
 
            print "%s => %s" % (old_name, new_name)        
569
 
 
570
 
 
571
 
class cmd_info(Command):
572
 
    """Show statistical information about a branch."""
573
 
    takes_args = ['branch?']
574
 
    
575
 
    @display_command
576
 
    def run(self, branch=None):
577
 
        import info
578
 
        b = Branch.open_containing(branch)[0]
579
 
        info.show_info(b)
580
 
 
581
 
 
582
 
class cmd_remove(Command):
583
 
    """Make a file unversioned.
584
 
 
585
 
    This makes bzr stop tracking changes to a versioned file.  It does
586
 
    not delete the working copy.
587
 
    """
588
 
    takes_args = ['file+']
589
 
    takes_options = ['verbose']
590
 
    aliases = ['rm']
591
 
    
592
 
    def run(self, file_list, verbose=False):
593
 
        b, file_list = branch_files(file_list)
594
 
        tree = b.working_tree()
595
 
        tree.remove(file_list, verbose=verbose)
596
 
 
597
 
 
598
 
class cmd_file_id(Command):
599
 
    """Print file_id of a particular file or directory.
600
 
 
601
 
    The file_id is assigned when the file is first added and remains the
602
 
    same through all revisions where the file exists, even when it is
603
 
    moved or renamed.
604
 
    """
605
 
    hidden = True
606
 
    takes_args = ['filename']
607
 
    @display_command
608
 
    def run(self, filename):
609
 
        b, relpath = Branch.open_containing(filename)
610
 
        i = b.inventory.path2id(relpath)
611
 
        if i == None:
612
 
            raise BzrError("%r is not a versioned file" % filename)
613
 
        else:
614
 
            print i
615
 
 
616
 
 
617
 
class cmd_file_path(Command):
618
 
    """Print path of file_ids to a file or directory.
619
 
 
620
 
    This prints one line for each directory down to the target,
621
 
    starting at the branch root."""
622
 
    hidden = True
623
 
    takes_args = ['filename']
624
 
    @display_command
625
 
    def run(self, filename):
626
 
        b, relpath = Branch.open_containing(filename)
627
 
        inv = b.inventory
628
 
        fid = inv.path2id(relpath)
629
 
        if fid == None:
630
 
            raise BzrError("%r is not a versioned file" % filename)
631
 
        for fip in inv.get_idpath(fid):
632
 
            print fip
633
 
 
634
 
 
635
 
class cmd_revision_history(Command):
636
 
    """Display list of revision ids on this branch."""
637
 
    hidden = True
638
 
    @display_command
639
 
    def run(self):
640
 
        for patchid in Branch.open_containing('.')[0].revision_history():
641
 
            print patchid
642
 
 
643
 
 
644
 
class cmd_ancestry(Command):
645
 
    """List all revisions merged into this branch."""
646
 
    hidden = True
647
 
    @display_command
648
 
    def run(self):
649
 
        b = Branch.open_containing('.')[0]
650
 
        for revision_id in b.get_ancestry(b.last_revision()):
651
 
            print revision_id
652
 
 
653
 
 
654
 
class cmd_directories(Command):
655
 
    """Display list of versioned directories in this branch."""
656
 
    @display_command
657
 
    def run(self):
658
 
        for name, ie in (Branch.open_containing('.')[0].working_tree().
659
 
                         read_working_inventory().directories()):
660
 
            if name == '':
661
 
                print '.'
662
 
            else:
663
 
                print name
664
 
 
665
 
 
666
 
class cmd_init(Command):
667
 
    """Make a directory into a versioned branch.
668
 
 
669
 
    Use this to create an empty branch, or before importing an
670
 
    existing project.
671
 
 
672
 
    Recipe for importing a tree of files:
673
 
        cd ~/project
674
 
        bzr init
675
 
        bzr add .
676
 
        bzr status
677
 
        bzr commit -m 'imported project'
678
 
    """
679
 
    takes_args = ['location?']
680
 
    def run(self, location=None):
681
 
        from bzrlib.branch import Branch
682
 
        if location is None:
683
 
            location = '.'
684
 
        else:
685
 
            # The path has to exist to initialize a
686
 
            # branch inside of it.
687
 
            # Just using os.mkdir, since I don't
688
 
            # believe that we want to create a bunch of
689
 
            # locations if the user supplies an extended path
690
 
            if not os.path.exists(location):
691
 
                os.mkdir(location)
692
 
        Branch.initialize(location)
693
 
 
694
 
 
695
 
class cmd_diff(Command):
696
 
    """Show differences in working tree.
697
 
    
698
 
    If files are listed, only the changes in those files are listed.
699
 
    Otherwise, all changes for the tree are listed.
700
 
 
701
 
    examples:
702
 
        bzr diff
703
 
        bzr diff -r1
704
 
        bzr diff -r1..2
705
 
    """
706
 
    # TODO: Allow diff across branches.
707
 
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
708
 
    #       or a graphical diff.
709
 
 
710
 
    # TODO: Python difflib is not exactly the same as unidiff; should
711
 
    #       either fix it up or prefer to use an external diff.
712
 
 
713
 
    # TODO: If a directory is given, diff everything under that.
714
 
 
715
 
    # TODO: Selected-file diff is inefficient and doesn't show you
716
 
    #       deleted files.
717
 
 
718
 
    # TODO: This probably handles non-Unix newlines poorly.
719
 
    
720
 
    takes_args = ['file*']
721
 
    takes_options = ['revision', 'diff-options']
722
 
    aliases = ['di', 'dif']
723
 
 
724
 
    @display_command
725
 
    def run(self, revision=None, file_list=None, diff_options=None):
726
 
        from bzrlib.diff import show_diff
727
 
        
728
 
        b, file_list = branch_files(file_list)
729
 
        if revision is not None:
730
 
            if len(revision) == 1:
731
 
                return show_diff(b, revision[0], specific_files=file_list,
732
 
                                 external_diff_options=diff_options)
733
 
            elif len(revision) == 2:
734
 
                return show_diff(b, revision[0], specific_files=file_list,
735
 
                                 external_diff_options=diff_options,
736
 
                                 revision2=revision[1])
737
 
            else:
738
 
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
739
 
        else:
740
 
            return show_diff(b, None, specific_files=file_list,
741
 
                             external_diff_options=diff_options)
742
 
 
743
 
 
744
 
class cmd_deleted(Command):
745
 
    """List files deleted in the working tree.
746
 
    """
747
 
    # TODO: Show files deleted since a previous revision, or
748
 
    # between two revisions.
749
 
    # TODO: Much more efficient way to do this: read in new
750
 
    # directories with readdir, rather than stating each one.  Same
751
 
    # level of effort but possibly much less IO.  (Or possibly not,
752
 
    # if the directories are very large...)
753
 
    @display_command
754
 
    def run(self, show_ids=False):
755
 
        b = Branch.open_containing('.')[0]
756
 
        old = b.basis_tree()
757
 
        new = b.working_tree()
758
 
        for path, ie in old.inventory.iter_entries():
759
 
            if not new.has_id(ie.file_id):
760
 
                if show_ids:
761
 
                    print '%-50s %s' % (path, ie.file_id)
762
 
                else:
763
 
                    print path
764
 
 
765
 
 
766
 
class cmd_modified(Command):
767
 
    """List files modified in working tree."""
768
 
    hidden = True
769
 
    @display_command
770
 
    def run(self):
771
 
        from bzrlib.delta import compare_trees
772
 
 
773
 
        b = Branch.open_containing('.')[0]
774
 
        td = compare_trees(b.basis_tree(), b.working_tree())
775
 
 
776
 
        for path, id, kind, text_modified, meta_modified in td.modified:
777
 
            print path
778
 
 
779
 
 
780
 
 
781
 
class cmd_added(Command):
782
 
    """List files added in working tree."""
783
 
    hidden = True
784
 
    @display_command
785
 
    def run(self):
786
 
        b = Branch.open_containing('.')[0]
787
 
        wt = b.working_tree()
788
 
        basis_inv = b.basis_tree().inventory
789
 
        inv = wt.inventory
790
 
        for file_id in inv:
791
 
            if file_id in basis_inv:
792
 
                continue
793
 
            path = inv.id2path(file_id)
794
 
            if not os.access(b.abspath(path), os.F_OK):
795
 
                continue
796
 
            print path
797
 
                
798
 
        
799
 
 
800
 
class cmd_root(Command):
801
 
    """Show the tree root directory.
802
 
 
803
 
    The root is the nearest enclosing directory with a .bzr control
804
 
    directory."""
805
 
    takes_args = ['filename?']
806
 
    @display_command
807
 
    def run(self, filename=None):
808
 
        """Print the branch root."""
809
 
        b = Branch.open_containing(filename)[0]
810
 
        print b.base
811
 
 
812
 
 
813
 
class cmd_log(Command):
814
 
    """Show log of this branch.
815
 
 
816
 
    To request a range of logs, you can use the command -r begin..end
817
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
818
 
    also valid.
819
 
    """
820
 
 
821
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
822
 
 
823
 
    takes_args = ['filename?']
824
 
    takes_options = [Option('forward', 
825
 
                            help='show from oldest to newest'),
826
 
                     'timezone', 'verbose', 
827
 
                     'show-ids', 'revision',
828
 
                     Option('line', help='format with one line per revision'),
829
 
                     'long', 
830
 
                     Option('message',
831
 
                            help='show revisions whose message matches this regexp',
832
 
                            type=str),
833
 
                     Option('short', help='use moderately short format'),
834
 
                     ]
835
 
    @display_command
836
 
    def run(self, filename=None, timezone='original',
837
 
            verbose=False,
838
 
            show_ids=False,
839
 
            forward=False,
840
 
            revision=None,
841
 
            message=None,
842
 
            long=False,
843
 
            short=False,
844
 
            line=False):
845
 
        from bzrlib.log import log_formatter, show_log
846
 
        import codecs
847
 
        assert message is None or isinstance(message, basestring), \
848
 
            "invalid message argument %r" % message
849
 
        direction = (forward and 'forward') or 'reverse'
850
 
        
851
 
        if filename:
852
 
            b, fp = Branch.open_containing(filename)
853
 
            if fp != '':
854
 
                try:
855
 
                    inv = b.working_tree().read_working_inventory()
856
 
                except NoWorkingTree:
857
 
                    inv = b.get_inventory(b.last_revision())
858
 
                file_id = inv.path2id(fp)
859
 
            else:
860
 
                file_id = None  # points to branch root
861
 
        else:
862
 
            b, relpath = Branch.open_containing('.')
863
 
            file_id = None
864
 
 
865
 
        if revision is None:
866
 
            rev1 = None
867
 
            rev2 = None
868
 
        elif len(revision) == 1:
869
 
            rev1 = rev2 = revision[0].in_history(b).revno
870
 
        elif len(revision) == 2:
871
 
            rev1 = revision[0].in_history(b).revno
872
 
            rev2 = revision[1].in_history(b).revno
873
 
        else:
874
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
875
 
 
876
 
        if rev1 == 0:
877
 
            rev1 = None
878
 
        if rev2 == 0:
879
 
            rev2 = None
880
 
 
881
 
        mutter('encoding log as %r', bzrlib.user_encoding)
882
 
 
883
 
        # use 'replace' so that we don't abort if trying to write out
884
 
        # in e.g. the default C locale.
885
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
886
 
 
887
 
        log_format = 'long'
888
 
        if short:
889
 
            log_format = 'short'
890
 
        if line:
891
 
            log_format = 'line'
892
 
        lf = log_formatter(log_format,
893
 
                           show_ids=show_ids,
894
 
                           to_file=outf,
895
 
                           show_timezone=timezone)
896
 
 
897
 
        show_log(b,
898
 
                 lf,
899
 
                 file_id,
900
 
                 verbose=verbose,
901
 
                 direction=direction,
902
 
                 start_revision=rev1,
903
 
                 end_revision=rev2,
904
 
                 search=message)
905
 
 
906
 
 
907
 
 
908
 
class cmd_touching_revisions(Command):
909
 
    """Return revision-ids which affected a particular file.
910
 
 
911
 
    A more user-friendly interface is "bzr log FILE"."""
912
 
    hidden = True
913
 
    takes_args = ["filename"]
914
 
    @display_command
915
 
    def run(self, filename):
916
 
        b, relpath = Branch.open_containing(filename)[0]
917
 
        inv = b.working_tree().read_working_inventory()
918
 
        file_id = inv.path2id(relpath)
919
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
920
 
            print "%6d %s" % (revno, what)
921
 
 
922
 
 
923
 
class cmd_ls(Command):
924
 
    """List files in a tree.
925
 
    """
926
 
    # TODO: Take a revision or remote path and list that tree instead.
927
 
    hidden = True
928
 
    takes_options = ['verbose', 'revision',
929
 
                     Option('non-recursive',
930
 
                            help='don\'t recurse into sub-directories'),
931
 
                     Option('from-root',
932
 
                            help='Print all paths from the root of the branch.'),
933
 
                     Option('unknown', help='Print unknown files'),
934
 
                     Option('versioned', help='Print versioned files'),
935
 
                     Option('ignored', help='Print ignored files'),
936
 
 
937
 
                     Option('null', help='Null separate the files'),
938
 
                    ]
939
 
    @display_command
940
 
    def run(self, revision=None, verbose=False, 
941
 
            non_recursive=False, from_root=False,
942
 
            unknown=False, versioned=False, ignored=False,
943
 
            null=False):
944
 
 
945
 
        if verbose and null:
946
 
            raise BzrCommandError('Cannot set both --verbose and --null')
947
 
        all = not (unknown or versioned or ignored)
948
 
 
949
 
        selection = {'I':ignored, '?':unknown, 'V':versioned}
950
 
 
951
 
        b, relpath = Branch.open_containing('.')
952
 
        if from_root:
953
 
            relpath = ''
954
 
        elif relpath:
955
 
            relpath += '/'
956
 
        if revision == None:
957
 
            tree = b.working_tree()
958
 
        else:
959
 
            tree = b.revision_tree(revision[0].in_history(b).rev_id)
960
 
        for fp, fc, kind, fid, entry in tree.list_files():
961
 
            if fp.startswith(relpath):
962
 
                fp = fp[len(relpath):]
963
 
                if non_recursive and '/' in fp:
964
 
                    continue
965
 
                if not all and not selection[fc]:
966
 
                    continue
967
 
                if verbose:
968
 
                    kindch = entry.kind_character()
969
 
                    print '%-8s %s%s' % (fc, fp, kindch)
970
 
                elif null:
971
 
                    sys.stdout.write(fp)
972
 
                    sys.stdout.write('\0')
973
 
                    sys.stdout.flush()
974
 
                else:
975
 
                    print fp
976
 
 
977
 
 
978
 
 
979
 
class cmd_unknowns(Command):
980
 
    """List unknown files."""
981
 
    @display_command
982
 
    def run(self):
983
 
        from bzrlib.osutils import quotefn
984
 
        for f in Branch.open_containing('.')[0].unknowns():
985
 
            print quotefn(f)
986
 
 
987
 
 
988
 
 
989
 
class cmd_ignore(Command):
990
 
    """Ignore a command or pattern.
991
 
 
992
 
    To remove patterns from the ignore list, edit the .bzrignore file.
993
 
 
994
 
    If the pattern contains a slash, it is compared to the whole path
995
 
    from the branch root.  Otherwise, it is compared to only the last
996
 
    component of the path.  To match a file only in the root directory,
997
 
    prepend './'.
998
 
 
999
 
    Ignore patterns are case-insensitive on case-insensitive systems.
1000
 
 
1001
 
    Note: wildcards must be quoted from the shell on Unix.
1002
 
 
1003
 
    examples:
1004
 
        bzr ignore ./Makefile
1005
 
        bzr ignore '*.class'
1006
 
    """
1007
 
    # TODO: Complain if the filename is absolute
1008
 
    takes_args = ['name_pattern']
1009
 
    
1010
 
    def run(self, name_pattern):
1011
 
        from bzrlib.atomicfile import AtomicFile
1012
 
        import os.path
1013
 
 
1014
 
        b, relpath = Branch.open_containing('.')
1015
 
        ifn = b.abspath('.bzrignore')
1016
 
 
1017
 
        if os.path.exists(ifn):
1018
 
            f = open(ifn, 'rt')
1019
 
            try:
1020
 
                igns = f.read().decode('utf-8')
1021
 
            finally:
1022
 
                f.close()
1023
 
        else:
1024
 
            igns = ''
1025
 
 
1026
 
        # TODO: If the file already uses crlf-style termination, maybe
1027
 
        # we should use that for the newly added lines?
1028
 
 
1029
 
        if igns and igns[-1] != '\n':
1030
 
            igns += '\n'
1031
 
        igns += name_pattern + '\n'
1032
 
 
1033
 
        try:
1034
 
            f = AtomicFile(ifn, 'wt')
1035
 
            f.write(igns.encode('utf-8'))
1036
 
            f.commit()
1037
 
        finally:
1038
 
            f.close()
1039
 
 
1040
 
        inv = b.working_tree().inventory
1041
 
        if inv.path2id('.bzrignore'):
1042
 
            mutter('.bzrignore is already versioned')
1043
 
        else:
1044
 
            mutter('need to make new .bzrignore file versioned')
1045
 
            b.add(['.bzrignore'])
1046
 
 
1047
 
 
1048
 
 
1049
 
class cmd_ignored(Command):
1050
 
    """List ignored files and the patterns that matched them.
1051
 
 
1052
 
    See also: bzr ignore"""
1053
 
    @display_command
1054
 
    def run(self):
1055
 
        tree = Branch.open_containing('.')[0].working_tree()
1056
 
        for path, file_class, kind, file_id, entry in tree.list_files():
1057
 
            if file_class != 'I':
1058
 
                continue
1059
 
            ## XXX: Slightly inefficient since this was already calculated
1060
 
            pat = tree.is_ignored(path)
1061
 
            print '%-50s %s' % (path, pat)
1062
 
 
1063
 
 
1064
 
class cmd_lookup_revision(Command):
1065
 
    """Lookup the revision-id from a revision-number
1066
 
 
1067
 
    example:
1068
 
        bzr lookup-revision 33
1069
 
    """
1070
 
    hidden = True
1071
 
    takes_args = ['revno']
1072
 
    
1073
 
    @display_command
1074
 
    def run(self, revno):
1075
 
        try:
1076
 
            revno = int(revno)
1077
 
        except ValueError:
1078
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
1079
 
 
1080
 
        print Branch.open_containing('.')[0].get_rev_id(revno)
1081
 
 
1082
 
 
1083
 
class cmd_export(Command):
1084
 
    """Export past revision to destination directory.
1085
 
 
1086
 
    If no revision is specified this exports the last committed revision.
1087
 
 
1088
 
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
1089
 
    given, try to find the format with the extension. If no extension
1090
 
    is found exports to a directory (equivalent to --format=dir).
1091
 
 
1092
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1093
 
    is given, the top directory will be the root name of the file."""
1094
 
    # TODO: list known exporters
1095
 
    takes_args = ['dest']
1096
 
    takes_options = ['revision', 'format', 'root']
1097
 
    def run(self, dest, revision=None, format=None, root=None):
1098
 
        import os.path
1099
 
        b = Branch.open_containing('.')[0]
1100
 
        if revision is None:
1101
 
            rev_id = b.last_revision()
1102
 
        else:
1103
 
            if len(revision) != 1:
1104
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1105
 
            rev_id = revision[0].in_history(b).rev_id
1106
 
        t = b.revision_tree(rev_id)
1107
 
        arg_root, ext = os.path.splitext(os.path.basename(dest))
1108
 
        if ext in ('.gz', '.bz2'):
1109
 
            new_root, new_ext = os.path.splitext(arg_root)
1110
 
            if new_ext == '.tar':
1111
 
                arg_root = new_root
1112
 
                ext = new_ext + ext
1113
 
        if root is None:
1114
 
            root = arg_root
1115
 
        if not format:
1116
 
            if ext in (".tar",):
1117
 
                format = "tar"
1118
 
            elif ext in (".tar.gz", ".tgz"):
1119
 
                format = "tgz"
1120
 
            elif ext in (".tar.bz2", ".tbz2"):
1121
 
                format = "tbz2"
1122
 
            else:
1123
 
                format = "dir"
1124
 
        t.export(dest, format, root)
1125
 
 
1126
 
 
1127
 
class cmd_cat(Command):
1128
 
    """Write a file's text from a previous revision."""
1129
 
 
1130
 
    takes_options = ['revision']
1131
 
    takes_args = ['filename']
1132
 
 
1133
 
    @display_command
1134
 
    def run(self, filename, revision=None):
1135
 
        if revision is None:
1136
 
            raise BzrCommandError("bzr cat requires a revision number")
1137
 
        elif len(revision) != 1:
1138
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1139
 
        b, relpath = Branch.open_containing(filename)
1140
 
        b.print_file(relpath, revision[0].in_history(b).revno)
1141
 
 
1142
 
 
1143
 
class cmd_local_time_offset(Command):
1144
 
    """Show the offset in seconds from GMT to local time."""
1145
 
    hidden = True    
1146
 
    @display_command
1147
 
    def run(self):
1148
 
        print bzrlib.osutils.local_time_offset()
1149
 
 
1150
 
 
1151
 
 
1152
 
class cmd_commit(Command):
1153
 
    """Commit changes into a new revision.
1154
 
    
1155
 
    If no arguments are given, the entire tree is committed.
1156
 
 
1157
 
    If selected files are specified, only changes to those files are
1158
 
    committed.  If a directory is specified then the directory and everything 
1159
 
    within it is committed.
1160
 
 
1161
 
    A selected-file commit may fail in some cases where the committed
1162
 
    tree would be invalid, such as trying to commit a file in a
1163
 
    newly-added directory that is not itself committed.
1164
 
    """
1165
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
1166
 
 
1167
 
    # TODO: Strict commit that fails if there are deleted files.
1168
 
    #       (what does "deleted files" mean ??)
1169
 
 
1170
 
    # TODO: Give better message for -s, --summary, used by tla people
1171
 
 
1172
 
    # XXX: verbose currently does nothing
1173
 
 
1174
 
    takes_args = ['selected*']
1175
 
    takes_options = ['message', 'verbose', 
1176
 
                     Option('unchanged',
1177
 
                            help='commit even if nothing has changed'),
1178
 
                     Option('file', type=str, 
1179
 
                            argname='msgfile',
1180
 
                            help='file containing commit message'),
1181
 
                     Option('strict',
1182
 
                            help="refuse to commit if there are unknown "
1183
 
                            "files in the working tree."),
1184
 
                     ]
1185
 
    aliases = ['ci', 'checkin']
1186
 
 
1187
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1188
 
            unchanged=False, strict=False):
1189
 
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1190
 
                StrictCommitFailed)
1191
 
        from bzrlib.msgeditor import edit_commit_message
1192
 
        from bzrlib.status import show_status
1193
 
        from cStringIO import StringIO
1194
 
 
1195
 
        b, selected_list = branch_files(selected_list)
1196
 
        if message is None and not file:
1197
 
            catcher = StringIO()
1198
 
            show_status(b, specific_files=selected_list,
1199
 
                        to_file=catcher)
1200
 
            message = edit_commit_message(catcher.getvalue())
1201
 
 
1202
 
            if message is None:
1203
 
                raise BzrCommandError("please specify a commit message"
1204
 
                                      " with either --message or --file")
1205
 
        elif message and file:
1206
 
            raise BzrCommandError("please specify either --message or --file")
1207
 
        
1208
 
        if file:
1209
 
            import codecs
1210
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1211
 
 
1212
 
        if message == "":
1213
 
                raise BzrCommandError("empty commit message specified")
1214
 
            
1215
 
        try:
1216
 
            b.working_tree().commit(message, specific_files=selected_list,
1217
 
                     allow_pointless=unchanged, strict=strict)
1218
 
        except PointlessCommit:
1219
 
            # FIXME: This should really happen before the file is read in;
1220
 
            # perhaps prepare the commit; get the message; then actually commit
1221
 
            raise BzrCommandError("no changes to commit",
1222
 
                                  ["use --unchanged to commit anyhow"])
1223
 
        except ConflictsInTree:
1224
 
            raise BzrCommandError("Conflicts detected in working tree.  "
1225
 
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1226
 
        except StrictCommitFailed:
1227
 
            raise BzrCommandError("Commit refused because there are unknown "
1228
 
                                  "files in the working tree.")
1229
 
 
1230
 
 
1231
 
class cmd_check(Command):
1232
 
    """Validate consistency of branch history.
1233
 
 
1234
 
    This command checks various invariants about the branch storage to
1235
 
    detect data corruption or bzr bugs.
1236
 
    """
1237
 
    takes_args = ['dir?']
1238
 
    takes_options = ['verbose']
1239
 
 
1240
 
    def run(self, dir='.', verbose=False):
1241
 
        from bzrlib.check import check
1242
 
        check(Branch.open_containing(dir)[0], verbose)
1243
 
 
1244
 
 
1245
 
class cmd_scan_cache(Command):
1246
 
    hidden = True
1247
 
    def run(self):
1248
 
        from bzrlib.hashcache import HashCache
1249
 
 
1250
 
        c = HashCache('.')
1251
 
        c.read()
1252
 
        c.scan()
1253
 
            
1254
 
        print '%6d stats' % c.stat_count
1255
 
        print '%6d in hashcache' % len(c._cache)
1256
 
        print '%6d files removed from cache' % c.removed_count
1257
 
        print '%6d hashes updated' % c.update_count
1258
 
        print '%6d files changed too recently to cache' % c.danger_count
1259
 
 
1260
 
        if c.needs_write:
1261
 
            c.write()
1262
 
            
1263
 
 
1264
 
 
1265
 
class cmd_upgrade(Command):
1266
 
    """Upgrade branch storage to current format.
1267
 
 
1268
 
    The check command or bzr developers may sometimes advise you to run
1269
 
    this command.
1270
 
 
1271
 
    This version of this command upgrades from the full-text storage
1272
 
    used by bzr 0.0.8 and earlier to the weave format (v5).
1273
 
    """
1274
 
    takes_args = ['dir?']
1275
 
 
1276
 
    def run(self, dir='.'):
1277
 
        from bzrlib.upgrade import upgrade
1278
 
        upgrade(dir)
1279
 
 
1280
 
 
1281
 
class cmd_whoami(Command):
1282
 
    """Show bzr user id."""
1283
 
    takes_options = ['email']
1284
 
    
1285
 
    @display_command
1286
 
    def run(self, email=False):
1287
 
        try:
1288
 
            b = bzrlib.branch.Branch.open_containing('.')[0]
1289
 
            config = bzrlib.config.BranchConfig(b)
1290
 
        except NotBranchError:
1291
 
            config = bzrlib.config.GlobalConfig()
1292
 
        
1293
 
        if email:
1294
 
            print config.user_email()
1295
 
        else:
1296
 
            print config.username()
1297
 
 
1298
 
 
1299
 
class cmd_selftest(Command):
1300
 
    """Run internal test suite.
1301
 
    
1302
 
    This creates temporary test directories in the working directory,
1303
 
    but not existing data is affected.  These directories are deleted
1304
 
    if the tests pass, or left behind to help in debugging if they
1305
 
    fail.
1306
 
    
1307
 
    If arguments are given, they are regular expressions that say
1308
 
    which tests should run.
1309
 
    """
1310
 
    # TODO: --list should give a list of all available tests
1311
 
    hidden = True
1312
 
    takes_args = ['testspecs*']
1313
 
    takes_options = ['verbose', 
1314
 
                     Option('one', help='stop when one test fails'),
1315
 
                    ]
1316
 
 
1317
 
    def run(self, testspecs_list=None, verbose=False, one=False):
1318
 
        import bzrlib.ui
1319
 
        from bzrlib.selftest import selftest
1320
 
        # we don't want progress meters from the tests to go to the
1321
 
        # real output; and we don't want log messages cluttering up
1322
 
        # the real logs.
1323
 
        save_ui = bzrlib.ui.ui_factory
1324
 
        bzrlib.trace.info('running tests...')
1325
 
        try:
1326
 
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1327
 
            if testspecs_list is not None:
1328
 
                pattern = '|'.join(testspecs_list)
1329
 
            else:
1330
 
                pattern = ".*"
1331
 
            result = selftest(verbose=verbose, 
1332
 
                              pattern=pattern,
1333
 
                              stop_on_failure=one)
1334
 
            if result:
1335
 
                bzrlib.trace.info('tests passed')
1336
 
            else:
1337
 
                bzrlib.trace.info('tests failed')
1338
 
            return int(not result)
1339
 
        finally:
1340
 
            bzrlib.ui.ui_factory = save_ui
1341
 
 
1342
 
 
1343
 
def show_version():
1344
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1345
 
    # is bzrlib itself in a branch?
1346
 
    bzrrev = bzrlib.get_bzr_revision()
1347
 
    if bzrrev:
1348
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1349
 
    print bzrlib.__copyright__
1350
 
    print "http://bazaar-ng.org/"
1351
 
    print
1352
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1353
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1354
 
    print "General Public License version 2 or later."
1355
 
 
1356
 
 
1357
 
class cmd_version(Command):
1358
 
    """Show version of bzr."""
1359
 
    @display_command
1360
 
    def run(self):
1361
 
        show_version()
1362
 
 
1363
 
class cmd_rocks(Command):
1364
 
    """Statement of optimism."""
1365
 
    hidden = True
1366
 
    @display_command
1367
 
    def run(self):
1368
 
        print "it sure does!"
1369
 
 
1370
 
 
1371
 
class cmd_find_merge_base(Command):
1372
 
    """Find and print a base revision for merging two branches.
1373
 
    """
1374
 
    # TODO: Options to specify revisions on either side, as if
1375
 
    #       merging only part of the history.
1376
 
    takes_args = ['branch', 'other']
1377
 
    hidden = True
1378
 
    
1379
 
    @display_command
1380
 
    def run(self, branch, other):
1381
 
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
1382
 
        
1383
 
        branch1 = Branch.open_containing(branch)[0]
1384
 
        branch2 = Branch.open_containing(other)[0]
1385
 
 
1386
 
        history_1 = branch1.revision_history()
1387
 
        history_2 = branch2.revision_history()
1388
 
 
1389
 
        last1 = branch1.last_revision()
1390
 
        last2 = branch2.last_revision()
1391
 
 
1392
 
        source = MultipleRevisionSources(branch1, branch2)
1393
 
        
1394
 
        base_rev_id = common_ancestor(last1, last2, source)
1395
 
 
1396
 
        print 'merge base is revision %s' % base_rev_id
1397
 
        
1398
 
        return
1399
 
 
1400
 
        if base_revno is None:
1401
 
            raise bzrlib.errors.UnrelatedBranches()
1402
 
 
1403
 
        print ' r%-6d in %s' % (base_revno, branch)
1404
 
 
1405
 
        other_revno = branch2.revision_id_to_revno(base_revid)
1406
 
        
1407
 
        print ' r%-6d in %s' % (other_revno, other)
1408
 
 
1409
 
 
1410
 
 
1411
 
class cmd_merge(Command):
1412
 
    """Perform a three-way merge.
1413
 
    
1414
 
    The branch is the branch you will merge from.  By default, it will
1415
 
    merge the latest revision.  If you specify a revision, that
1416
 
    revision will be merged.  If you specify two revisions, the first
1417
 
    will be used as a BASE, and the second one as OTHER.  Revision
1418
 
    numbers are always relative to the specified branch.
1419
 
 
1420
 
    By default bzr will try to merge in all new work from the other
1421
 
    branch, automatically determining an appropriate base.  If this
1422
 
    fails, you may need to give an explicit base.
1423
 
    
1424
 
    Examples:
1425
 
 
1426
 
    To merge the latest revision from bzr.dev
1427
 
    bzr merge ../bzr.dev
1428
 
 
1429
 
    To merge changes up to and including revision 82 from bzr.dev
1430
 
    bzr merge -r 82 ../bzr.dev
1431
 
 
1432
 
    To merge the changes introduced by 82, without previous changes:
1433
 
    bzr merge -r 81..82 ../bzr.dev
1434
 
    
1435
 
    merge refuses to run if there are any uncommitted changes, unless
1436
 
    --force is given.
1437
 
    """
1438
 
    takes_args = ['branch?']
1439
 
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
1440
 
                     Option('show-base', help="Show base revision text in "
1441
 
                            "conflicts")]
1442
 
 
1443
 
    def run(self, branch=None, revision=None, force=False, merge_type=None,
1444
 
            show_base=False, reprocess=False):
1445
 
        from bzrlib.merge import merge
1446
 
        from bzrlib.merge_core import ApplyMerge3
1447
 
        if merge_type is None:
1448
 
            merge_type = ApplyMerge3
1449
 
        if branch is None:
1450
 
            branch = Branch.open_containing('.')[0].get_parent()
1451
 
            if branch is None:
1452
 
                raise BzrCommandError("No merge location known or specified.")
1453
 
            else:
1454
 
                print "Using saved location: %s" % branch 
1455
 
        if revision is None or len(revision) < 1:
1456
 
            base = [None, None]
1457
 
            other = [branch, -1]
1458
 
        else:
1459
 
            if len(revision) == 1:
1460
 
                base = [None, None]
1461
 
                other_branch = Branch.open_containing(branch)[0]
1462
 
                revno = revision[0].in_history(other_branch).revno
1463
 
                other = [branch, revno]
1464
 
            else:
1465
 
                assert len(revision) == 2
1466
 
                if None in revision:
1467
 
                    raise BzrCommandError(
1468
 
                        "Merge doesn't permit that revision specifier.")
1469
 
                b = Branch.open_containing(branch)[0]
1470
 
 
1471
 
                base = [branch, revision[0].in_history(b).revno]
1472
 
                other = [branch, revision[1].in_history(b).revno]
1473
 
 
1474
 
        try:
1475
 
            conflict_count = merge(other, base, check_clean=(not force),
1476
 
                                   merge_type=merge_type, reprocess=reprocess,
1477
 
                                   show_base=show_base)
1478
 
            if conflict_count != 0:
1479
 
                return 1
1480
 
            else:
1481
 
                return 0
1482
 
        except bzrlib.errors.AmbiguousBase, e:
1483
 
            m = ("sorry, bzr can't determine the right merge base yet\n"
1484
 
                 "candidates are:\n  "
1485
 
                 + "\n  ".join(e.bases)
1486
 
                 + "\n"
1487
 
                 "please specify an explicit base with -r,\n"
1488
 
                 "and (if you want) report this to the bzr developers\n")
1489
 
            log_error(m)
1490
 
 
1491
 
 
1492
 
class cmd_revert(Command):
1493
 
    """Reverse all changes since the last commit.
1494
 
 
1495
 
    Only versioned files are affected.  Specify filenames to revert only 
1496
 
    those files.  By default, any files that are changed will be backed up
1497
 
    first.  Backup files have a '~' appended to their name.
1498
 
    """
1499
 
    takes_options = ['revision', 'no-backup']
1500
 
    takes_args = ['file*']
1501
 
    aliases = ['merge-revert']
1502
 
 
1503
 
    def run(self, revision=None, no_backup=False, file_list=None):
1504
 
        from bzrlib.merge import merge_inner
1505
 
        from bzrlib.commands import parse_spec
1506
 
        if file_list is not None:
1507
 
            if len(file_list) == 0:
1508
 
                raise BzrCommandError("No files specified")
1509
 
        else:
1510
 
            file_list = []
1511
 
        if revision is None:
1512
 
            revno = -1
1513
 
            b = Branch.open_containing('.')[0]
1514
 
            rev_id = b.last_revision()
1515
 
        elif len(revision) != 1:
1516
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1517
 
        else:
1518
 
            b, file_list = branch_files(file_list)
1519
 
            rev_id = revision[0].in_history(b).rev_id
1520
 
        b.working_tree().revert(file_list, b.revision_tree(rev_id),
1521
 
                                not no_backup)
1522
 
 
1523
 
 
1524
 
class cmd_assert_fail(Command):
1525
 
    """Test reporting of assertion failures"""
1526
 
    hidden = True
1527
 
    def run(self):
1528
 
        assert False, "always fails"
1529
 
 
1530
 
 
1531
 
class cmd_help(Command):
1532
 
    """Show help on a command or other topic.
1533
 
 
1534
 
    For a list of all available commands, say 'bzr help commands'."""
1535
 
    takes_options = ['long']
1536
 
    takes_args = ['topic?']
1537
 
    aliases = ['?']
1538
 
    
1539
 
    @display_command
1540
 
    def run(self, topic=None, long=False):
1541
 
        import help
1542
 
        if topic is None and long:
1543
 
            topic = "commands"
1544
 
        help.help(topic)
1545
 
 
1546
 
 
1547
 
class cmd_shell_complete(Command):
1548
 
    """Show appropriate completions for context.
1549
 
 
1550
 
    For a list of all available commands, say 'bzr shell-complete'."""
1551
 
    takes_args = ['context?']
1552
 
    aliases = ['s-c']
1553
 
    hidden = True
1554
 
    
1555
 
    @display_command
1556
 
    def run(self, context=None):
1557
 
        import shellcomplete
1558
 
        shellcomplete.shellcomplete(context)
1559
 
 
1560
 
 
1561
 
class cmd_fetch(Command):
1562
 
    """Copy in history from another branch but don't merge it.
1563
 
 
1564
 
    This is an internal method used for pull and merge."""
1565
 
    hidden = True
1566
 
    takes_args = ['from_branch', 'to_branch']
1567
 
    def run(self, from_branch, to_branch):
1568
 
        from bzrlib.fetch import Fetcher
1569
 
        from bzrlib.branch import Branch
1570
 
        from_b = Branch.open(from_branch)
1571
 
        to_b = Branch.open(to_branch)
1572
 
        from_b.lock_read()
1573
 
        try:
1574
 
            to_b.lock_write()
1575
 
            try:
1576
 
                Fetcher(to_b, from_b)
1577
 
            finally:
1578
 
                to_b.unlock()
1579
 
        finally:
1580
 
            from_b.unlock()
1581
 
 
1582
 
 
1583
 
class cmd_missing(Command):
1584
 
    """What is missing in this branch relative to other branch.
1585
 
    """
1586
 
    # TODO: rewrite this in terms of ancestry so that it shows only
1587
 
    # unmerged things
1588
 
    
1589
 
    takes_args = ['remote?']
1590
 
    aliases = ['mis', 'miss']
1591
 
    # We don't have to add quiet to the list, because 
1592
 
    # unknown options are parsed as booleans
1593
 
    takes_options = ['verbose', 'quiet']
1594
 
 
1595
 
    @display_command
1596
 
    def run(self, remote=None, verbose=False, quiet=False):
1597
 
        from bzrlib.errors import BzrCommandError
1598
 
        from bzrlib.missing import show_missing
1599
 
 
1600
 
        if verbose and quiet:
1601
 
            raise BzrCommandError('Cannot pass both quiet and verbose')
1602
 
 
1603
 
        b = Branch.open_containing('.')[0]
1604
 
        parent = b.get_parent()
1605
 
        if remote is None:
1606
 
            if parent is None:
1607
 
                raise BzrCommandError("No missing location known or specified.")
1608
 
            else:
1609
 
                if not quiet:
1610
 
                    print "Using last location: %s" % parent
1611
 
                remote = parent
1612
 
        elif parent is None:
1613
 
            # We only update parent if it did not exist, missing
1614
 
            # should not change the parent
1615
 
            b.set_parent(remote)
1616
 
        br_remote = Branch.open_containing(remote)[0]
1617
 
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1618
 
 
1619
 
 
1620
 
class cmd_plugins(Command):
1621
 
    """List plugins"""
1622
 
    hidden = True
1623
 
    @display_command
1624
 
    def run(self):
1625
 
        import bzrlib.plugin
1626
 
        from inspect import getdoc
1627
 
        for plugin in bzrlib.plugin.all_plugins:
1628
 
            if hasattr(plugin, '__path__'):
1629
 
                print plugin.__path__[0]
1630
 
            elif hasattr(plugin, '__file__'):
1631
 
                print plugin.__file__
1632
 
            else:
1633
 
                print `plugin`
1634
 
                
1635
 
            d = getdoc(plugin)
1636
 
            if d:
1637
 
                print '\t', d.split('\n')[0]
1638
 
 
1639
 
 
1640
 
class cmd_testament(Command):
1641
 
    """Show testament (signing-form) of a revision."""
1642
 
    takes_options = ['revision', 'long']
1643
 
    takes_args = ['branch?']
1644
 
    @display_command
1645
 
    def run(self, branch='.', revision=None, long=False):
1646
 
        from bzrlib.testament import Testament
1647
 
        b = Branch.open_containing(branch)[0]
1648
 
        b.lock_read()
1649
 
        try:
1650
 
            if revision is None:
1651
 
                rev_id = b.last_revision()
1652
 
            else:
1653
 
                rev_id = revision[0].in_history(b).rev_id
1654
 
            t = Testament.from_revision(b, rev_id)
1655
 
            if long:
1656
 
                sys.stdout.writelines(t.as_text_lines())
1657
 
            else:
1658
 
                sys.stdout.write(t.as_short_text())
1659
 
        finally:
1660
 
            b.unlock()
1661
 
 
1662
 
 
1663
 
class cmd_annotate(Command):
1664
 
    """Show the origin of each line in a file.
1665
 
 
1666
 
    This prints out the given file with an annotation on the left side
1667
 
    indicating which revision, author and date introduced the change.
1668
 
 
1669
 
    If the origin is the same for a run of consecutive lines, it is 
1670
 
    shown only at the top, unless the --all option is given.
1671
 
    """
1672
 
    # TODO: annotate directories; showing when each file was last changed
1673
 
    # TODO: annotate a previous version of a file
1674
 
    # TODO: if the working copy is modified, show annotations on that 
1675
 
    #       with new uncommitted lines marked
1676
 
    aliases = ['blame', 'praise']
1677
 
    takes_args = ['filename']
1678
 
    takes_options = [Option('all', help='show annotations on all lines'),
1679
 
                     Option('long', help='show date in annotations'),
1680
 
                     ]
1681
 
 
1682
 
    @display_command
1683
 
    def run(self, filename, all=False, long=False):
1684
 
        from bzrlib.annotate import annotate_file
1685
 
        b, relpath = Branch.open_containing(filename)
1686
 
        b.lock_read()
1687
 
        try:
1688
 
            tree = WorkingTree(b.base, b)
1689
 
            tree = b.revision_tree(b.last_revision())
1690
 
            file_id = tree.inventory.path2id(relpath)
1691
 
            file_version = tree.inventory[file_id].revision
1692
 
            annotate_file(b, file_version, file_id, long, all, sys.stdout)
1693
 
        finally:
1694
 
            b.unlock()
1695
 
 
1696
 
 
1697
 
class cmd_re_sign(Command):
1698
 
    """Create a digital signature for an existing revision."""
1699
 
    # TODO be able to replace existing ones.
1700
 
 
1701
 
    hidden = True # is this right ?
1702
 
    takes_args = ['revision_id?']
1703
 
    takes_options = ['revision']
1704
 
    
1705
 
    def run(self, revision_id=None, revision=None):
1706
 
        import bzrlib.config as config
1707
 
        import bzrlib.gpg as gpg
1708
 
        if revision_id is not None and revision is not None:
1709
 
            raise BzrCommandError('You can only supply one of revision_id or --revision')
1710
 
        if revision_id is None and revision is None:
1711
 
            raise BzrCommandError('You must supply either --revision or a revision_id')
1712
 
        b = Branch.open_containing('.')[0]
1713
 
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1714
 
        if revision_id is not None:
1715
 
            b.sign_revision(revision_id, gpg_strategy)
1716
 
        elif revision is not None:
1717
 
            if len(revision) == 1:
1718
 
                revno, rev_id = revision[0].in_history(b)
1719
 
                b.sign_revision(rev_id, gpg_strategy)
1720
 
            elif len(revision) == 2:
1721
 
                # are they both on rh- if so we can walk between them
1722
 
                # might be nice to have a range helper for arbitrary
1723
 
                # revision paths. hmm.
1724
 
                from_revno, from_revid = revision[0].in_history(b)
1725
 
                to_revno, to_revid = revision[1].in_history(b)
1726
 
                if to_revid is None:
1727
 
                    to_revno = b.revno()
1728
 
                if from_revno is None or to_revno is None:
1729
 
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
1730
 
                for revno in range(from_revno, to_revno + 1):
1731
 
                    b.sign_revision(b.get_rev_id(revno), gpg_strategy)
1732
 
            else:
1733
 
                raise BzrCommandError('Please supply either one revision, or a range.')
1734
 
 
1735
 
 
1736
 
# these get imported and then picked up by the scan for cmd_*
1737
 
# TODO: Some more consistent way to split command definitions across files;
1738
 
# we do need to load at least some information about them to know of 
1739
 
# aliases.
1740
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts