← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2005-10-30 00:00:09 UTC
  • mfrom: (1185.16.134)
  • Revision ID: robertc@robertcollins.net-20051030000009-9db99a338a0dfdac
Merge from Martin.

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
 
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.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
        if br_to.get_parent() is None or remember:
 
383
            br_to.set_parent(location)
 
384
        br_from = Branch.open(location)
 
385
        try:
 
386
            br_to.working_tree().pull(br_from, overwrite)
 
387
        except DivergedBranches:
 
388
            raise BzrCommandError("These branches have diverged."
 
389
                                  "  Try merge.")
 
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
    takes_args = ['location?']
 
417
 
 
418
    def run(self, location=None, remember=False, overwrite=False):
 
419
        import errno
 
420
        from shutil import rmtree
 
421
        from bzrlib.transport import get_transport
 
422
        
 
423
        br_from = Branch.open_containing('.')[0]
 
424
        stored_loc = br_from.get_push_location()
 
425
        if location is None:
 
426
            if stored_loc is None:
 
427
                raise BzrCommandError("No push location known or specified.")
 
428
            else:
 
429
                print "Using saved location: %s" % stored_loc
 
430
                location = stored_loc
 
431
        if br_from.get_push_location() is None or remember:
 
432
            br_from.set_push_location(location)
 
433
        try:
 
434
            br_to = Branch.open(location)
 
435
        except NotBranchError:
 
436
            # create a branch.
 
437
            transport = get_transport(location).clone('..')
 
438
            transport.mkdir(transport.relpath(location))
 
439
            br_to = Branch.initialize(location)
 
440
        try:
 
441
            br_to.pull(br_from, overwrite)
 
442
        except DivergedBranches:
 
443
            raise BzrCommandError("These branches have diverged."
 
444
                                  "  Try a merge then push with overwrite.")
 
445
 
 
446
 
 
447
class cmd_branch(Command):
 
448
    """Create a new copy of a branch.
 
449
 
 
450
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
451
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
452
 
 
453
    To retrieve the branch as of a particular revision, supply the --revision
 
454
    parameter, as in "branch foo/bar -r 5".
 
455
 
 
456
    --basis is to speed up branching from remote branches.  When specified, it
 
457
    copies all the file-contents, inventory and revision data from the basis
 
458
    branch before copying anything from the remote branch.
 
459
    """
 
460
    takes_args = ['from_location', 'to_location?']
 
461
    takes_options = ['revision', 'basis']
 
462
    aliases = ['get', 'clone']
 
463
 
 
464
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
465
        from bzrlib.clone import copy_branch
 
466
        import errno
 
467
        from shutil import rmtree
 
468
        if revision is None:
 
469
            revision = [None]
 
470
        elif len(revision) > 1:
 
471
            raise BzrCommandError(
 
472
                'bzr branch --revision takes exactly 1 revision value')
 
473
        try:
 
474
            br_from = Branch.open(from_location)
 
475
        except OSError, e:
 
476
            if e.errno == errno.ENOENT:
 
477
                raise BzrCommandError('Source location "%s" does not'
 
478
                                      ' exist.' % to_location)
 
479
            else:
 
480
                raise
 
481
        br_from.lock_read()
 
482
        try:
 
483
            if basis is not None:
 
484
                basis_branch = Branch.open_containing(basis)[0]
 
485
            else:
 
486
                basis_branch = None
 
487
            if len(revision) == 1 and revision[0] is not None:
 
488
                revision_id = revision[0].in_history(br_from)[1]
 
489
            else:
 
490
                revision_id = None
 
491
            if to_location is None:
 
492
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
493
                name = None
 
494
            else:
 
495
                name = os.path.basename(to_location) + '\n'
 
496
            try:
 
497
                os.mkdir(to_location)
 
498
            except OSError, e:
 
499
                if e.errno == errno.EEXIST:
 
500
                    raise BzrCommandError('Target directory "%s" already'
 
501
                                          ' exists.' % to_location)
 
502
                if e.errno == errno.ENOENT:
 
503
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
504
                                          to_location)
 
505
                else:
 
506
                    raise
 
507
            try:
 
508
                copy_branch(br_from, to_location, revision_id, basis_branch)
 
509
            except bzrlib.errors.NoSuchRevision:
 
510
                rmtree(to_location)
 
511
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
512
                raise BzrCommandError(msg)
 
513
            except bzrlib.errors.UnlistableBranch:
 
514
                rmtree(to_location)
 
515
                msg = "The branch %s cannot be used as a --basis"
 
516
                raise BzrCommandError(msg)
 
517
            if name:
 
518
                branch = Branch.open(to_location)
 
519
                name = StringIO(name)
 
520
                branch.put_controlfile('branch-name', name)
 
521
        finally:
 
522
            br_from.unlock()
 
523
 
 
524
 
 
525
class cmd_renames(Command):
 
526
    """Show list of renamed files.
 
527
    """
 
528
    # TODO: Option to show renames between two historical versions.
 
529
 
 
530
    # TODO: Only show renames under dir, rather than in the whole branch.
 
531
    takes_args = ['dir?']
 
532
 
 
533
    @display_command
 
534
    def run(self, dir='.'):
 
535
        b = Branch.open_containing(dir)[0]
 
536
        old_inv = b.basis_tree().inventory
 
537
        new_inv = b.read_working_inventory()
 
538
 
 
539
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
540
        renames.sort()
 
541
        for old_name, new_name in renames:
 
542
            print "%s => %s" % (old_name, new_name)        
 
543
 
 
544
 
 
545
class cmd_info(Command):
 
546
    """Show statistical information about a branch."""
 
547
    takes_args = ['branch?']
 
548
    
 
549
    @display_command
 
550
    def run(self, branch=None):
 
551
        import info
 
552
        b = Branch.open_containing(branch)[0]
 
553
        info.show_info(b)
 
554
 
 
555
 
 
556
class cmd_remove(Command):
 
557
    """Make a file unversioned.
 
558
 
 
559
    This makes bzr stop tracking changes to a versioned file.  It does
 
560
    not delete the working copy.
 
561
    """
 
562
    takes_args = ['file+']
 
563
    takes_options = ['verbose']
 
564
    aliases = ['rm']
 
565
    
 
566
    def run(self, file_list, verbose=False):
 
