/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2006-06-15 05:36:34 UTC
  • mto: This revision was merged to the branch mainline in revision 1797.
  • Revision ID: mbp@sourcefrog.net-20060615053634-4fd52ba691855659
Clean up many exception classes.

Errors indicating a user error are now shown with is_user_error on the
exception; use this rather than hardcoding a list of exceptions that should be
handled this way.

Exceptions now inherit from BzrNewException where possible to use consistent
formatting method.

Remove rather obsolete docstring test on Branch.missing_revisions.

Remove dead code from find_merge_base.


Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006 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
"""builtin bzr commands"""
 
18
 
 
19
 
 
20
import errno
 
21
import os
 
22
import sys
 
23
 
 
24
import bzrlib
 
25
import bzrlib.branch
 
26
from bzrlib.branch import Branch
 
27
import bzrlib.bzrdir as bzrdir
 
28
from bzrlib.bundle.read_bundle import BundleReader
 
29
from bzrlib.bundle.apply_bundle import merge_bundle
 
30
from bzrlib.commands import Command, display_command
 
31
import bzrlib.errors as errors
 
32
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
 
33
                           NotBranchError, DivergedBranches, NotConflicted,
 
34
                           NoSuchFile, NoWorkingTree, FileInWrongBranch,
 
35
                           NotVersionedError, BadBundle)
 
36
from bzrlib.log import show_one_log
 
37
from bzrlib.merge import Merge3Merger
 
38
from bzrlib.option import Option
 
39
from bzrlib.progress import DummyProgress, ProgressPhase
 
40
from bzrlib.revision import common_ancestor
 
41
from bzrlib.revisionspec import RevisionSpec
 
42
import bzrlib.trace
 
43
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
 
44
from bzrlib.transport.local import LocalTransport
 
45
import bzrlib.ui
 
46
from bzrlib.workingtree import WorkingTree
 
47
 
 
48
 
 
49
def tree_files(file_list, default_branch=u'.'):
 
50
    try:
 
51
        return internal_tree_files(file_list, default_branch)
 
52
    except FileInWrongBranch, e:
 
53
        raise BzrCommandError("%s is not in the same branch as %s" %
 
54
                             (e.path, file_list[0]))
 
55
 
 
56
 
 
57
# XXX: Bad function name; should possibly also be a class method of
 
58
# WorkingTree rather than a function.
 
59
def internal_tree_files(file_list, default_branch=u'.'):
 
60
    """Convert command-line paths to a WorkingTree and relative paths.
 
61
 
 
62
    This is typically used for command-line processors that take one or
 
63
    more filenames, and infer the workingtree that contains them.
 
64
 
 
65
    The filenames given are not required to exist.
 
66
 
 
67
    :param file_list: Filenames to convert.  
 
68
 
 
69
    :param default_branch: Fallback tree path to use if file_list is empty or None.
 
70
 
 
71
    :return: workingtree, [relative_paths]
 
72
    """
 
73
    if file_list is None or len(file_list) == 0:
 
74
        return WorkingTree.open_containing(default_branch)[0], file_list
 
75
    tree = WorkingTree.open_containing(file_list[0])[0]
 
76
    new_list = []
 
77
    for filename in file_list:
 
78
        try:
 
79
            new_list.append(tree.relpath(filename))
 
80
        except errors.PathNotChild:
 
81
            raise FileInWrongBranch(tree.branch, filename)
 
82
    return tree, new_list
 
83
 
 
84
 
 
85
def get_format_type(typestring):
 
86
    """Parse and return a format specifier."""
 
87
    if typestring == "weave":
 
88
        return bzrdir.BzrDirFormat6()
 
89
    if typestring == "default":
 
90
        return bzrdir.BzrDirMetaFormat1()
 
91
    if typestring == "metaweave":
 
92
        format = bzrdir.BzrDirMetaFormat1()
 
93
        format.repository_format = bzrlib.repository.RepositoryFormat7()
 
94
        return format
 
95
    if typestring == "knit":
 
96
        format = bzrdir.BzrDirMetaFormat1()
 
97
        format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
 
98
        return format
 
99
    msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
 
100
          "metaweave and weave" % typestring
 
101
    raise BzrCommandError(msg)
 
102
 
 
103
 
 
104
# TODO: Make sure no commands unconditionally use the working directory as a
 
105
# branch.  If a filename argument is used, the first of them should be used to
 
106
# specify the branch.  (Perhaps this can be factored out into some kind of
 
107
# Argument class, representing a file in a branch, where the first occurrence
 
108
# opens the branch?)
 
109
 
 
110
class cmd_status(Command):
 
111
    """Display status summary.
 
112
 
 
113
    This reports on versioned and unknown files, reporting them
 
114
    grouped by state.  Possible states are:
 
115
 
 
116
    added
 
117
        Versioned in the working copy but not in the previous revision.
 
118
 
 
119
    removed
 
120
        Versioned in the previous revision but removed or deleted
 
121
        in the working copy.
 
122
 
 
123
    renamed
 
124
        Path of this file changed from the previous revision;
 
125
        the text may also have changed.  This includes files whose
 
126
        parent directory was renamed.
 
127
 
 
128
    modified
 
129
        Text has changed since the previous revision.
 
130
 
 
131
    unchanged
 
132
        Nothing about this file has changed since the previous revision.
 
133
        Only shown with --all.
 
134
 
 
135
    unknown
 
136
        Not versioned and not matching an ignore pattern.
 
137
 
 
138
    To see ignored files use 'bzr ignored'.  For details in the
 
139
    changes to file texts, use 'bzr diff'.
 
140
 
 
141
    If no arguments are specified, the status of the entire working
 
142
    directory is shown.  Otherwise, only the status of the specified
 
143
    files or directories is reported.  If a directory is given, status
 
144
    is reported for everything inside that directory.
 
145
 
 
146
    If a revision argument is given, the status is calculated against
 
147
    that revision, or between two revisions if two are provided.
 
148
    """
 
149
    
 
150
    # TODO: --no-recurse, --recurse options
 
151
    
 
152
    takes_args = ['file*']
 
153
    takes_options = ['all', 'show-ids', 'revision']
 
154
    aliases = ['st', 'stat']
 
155
    
 
156
    @display_command
 
157
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
158
        tree, file_list = tree_files(file_list)
 
159
            
 
160
        from bzrlib.status import show_tree_status
 
161
        show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
 
162
                         specific_files=file_list, revision=revision)
 
163
 
 
164
 
 
165
class cmd_cat_revision(Command):
 
166
    """Write out metadata for a revision.
 
167
    
 
168
    The revision to print can either be specified by a specific
 
169
    revision identifier, or you can use --revision.
 
170
    """
 
171
 
 
172
    hidden = True
 
173
    takes_args = ['revision_id?']
 
174
    takes_options = ['revision']
 
175
    
 
176
    @display_command
 
177
    def run(self, revision_id=None, revision=None):
 
178
 
 
179
        if revision_id is not None and revision is not None:
 
180
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
181
        if revision_id is None and revision is None:
 
182
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
183
        b = WorkingTree.open_containing(u'.')[0].branch
 
184
        if revision_id is not None:
 
185
            sys.stdout.write(b.repository.get_revision_xml(revision_id))
 
186
        elif revision is not None:
 
187
            for rev in revision:
 
188
                if rev is None:
 
189
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
190
                revno, rev_id = rev.in_history(b)
 
191
                sys.stdout.write(b.repository.get_revision_xml(rev_id))
 
192
    
 
193
 
 
194
class cmd_revno(Command):
 
195
    """Show current revision number.
 
196
 
 
197
    This is equal to the number of revisions on this branch."""
 
198
    takes_args = ['location?']
 
199
    @display_command
 
200
    def run(self, location=u'.'):
 
201
        print Branch.open_containing(location)[0].revno()
 
202
 
 
203
 
 
204
class cmd_revision_info(Command):
 
205
    """Show revision number and revision id for a given revision identifier.
 
206
    """
 
207
    hidden = True
 
208
    takes_args = ['revision_info*']
 
209
    takes_options = ['revision']
 
210
    @display_command
 
211
    def run(self, revision=None, revision_info_list=[]):
 
212
 
 
213
        revs = []
 
214
        if revision is not None:
 
215
            revs.extend(revision)
 
216
        if revision_info_list is not None:
 
217
            for rev in revision_info_list:
 
218
                revs.append(RevisionSpec(rev))
 
219
        if len(revs) == 0:
 
220
            raise BzrCommandError('You must supply a revision identifier')
 
221
 
 
222
        b = WorkingTree.open_containing(u'.')[0].branch
 
223
 
 
224
        for rev in revs:
 
225
            revinfo = rev.in_history(b)
 
226
            if revinfo.revno is None:
 
227
                print '     %s' % revinfo.rev_id
 
228
            else:
 
229
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
230
 
 
231
    
 
232
class cmd_add(Command):
 
233
    """Add specified files or directories.
 
234
 
 
235
    In non-recursive mode, all the named items are added, regardless
 
236
    of whether they were previously ignored.  A warning is given if
 
237
    any of the named files are already versioned.
 
238
 
 
239
    In recursive mode (the default), files are treated the same way
 
240
    but the behaviour for directories is different.  Directories that
 
241
    are already versioned do not give a warning.  All directories,
 
242
    whether already versioned or not, are searched for files or
 
243
    subdirectories that are neither versioned or ignored, and these
 
244
    are added.  This search proceeds recursively into versioned
 
245
    directories.  If no names are given '.' is assumed.
 
246
 
 
247
    Therefore simply saying 'bzr add' will version all files that
 
248
    are currently unknown.
 
249
 
 
250
    Adding a file whose parent directory is not versioned will
 
251
    implicitly add the parent, and so on up to the root. This means
 
252
    you should never need to explictly add a directory, they'll just
 
253
    get added when you add a file in the directory.
 
254
 
 
255
    --dry-run will show which files would be added, but not actually 
 
256
    add them.
 
257
    """
 
258
    takes_args = ['file*']
 
259
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
260
 
 
261
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
262
        import bzrlib.add
 
263
 
 
264
        if dry_run:
 
265
            if is_quiet():
 
266
                # This is pointless, but I'd rather not raise an error
 
267
                action = bzrlib.add.add_action_null
 
268
            else:
 
269
                action = bzrlib.add.add_action_print
 
270
        elif is_quiet():
 
271
            action = bzrlib.add.add_action_add
 
272
        else:
 
273
            action = bzrlib.add.add_action_add_and_print
 
274
 
 
275
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
 
276
                                              action)
 
277
        if len(ignored) > 0:
 
278
            if verbose:
 
279
                for glob in sorted(ignored.keys()):
 
280
                    for path in ignored[glob]:
 
281
                        print "ignored %s matching \"%s\"" % (path, glob)
 
282
            else:
 
283
                match_len = 0
 
284
                for glob, paths in ignored.items():
 
285
                    match_len += len(paths)
 
286
                print "ignored %d file(s)." % match_len
 
287
            print "If you wish to add some of these files, please add them"\
 
288
                " by name."
 
289
 
 
290
 
 
291
class cmd_mkdir(Command):
 
292
    """Create a new versioned directory.
 
293
 
 
294
    This is equivalent to creating the directory and then adding it.
 
295
    """
 
296
    takes_args = ['dir+']
 
297
 
 
298
    def run(self, dir_list):
 
299
        for d in dir_list:
 
300
            os.mkdir(d)
 
301
            wt, dd = WorkingTree.open_containing(d)
 
302
            wt.add([dd])
 
303
            print 'added', d
 
304
 
 
305
 
 
306
class cmd_relpath(Command):
 
307
    """Show path of a file relative to root"""
 
308
    takes_args = ['filename']
 
309
    hidden = True
 
310
    
 
311
    @display_command
 
312
    def run(self, filename):
 
313
        tree, relpath = WorkingTree.open_containing(filename)
 
314
        print relpath
 
315
 
 
316
 
 
317
class cmd_inventory(Command):
 
318
    """Show inventory of the current working copy or a revision.
 
319
 
 
320
    It is possible to limit the output to a particular entry
 
321
    type using the --kind option.  For example; --kind file.
 
322
    """
 
323
    takes_options = ['revision', 'show-ids', 'kind']
 
324
    
 
325
    @display_command
 
326
    def run(self, revision=None, show_ids=False, kind=None):
 
327
        if kind and kind not in ['file', 'directory', 'symlink']:
 
328
            raise BzrCommandError('invalid kind specified')
 
329
        tree = WorkingTree.open_containing(u'.')[0]
 
330
        if revision is None:
 
331
            inv = tree.read_working_inventory()
 
332
        else:
 
333
            if len(revision) > 1:
 
334
                raise BzrCommandError('bzr inventory --revision takes'
 
335
                    ' exactly one revision identifier')
 
336
            inv = tree.branch.repository.get_revision_inventory(
 
337
                revision[0].in_history(tree.branch).rev_id)
 
338
 
 
339
        for path, entry in inv.entries():
 
340
            if kind and kind != entry.kind:
 
341
                continue
 
342
            if show_ids:
 
