~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2005-06-20 04:24:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050620042435-7c315b5a93001b89
- add jk's patchwork client

Show diffs side-by-side

added added

removed removed

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