567
        b, file_list = branch_files(file_list)
 
568
        tree = b.working_tree()
 
569
        tree.remove(file_list, verbose=verbose)
 
570
 
 
571
 
 
572
class cmd_file_id(Command):
 
573
    """Print file_id of a particular file or directory.
 
574
 
 
575
    The file_id is assigned when the file is first added and remains the
 
576
    same through all revisions where the file exists, even when it is
 
577
    moved or renamed.
 
578
    """
 
579
    hidden = True
 
580
    takes_args = ['filename']
 
581
    @display_command
 
582
    def run(self, filename):
 
583
        b, relpath = Branch.open_containing(filename)
 
584
        i = b.inventory.path2id(relpath)
 
585
        if i == None:
 
586
            raise BzrError("%r is not a versioned file" % filename)
 
587
        else:
 
588
            print i
 
589
 
 
590
 
 
591
class cmd_file_path(Command):
 
592
    """Print path of file_ids to a file or directory.
 
593
 
 
594
    This prints one line for each directory down to the target,
 
595
    starting at the branch root."""
 
596
    hidden = True
 
597
    takes_args = ['filename']
 
598
    @display_command
 
599
    def run(self, filename):
 
600
        b, relpath = Branch.open_containing(filename)
 
601
        inv = b.inventory
 
602
        fid = inv.path2id(relpath)
 
603
        if fid == None:
 
604
            raise BzrError("%r is not a versioned file" % filename)
 
605
        for fip in inv.get_idpath(fid):
 
606
            print fip
 
607
 
 
608
 
 
609
class cmd_revision_history(Command):
 
610
    """Display list of revision ids on this branch."""
 
611
    hidden = True
 
612
    @display_command
 
613
    def run(self):
 
614
        for patchid in Branch.open_containing('.')[0].revision_history():
 
615
            print patchid
 
616
 
 
617
 
 
618
class cmd_ancestry(Command):
 
619
    """List all revisions merged into this branch."""
 
620
    hidden = True
 
621
    @display_command
 
622
    def run(self):
 
623
        b = Branch.open_containing('.')[0]
 
624
        for revision_id in b.get_ancestry(b.last_revision()):
 
625
            print revision_id
 
626
 
 
627
 
 
628
class cmd_directories(Command):
 
629
    """Display list of versioned directories in this branch."""
 
630
    @display_command
 
631
    def run(self):
 
632
        for name, ie in Branch.open_containing('.')[0].read_working_inventory().directories():
 
633
            if name == '':
 
634
                print '.'
 
635
            else:
 
636
                print name
 
637
 
 
638
 
 
639
class cmd_init(Command):
 
640
    """Make a directory into a versioned branch.
 
641
 
 
642
    Use this to create an empty branch, or before importing an
 
643
    existing project.
 
644
 
 
645
    Recipe for importing a tree of files:
 
646
        cd ~/project
 
647
        bzr init
 
648
        bzr add .
 
649
        bzr status
 
650
        bzr commit -m 'imported project'
 
651
    """
 
652
    def run(self):
 
653
        Branch.initialize('.')
 
654
 
 
655
 
 
656
class cmd_diff(Command):
 
657
    """Show differences in working tree.
 
658
    
 
659
    If files are listed, only the changes in those files are listed.
 
660
    Otherwise, all changes for the tree are listed.
 
661
 
 
662
    examples:
 
663
        bzr diff
 
664
        bzr diff -r1
 
665
        bzr diff -r1..2
 
666
    """
 
667
    # TODO: Allow diff across branches.
 
668
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
669
    #       or a graphical diff.
 
670
 
 
671
    # TODO: Python difflib is not exactly the same as unidiff; should
 
672
    #       either fix it up or prefer to use an external diff.
 
673
 
 
674
    # TODO: If a directory is given, diff everything under that.
 
675
 
 
676
    # TODO: Selected-file diff is inefficient and doesn't show you
 
677
    #       deleted files.
 
678
 
 
679
    # TODO: This probably handles non-Unix newlines poorly.
 
680
    
 
681
    takes_args = ['file*']
 
682
    takes_options = ['revision', 'diff-options']
 
683
    aliases = ['di', 'dif']
 
684
 
 
685
    @display_command
 
686
    def run(self, revision=None, file_list=None, diff_options=None):
 
687
        from bzrlib.diff import show_diff
 
688
        
 
689
        b, file_list = branch_files(file_list)
 
690
        if revision is not None:
 
691
            if len(revision) == 1:
 
692
                return show_diff(b, revision[0], specific_files=file_list,
 
693
                                 external_diff_options=diff_options)
 
694
            elif len(revision) == 2:
 
695
                return show_diff(b, revision[0], specific_files=file_list,
 
696
                                 external_diff_options=diff_options,
 
697
                                 revision2=revision[1])
 
698
            else:
 
699
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
700
        else:
 
701
            return show_diff(b, None, specific_files=file_list,
 
702
                             external_diff_options=diff_options)
 
703
 
 
704
 
 
705
class cmd_deleted(Command):
 
706
    """List files deleted in the working tree.
 
707
    """
 
708
    # TODO: Show files deleted since a previous revision, or
 
709
    # between two revisions.
 
710
    # TODO: Much more efficient way to do this: read in new
 
711
    # directories with readdir, rather than stating each one.  Same
 
712
    # level of effort but possibly much less IO.  (Or possibly not,
 
713
    # if the directories are very large...)
 
714
    @display_command
 
715
    def run(self, show_ids=False):
 
716
        b = Branch.open_containing('.')[0]
 
717
        old = b.basis_tree()
 
718
        new = b.working_tree()
 
719
        for path, ie in old.inventory.iter_entries():
 
720
            if not new.has_id(ie.file_id):
 
721
                if show_ids:
 
722
                    print '%-50s %s' % (path, ie.file_id)
 
723
                else:
 
724
                    print path
 
725
 
 
726
 
 
727
class cmd_modified(Command):
 
728
    """List files modified in working tree."""
 
729
    hidden = True
 
730
    @display_command
 
731
    def run(self):
 
732
        from bzrlib.delta import compare_trees
 
733
 
 
734
        b = Branch.open_containing('.')[0]
 
735
        td = compare_trees(b.basis_tree(), b.working_tree())
 
736
 
 
737
        for path, id, kind, text_modified, meta_modified in td.modified:
 