343
                print '%-50s %s' % (path, entry.file_id)
 
344
            else:
 
345
                print path
 
346
 
 
347
 
 
348
class cmd_mv(Command):
 
349
    """Move or rename a file.
 
350
 
 
351
    usage:
 
352
        bzr mv OLDNAME NEWNAME
 
353
        bzr mv SOURCE... DESTINATION
 
354
 
 
355
    If the last argument is a versioned directory, all the other names
 
356
    are moved into it.  Otherwise, there must be exactly two arguments
 
357
    and the file is changed to a new name, which must not already exist.
 
358
 
 
359
    Files cannot be moved between branches.
 
360
    """
 
361
    takes_args = ['names*']
 
362
    aliases = ['move', 'rename']
 
363
 
 
364
    def run(self, names_list):
 
365
        if len(names_list) < 2:
 
366
            raise BzrCommandError("missing file argument")
 
367
        tree, rel_names = tree_files(names_list)
 
368
        
 
369
        if os.path.isdir(names_list[-1]):
 
370
            # move into existing directory
 
371
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
 
372
                print "%s => %s" % pair
 
373
        else:
 
374
            if len(names_list) != 2:
 
375
                raise BzrCommandError('to mv multiple files the destination '
 
376
                                      'must be a versioned directory')
 
377
            tree.rename_one(rel_names[0], rel_names[1])
 
378
            print "%s => %s" % (rel_names[0], rel_names[1])
 
379
            
 
380
    
 
381
class cmd_pull(Command):
 
382
    """Turn this branch into a mirror of another branch.
 
383
 
 
384
    This command only works on branches that have not diverged.  Branches are
 
385
    considered diverged if the destination branch's most recent commit is one
 
386
    that has not been merged (directly or indirectly) into the parent.
 
387
 
 
388
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
389
    from one into the other.  Once one branch has merged, the other should
 
390
    be able to pull it again.
 
391
 
 
392
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
393
    from one into the other.  Once one branch has merged, the other should
 
394
    be able to pull it again.
 
395
 
 
396
    If you want to forget your local changes and just update your branch to
 
397
    match the remote one, use pull --overwrite.
 
398
 
 
399
    If there is no default location set, the first pull will set it.  After
 
400
    that, you can omit the location to use the default.  To change the
 
401
    default, use --remember.
 
402
    """
 
403
    takes_options = ['remember', 'overwrite', 'revision', 'verbose']
 
404
    takes_args = ['location?']
 
405
 
 
406
    def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
 
407
        # FIXME: too much stuff is in the command class
 
408
        try:
 
409
            tree_to = WorkingTree.open_containing(u'.')[0]
 
410
            branch_to = tree_to.branch
 
411
        except NoWorkingTree:
 
412
            tree_to = None
 
413
            branch_to = Branch.open_containing(u'.')[0] 
 
414
        stored_loc = branch_to.get_parent()
 
415
        if location is None:
 
416
            if stored_loc is None:
 
417
                raise BzrCommandError("No pull location known or specified.")
 
418
            else:
 
419
                print "Using saved location: %s" % stored_loc
 
420
                location = stored_loc
 
421
 
 
422
        if branch_to.get_parent() is None or remember:
 
423
            branch_to.set_parent(location)
 
424
 
 
425
        branch_from = Branch.open(location)
 
426
 
 
427
        if revision is None:
 
428
            rev_id = None
 
429
        elif len(revision) == 1:
 
430
            rev_id = revision[0].in_history(branch_from).rev_id
 
431
        else:
 
432
            raise BzrCommandError('bzr pull --revision takes one value.')
 
433
 
 
434
        old_rh = branch_to.revision_history()
 
435
        if tree_to is not None:
 
436
            count = tree_to.pull(branch_from, overwrite, rev_id)
 
437
        else:
 
438
            count = branch_to.pull(branch_from, overwrite, rev_id)
 
439
        note('%d revision(s) pulled.' % (count,))
 
440
 
 
441
        if verbose:
 
442
            new_rh = branch_to.revision_history()
 
443
            if old_rh != new_rh:
 
444
                # Something changed
 
445
                from bzrlib.log import show_changed_revisions
 
446
                show_changed_revisions(branch_to, old_rh, new_rh)
 
447
 
 
448
 
 
449
class cmd_push(Command):
 
450
    """Update a mirror of this branch.
 
451
    
 
452
    The target branch will not have its working tree populated because this
 
453
    is both expensive, and is not supported on remote file systems.
 
454
    
 
455
    Some smart servers or protocols *may* put the working tree in place in
 
456
    the future.
 
457
 
 
458
    This command only works on branches that have not diverged.  Branches are
 
459
    considered diverged if the destination branch's most recent commit is one
 
460
    that has not been merged (directly or indirectly) by the source branch.
 
461
 
 
462
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
463
    the other branch completely, discarding its unmerged changes.
 
464
    
 
465
    If you want to ensure you have the different changes in the other branch,
 
466
    do a merge (see bzr help merge) from the other branch, and commit that.
 
467
    After that you will be able to do a push without '--overwrite'.
 
468
 
 
469
    If there is no default push location set, the first push will set it.
 
470
    After that, you can omit the location to use the default.  To change the
 
471
    default, use --remember.
 
472
    """
 
473
    takes_options = ['remember', 'overwrite', 
 
474
                     Option('create-prefix', 
 
475
                            help='Create the path leading up to the branch '
 
476
                                 'if it does not already exist')]
 
477
    takes_args = ['location?']
 
478
 
 
479
    def run(self, location=None, remember=False, overwrite=False,
 
480
            create_prefix=False, verbose=False):
 
481
        # FIXME: Way too big!  Put this into a function called from the
 
482
        # command.
 
483
        from bzrlib.transport import get_transport
 
484
        
 
485
        br_from = Branch.open_containing('.')[0]
 
486
        stored_loc = br_from.get_push_location()
 
487
        if location is None:
 
488
            if stored_loc is None:
 
489
                raise BzrCommandError("No push location known or specified.")
 
490
            else:
 
491
                print "Using saved location: %s" % stored_loc
 
492
                location = stored_loc
 
493
        if br_from.get_push_location() is None or remember:
 
494
            br_from.set_push_location(location)
 
495
        try:
 
496
            dir_to = bzrlib.bzrdir.BzrDir.open(location)
 
497
            br_to = dir_to.open_branch()
 
498
        except NotBranchError:
 
499
            # create a branch.
 
500
            transport = get_transport(location).clone('..')
 
501
            if not create_prefix:
 
502
                try:
 
503
                    transport.mkdir(transport.relpath(location))
 
504
                except NoSuchFile:
 
505
                    raise BzrCommandError("Parent directory of %s "
 
506
                                          "does not exist." % location)
 
507
            else:
 
508
                current = transport.base
 
509
                needed = [(transport, transport.relpath(location))]
 
510
                while needed:
 
511
                    try:
 
512
                        transport, relpath = needed[-1]
 
513
                        transport.mkdir(relpath)
 
514
                        needed.pop()
 
515
                    except NoSuchFile:
 
516
                        new_transport = transport.clone('..')
 
517
                        needed.append((new_transport,
 
518
                                       new_transport.relpath(transport.base)))
 
519
                        if new_transport.base == transport.base:
 
520
                            raise BzrCommandError("Could not create "
 
521
                                                  "path prefix.")
 
522
            dir_to = br_from.bzrdir.clone(location,
 
523
                revision_id=br_from.last_revision())
 
524
            br_to = dir_to.open_branch()
 
525
            count = len(br_to.revision_history())
 
526
        else:
 
527
            old_rh = br_to.revision_history()
 
528
            try:
 
529
                try:
 
530
                    tree_to = dir_to.open_workingtree()
 
531
                except errors.NotLocalUrl:
 
532
                    warning('This transport does not update the working '
 
533
                            'tree of: %s' % (br_to.base,))
 
534
                    count = br_to.pull(br_from, overwrite)
 
535
                except NoWorkingTree:
 
536
                    count = br_to.pull(br_from, overwrite)
 
537
                else:
 
538
                    count = tree_to.pull(br_from, overwrite)
 
539
            except DivergedBranches:
 
540
                raise BzrCommandError("These branches have diverged."
 
541
                                      "  Try a merge then push with overwrite.")
 
542
        note('%d revision(s) pushed.' % (count,))
 
543
 
 
544
        if verbose:
 
545
            new_rh = br_to.revision_history()
 
546
            if old_rh != new_rh:
 
547
                # Something changed
 
548
                from bzrlib.log import show_changed_revisions
 
549
                show_changed_revisions(br_to, old_rh, new_rh)
 
550
 
 
551
 
 
552
class cmd_branch(Command):
 
553
    """Create a new copy of a branch.
 
554
 
 
555
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
556
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
557
 
 
558
    To retrieve the branch as of a particular revision, supply the --revision
 
559
    parameter, as in "branch foo/bar -r 5".
 
560
 
 
561
    --basis is to speed up branching from remote branches.  When specified, it
 
562
    copies all the file-contents, inventory and revision data from the basis
 
563
    branch before copying anything from the remote branch.
 
564
    """
 
565
    takes_args = ['from_location', 'to_location?']
 
566
    takes_options = ['revision', 'basis']
 
567
    aliases = ['get', 'clone']
 
568
 
 
569
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
570
        from bzrlib.osutils import rmtree
 
571
        if revision is None:
 
572
            revision = [None]
 
573
        elif len(revision) > 1:
 
574
            raise BzrCommandError(
 
575
                'bzr branch --revision takes exactly 1 revision value')
 
576
        try:
 
577
            br_from = Branch.open(from_location)
 
578
        except OSError, e:
 
579
            if e.errno == errno.ENOENT:
 
580
                raise BzrCommandError('Source location "%s" does not'
 
581
                                      ' exist.' % to_location)
 
582
            else:
 
583
                raise
 
584
        br_from.lock_read()
 
585
        try:
 
586
            if basis is not None:
 
587
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
588
            else:
 
589
                basis_dir = None
 
590
            if len(revision) == 1 and revision[0] is not None:
 
591
                revision_id = revision[0].in_history(br_from)[1]
 
592
            else:
 
593
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
594
                # None or perhaps NULL_REVISION to mean copy nothing
 
595
                # RBC 20060209
 
596
                revision_id = br_from.last_revision()
 
597
            if to_location is None:
 
598
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
599
                name = None
 
600
            else:
 
601
                name = os.path.basename(to_location) + '\n'
 
602
            try:
 
603
                os.mkdir(to_location)
 
604
            except OSError, e:
 
605
                if e.errno == errno.EEXIST:
 
606
                    raise BzrCommandError('Target directory "%s" already'
 
607
                                          ' exists.' % to_location)
 
608
                if e.errno == errno.ENOENT:
 
609
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
610
                                          to_location)
 
611
                else:
 
612
                    raise
 
613
            try:
 
614
                # preserve whatever source format we have.
 
615
                dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
 
616
                branch = dir.open_branch()
 
617
            except bzrlib.errors.NoSuchRevision:
 
618
                rmtree(to_location)
 
619
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
620
                raise BzrCommandError(msg)
 
621
            except bzrlib.errors.UnlistableBranch:
 
622
                rmtree(to_location)
 
623
                msg = "The branch %s cannot be used as a --basis" % (basis,)
 
624
                raise BzrCommandError(msg)
 
625
            if name:
 
626
                branch.control_files.put_utf8('branch-name', name)
 
627
 
 
628
            note('Branched %d revision(s).' % branch.revno())
 
629
        finally:
 
630
            br_from.unlock()
 
631
 
 
632
 
 
633
class cmd_checkout(Command):
 
634
    """Create a new checkout of an existing branch.
 
635
 
 
636
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
637
    the branch found in '.'. This is useful if you have removed the working tree
 
638
    or if it was never created - i.e. if you pushed the branch to its current
 
639
    location using SFTP.
 
640
    
 
641
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
642
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
643
 
 
644
    To retrieve the branch as of a particular revision, supply the --revision
 
645
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
646
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
647
    code.)
 
648
 
 
649
    --basis is to speed up checking out from remote branches.  When specified, it
 
650
    uses the inventory and file contents from the basis branch in preference to the
 
651
    branch being checked out.
 
652
    """
 
653
    takes_args = ['branch_location?', 'to_location?']
 
654
    takes_options = ['revision', # , 'basis']
 
655
                     Option('lightweight',
 
656
                            help="perform a lightweight checkout. Lightweight "
 
657
                                 "checkouts depend on access to the branch for "
 
658
                                 "every operation. Normal checkouts can perform "
 
659
                                 "common operations like diff and status without "
 
660
                                 "such access, and also support local commits."
 
661
                            ),
 
662
                     ]
 
663
 
 
664
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
 
665
            lightweight=False):
 
666
        if revision is None:
 
667
            revision = [None]
 
668
        elif len(revision) > 1:
 
669
            raise BzrCommandError(
 
670
                'bzr checkout --revision takes exactly 1 revision value')
 
671
        if branch_location is None:
 
672
            branch_location = bzrlib.osutils.getcwd()
 