738
            print path
 
739
 
 
740
 
 
741
 
 
742
class cmd_added(Command):
 
743
    """List files added in working tree."""
 
744
    hidden = True
 
745
    @display_command
 
746
    def run(self):
 
747
        b = Branch.open_containing('.')[0]
 
748
        wt = b.working_tree()
 
749
        basis_inv = b.basis_tree().inventory
 
750
        inv = wt.inventory
 
751
        for file_id in inv:
 
752
            if file_id in basis_inv:
 
753
                continue
 
754
            path = inv.id2path(file_id)
 
755
            if not os.access(b.abspath(path), os.F_OK):
 
756
                continue
 
757
            print path
 
758
                
 
759
        
 
760
 
 
761
class cmd_root(Command):
 
762
    """Show the tree root directory.
 
763
 
 
764
    The root is the nearest enclosing directory with a .bzr control
 
765
    directory."""
 
766
    takes_args = ['filename?']
 
767
    @display_command
 
768
    def run(self, filename=None):
 
769
        """Print the branch root."""
 
770
        b = Branch.open_containing(filename)[0]
 
771
        print b.base
 
772
 
 
773
 
 
774
class cmd_log(Command):
 
775
    """Show log of this branch.
 
776
 
 
777
    To request a range of logs, you can use the command -r begin:end
 
778
    -r revision requests a specific revision, -r :end or -r begin: are
 
779
    also valid.
 
780
    """
 
781
 
 
782
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
783
 
 
784
    takes_args = ['filename?']
 
785
    takes_options = [Option('forward', 
 
786
                            help='show from oldest to newest'),
 
787
                     'timezone', 'verbose', 
 
788
                     'show-ids', 'revision',
 
789
                     Option('line', help='format with one line per revision'),
 
790
                     'long', 
 
791
                     Option('message',
 
792
                            help='show revisions whose message matches this regexp',
 
793
                            type=str),
 
794
                     Option('short', help='use moderately short format'),
 
795
                     ]
 
796
    @display_command
 
797
    def run(self, filename=None, timezone='original',
 
798
            verbose=False,
 
799
            show_ids=False,
 
800
            forward=False,
 
801
            revision=None,
 
802
            message=None,
 
803
            long=False,
 
804
            short=False,
 
805
            line=False):
 
806
        from bzrlib.log import log_formatter, show_log
 
807
        import codecs
 
808
        assert message is None or isinstance(message, basestring), \
 
809
            "invalid message argument %r" % message
 
810
        direction = (forward and 'forward') or 'reverse'
 
811
        
 
812
        if filename:
 
813
            b, fp = Branch.open_containing(filename)
 
814
            if fp != '':
 
815
                file_id = b.read_working_inventory().path2id(fp)
 
816
            else:
 
817
                file_id = None  # points to branch root
 
818
        else:
 
819
            b, relpath = Branch.open_containing('.')
 
820
            file_id = None
 
821
 
 
822
        if revision is None:
 
823
            rev1 = None
 
824
            rev2 = None
 
825
        elif len(revision) == 1:
 
826
            rev1 = rev2 = revision[0].in_history(b).revno
 
827
        elif len(revision) == 2:
 
828
            rev1 = revision[0].in_history(b).revno
 
829
            rev2 = revision[1].in_history(b).revno
 
830
        else:
 
831
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
832
 
 
833
        if rev1 == 0:
 
834
            rev1 = None
 
835
        if rev2 == 0:
 
836
            rev2 = None
 
837
 
 
838
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
839
 
 
840
        # use 'replace' so that we don't abort if trying to write out
 
841
        # in e.g. the default C locale.
 
842
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
843
 
 
844
        log_format = 'long'
 
845
        if short:
 
846
            log_format = 'short'
 
847
        if line:
 
848
            log_format = 'line'
 
849
        lf = log_formatter(log_format,
 
850
                           show_ids=show_ids,
 
851
                           to_file=outf,
 
852
                           show_timezone=timezone)
 
853
 
 
854
        show_log(b,
 
855
                 lf,
 
856
                 file_id,
 
857
                 verbose=verbose,
 
858
                 direction=direction,
 
859
                 start_revision=rev1,
 
860
                 end_revision=rev2,
 
861
                 search=message)
 
862
 
 
863
 
 
864
 
 
865
class cmd_touching_revisions(Command):
 
866
    """Return revision-ids which affected a particular file.
 
867
 
 
868
    A more user-friendly interface is "bzr log FILE"."""
 
869
    hidden = True
 
870
    takes_args = ["filename"]
 
871
    @display_command
 
872
    def run(self, filename):
 
873
        b, relpath = Branch.open_containing(filename)[0]
 
874
        inv = b.read_working_inventory()
 
875
        file_id = inv.path2id(relpath)
 
876
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
877
            print "%6d %s" % (revno, what)
 
878
 
 
879
 
 
880
class cmd_ls(Command):
 
881
    """List files in a tree.
 
882
    """
 
883
    # TODO: Take a revision or remote path and list that tree instead.
 
884
    hidden = True
 
885
    takes_options = ['verbose', 'revision',
 
886
                     Option('non-recursive',
 
887
                            help='don\'t recurse into sub-directories'),
 
888
                     Option('from-root',
 
889
                            help='Print all paths from the root of the branch.'),
 
890
                     Option('unknown', help='Print unknown files'),
 
891
                     Option('versioned', help='Print versioned files'),
 
892
                     Option('ignored', help='Print ignored files'),
 
893
 
 
894
                     Option('null', help='Null separate the files'),
 
895
                    ]
 
896
    @display_command
 
897
    def run(self, revision=None, verbose=False, 
 
898
            non_recursive=False, from_root=False,
 
899
            unknown=False, versioned=False, ignored=False,
 
900
            null=False):
 
901
 
 
902
        if verbose and null:
 
903
            raise BzrCommandError('Cannot set both --verbose and --null')
 
904
        all = not (unknown or versioned or ignored)
 
905
 
 
906
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
907
 
 
908
        b, relpath = Branch.open_containing('.')
 
909
        if from_root:
 
910
            relpath = ''
 
911
        elif relpath:
 
912
            relpath += '/'
 
913
        if revision == None:
 
914
            tree = b.working_tree()
 
915
        else:
 
916
            tree = b.revision_tree(revision[0].in_history(b).rev_id)
 
917
        for fp, fc, kind, fid, entry in tree.list_files():
 
918
            if fp.startswith(relpath):
 
919
                fp = fp[len(relpath):]
 
920
                if non_recursive and '/' in fp:
 
921
                    continue
 
922
                if not all and not selection[fc]:
 
923
                    continue
 
924
                if verbose:
 
925
                    kindch = entry.kind_character()
 
926
                    print '%-8s %s%s' % (fc, fp, kindch)
 
927
                elif null:
 
928
                    sys.stdout.write(fp)
 
929
                    sys.stdout.write('\0')
 
930
                    sys.stdout.flush()
 
931
                else:
 
932
                    print fp
 
933
 
 
934
 
 
935
 
 
936
class cmd_unknowns(Command):
 
937
    """List unknown files."""
 
938
    @display_command
 
939
    def run(self):
 
940
        from bzrlib.osutils import quotefn
 
941
        for f in Branch.open_containing('.')[0].unknowns():
 
942
            print quotefn(f)
 
943
 
 
944
 
 
945
 
 
946
class cmd_ignore(Command):
 
947
    """Ignore a command or pattern.
 
948
 
 
949
    To remove patterns from the ignore list, edit the .bzrignore file.
 
950
 
 
951
    If the pattern contains a slash, it is compared to the whole path
 
952
    from the branch root.  Otherwise, it is compared to only the last
 
953
    component of the path.  To match a file only in the root directory,
 
954
    prepend './'.
 
955
 
 
956
    Ignore patterns are case-insensitive on case-insensitive systems.
 
957
 
 
958
    Note: wildcards must be quoted from the shell on Unix.
 
959
 
 
960
    examples:
 
961
        bzr ignore ./Makefile
 
962
        bzr ignore '*.class'
 
963
    """
 
964
    # TODO: Complain if the filename is absolute
 
965
    takes_args = ['name_pattern']
 
966
    
 
967
    def run(self, name_pattern):
 
968
        from bzrlib.atomicfile import AtomicFile
 
969
        import os.path
 
970
 
 
971
        b, relpath = Branch.open_containing('.')
 
972
        ifn = b.abspath('.bzrignore')
 
973
 
 
974
        if os.path.exists(ifn):
 
975
            f = open(ifn, 'rt')
 
976
            try:
 
977
                igns = f.read().decode('utf-8')
 
978
            finally:
 
979
                f.close()
 
980
        else:
 
981
            igns = ''
 
982
 
 
983
        # TODO: If the file already uses crlf-style termination, maybe
 
984
        # we should use that for the newly added lines?
 
985
 
 
986
        if igns and igns[-1] != '\n':
 
987
            igns += '\n'
 
988
        igns += name_pattern + '\n'
 
989
 
 
990
        try:
 
991
            f = AtomicFile(ifn, 'wt')
 
992
            f.write(igns.encode('utf-8'))
 
993
            f.commit()
 
994
        finally:
 
995
            f.close()
 
996
 
 
997
        inv = b.working_tree().inventory
 
998
        if inv.path2id('.bzrignore'):
 
999
            mutter('.bzrignore is already versioned')
 
1000
        else:
 
1001
            mutter('need to make new .bzrignore file versioned')
 
1002
            b.add(['.bzrignore'])
 
1003
 
 
1004
 
 
1005
 
 
1006
class cmd_ignored(Command):
 
1007
    """List ignored files and the patterns that matched them.
 
1008
 
 
1009
    See also: bzr ignore"""
 
1010
    @display_command
 
1011
    def run(self):
 
1012
        tree = Branch.open_containing('.')[0].working_tree()
 
1013
        for path, file_class, kind, file_id, entry in tree.list_files():
 
1014
            if file_class != 'I':
 
1015
                continue
 
1016
            ## XXX: Slightly inefficient since this was already calculated
 
1017
            pat = tree.is_ignored(path)
 
1018
            print '%-50s %s' % (path, pat)
 
1019
 
 
1020
 
 
1021
class cmd_lookup_revision(Command):
 
1022
    """Lookup the revision-id from a revision-number
 
1023
 
 
1024
    example:
 
1025
        bzr lookup-revision 33
 
1026
    """
 
1027
    hidden = True
 
1028
    takes_args = ['revno']
 
1029
    
 
1030
    @display_command
 
1031
    def run(self, revno):
 
1032
        try:
 
1033
            revno = int(revno)
 
1034
        except ValueError:
 
1035
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1036
 
 
1037
        print Branch.open_containing('.')[0].get_rev_id(revno)
 
1038
 
 
1039
 
 
1040
class cmd_export(Command):
 
1041
    """Export past revision to destination directory.
 
1042
 
 
1043
    If no revision is specified this exports the last committed revision.
 
1044
 
 
1045
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1046
    given, try to find the format with the extension. If no extension
 
1047
    is found exports to a directory (equivalent to --format=dir).
 
1048
 
 
1049
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1050
    is given, the top directory will be the root name of the file."""
 
1051
    # TODO: list known exporters
 
1052
    takes_args = ['dest']
 
1053
    takes_options = ['revision', 'format', 'root']
 
1054
    def run(self, dest, revision=None, format=None, root=None):
 
1055
        import os.path
 
1056
        b = Branch.open_containing('.')[0]
 
1057
        if revision is None:
 
1058
            rev_id = b.last_revision()
 
1059
        else:
 
1060
            if len(revision) != 1:
 
1061
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1062
            rev_id = revision[0].in_history(b).rev_id
 
1063
        t = b.revision_tree(rev_id)
 
1064
        arg_root, ext = os.path.splitext(os.path.basename(dest))
 
1065
        if ext in ('.gz', '.bz2'):
 
1066
            new_root, new_ext = os.path.splitext(arg_root)
 
1067
            if new_ext == '.tar':
 
1068
                arg_root = new_root
 
1069
                ext = new_ext + ext
 
1070
        if root is None:
 
1071
            root = arg_root
 
1072
        if not format:
 
1073
            if ext in (".tar",):
 
1074
                format = "tar"
 
1075
            elif ext in (".tar.gz", ".tgz"):
 
1076
                format = "tgz"
 
1077
            elif ext in (".tar.bz2", ".tbz2"):
 