673
            to_location = branch_location
 
674
        source = Branch.open(branch_location)
 
675
        if len(revision) == 1 and revision[0] is not None:
 
676
            revision_id = revision[0].in_history(source)[1]
 
677
        else:
 
678
            revision_id = None
 
679
        if to_location is None:
 
680
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
681
        # if the source and to_location are the same, 
 
682
        # and there is no working tree,
 
683
        # then reconstitute a branch
 
684
        if (bzrlib.osutils.abspath(to_location) == 
 
685
            bzrlib.osutils.abspath(branch_location)):
 
686
            try:
 
687
                source.bzrdir.open_workingtree()
 
688
            except errors.NoWorkingTree:
 
689
                source.bzrdir.create_workingtree()
 
690
                return
 
691
        try:
 
692
            os.mkdir(to_location)
 
693
        except OSError, e:
 
694
            if e.errno == errno.EEXIST:
 
695
                raise BzrCommandError('Target directory "%s" already'
 
696
                                      ' exists.' % to_location)
 
697
            if e.errno == errno.ENOENT:
 
698
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
699
                                      to_location)
 
700
            else:
 
701
                raise
 
702
        old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
703
        bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
 
704
        try:
 
705
            if lightweight:
 
706
                checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
 
707
                bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
 
708
            else:
 
709
                checkout_branch =  bzrlib.bzrdir.BzrDir.create_branch_convenience(
 
710
                    to_location, force_new_tree=False)
 
711
                checkout = checkout_branch.bzrdir
 
712
                checkout_branch.bind(source)
 
713
                if revision_id is not None:
 
714
                    rh = checkout_branch.revision_history()
 
715
                    checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
 
716
            checkout.create_workingtree(revision_id)
 
717
        finally:
 
718
            bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
 
719
 
 
720
 
 
721
class cmd_renames(Command):
 
722
    """Show list of renamed files.
 
723
    """
 
724
    # TODO: Option to show renames between two historical versions.
 
725
 
 
726
    # TODO: Only show renames under dir, rather than in the whole branch.
 
727
    takes_args = ['dir?']
 
728
 
 
729
    @display_command
 
730
    def run(self, dir=u'.'):
 
731
        tree = WorkingTree.open_containing(dir)[0]
 
732
        old_inv = tree.basis_tree().inventory
 
733
        new_inv = tree.read_working_inventory()
 
734
 
 
735
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
736
        renames.sort()
 
737
        for old_name, new_name in renames:
 
738
            print "%s => %s" % (old_name, new_name)        
 
739
 
 
740
 
 
741
class cmd_update(Command):
 
742
    """Update a tree to have the latest code committed to its branch.
 
743
    
 
744
    This will perform a merge into the working tree, and may generate
 
745
    conflicts. If you have any local changes, you will still 
 
746
    need to commit them after the update for the update to be complete.
 
747
    
 
748
    If you want to discard your local changes, you can just do a 
 
749
    'bzr revert' instead of 'bzr commit' after the update.
 
750
    """
 
751
    takes_args = ['dir?']
 
752
 
 
753
    def run(self, dir='.'):
 
754
        tree = WorkingTree.open_containing(dir)[0]
 
755
        tree.lock_write()
 
756
        try:
 
757
            if tree.last_revision() == tree.branch.last_revision():
 
758
                # may be up to date, check master too.
 
759
                master = tree.branch.get_master_branch()
 
760
                if master is None or master.last_revision == tree.last_revision():
 
761
                    note("Tree is up to date.")
 
762
                    return
 
763
            conflicts = tree.update()
 
764
            note('Updated to revision %d.' %
 
765
                 (tree.branch.revision_id_to_revno(tree.last_revision()),))
 
766
            if conflicts != 0:
 
767
                return 1
 
768
            else:
 
769
                return 0
 
770
        finally:
 
771
            tree.unlock()
 
772
 
 
773
 
 
774
class cmd_info(Command):
 
775
    """Show information about a working tree, branch or repository.
 
776
 
 
777
    This command will show all known locations and formats associated to the
 
778
    tree, branch or repository.  Statistical information is included with
 
779
    each report.
 
780
 
 
781
    Branches and working trees will also report any missing revisions.
 
782
    """
 
783
    takes_args = ['location?']
 
784
    takes_options = ['verbose']
 
785
 
 
786
    @display_command
 
787
    def run(self, location=None, verbose=False):
 
788
        from bzrlib.info import show_bzrdir_info
 
789
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
790
                         verbose=verbose)
 
791
 
 
792
 
 
793
class cmd_remove(Command):
 
794
    """Make a file unversioned.
 
795
 
 
796
    This makes bzr stop tracking changes to a versioned file.  It does
 
797
    not delete the working copy.
 
798
 
 
799
    You can specify one or more files, and/or --new.  If you specify --new,
 
800
    only 'added' files will be removed.  If you specify both, then new files
 
801
    in the specified directories will be removed.  If the directories are
 
802
    also new, they will also be removed.
 
803
    """
 
804
    takes_args = ['file*']
 
805
    takes_options = ['verbose', Option('new', help='remove newly-added files')]
 
806
    aliases = ['rm']
 
807
    
 
808
    def run(self, file_list, verbose=False, new=False):
 
809
        tree, file_list = tree_files(file_list)
 
810
        if new is False:
 
811
            if file_list is None:
 
812
                raise BzrCommandError('Specify one or more files to remove, or'
 
813
                                      ' use --new.')
 
814
        else:
 
815
            from bzrlib.delta import compare_trees
 
816
            added = [compare_trees(tree.basis_tree(), tree,
 
817
                                   specific_files=file_list).added]
 
818
            file_list = sorted([f[0] for f in added[0]], reverse=True)
 
819
            if len(file_list) == 0:
 
820
                raise BzrCommandError('No matching files.')
 
821
        tree.remove(file_list, verbose=verbose)
 
822
 
 
823
 
 
824
class cmd_file_id(Command):
 
825
    """Print file_id of a particular file or directory.
 
826
 
 
827
    The file_id is assigned when the file is first added and remains the
 
828
    same through all revisions where the file exists, even when it is
 
829
    moved or renamed.
 
830
    """
 
831
    hidden = True
 
832
    takes_args = ['filename']
 
833
    @display_command
 
834
    def run(self, filename):
 
835
        tree, relpath = WorkingTree.open_containing(filename)
 
836
        i = tree.inventory.path2id(relpath)
 
837
        if i == None:
 
838
            raise BzrError("%r is not a versioned file" % filename)
 
839
        else:
 
840
            print i
 
841
 
 
842
 
 
843
class cmd_file_path(Command):
 
844
    """Print path of file_ids to a file or directory.
 
845
 
 
846
    This prints one line for each directory down to the target,
 
847
    starting at the branch root."""
 
848
    hidden = True
 
849
    takes_args = ['filename']
 
850
    @display_command
 
851
    def run(self, filename):
 
852
        tree, relpath = WorkingTree.open_containing(filename)
 
853
        inv = tree.inventory
 
854
        fid = inv.path2id(relpath)
 
855
        if fid == None:
 
856
            raise BzrError("%r is not a versioned file" % filename)
 
857
        for fip in inv.get_idpath(fid):
 
858
            print fip
 
859
 
 
860
 
 
861
class cmd_reconcile(Command):
 
862
    """Reconcile bzr metadata in a branch.
 
863
 
 
864
    This can correct data mismatches that may have been caused by
 
865
    previous ghost operations or bzr upgrades. You should only
 
866
    need to run this command if 'bzr check' or a bzr developer 
 
867
    advises you to run it.
 
868
 
 
869
    If a second branch is provided, cross-branch reconciliation is
 
870
    also attempted, which will check that data like the tree root
 
871
    id which was not present in very early bzr versions is represented
 
872
    correctly in both branches.
 
873
 
 
874
    At the same time it is run it may recompress data resulting in 
 
875
    a potential saving in disk space or performance gain.
 
876
 
 
877
    The branch *MUST* be on a listable system such as local disk or sftp.
 
878
    """
 
879
    takes_args = ['branch?']
 
880
 
 
881
    def run(self, branch="."):
 
882
        from bzrlib.reconcile import reconcile
 
883
        dir = bzrlib.bzrdir.BzrDir.open(branch)
 
884
        reconcile(dir)
 
885
 
 
886
 
 
887
class cmd_revision_history(Command):
 
888
    """Display list of revision ids on this branch."""
 
889
    hidden = True
 
890
    @display_command
 
891
    def run(self):
 
892
        branch = WorkingTree.open_containing(u'.')[0].branch
 
893
        for patchid in branch.revision_history():
 
894
            print patchid
 
895
 
 
896
 
 
897
class cmd_ancestry(Command):
 
898
    """List all revisions merged into this branch."""
 
899
    hidden = True
 
900
    @display_command
 
901
    def run(self):
 
902
        tree = WorkingTree.open_containing(u'.')[0]
 
903
        b = tree.branch
 
904
        # FIXME. should be tree.last_revision
 
905
        revision_ids = b.repository.get_ancestry(b.last_revision())
 
906
        assert revision_ids[0] == None
 
907
        revision_ids.pop(0)
 
908
        for revision_id in revision_ids:
 
909
            print revision_id
 
910
 
 
911
 
 
912
class cmd_init(Command):
 
913
    """Make a directory into a versioned branch.
 
914
 
 
915
    Use this to create an empty branch, or before importing an
 
916
    existing project.
 
917
 
 
918
    If there is a repository in a parent directory of the location, then 
 
919
    the history of the branch will be stored in the repository.  Otherwise
 
920
    init creates a standalone branch which carries its own history in 
 
921
    .bzr.
 
922
 
 
923
    If there is already a branch at the location but it has no working tree,
 
924
    the tree can be populated with 'bzr checkout'.
 
925
 
 
926
    Recipe for importing a tree of files:
 
927
        cd ~/project
 
928
        bzr init
 
929
        bzr add .
 
930
        bzr status
 
931
        bzr commit -m 'imported project'
 
932
    """
 
933
    takes_args = ['location?']
 
934
    takes_options = [
 
935
                     Option('format', 
 
936
                            help='Specify a format for this branch. Current'
 
937
                                 ' formats are: default, knit, metaweave and'
 
938
                                 ' weave. Default is knit; metaweave and'
 
939
                                 ' weave are deprecated',
 
940
                            type=get_format_type),
 
941
                     ]
 
942
    def run(self, location=None, format=None):
 
943
        from bzrlib.branch import Branch
 
944
        if format is None:
 
945
            format = get_format_type('default')
 
946
        if location is None:
 
947
            location = u'.'
 
948
        else:
 
949
            # The path has to exist to initialize a
 
950
            # branch inside of it.
 
951
            # Just using os.mkdir, since I don't
 
952
            # believe that we want to create a bunch of
 
953
            # locations if the user supplies an extended path
 
954
            if not os.path.exists(location):
 
955
                os.mkdir(location)
 
956
        try:
 
957
            existing_bzrdir = bzrdir.BzrDir.open(location)
 
958
        except NotBranchError:
 
959
            # really a NotBzrDir error...
 
960
            bzrdir.BzrDir.create_branch_convenience(location, format=format)
 
961
        else:
 
962
            if existing_bzrdir.has_branch():
 
963
                if existing_bzrdir.has_workingtree():
 
964
                    raise errors.AlreadyBranchError(location)
 
965
                else:
 
966
                    raise errors.BranchExistsWithoutWorkingTree(location)
 
967
            else:
 
968
                existing_bzrdir.create_branch()
 
969
                existing_bzrdir.create_workingtree()
 
970
 
 
971
 
 
972
class cmd_init_repository(Command):
 
973
    """Create a shared repository to hold branches.
 
974
 
 
975
    New branches created under the repository directory will store their revisions
 
976
    in the repository, not in the branch directory, if the branch format supports
 
977
    shared storage.
 
978
 
 
979
    example:
 
980
        bzr init-repo repo
 
981
        bzr init repo/trunk
 
982
        bzr checkout --lightweight repo/trunk trunk-checkout
 
983
        cd trunk-checkout
 
984
        (add files here)
 
985
    """
 
986
    takes_args = ["location"] 
 
987
    takes_options = [Option('format', 
 
988
                            help='Specify a format for this repository.'
 
989
                                 ' Current formats are: default, knit,'
 
990
                                 ' metaweave and weave. Default is knit;'
 
991
                                 ' metaweave and weave are deprecated',
 
992
                            type=get_format_type),
 
993
                     Option('trees',
 
994
                             help='Allows branches in repository to have'
 
995
                             ' a working tree')]
 
996
    aliases = ["init-repo"]
 
997
    def run(self, location, format=None, trees=False):
 
998
        from bzrlib.transport import get_transport
 
999
        if format is None:
 
1000
            format = get_format_type('default')
 
1001
        transport = get_transport(location)
 
1002
        if not transport.has('.'):
 
1003
            transport.mkdir('')
 
1004
        newdir = format.initialize_on_transport(transport)
 
1005
        repo = newdir.create_repository(shared=True)
 