1078
                format = "tbz2"
 
1079
            else:
 
1080
                format = "dir"
 
1081
        t.export(dest, format, root)
 
1082
 
 
1083
 
 
1084
class cmd_cat(Command):
 
1085
    """Write a file's text from a previous revision."""
 
1086
 
 
1087
    takes_options = ['revision']
 
1088
    takes_args = ['filename']
 
1089
 
 
1090
    @display_command
 
1091
    def run(self, filename, revision=None):
 
1092
        if revision is None:
 
1093
            raise BzrCommandError("bzr cat requires a revision number")
 
1094
        elif len(revision) != 1:
 
1095
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1096
        b, relpath = Branch.open_containing(filename)
 
1097
        b.print_file(relpath, revision[0].in_history(b).revno)
 
1098
 
 
1099
 
 
1100
class cmd_local_time_offset(Command):
 
1101
    """Show the offset in seconds from GMT to local time."""
 
1102
    hidden = True    
 
1103
    @display_command
 
1104
    def run(self):
 
1105
        print bzrlib.osutils.local_time_offset()
 
1106
 
 
1107
 
 
1108
 
 
1109
class cmd_commit(Command):
 
1110
    """Commit changes into a new revision.
 
1111
    
 
1112
    If no arguments are given, the entire tree is committed.
 
1113
 
 
1114
    If selected files are specified, only changes to those files are
 
1115
    committed.  If a directory is specified then the directory and everything 
 
1116
    within it is committed.
 
1117
 
 
1118
    A selected-file commit may fail in some cases where the committed
 
1119
    tree would be invalid, such as trying to commit a file in a
 
1120
    newly-added directory that is not itself committed.
 
1121
    """
 
1122
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1123
 
 
1124
    # TODO: Strict commit that fails if there are deleted files.
 
1125
    #       (what does "deleted files" mean ??)
 
1126
 
 
1127
    # TODO: Give better message for -s, --summary, used by tla people
 
1128
 
 
1129
    # XXX: verbose currently does nothing
 
1130
 
 
1131
    takes_args = ['selected*']
 
1132
    takes_options = ['message', 'verbose', 
 
1133
                     Option('unchanged',
 
1134
                            help='commit even if nothing has changed'),
 
1135
                     Option('file', type=str, 
 
1136
                            argname='msgfile',
 
1137
                            help='file containing commit message'),
 
1138
                     Option('strict',
 
1139
                            help="refuse to commit if there are unknown "
 
1140
                            "files in the working tree."),
 
1141
                     ]
 
1142
    aliases = ['ci', 'checkin']
 
1143
 
 
1144
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1145
            unchanged=False, strict=False):
 
1146
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1147
                StrictCommitFailed)
 
1148
        from bzrlib.msgeditor import edit_commit_message
 
1149
        from bzrlib.status import show_status
 
1150
        from cStringIO import StringIO
 
1151
 
 
1152
        b, selected_list = branch_files(selected_list)
 
1153
        if message is None and not file:
 
1154
            catcher = StringIO()
 
1155
            show_status(b, specific_files=selected_list,
 
1156
                        to_file=catcher)
 
1157
            message = edit_commit_message(catcher.getvalue())
 
1158
 
 
1159
            if message is None:
 
1160
                raise BzrCommandError("please specify a commit message"
 
1161
                                      " with either --message or --file")
 
1162
        elif message and file:
 
1163
            raise BzrCommandError("please specify either --message or --file")
 
1164
        
 
1165
        if file:
 
1166
            import codecs
 
1167
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1168
 
 
1169
        if message == "":
 
1170
                raise BzrCommandError("empty commit message specified")
 
1171
            
 
1172
        try:
 
1173
            b.commit(message, specific_files=selected_list,
 
1174
                     allow_pointless=unchanged, strict=strict)
 
1175
        except PointlessCommit:
 
1176
            # FIXME: This should really happen before the file is read in;
 
1177
            # perhaps prepare the commit; get the message; then actually commit
 
1178
            raise BzrCommandError("no changes to commit",
 
1179
                                  ["use --unchanged to commit anyhow"])
 
1180
        except ConflictsInTree:
 
1181
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1182
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1183
        except StrictCommitFailed:
 
1184
            raise BzrCommandError("Commit refused because there are unknown "
 
1185
                                  "files in the working tree.")
 
1186
 
 
1187
 
 
1188
class cmd_check(Command):
 
1189
    """Validate consistency of branch history.
 
1190
 
 
1191
    This command checks various invariants about the branch storage to
 
1192
    detect data corruption or bzr bugs.
 
1193
    """
 
1194
    takes_args = ['dir?']
 
1195
    takes_options = ['verbose']
 
1196
 
 
1197
    def run(self, dir='.', verbose=False):
 
1198
        from bzrlib.check import check
 
1199
        check(Branch.open_containing(dir)[0], verbose)
 
1200
 
 
1201
 
 
1202
class cmd_scan_cache(Command):
 
1203
    hidden = True
 
1204
    def run(self):
 
1205
        from bzrlib.hashcache import HashCache
 
1206
 
 
1207
        c = HashCache('.')
 
1208
        c.read()
 
1209
        c.scan()
 
1210
            
 
1211
        print '%6d stats' % c.stat_count
 
1212
        print '%6d in hashcache' % len(c._cache)
 
1213
        print '%6d files removed from cache' % c.removed_count
 
1214
        print '%6d hashes updated' % c.update_count
 
1215
        print '%6d files changed too recently to cache' % c.danger_count
 
1216
 
 
1217
        if c.needs_write:
 
1218
            c.write()
 
1219
            
 
1220
 
 
1221
 
 
1222
class cmd_upgrade(Command):
 
1223
    """Upgrade branch storage to current format.
 
1224
 
 
1225
    The check command or bzr developers may sometimes advise you to run
 
1226
    this command.
 
1227
 
 
1228
    This version of this command upgrades from the full-text storage
 
1229
    used by bzr 0.0.8 and earlier to the weave format (v5).
 
1230
    """
 
1231
    takes_args = ['dir?']
 
1232
 
 
1233
    def run(self, dir='.'):
 
1234
        from bzrlib.upgrade import upgrade
 
1235
        upgrade(dir)
 
1236
 
 
1237
 
 
1238
class cmd_whoami(Command):
 
1239
    """Show bzr user id."""
 
1240
    takes_options = ['email']
 
1241
    
 
1242
    @display_command
 
1243
    def run(self, email=False):
 
1244
        try:
 
1245
            b = bzrlib.branch.Branch.open_containing('.')[0]
 
1246
            config = bzrlib.config.BranchConfig(b)
 
1247
        except NotBranchError:
 
1248
            config = bzrlib.config.GlobalConfig()
 
1249
        
 
1250
        if email:
 
1251
            print config.user_email()
 
1252
        else:
 
1253
            print config.username()
 
1254
 
 
1255
 
 
1256
class cmd_selftest(Command):
 
1257
    """Run internal test suite.
 
1258
    
 
1259
    This creates temporary test directories in the working directory,
 
1260
    but not existing data is affected.  These directories are deleted
 
1261
    if the tests pass, or left behind to help in debugging if they
 
1262
    fail.
 
1263
    
 
1264
    If arguments are given, they are regular expressions that say
 
1265
    which tests should run.
 
1266
    """
 
1267
    # TODO: --list should give a list of all available tests
 
1268
    hidden = True
 
1269
    takes_args = ['testspecs*']
 
1270
    takes_options = ['verbose', 
 
1271
                     Option('one', help='stop when one test fails'),
 
1272
                    ]
 
1273
 
 
1274
    def run(self, testspecs_list=None, verbose=False, one=False):
 
1275
        import bzrlib.ui
 
1276
        from bzrlib.selftest import selftest
 
1277
        # we don't want progress meters from the tests to go to the
 
1278
        # real output; and we don't want log messages cluttering up
 
1279
        # the real logs.
 
1280
        save_ui = bzrlib.ui.ui_factory
 
1281
        bzrlib.trace.info('running tests...')
 
1282
        try:
 
1283
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1284
            if testspecs_list is not None:
 
1285
                pattern = '|'.join(testspecs_list)
 
1286
            else:
 
1287
                pattern = ".*"
 
1288
            result = selftest(verbose=verbose, 
 
1289
                              pattern=pattern,
 
1290
                              stop_on_failure=one)
 
1291
            if result:
 
1292
                bzrlib.trace.info('tests passed')
 
1293
            else:
 
1294
                bzrlib.trace.info('tests failed')
 
1295
            return int(not result)
 
1296
        finally:
 
1297
            bzrlib.ui.ui_factory = save_ui
 
1298
 
 
1299
 
 
1300
def show_version():
 
1301
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1302
    # is bzrlib itself in a branch?
 
1303
    bzrrev = bzrlib.get_bzr_revision()
 
1304
    if bzrrev:
 
1305
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1306
    print bzrlib.__copyright__
 
1307
    print "http://bazaar-ng.org/"
 
1308
    print
 
1309
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1310
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1311
    print "General Public License version 2 or later."
 
1312
 
 
1313
 
 
1314
class cmd_version(Command):
 
1315
    """Show version of bzr."""
 
1316
    @display_command
 
1317
    def run(self):
 
1318
        show_version()
 
1319
 
 
1320
class cmd_rocks(Command):
 
1321
    """Statement of optimism."""
 
1322
    hidden = True
 
1323
    @display_command
 
1324
    def run(self):
 
1325
        print "it sure does!"
 
1326
 
 
1327
 
 
1328
class cmd_find_merge_base(Command):
 
1329
    """Find and print a base revision for merging two branches.
 
1330
    """
 
1331
    # TODO: Options to specify revisions on either side, as if
 
1332
    #       merging only part of the history.
 
1333
    takes_args = ['branch', 'other']
 
1334
    hidden = True
 
1335
    
 
1336
    @display_command
 
1337
    def run(self, branch, other):
 
1338
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1339
        
 
1340
        branch1 = Branch.open_containing(branch)[0]
 
1341
        branch2 = Branch.open_containing(other)[0]
 
1342
 
 
1343
        history_1 = branch1.revision_history()
 
1344
        history_2 = branch2.revision_history()
 
1345
 
 
1346
        last1 = branch1.last_revision()
 
1347
        last2 = branch2.last_revision()
 
1348
 
 
1349
        source = MultipleRevisionSources(branch1, branch2)
 
1350
        
 
1351
        base_rev_id = common_ancestor(last1, last2, source)
 
1352
 
 
1353
        print 'merge base is revision %s' % base_rev_id
 
1354
        
 
1355
        return
 
1356
 
 
1357
        if base_revno is None:
 
1358
            raise bzrlib.errors.UnrelatedBranches()
 
1359
 
 
1360
        print ' r%-6d in %s' % (base_revno, branch)
 
1361
 
 
1362
        other_revno = branch2.revision_id_to_revno(base_revid)
 
1363
        
 
1364
        print ' r%-6d in %s' % (other_revno, other)
 
1365
 
 
1366
 
 
1367
 
 
1368
class cmd_merge(Command):
 
1369
    """Perform a three-way merge.
 
1370
    
 
1371
    The branch is the branch you will merge from.  By default, it will
 
1372
    merge the latest revision.  If you specify a revision, that
 
1373
    revision will be merged.  If you specify two revisions, the first
 
1374
    will be used as a BASE, and the second one as OTHER.  Revision
 
1375
    numbers are always relative to the specified branch.
 
1376
 
 
1377
    By default bzr will try to merge in all new work from the other
 
1378
    branch, automatically determining an appropriate base.  If this
 
1379
    fails, you may need to give an explicit base.
 
1380
    
 
1381
    Examples:
 
1382
 
 
1383
    To merge the latest revision from bzr.dev
 
1384
    bzr merge ../bzr.dev
 
1385
 
 
1386
    To merge changes up to and including revision 82 from bzr.dev
 
1387
    bzr merge -r 82 ../bzr.dev
 
1388
 
 
1389
    To merge the changes introduced by 82, without previous changes:
 
1390
    bzr merge -r 81..82 ../bzr.dev
 
1391
    
 
1392
    merge refuses to run if there are any uncommitted changes, unless
 
1393
    --force is given.
 
1394
    """
 
1395
    takes_args = ['branch?']
 
1396
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
 
1397
                     Option('show-base', help="Show base revision text in "
 
1398
                            "conflicts")]
 
1399
 
 
1400
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1401
            show_base=False, reprocess=False):
 