1006
        repo.set_make_working_trees(trees)
 
1007
 
 
1008
 
 
1009
class cmd_diff(Command):
 
1010
    """Show differences in working tree.
 
1011
    
 
1012
    If files are listed, only the changes in those files are listed.
 
1013
    Otherwise, all changes for the tree are listed.
 
1014
 
 
1015
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1016
    produces patches suitable for "patch -p1".
 
1017
 
 
1018
    examples:
 
1019
        bzr diff
 
1020
        bzr diff -r1
 
1021
        bzr diff -r1..2
 
1022
        bzr diff --diff-prefix old/:new/
 
1023
        bzr diff bzr.mine bzr.dev
 
1024
        bzr diff foo.c
 
1025
    """
 
1026
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
1027
    #       or a graphical diff.
 
1028
 
 
1029
    # TODO: Python difflib is not exactly the same as unidiff; should
 
1030
    #       either fix it up or prefer to use an external diff.
 
1031
 
 
1032
    # TODO: Selected-file diff is inefficient and doesn't show you
 
1033
    #       deleted files.
 
1034
 
 
1035
    # TODO: This probably handles non-Unix newlines poorly.
 
1036
    
 
1037
    takes_args = ['file*']
 
1038
    takes_options = ['revision', 'diff-options', 'prefix']
 
1039
    aliases = ['di', 'dif']
 
1040
 
 
1041
    @display_command
 
1042
    def run(self, revision=None, file_list=None, diff_options=None,
 
1043
            prefix=None):
 
1044
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1045
 
 
1046
        if (prefix is None) or (prefix == '0'):
 
1047
            # diff -p0 format
 
1048
            old_label = ''
 
1049
            new_label = ''
 
1050
        elif prefix == '1':
 
1051
            old_label = 'old/'
 
1052
            new_label = 'new/'
 
1053
        else:
 
1054
            if not ':' in prefix:
 
1055
                 raise BzrError("--diff-prefix expects two values separated by a colon")
 
1056
            old_label, new_label = prefix.split(":")
 
1057
        
 
1058
        try:
 
1059
            tree1, file_list = internal_tree_files(file_list)
 
1060
            tree2 = None
 
1061
            b = None
 
1062
            b2 = None
 
1063
        except FileInWrongBranch:
 
1064
            if len(file_list) != 2:
 
1065
                raise BzrCommandError("Files are in different branches")
 
1066
 
 
1067
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
1068
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
1069
            if file1 != "" or file2 != "":
 
1070
                # FIXME diff those two files. rbc 20051123
 
1071
                raise BzrCommandError("Files are in different branches")
 
1072
            file_list = None
 
1073
        if revision is not None:
 
1074
            if tree2 is not None:
 
1075
                raise BzrCommandError("Can't specify -r with two branches")
 
1076
            if (len(revision) == 1) or (revision[1].spec is None):
 
1077
                return diff_cmd_helper(tree1, file_list, diff_options,
 
1078
                                       revision[0], 
 
1079
                                       old_label=old_label, new_label=new_label)
 
1080
            elif len(revision) == 2:
 
1081
                return diff_cmd_helper(tree1, file_list, diff_options,
 
1082
                                       revision[0], revision[1],
 
1083
                                       old_label=old_label, new_label=new_label)
 
1084
            else:
 
1085
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
1086
        else:
 
1087
            if tree2 is not None:
 
1088
                return show_diff_trees(tree1, tree2, sys.stdout, 
 
1089
                                       specific_files=file_list,
 
1090
                                       external_diff_options=diff_options,
 
1091
                                       old_label=old_label, new_label=new_label)
 
1092
            else:
 
1093
                return diff_cmd_helper(tree1, file_list, diff_options,
 
1094
                                       old_label=old_label, new_label=new_label)
 
1095
 
 
1096
 
 
1097
class cmd_deleted(Command):
 
1098
    """List files deleted in the working tree.
 
1099
    """
 
1100
    # TODO: Show files deleted since a previous revision, or
 
1101
    # between two revisions.
 
1102
    # TODO: Much more efficient way to do this: read in new
 
1103
    # directories with readdir, rather than stating each one.  Same
 
1104
    # level of effort but possibly much less IO.  (Or possibly not,
 
1105
    # if the directories are very large...)
 
1106
    @display_command
 
1107
    def run(self, show_ids=False):
 
1108
        tree = WorkingTree.open_containing(u'.')[0]
 
1109
        old = tree.basis_tree()
 
1110
        for path, ie in old.inventory.iter_entries():
 
1111
            if not tree.has_id(ie.file_id):
 
1112
                if show_ids:
 
1113
                    print '%-50s %s' % (path, ie.file_id)
 
1114
                else:
 
1115
                    print path
 
1116
 
 
1117
 
 
1118
class cmd_modified(Command):
 
1119
    """List files modified in working tree."""
 
1120
    hidden = True
 
1121
    @display_command
 
1122
    def run(self):
 
1123
        from bzrlib.delta import compare_trees
 
1124
 
 
1125
        tree = WorkingTree.open_containing(u'.')[0]
 
1126
        td = compare_trees(tree.basis_tree(), tree)
 
1127
 
 
1128
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1129
            print path
 
1130
 
 
1131
 
 
1132
 
 
1133
class cmd_added(Command):
 
1134
    """List files added in working tree."""
 
1135
    hidden = True
 
1136
    @display_command
 
1137
    def run(self):
 
1138
        wt = WorkingTree.open_containing(u'.')[0]
 
1139
        basis_inv = wt.basis_tree().inventory
 
1140
        inv = wt.inventory
 
1141
        for file_id in inv:
 
1142
            if file_id in basis_inv:
 
1143
                continue
 
1144
            path = inv.id2path(file_id)
 
1145
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
1146
                continue
 
1147
            print path
 
1148
                
 
1149
        
 
1150
 
 
1151
class cmd_root(Command):
 
1152
    """Show the tree root directory.
 
1153
 
 
1154
    The root is the nearest enclosing directory with a .bzr control
 
1155
    directory."""
 
1156
    takes_args = ['filename?']
 
1157
    @display_command
 
1158
    def run(self, filename=None):
 
1159
        """Print the branch root."""
 
1160
        tree = WorkingTree.open_containing(filename)[0]
 
1161
        print tree.basedir
 
1162
 
 
1163
 
 
1164
class cmd_log(Command):
 
1165
    """Show log of a branch, file, or directory.
 
1166
 
 
1167
    By default show the log of the branch containing the working directory.
 
1168
 
 
1169
    To request a range of logs, you can use the command -r begin..end
 
1170
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1171
    also valid.
 
1172
 
 
1173
    examples:
 
1174
        bzr log
 
1175
        bzr log foo.c
 
1176
        bzr log -r -10.. http://server/branch
 
1177
    """
 
1178
 
 
1179
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1180
 
 
1181
    takes_args = ['location?']
 
1182
    takes_options = [Option('forward', 
 
1183
                            help='show from oldest to newest'),
 
1184
                     'timezone', 
 
1185
                     Option('verbose', 
 
1186
                             help='show files changed in each revision'),
 
1187
                     'show-ids', 'revision',
 
1188
                     'log-format',
 
1189
                     'line', 'long', 
 
1190
                     Option('message',
 
1191
                            help='show revisions whose message matches this regexp',
 
1192
                            type=str),
 
1193
                     'short',
 
1194
                     ]
 
1195
    @display_command
 
1196
    def run(self, location=None, timezone='original',
 
1197
            verbose=False,
 
1198
            show_ids=False,
 
1199
            forward=False,
 
1200
            revision=None,
 
1201
            log_format=None,
 
1202
            message=None,
 
1203
            long=False,
 
1204
            short=False,
 
1205
            line=False):
 
1206
        from bzrlib.log import log_formatter, show_log
 
1207
        import codecs
 
1208
        assert message is None or isinstance(message, basestring), \
 
1209
            "invalid message argument %r" % message
 
1210
        direction = (forward and 'forward') or 'reverse'
 
1211
        
 
1212
        # log everything
 
1213
        file_id = None
 
1214
        if location:
 
1215
            # find the file id to log:
 
1216
 
 
1217
            dir, fp = bzrdir.BzrDir.open_containing(location)
 
1218
            b = dir.open_branch()
 
1219
            if fp != '':
 
1220
                try:
 
1221
                    # might be a tree:
 
1222
                    inv = dir.open_workingtree().inventory
 
1223
                except (errors.NotBranchError, errors.NotLocalUrl):
 
1224
                    # either no tree, or is remote.
 
1225
                    inv = b.basis_tree().inventory
 
1226
                file_id = inv.path2id(fp)
 
1227
        else:
 
1228
            # local dir only
 
1229
            # FIXME ? log the current subdir only RBC 20060203 
 
1230
            dir, relpath = bzrdir.BzrDir.open_containing('.')
 
1231
            b = dir.open_branch()
 
1232
 
 
1233
        if revision is None:
 
1234
            rev1 = None
 
1235
            rev2 = None
 
1236
        elif len(revision) == 1:
 
1237
            rev1 = rev2 = revision[0].in_history(b).revno
 
1238
        elif len(revision) == 2:
 
1239
            if revision[0].spec is None:
 
1240
                # missing begin-range means first revision
 
1241
                rev1 = 1
 
1242
            else:
 
1243
                rev1 = revision[0].in_history(b).revno
 
1244
 
 
1245
            if revision[1].spec is None:
 
1246
                # missing end-range means last known revision
 
1247
                rev2 = b.revno()
 
1248
            else:
 
1249
                rev2 = revision[1].in_history(b).revno
 
1250
        else:
 
1251
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
1252
 
 
1253
        # By this point, the revision numbers are converted to the +ve
 
1254
        # form if they were supplied in the -ve form, so we can do
 
1255
        # this comparison in relative safety
 
1256
        if rev1 > rev2:
 
1257
            (rev2, rev1) = (rev1, rev2)
 
1258
 
 
1259
        mutter('encoding log as %r', bzrlib.user_encoding)
 
1260
 
 
1261
        # use 'replace' so that we don't abort if trying to write out
 
1262
        # in e.g. the default C locale.
 
1263
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1264
 
 
1265
        if (log_format == None):
 
1266
            default = bzrlib.config.BranchConfig(b).log_format()
 
1267
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
1268
 
 
1269
        lf = log_formatter(log_format,
 
1270
                           show_ids=show_ids,
 
1271
                           to_file=outf,
 
1272
                           show_timezone=timezone)
 
1273
 
 
1274
        show_log(b,
 
1275
                 lf,
 
1276
                 file_id,
 
1277
                 verbose=verbose,
 
1278
                 direction=direction,
 
1279
                 start_revision=rev1,
 
1280
                 end_revision=rev2,
 
1281
                 search=message)
 
1282
 
 
1283
 
 
1284
def get_log_format(long=False, short=False, line=False, default='long'):
 
1285
    log_format = default
 
1286
    if long:
 
1287
        log_format = 'long'
 
1288
    if short:
 
1289
        log_format = 'short'
 
1290
    if line:
 
1291
        log_format = 'line'
 
1292
    return log_format
 
1293
 
 
1294
 
 
1295
class cmd_touching_revisions(Command):
 
1296
    """Return revision-ids which affected a particular file.
 
1297
 
 
1298
    A more user-friendly interface is "bzr log FILE"."""
 
1299
    hidden = True
 
1300
    takes_args = ["filename"]
 
1301
    @display_command
 
1302
    def run(self, filename):
 
1303
        tree, relpath = WorkingTree.open_containing(filename)
 
1304
        b = tree.branch
 
1305
        inv = tree.read_working_inventory()
 
1306
        file_id = inv.path2id(relpath)
 
1307
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
1308
            print "%6d %s" % (revno, what)
 
1309
 
 
1310
 
 
1311
class cmd_ls(Command):
 
1312
    """List files in a tree.
 
1313
    """
 
1314
    # TODO: Take a revision or remote path and list that tree instead.
 
1315
    hidden = True
 
1316
    takes_options = ['verbose', 'revision',
 
1317
                     Option('non-recursive',
 
1318
                            help='don\'t recurse into sub-directories'),
 
1319
                     Option('from-root',
 
1320
                            help='Print all paths from the root of the branch.'),
 
1321
                     Option('unknown', help='Print unknown files'),
 
1322
                     Option('versioned', help='Print versioned files'),
 
1323
                     Option('ignored', help='Print ignored files'),
 
1324
 
 
1325
                     Option('null', help='Null separate the files'),
 
1326
                    ]
 
1327
    @display_command
 
1328
    def run(self, revision=None, verbose=False, 
 
1329
            non_recursive=False, from_root=False,
 
1330
            unknown=False, versioned=False, ignored=False,
 
1331
            null=False):
 
1332
 
 
1333
        if verbose and null:
 
1334
            raise BzrCommandError('Cannot set both --verbose and --null')
 
1335
        all = not (unknown or versioned or ignored)
 
1336
 
 
1337
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1338
 
 
1339
        tree, relpath = WorkingTree.open_containing(u'.')
 
1340
        if from_root:
 
1341
            relpath = u''
 
1342
        elif relpath:
 
1343
            relpath += '/'
 
1344
        if revision is not None:
 
1345
            tree = tree.branch.repository.revision_tree(
 
1346
                revision[0].in_history(tree.branch).rev_id)
 
1347
        for fp, fc, kind, fid, entry in tree.list_files():
 
1348
            if fp.startswith(relpath):
 
1349
                fp = fp[len(relpath):]
 
1350
                if non_recursive and '/' in fp:
 
1351
                    continue
 
1352
                if not all and not selection[fc]:
 
1353
                    continue
 
1354
                if verbose:
 
1355
                    kindch = entry.kind_character()
 
1356
                    print '%-8s %s%s' % (fc, fp, kindch)
 
1357
                elif null:
 
1358
                    sys.stdout.write(fp)
 
1359
                    sys.stdout.write('\0')
 
1360
                    sys.stdout.flush()
 
1361
                else:
 
1362
                    print fp
 
1363
 
 
1364
 
 
1365
class cmd_unknowns(Command):
 
1366
    """List unknown files."""
 
1367
    @display_command
 
1368
    def run(self):
 
1369
        from bzrlib.osutils import quotefn
 
1370
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1371
            print quotefn(f)
 
1372
 
 
1373
 
 
1374
class cmd_ignore(Command):
 
1375
    """Ignore a command or pattern.
 
1376
 
 
1377
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1378
 
 
1379
    If the pattern contains a slash, it is compared to the whole path
 
1380
    from the branch root.  Otherwise, it is compared to only the last
 
1381
    component of the path.  To match a file only in the root directory,
 
1382
    prepend './'.
 
1383
 
 
1384
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1385
 
 
1386
    Note: wildcards must be quoted from the shell on Unix.
 
1387
 
 
1388
    examples:
 
1389
        bzr ignore ./Makefile
 
1390
        bzr ignore '*.class'
 
1391
    """
 
1392
    # TODO: Complain if the filename is absolute
 
1393
    takes_args = ['name_pattern']
 
1394
    
 
1395
    def run(self, name_pattern):
 
1396
        from bzrlib.atomicfile import AtomicFile
 
1397
        import os.path
 
1398
 
 
1399
        tree, relpath = WorkingTree.open_containing(u'.')
 
1400
        ifn = tree.abspath('.bzrignore')
 
1401
 
 
1402
        if os.path.exists(ifn):
 
1403
            f = open(ifn, 'rt')
 
1404
            try:
 
1405
                igns = f.read().decode('utf-8')
 
1406
            finally:
 
1407
                f.close()
 
1408
        else:
 
1409
            igns = ''
 
1410
 
 
1411
        # TODO: If the file already uses crlf-style termination, maybe
 
1412
        # we should use that for the newly added lines?
 
1413
 
 
1414
        if igns and igns[-1] != '\n':
 
1415
            igns += '\n'
 
1416
        igns += name_pattern + '\n'
 
1417
 
 
1418
        f = AtomicFile(ifn, 'wt')
 
1419
        try:
 
1420
            f.write(igns.encode('utf-8'))
 
1421
            f.commit()
 
1422
        finally:
 
1423
            f.close()
 
1424
 
 
1425
        inv = tree.inventory
 
1426
        if inv.path2id('.bzrignore'):
 
1427
            mutter('.bzrignore is already versioned')
 
1428
        else:
 
1429
            mutter('need to make new .bzrignore file versioned')
 
1430
            tree.add(['.bzrignore'])
 
1431
 
 
1432
 
 
1433
class cmd_ignored(Command):
 
1434
    """List ignored files and the patterns that matched them.
 
1435
 
 
1436
    See also: bzr ignore"""
 
1437
    @display_command
 
1438
    def run(self):
 
1439
        tree = WorkingTree.open_containing(u'.')[0]
 
1440
        for path, file_class, kind, file_id, entry in tree.list_files():
 
1441
            if file_class != 'I':
 
1442
                continue
 
1443
            ## XXX: Slightly inefficient since this was already calculated
 
1444
            pat = tree.is_ignored(path)
 
1445
            print '%-50s %s' % (path, pat)
 
1446
 
 
1447
 
 
1448
class cmd_lookup_revision(Command):
 
1449
    """Lookup the revision-id from a revision-number
 
1450
 
 
1451
    example:
 
1452
        bzr lookup-revision 33
 
1453
    """
 
1454
    hidden = True
 
1455
    takes_args = ['revno']
 
1456
    
 
1457
    @display_command
 
1458
    def run(self, revno):
 
1459
        try:
 
1460
            revno = int(revno)
 
1461
        except ValueError:
 
1462
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1463
 
 
1464
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1465
 
 
1466
 
 
1467
class cmd_export(Command):
 
1468
    """Export past revision to destination directory.
 
1469
 
 
1470
    If no revision is specified this exports the last committed revision.
 
1471
 
 
1472
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1473
    given, try to find the format with the extension. If no extension
 
1474
    is found exports to a directory (equivalent to --format=dir).
 
1475
 
 
1476
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1477
    is given, the top directory will be the root name of the file.
 
1478
 
 
1479
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1480
 
 
1481
     Supported formats       Autodetected by extension
 
1482
     -----------------       -------------------------
 
1483
         dir                            -
 
1484
         tar                          .tar
 
1485
         tbz2                    .tar.bz2, .tbz2
 
1486
         tgz                      .tar.gz, .tgz
 
1487
         zip                          .zip
 
1488
    """
 
1489
    takes_args = ['dest']
 
1490
    takes_options = ['revision', 'format', 'root']
 
1491
    def run(self, dest, revision=None, format=None, root=None):
 
1492
        import os.path
 
1493
        from bzrlib.export import export
 
1494
        tree = WorkingTree.open_containing(u'.')[0]
 
1495
        b = tree.branch
 
1496
        if revision is None:
 
1497
            # should be tree.last_revision  FIXME
 
1498
            rev_id = b.last_revision()
 
1499
        else:
 
1500
            if len(revision) != 1:
 
1501
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1502
            rev_id = revision[0].in_history(b).rev_id
 
1503
        t = b.repository.revision_tree(rev_id)
 
1504
        try:
 
1505
            export(t, dest, format, root)
 
1506
        except errors.NoSuchExportFormat, e:
 
1507
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
1508
 
 
1509
 
 
1510
class cmd_cat(Command):
 
1511
    """Write a file's text from a previous revision."""
 
1512
 
 
1513
    takes_options = ['revision']
 
1514
    takes_args = ['filename']
 
1515
 
 
1516
    @display_command
 
1517
    def run(self, filename, revision=None):
 
1518
        if revision is not None and len(revision) != 1:
 
1519
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1520
        tree = None
 
1521
        try:
 
1522
            tree, relpath = WorkingTree.open_containing(filename)
 
1523
            b = tree.branch
 
1524
        except NotBranchError:
 
1525
            pass
 
1526
 
 
1527
        if tree is None:
 
1528
            b, relpath = Branch.open_containing(filename)
 
1529
        if revision is None:
 
1530
            revision_id = b.last_revision()
 
1531
        else:
 
1532
            revision_id = revision[0].in_history(b).rev_id
 
1533
        b.print_file(relpath, revision_id)
 
1534
 
 
1535
 
 
1536
class cmd_local_time_offset(Command):
 
1537
    """Show the offset in seconds from GMT to local time."""
 
1538
    hidden = True    
 
1539
    @display_command
 
1540
    def run(self):
 
1541
        print bzrlib.osutils.local_time_offset()
 
1542
 
 
1543
 
 
1544
 
 
1545
class cmd_commit(Command):
 
1546
    """Commit changes into a new revision.
 
1547
    
 
1548
    If no arguments are given, the entire tree is committed.
 
1549
 
 
1550
    If selected files are specified, only changes to those files are
 
1551
    committed.  If a directory is specified then the directory and everything 
 
1552
    within it is committed.
 
1553
 
 
1554
    A selected-file commit may fail in some cases where the committed
 
1555
    tree would be invalid, such as trying to commit a file in a
 
1556
    newly-added directory that is not itself committed.
 
1557
    """
 
1558
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1559
 
 
1560
    # TODO: Strict commit that fails if there are deleted files.
 
1561
    #       (what does "deleted files" mean ??)
 
1562
 
 
1563
    # TODO: Give better message for -s, --summary, used by tla people
 
1564
 
 
1565
    # XXX: verbose currently does nothing
 
1566
 
 
1567
    takes_args = ['selected*']
 
1568
    takes_options = ['message', 'verbose', 
 
1569
                     Option('unchanged',
 
1570
                            help='commit even if nothing has changed'),
 
1571
                     Option('file', type=str, 
 
1572
                            argname='msgfile',
 
1573
                            help='file containing commit message'),
 
1574
                     Option('strict',
 
1575
                            help="refuse to commit if there are unknown "
 
1576
                            "files in the working tree."),
 
1577
                     Option('local',
 
1578
                            help="perform a local only commit in a bound "
 
1579
                                 "branch. Such commits are not pushed to "
 
1580
                                 "the master branch until a normal commit "
 
1581
                                 "is performed."
 
1582
                            ),
 
1583
                     ]
 
1584
    aliases = ['ci', 'checkin']
 
1585
 
 
1586
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1587
            unchanged=False, strict=False, local=False):
 
1588
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
1589
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1590
                StrictCommitFailed)
 
1591
        from bzrlib.msgeditor import edit_commit_message, \
 
1592
                make_commit_message_template
 
1593
        from tempfile import TemporaryFile
 
1594
        import codecs
 
1595
 
 
1596
        # TODO: Need a blackbox test for invoking the external editor; may be
 
1597
        # slightly problematic to run this cross-platform.
 
1598
 
 
1599
        # TODO: do more checks that the commit will succeed before 
 
1600
        # spending the user's valuable time typing a commit message.
 
1601
        #
 
1602
        # TODO: if the commit *does* happen to fail, then save the commit 
 
1603
        # message to a temporary file where it can be recovered
 
1604
        tree, selected_list = tree_files(selected_list)
 
1605
        if selected_list == ['']:
 
1606
            # workaround - commit of root of tree should be exactly the same
 
1607
            # as just default commit in that tree, and succeed even though
 
1608
            # selected-file merge commit is not done yet
 
1609
            selected_list = []
 
1610
 
 
1611
        if local and not tree.branch.get_bound_location():
 
1612
            raise errors.LocalRequiresBoundBranch()
 
1613
        if message is None and not file:
 
1614
            template = make_commit_message_template(tree, selected_list)
 
1615
            message = edit_commit_message(template)
 
1616
            if message is None:
 
1617
                raise BzrCommandError("please specify a commit message"
 
1618
                                      " with either --message or --file")
 
1619
        elif message and file:
 
1620
            raise BzrCommandError("please specify either --message or --file")
 
1621
        
 
1622
        if file:
 
1623
            import codecs
 
1624
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1625
 
 
1626
        if message == "":
 
1627
                raise BzrCommandError("empty commit message specified")
 
1628
        
 
1629
        if verbose:
 
1630
            reporter = ReportCommitToLog()
 
1631
        else:
 
1632
            reporter = NullCommitReporter()
 
1633
        
 
1634
        try:
 
1635
            tree.commit(message, specific_files=selected_list,
 
1636
                        allow_pointless=unchanged, strict=strict, local=local,
 
1637
                        reporter=reporter)
 
1638
        except PointlessCommit:
 
1639
            # FIXME: This should really happen before the file is read in;
 
1640
            # perhaps prepare the commit; get the message; then actually commit
 
1641
            raise BzrCommandError("no changes to commit",
 
1642
                                  ["use --unchanged to commit anyhow"])
 
1643
        except ConflictsInTree:
 
1644
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1645
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1646
        except StrictCommitFailed:
 
1647
            raise BzrCommandError("Commit refused because there are unknown "
 
1648
                                  "files in the working tree.")
 
1649
        except errors.BoundBranchOutOfDate, e:
 
1650
            raise BzrCommandError(str(e)
 
1651
                                  + ' Either unbind, update, or'
 
1652
                                    ' pass --local to commit.')
 
1653
 
 
1654
 
 
1655
class cmd_check(Command):
 
1656
    """Validate consistency of branch history.
 
1657
 
 
1658
    This command checks various invariants about the branch storage to
 
1659
    detect data corruption or bzr bugs.
 
1660
    """
 
1661
    takes_args = ['branch?']
 
1662
    takes_options = ['verbose']
 
1663
 
 
1664
    def run(self, branch=None, verbose=False):
 
1665
        from bzrlib.check import check
 
1666
        if branch is None:
 
1667
            tree = WorkingTree.open_containing()[0]
 
1668
            branch = tree.branch
 
1669
        else:
 
1670
            branch = Branch.open(branch)
 
1671
        check(branch, verbose)
 
1672
 
 
1673
 
 
1674
class cmd_scan_cache(Command):
 
1675
    hidden = True
 
1676
    def run(self):
 
1677
        from bzrlib.hashcache import HashCache
 
1678
 
 
1679
        c = HashCache(u'.')
 