1402
        from bzrlib.merge import merge
 
1403
        from bzrlib.merge_core import ApplyMerge3
 
1404
        if merge_type is None:
 
1405
            merge_type = ApplyMerge3
 
1406
        if branch is None:
 
1407
            branch = Branch.open_containing('.')[0].get_parent()
 
1408
            if branch is None:
 
1409
                raise BzrCommandError("No merge location known or specified.")
 
1410
            else:
 
1411
                print "Using saved location: %s" % branch 
 
1412
        if revision is None or len(revision) < 1:
 
1413
            base = [None, None]
 
1414
            other = [branch, -1]
 
1415
        else:
 
1416
            if len(revision) == 1:
 
1417
                base = [None, None]
 
1418
                other_branch = Branch.open_containing(branch)[0]
 
1419
                revno = revision[0].in_history(other_branch).revno
 
1420
                other = [branch, revno]
 
1421
            else:
 
1422
                assert len(revision) == 2
 
1423
                if None in revision:
 
1424
                    raise BzrCommandError(
 
1425
                        "Merge doesn't permit that revision specifier.")
 
1426
                b = Branch.open_containing(branch)[0]
 
1427
 
 
1428
                base = [branch, revision[0].in_history(b).revno]
 
1429
                other = [branch, revision[1].in_history(b).revno]
 
1430
 
 
1431
        try:
 
1432
            conflict_count = merge(other, base, check_clean=(not force),
 
1433
                                   merge_type=merge_type, reprocess=reprocess,
 
1434
                                   show_base=show_base)
 
1435
            if conflict_count != 0:
 
1436
                return 1
 
1437
            else:
 
1438
                return 0
 
1439
        except bzrlib.errors.AmbiguousBase, e:
 
1440
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
1441
                 "candidates are:\n  "
 
1442
                 + "\n  ".join(e.bases)
 
1443
                 + "\n"
 
1444
                 "please specify an explicit base with -r,\n"
 
1445
                 "and (if you want) report this to the bzr developers\n")
 
1446
            log_error(m)
 
1447
 
 
1448
 
 
1449
class cmd_revert(Command):
 
1450
    """Reverse all changes since the last commit.
 
1451
 
 
1452
    Only versioned files are affected.  Specify filenames to revert only 
 
1453
    those files.  By default, any files that are changed will be backed up
 
1454
    first.  Backup files have a '~' appended to their name.
 
1455
    """
 
1456
    takes_options = ['revision', 'no-backup']
 
1457
    takes_args = ['file*']
 
1458
    aliases = ['merge-revert']
 
1459
 
 
1460
    def run(self, revision=None, no_backup=False, file_list=None):
 
1461
        from bzrlib.merge import merge
 
1462
        from bzrlib.commands import parse_spec
 
1463
 
 
1464
        if file_list is not None:
 
1465
            if len(file_list) == 0:
 
1466
                raise BzrCommandError("No files specified")
 
1467
        if revision is None:
 
1468
            revno = -1
 
1469
        elif len(revision) != 1:
 
1470
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1471
        else:
 
1472
            b, file_list = branch_files(file_list)
 
1473
            revno = revision[0].in_history(b).revno
 
1474
        merge(('.', revno), parse_spec('.'),
 
1475
              check_clean=False,
 
1476
              ignore_zero=True,
 
1477
              backup_files=not no_backup,
 
1478
              file_list=file_list)
 
1479
        if not file_list:
 
1480
            Branch.open_containing('.')[0].set_pending_merges([])
 
1481
 
 
1482
 
 
1483
class cmd_assert_fail(Command):
 
1484
    """Test reporting of assertion failures"""
 
1485
    hidden = True
 
1486
    def run(self):
 
1487
        assert False, "always fails"
 
1488
 
 
1489
 
 
1490
class cmd_help(Command):
 
1491
    """Show help on a command or other topic.
 
1492
 
 
1493
    For a list of all available commands, say 'bzr help commands'."""
 
1494
    takes_options = ['long']
 
1495
    takes_args = ['topic?']
 
1496
    aliases = ['?']
 
1497
    
 
1498
    @display_command
 
1499
    def run(self, topic=None, long=False):
 
1500
        import help
 
1501
        if topic is None and long:
 
1502
            topic = "commands"
 
1503
        help.help(topic)
 
1504
 
 
1505
 
 
1506
class cmd_shell_complete(Command):
 
1507
    """Show appropriate completions for context.
 
1508
 
 
1509
    For a list of all available commands, say 'bzr shell-complete'."""
 
1510
    takes_args = ['context?']
 
1511
    aliases = ['s-c']
 
1512
    hidden = True
 
1513
    
 
1514
    @display_command
 
1515
    def run(self, context=None):
 
1516
        import shellcomplete
 
1517
        shellcomplete.shellcomplete(context)
 
1518
 
 
1519
 
 
1520
class cmd_fetch(Command):
 
1521
    """Copy in history from another branch but don't merge it.
 
1522
 
 
1523
    This is an internal method used for pull and merge."""
 
1524
    hidden = True
 
1525
    takes_args = ['from_branch', 'to_branch']
 
1526
    def run(self, from_branch, to_branch):
 
1527
        from bzrlib.fetch import Fetcher
 
1528
        from bzrlib.branch import Branch
 
1529
        from_b = Branch.open(from_branch)
 
1530
        to_b = Branch.open(to_branch)
 
1531
        from_b.lock_read()
 
1532
        try:
 
1533
            to_b.lock_write()
 
1534
            try:
 
1535
                Fetcher(to_b, from_b)
 
1536
            finally:
 
1537
                to_b.unlock()
 
1538
        finally:
 
1539
            from_b.unlock()
 
1540
 
 
1541
 
 
1542
class cmd_missing(Command):
 
1543
    """What is missing in this branch relative to other branch.
 
1544
    """
 
1545
    # TODO: rewrite this in terms of ancestry so that it shows only
 
1546
    # unmerged things
 
1547
    
 
1548
    takes_args = ['remote?']
 
1549
    aliases = ['mis', 'miss']
 
1550
    # We don't have to add quiet to the list, because 
 
1551
    # unknown options are parsed as booleans
 
1552
    takes_options = ['verbose', 'quiet']
 
1553
 
 
1554
    @display_command
 