1680
        c.read()
 
1681
        c.scan()
 
1682
            
 
1683
        print '%6d stats' % c.stat_count
 
1684
        print '%6d in hashcache' % len(c._cache)
 
1685
        print '%6d files removed from cache' % c.removed_count
 
1686
        print '%6d hashes updated' % c.update_count
 
1687
        print '%6d files changed too recently to cache' % c.danger_count
 
1688
 
 
1689
        if c.needs_write:
 
1690
            c.write()
 
1691
 
 
1692
 
 
1693
class cmd_upgrade(Command):
 
1694
    """Upgrade branch storage to current format.
 
1695
 
 
1696
    The check command or bzr developers may sometimes advise you to run
 
1697
    this command. When the default format has changed you may also be warned
 
1698
    during other operations to upgrade.
 
1699
    """
 
1700
    takes_args = ['url?']
 
1701
    takes_options = [
 
1702
                     Option('format', 
 
1703
                            help='Upgrade to a specific format. Current formats'
 
1704
                                 ' are: default, knit, metaweave and weave.'
 
1705
                                 ' Default is knit; metaweave and weave are'
 
1706
                                 ' deprecated',
 
1707
                            type=get_format_type),
 
1708
                    ]
 
1709
 
 
1710
 
 
1711
    def run(self, url='.', format=None):
 
1712
        from bzrlib.upgrade import upgrade
 
1713
        if format is None:
 
1714
            format = get_format_type('default')
 
1715
        upgrade(url, format)
 
1716
 
 
1717
 
 
1718
class cmd_whoami(Command):
 
1719
    """Show bzr user id."""
 
1720
    takes_options = ['email']
 
1721
    
 
1722
    @display_command
 
1723
    def run(self, email=False):
 
1724
        try:
 
1725
            b = WorkingTree.open_containing(u'.')[0].branch
 
1726
            config = bzrlib.config.BranchConfig(b)
 
1727
        except NotBranchError:
 
1728
            config = bzrlib.config.GlobalConfig()
 
1729
        
 
1730
        if email:
 
1731
            print config.user_email()
 
1732
        else:
 
1733
            print config.username()
 
1734
 
 
1735
 
 
1736
class cmd_nick(Command):
 
1737
    """Print or set the branch nickname.  
 
1738
 
 
1739
    If unset, the tree root directory name is used as the nickname
 
1740
    To print the current nickname, execute with no argument.  
 
1741
    """
 
1742
    takes_args = ['nickname?']
 
1743
    def run(self, nickname=None):
 
1744
        branch = Branch.open_containing(u'.')[0]
 
1745
        if nickname is None:
 
1746
            self.printme(branch)
 
1747
        else:
 
1748
            branch.nick = nickname
 
1749
 
 
1750
    @display_command
 
1751
    def printme(self, branch):
 
1752
        print branch.nick 
 
1753
 
 
1754
 
 
1755
class cmd_selftest(Command):
 
1756
    """Run internal test suite.
 
1757
    
 
1758
    This creates temporary test directories in the working directory,
 
1759
    but not existing data is affected.  These directories are deleted
 
1760
    if the tests pass, or left behind to help in debugging if they
 
1761
    fail and --keep-output is specified.
 
1762
    
 
1763
    If arguments are given, they are regular expressions that say
 
1764
    which tests should run.
 
1765
 
 
1766
    If the global option '--no-plugins' is given, plugins are not loaded
 
1767
    before running the selftests.  This has two effects: features provided or
 
1768
    modified by plugins will not be tested, and tests provided by plugins will
 
1769
    not be run.
 
1770
 
 
1771
    examples:
 
1772
        bzr selftest ignore
 
1773
        bzr --no-plugins selftest -v
 
1774
    """
 
1775
    # TODO: --list should give a list of all available tests
 
1776
 
 
1777
    # NB: this is used from the class without creating an instance, which is
 
1778
    # why it does not have a self parameter.
 
1779
    def get_transport_type(typestring):
 
1780
        """Parse and return a transport specifier."""
 
1781
        if typestring == "sftp":
 
1782
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
1783
            return SFTPAbsoluteServer
 
1784
        if typestring == "memory":
 
1785
            from bzrlib.transport.memory import MemoryServer
 
1786
            return MemoryServer
 
1787
        if typestring == "fakenfs":
 
1788
            from bzrlib.transport.fakenfs import FakeNFSServer
 
1789
            return FakeNFSServer
 
1790
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
1791
            (typestring)
 
1792
        raise BzrCommandError(msg)
 
1793
 
 
1794
    hidden = True
 
1795
    takes_args = ['testspecs*']
 
1796
    takes_options = ['verbose',
 
1797
                     Option('one', help='stop when one test fails'),
 
1798
                     Option('keep-output', 
 
1799
                            help='keep output directories when tests fail'),
 
1800
                     Option('transport', 
 
1801
                            help='Use a different transport by default '
 
1802
                                 'throughout the test suite.',
 
1803
                            type=get_transport_type),
 
1804
                     Option('benchmark', help='run the bzr bencharks.'),
 
1805
                     Option('lsprof-timed',
 
1806
                            help='generate lsprof output for benchmarked'
 
1807
                                 ' sections of code.'),
 
1808
                     ]
 
1809
 
 
1810
    def run(self, testspecs_list=None, verbose=None, one=False,
 
1811
            keep_output=False, transport=None, benchmark=None,
 
1812
            lsprof_timed=None):
 
1813
        import bzrlib.ui
 
1814
        from bzrlib.tests import selftest
 
1815
        import bzrlib.benchmarks as benchmarks
 
1816
        # we don't want progress meters from the tests to go to the
 
1817
        # real output; and we don't want log messages cluttering up
 
1818
        # the real logs.
 
1819
        save_ui = bzrlib.ui.ui_factory
 
1820
        print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
 
1821
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
1822
        print
 
1823
        bzrlib.trace.info('running tests...')
 
1824
        try:
 
1825
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1826
            if testspecs_list is not None:
 
1827
                pattern = '|'.join(testspecs_list)
 
1828
            else:
 
1829
                pattern = ".*"
 
1830
            if benchmark:
 
1831
                test_suite_factory = benchmarks.test_suite
 
1832
                if verbose is None:
 
1833
                    verbose = True
 
1834
            else:
 
1835
                test_suite_factory = None
 
1836
                if verbose is None:
 
1837
                    verbose = False
 
1838
            result = selftest(verbose=verbose, 
 
1839
                              pattern=pattern,
 
1840
                              stop_on_failure=one, 
 
1841
                              keep_output=keep_output,
 
1842
                              transport=transport,
 
1843
                              test_suite_factory=test_suite_factory,
 
1844
                              lsprof_timed=lsprof_timed)
 
1845
            if result:
 
1846
                bzrlib.trace.info('tests passed')
 
1847
            else:
 
1848
                bzrlib.trace.info('tests failed')
 
1849
            return int(not result)
 
1850
        finally:
 
1851
            bzrlib.ui.ui_factory = save_ui
 
1852
 
 
1853
 
 
1854
def _get_bzr_branch():
 
1855
    """If bzr is run from a branch, return Branch or None"""
 
1856
    import bzrlib.errors
 
1857
    from bzrlib.branch import Branch
 
1858
    from bzrlib.osutils import abspath
 
1859
    from os.path import dirname
 
1860
    
 
1861
    try:
 
1862
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
1863
        return branch
 
1864
    except bzrlib.errors.BzrError:
 
1865
        return None
 
1866
    
 
1867
 
 
1868
def show_version():
 
1869
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1870
    # is bzrlib itself in a branch?
 
1871
    branch = _get_bzr_branch()
 
1872
    if branch:
 
1873
        rh = branch.revision_history()
 
1874
        revno = len(rh)
 
1875
        print "  bzr checkout, revision %d" % (revno,)
 
1876
        print "  nick: %s" % (branch.nick,)
 
1877
        if rh:
 
1878
            print "  revid: %s" % (rh[-1],)
 
1879
    print "Using python interpreter:", sys.executable
 
1880
    import site
 
1881
    print "Using python standard library:", os.path.dirname(site.__file__)
 
1882
    print "Using bzrlib:",
 
1883
    if len(bzrlib.__path__) > 1:
 
1884
        # print repr, which is a good enough way of making it clear it's
 
1885
        # more than one element (eg ['/foo/bar', '/foo/bzr'])
 
1886
        print repr(bzrlib.__path__)
 
1887
    else:
 
1888
        print bzrlib.__path__[0]
 
1889
 
 
1890
    print
 
1891
    print bzrlib.__copyright__
 
1892
    print "http://bazaar-vcs.org/"
 
1893
    print
 
1894
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1895
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1896
    print "General Public License version 2 or later."
 
1897
 
 
1898
 
 
1899
class cmd_version(Command):
 
1900
    """Show version of bzr."""
 
1901
    @display_command
 
1902
    def run(self):
 
1903
        show_version()
 
1904
 
 
1905
class cmd_rocks(Command):
 
1906
    """Statement of optimism."""
 
1907
    hidden = True
 
1908
    @display_command
 
1909
    def run(self):
 
1910
        print "it sure does!"
 
1911
 
 
1912
 
 
1913
class cmd_find_merge_base(Command):
 
1914
    """Find and print a base revision for merging two branches.
 
1915
    """
 
1916
    # TODO: Options to specify revisions on either side, as if
 
1917
    #       merging only part of the history.
 
1918
    takes_args = ['branch', 'other']
 
1919
    hidden = True
 
1920
    
 
1921
    @display_command
 
1922
    def run(self, branch, other):
 
1923
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1924
        
 
1925
        branch1 = Branch.open_containing(branch)[0]
 
1926
        branch2 = Branch.open_containing(other)[0]
 
1927
 
 
1928
        history_1 = branch1.revision_history()
 
1929
        history_2 = branch2.revision_history()
 
1930
 
 
1931
        last1 = branch1.last_revision()
 
1932
        last2 = branch2.last_revision()
 
1933
 
 
1934
        source = MultipleRevisionSources(branch1.repository, 
 
1935
                                         branch2.repository)
 
1936
        
 
1937
        base_rev_id = common_ancestor(last1, last2, source)
 
1938
 
 
1939
        print 'merge base is revision %s' % base_rev_id
 
1940
 
 
1941
 
 
1942
class cmd_merge(Command):
 
1943
    """Perform a three-way merge.
 
1944
    
 
1945
    The branch is the branch you will merge from.  By default, it will
 
1946
    merge the latest revision.  If you specify a revision, that
 
1947
    revision will be merged.  If you specify two revisions, the first
 
1948
    will be used as a BASE, and the second one as OTHER.  Revision
 
1949
    numbers are always relative to the specified branch.
 
1950
 
 
1951
    By default, bzr will try to merge in all new work from the other
 
1952
    branch, automatically determining an appropriate base.  If this
 
1953
    fails, you may need to give an explicit base.
 
1954
    
 
1955
    Merge will do its best to combine the changes in two branches, but there
 
1956
    are some kinds of problems only a human can fix.  When it encounters those,
 
1957
    it will mark a conflict.  A conflict means that you need to fix something,
 
1958
    before you should commit.
 
1959
 
 
1960
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
1961
 
 
1962
    If there is no default branch set, the first merge will set it. After
 
1963
    that, you can omit the branch to use the default.  To change the
 
1964
    default, use --remember.
 
1965
 
 
1966
    Examples:
 
1967
 
 
1968
    To merge the latest revision from bzr.dev
 
1969
    bzr merge ../bzr.dev
 
1970
 
 
1971
    To merge changes up to and including revision 82 from bzr.dev
 
1972
    bzr merge -r 82 ../bzr.dev
 
1973
 
 
1974
    To merge the changes introduced by 82, without previous changes:
 
1975
    bzr merge -r 81..82 ../bzr.dev
 
1976
    
 
1977
    merge refuses to run if there are any uncommitted changes, unless
 
1978
    --force is given.
 
1979
 
 
1980
    The following merge types are available:
 
1981
    """
 
1982
    takes_args = ['branch?']
 
1983
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
1984
                     Option('show-base', help="Show base revision text in "
 
1985
                            "conflicts")]
 
1986
 
 
1987
    def help(self):
 
1988
        from merge import merge_type_help
 
1989
        from inspect import getdoc
 
1990
        return getdoc(self) + '\n' + merge_type_help() 
 
1991
 
 
1992
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1993
            show_base=False, reprocess=False, remember=False):
 
1994
        if merge_type is None:
 
1995
            merge_type = Merge3Merger
 
1996
 
 
1997
 
 
1998
        tree = WorkingTree.open_containing(u'.')[0]
 
1999
        try:
 
2000
            if branch is not None:
 
2001
                reader = BundleReader(file(branch, 'rb'))
 
2002
            else:
 
2003
                reader = None
 
2004
        except IOError, e:
 
2005
            if e.errno not in (errno.ENOENT, errno.EISDIR):
 
2006
                raise
 
2007
            reader = None
 
2008
        except BadBundle:
 
2009
            reader = None
 
2010
        if reader is not None:
 
2011
            conflicts = merge_bundle(reader, tree, not force, merge_type,
 
2012
                                        reprocess, show_base)
 
2013
            if conflicts == 0:
 
2014
                return 0
 
2015
            else:
 
2016
                return 1
 
2017
 
 
2018
        stored_loc = tree.branch.get_parent()
 
2019
        if branch is None:
 
2020
            if stored_loc is None:
 
2021
                raise BzrCommandError("No merge branch known or specified.")
 
2022
            else:
 
2023
                print "Using saved branch: %s" % stored_loc
 
2024
                branch = stored_loc
 
2025
 
 
2026
        if tree.branch.get_parent() is None or remember:
 
2027
            tree.branch.set_parent(branch)
 
2028
 
 
2029
        if revision is None or len(revision) < 1:
 
2030
            base = [None, None]
 
2031
            other = [branch, -1]
 
2032
            other_branch, path = Branch.open_containing(branch)
 
2033
        else:
 
2034
            if len(revision) == 1:
 
2035
                base = [None, None]
 
2036
                other_branch, path = Branch.open_containing(branch)
 
2037
                revno = revision[0].in_history(other_branch).revno
 
2038
                other = [branch, revno]
 
2039
            else:
 
2040
                assert len(revision) == 2
 
2041
                if None in revision:
 
2042
                    raise BzrCommandError(
 
2043
                        "Merge doesn't permit that revision specifier.")
 
2044
                b, path = Branch.open_containing(branch)
 
2045
 
 
2046
                base = [branch, revision[0].in_history(b).revno]
 
2047
                other = [branch, revision[1].in_history(b).revno]
 
2048
        if path != "":
 
2049
            interesting_files = [path]
 
2050
        else:
 
2051
            interesting_files = None
 
2052
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2053
        try:
 
2054
            try:
 
2055
                conflict_count = merge(other, base, check_clean=(not force),
 
2056
                                       merge_type=merge_type, 
 
2057
                                       reprocess=reprocess,
 
2058
                                       show_base=show_base, 
 
2059
                                       pb=pb, file_list=interesting_files)
 
2060
            finally:
 
2061
                pb.finished()
 
2062
            if conflict_count != 0:
 
2063
                return 1
 
2064
            else:
 
2065
                return 0
 
2066
        except bzrlib.errors.AmbiguousBase, e:
 
2067
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
2068
                 "candidates are:\n  "
 
2069
                 + "\n  ".join(e.bases)
 
2070
                 + "\n"
 
2071
                 "please specify an explicit base with -r,\n"
 
2072
                 "and (if you want) report this to the bzr developers\n")
 
2073
            log_error(m)
 
2074
 
 
2075
 
 
2076
class cmd_remerge(Command):
 
2077
    """Redo a merge.
 
2078
 
 
2079
    Use this if you want to try a different merge technique while resolving
 
2080
    conflicts.  Some merge techniques are better than others, and remerge 
 
2081
    lets you try different ones on different files.
 
2082
 
 
2083
    The options for remerge have the same meaning and defaults as the ones for
 
2084
    merge.  The difference is that remerge can (only) be run when there is a
 
2085
    pending merge, and it lets you specify particular files.
 
2086
 
 
2087
    Examples:
 
2088
    $ bzr remerge --show-base
 
2089
        Re-do the merge of all conflicted files, and show the base text in
 
2090
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2091
 
 
2092
    $ bzr remerge --merge-type weave --reprocess foobar
 
2093
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2094
        additional processing to reduce the size of conflict regions.
 
2095
    
 
2096
    The following merge types are available:"""
 
2097
    takes_args = ['file*']
 
2098
    takes_options = ['merge-type', 'reprocess',
 
2099
                     Option('show-base', help="Show base revision text in "
 
2100
                            "conflicts")]
 
2101
 
 
2102
    def help(self):
 
2103
        from merge import merge_type_help
 
2104
        from inspect import getdoc
 
2105
        return getdoc(self) + '\n' + merge_type_help() 
 
2106
 
 
2107
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2108
            reprocess=False):
 
2109
        from bzrlib.merge import merge_inner, transform_tree
 
2110
        if merge_type is None:
 
2111
            merge_type = Merge3Merger
 
2112
        tree, file_list = tree_files(file_list)
 
2113
        tree.lock_write()
 
2114
        try:
 
2115
            pending_merges = tree.pending_merges() 
 
2116
            if len(pending_merges) != 1:
 
2117
                raise BzrCommandError("Sorry, remerge only works after normal"
 
2118
                                      + " merges.  Not cherrypicking or"
 
2119
                                      + "multi-merges.")
 
2120
            repository = tree.branch.repository
 
2121
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
2122
                                            pending_merges[0], repository)
 
2123
            base_tree = repository.revision_tree(base_revision)
 
2124
            other_tree = repository.revision_tree(pending_merges[0])
 
2125
            interesting_ids = None
 
2126
            if file_list is not None:
 
2127
                interesting_ids = set()
 
2128
                for filename in file_list:
 
2129
                    file_id = tree.path2id(filename)
 
2130
                    if file_id is None:
 
2131
                        raise NotVersionedError(filename)
 
2132
                    interesting_ids.add(file_id)
 
2133
                    if tree.kind(file_id) != "directory":
 
2134
                        continue
 
2135
                    
 
2136
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2137
                        interesting_ids.add(ie.file_id)
 
2138
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
2139
            if file_list is None:
 
2140
                restore_files = list(tree.iter_conflicts())
 
2141
            else:
 
2142
                restore_files = file_list
 
2143
            for filename in restore_files:
 
2144
                try:
 
2145
                    restore(tree.abspath(filename))
 
2146
                except NotConflicted:
 
2147
                    pass
 
2148
            conflicts =  merge_inner(tree.branch, other_tree, base_tree,
 
2149
                                     this_tree=tree,
 
2150
                                     interesting_ids = interesting_ids, 
 
2151
                                     other_rev_id=pending_merges[0], 
 
2152
                                     merge_type=merge_type, 
 
2153
                                     show_base=show_base,
 
2154
                                     reprocess=reprocess)
 
2155
        finally:
 
2156
            tree.unlock()
 
2157
        if conflicts > 0:
 
2158
            return 1
 
2159
        else:
 
2160
            return 0
 
2161
 
 
2162
class cmd_revert(Command):
 
2163
    """Reverse all changes since the last commit.
 
2164
 
 
2165
    Only versioned files are affected.  Specify filenames to revert only 
 
2166
    those files.  By default, any files that are changed will be backed up
 
2167
    first.  Backup files have a '~' appended to their name.
 
2168
    """
 
2169
    takes_options = ['revision', 'no-backup']
 
2170
    takes_args = ['file*']
 
2171
    aliases = ['merge-revert']
 
2172
 
 
2173
    def run(self, revision=None, no_backup=False, file_list=None):
 
2174
        from bzrlib.commands import parse_spec
 
2175
        if file_list is not None:
 
2176
            if len(file_list) == 0:
 
2177
                raise BzrCommandError("No files specified")
 
2178
        else:
 
2179
            file_list = []
 
2180
        
 
2181
        tree, file_list = tree_files(file_list)
 
2182
        if revision is None:
 
2183
            # FIXME should be tree.last_revision
 
2184
            rev_id = tree.last_revision()
 
2185
        elif len(revision) != 1:
 
2186
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
2187
        else:
 
2188
            rev_id = revision[0].in_history(tree.branch).rev_id
 
2189
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2190
        try:
 
2191
            tree.revert(file_list, 
 
2192
                        tree.branch.repository.revision_tree(rev_id),
 
2193
                        not no_backup, pb)
 
2194
        finally:
 
2195
            pb.finished()
 
2196
 
 
2197
 
 
2198
class cmd_assert_fail(Command):
 
2199
    """Test reporting of assertion failures"""
 
2200
    hidden = True
 
2201
    def run(self):
 
2202
        assert False, "always fails"
 
2203
 
 
2204
 
 
2205
class cmd_help(Command):
 
2206
    """Show help on a command or other topic.
 
2207
 
 
2208
    For a list of all available commands, say 'bzr help commands'."""
 
2209
    takes_options = [Option('long', 'show help on all commands')]
 
2210
    takes_args = ['topic?']
 
2211
    aliases = ['?', '--help', '-?', '-h']
 
2212
    
 
2213
    @display_command
 
2214
    def run(self, topic=None, long=False):
 
2215
        import help
 
2216
        if topic is None and long:
 
2217
            topic = "commands"
 
2218
        help.help(topic)
 
2219
 
 
2220
 
 
2221
class cmd_shell_complete(Command):
 
2222
    """Show appropriate completions for context.
 
2223
 
 
2224
    For a list of all available commands, say 'bzr shell-complete'."""
 
2225
    takes_args = ['context?']
 
2226
    aliases = ['s-c']
 
2227
    hidden = True
 
2228
    
 
2229
    @display_command
 
2230
    def run(self, context=None):
 
2231
        import shellcomplete
 
2232
        shellcomplete.shellcomplete(context)
 
2233
 
 
2234
 
 
2235
class cmd_fetch(Command):
 
2236
    """Copy in history from another branch but don't merge it.
 
2237
 
 
2238
    This is an internal method used for pull and merge."""
 
2239
    hidden = True
 
2240
    takes_args = ['from_branch', 'to_branch']
 
2241
    def run(self, from_branch, to_branch):
 
2242
        from bzrlib.fetch import Fetcher
 
2243
        from bzrlib.branch import Branch
 
2244
        from_b = Branch.open(from_branch)
 
2245
        to_b = Branch.open(to_branch)
 
2246
        Fetcher(to_b, from_b)
 
2247
 
 
2248
 
 
2249
class cmd_missing(Command):
 
2250
    """Show unmerged/unpulled revisions between two branches.
 
2251
 
 
2252
    OTHER_BRANCH may be local or remote."""
 
2253
    takes_args = ['other_branch?']
 
2254
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2255
                     Option('mine-only', 
 
2256
                            'Display changes in the local branch only'),
 
2257
                     Option('theirs-only', 
 
2258
                            'Display changes in the remote branch only'), 
 
2259
                     'log-format',
 
2260
                     'line',
 
2261
                     'long', 
 
2262
                     'short',
 
2263
                     'show-ids',
 
2264
                     'verbose'
 
2265
                     ]
 
2266
 
 
2267
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2268
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2269
            show_ids=False, verbose=False):
 
2270
        from bzrlib.missing import find_unmerged, iter_log_data
 
2271
        from bzrlib.log import log_formatter
 
2272
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
2273
        parent = local_branch.get_parent()
 
2274
        if other_branch is None:
 
2275
            other_branch = parent
 
2276
            if other_branch is None:
 
2277
                raise BzrCommandError("No missing location known or specified.")
 
2278
            print "Using last location: " + local_branch.get_parent()
 
2279
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
2280
        if remote_branch.base == local_branch.base:
 
2281
            remote_branch = local_branch
 
2282
        local_branch.lock_read()
 
2283
        try:
 
2284
            remote_branch.lock_read()
 
2285
            try:
 
2286
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2287
                if (log_format == None):
 
2288
                    default = bzrlib.config.BranchConfig(local_branch).log_format()
 
2289
                    log_format = get_log_format(long=long, short=short, line=line, default=default)
 
2290
                lf = log_formatter(log_format, sys.stdout,
 
2291
                                   show_ids=show_ids,
 
2292
                                   show_timezone='original')
 
2293
                if reverse is False:
 
2294
                    local_extra.reverse()
 
2295
                    remote_extra.reverse()
 
2296
                if local_extra and not theirs_only:
 
2297
                    print "You have %d extra revision(s):" % len(local_extra)
 
2298
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2299
                                              verbose):
 
2300
                        lf.show(*data)
 
2301
                    printed_local = True
 
2302
                else:
 
2303
                    printed_local = False
 
2304
                if remote_extra and not mine_only:
 
2305
                    if printed_local is True:
 
2306
                        print "\n\n"
 
2307
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2308
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2309
                                              verbose):
 
2310
                        lf.show(*data)
 
2311
                if not remote_extra and not local_extra:
 
2312
                    status_code = 0
 
2313
                    print "Branches are up to date."
 
2314
                else:
 
2315
                    status_code = 1
 
2316
            finally:
 
2317
                remote_branch.unlock()
 
2318
        finally:
 
2319
            local_branch.unlock()
 
2320
        if not status_code and parent is None and other_branch is not None:
 
2321
            local_branch.lock_write()
 
2322
            try:
 
2323
                # handle race conditions - a parent might be set while we run.
 
2324
                if local_branch.get_parent() is None:
 
2325
                    local_branch.set_parent(other_branch)
 
2326
            finally:
 
2327
                local_branch.unlock()
 
2328
        return status_code
 
2329
 
 
2330
 
 
2331
class cmd_plugins(Command):
 
2332
    """List plugins"""
 
2333
    hidden = True
 
2334
    @display_command
 
2335
    def run(self):
 
2336
        import bzrlib.plugin
 
2337
        from inspect import getdoc
 
2338
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2339
            if hasattr(plugin, '__path__'):
 