1555
    def run(self, remote=None, verbose=False, quiet=False):
 
1556
        from bzrlib.errors import BzrCommandError
 
1557
        from bzrlib.missing import show_missing
 
1558
 
 
1559
        if verbose and quiet:
 
1560
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
1561
 
 
1562
        b = Branch.open_containing('.')[0]
 
1563
        parent = b.get_parent()
 
1564
        if remote is None:
 
1565
            if parent is None:
 
1566
                raise BzrCommandError("No missing location known or specified.")
 
1567
            else:
 
1568
                if not quiet:
 
1569
                    print "Using last location: %s" % parent
 
1570
                remote = parent
 
1571
        elif parent is None:
 
1572
            # We only update parent if it did not exist, missing
 
1573
            # should not change the parent
 
1574
            b.set_parent(remote)
 
1575
        br_remote = Branch.open_containing(remote)[0]
 
1576
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
1577
 
 
1578
 
 
1579
class cmd_plugins(Command):
 
1580
    """List plugins"""
 
1581
    hidden = True
 
1582
    @display_command
 
1583
    def run(self):
 
1584
        import bzrlib.plugin
 
1585
        from inspect import getdoc
 
1586
        for plugin in bzrlib.plugin.all_plugins:
 
1587
            if hasattr(plugin, '__path__'):
 
1588
                print plugin.__path__[0]
 
1589
            elif hasattr(plugin, '__file__'):
 
1590
                print plugin.__file__
 
1591
            else:
 
1592
                print `plugin`
 
1593
                
 
1594
            d = getdoc(plugin)
 
1595
            if d:
 
1596
                print '\t', d.split('\n')[0]
 
1597
 
 
1598
 
 
1599
class cmd_testament(Command):
 
1600
    """Show testament (signing-form) of a revision."""
 
1601
    takes_options = ['revision', 'long']
 
1602
    takes_args = ['branch?']
 
1603
    @display_command
 
1604
    def run(self, branch='.', revision=None, long=False):
 
1605
        from bzrlib.testament import Testament
 
1606
        b = Branch.open_containing(branch)[0]
 
1607
        b.lock_read()
 
1608
        try:
 
1609
            if revision is None:
 
1610
                rev_id = b.last_revision()
 
1611
            else:
 
1612
                rev_id = revision[0].in_history(b).rev_id
 
1613
            t = Testament.from_revision(b, rev_id)
 
1614
            if long:
 
1615
                sys.stdout.writelines(t.as_text_lines())
 
1616
            else:
 
1617
                sys.stdout.write(t.as_short_text())
 
1618
        finally:
 
1619
            b.unlock()
 
1620
 
 
1621
 
 
1622
class cmd_annotate(Command):
 
1623
    """Show the origin of each line in a file.
 
1624
 
 
1625
    This prints out the given file with an annotation on the left side
 
1626
    indicating which revision, author and date introduced the change.
 
1627
 
 
1628
    If the origin is the same for a run of consecutive lines, it is 
 
1629
    shown only at the top, unless the --all option is given.
 
1630
    """
 
1631
    # TODO: annotate directories; showing when each file was last changed
 
1632
    # TODO: annotate a previous version of a file
 
1633
    # TODO: if the working copy is modified, show annotations on that 
 
1634
    #       with new uncommitted lines marked
 
1635
    aliases = ['blame', 'praise']
 
1636
    takes_args = ['filename']
 
1637
    takes_options = [Option('all', help='show annotations on all lines'),
 
1638
                     Option('long', help='show date in annotations'),
 
1639
                     ]
 
1640
 
 
1641
    @display_command
 
1642
    def run(self, filename, all=False, long=False):
 
1643
        from bzrlib.annotate import annotate_file
 
1644
        b, relpath = Branch.open_containing(filename)
 
1645
        b.lock_read()
 
1646
        try:
 
1647
            tree = WorkingTree(b.base, b)
 
1648
            tree = b.revision_tree(b.last_revision())
 
1649
            file_id = tree.inventory.path2id(relpath)
 
1650
            file_version = tree.inventory[file_id].revision
 
1651
            annotate_file(b, file_version, file_id, long, all, sys.stdout)
 
1652
        finally:
 
1653
            b.unlock()
 
1654
 
 
1655
 
 
1656
class cmd_re_sign(Command):
 
1657
    """Create a digital signature for an existing revision."""
 
1658
    # TODO be able to replace existing ones.
 
1659
 
 
1660
    hidden = True # is this right ?
 
1661
    takes_args = ['revision_id?']
 
1662
    takes_options = ['revision']
 
1663
    
 
1664
    def run(self, revision_id=None, revision=None):
 
1665
        import bzrlib.config as config
 
1666
        import bzrlib.gpg as gpg
 
1667
        if revision_id is not None and revision is not None:
 
1668
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
1669
        if revision_id is None and revision is None:
 
1670
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
1671
        b = Branch.open_containing('.')[0]
 
1672
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
1673
        if revision_id is not None:
 
1674
            b.sign_revision(revision_id, gpg_strategy)
 
1675
        elif revision is not None:
 
1676
            if len(revision) == 1:
 
1677
                revno, rev_id = revision[0].in_history(b)
 
1678
                b.sign_revision(rev_id, gpg_strategy)
 
1679
            elif len(revision) == 2:
 
1680
                # are they both on rh- if so we can walk between them
 
1681
                # might be nice to have a range helper for arbitrary
 
1682
                # revision paths. hmm.
 
1683
                from_revno, from_revid = revision[0].in_history(b)
 
1684
                to_revno, to_revid = revision[1].in_history(b)
 
1685
                if to_revid is None:
 
1686
                    to_revno = b.revno()
 
1687
                if from_revno is None or to_revno is None:
 
1688
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
1689
                for revno in range(from_revno, to_revno + 1):
 
1690
                    b.sign_revision(b.get_rev_id(revno), gpg_strategy)
 
1691
            else:
 
1692
                raise BzrCommandError('Please supply either one revision, or a range.')
 
1693
 
 
1694
 
 
1695
# these get imported and then picked up by the scan for cmd_*
 
1696
# TODO: Some more consistent way to split command definitions across files;
 
1697
# we do need to load at least some information about them to know of 
 
1698
# aliases.
 
1699
from bzrlib.conflicts import cmd_resolve, cmd_conflicts