2340
                print plugin.__path__[0]
 
2341
            elif hasattr(plugin, '__file__'):
 
2342
                print plugin.__file__
 
2343
            else:
 
2344
                print `plugin`
 
2345
                
 
2346
            d = getdoc(plugin)
 
2347
            if d:
 
2348
                print '\t', d.split('\n')[0]
 
2349
 
 
2350
 
 
2351
class cmd_testament(Command):
 
2352
    """Show testament (signing-form) of a revision."""
 
2353
    takes_options = ['revision', 'long']
 
2354
    takes_args = ['branch?']
 
2355
    @display_command
 
2356
    def run(self, branch=u'.', revision=None, long=False):
 
2357
        from bzrlib.testament import Testament
 
2358
        b = WorkingTree.open_containing(branch)[0].branch
 
2359
        b.lock_read()
 
2360
        try:
 
2361
            if revision is None:
 
2362
                rev_id = b.last_revision()
 
2363
            else:
 
2364
                rev_id = revision[0].in_history(b).rev_id
 
2365
            t = Testament.from_revision(b.repository, rev_id)
 
2366
            if long:
 
2367
                sys.stdout.writelines(t.as_text_lines())
 
2368
            else:
 
2369
                sys.stdout.write(t.as_short_text())
 
2370
        finally:
 
2371
            b.unlock()
 
2372
 
 
2373
 
 
2374
class cmd_annotate(Command):
 
2375
    """Show the origin of each line in a file.
 
2376
 
 
2377
    This prints out the given file with an annotation on the left side
 
2378
    indicating which revision, author and date introduced the change.
 
2379
 
 
2380
    If the origin is the same for a run of consecutive lines, it is 
 
2381
    shown only at the top, unless the --all option is given.
 
2382
    """
 
2383
    # TODO: annotate directories; showing when each file was last changed
 
2384
    # TODO: if the working copy is modified, show annotations on that 
 
2385
    #       with new uncommitted lines marked
 
2386
    aliases = ['blame', 'praise']
 
2387
    takes_args = ['filename']
 
2388
    takes_options = [Option('all', help='show annotations on all lines'),
 
2389
                     Option('long', help='show date in annotations'),
 
2390
                     'revision'
 
2391
                     ]
 
2392
 
 
2393
    @display_command
 
2394
    def run(self, filename, all=False, long=False, revision=None):
 
2395
        from bzrlib.annotate import annotate_file
 
2396
        tree, relpath = WorkingTree.open_containing(filename)
 
2397
        branch = tree.branch
 
2398
        branch.lock_read()
 
2399
        try:
 
2400
            if revision is None:
 
2401
                revision_id = branch.last_revision()
 
2402
            elif len(revision) != 1:
 
2403
                raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
2404
            else:
 
2405
                revision_id = revision[0].in_history(branch).rev_id
 
2406
            file_id = tree.inventory.path2id(relpath)
 
2407
            tree = branch.repository.revision_tree(revision_id)
 
2408
            file_version = tree.inventory[file_id].revision
 
2409
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
2410
        finally:
 
2411
            branch.unlock()
 
2412
 
 
2413
 
 
2414
class cmd_re_sign(Command):
 
2415
    """Create a digital signature for an existing revision."""
 
2416
    # TODO be able to replace existing ones.
 
2417
 
 
2418
    hidden = True # is this right ?
 
2419
    takes_args = ['revision_id*']
 
2420
    takes_options = ['revision']
 
2421
    
 
2422
    def run(self, revision_id_list=None, revision=None):
 
2423
        import bzrlib.config as config
 
2424
        import bzrlib.gpg as gpg
 
2425
        if revision_id_list is not None and revision is not None:
 
2426
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
2427
        if revision_id_list is None and revision is None:
 
2428
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
2429
        b = WorkingTree.open_containing(u'.')[0].branch
 
2430
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
2431
        if revision_id_list is not None:
 
2432
            for revision_id in revision_id_list:
 
2433
                b.repository.sign_revision(revision_id, gpg_strategy)
 
2434
        elif revision is not None:
 
2435
            if len(revision) == 1:
 
2436
                revno, rev_id = revision[0].in_history(b)
 
2437
                b.repository.sign_revision(rev_id, gpg_strategy)
 
2438
            elif len(revision) == 2:
 
2439
                # are they both on rh- if so we can walk between them
 
2440
                # might be nice to have a range helper for arbitrary
 
2441
                # revision paths. hmm.
 
2442
                from_revno, from_revid = revision[0].in_history(b)
 
2443
                to_revno, to_revid = revision[1].in_history(b)
 
2444
                if to_revid is None:
 
2445
                    to_revno = b.revno()
 
2446
                if from_revno is None or to_revno is None:
 
2447
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
2448
                for revno in range(from_revno, to_revno + 1):
 
2449
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
2450
                                               gpg_strategy)
 
2451
            else:
 
2452
                raise BzrCommandError('Please supply either one revision, or a range.')
 
2453
 
 
2454
 
 
2455
class cmd_bind(Command):
 
2456
    """Bind the current branch to a master branch.
 
2457
 
 
2458
    After binding, commits must succeed on the master branch
 
2459
    before they are executed on the local one.
 
2460
    """
 
2461
 
 
2462
    takes_args = ['location']
 
2463
    takes_options = []
 
2464
 
 
2465
    def run(self, location=None):
 
2466
        b, relpath = Branch.open_containing(u'.')
 
2467
        b_other = Branch.open(location)
 
2468
        try:
 
2469
            b.bind(b_other)
 
2470
        except DivergedBranches:
 
2471
            raise BzrCommandError('These branches have diverged.'
 
2472
                                  ' Try merging, and then bind again.')
 
2473
 
 
2474
 
 
2475
class cmd_unbind(Command):
 
2476
    """Unbind the current branch from its master branch.
 
2477
 
 
2478
    After unbinding, the local branch is considered independent.
 
2479
    All subsequent commits will be local.
 
2480
    """
 
2481
 
 
2482
    takes_args = []
 
2483
    takes_options = []
 
2484
 
 
2485
    def run(self):
 
2486
        b, relpath = Branch.open_containing(u'.')
 
2487
        if not b.unbind():
 
2488
            raise BzrCommandError('Local branch is not bound')
 
2489
 
 
2490
 
 
2491
class cmd_uncommit(bzrlib.commands.Command):
 
2492
    """Remove the last committed revision.
 
2493
 
 
2494
    --verbose will print out what is being removed.
 
2495
    --dry-run will go through all the motions, but not actually
 
2496
    remove anything.
 
2497
    
 
2498
    In the future, uncommit will create a revision bundle, which can then
 
2499
    be re-applied.
 
2500
    """
 
2501
 
 
2502
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
2503
    # unreferenced information in 'branch-as-repostory' branches.
 
2504
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
2505
    # information in shared branches as well.
 
2506
    takes_options = ['verbose', 'revision',
 
2507
                    Option('dry-run', help='Don\'t actually make changes'),
 
2508
                    Option('force', help='Say yes to all questions.')]
 
2509
    takes_args = ['location?']
 
2510
    aliases = []
 
2511
 
 
2512
    def run(self, location=None, 
 
2513
            dry_run=False, verbose=False,
 
2514
            revision=None, force=False):
 
2515
        from bzrlib.branch import Branch
 
2516
        from bzrlib.log import log_formatter
 
2517
        import sys
 
2518
        from bzrlib.uncommit import uncommit
 
2519
 
 
2520
        if location is None:
 
2521
            location = u'.'
 
2522
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
2523
        try:
 
2524
            tree = control.open_workingtree()
 
2525
            b = tree.branch
 
2526
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2527
            tree = None
 
2528
            b = control.open_branch()
 
2529
 
 
2530
        if revision is None:
 
2531
            revno = b.revno()
 
2532
            rev_id = b.last_revision()
 
2533
        else:
 
2534
            revno, rev_id = revision[0].in_history(b)
 
2535
        if rev_id is None:
 
2536
            print 'No revisions to uncommit.'
 
2537
 
 
2538
        for r in range(revno, b.revno()+1):
 
2539
            rev_id = b.get_rev_id(r)
 
2540
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
2541
            lf.show(r, b.repository.get_revision(rev_id), None)
 
2542
 
 
2543
        if dry_run:
 
2544
            print 'Dry-run, pretending to remove the above revisions.'
 
2545
            if not force:
 
2546
                val = raw_input('Press <enter> to continue')
 
2547
        else:
 
2548
            print 'The above revision(s) will be removed.'
 
2549
            if not force:
 
2550
                val = raw_input('Are you sure [y/N]? ')
 
2551
                if val.lower() not in ('y', 'yes'):
 
2552
                    print 'Canceled'
 
2553
                    return 0
 
2554
 
 
2555
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
2556
                revno=revno)
 
2557
 
 
2558
 
 
2559
class cmd_break_lock(Command):
 
2560
    """Break a dead lock on a repository, branch or working directory.
 
2561
 
 
2562
    CAUTION: Locks should only be broken when you are sure that the process
 
2563
    holding the lock has been stopped.
 
2564
 
 
2565
    You can get information on what locks are open via the 'bzr info' command.
 
2566
    
 
2567
    example:
 
2568
        bzr break-lock
 
2569
    """
 
2570
    takes_args = ['location?']
 
2571
 
 
2572
    def run(self, location=None, show=False):
 
2573
        if location is None:
 
2574
            location = u'.'
 
2575
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
2576
        try:
 
2577
            control.break_lock()
 
2578
        except NotImplementedError:
 
2579
            pass
 
2580
        
 
2581
 
 
2582
 
 
2583
# command-line interpretation helper for merge-related commands
 
2584
def merge(other_revision, base_revision,
 
2585
          check_clean=True, ignore_zero=False,
 
2586
          this_dir=None, backup_files=False, merge_type=Merge3Merger,
 
2587
          file_list=None, show_base=False, reprocess=False,
 
2588
          pb=DummyProgress()):
 
2589
    """Merge changes into a tree.
 
2590
 
 
2591
    base_revision
 
2592
        list(path, revno) Base for three-way merge.  
 
2593
        If [None, None] then a base will be automatically determined.
 
2594
    other_revision
 
2595
        list(path, revno) Other revision for three-way merge.
 
2596
    this_dir
 
2597
        Directory to merge changes into; '.' by default.
 
2598
    check_clean
 
2599
        If true, this_dir must have no uncommitted changes before the
 
2600
        merge begins.
 
2601
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
2602
        there are no conflicts; should be set when doing something we expect
 
2603
        to complete perfectly.
 
2604
    file_list - If supplied, merge only changes to selected files.
 
2605
 
 
2606
    All available ancestors of other_revision and base_revision are
 
2607
    automatically pulled into the branch.
 
2608
 
 
2609
    The revno may be -1 to indicate the last revision on the branch, which is
 
2610
    the typical case.
 
2611
 
 
2612
    This function is intended for use from the command line; programmatic
 
2613
    clients might prefer to call merge.merge_inner(), which has less magic 
 
2614
    behavior.
 
2615
    """
 
2616
    from bzrlib.merge import Merger
 
2617
    if this_dir is None:
 
2618
        this_dir = u'.'
 
2619
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
2620
    if show_base and not merge_type is Merge3Merger:
 
2621
        raise BzrCommandError("Show-base is not supported for this merge"
 
2622
                              " type. %s" % merge_type)
 
2623
    if reprocess and not merge_type.supports_reprocess:
 
2624
        raise BzrCommandError("Conflict reduction is not supported for merge"
 
2625
                              " type %s." % merge_type)
 
2626
    if reprocess and show_base:
 
2627
        raise BzrCommandError("Cannot do conflict reduction and show base.")
 
2628
    try:
 
2629
        merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
 
2630
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
2631
        merger.pp.next_phase()
 
2632
        merger.check_basis(check_clean)
 
2633
        merger.set_other(other_revision)
 
2634
        merger.pp.next_phase()
 
2635
        merger.set_base(base_revision)
 
2636
        if merger.base_rev_id == merger.other_rev_id:
 
2637
            note('Nothing to do.')
 
2638
            return 0
 
2639
        merger.backup_files = backup_files
 
2640
        merger.merge_type = merge_type 
 
2641
        merger.set_interesting_files(file_list)
 
2642
        merger.show_base = show_base 
 
2643
        merger.reprocess = reprocess
 
2644
        conflicts = merger.do_merge()
 
2645
        if file_list is None:
 
2646
            merger.set_pending()
 
2647
    finally:
 
2648
        pb.clear()
 
2649
    return conflicts
 
2650
 
 
2651
 
 
2652
# these get imported and then picked up by the scan for cmd_*
 
2653
# TODO: Some more consistent way to split command definitions across files;
 
2654
# we do need to load at least some information about them to know of 
 
2655
# aliases.  ideally we would avoid loading the implementation until the
 
2656
# details were needed.
 
2657
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
2658
from bzrlib.bundle.commands import cmd_bundle_revisions
 
2659
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
2660
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
2661
        cmd_weave_plan_merge, cmd_weave_merge_text