/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2009-02-11 00:29:57 UTC
  • mfrom: (3990.2.7 shelf)
  • mto: This revision was merged to the branch mainline in revision 4000.
  • Revision ID: ian.clatworthy@canonical.com-20090211002957-m3f364g9ovnwqm6h
Improve shelf documentation & fix backtrace (Daniel Watkins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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
import os
 
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
import codecs
 
24
import cStringIO
 
25
import sys
 
26
import time
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    bugtracker,
 
31
    bundle,
 
32
    btree_index,
 
33
    bzrdir,
 
34
    delta,
 
35
    config,
 
36
    errors,
 
37
    globbing,
 
38
    log,
 
39
    merge as _mod_merge,
 
40
    merge_directive,
 
41
    osutils,
 
42
    reconfigure,
 
43
    revision as _mod_revision,
 
44
    symbol_versioning,
 
45
    transport,
 
46
    tree as _mod_tree,
 
47
    ui,
 
48
    urlutils,
 
49
    )
 
50
from bzrlib.branch import Branch
 
51
from bzrlib.conflicts import ConflictList
 
52
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
 
53
from bzrlib.smtp_connection import SMTPConnection
 
54
from bzrlib.workingtree import WorkingTree
 
55
""")
 
56
 
 
57
from bzrlib.commands import Command, display_command
 
58
from bzrlib.option import (
 
59
    ListOption,
 
60
    Option,
 
61
    RegistryOption,
 
62
    custom_help,
 
63
    _parse_revision_str,
 
64
    )
 
65
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
66
 
 
67
 
 
68
def tree_files(file_list, default_branch=u'.', canonicalize=True):
 
69
    try:
 
70
        return internal_tree_files(file_list, default_branch, canonicalize)
 
71
    except errors.FileInWrongBranch, e:
 
72
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
73
                                     (e.path, file_list[0]))
 
74
 
 
75
 
 
76
def _get_one_revision(command_name, revisions):
 
77
    if revisions is None:
 
78
        return None
 
79
    if len(revisions) != 1:
 
80
        raise errors.BzrCommandError(
 
81
            'bzr %s --revision takes exactly one revision identifier' % (
 
82
                command_name,))
 
83
    return revisions[0]
 
84
 
 
85
 
 
86
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
87
    if branch is None:
 
88
        branch = tree.branch
 
89
    if revisions is None:
 
90
        if tree is not None:
 
91
            rev_tree = tree.basis_tree()
 
92
        else:
 
93
            rev_tree = branch.basis_tree()
 
94
    else:
 
95
        revision = _get_one_revision(command_name, revisions)
 
96
        rev_tree = revision.as_tree(branch)
 
97
    return rev_tree
 
98
 
 
99
 
 
100
# XXX: Bad function name; should possibly also be a class method of
 
101
# WorkingTree rather than a function.
 
102
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True):
 
103
    """Convert command-line paths to a WorkingTree and relative paths.
 
104
 
 
105
    This is typically used for command-line processors that take one or
 
106
    more filenames, and infer the workingtree that contains them.
 
107
 
 
108
    The filenames given are not required to exist.
 
109
 
 
110
    :param file_list: Filenames to convert.  
 
111
 
 
112
    :param default_branch: Fallback tree path to use if file_list is empty or
 
113
        None.
 
114
 
 
115
    :return: workingtree, [relative_paths]
 
116
    """
 
117
    if file_list is None or len(file_list) == 0:
 
118
        return WorkingTree.open_containing(default_branch)[0], file_list
 
119
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
120
    return tree, safe_relpath_files(tree, file_list, canonicalize)
 
121
 
 
122
 
 
123
def safe_relpath_files(tree, file_list, canonicalize=True):
 
124
    """Convert file_list into a list of relpaths in tree.
 
125
 
 
126
    :param tree: A tree to operate on.
 
127
    :param file_list: A list of user provided paths or None.
 
128
    :return: A list of relative paths.
 
129
    :raises errors.PathNotChild: When a provided path is in a different tree
 
130
        than tree.
 
131
    """
 
132
    if file_list is None:
 
133
        return None
 
134
    new_list = []
 
135
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
136
    # doesn't - fix that up here before we enter the loop.
 
137
    if canonicalize:
 
138
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
139
    else:
 
140
        fixer = tree.relpath
 
141
    for filename in file_list:
 
142
        try:
 
143
            new_list.append(fixer(osutils.dereference_path(filename)))
 
144
        except errors.PathNotChild:
 
145
            raise errors.FileInWrongBranch(tree.branch, filename)
 
146
    return new_list
 
147
 
 
148
 
 
149
# TODO: Make sure no commands unconditionally use the working directory as a
 
150
# branch.  If a filename argument is used, the first of them should be used to
 
151
# specify the branch.  (Perhaps this can be factored out into some kind of
 
152
# Argument class, representing a file in a branch, where the first occurrence
 
153
# opens the branch?)
 
154
 
 
155
class cmd_status(Command):
 
156
    """Display status summary.
 
157
 
 
158
    This reports on versioned and unknown files, reporting them
 
159
    grouped by state.  Possible states are:
 
160
 
 
161
    added
 
162
        Versioned in the working copy but not in the previous revision.
 
163
 
 
164
    removed
 
165
        Versioned in the previous revision but removed or deleted
 
166
        in the working copy.
 
167
 
 
168
    renamed
 
169
        Path of this file changed from the previous revision;
 
170
        the text may also have changed.  This includes files whose
 
171
        parent directory was renamed.
 
172
 
 
173
    modified
 
174
        Text has changed since the previous revision.
 
175
 
 
176
    kind changed
 
177
        File kind has been changed (e.g. from file to directory).
 
178
 
 
179
    unknown
 
180
        Not versioned and not matching an ignore pattern.
 
181
 
 
182
    To see ignored files use 'bzr ignored'.  For details on the
 
183
    changes to file texts, use 'bzr diff'.
 
184
    
 
185
    Note that --short or -S gives status flags for each item, similar
 
186
    to Subversion's status command. To get output similar to svn -q,
 
187
    use bzr status -SV.
 
188
 
 
189
    If no arguments are specified, the status of the entire working
 
190
    directory is shown.  Otherwise, only the status of the specified
 
191
    files or directories is reported.  If a directory is given, status
 
192
    is reported for everything inside that directory.
 
193
 
 
194
    Before merges are committed, the pending merge tip revisions are
 
195
    shown. To see all pending merge revisions, use the -v option.
 
196
    To skip the display of pending merge information altogether, use
 
197
    the no-pending option or specify a file/directory.
 
198
 
 
199
    If a revision argument is given, the status is calculated against
 
200
    that revision, or between two revisions if two are provided.
 
201
    """
 
202
    
 
203
    # TODO: --no-recurse, --recurse options
 
204
    
 
205
    takes_args = ['file*']
 
206
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
207
                     Option('short', help='Use short status indicators.',
 
208
                            short_name='S'),
 
209
                     Option('versioned', help='Only show versioned files.',
 
210
                            short_name='V'),
 
211
                     Option('no-pending', help='Don\'t show pending merges.',
 
212
                           ),
 
213
                     ]
 
214
    aliases = ['st', 'stat']
 
215
 
 
216
    encoding_type = 'replace'
 
217
    _see_also = ['diff', 'revert', 'status-flags']
 
218
    
 
219
    @display_command
 
220
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
221
            versioned=False, no_pending=False, verbose=False):
 
222
        from bzrlib.status import show_tree_status
 
223
 
 
224
        if revision and len(revision) > 2:
 
225
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
226
                                         ' one or two revision specifiers')
 
227
 
 
228
        tree, relfile_list = tree_files(file_list)
 
229
        # Avoid asking for specific files when that is not needed.
 
230
        if relfile_list == ['']:
 
231
            relfile_list = None
 
232
            # Don't disable pending merges for full trees other than '.'.
 
233
            if file_list == ['.']:
 
234
                no_pending = True
 
235
        # A specific path within a tree was given.
 
236
        elif relfile_list is not None:
 
237
            no_pending = True
 
238
        show_tree_status(tree, show_ids=show_ids,
 
239
                         specific_files=relfile_list, revision=revision,
 
240
                         to_file=self.outf, short=short, versioned=versioned,
 
241
                         show_pending=(not no_pending), verbose=verbose)
 
242
 
 
243
 
 
244
class cmd_cat_revision(Command):
 
245
    """Write out metadata for a revision.
 
246
    
 
247
    The revision to print can either be specified by a specific
 
248
    revision identifier, or you can use --revision.
 
249
    """
 
250
 
 
251
    hidden = True
 
252
    takes_args = ['revision_id?']
 
253
    takes_options = ['revision']
 
254
    # cat-revision is more for frontends so should be exact
 
255
    encoding = 'strict'
 
256
    
 
257
    @display_command
 
258
    def run(self, revision_id=None, revision=None):
 
259
        if revision_id is not None and revision is not None:
 
260
            raise errors.BzrCommandError('You can only supply one of'
 
261
                                         ' revision_id or --revision')
 
262
        if revision_id is None and revision is None:
 
263
            raise errors.BzrCommandError('You must supply either'
 
264
                                         ' --revision or a revision_id')
 
265
        b = WorkingTree.open_containing(u'.')[0].branch
 
266
 
 
267
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
268
        if revision_id is not None:
 
269
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
270
            try:
 
271
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
272
            except errors.NoSuchRevision:
 
273
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
274
                    revision_id)
 
275
                raise errors.BzrCommandError(msg)
 
276
        elif revision is not None:
 
277
            for rev in revision:
 
278
                if rev is None:
 
279
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
280
                                                 ' revision.')
 
281
                rev_id = rev.as_revision_id(b)
 
282
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
283
 
 
284
 
 
285
class cmd_dump_btree(Command):
 
286
    """Dump the contents of a btree index file to stdout.
 
287
 
 
288
    PATH is a btree index file, it can be any URL. This includes things like
 
289
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
 
290
 
 
291
    By default, the tuples stored in the index file will be displayed. With
 
292
    --raw, we will uncompress the pages, but otherwise display the raw bytes
 
293
    stored in the index.
 
294
    """
 
295
 
 
296
    # TODO: Do we want to dump the internal nodes as well?
 
297
    # TODO: It would be nice to be able to dump the un-parsed information,
 
298
    #       rather than only going through iter_all_entries. However, this is
 
299
    #       good enough for a start
 
300
    hidden = True
 
301
    encoding_type = 'exact'
 
302
    takes_args = ['path']
 
303
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
 
304
                                        ' rather than the parsed tuples.'),
 
305
                    ]
 
306
 
 
307
    def run(self, path, raw=False):
 
308
        dirname, basename = osutils.split(path)
 
309
        t = transport.get_transport(dirname)
 
310
        if raw:
 
311
            self._dump_raw_bytes(t, basename)
 
312
        else:
 
313
            self._dump_entries(t, basename)
 
314
 
 
315
    def _get_index_and_bytes(self, trans, basename):
 
316
        """Create a BTreeGraphIndex and raw bytes."""
 
317
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
 
318
        bytes = trans.get_bytes(basename)
 
319
        bt._file = cStringIO.StringIO(bytes)
 
320
        bt._size = len(bytes)
 
321
        return bt, bytes
 
322
 
 
323
    def _dump_raw_bytes(self, trans, basename):
 
324
        import zlib
 
325
 
 
326
        # We need to parse at least the root node.
 
327
        # This is because the first page of every row starts with an
 
328
        # uncompressed header.
 
329
        bt, bytes = self._get_index_and_bytes(trans, basename)
 
330
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
 
331
                                                     btree_index._PAGE_SIZE)):
 
332
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
 
333
            page_bytes = bytes[page_start:page_end]
 
334
            if page_idx == 0:
 
335
                self.outf.write('Root node:\n')
 
336
                header_end, data = bt._parse_header_from_bytes(page_bytes)
 
337
                self.outf.write(page_bytes[:header_end])
 
338
                page_bytes = data
 
339
            self.outf.write('\nPage %d\n' % (page_idx,))
 
340
            decomp_bytes = zlib.decompress(page_bytes)
 
341
            self.outf.write(decomp_bytes)
 
342
            self.outf.write('\n')
 
343
 
 
344
    def _dump_entries(self, trans, basename):
 
345
        try:
 
346
            st = trans.stat(basename)
 
347
        except errors.TransportNotPossible:
 
348
            # We can't stat, so we'll fake it because we have to do the 'get()'
 
349
            # anyway.
 
350
            bt, _ = self._get_index_and_bytes(trans, basename)
 
351
        else:
 
352
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
 
353
        for node in bt.iter_all_entries():
 
354
            # Node is made up of:
 
355
            # (index, key, value, [references])
 
356
            self.outf.write('%s\n' % (node[1:],))
 
357
 
 
358
 
 
359
class cmd_remove_tree(Command):
 
360
    """Remove the working tree from a given branch/checkout.
 
361
 
 
362
    Since a lightweight checkout is little more than a working tree
 
363
    this will refuse to run against one.
 
364
 
 
365
    To re-create the working tree, use "bzr checkout".
 
366
    """
 
367
    _see_also = ['checkout', 'working-trees']
 
368
    takes_args = ['location?']
 
369
    takes_options = [
 
370
        Option('force',
 
371
               help='Remove the working tree even if it has '
 
372
                    'uncommitted changes.'),
 
373
        ]
 
374
 
 
375
    def run(self, location='.', force=False):
 
376
        d = bzrdir.BzrDir.open(location)
 
377
        
 
378
        try:
 
379
            working = d.open_workingtree()
 
380
        except errors.NoWorkingTree:
 
381
            raise errors.BzrCommandError("No working tree to remove")
 
382
        except errors.NotLocalUrl:
 
383
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
384
                                         "remote path")
 
385
        if not force:
 
386
            changes = working.changes_from(working.basis_tree())
 
387
            if changes.has_changed():
 
388
                raise errors.UncommittedChanges(working)
 
389
 
 
390
        working_path = working.bzrdir.root_transport.base
 
391
        branch_path = working.branch.bzrdir.root_transport.base
 
392
        if working_path != branch_path:
 
393
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
394
                                         "a lightweight checkout")
 
395
        
 
396
        d.destroy_workingtree()
 
397
        
 
398
 
 
399
class cmd_revno(Command):
 
400
    """Show current revision number.
 
401
 
 
402
    This is equal to the number of revisions on this branch.
 
403
    """
 
404
 
 
405
    _see_also = ['info']
 
406
    takes_args = ['location?']
 
407
 
 
408
    @display_command
 
409
    def run(self, location=u'.'):
 
410
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
411
        self.outf.write('\n')
 
412
 
 
413
 
 
414
class cmd_revision_info(Command):
 
415
    """Show revision number and revision id for a given revision identifier.
 
416
    """
 
417
    hidden = True
 
418
    takes_args = ['revision_info*']
 
419
    takes_options = [
 
420
        'revision',
 
421
        Option('directory',
 
422
            help='Branch to examine, '
 
423
                 'rather than the one containing the working directory.',
 
424
            short_name='d',
 
425
            type=unicode,
 
426
            ),
 
427
        ]
 
428
 
 
429
    @display_command
 
430
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
431
 
 
432
        revs = []
 
433
        if revision is not None:
 
434
            revs.extend(revision)
 
435
        if revision_info_list is not None:
 
436
            for rev in revision_info_list:
 
437
                revs.append(RevisionSpec.from_string(rev))
 
438
 
 
439
        b = Branch.open_containing(directory)[0]
 
440
 
 
441
        if len(revs) == 0:
 
442
            revs.append(RevisionSpec.from_string('-1'))
 
443
 
 
444
        for rev in revs:
 
445
            revision_id = rev.as_revision_id(b)
 
446
            try:
 
447
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
448
            except errors.NoSuchRevision:
 
449
                dotted_map = b.get_revision_id_to_revno_map()
 
450
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
451
            print '%s %s' % (revno, revision_id)
 
452
 
 
453
    
 
454
class cmd_add(Command):
 
455
    """Add specified files or directories.
 
456
 
 
457
    In non-recursive mode, all the named items are added, regardless
 
458
    of whether they were previously ignored.  A warning is given if
 
459
    any of the named files are already versioned.
 
460
 
 
461
    In recursive mode (the default), files are treated the same way
 
462
    but the behaviour for directories is different.  Directories that
 
463
    are already versioned do not give a warning.  All directories,
 
464
    whether already versioned or not, are searched for files or
 
465
    subdirectories that are neither versioned or ignored, and these
 
466
    are added.  This search proceeds recursively into versioned
 
467
    directories.  If no names are given '.' is assumed.
 
468
 
 
469
    Therefore simply saying 'bzr add' will version all files that
 
470
    are currently unknown.
 
471
 
 
472
    Adding a file whose parent directory is not versioned will
 
473
    implicitly add the parent, and so on up to the root. This means
 
474
    you should never need to explicitly add a directory, they'll just
 
475
    get added when you add a file in the directory.
 
476
 
 
477
    --dry-run will show which files would be added, but not actually 
 
478
    add them.
 
479
 
 
480
    --file-ids-from will try to use the file ids from the supplied path.
 
481
    It looks up ids trying to find a matching parent directory with the
 
482
    same filename, and then by pure path. This option is rarely needed
 
483
    but can be useful when adding the same logical file into two
 
484
    branches that will be merged later (without showing the two different
 
485
    adds as a conflict). It is also useful when merging another project
 
486
    into a subdirectory of this one.
 
487
    """
 
488
    takes_args = ['file*']
 
489
    takes_options = [
 
490
        Option('no-recurse',
 
491
               help="Don't recursively add the contents of directories."),
 
492
        Option('dry-run',
 
493
               help="Show what would be done, but don't actually do anything."),
 
494
        'verbose',
 
495
        Option('file-ids-from',
 
496
               type=unicode,
 
497
               help='Lookup file ids from this tree.'),
 
498
        ]
 
499
    encoding_type = 'replace'
 
500
    _see_also = ['remove']
 
501
 
 
502
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
503
            file_ids_from=None):
 
504
        import bzrlib.add
 
505
 
 
506
        base_tree = None
 
507
        if file_ids_from is not None:
 
508
            try:
 
509
                base_tree, base_path = WorkingTree.open_containing(
 
510
                                            file_ids_from)
 
511
            except errors.NoWorkingTree:
 
512
                base_branch, base_path = Branch.open_containing(
 
513
                                            file_ids_from)
 
514
                base_tree = base_branch.basis_tree()
 
515
 
 
516
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
517
                          to_file=self.outf, should_print=(not is_quiet()))
 
518
        else:
 
519
            action = bzrlib.add.AddAction(to_file=self.outf,
 
520
                should_print=(not is_quiet()))
 
521
 
 
522
        if base_tree:
 
523
            base_tree.lock_read()
 
524
        try:
 
525
            file_list = self._maybe_expand_globs(file_list)
 
526
            if file_list:
 
527
                tree = WorkingTree.open_containing(file_list[0])[0]
 
528
            else:
 
529
                tree = WorkingTree.open_containing(u'.')[0]
 
530
            added, ignored = tree.smart_add(file_list, not
 
531
                no_recurse, action=action, save=not dry_run)
 
532
        finally:
 
533
            if base_tree is not None:
 
534
                base_tree.unlock()
 
535
        if not is_quiet() and len(added) > 0:
 
536
            self.outf.write('add completed\n')
 
537
        if len(ignored) > 0:
 
538
            if verbose:
 
539
                for glob in sorted(ignored.keys()):
 
540
                    for path in ignored[glob]:
 
541
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
542
                                        % (path, glob))
 
543
            else:
 
544
                match_len = 0
 
545
                for glob, paths in ignored.items():
 
546
                    match_len += len(paths)
 
547
                self.outf.write("ignored %d file(s).\n" % match_len)
 
548
            self.outf.write("If you wish to add some of these files,"
 
549
                            " please add them by name.\n")
 
550
 
 
551
 
 
552
class cmd_mkdir(Command):
 
553
    """Create a new versioned directory.
 
554
 
 
555
    This is equivalent to creating the directory and then adding it.
 
556
    """
 
557
 
 
558
    takes_args = ['dir+']
 
559
    encoding_type = 'replace'
 
560
 
 
561
    def run(self, dir_list):
 
562
        for d in dir_list:
 
563
            os.mkdir(d)
 
564
            wt, dd = WorkingTree.open_containing(d)
 
565
            wt.add([dd])
 
566
            self.outf.write('added %s\n' % d)
 
567
 
 
568
 
 
569
class cmd_relpath(Command):
 
570
    """Show path of a file relative to root"""
 
571
 
 
572
    takes_args = ['filename']
 
573
    hidden = True
 
574
    
 
575
    @display_command
 
576
    def run(self, filename):
 
577
        # TODO: jam 20050106 Can relpath return a munged path if
 
578
        #       sys.stdout encoding cannot represent it?
 
579
        tree, relpath = WorkingTree.open_containing(filename)
 
580
        self.outf.write(relpath)
 
581
        self.outf.write('\n')
 
582
 
 
583
 
 
584
class cmd_inventory(Command):
 
585
    """Show inventory of the current working copy or a revision.
 
586
 
 
587
    It is possible to limit the output to a particular entry
 
588
    type using the --kind option.  For example: --kind file.
 
589
 
 
590
    It is also possible to restrict the list of files to a specific
 
591
    set. For example: bzr inventory --show-ids this/file
 
592
    """
 
593
 
 
594
    hidden = True
 
595
    _see_also = ['ls']
 
596
    takes_options = [
 
597
        'revision',
 
598
        'show-ids',
 
599
        Option('kind',
 
600
               help='List entries of a particular kind: file, directory, symlink.',
 
601
               type=unicode),
 
602
        ]
 
603
    takes_args = ['file*']
 
604
 
 
605
    @display_command
 
606
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
607
        if kind and kind not in ['file', 'directory', 'symlink']:
 
608
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
609
 
 
610
        revision = _get_one_revision('inventory', revision)
 
611
        work_tree, file_list = tree_files(file_list)
 
612
        work_tree.lock_read()
 
613
        try:
 
614
            if revision is not None:
 
615
                tree = revision.as_tree(work_tree.branch)
 
616
 
 
617
                extra_trees = [work_tree]
 
618
                tree.lock_read()
 
619
            else:
 
620
                tree = work_tree
 
621
                extra_trees = []
 
622
 
 
623
            if file_list is not None:
 
624
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
625
                                          require_versioned=True)
 
626
                # find_ids_across_trees may include some paths that don't
 
627
                # exist in 'tree'.
 
628
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
629
                                 for file_id in file_ids if file_id in tree)
 
630
            else:
 
631
                entries = tree.inventory.entries()
 
632
        finally:
 
633
            tree.unlock()
 
634
            if tree is not work_tree:
 
635
                work_tree.unlock()
 
636
 
 
637
        for path, entry in entries:
 
638
            if kind and kind != entry.kind:
 
639
                continue
 
640
            if show_ids:
 
641
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
642
            else:
 
643
                self.outf.write(path)
 
644
                self.outf.write('\n')
 
645
 
 
646
 
 
647
class cmd_mv(Command):
 
648
    """Move or rename a file.
 
649
 
 
650
    :Usage:
 
651
        bzr mv OLDNAME NEWNAME
 
652
 
 
653
        bzr mv SOURCE... DESTINATION
 
654
 
 
655
    If the last argument is a versioned directory, all the other names
 
656
    are moved into it.  Otherwise, there must be exactly two arguments
 
657
    and the file is changed to a new name.
 
658
 
 
659
    If OLDNAME does not exist on the filesystem but is versioned and
 
660
    NEWNAME does exist on the filesystem but is not versioned, mv
 
661
    assumes that the file has been manually moved and only updates
 
662
    its internal inventory to reflect that change.
 
663
    The same is valid when moving many SOURCE files to a DESTINATION.
 
664
 
 
665
    Files cannot be moved between branches.
 
666
    """
 
667
 
 
668
    takes_args = ['names*']
 
669
    takes_options = [Option("after", help="Move only the bzr identifier"
 
670
        " of the file, because the file has already been moved."),
 
671
        ]
 
672
    aliases = ['move', 'rename']
 
673
    encoding_type = 'replace'
 
674
 
 
675
    def run(self, names_list, after=False):
 
676
        if names_list is None:
 
677
            names_list = []
 
678
 
 
679
        if len(names_list) < 2:
 
680
            raise errors.BzrCommandError("missing file argument")
 
681
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
682
        tree.lock_write()
 
683
        try:
 
684
            self._run(tree, names_list, rel_names, after)
 
685
        finally:
 
686
            tree.unlock()
 
687
 
 
688
    def _run(self, tree, names_list, rel_names, after):
 
689
        into_existing = osutils.isdir(names_list[-1])
 
690
        if into_existing and len(names_list) == 2:
 
691
            # special cases:
 
692
            # a. case-insensitive filesystem and change case of dir
 
693
            # b. move directory after the fact (if the source used to be
 
694
            #    a directory, but now doesn't exist in the working tree
 
695
            #    and the target is an existing directory, just rename it)
 
696
            if (not tree.case_sensitive
 
697
                and rel_names[0].lower() == rel_names[1].lower()):
 
698
                into_existing = False
 
699
            else:
 
700
                inv = tree.inventory
 
701
                # 'fix' the case of a potential 'from'
 
702
                from_id = tree.path2id(
 
703
                            tree.get_canonical_inventory_path(rel_names[0]))
 
704
                if (not osutils.lexists(names_list[0]) and
 
705
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
706
                    into_existing = False
 
707
        # move/rename
 
708
        if into_existing:
 
709
            # move into existing directory
 
710
            # All entries reference existing inventory items, so fix them up
 
711
            # for cicp file-systems.
 
712
            rel_names = tree.get_canonical_inventory_paths(rel_names)
 
713
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
714
                self.outf.write("%s => %s\n" % pair)
 
715
        else:
 
716
            if len(names_list) != 2:
 
717
                raise errors.BzrCommandError('to mv multiple files the'
 
718
                                             ' destination must be a versioned'
 
719
                                             ' directory')
 
720
 
 
721
            # for cicp file-systems: the src references an existing inventory
 
722
            # item:
 
723
            src = tree.get_canonical_inventory_path(rel_names[0])
 
724
            # Find the canonical version of the destination:  In all cases, the
 
725
            # parent of the target must be in the inventory, so we fetch the
 
726
            # canonical version from there (we do not always *use* the
 
727
            # canonicalized tail portion - we may be attempting to rename the
 
728
            # case of the tail)
 
729
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
 
730
            dest_parent = osutils.dirname(canon_dest)
 
731
            spec_tail = osutils.basename(rel_names[1])
 
732
            # For a CICP file-system, we need to avoid creating 2 inventory
 
733
            # entries that differ only by case.  So regardless of the case
 
734
            # we *want* to use (ie, specified by the user or the file-system),
 
735
            # we must always choose to use the case of any existing inventory
 
736
            # items.  The only exception to this is when we are attempting a
 
737
            # case-only rename (ie, canonical versions of src and dest are
 
738
            # the same)
 
739
            dest_id = tree.path2id(canon_dest)
 
740
            if dest_id is None or tree.path2id(src) == dest_id:
 
741
                # No existing item we care about, so work out what case we
 
742
                # are actually going to use.
 
743
                if after:
 
744
                    # If 'after' is specified, the tail must refer to a file on disk.
 
745
                    if dest_parent:
 
746
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
 
747
                    else:
 
748
                        # pathjoin with an empty tail adds a slash, which breaks
 
749
                        # relpath :(
 
750
                        dest_parent_fq = tree.basedir
 
751
    
 
752
                    dest_tail = osutils.canonical_relpath(
 
753
                                    dest_parent_fq,
 
754
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
 
755
                else:
 
756
                    # not 'after', so case as specified is used
 
757
                    dest_tail = spec_tail
 
758
            else:
 
759
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
760
                dest_tail = os.path.basename(canon_dest)
 
761
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
762
            mutter("attempting to move %s => %s", src, dest)
 
763
            tree.rename_one(src, dest, after=after)
 
764
            self.outf.write("%s => %s\n" % (src, dest))
 
765
 
 
766
 
 
767
class cmd_pull(Command):
 
768
    """Turn this branch into a mirror of another branch.
 
769
 
 
770
    This command only works on branches that have not diverged.  Branches are
 
771
    considered diverged if the destination branch's most recent commit is one
 
772
    that has not been merged (directly or indirectly) into the parent.
 
773
 
 
774
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
775
    from one into the other.  Once one branch has merged, the other should
 
776
    be able to pull it again.
 
777
 
 
778
    If you want to forget your local changes and just update your branch to
 
779
    match the remote one, use pull --overwrite.
 
780
 
 
781
    If there is no default location set, the first pull will set it.  After
 
782
    that, you can omit the location to use the default.  To change the
 
783
    default, use --remember. The value will only be saved if the remote
 
784
    location can be accessed.
 
785
 
 
786
    Note: The location can be specified either in the form of a branch,
 
787
    or in the form of a path to a file containing a merge directive generated
 
788
    with bzr send.
 
789
    """
 
790
 
 
791
    _see_also = ['push', 'update', 'status-flags']
 
792
    takes_options = ['remember', 'overwrite', 'revision',
 
793
        custom_help('verbose',
 
794
            help='Show logs of pulled revisions.'),
 
795
        Option('directory',
 
796
            help='Branch to pull into, '
 
797
                 'rather than the one containing the working directory.',
 
798
            short_name='d',
 
799
            type=unicode,
 
800
            ),
 
801
        ]
 
802
    takes_args = ['location?']
 
803
    encoding_type = 'replace'
 
804
 
 
805
    def run(self, location=None, remember=False, overwrite=False,
 
806
            revision=None, verbose=False,
 
807
            directory=None):
 
808
        # FIXME: too much stuff is in the command class
 
809
        revision_id = None
 
810
        mergeable = None
 
811
        if directory is None:
 
812
            directory = u'.'
 
813
        try:
 
814
            tree_to = WorkingTree.open_containing(directory)[0]
 
815
            branch_to = tree_to.branch
 
816
        except errors.NoWorkingTree:
 
817
            tree_to = None
 
818
            branch_to = Branch.open_containing(directory)[0]
 
819
 
 
820
        possible_transports = []
 
821
        if location is not None:
 
822
            try:
 
823
                mergeable = bundle.read_mergeable_from_url(location,
 
824
                    possible_transports=possible_transports)
 
825
            except errors.NotABundle:
 
826
                mergeable = None
 
827
 
 
828
        stored_loc = branch_to.get_parent()
 
829
        if location is None:
 
830
            if stored_loc is None:
 
831
                raise errors.BzrCommandError("No pull location known or"
 
832
                                             " specified.")
 
833
            else:
 
834
                display_url = urlutils.unescape_for_display(stored_loc,
 
835
                        self.outf.encoding)
 
836
                if not is_quiet():
 
837
                    self.outf.write("Using saved parent location: %s\n" % display_url)
 
838
                location = stored_loc
 
839
 
 
840
        revision = _get_one_revision('pull', revision)
 
841
        if mergeable is not None:
 
842
            if revision is not None:
 
843
                raise errors.BzrCommandError(
 
844
                    'Cannot use -r with merge directives or bundles')
 
845
            mergeable.install_revisions(branch_to.repository)
 
846
            base_revision_id, revision_id, verified = \
 
847
                mergeable.get_merge_request(branch_to.repository)
 
848
            branch_from = branch_to
 
849
        else:
 
850
            branch_from = Branch.open(location,
 
851
                possible_transports=possible_transports)
 
852
 
 
853
            if branch_to.get_parent() is None or remember:
 
854
                branch_to.set_parent(branch_from.base)
 
855
 
 
856
        if revision is not None:
 
857
            revision_id = revision.as_revision_id(branch_from)
 
858
 
 
859
        branch_to.lock_write()
 
860
        try:
 
861
            if tree_to is not None:
 
862
                change_reporter = delta._ChangeReporter(
 
863
                    unversioned_filter=tree_to.is_ignored)
 
864
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
865
                                      change_reporter,
 
866
                                      possible_transports=possible_transports)
 
867
            else:
 
868
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
869
 
 
870
            result.report(self.outf)
 
871
            if verbose and result.old_revid != result.new_revid:
 
872
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
873
                                       result.old_revid)
 
874
        finally:
 
875
            branch_to.unlock()
 
876
 
 
877
 
 
878
class cmd_push(Command):
 
879
    """Update a mirror of this branch.
 
880
    
 
881
    The target branch will not have its working tree populated because this
 
882
    is both expensive, and is not supported on remote file systems.
 
883
    
 
884
    Some smart servers or protocols *may* put the working tree in place in
 
885
    the future.
 
886
 
 
887
    This command only works on branches that have not diverged.  Branches are
 
888
    considered diverged if the destination branch's most recent commit is one
 
889
    that has not been merged (directly or indirectly) by the source branch.
 
890
 
 
891
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
892
    the other branch completely, discarding its unmerged changes.
 
893
    
 
894
    If you want to ensure you have the different changes in the other branch,
 
895
    do a merge (see bzr help merge) from the other branch, and commit that.
 
896
    After that you will be able to do a push without '--overwrite'.
 
897
 
 
898
    If there is no default push location set, the first push will set it.
 
899
    After that, you can omit the location to use the default.  To change the
 
900
    default, use --remember. The value will only be saved if the remote
 
901
    location can be accessed.
 
902
    """
 
903
 
 
904
    _see_also = ['pull', 'update', 'working-trees']
 
905
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
906
        Option('create-prefix',
 
907
               help='Create the path leading up to the branch '
 
908
                    'if it does not already exist.'),
 
909
        Option('directory',
 
910
            help='Branch to push from, '
 
911
                 'rather than the one containing the working directory.',
 
912
            short_name='d',
 
913
            type=unicode,
 
914
            ),
 
915
        Option('use-existing-dir',
 
916
               help='By default push will fail if the target'
 
917
                    ' directory exists, but does not already'
 
918
                    ' have a control directory.  This flag will'
 
919
                    ' allow push to proceed.'),
 
920
        Option('stacked',
 
921
            help='Create a stacked branch that references the public location '
 
922
                'of the parent branch.'),
 
923
        Option('stacked-on',
 
924
            help='Create a stacked branch that refers to another branch '
 
925
                'for the commit history. Only the work not present in the '
 
926
                'referenced branch is included in the branch created.',
 
927
            type=unicode),
 
928
        ]
 
929
    takes_args = ['location?']
 
930
    encoding_type = 'replace'
 
931
 
 
932
    def run(self, location=None, remember=False, overwrite=False,
 
933
        create_prefix=False, verbose=False, revision=None,
 
934
        use_existing_dir=False, directory=None, stacked_on=None,
 
935
        stacked=False):
 
936
        from bzrlib.push import _show_push_branch
 
937
 
 
938
        # Get the source branch and revision_id
 
939
        if directory is None:
 
940
            directory = '.'
 
941
        br_from = Branch.open_containing(directory)[0]
 
942
        revision = _get_one_revision('push', revision)
 
943
        if revision is not None:
 
944
            revision_id = revision.in_history(br_from).rev_id
 
945
        else:
 
946
            revision_id = br_from.last_revision()
 
947
 
 
948
        # Get the stacked_on branch, if any
 
949
        if stacked_on is not None:
 
950
            stacked_on = urlutils.normalize_url(stacked_on)
 
951
        elif stacked:
 
952
            parent_url = br_from.get_parent()
 
953
            if parent_url:
 
954
                parent = Branch.open(parent_url)
 
955
                stacked_on = parent.get_public_branch()
 
956
                if not stacked_on:
 
957
                    # I considered excluding non-http url's here, thus forcing
 
958
                    # 'public' branches only, but that only works for some
 
959
                    # users, so it's best to just depend on the user spotting an
 
960
                    # error by the feedback given to them. RBC 20080227.
 
961
                    stacked_on = parent_url
 
962
            if not stacked_on:
 
963
                raise errors.BzrCommandError(
 
964
                    "Could not determine branch to refer to.")
 
965
 
 
966
        # Get the destination location
 
967
        if location is None:
 
968
            stored_loc = br_from.get_push_location()
 
969
            if stored_loc is None:
 
970
                raise errors.BzrCommandError(
 
971
                    "No push location known or specified.")
 
972
            else:
 
973
                display_url = urlutils.unescape_for_display(stored_loc,
 
974
                        self.outf.encoding)
 
975
                self.outf.write("Using saved push location: %s\n" % display_url)
 
976
                location = stored_loc
 
977
 
 
978
        _show_push_branch(br_from, revision_id, location, self.outf,
 
979
            verbose=verbose, overwrite=overwrite, remember=remember,
 
980
            stacked_on=stacked_on, create_prefix=create_prefix,
 
981
            use_existing_dir=use_existing_dir)
 
982
 
 
983
 
 
984
class cmd_branch(Command):
 
985
    """Create a new copy of a branch.
 
986
 
 
987
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
988
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
989
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
990
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
991
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
992
    create ./foo-bar.
 
993
 
 
994
    To retrieve the branch as of a particular revision, supply the --revision
 
995
    parameter, as in "branch foo/bar -r 5".
 
996
    """
 
997
 
 
998
    _see_also = ['checkout']
 
999
    takes_args = ['from_location', 'to_location?']
 
1000
    takes_options = ['revision', Option('hardlink',
 
1001
        help='Hard-link working tree files where possible.'),
 
1002
        Option('no-tree',
 
1003
            help="Create a branch without a working-tree."),
 
1004
        Option('stacked',
 
1005
            help='Create a stacked branch referring to the source branch. '
 
1006
                'The new branch will depend on the availability of the source '
 
1007
                'branch for all operations.'),
 
1008
        Option('standalone',
 
1009
               help='Do not use a shared repository, even if available.'),
 
1010
        ]
 
1011
    aliases = ['get', 'clone']
 
1012
 
 
1013
    def run(self, from_location, to_location=None, revision=None,
 
1014
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
1015
        from bzrlib.tag import _merge_tags_if_possible
 
1016
 
 
1017
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
1018
            from_location)
 
1019
        revision = _get_one_revision('branch', revision)
 
1020
        br_from.lock_read()
 
1021
        try:
 
1022
            if revision is not None:
 
1023
                revision_id = revision.as_revision_id(br_from)
 
1024
            else:
 
1025
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1026
                # None or perhaps NULL_REVISION to mean copy nothing
 
1027
                # RBC 20060209
 
1028
                revision_id = br_from.last_revision()
 
1029
            if to_location is None:
 
1030
                to_location = urlutils.derive_to_location(from_location)
 
1031
            to_transport = transport.get_transport(to_location)
 
1032
            try:
 
1033
                to_transport.mkdir('.')
 
1034
            except errors.FileExists:
 
1035
                raise errors.BzrCommandError('Target directory "%s" already'
 
1036
                                             ' exists.' % to_location)
 
1037
            except errors.NoSuchFile:
 
1038
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1039
                                             % to_location)
 
1040
            try:
 
1041
                # preserve whatever source format we have.
 
1042
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1043
                                            possible_transports=[to_transport],
 
1044
                                            accelerator_tree=accelerator_tree,
 
1045
                                            hardlink=hardlink, stacked=stacked,
 
1046
                                            force_new_repo=standalone,
 
1047
                                            create_tree_if_local=not no_tree,
 
1048
                                            source_branch=br_from)
 
1049
                branch = dir.open_branch()
 
1050
            except errors.NoSuchRevision:
 
1051
                to_transport.delete_tree('.')
 
1052
                msg = "The branch %s has no revision %s." % (from_location,
 
1053
                    revision)
 
1054
                raise errors.BzrCommandError(msg)
 
1055
            _merge_tags_if_possible(br_from, branch)
 
1056
            # If the source branch is stacked, the new branch may
 
1057
            # be stacked whether we asked for that explicitly or not.
 
1058
            # We therefore need a try/except here and not just 'if stacked:'
 
1059
            try:
 
1060
                note('Created new stacked branch referring to %s.' %
 
1061
                    branch.get_stacked_on_url())
 
1062
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1063
                errors.UnstackableRepositoryFormat), e:
 
1064
                note('Branched %d revision(s).' % branch.revno())
 
1065
        finally:
 
1066
            br_from.unlock()
 
1067
 
 
1068
 
 
1069
class cmd_checkout(Command):
 
1070
    """Create a new checkout of an existing branch.
 
1071
 
 
1072
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
1073
    the branch found in '.'. This is useful if you have removed the working tree
 
1074
    or if it was never created - i.e. if you pushed the branch to its current
 
1075
    location using SFTP.
 
1076
    
 
1077
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
1078
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
1079
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1080
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
1081
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
1082
    create ./foo-bar.
 
1083
 
 
1084
    To retrieve the branch as of a particular revision, supply the --revision
 
1085
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
1086
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
1087
    code.)
 
1088
    """
 
1089
 
 
1090
    _see_also = ['checkouts', 'branch']
 
1091
    takes_args = ['branch_location?', 'to_location?']
 
1092
    takes_options = ['revision',
 
1093
                     Option('lightweight',
 
1094
                            help="Perform a lightweight checkout.  Lightweight "
 
1095
                                 "checkouts depend on access to the branch for "
 
1096
                                 "every operation.  Normal checkouts can perform "
 
1097
                                 "common operations like diff and status without "
 
1098
                                 "such access, and also support local commits."
 
1099
                            ),
 
1100
                     Option('files-from', type=str,
 
1101
                            help="Get file contents from this tree."),
 
1102
                     Option('hardlink',
 
1103
                            help='Hard-link working tree files where possible.'
 
1104
                            ),
 
1105
                     ]
 
1106
    aliases = ['co']
 
1107
 
 
1108
    def run(self, branch_location=None, to_location=None, revision=None,
 
1109
            lightweight=False, files_from=None, hardlink=False):
 
1110
        if branch_location is None:
 
1111
            branch_location = osutils.getcwd()
 
1112
            to_location = branch_location
 
1113
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1114
            branch_location)
 
1115
        revision = _get_one_revision('checkout', revision)
 
1116
        if files_from is not None:
 
1117
            accelerator_tree = WorkingTree.open(files_from)
 
1118
        if revision is not None:
 
1119
            revision_id = revision.as_revision_id(source)
 
1120
        else:
 
1121
            revision_id = None
 
1122
        if to_location is None:
 
1123
            to_location = urlutils.derive_to_location(branch_location)
 
1124
        # if the source and to_location are the same, 
 
1125
        # and there is no working tree,
 
1126
        # then reconstitute a branch
 
1127
        if (osutils.abspath(to_location) ==
 
1128
            osutils.abspath(branch_location)):
 
1129
            try:
 
1130
                source.bzrdir.open_workingtree()
 
1131
            except errors.NoWorkingTree:
 
1132
                source.bzrdir.create_workingtree(revision_id)
 
1133
                return
 
1134
        source.create_checkout(to_location, revision_id, lightweight,
 
1135
                               accelerator_tree, hardlink)
 
1136
 
 
1137
 
 
1138
class cmd_renames(Command):
 
1139
    """Show list of renamed files.
 
1140
    """
 
1141
    # TODO: Option to show renames between two historical versions.
 
1142
 
 
1143
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1144
    _see_also = ['status']
 
1145
    takes_args = ['dir?']
 
1146
 
 
1147
    @display_command
 
1148
    def run(self, dir=u'.'):
 
1149
        tree = WorkingTree.open_containing(dir)[0]
 
1150
        tree.lock_read()
 
1151
        try:
 
1152
            new_inv = tree.inventory
 
1153
            old_tree = tree.basis_tree()
 
1154
            old_tree.lock_read()
 
1155
            try:
 
1156
                old_inv = old_tree.inventory
 
1157
                renames = []
 
1158
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1159
                for f, paths, c, v, p, n, k, e in iterator:
 
1160
                    if paths[0] == paths[1]:
 
1161
                        continue
 
1162
                    if None in (paths):
 
1163
                        continue
 
1164
                    renames.append(paths)
 
1165
                renames.sort()
 
1166
                for old_name, new_name in renames:
 
1167
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1168
            finally:
 
1169
                old_tree.unlock()
 
1170
        finally:
 
1171
            tree.unlock()
 
1172
 
 
1173
 
 
1174
class cmd_update(Command):
 
1175
    """Update a tree to have the latest code committed to its branch.
 
1176
    
 
1177
    This will perform a merge into the working tree, and may generate
 
1178
    conflicts. If you have any local changes, you will still 
 
1179
    need to commit them after the update for the update to be complete.
 
1180
    
 
1181
    If you want to discard your local changes, you can just do a 
 
1182
    'bzr revert' instead of 'bzr commit' after the update.
 
1183
    """
 
1184
 
 
1185
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1186
    takes_args = ['dir?']
 
1187
    aliases = ['up']
 
1188
 
 
1189
    def run(self, dir='.'):
 
1190
        tree = WorkingTree.open_containing(dir)[0]
 
1191
        possible_transports = []
 
1192
        master = tree.branch.get_master_branch(
 
1193
            possible_transports=possible_transports)
 
1194
        if master is not None:
 
1195
            tree.lock_write()
 
1196
        else:
 
1197
            tree.lock_tree_write()
 
1198
        try:
 
1199
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1200
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1201
            if last_rev == _mod_revision.ensure_null(
 
1202
                tree.branch.last_revision()):
 
1203
                # may be up to date, check master too.
 
1204
                if master is None or last_rev == _mod_revision.ensure_null(
 
1205
                    master.last_revision()):
 
1206
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1207
                    note("Tree is up to date at revision %d." % (revno,))
 
1208
                    return 0
 
1209
            conflicts = tree.update(
 
1210
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1211
                possible_transports=possible_transports)
 
1212
            revno = tree.branch.revision_id_to_revno(
 
1213
                _mod_revision.ensure_null(tree.last_revision()))
 
1214
            note('Updated to revision %d.' % (revno,))
 
1215
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1216
                note('Your local commits will now show as pending merges with '
 
1217
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1218
            if conflicts != 0:
 
1219
                return 1
 
1220
            else:
 
1221
                return 0
 
1222
        finally:
 
1223
            tree.unlock()
 
1224
 
 
1225
 
 
1226
class cmd_info(Command):
 
1227
    """Show information about a working tree, branch or repository.
 
1228
 
 
1229
    This command will show all known locations and formats associated to the
 
1230
    tree, branch or repository.  Statistical information is included with
 
1231
    each report.
 
1232
 
 
1233
    Branches and working trees will also report any missing revisions.
 
1234
    """
 
1235
    _see_also = ['revno', 'working-trees', 'repositories']
 
1236
    takes_args = ['location?']
 
1237
    takes_options = ['verbose']
 
1238
    encoding_type = 'replace'
 
1239
 
 
1240
    @display_command
 
1241
    def run(self, location=None, verbose=False):
 
1242
        if verbose:
 
1243
            noise_level = 2
 
1244
        else:
 
1245
            noise_level = 0
 
1246
        from bzrlib.info import show_bzrdir_info
 
1247
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1248
                         verbose=noise_level, outfile=self.outf)
 
1249
 
 
1250
 
 
1251
class cmd_remove(Command):
 
1252
    """Remove files or directories.
 
1253
 
 
1254
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1255
    them if they can easily be recovered using revert. If no options or
 
1256
    parameters are given bzr will scan for files that are being tracked by bzr
 
1257
    but missing in your tree and stop tracking them for you.
 
1258
    """
 
1259
    takes_args = ['file*']
 
1260
    takes_options = ['verbose',
 
1261
        Option('new', help='Only remove files that have never been committed.'),
 
1262
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1263
            'The file deletion mode to be used.',
 
1264
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1265
            safe='Only delete files if they can be'
 
1266
                 ' safely recovered (default).',
 
1267
            keep="Don't delete any files.",
 
1268
            force='Delete all the specified files, even if they can not be '
 
1269
                'recovered and even if they are non-empty directories.')]
 
1270
    aliases = ['rm', 'del']
 
1271
    encoding_type = 'replace'
 
1272
 
 
1273
    def run(self, file_list, verbose=False, new=False,
 
1274
        file_deletion_strategy='safe'):
 
1275
        tree, file_list = tree_files(file_list)
 
1276
 
 
1277
        if file_list is not None:
 
1278
            file_list = [f for f in file_list]
 
1279
 
 
1280
        tree.lock_write()
 
1281
        try:
 
1282
            # Heuristics should probably all move into tree.remove_smart or
 
1283
            # some such?
 
1284
            if new:
 
1285
                added = tree.changes_from(tree.basis_tree(),
 
1286
                    specific_files=file_list).added
 
1287
                file_list = sorted([f[0] for f in added], reverse=True)
 
1288
                if len(file_list) == 0:
 
1289
                    raise errors.BzrCommandError('No matching files.')
 
1290
            elif file_list is None:
 
1291
                # missing files show up in iter_changes(basis) as
 
1292
                # versioned-with-no-kind.
 
1293
                missing = []
 
1294
                for change in tree.iter_changes(tree.basis_tree()):
 
1295
                    # Find paths in the working tree that have no kind:
 
1296
                    if change[1][1] is not None and change[6][1] is None:
 
1297
                        missing.append(change[1][1])
 
1298
                file_list = sorted(missing, reverse=True)
 
1299
                file_deletion_strategy = 'keep'
 
1300
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1301
                keep_files=file_deletion_strategy=='keep',
 
1302
                force=file_deletion_strategy=='force')
 
1303
        finally:
 
1304
            tree.unlock()
 
1305
 
 
1306
 
 
1307
class cmd_file_id(Command):
 
1308
    """Print file_id of a particular file or directory.
 
1309
 
 
1310
    The file_id is assigned when the file is first added and remains the
 
1311
    same through all revisions where the file exists, even when it is
 
1312
    moved or renamed.
 
1313
    """
 
1314
 
 
1315
    hidden = True
 
1316
    _see_also = ['inventory', 'ls']
 
1317
    takes_args = ['filename']
 
1318
 
 
1319
    @display_command
 
1320
    def run(self, filename):
 
1321
        tree, relpath = WorkingTree.open_containing(filename)
 
1322
        i = tree.path2id(relpath)
 
1323
        if i is None:
 
1324
            raise errors.NotVersionedError(filename)
 
1325
        else:
 
1326
            self.outf.write(i + '\n')
 
1327
 
 
1328
 
 
1329
class cmd_file_path(Command):
 
1330
    """Print path of file_ids to a file or directory.
 
1331
 
 
1332
    This prints one line for each directory down to the target,
 
1333
    starting at the branch root.
 
1334
    """
 
1335
 
 
1336
    hidden = True
 
1337
    takes_args = ['filename']
 
1338
 
 
1339
    @display_command
 
1340
    def run(self, filename):
 
1341
        tree, relpath = WorkingTree.open_containing(filename)
 
1342
        fid = tree.path2id(relpath)
 
1343
        if fid is None:
 
1344
            raise errors.NotVersionedError(filename)
 
1345
        segments = osutils.splitpath(relpath)
 
1346
        for pos in range(1, len(segments) + 1):
 
1347
            path = osutils.joinpath(segments[:pos])
 
1348
            self.outf.write("%s\n" % tree.path2id(path))
 
1349
 
 
1350
 
 
1351
class cmd_reconcile(Command):
 
1352
    """Reconcile bzr metadata in a branch.
 
1353
 
 
1354
    This can correct data mismatches that may have been caused by
 
1355
    previous ghost operations or bzr upgrades. You should only
 
1356
    need to run this command if 'bzr check' or a bzr developer 
 
1357
    advises you to run it.
 
1358
 
 
1359
    If a second branch is provided, cross-branch reconciliation is
 
1360
    also attempted, which will check that data like the tree root
 
1361
    id which was not present in very early bzr versions is represented
 
1362
    correctly in both branches.
 
1363
 
 
1364
    At the same time it is run it may recompress data resulting in 
 
1365
    a potential saving in disk space or performance gain.
 
1366
 
 
1367
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1368
    """
 
1369
 
 
1370
    _see_also = ['check']
 
1371
    takes_args = ['branch?']
 
1372
 
 
1373
    def run(self, branch="."):
 
1374
        from bzrlib.reconcile import reconcile
 
1375
        dir = bzrdir.BzrDir.open(branch)
 
1376
        reconcile(dir)
 
1377
 
 
1378
 
 
1379
class cmd_revision_history(Command):
 
1380
    """Display the list of revision ids on a branch."""
 
1381
 
 
1382
    _see_also = ['log']
 
1383
    takes_args = ['location?']
 
1384
 
 
1385
    hidden = True
 
1386
 
 
1387
    @display_command
 
1388
    def run(self, location="."):
 
1389
        branch = Branch.open_containing(location)[0]
 
1390
        for revid in branch.revision_history():
 
1391
            self.outf.write(revid)
 
1392
            self.outf.write('\n')
 
1393
 
 
1394
 
 
1395
class cmd_ancestry(Command):
 
1396
    """List all revisions merged into this branch."""
 
1397
 
 
1398
    _see_also = ['log', 'revision-history']
 
1399
    takes_args = ['location?']
 
1400
 
 
1401
    hidden = True
 
1402
 
 
1403
    @display_command
 
1404
    def run(self, location="."):
 
1405
        try:
 
1406
            wt = WorkingTree.open_containing(location)[0]
 
1407
        except errors.NoWorkingTree:
 
1408
            b = Branch.open(location)
 
1409
            last_revision = b.last_revision()
 
1410
        else:
 
1411
            b = wt.branch
 
1412
            last_revision = wt.last_revision()
 
1413
 
 
1414
        revision_ids = b.repository.get_ancestry(last_revision)
 
1415
        revision_ids.pop(0)
 
1416
        for revision_id in revision_ids:
 
1417
            self.outf.write(revision_id + '\n')
 
1418
 
 
1419
 
 
1420
class cmd_init(Command):
 
1421
    """Make a directory into a versioned branch.
 
1422
 
 
1423
    Use this to create an empty branch, or before importing an
 
1424
    existing project.
 
1425
 
 
1426
    If there is a repository in a parent directory of the location, then 
 
1427
    the history of the branch will be stored in the repository.  Otherwise
 
1428
    init creates a standalone branch which carries its own history
 
1429
    in the .bzr directory.
 
1430
 
 
1431
    If there is already a branch at the location but it has no working tree,
 
1432
    the tree can be populated with 'bzr checkout'.
 
1433
 
 
1434
    Recipe for importing a tree of files::
 
1435
 
 
1436
        cd ~/project
 
1437
        bzr init
 
1438
        bzr add .
 
1439
        bzr status
 
1440
        bzr commit -m "imported project"
 
1441
    """
 
1442
 
 
1443
    _see_also = ['init-repository', 'branch', 'checkout']
 
1444
    takes_args = ['location?']
 
1445
    takes_options = [
 
1446
        Option('create-prefix',
 
1447
               help='Create the path leading up to the branch '
 
1448
                    'if it does not already exist.'),
 
1449
         RegistryOption('format',
 
1450
                help='Specify a format for this branch. '
 
1451
                'See "help formats".',
 
1452
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1453
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1454
                value_switches=True,
 
1455
                title="Branch Format",
 
1456
                ),
 
1457
         Option('append-revisions-only',
 
1458
                help='Never change revnos or the existing log.'
 
1459
                '  Append revisions to it only.')
 
1460
         ]
 
1461
    def run(self, location=None, format=None, append_revisions_only=False,
 
1462
            create_prefix=False):
 
1463
        if format is None:
 
1464
            format = bzrdir.format_registry.make_bzrdir('default')
 
1465
        if location is None:
 
1466
            location = u'.'
 
1467
 
 
1468
        to_transport = transport.get_transport(location)
 
1469
 
 
1470
        # The path has to exist to initialize a
 
1471
        # branch inside of it.
 
1472
        # Just using os.mkdir, since I don't
 
1473
        # believe that we want to create a bunch of
 
1474
        # locations if the user supplies an extended path
 
1475
        try:
 
1476
            to_transport.ensure_base()
 
1477
        except errors.NoSuchFile:
 
1478
            if not create_prefix:
 
1479
                raise errors.BzrCommandError("Parent directory of %s"
 
1480
                    " does not exist."
 
1481
                    "\nYou may supply --create-prefix to create all"
 
1482
                    " leading parent directories."
 
1483
                    % location)
 
1484
            _create_prefix(to_transport)
 
1485
 
 
1486
        try:
 
1487
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1488
        except errors.NotBranchError:
 
1489
            # really a NotBzrDir error...
 
1490
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1491
            branch = create_branch(to_transport.base, format=format,
 
1492
                                   possible_transports=[to_transport])
 
1493
            a_bzrdir = branch.bzrdir
 
1494
        else:
 
1495
            from bzrlib.transport.local import LocalTransport
 
1496
            if a_bzrdir.has_branch():
 
1497
                if (isinstance(to_transport, LocalTransport)
 
1498
                    and not a_bzrdir.has_workingtree()):
 
1499
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1500
                raise errors.AlreadyBranchError(location)
 
1501
            branch = a_bzrdir.create_branch()
 
1502
            a_bzrdir.create_workingtree()
 
1503
        if append_revisions_only:
 
1504
            try:
 
1505
                branch.set_append_revisions_only(True)
 
1506
            except errors.UpgradeRequired:
 
1507
                raise errors.BzrCommandError('This branch format cannot be set'
 
1508
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1509
        if not is_quiet():
 
1510
            from bzrlib.info import describe_layout, describe_format
 
1511
            try:
 
1512
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
1513
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1514
                tree = None
 
1515
            repository = branch.repository
 
1516
            layout = describe_layout(repository, branch, tree).lower()
 
1517
            format = describe_format(a_bzrdir, repository, branch, tree)
 
1518
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
 
1519
            if repository.is_shared():
 
1520
                #XXX: maybe this can be refactored into transport.path_or_url()
 
1521
                url = repository.bzrdir.root_transport.external_url()
 
1522
                try:
 
1523
                    url = urlutils.local_path_from_url(url)
 
1524
                except errors.InvalidURL:
 
1525
                    pass
 
1526
                self.outf.write("Using shared repository: %s\n" % url)
 
1527
 
 
1528
 
 
1529
class cmd_init_repository(Command):
 
1530
    """Create a shared repository to hold branches.
 
1531
 
 
1532
    New branches created under the repository directory will store their
 
1533
    revisions in the repository, not in the branch directory.
 
1534
 
 
1535
    If the --no-trees option is used then the branches in the repository
 
1536
    will not have working trees by default.
 
1537
 
 
1538
    :Examples:
 
1539
        Create a shared repositories holding just branches::
 
1540
 
 
1541
            bzr init-repo --no-trees repo
 
1542
            bzr init repo/trunk
 
1543
 
 
1544
        Make a lightweight checkout elsewhere::
 
1545
 
 
1546
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1547
            cd trunk-checkout
 
1548
            (add files here)
 
1549
    """
 
1550
 
 
1551
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1552
    takes_args = ["location"]
 
1553
    takes_options = [RegistryOption('format',
 
1554
                            help='Specify a format for this repository. See'
 
1555
                                 ' "bzr help formats" for details.',
 
1556
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1557
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1558
                            value_switches=True, title='Repository format'),
 
1559
                     Option('no-trees',
 
1560
                             help='Branches in the repository will default to'
 
1561
                                  ' not having a working tree.'),
 
1562
                    ]
 
1563
    aliases = ["init-repo"]
 
1564
 
 
1565
    def run(self, location, format=None, no_trees=False):
 
1566
        if format is None:
 
1567
            format = bzrdir.format_registry.make_bzrdir('default')
 
1568
 
 
1569
        if location is None:
 
1570
            location = '.'
 
1571
 
 
1572
        to_transport = transport.get_transport(location)
 
1573
        to_transport.ensure_base()
 
1574
 
 
1575
        newdir = format.initialize_on_transport(to_transport)
 
1576
        repo = newdir.create_repository(shared=True)
 
1577
        repo.set_make_working_trees(not no_trees)
 
1578
        if not is_quiet():
 
1579
            from bzrlib.info import show_bzrdir_info
 
1580
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
 
1581
 
 
1582
 
 
1583
class cmd_diff(Command):
 
1584
    """Show differences in the working tree, between revisions or branches.
 
1585
    
 
1586
    If no arguments are given, all changes for the current tree are listed.
 
1587
    If files are given, only the changes in those files are listed.
 
1588
    Remote and multiple branches can be compared by using the --old and
 
1589
    --new options. If not provided, the default for both is derived from
 
1590
    the first argument, if any, or the current tree if no arguments are
 
1591
    given.
 
1592
 
 
1593
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1594
    produces patches suitable for "patch -p1".
 
1595
 
 
1596
    :Exit values:
 
1597
        1 - changed
 
1598
        2 - unrepresentable changes
 
1599
        3 - error
 
1600
        0 - no change
 
1601
 
 
1602
    :Examples:
 
1603
        Shows the difference in the working tree versus the last commit::
 
1604
 
 
1605
            bzr diff
 
1606
 
 
1607
        Difference between the working tree and revision 1::
 
1608
 
 
1609
            bzr diff -r1
 
1610
 
 
1611
        Difference between revision 2 and revision 1::
 
1612
 
 
1613
            bzr diff -r1..2
 
1614
 
 
1615
        Difference between revision 2 and revision 1 for branch xxx::
 
1616
 
 
1617
            bzr diff -r1..2 xxx
 
1618
 
 
1619
        Show just the differences for file NEWS::
 
1620
 
 
1621
            bzr diff NEWS
 
1622
 
 
1623
        Show the differences in working tree xxx for file NEWS::
 
1624
 
 
1625
            bzr diff xxx/NEWS
 
1626
 
 
1627
        Show the differences from branch xxx to this working tree:
 
1628
 
 
1629
            bzr diff --old xxx
 
1630
 
 
1631
        Show the differences between two branches for file NEWS::
 
1632
 
 
1633
            bzr diff --old xxx --new yyy NEWS
 
1634
 
 
1635
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1636
 
 
1637
            bzr diff --prefix old/:new/
 
1638
    """
 
1639
    _see_also = ['status']
 
1640
    takes_args = ['file*']
 
1641
    takes_options = [
 
1642
        Option('diff-options', type=str,
 
1643
               help='Pass these options to the external diff program.'),
 
1644
        Option('prefix', type=str,
 
1645
               short_name='p',
 
1646
               help='Set prefixes added to old and new filenames, as '
 
1647
                    'two values separated by a colon. (eg "old/:new/").'),
 
1648
        Option('old',
 
1649
            help='Branch/tree to compare from.',
 
1650
            type=unicode,
 
1651
            ),
 
1652
        Option('new',
 
1653
            help='Branch/tree to compare to.',
 
1654
            type=unicode,
 
1655
            ),
 
1656
        'revision',
 
1657
        'change',
 
1658
        Option('using',
 
1659
            help='Use this command to compare files.',
 
1660
            type=unicode,
 
1661
            ),
 
1662
        ]
 
1663
    aliases = ['di', 'dif']
 
1664
    encoding_type = 'exact'
 
1665
 
 
1666
    @display_command
 
1667
    def run(self, revision=None, file_list=None, diff_options=None,
 
1668
            prefix=None, old=None, new=None, using=None):
 
1669
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1670
 
 
1671
        if (prefix is None) or (prefix == '0'):
 
1672
            # diff -p0 format
 
1673
            old_label = ''
 
1674
            new_label = ''
 
1675
        elif prefix == '1':
 
1676
            old_label = 'old/'
 
1677
            new_label = 'new/'
 
1678
        elif ':' in prefix:
 
1679
            old_label, new_label = prefix.split(":")
 
1680
        else:
 
1681
            raise errors.BzrCommandError(
 
1682
                '--prefix expects two values separated by a colon'
 
1683
                ' (eg "old/:new/")')
 
1684
 
 
1685
        if revision and len(revision) > 2:
 
1686
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1687
                                         ' one or two revision specifiers')
 
1688
 
 
1689
        old_tree, new_tree, specific_files, extra_trees = \
 
1690
                _get_trees_to_diff(file_list, revision, old, new)
 
1691
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1692
                               specific_files=specific_files,
 
1693
                               external_diff_options=diff_options,
 
1694
                               old_label=old_label, new_label=new_label,
 
1695
                               extra_trees=extra_trees, using=using)
 
1696
 
 
1697
 
 
1698
class cmd_deleted(Command):
 
1699
    """List files deleted in the working tree.
 
1700
    """
 
1701
    # TODO: Show files deleted since a previous revision, or
 
1702
    # between two revisions.
 
1703
    # TODO: Much more efficient way to do this: read in new
 
1704
    # directories with readdir, rather than stating each one.  Same
 
1705
    # level of effort but possibly much less IO.  (Or possibly not,
 
1706
    # if the directories are very large...)
 
1707
    _see_also = ['status', 'ls']
 
1708
    takes_options = ['show-ids']
 
1709
 
 
1710
    @display_command
 
1711
    def run(self, show_ids=False):
 
1712
        tree = WorkingTree.open_containing(u'.')[0]
 
1713
        tree.lock_read()
 
1714
        try:
 
1715
            old = tree.basis_tree()
 
1716
            old.lock_read()
 
1717
            try:
 
1718
                for path, ie in old.inventory.iter_entries():
 
1719
                    if not tree.has_id(ie.file_id):
 
1720
                        self.outf.write(path)
 
1721
                        if show_ids:
 
1722
                            self.outf.write(' ')
 
1723
                            self.outf.write(ie.file_id)
 
1724
                        self.outf.write('\n')
 
1725
            finally:
 
1726
                old.unlock()
 
1727
        finally:
 
1728
            tree.unlock()
 
1729
 
 
1730
 
 
1731
class cmd_modified(Command):
 
1732
    """List files modified in working tree.
 
1733
    """
 
1734
 
 
1735
    hidden = True
 
1736
    _see_also = ['status', 'ls']
 
1737
    takes_options = [
 
1738
            Option('null',
 
1739
                   help='Write an ascii NUL (\\0) separator '
 
1740
                   'between files rather than a newline.')
 
1741
            ]
 
1742
 
 
1743
    @display_command
 
1744
    def run(self, null=False):
 
1745
        tree = WorkingTree.open_containing(u'.')[0]
 
1746
        td = tree.changes_from(tree.basis_tree())
 
1747
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1748
            if null:
 
1749
                self.outf.write(path + '\0')
 
1750
            else:
 
1751
                self.outf.write(osutils.quotefn(path) + '\n')
 
1752
 
 
1753
 
 
1754
class cmd_added(Command):
 
1755
    """List files added in working tree.
 
1756
    """
 
1757
 
 
1758
    hidden = True
 
1759
    _see_also = ['status', 'ls']
 
1760
    takes_options = [
 
1761
            Option('null',
 
1762
                   help='Write an ascii NUL (\\0) separator '
 
1763
                   'between files rather than a newline.')
 
1764
            ]
 
1765
 
 
1766
    @display_command
 
1767
    def run(self, null=False):
 
1768
        wt = WorkingTree.open_containing(u'.')[0]
 
1769
        wt.lock_read()
 
1770
        try:
 
1771
            basis = wt.basis_tree()
 
1772
            basis.lock_read()
 
1773
            try:
 
1774
                basis_inv = basis.inventory
 
1775
                inv = wt.inventory
 
1776
                for file_id in inv:
 
1777
                    if file_id in basis_inv:
 
1778
                        continue
 
1779
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1780
                        continue
 
1781
                    path = inv.id2path(file_id)
 
1782
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1783
                        continue
 
1784
                    if null:
 
1785
                        self.outf.write(path + '\0')
 
1786
                    else:
 
1787
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1788
            finally:
 
1789
                basis.unlock()
 
1790
        finally:
 
1791
            wt.unlock()
 
1792
 
 
1793
 
 
1794
class cmd_root(Command):
 
1795
    """Show the tree root directory.
 
1796
 
 
1797
    The root is the nearest enclosing directory with a .bzr control
 
1798
    directory."""
 
1799
 
 
1800
    takes_args = ['filename?']
 
1801
    @display_command
 
1802
    def run(self, filename=None):
 
1803
        """Print the branch root."""
 
1804
        tree = WorkingTree.open_containing(filename)[0]
 
1805
        self.outf.write(tree.basedir + '\n')
 
1806
 
 
1807
 
 
1808
def _parse_limit(limitstring):
 
1809
    try:
 
1810
        return int(limitstring)
 
1811
    except ValueError:
 
1812
        msg = "The limit argument must be an integer."
 
1813
        raise errors.BzrCommandError(msg)
 
1814
 
 
1815
 
 
1816
def _parse_levels(s):
 
1817
    try:
 
1818
        return int(s)
 
1819
    except ValueError:
 
1820
        msg = "The levels argument must be an integer."
 
1821
        raise errors.BzrCommandError(msg)
 
1822
 
 
1823
 
 
1824
class cmd_log(Command):
 
1825
    """Show log of a branch, file, or directory.
 
1826
 
 
1827
    By default show the log of the branch containing the working directory.
 
1828
 
 
1829
    To request a range of logs, you can use the command -r begin..end
 
1830
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1831
    also valid.
 
1832
 
 
1833
    :Examples:
 
1834
        Log the current branch::
 
1835
 
 
1836
            bzr log
 
1837
 
 
1838
        Log a file::
 
1839
 
 
1840
            bzr log foo.c
 
1841
 
 
1842
        Log the last 10 revisions of a branch::
 
1843
 
 
1844
            bzr log -r -10.. http://server/branch
 
1845
    """
 
1846
 
 
1847
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1848
 
 
1849
    takes_args = ['location?']
 
1850
    takes_options = [
 
1851
            Option('forward',
 
1852
                   help='Show from oldest to newest.'),
 
1853
            'timezone',
 
1854
            custom_help('verbose',
 
1855
                   help='Show files changed in each revision.'),
 
1856
            'show-ids',
 
1857
            'revision',
 
1858
            Option('change',
 
1859
                   type=bzrlib.option._parse_revision_str,
 
1860
                   short_name='c',
 
1861
                   help='Show just the specified revision.'
 
1862
                   ' See also "help revisionspec".'),
 
1863
            'log-format',
 
1864
            Option('levels',
 
1865
                   short_name='n',
 
1866
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
1867
                   argname='N',
 
1868
                   type=_parse_levels),
 
1869
            Option('message',
 
1870
                   short_name='m',
 
1871
                   help='Show revisions whose message matches this '
 
1872
                        'regular expression.',
 
1873
                   type=str),
 
1874
            Option('limit',
 
1875
                   short_name='l',
 
1876
                   help='Limit the output to the first N revisions.',
 
1877
                   argname='N',
 
1878
                   type=_parse_limit),
 
1879
            Option('show-diff',
 
1880
                   short_name='p',
 
1881
                   help='Show changes made in each revision as a patch.'),
 
1882
            ]
 
1883
    encoding_type = 'replace'
 
1884
 
 
1885
    @display_command
 
1886
    def run(self, location=None, timezone='original',
 
1887
            verbose=False,
 
1888
            show_ids=False,
 
1889
            forward=False,
 
1890
            revision=None,
 
1891
            change=None,
 
1892
            log_format=None,
 
1893
            levels=None,
 
1894
            message=None,
 
1895
            limit=None,
 
1896
            show_diff=False):
 
1897
        from bzrlib.log import show_log, _get_fileid_to_log
 
1898
        direction = (forward and 'forward') or 'reverse'
 
1899
 
 
1900
        if change is not None:
 
1901
            if len(change) > 1:
 
1902
                raise errors.RangeInChangeOption()
 
1903
            if revision is not None:
 
1904
                raise errors.BzrCommandError(
 
1905
                    '--revision and --change are mutually exclusive')
 
1906
            else:
 
1907
                revision = change
 
1908
 
 
1909
        # log everything
 
1910
        file_id = None
 
1911
        if location:
 
1912
            # find the file id to log:
 
1913
 
 
1914
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1915
                location)
 
1916
            if fp != '':
 
1917
                file_id = _get_fileid_to_log(revision, tree, b, fp)
 
1918
                if file_id is None:
 
1919
                    raise errors.BzrCommandError(
 
1920
                        "Path unknown at end or start of revision range: %s" %
 
1921
                        location)
 
1922
        else:
 
1923
            # local dir only
 
1924
            # FIXME ? log the current subdir only RBC 20060203 
 
1925
            if revision is not None \
 
1926
                    and len(revision) > 0 and revision[0].get_branch():
 
1927
                location = revision[0].get_branch()
 
1928
            else:
 
1929
                location = '.'
 
1930
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1931
            b = dir.open_branch()
 
1932
 
 
1933
        b.lock_read()
 
1934
        try:
 
1935
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
1936
            if log_format is None:
 
1937
                log_format = log.log_formatter_registry.get_default(b)
 
1938
 
 
1939
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1940
                            show_timezone=timezone,
 
1941
                            delta_format=get_verbosity_level(),
 
1942
                            levels=levels)
 
1943
 
 
1944
            show_log(b,
 
1945
                     lf,
 
1946
                     file_id,
 
1947
                     verbose=verbose,
 
1948
                     direction=direction,
 
1949
                     start_revision=rev1,
 
1950
                     end_revision=rev2,
 
1951
                     search=message,
 
1952
                     limit=limit,
 
1953
                     show_diff=show_diff)
 
1954
        finally:
 
1955
            b.unlock()
 
1956
 
 
1957
 
 
1958
def _get_revision_range(revisionspec_list, branch, command_name):
 
1959
    """Take the input of a revision option and turn it into a revision range.
 
1960
 
 
1961
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
1962
    of the desired revisons. It does some user input validations.
 
1963
    """
 
1964
    if revisionspec_list is None:
 
1965
        rev1 = None
 
1966
        rev2 = None
 
1967
    elif len(revisionspec_list) == 1:
 
1968
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
1969
    elif len(revisionspec_list) == 2:
 
1970
        start_spec = revisionspec_list[0]
 
1971
        end_spec = revisionspec_list[1]
 
1972
        if end_spec.get_branch() != start_spec.get_branch():
 
1973
            # b is taken from revision[0].get_branch(), and
 
1974
            # show_log will use its revision_history. Having
 
1975
            # different branches will lead to weird behaviors.
 
1976
            raise errors.BzrCommandError(
 
1977
                "bzr %s doesn't accept two revisions in different"
 
1978
                " branches." % command_name)
 
1979
        rev1 = start_spec.in_history(branch)
 
1980
        # Avoid loading all of history when we know a missing
 
1981
        # end of range means the last revision ...
 
1982
        if end_spec.spec is None:
 
1983
            last_revno, last_revision_id = branch.last_revision_info()
 
1984
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
1985
        else:
 
1986
            rev2 = end_spec.in_history(branch)
 
1987
    else:
 
1988
        raise errors.BzrCommandError(
 
1989
            'bzr %s --revision takes one or two values.' % command_name)
 
1990
    return rev1, rev2
 
1991
 
 
1992
 
 
1993
def _revision_range_to_revid_range(revision_range):
 
1994
    rev_id1 = None
 
1995
    rev_id2 = None
 
1996
    if revision_range[0] is not None:
 
1997
        rev_id1 = revision_range[0].rev_id
 
1998
    if revision_range[1] is not None:
 
1999
        rev_id2 = revision_range[1].rev_id
 
2000
    return rev_id1, rev_id2
 
2001
 
 
2002
def get_log_format(long=False, short=False, line=False, default='long'):
 
2003
    log_format = default
 
2004
    if long:
 
2005
        log_format = 'long'
 
2006
    if short:
 
2007
        log_format = 'short'
 
2008
    if line:
 
2009
        log_format = 'line'
 
2010
    return log_format
 
2011
 
 
2012
 
 
2013
class cmd_touching_revisions(Command):
 
2014
    """Return revision-ids which affected a particular file.
 
2015
 
 
2016
    A more user-friendly interface is "bzr log FILE".
 
2017
    """
 
2018
 
 
2019
    hidden = True
 
2020
    takes_args = ["filename"]
 
2021
 
 
2022
    @display_command
 
2023
    def run(self, filename):
 
2024
        tree, relpath = WorkingTree.open_containing(filename)
 
2025
        b = tree.branch
 
2026
        file_id = tree.path2id(relpath)
 
2027
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2028
            self.outf.write("%6d %s\n" % (revno, what))
 
2029
 
 
2030
 
 
2031
class cmd_ls(Command):
 
2032
    """List files in a tree.
 
2033
    """
 
2034
 
 
2035
    _see_also = ['status', 'cat']
 
2036
    takes_args = ['path?']
 
2037
    # TODO: Take a revision or remote path and list that tree instead.
 
2038
    takes_options = [
 
2039
            'verbose',
 
2040
            'revision',
 
2041
            Option('non-recursive',
 
2042
                   help='Don\'t recurse into subdirectories.'),
 
2043
            Option('from-root',
 
2044
                   help='Print paths relative to the root of the branch.'),
 
2045
            Option('unknown', help='Print unknown files.'),
 
2046
            Option('versioned', help='Print versioned files.',
 
2047
                   short_name='V'),
 
2048
            Option('ignored', help='Print ignored files.'),
 
2049
            Option('null',
 
2050
                   help='Write an ascii NUL (\\0) separator '
 
2051
                   'between files rather than a newline.'),
 
2052
            Option('kind',
 
2053
                   help='List entries of a particular kind: file, directory, symlink.',
 
2054
                   type=unicode),
 
2055
            'show-ids',
 
2056
            ]
 
2057
    @display_command
 
2058
    def run(self, revision=None, verbose=False,
 
2059
            non_recursive=False, from_root=False,
 
2060
            unknown=False, versioned=False, ignored=False,
 
2061
            null=False, kind=None, show_ids=False, path=None):
 
2062
 
 
2063
        if kind and kind not in ('file', 'directory', 'symlink'):
 
2064
            raise errors.BzrCommandError('invalid kind specified')
 
2065
 
 
2066
        if verbose and null:
 
2067
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2068
        all = not (unknown or versioned or ignored)
 
2069
 
 
2070
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
2071
 
 
2072
        if path is None:
 
2073
            fs_path = '.'
 
2074
            prefix = ''
 
2075
        else:
 
2076
            if from_root:
 
2077
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2078
                                             ' and PATH')
 
2079
            fs_path = path
 
2080
            prefix = path
 
2081
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2082
            fs_path)
 
2083
        if from_root:
 
2084
            relpath = u''
 
2085
        elif relpath:
 
2086
            relpath += '/'
 
2087
        if revision is not None or tree is None:
 
2088
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
2089
 
 
2090
        tree.lock_read()
 
2091
        try:
 
2092
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2093
                if fp.startswith(relpath):
 
2094
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2095
                    if non_recursive and '/' in fp:
 
2096
                        continue
 
2097
                    if not all and not selection[fc]:
 
2098
                        continue
 
2099
                    if kind is not None and fkind != kind:
 
2100
                        continue
 
2101
                    kindch = entry.kind_character()
 
2102
                    outstring = fp + kindch
 
2103
                    if verbose:
 
2104
                        outstring = '%-8s %s' % (fc, outstring)
 
2105
                        if show_ids and fid is not None:
 
2106
                            outstring = "%-50s %s" % (outstring, fid)
 
2107
                        self.outf.write(outstring + '\n')
 
2108
                    elif null:
 
2109
                        self.outf.write(fp + '\0')
 
2110
                        if show_ids:
 
2111
                            if fid is not None:
 
2112
                                self.outf.write(fid)
 
2113
                            self.outf.write('\0')
 
2114
                        self.outf.flush()
 
2115
                    else:
 
2116
                        if fid is not None:
 
2117
                            my_id = fid
 
2118
                        else:
 
2119
                            my_id = ''
 
2120
                        if show_ids:
 
2121
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2122
                        else:
 
2123
                            self.outf.write(outstring + '\n')
 
2124
        finally:
 
2125
            tree.unlock()
 
2126
 
 
2127
 
 
2128
class cmd_unknowns(Command):
 
2129
    """List unknown files.
 
2130
    """
 
2131
 
 
2132
    hidden = True
 
2133
    _see_also = ['ls']
 
2134
 
 
2135
    @display_command
 
2136
    def run(self):
 
2137
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2138
            self.outf.write(osutils.quotefn(f) + '\n')
 
2139
 
 
2140
 
 
2141
class cmd_ignore(Command):
 
2142
    """Ignore specified files or patterns.
 
2143
 
 
2144
    See ``bzr help patterns`` for details on the syntax of patterns.
 
2145
 
 
2146
    To remove patterns from the ignore list, edit the .bzrignore file.
 
2147
    After adding, editing or deleting that file either indirectly by
 
2148
    using this command or directly by using an editor, be sure to commit
 
2149
    it.
 
2150
 
 
2151
    Note: ignore patterns containing shell wildcards must be quoted from 
 
2152
    the shell on Unix.
 
2153
 
 
2154
    :Examples:
 
2155
        Ignore the top level Makefile::
 
2156
 
 
2157
            bzr ignore ./Makefile
 
2158
 
 
2159
        Ignore class files in all directories::
 
2160
 
 
2161
            bzr ignore "*.class"
 
2162
 
 
2163
        Ignore .o files under the lib directory::
 
2164
 
 
2165
            bzr ignore "lib/**/*.o"
 
2166
 
 
2167
        Ignore .o files under the lib directory::
 
2168
 
 
2169
            bzr ignore "RE:lib/.*\.o"
 
2170
 
 
2171
        Ignore everything but the "debian" toplevel directory::
 
2172
 
 
2173
            bzr ignore "RE:(?!debian/).*"
 
2174
    """
 
2175
 
 
2176
    _see_also = ['status', 'ignored', 'patterns']
 
2177
    takes_args = ['name_pattern*']
 
2178
    takes_options = [
 
2179
        Option('old-default-rules',
 
2180
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2181
        ]
 
2182
    
 
2183
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2184
        from bzrlib import ignores
 
2185
        if old_default_rules is not None:
 
2186
            # dump the rules and exit
 
2187
            for pattern in ignores.OLD_DEFAULTS:
 
2188
                print pattern
 
2189
            return
 
2190
        if not name_pattern_list:
 
2191
            raise errors.BzrCommandError("ignore requires at least one "
 
2192
                                  "NAME_PATTERN or --old-default-rules")
 
2193
        name_pattern_list = [globbing.normalize_pattern(p) 
 
2194
                             for p in name_pattern_list]
 
2195
        for name_pattern in name_pattern_list:
 
2196
            if (name_pattern[0] == '/' or 
 
2197
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2198
                raise errors.BzrCommandError(
 
2199
                    "NAME_PATTERN should not be an absolute path")
 
2200
        tree, relpath = WorkingTree.open_containing(u'.')
 
2201
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
2202
        ignored = globbing.Globster(name_pattern_list)
 
2203
        matches = []
 
2204
        tree.lock_read()
 
2205
        for entry in tree.list_files():
 
2206
            id = entry[3]
 
2207
            if id is not None:
 
2208
                filename = entry[0]
 
2209
                if ignored.match(filename):
 
2210
                    matches.append(filename.encode('utf-8'))
 
2211
        tree.unlock()
 
2212
        if len(matches) > 0:
 
2213
            print "Warning: the following files are version controlled and" \
 
2214
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
2215
 
 
2216
 
 
2217
class cmd_ignored(Command):
 
2218
    """List ignored files and the patterns that matched them.
 
2219
 
 
2220
    List all the ignored files and the ignore pattern that caused the file to
 
2221
    be ignored.
 
2222
 
 
2223
    Alternatively, to list just the files::
 
2224
 
 
2225
        bzr ls --ignored
 
2226
    """
 
2227
 
 
2228
    encoding_type = 'replace'
 
2229
    _see_also = ['ignore', 'ls']
 
2230
 
 
2231
    @display_command
 
2232
    def run(self):
 
2233
        tree = WorkingTree.open_containing(u'.')[0]
 
2234
        tree.lock_read()
 
2235
        try:
 
2236
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2237
                if file_class != 'I':
 
2238
                    continue
 
2239
                ## XXX: Slightly inefficient since this was already calculated
 
2240
                pat = tree.is_ignored(path)
 
2241
                self.outf.write('%-50s %s\n' % (path, pat))
 
2242
        finally:
 
2243
            tree.unlock()
 
2244
 
 
2245
 
 
2246
class cmd_lookup_revision(Command):
 
2247
    """Lookup the revision-id from a revision-number
 
2248
 
 
2249
    :Examples:
 
2250
        bzr lookup-revision 33
 
2251
    """
 
2252
    hidden = True
 
2253
    takes_args = ['revno']
 
2254
    
 
2255
    @display_command
 
2256
    def run(self, revno):
 
2257
        try:
 
2258
            revno = int(revno)
 
2259
        except ValueError:
 
2260
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2261
 
 
2262
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2263
 
 
2264
 
 
2265
class cmd_export(Command):
 
2266
    """Export current or past revision to a destination directory or archive.
 
2267
 
 
2268
    If no revision is specified this exports the last committed revision.
 
2269
 
 
2270
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2271
    given, try to find the format with the extension. If no extension
 
2272
    is found exports to a directory (equivalent to --format=dir).
 
2273
 
 
2274
    If root is supplied, it will be used as the root directory inside
 
2275
    container formats (tar, zip, etc). If it is not supplied it will default
 
2276
    to the exported filename. The root option has no effect for 'dir' format.
 
2277
 
 
2278
    If branch is omitted then the branch containing the current working
 
2279
    directory will be used.
 
2280
 
 
2281
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2282
 
 
2283
      =================       =========================
 
2284
      Supported formats       Autodetected by extension
 
2285
      =================       =========================
 
2286
         dir                         (none)
 
2287
         tar                          .tar
 
2288
         tbz2                    .tar.bz2, .tbz2
 
2289
         tgz                      .tar.gz, .tgz
 
2290
         zip                          .zip
 
2291
      =================       =========================
 
2292
    """
 
2293
    takes_args = ['dest', 'branch_or_subdir?']
 
2294
    takes_options = [
 
2295
        Option('format',
 
2296
               help="Type of file to export to.",
 
2297
               type=unicode),
 
2298
        'revision',
 
2299
        Option('root',
 
2300
               type=str,
 
2301
               help="Name of the root directory inside the exported file."),
 
2302
        ]
 
2303
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2304
        root=None):
 
2305
        from bzrlib.export import export
 
2306
 
 
2307
        if branch_or_subdir is None:
 
2308
            tree = WorkingTree.open_containing(u'.')[0]
 
2309
            b = tree.branch
 
2310
            subdir = None
 
2311
        else:
 
2312
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2313
            tree = None
 
2314
 
 
2315
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
2316
        try:
 
2317
            export(rev_tree, dest, format, root, subdir)
 
2318
        except errors.NoSuchExportFormat, e:
 
2319
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2320
 
 
2321
 
 
2322
class cmd_cat(Command):
 
2323
    """Write the contents of a file as of a given revision to standard output.
 
2324
 
 
2325
    If no revision is nominated, the last revision is used.
 
2326
 
 
2327
    Note: Take care to redirect standard output when using this command on a
 
2328
    binary file. 
 
2329
    """
 
2330
 
 
2331
    _see_also = ['ls']
 
2332
    takes_options = [
 
2333
        Option('name-from-revision', help='The path name in the old tree.'),
 
2334
        'revision',
 
2335
        ]
 
2336
    takes_args = ['filename']
 
2337
    encoding_type = 'exact'
 
2338
 
 
2339
    @display_command
 
2340
    def run(self, filename, revision=None, name_from_revision=False):
 
2341
        if revision is not None and len(revision) != 1:
 
2342
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2343
                                         " one revision specifier")
 
2344
        tree, branch, relpath = \
 
2345
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2346
        branch.lock_read()
 
2347
        try:
 
2348
            return self._run(tree, branch, relpath, filename, revision,
 
2349
                             name_from_revision)
 
2350
        finally:
 
2351
            branch.unlock()
 
2352
 
 
2353
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2354
        if tree is None:
 
2355
            tree = b.basis_tree()
 
2356
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2357
 
 
2358
        cur_file_id = tree.path2id(relpath)
 
2359
        old_file_id = rev_tree.path2id(relpath)
 
2360
 
 
2361
        if name_from_revision:
 
2362
            if old_file_id is None:
 
2363
                raise errors.BzrCommandError(
 
2364
                    "%r is not present in revision %s" % (
 
2365
                        filename, rev_tree.get_revision_id()))
 
2366
            else:
 
2367
                content = rev_tree.get_file_text(old_file_id)
 
2368
        elif cur_file_id is not None:
 
2369
            content = rev_tree.get_file_text(cur_file_id)
 
2370
        elif old_file_id is not None:
 
2371
            content = rev_tree.get_file_text(old_file_id)
 
2372
        else:
 
2373
            raise errors.BzrCommandError(
 
2374
                "%r is not present in revision %s" % (
 
2375
                    filename, rev_tree.get_revision_id()))
 
2376
        self.outf.write(content)
 
2377
 
 
2378
 
 
2379
class cmd_local_time_offset(Command):
 
2380
    """Show the offset in seconds from GMT to local time."""
 
2381
    hidden = True    
 
2382
    @display_command
 
2383
    def run(self):
 
2384
        print osutils.local_time_offset()
 
2385
 
 
2386
 
 
2387
 
 
2388
class cmd_commit(Command):
 
2389
    """Commit changes into a new revision.
 
2390
    
 
2391
    If no arguments are given, the entire tree is committed.
 
2392
 
 
2393
    If selected files are specified, only changes to those files are
 
2394
    committed.  If a directory is specified then the directory and everything 
 
2395
    within it is committed.
 
2396
 
 
2397
    When excludes are given, they take precedence over selected files.
 
2398
    For example, too commit only changes within foo, but not changes within
 
2399
    foo/bar::
 
2400
 
 
2401
      bzr commit foo -x foo/bar
 
2402
 
 
2403
    If author of the change is not the same person as the committer, you can
 
2404
    specify the author's name using the --author option. The name should be
 
2405
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2406
 
 
2407
    A selected-file commit may fail in some cases where the committed
 
2408
    tree would be invalid. Consider::
 
2409
 
 
2410
      bzr init foo
 
2411
      mkdir foo/bar
 
2412
      bzr add foo/bar
 
2413
      bzr commit foo -m "committing foo"
 
2414
      bzr mv foo/bar foo/baz
 
2415
      mkdir foo/bar
 
2416
      bzr add foo/bar
 
2417
      bzr commit foo/bar -m "committing bar but not baz"
 
2418
 
 
2419
    In the example above, the last commit will fail by design. This gives
 
2420
    the user the opportunity to decide whether they want to commit the
 
2421
    rename at the same time, separately first, or not at all. (As a general
 
2422
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2423
 
 
2424
    Note: A selected-file commit after a merge is not yet supported.
 
2425
    """
 
2426
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2427
 
 
2428
    # TODO: Strict commit that fails if there are deleted files.
 
2429
    #       (what does "deleted files" mean ??)
 
2430
 
 
2431
    # TODO: Give better message for -s, --summary, used by tla people
 
2432
 
 
2433
    # XXX: verbose currently does nothing
 
2434
 
 
2435
    _see_also = ['bugs', 'uncommit']
 
2436
    takes_args = ['selected*']
 
2437
    takes_options = [
 
2438
            ListOption('exclude', type=str, short_name='x',
 
2439
                help="Do not consider changes made to a given path."),
 
2440
            Option('message', type=unicode,
 
2441
                   short_name='m',
 
2442
                   help="Description of the new revision."),
 
2443
            'verbose',
 
2444
             Option('unchanged',
 
2445
                    help='Commit even if nothing has changed.'),
 
2446
             Option('file', type=str,
 
2447
                    short_name='F',
 
2448
                    argname='msgfile',
 
2449
                    help='Take commit message from this file.'),
 
2450
             Option('strict',
 
2451
                    help="Refuse to commit if there are unknown "
 
2452
                    "files in the working tree."),
 
2453
             ListOption('fixes', type=str,
 
2454
                    help="Mark a bug as being fixed by this revision."),
 
2455
             Option('author', type=unicode,
 
2456
                    help="Set the author's name, if it's different "
 
2457
                         "from the committer."),
 
2458
             Option('local',
 
2459
                    help="Perform a local commit in a bound "
 
2460
                         "branch.  Local commits are not pushed to "
 
2461
                         "the master branch until a normal commit "
 
2462
                         "is performed."
 
2463
                    ),
 
2464
              Option('show-diff',
 
2465
                     help='When no message is supplied, show the diff along'
 
2466
                     ' with the status summary in the message editor.'),
 
2467
             ]
 
2468
    aliases = ['ci', 'checkin']
 
2469
 
 
2470
    def _get_bug_fix_properties(self, fixes, branch):
 
2471
        properties = []
 
2472
        # Configure the properties for bug fixing attributes.
 
2473
        for fixed_bug in fixes:
 
2474
            tokens = fixed_bug.split(':')
 
2475
            if len(tokens) != 2:
 
2476
                raise errors.BzrCommandError(
 
2477
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2478
                    "Commit refused." % fixed_bug)
 
2479
            tag, bug_id = tokens
 
2480
            try:
 
2481
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2482
            except errors.UnknownBugTrackerAbbreviation:
 
2483
                raise errors.BzrCommandError(
 
2484
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2485
            except errors.MalformedBugIdentifier:
 
2486
                raise errors.BzrCommandError(
 
2487
                    "Invalid bug identifier for %s. Commit refused."
 
2488
                    % fixed_bug)
 
2489
            properties.append('%s fixed' % bug_url)
 
2490
        return '\n'.join(properties)
 
2491
 
 
2492
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2493
            unchanged=False, strict=False, local=False, fixes=None,
 
2494
            author=None, show_diff=False, exclude=None):
 
2495
        from bzrlib.errors import (
 
2496
            PointlessCommit,
 
2497
            ConflictsInTree,
 
2498
            StrictCommitFailed
 
2499
        )
 
2500
        from bzrlib.msgeditor import (
 
2501
            edit_commit_message_encoded,
 
2502
            generate_commit_message_template,
 
2503
            make_commit_message_template_encoded
 
2504
        )
 
2505
 
 
2506
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2507
        # slightly problematic to run this cross-platform.
 
2508
 
 
2509
        # TODO: do more checks that the commit will succeed before 
 
2510
        # spending the user's valuable time typing a commit message.
 
2511
 
 
2512
        properties = {}
 
2513
 
 
2514
        tree, selected_list = tree_files(selected_list)
 
2515
        if selected_list == ['']:
 
2516
            # workaround - commit of root of tree should be exactly the same
 
2517
            # as just default commit in that tree, and succeed even though
 
2518
            # selected-file merge commit is not done yet
 
2519
            selected_list = []
 
2520
 
 
2521
        if fixes is None:
 
2522
            fixes = []
 
2523
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2524
        if bug_property:
 
2525
            properties['bugs'] = bug_property
 
2526
 
 
2527
        if local and not tree.branch.get_bound_location():
 
2528
            raise errors.LocalRequiresBoundBranch()
 
2529
 
 
2530
        def get_message(commit_obj):
 
2531
            """Callback to get commit message"""
 
2532
            my_message = message
 
2533
            if my_message is None and not file:
 
2534
                t = make_commit_message_template_encoded(tree,
 
2535
                        selected_list, diff=show_diff,
 
2536
                        output_encoding=osutils.get_user_encoding())
 
2537
                start_message = generate_commit_message_template(commit_obj)
 
2538
                my_message = edit_commit_message_encoded(t, 
 
2539
                    start_message=start_message)
 
2540
                if my_message is None:
 
2541
                    raise errors.BzrCommandError("please specify a commit"
 
2542
                        " message with either --message or --file")
 
2543
            elif my_message and file:
 
2544
                raise errors.BzrCommandError(
 
2545
                    "please specify either --message or --file")
 
2546
            if file:
 
2547
                my_message = codecs.open(file, 'rt',
 
2548
                                         osutils.get_user_encoding()).read()
 
2549
            if my_message == "":
 
2550
                raise errors.BzrCommandError("empty commit message specified")
 
2551
            return my_message
 
2552
 
 
2553
        try:
 
2554
            tree.commit(message_callback=get_message,
 
2555
                        specific_files=selected_list,
 
2556
                        allow_pointless=unchanged, strict=strict, local=local,
 
2557
                        reporter=None, verbose=verbose, revprops=properties,
 
2558
                        author=author,
 
2559
                        exclude=safe_relpath_files(tree, exclude))
 
2560
        except PointlessCommit:
 
2561
            # FIXME: This should really happen before the file is read in;
 
2562
            # perhaps prepare the commit; get the message; then actually commit
 
2563
            raise errors.BzrCommandError("no changes to commit."
 
2564
                              " use --unchanged to commit anyhow")
 
2565
        except ConflictsInTree:
 
2566
            raise errors.BzrCommandError('Conflicts detected in working '
 
2567
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2568
                ' resolve.')
 
2569
        except StrictCommitFailed:
 
2570
            raise errors.BzrCommandError("Commit refused because there are"
 
2571
                              " unknown files in the working tree.")
 
2572
        except errors.BoundBranchOutOfDate, e:
 
2573
            raise errors.BzrCommandError(str(e) + "\n"
 
2574
            'To commit to master branch, run update and then commit.\n'
 
2575
            'You can also pass --local to commit to continue working '
 
2576
            'disconnected.')
 
2577
 
 
2578
 
 
2579
class cmd_check(Command):
 
2580
    """Validate working tree structure, branch consistency and repository history.
 
2581
 
 
2582
    This command checks various invariants about branch and repository storage
 
2583
    to detect data corruption or bzr bugs.
 
2584
 
 
2585
    The working tree and branch checks will only give output if a problem is
 
2586
    detected. The output fields of the repository check are:
 
2587
 
 
2588
        revisions: This is just the number of revisions checked.  It doesn't
 
2589
            indicate a problem.
 
2590
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2591
            doesn't indicate a problem.
 
2592
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2593
            are not properly referenced by the revision ancestry.  This is a
 
2594
            subtle problem that Bazaar can work around.
 
2595
        unique file texts: This is the total number of unique file contents
 
2596
            seen in the checked revisions.  It does not indicate a problem.
 
2597
        repeated file texts: This is the total number of repeated texts seen
 
2598
            in the checked revisions.  Texts can be repeated when their file
 
2599
            entries are modified, but the file contents are not.  It does not
 
2600
            indicate a problem.
 
2601
 
 
2602
    If no restrictions are specified, all Bazaar data that is found at the given
 
2603
    location will be checked.
 
2604
 
 
2605
    :Examples:
 
2606
 
 
2607
        Check the tree and branch at 'foo'::
 
2608
 
 
2609
            bzr check --tree --branch foo
 
2610
 
 
2611
        Check only the repository at 'bar'::
 
2612
 
 
2613
            bzr check --repo bar
 
2614
 
 
2615
        Check everything at 'baz'::
 
2616
 
 
2617
            bzr check baz
 
2618
    """
 
2619
 
 
2620
    _see_also = ['reconcile']
 
2621
    takes_args = ['path?']
 
2622
    takes_options = ['verbose',
 
2623
                     Option('branch', help="Check the branch related to the"
 
2624
                                           " current directory."),
 
2625
                     Option('repo', help="Check the repository related to the"
 
2626
                                         " current directory."),
 
2627
                     Option('tree', help="Check the working tree related to"
 
2628
                                         " the current directory.")]
 
2629
 
 
2630
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
2631
            tree=False):
 
2632
        from bzrlib.check import check_dwim
 
2633
        if path is None:
 
2634
            path = '.'
 
2635
        if not branch and not repo and not tree:
 
2636
            branch = repo = tree = True
 
2637
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2638
 
 
2639
 
 
2640
class cmd_upgrade(Command):
 
2641
    """Upgrade branch storage to current format.
 
2642
 
 
2643
    The check command or bzr developers may sometimes advise you to run
 
2644
    this command. When the default format has changed you may also be warned
 
2645
    during other operations to upgrade.
 
2646
    """
 
2647
 
 
2648
    _see_also = ['check']
 
2649
    takes_args = ['url?']
 
2650
    takes_options = [
 
2651
                    RegistryOption('format',
 
2652
                        help='Upgrade to a specific format.  See "bzr help'
 
2653
                             ' formats" for details.',
 
2654
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
2655
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2656
                        value_switches=True, title='Branch format'),
 
2657
                    ]
 
2658
 
 
2659
    def run(self, url='.', format=None):
 
2660
        from bzrlib.upgrade import upgrade
 
2661
        if format is None:
 
2662
            format = bzrdir.format_registry.make_bzrdir('default')
 
2663
        upgrade(url, format)
 
2664
 
 
2665
 
 
2666
class cmd_whoami(Command):
 
2667
    """Show or set bzr user id.
 
2668
    
 
2669
    :Examples:
 
2670
        Show the email of the current user::
 
2671
 
 
2672
            bzr whoami --email
 
2673
 
 
2674
        Set the current user::
 
2675
 
 
2676
            bzr whoami "Frank Chu <fchu@example.com>"
 
2677
    """
 
2678
    takes_options = [ Option('email',
 
2679
                             help='Display email address only.'),
 
2680
                      Option('branch',
 
2681
                             help='Set identity for the current branch instead of '
 
2682
                                  'globally.'),
 
2683
                    ]
 
2684
    takes_args = ['name?']
 
2685
    encoding_type = 'replace'
 
2686
    
 
2687
    @display_command
 
2688
    def run(self, email=False, branch=False, name=None):
 
2689
        if name is None:
 
2690
            # use branch if we're inside one; otherwise global config
 
2691
            try:
 
2692
                c = Branch.open_containing('.')[0].get_config()
 
2693
            except errors.NotBranchError:
 
2694
                c = config.GlobalConfig()
 
2695
            if email:
 
2696
                self.outf.write(c.user_email() + '\n')
 
2697
            else:
 
2698
                self.outf.write(c.username() + '\n')
 
2699
            return
 
2700
 
 
2701
        # display a warning if an email address isn't included in the given name.
 
2702
        try:
 
2703
            config.extract_email_address(name)
 
2704
        except errors.NoEmailInUsername, e:
 
2705
            warning('"%s" does not seem to contain an email address.  '
 
2706
                    'This is allowed, but not recommended.', name)
 
2707
        
 
2708
        # use global config unless --branch given
 
2709
        if branch:
 
2710
            c = Branch.open_containing('.')[0].get_config()
 
2711
        else:
 
2712
            c = config.GlobalConfig()
 
2713
        c.set_user_option('email', name)
 
2714
 
 
2715
 
 
2716
class cmd_nick(Command):
 
2717
    """Print or set the branch nickname.
 
2718
 
 
2719
    If unset, the tree root directory name is used as the nickname.
 
2720
    To print the current nickname, execute with no argument.
 
2721
 
 
2722
    Bound branches use the nickname of its master branch unless it is set
 
2723
    locally.
 
2724
    """
 
2725
 
 
2726
    _see_also = ['info']
 
2727
    takes_args = ['nickname?']
 
2728
    def run(self, nickname=None):
 
2729
        branch = Branch.open_containing(u'.')[0]
 
2730
        if nickname is None:
 
2731
            self.printme(branch)
 
2732
        else:
 
2733
            branch.nick = nickname
 
2734
 
 
2735
    @display_command
 
2736
    def printme(self, branch):
 
2737
        print branch.nick
 
2738
 
 
2739
 
 
2740
class cmd_alias(Command):
 
2741
    """Set/unset and display aliases.
 
2742
 
 
2743
    :Examples:
 
2744
        Show the current aliases::
 
2745
 
 
2746
            bzr alias
 
2747
 
 
2748
        Show the alias specified for 'll'::
 
2749
 
 
2750
            bzr alias ll
 
2751
 
 
2752
        Set an alias for 'll'::
 
2753
 
 
2754
            bzr alias ll="log --line -r-10..-1"
 
2755
 
 
2756
        To remove an alias for 'll'::
 
2757
 
 
2758
            bzr alias --remove ll
 
2759
 
 
2760
    """
 
2761
    takes_args = ['name?']
 
2762
    takes_options = [
 
2763
        Option('remove', help='Remove the alias.'),
 
2764
        ]
 
2765
 
 
2766
    def run(self, name=None, remove=False):
 
2767
        if remove:
 
2768
            self.remove_alias(name)
 
2769
        elif name is None:
 
2770
            self.print_aliases()
 
2771
        else:
 
2772
            equal_pos = name.find('=')
 
2773
            if equal_pos == -1:
 
2774
                self.print_alias(name)
 
2775
            else:
 
2776
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
2777
 
 
2778
    def remove_alias(self, alias_name):
 
2779
        if alias_name is None:
 
2780
            raise errors.BzrCommandError(
 
2781
                'bzr alias --remove expects an alias to remove.')
 
2782
        # If alias is not found, print something like:
 
2783
        # unalias: foo: not found
 
2784
        c = config.GlobalConfig()
 
2785
        c.unset_alias(alias_name)
 
2786
 
 
2787
    @display_command
 
2788
    def print_aliases(self):
 
2789
        """Print out the defined aliases in a similar format to bash."""
 
2790
        aliases = config.GlobalConfig().get_aliases()
 
2791
        for key, value in sorted(aliases.iteritems()):
 
2792
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
2793
 
 
2794
    @display_command
 
2795
    def print_alias(self, alias_name):
 
2796
        from bzrlib.commands import get_alias
 
2797
        alias = get_alias(alias_name)
 
2798
        if alias is None:
 
2799
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
2800
        else:
 
2801
            self.outf.write(
 
2802
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
2803
 
 
2804
    def set_alias(self, alias_name, alias_command):
 
2805
        """Save the alias in the global config."""
 
2806
        c = config.GlobalConfig()
 
2807
        c.set_alias(alias_name, alias_command)
 
2808
 
 
2809
 
 
2810
class cmd_selftest(Command):
 
2811
    """Run internal test suite.
 
2812
    
 
2813
    If arguments are given, they are regular expressions that say which tests
 
2814
    should run.  Tests matching any expression are run, and other tests are
 
2815
    not run.
 
2816
 
 
2817
    Alternatively if --first is given, matching tests are run first and then
 
2818
    all other tests are run.  This is useful if you have been working in a
 
2819
    particular area, but want to make sure nothing else was broken.
 
2820
 
 
2821
    If --exclude is given, tests that match that regular expression are
 
2822
    excluded, regardless of whether they match --first or not.
 
2823
 
 
2824
    To help catch accidential dependencies between tests, the --randomize
 
2825
    option is useful. In most cases, the argument used is the word 'now'.
 
2826
    Note that the seed used for the random number generator is displayed
 
2827
    when this option is used. The seed can be explicitly passed as the
 
2828
    argument to this option if required. This enables reproduction of the
 
2829
    actual ordering used if and when an order sensitive problem is encountered.
 
2830
 
 
2831
    If --list-only is given, the tests that would be run are listed. This is
 
2832
    useful when combined with --first, --exclude and/or --randomize to
 
2833
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2834
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2835
 
 
2836
    If the global option '--no-plugins' is given, plugins are not loaded
 
2837
    before running the selftests.  This has two effects: features provided or
 
2838
    modified by plugins will not be tested, and tests provided by plugins will
 
2839
    not be run.
 
2840
 
 
2841
    Tests that need working space on disk use a common temporary directory, 
 
2842
    typically inside $TMPDIR or /tmp.
 
2843
 
 
2844
    :Examples:
 
2845
        Run only tests relating to 'ignore'::
 
2846
 
 
2847
            bzr selftest ignore
 
2848
 
 
2849
        Disable plugins and list tests as they're run::
 
2850
 
 
2851
            bzr --no-plugins selftest -v
 
2852
    """
 
2853
    # NB: this is used from the class without creating an instance, which is
 
2854
    # why it does not have a self parameter.
 
2855
    def get_transport_type(typestring):
 
2856
        """Parse and return a transport specifier."""
 
2857
        if typestring == "sftp":
 
2858
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2859
            return SFTPAbsoluteServer
 
2860
        if typestring == "memory":
 
2861
            from bzrlib.transport.memory import MemoryServer
 
2862
            return MemoryServer
 
2863
        if typestring == "fakenfs":
 
2864
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2865
            return FakeNFSServer
 
2866
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2867
            (typestring)
 
2868
        raise errors.BzrCommandError(msg)
 
2869
 
 
2870
    hidden = True
 
2871
    takes_args = ['testspecs*']
 
2872
    takes_options = ['verbose',
 
2873
                     Option('one',
 
2874
                             help='Stop when one test fails.',
 
2875
                             short_name='1',
 
2876
                             ),
 
2877
                     Option('transport',
 
2878
                            help='Use a different transport by default '
 
2879
                                 'throughout the test suite.',
 
2880
                            type=get_transport_type),
 
2881
                     Option('benchmark',
 
2882
                            help='Run the benchmarks rather than selftests.'),
 
2883
                     Option('lsprof-timed',
 
2884
                            help='Generate lsprof output for benchmarked'
 
2885
                                 ' sections of code.'),
 
2886
                     Option('cache-dir', type=str,
 
2887
                            help='Cache intermediate benchmark output in this '
 
2888
                                 'directory.'),
 
2889
                     Option('first',
 
2890
                            help='Run all tests, but run specified tests first.',
 
2891
                            short_name='f',
 
2892
                            ),
 
2893
                     Option('list-only',
 
2894
                            help='List the tests instead of running them.'),
 
2895
                     Option('randomize', type=str, argname="SEED",
 
2896
                            help='Randomize the order of tests using the given'
 
2897
                                 ' seed or "now" for the current time.'),
 
2898
                     Option('exclude', type=str, argname="PATTERN",
 
2899
                            short_name='x',
 
2900
                            help='Exclude tests that match this regular'
 
2901
                                 ' expression.'),
 
2902
                     Option('strict', help='Fail on missing dependencies or '
 
2903
                            'known failures.'),
 
2904
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
2905
                            help='Load a test id list from a text file.'),
 
2906
                     ListOption('debugflag', type=str, short_name='E',
 
2907
                                help='Turn on a selftest debug flag.'),
 
2908
                     ListOption('starting-with', type=str, argname='TESTID',
 
2909
                                param_name='starting_with', short_name='s',
 
2910
                                help=
 
2911
                                'Load only the tests starting with TESTID.'),
 
2912
                     ]
 
2913
    encoding_type = 'replace'
 
2914
 
 
2915
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2916
            transport=None, benchmark=None,
 
2917
            lsprof_timed=None, cache_dir=None,
 
2918
            first=False, list_only=False,
 
2919
            randomize=None, exclude=None, strict=False,
 
2920
            load_list=None, debugflag=None, starting_with=None):
 
2921
        from bzrlib.tests import selftest
 
2922
        import bzrlib.benchmarks as benchmarks
 
2923
        from bzrlib.benchmarks import tree_creator
 
2924
 
 
2925
        # Make deprecation warnings visible, unless -Werror is set
 
2926
        symbol_versioning.activate_deprecation_warnings(override=False)
 
2927
 
 
2928
        if cache_dir is not None:
 
2929
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2930
        if not list_only:
 
2931
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2932
            print '   %s (%s python%s)' % (
 
2933
                    bzrlib.__path__[0],
 
2934
                    bzrlib.version_string,
 
2935
                    bzrlib._format_version_tuple(sys.version_info),
 
2936
                    )
 
2937
        print
 
2938
        if testspecs_list is not None:
 
2939
            pattern = '|'.join(testspecs_list)
 
2940
        else:
 
2941
            pattern = ".*"
 
2942
        if benchmark:
 
2943
            test_suite_factory = benchmarks.test_suite
 
2944
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2945
            verbose = not is_quiet()
 
2946
            # TODO: should possibly lock the history file...
 
2947
            benchfile = open(".perf_history", "at", buffering=1)
 
2948
        else:
 
2949
            test_suite_factory = None
 
2950
            benchfile = None
 
2951
        try:
 
2952
            result = selftest(verbose=verbose,
 
2953
                              pattern=pattern,
 
2954
                              stop_on_failure=one,
 
2955
                              transport=transport,
 
2956
                              test_suite_factory=test_suite_factory,
 
2957
                              lsprof_timed=lsprof_timed,
 
2958
                              bench_history=benchfile,
 
2959
                              matching_tests_first=first,
 
2960
                              list_only=list_only,
 
2961
                              random_seed=randomize,
 
2962
                              exclude_pattern=exclude,
 
2963
                              strict=strict,
 
2964
                              load_list=load_list,
 
2965
                              debug_flags=debugflag,
 
2966
                              starting_with=starting_with,
 
2967
                              )
 
2968
        finally:
 
2969
            if benchfile is not None:
 
2970
                benchfile.close()
 
2971
        if result:
 
2972
            note('tests passed')
 
2973
        else:
 
2974
            note('tests failed')
 
2975
        return int(not result)
 
2976
 
 
2977
 
 
2978
class cmd_version(Command):
 
2979
    """Show version of bzr."""
 
2980
 
 
2981
    encoding_type = 'replace'
 
2982
    takes_options = [
 
2983
        Option("short", help="Print just the version number."),
 
2984
        ]
 
2985
 
 
2986
    @display_command
 
2987
    def run(self, short=False):
 
2988
        from bzrlib.version import show_version
 
2989
        if short:
 
2990
            self.outf.write(bzrlib.version_string + '\n')
 
2991
        else:
 
2992
            show_version(to_file=self.outf)
 
2993
 
 
2994
 
 
2995
class cmd_rocks(Command):
 
2996
    """Statement of optimism."""
 
2997
 
 
2998
    hidden = True
 
2999
 
 
3000
    @display_command
 
3001
    def run(self):
 
3002
        print "It sure does!"
 
3003
 
 
3004
 
 
3005
class cmd_find_merge_base(Command):
 
3006
    """Find and print a base revision for merging two branches."""
 
3007
    # TODO: Options to specify revisions on either side, as if
 
3008
    #       merging only part of the history.
 
3009
    takes_args = ['branch', 'other']
 
3010
    hidden = True
 
3011
    
 
3012
    @display_command
 
3013
    def run(self, branch, other):
 
3014
        from bzrlib.revision import ensure_null
 
3015
        
 
3016
        branch1 = Branch.open_containing(branch)[0]
 
3017
        branch2 = Branch.open_containing(other)[0]
 
3018
        branch1.lock_read()
 
3019
        try:
 
3020
            branch2.lock_read()
 
3021
            try:
 
3022
                last1 = ensure_null(branch1.last_revision())
 
3023
                last2 = ensure_null(branch2.last_revision())
 
3024
 
 
3025
                graph = branch1.repository.get_graph(branch2.repository)
 
3026
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3027
 
 
3028
                print 'merge base is revision %s' % base_rev_id
 
3029
            finally:
 
3030
                branch2.unlock()
 
3031
        finally:
 
3032
            branch1.unlock()
 
3033
 
 
3034
 
 
3035
class cmd_merge(Command):
 
3036
    """Perform a three-way merge.
 
3037
    
 
3038
    The source of the merge can be specified either in the form of a branch,
 
3039
    or in the form of a path to a file containing a merge directive generated
 
3040
    with bzr send. If neither is specified, the default is the upstream branch
 
3041
    or the branch most recently merged using --remember.
 
3042
 
 
3043
    When merging a branch, by default the tip will be merged. To pick a different
 
3044
    revision, pass --revision. If you specify two values, the first will be used as
 
3045
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3046
    available revisions, like this is commonly referred to as "cherrypicking".
 
3047
 
 
3048
    Revision numbers are always relative to the branch being merged.
 
3049
 
 
3050
    By default, bzr will try to merge in all new work from the other
 
3051
    branch, automatically determining an appropriate base.  If this
 
3052
    fails, you may need to give an explicit base.
 
3053
    
 
3054
    Merge will do its best to combine the changes in two branches, but there
 
3055
    are some kinds of problems only a human can fix.  When it encounters those,
 
3056
    it will mark a conflict.  A conflict means that you need to fix something,
 
3057
    before you should commit.
 
3058
 
 
3059
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
3060
 
 
3061
    If there is no default branch set, the first merge will set it. After
 
3062
    that, you can omit the branch to use the default.  To change the
 
3063
    default, use --remember. The value will only be saved if the remote
 
3064
    location can be accessed.
 
3065
 
 
3066
    The results of the merge are placed into the destination working
 
3067
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3068
    committed to record the result of the merge.
 
3069
    
 
3070
    merge refuses to run if there are any uncommitted changes, unless
 
3071
    --force is given.
 
3072
 
 
3073
    :Examples:
 
3074
        To merge the latest revision from bzr.dev::
 
3075
 
 
3076
            bzr merge ../bzr.dev
 
3077
 
 
3078
        To merge changes up to and including revision 82 from bzr.dev::
 
3079
 
 
3080
            bzr merge -r 82 ../bzr.dev
 
3081
 
 
3082
        To merge the changes introduced by 82, without previous changes::
 
3083
 
 
3084
            bzr merge -r 81..82 ../bzr.dev
 
3085
 
 
3086
        To apply a merge directive contained in in /tmp/merge:
 
3087
 
 
3088
            bzr merge /tmp/merge
 
3089
    """
 
3090
 
 
3091
    encoding_type = 'exact'
 
3092
    _see_also = ['update', 'remerge', 'status-flags']
 
3093
    takes_args = ['location?']
 
3094
    takes_options = [
 
3095
        'change',
 
3096
        'revision',
 
3097
        Option('force',
 
3098
               help='Merge even if the destination tree has uncommitted changes.'),
 
3099
        'merge-type',
 
3100
        'reprocess',
 
3101
        'remember',
 
3102
        Option('show-base', help="Show base revision text in "
 
3103
               "conflicts."),
 
3104
        Option('uncommitted', help='Apply uncommitted changes'
 
3105
               ' from a working copy, instead of branch changes.'),
 
3106
        Option('pull', help='If the destination is already'
 
3107
                ' completely merged into the source, pull from the'
 
3108
                ' source rather than merging.  When this happens,'
 
3109
                ' you do not need to commit the result.'),
 
3110
        Option('directory',
 
3111
               help='Branch to merge into, '
 
3112
                    'rather than the one containing the working directory.',
 
3113
               short_name='d',
 
3114
               type=unicode,
 
3115
               ),
 
3116
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3117
    ]
 
3118
 
 
3119
    def run(self, location=None, revision=None, force=False,
 
3120
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3121
            uncommitted=False, pull=False,
 
3122
            directory=None,
 
3123
            preview=False,
 
3124
            ):
 
3125
        if merge_type is None:
 
3126
            merge_type = _mod_merge.Merge3Merger
 
3127
 
 
3128
        if directory is None: directory = u'.'
 
3129
        possible_transports = []
 
3130
        merger = None
 
3131
        allow_pending = True
 
3132
        verified = 'inapplicable'
 
3133
        tree = WorkingTree.open_containing(directory)[0]
 
3134
        change_reporter = delta._ChangeReporter(
 
3135
            unversioned_filter=tree.is_ignored)
 
3136
        cleanups = []
 
3137
        try:
 
3138
            pb = ui.ui_factory.nested_progress_bar()
 
3139
            cleanups.append(pb.finished)
 
3140
            tree.lock_write()
 
3141
            cleanups.append(tree.unlock)
 
3142
            if location is not None:
 
3143
                try:
 
3144
                    mergeable = bundle.read_mergeable_from_url(location,
 
3145
                        possible_transports=possible_transports)
 
3146
                except errors.NotABundle:
 
3147
                    mergeable = None
 
3148
                else:
 
3149
                    if uncommitted:
 
3150
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3151
                            ' with bundles or merge directives.')
 
3152
 
 
3153
                    if revision is not None:
 
3154
                        raise errors.BzrCommandError(
 
3155
                            'Cannot use -r with merge directives or bundles')
 
3156
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3157
                       mergeable, pb)
 
3158
 
 
3159
            if merger is None and uncommitted:
 
3160
                if revision is not None and len(revision) > 0:
 
3161
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3162
                        ' --revision at the same time.')
 
3163
                location = self._select_branch_location(tree, location)[0]
 
3164
                other_tree, other_path = WorkingTree.open_containing(location)
 
3165
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3166
                    pb)
 
3167
                allow_pending = False
 
3168
                if other_path != '':
 
3169
                    merger.interesting_files = [other_path]
 
3170
 
 
3171
            if merger is None:
 
3172
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3173
                    location, revision, remember, possible_transports, pb)
 
3174
 
 
3175
            merger.merge_type = merge_type
 
3176
            merger.reprocess = reprocess
 
3177
            merger.show_base = show_base
 
3178
            self.sanity_check_merger(merger)
 
3179
            if (merger.base_rev_id == merger.other_rev_id and
 
3180
                merger.other_rev_id is not None):
 
3181
                note('Nothing to do.')
 
3182
                return 0
 
3183
            if pull:
 
3184
                if merger.interesting_files is not None:
 
3185
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3186
                if (merger.base_rev_id == tree.last_revision()):
 
3187
                    result = tree.pull(merger.other_branch, False,
 
3188
                                       merger.other_rev_id)
 
3189
                    result.report(self.outf)
 
3190
                    return 0
 
3191
            merger.check_basis(not force)
 
3192
            if preview:
 
3193
                return self._do_preview(merger)
 
3194
            else:
 
3195
                return self._do_merge(merger, change_reporter, allow_pending,
 
3196
                                      verified)
 
3197
        finally:
 
3198
            for cleanup in reversed(cleanups):
 
3199
                cleanup()
 
3200
 
 
3201
    def _do_preview(self, merger):
 
3202
        from bzrlib.diff import show_diff_trees
 
3203
        tree_merger = merger.make_merger()
 
3204
        tt = tree_merger.make_preview_transform()
 
3205
        try:
 
3206
            result_tree = tt.get_preview_tree()
 
3207
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3208
                            old_label='', new_label='')
 
3209
        finally:
 
3210
            tt.finalize()
 
3211
 
 
3212
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3213
        merger.change_reporter = change_reporter
 
3214
        conflict_count = merger.do_merge()
 
3215
        if allow_pending:
 
3216
            merger.set_pending()
 
3217
        if verified == 'failed':
 
3218
            warning('Preview patch does not match changes')
 
3219
        if conflict_count != 0:
 
3220
            return 1
 
3221
        else:
 
3222
            return 0
 
3223
 
 
3224
    def sanity_check_merger(self, merger):
 
3225
        if (merger.show_base and
 
3226
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3227
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3228
                                         " merge type. %s" % merger.merge_type)
 
3229
        if merger.reprocess is None:
 
3230
            if merger.show_base:
 
3231
                merger.reprocess = False
 
3232
            else:
 
3233
                # Use reprocess if the merger supports it
 
3234
                merger.reprocess = merger.merge_type.supports_reprocess
 
3235
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3236
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3237
                                         " for merge type %s." %
 
3238
                                         merger.merge_type)
 
3239
        if merger.reprocess and merger.show_base:
 
3240
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3241
                                         " show base.")
 
3242
 
 
3243
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3244
                                possible_transports, pb):
 
3245
        """Produce a merger from a location, assuming it refers to a branch."""
 
3246
        from bzrlib.tag import _merge_tags_if_possible
 
3247
        # find the branch locations
 
3248
        other_loc, user_location = self._select_branch_location(tree, location,
 
3249
            revision, -1)
 
3250
        if revision is not None and len(revision) == 2:
 
3251
            base_loc, _unused = self._select_branch_location(tree,
 
3252
                location, revision, 0)
 
3253
        else:
 
3254
            base_loc = other_loc
 
3255
        # Open the branches
 
3256
        other_branch, other_path = Branch.open_containing(other_loc,
 
3257
            possible_transports)
 
3258
        if base_loc == other_loc:
 
3259
            base_branch = other_branch
 
3260
        else:
 
3261
            base_branch, base_path = Branch.open_containing(base_loc,
 
3262
                possible_transports)
 
3263
        # Find the revision ids
 
3264
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3265
            other_revision_id = _mod_revision.ensure_null(
 
3266
                other_branch.last_revision())
 
3267
        else:
 
3268
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3269
        if (revision is not None and len(revision) == 2
 
3270
            and revision[0] is not None):
 
3271
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3272
        else:
 
3273
            base_revision_id = None
 
3274
        # Remember where we merge from
 
3275
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3276
             user_location is not None):
 
3277
            tree.branch.set_submit_branch(other_branch.base)
 
3278
        _merge_tags_if_possible(other_branch, tree.branch)
 
3279
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3280
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3281
        if other_path != '':
 
3282
            allow_pending = False
 
3283
            merger.interesting_files = [other_path]
 
3284
        else:
 
3285
            allow_pending = True
 
3286
        return merger, allow_pending
 
3287
 
 
3288
    def _select_branch_location(self, tree, user_location, revision=None,
 
3289
                                index=None):
 
3290
        """Select a branch location, according to possible inputs.
 
3291
 
 
3292
        If provided, branches from ``revision`` are preferred.  (Both
 
3293
        ``revision`` and ``index`` must be supplied.)
 
3294
 
 
3295
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3296
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3297
 
 
3298
        :param tree: The working tree to select a branch for merging into
 
3299
        :param location: The location entered by the user
 
3300
        :param revision: The revision parameter to the command
 
3301
        :param index: The index to use for the revision parameter.  Negative
 
3302
            indices are permitted.
 
3303
        :return: (selected_location, user_location).  The default location
 
3304
            will be the user-entered location.
 
3305
        """
 
3306
        if (revision is not None and index is not None
 
3307
            and revision[index] is not None):
 
3308
            branch = revision[index].get_branch()
 
3309
            if branch is not None:
 
3310
                return branch, branch
 
3311
        if user_location is None:
 
3312
            location = self._get_remembered(tree, 'Merging from')
 
3313
        else:
 
3314
            location = user_location
 
3315
        return location, user_location
 
3316
 
 
3317
    def _get_remembered(self, tree, verb_string):
 
3318
        """Use tree.branch's parent if none was supplied.
 
3319
 
 
3320
        Report if the remembered location was used.
 
3321
        """
 
3322
        stored_location = tree.branch.get_submit_branch()
 
3323
        stored_location_type = "submit"
 
3324
        if stored_location is None:
 
3325
            stored_location = tree.branch.get_parent()
 
3326
            stored_location_type = "parent"
 
3327
        mutter("%s", stored_location)
 
3328
        if stored_location is None:
 
3329
            raise errors.BzrCommandError("No location specified or remembered")
 
3330
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3331
        note(u"%s remembered %s location %s", verb_string,
 
3332
                stored_location_type, display_url)
 
3333
        return stored_location
 
3334
 
 
3335
 
 
3336
class cmd_remerge(Command):
 
3337
    """Redo a merge.
 
3338
 
 
3339
    Use this if you want to try a different merge technique while resolving
 
3340
    conflicts.  Some merge techniques are better than others, and remerge 
 
3341
    lets you try different ones on different files.
 
3342
 
 
3343
    The options for remerge have the same meaning and defaults as the ones for
 
3344
    merge.  The difference is that remerge can (only) be run when there is a
 
3345
    pending merge, and it lets you specify particular files.
 
3346
 
 
3347
    :Examples:
 
3348
        Re-do the merge of all conflicted files, and show the base text in
 
3349
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3350
      
 
3351
            bzr remerge --show-base
 
3352
 
 
3353
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3354
        additional processing to reduce the size of conflict regions::
 
3355
      
 
3356
            bzr remerge --merge-type weave --reprocess foobar
 
3357
    """
 
3358
    takes_args = ['file*']
 
3359
    takes_options = [
 
3360
            'merge-type',
 
3361
            'reprocess',
 
3362
            Option('show-base',
 
3363
                   help="Show base revision text in conflicts."),
 
3364
            ]
 
3365
 
 
3366
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3367
            reprocess=False):
 
3368
        if merge_type is None:
 
3369
            merge_type = _mod_merge.Merge3Merger
 
3370
        tree, file_list = tree_files(file_list)
 
3371
        tree.lock_write()
 
3372
        try:
 
3373
            parents = tree.get_parent_ids()
 
3374
            if len(parents) != 2:
 
3375
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3376
                                             " merges.  Not cherrypicking or"
 
3377
                                             " multi-merges.")
 
3378
            repository = tree.branch.repository
 
3379
            interesting_ids = None
 
3380
            new_conflicts = []
 
3381
            conflicts = tree.conflicts()
 
3382
            if file_list is not None:
 
3383
                interesting_ids = set()
 
3384
                for filename in file_list:
 
3385
                    file_id = tree.path2id(filename)
 
3386
                    if file_id is None:
 
3387
                        raise errors.NotVersionedError(filename)
 
3388
                    interesting_ids.add(file_id)
 
3389
                    if tree.kind(file_id) != "directory":
 
3390
                        continue
 
3391
                    
 
3392
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3393
                        interesting_ids.add(ie.file_id)
 
3394
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3395
            else:
 
3396
                # Remerge only supports resolving contents conflicts
 
3397
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3398
                restore_files = [c.path for c in conflicts
 
3399
                                 if c.typestring in allowed_conflicts]
 
3400
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3401
            tree.set_conflicts(ConflictList(new_conflicts))
 
3402
            if file_list is not None:
 
3403
                restore_files = file_list
 
3404
            for filename in restore_files:
 
3405
                try:
 
3406
                    restore(tree.abspath(filename))
 
3407
                except errors.NotConflicted:
 
3408
                    pass
 
3409
            # Disable pending merges, because the file texts we are remerging
 
3410
            # have not had those merges performed.  If we use the wrong parents
 
3411
            # list, we imply that the working tree text has seen and rejected
 
3412
            # all the changes from the other tree, when in fact those changes
 
3413
            # have not yet been seen.
 
3414
            pb = ui.ui_factory.nested_progress_bar()
 
3415
            tree.set_parent_ids(parents[:1])
 
3416
            try:
 
3417
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3418
                                                             tree, parents[1])
 
3419
                merger.interesting_ids = interesting_ids
 
3420
                merger.merge_type = merge_type
 
3421
                merger.show_base = show_base
 
3422
                merger.reprocess = reprocess
 
3423
                conflicts = merger.do_merge()
 
3424
            finally:
 
3425
                tree.set_parent_ids(parents)
 
3426
                pb.finished()
 
3427
        finally:
 
3428
            tree.unlock()
 
3429
        if conflicts > 0:
 
3430
            return 1
 
3431
        else:
 
3432
            return 0
 
3433
 
 
3434
 
 
3435
class cmd_revert(Command):
 
3436
    """Revert files to a previous revision.
 
3437
 
 
3438
    Giving a list of files will revert only those files.  Otherwise, all files
 
3439
    will be reverted.  If the revision is not specified with '--revision', the
 
3440
    last committed revision is used.
 
3441
 
 
3442
    To remove only some changes, without reverting to a prior version, use
 
3443
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3444
    changes introduced by -2, without affecting the changes introduced by -1.
 
3445
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3446
    
 
3447
    By default, any files that have been manually changed will be backed up
 
3448
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3449
    '.~#~' appended to their name, where # is a number.
 
3450
 
 
3451
    When you provide files, you can use their current pathname or the pathname
 
3452
    from the target revision.  So you can use revert to "undelete" a file by
 
3453
    name.  If you name a directory, all the contents of that directory will be
 
3454
    reverted.
 
3455
 
 
3456
    Any files that have been newly added since that revision will be deleted,
 
3457
    with a backup kept if appropriate.  Directories containing unknown files
 
3458
    will not be deleted.
 
3459
 
 
3460
    The working tree contains a list of pending merged revisions, which will
 
3461
    be included as parents in the next commit.  Normally, revert clears that
 
3462
    list as well as reverting the files.  If any files are specified, revert
 
3463
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3464
    revert ." in the tree root to revert all files but keep the merge record,
 
3465
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3466
    reverting any files.
 
3467
    """
 
3468
 
 
3469
    _see_also = ['cat', 'export']
 
3470
    takes_options = [
 
3471
        'revision',
 
3472
        Option('no-backup', "Do not save backups of reverted files."),
 
3473
        Option('forget-merges',
 
3474
               'Remove pending merge marker, without changing any files.'),
 
3475
        ]
 
3476
    takes_args = ['file*']
 
3477
 
 
3478
    def run(self, revision=None, no_backup=False, file_list=None,
 
3479
            forget_merges=None):
 
3480
        tree, file_list = tree_files(file_list)
 
3481
        tree.lock_write()
 
3482
        try:
 
3483
            if forget_merges:
 
3484
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3485
            else:
 
3486
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3487
        finally:
 
3488
            tree.unlock()
 
3489
 
 
3490
    @staticmethod
 
3491
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3492
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
3493
        pb = ui.ui_factory.nested_progress_bar()
 
3494
        try:
 
3495
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3496
                report_changes=True)
 
3497
        finally:
 
3498
            pb.finished()
 
3499
 
 
3500
 
 
3501
class cmd_assert_fail(Command):
 
3502
    """Test reporting of assertion failures"""
 
3503
    # intended just for use in testing
 
3504
 
 
3505
    hidden = True
 
3506
 
 
3507
    def run(self):
 
3508
        raise AssertionError("always fails")
 
3509
 
 
3510
 
 
3511
class cmd_help(Command):
 
3512
    """Show help on a command or other topic.
 
3513
    """
 
3514
 
 
3515
    _see_also = ['topics']
 
3516
    takes_options = [
 
3517
            Option('long', 'Show help on all commands.'),
 
3518
            ]
 
3519
    takes_args = ['topic?']
 
3520
    aliases = ['?', '--help', '-?', '-h']
 
3521
    
 
3522
    @display_command
 
3523
    def run(self, topic=None, long=False):
 
3524
        import bzrlib.help
 
3525
        if topic is None and long:
 
3526
            topic = "commands"
 
3527
        bzrlib.help.help(topic)
 
3528
 
 
3529
 
 
3530
class cmd_shell_complete(Command):
 
3531
    """Show appropriate completions for context.
 
3532
 
 
3533
    For a list of all available commands, say 'bzr shell-complete'.
 
3534
    """
 
3535
    takes_args = ['context?']
 
3536
    aliases = ['s-c']
 
3537
    hidden = True
 
3538
    
 
3539
    @display_command
 
3540
    def run(self, context=None):
 
3541
        import shellcomplete
 
3542
        shellcomplete.shellcomplete(context)
 
3543
 
 
3544
 
 
3545
class cmd_missing(Command):
 
3546
    """Show unmerged/unpulled revisions between two branches.
 
3547
 
 
3548
    OTHER_BRANCH may be local or remote.
 
3549
 
 
3550
    To filter on a range of revirions, you can use the command -r begin..end
 
3551
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
3552
    also valid.
 
3553
 
 
3554
    :Examples:
 
3555
 
 
3556
        Determine the missing revisions between this and the branch at the
 
3557
        remembered pull location::
 
3558
 
 
3559
            bzr missing
 
3560
 
 
3561
        Determine the missing revisions between this and another branch::
 
3562
 
 
3563
            bzr missing http://server/branch
 
3564
 
 
3565
        Determine the missing revisions up to a specific revision on the other
 
3566
        branch::
 
3567
 
 
3568
            bzr missing -r ..-10
 
3569
 
 
3570
        Determine the missing revisions up to a specific revision on this
 
3571
        branch::
 
3572
 
 
3573
            bzr missing --my-revision ..-10
 
3574
    """
 
3575
 
 
3576
    _see_also = ['merge', 'pull']
 
3577
    takes_args = ['other_branch?']
 
3578
    takes_options = [
 
3579
        Option('reverse', 'Reverse the order of revisions.'),
 
3580
        Option('mine-only',
 
3581
               'Display changes in the local branch only.'),
 
3582
        Option('this' , 'Same as --mine-only.'),
 
3583
        Option('theirs-only',
 
3584
               'Display changes in the remote branch only.'),
 
3585
        Option('other', 'Same as --theirs-only.'),
 
3586
        'log-format',
 
3587
        'show-ids',
 
3588
        'verbose',
 
3589
        custom_help('revision',
 
3590
             help='Filter on other branch revisions (inclusive). '
 
3591
                'See "help revisionspec" for details.'),
 
3592
        Option('my-revision',
 
3593
            type=_parse_revision_str,
 
3594
            help='Filter on local branch revisions (inclusive). '
 
3595
                'See "help revisionspec" for details.'),
 
3596
        Option('include-merges', 'Show merged revisions.'),
 
3597
        ]
 
3598
    encoding_type = 'replace'
 
3599
 
 
3600
    @display_command
 
3601
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3602
            theirs_only=False,
 
3603
            log_format=None, long=False, short=False, line=False,
 
3604
            show_ids=False, verbose=False, this=False, other=False,
 
3605
            include_merges=False, revision=None, my_revision=None):
 
3606
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3607
        def message(s):
 
3608
            if not is_quiet():
 
3609
                self.outf.write(s)
 
3610
 
 
3611
        if this:
 
3612
            mine_only = this
 
3613
        if other:
 
3614
            theirs_only = other
 
3615
        # TODO: We should probably check that we don't have mine-only and
 
3616
        #       theirs-only set, but it gets complicated because we also have
 
3617
        #       this and other which could be used.
 
3618
        restrict = 'all'
 
3619
        if mine_only:
 
3620
            restrict = 'local'
 
3621
        elif theirs_only:
 
3622
            restrict = 'remote'
 
3623
 
 
3624
        local_branch = Branch.open_containing(u".")[0]
 
3625
        parent = local_branch.get_parent()
 
3626
        if other_branch is None:
 
3627
            other_branch = parent
 
3628
            if other_branch is None:
 
3629
                raise errors.BzrCommandError("No peer location known"
 
3630
                                             " or specified.")
 
3631
            display_url = urlutils.unescape_for_display(parent,
 
3632
                                                        self.outf.encoding)
 
3633
            message("Using saved parent location: "
 
3634
                    + display_url + "\n")
 
3635
 
 
3636
        remote_branch = Branch.open(other_branch)
 
3637
        if remote_branch.base == local_branch.base:
 
3638
            remote_branch = local_branch
 
3639
 
 
3640
        local_revid_range = _revision_range_to_revid_range(
 
3641
            _get_revision_range(my_revision, local_branch,
 
3642
                self.name()))
 
3643
 
 
3644
        remote_revid_range = _revision_range_to_revid_range(
 
3645
            _get_revision_range(revision,
 
3646
                remote_branch, self.name()))
 
3647
 
 
3648
        local_branch.lock_read()
 
3649
        try:
 
3650
            remote_branch.lock_read()
 
3651
            try:
 
3652
                local_extra, remote_extra = find_unmerged(
 
3653
                    local_branch, remote_branch, restrict,
 
3654
                    backward=not reverse,
 
3655
                    include_merges=include_merges,
 
3656
                    local_revid_range=local_revid_range,
 
3657
                    remote_revid_range=remote_revid_range)
 
3658
 
 
3659
                if log_format is None:
 
3660
                    registry = log.log_formatter_registry
 
3661
                    log_format = registry.get_default(local_branch)
 
3662
                lf = log_format(to_file=self.outf,
 
3663
                                show_ids=show_ids,
 
3664
                                show_timezone='original')
 
3665
 
 
3666
                status_code = 0
 
3667
                if local_extra and not theirs_only:
 
3668
                    message("You have %d extra revision(s):\n" %
 
3669
                        len(local_extra))
 
3670
                    for revision in iter_log_revisions(local_extra,
 
3671
                                        local_branch.repository,
 
3672
                                        verbose):
 
3673
                        lf.log_revision(revision)
 
3674
                    printed_local = True
 
3675
                    status_code = 1
 
3676
                else:
 
3677
                    printed_local = False
 
3678
 
 
3679
                if remote_extra and not mine_only:
 
3680
                    if printed_local is True:
 
3681
                        message("\n\n\n")
 
3682
                    message("You are missing %d revision(s):\n" %
 
3683
                        len(remote_extra))
 
3684
                    for revision in iter_log_revisions(remote_extra,
 
3685
                                        remote_branch.repository,
 
3686
                                        verbose):
 
3687
                        lf.log_revision(revision)
 
3688
                    status_code = 1
 
3689
 
 
3690
                if mine_only and not local_extra:
 
3691
                    # We checked local, and found nothing extra
 
3692
                    message('This branch is up to date.\n')
 
3693
                elif theirs_only and not remote_extra:
 
3694
                    # We checked remote, and found nothing extra
 
3695
                    message('Other branch is up to date.\n')
 
3696
                elif not (mine_only or theirs_only or local_extra or
 
3697
                          remote_extra):
 
3698
                    # We checked both branches, and neither one had extra
 
3699
                    # revisions
 
3700
                    message("Branches are up to date.\n")
 
3701
            finally:
 
3702
                remote_branch.unlock()
 
3703
        finally:
 
3704
            local_branch.unlock()
 
3705
        if not status_code and parent is None and other_branch is not None:
 
3706
            local_branch.lock_write()
 
3707
            try:
 
3708
                # handle race conditions - a parent might be set while we run.
 
3709
                if local_branch.get_parent() is None:
 
3710
                    local_branch.set_parent(remote_branch.base)
 
3711
            finally:
 
3712
                local_branch.unlock()
 
3713
        return status_code
 
3714
 
 
3715
 
 
3716
class cmd_pack(Command):
 
3717
    """Compress the data within a repository."""
 
3718
 
 
3719
    _see_also = ['repositories']
 
3720
    takes_args = ['branch_or_repo?']
 
3721
 
 
3722
    def run(self, branch_or_repo='.'):
 
3723
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3724
        try:
 
3725
            branch = dir.open_branch()
 
3726
            repository = branch.repository
 
3727
        except errors.NotBranchError:
 
3728
            repository = dir.open_repository()
 
3729
        repository.pack()
 
3730
 
 
3731
 
 
3732
class cmd_plugins(Command):
 
3733
    """List the installed plugins.
 
3734
    
 
3735
    This command displays the list of installed plugins including
 
3736
    version of plugin and a short description of each.
 
3737
 
 
3738
    --verbose shows the path where each plugin is located.
 
3739
 
 
3740
    A plugin is an external component for Bazaar that extends the
 
3741
    revision control system, by adding or replacing code in Bazaar.
 
3742
    Plugins can do a variety of things, including overriding commands,
 
3743
    adding new commands, providing additional network transports and
 
3744
    customizing log output.
 
3745
 
 
3746
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3747
    information on plugins including where to find them and how to
 
3748
    install them. Instructions are also provided there on how to
 
3749
    write new plugins using the Python programming language.
 
3750
    """
 
3751
    takes_options = ['verbose']
 
3752
 
 
3753
    @display_command
 
3754
    def run(self, verbose=False):
 
3755
        import bzrlib.plugin
 
3756
        from inspect import getdoc
 
3757
        result = []
 
3758
        for name, plugin in bzrlib.plugin.plugins().items():
 
3759
            version = plugin.__version__
 
3760
            if version == 'unknown':
 
3761
                version = ''
 
3762
            name_ver = '%s %s' % (name, version)
 
3763
            d = getdoc(plugin.module)
 
3764
            if d:
 
3765
                doc = d.split('\n')[0]
 
3766
            else:
 
3767
                doc = '(no description)'
 
3768
            result.append((name_ver, doc, plugin.path()))
 
3769
        for name_ver, doc, path in sorted(result):
 
3770
            print name_ver
 
3771
            print '   ', doc
 
3772
            if verbose:
 
3773
                print '   ', path
 
3774
            print
 
3775
 
 
3776
 
 
3777
class cmd_testament(Command):
 
3778
    """Show testament (signing-form) of a revision."""
 
3779
    takes_options = [
 
3780
            'revision',
 
3781
            Option('long', help='Produce long-format testament.'),
 
3782
            Option('strict',
 
3783
                   help='Produce a strict-format testament.')]
 
3784
    takes_args = ['branch?']
 
3785
    @display_command
 
3786
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3787
        from bzrlib.testament import Testament, StrictTestament
 
3788
        if strict is True:
 
3789
            testament_class = StrictTestament
 
3790
        else:
 
3791
            testament_class = Testament
 
3792
        if branch == '.':
 
3793
            b = Branch.open_containing(branch)[0]
 
3794
        else:
 
3795
            b = Branch.open(branch)
 
3796
        b.lock_read()
 
3797
        try:
 
3798
            if revision is None:
 
3799
                rev_id = b.last_revision()
 
3800
            else:
 
3801
                rev_id = revision[0].as_revision_id(b)
 
3802
            t = testament_class.from_revision(b.repository, rev_id)
 
3803
            if long:
 
3804
                sys.stdout.writelines(t.as_text_lines())
 
3805
            else:
 
3806
                sys.stdout.write(t.as_short_text())
 
3807
        finally:
 
3808
            b.unlock()
 
3809
 
 
3810
 
 
3811
class cmd_annotate(Command):
 
3812
    """Show the origin of each line in a file.
 
3813
 
 
3814
    This prints out the given file with an annotation on the left side
 
3815
    indicating which revision, author and date introduced the change.
 
3816
 
 
3817
    If the origin is the same for a run of consecutive lines, it is 
 
3818
    shown only at the top, unless the --all option is given.
 
3819
    """
 
3820
    # TODO: annotate directories; showing when each file was last changed
 
3821
    # TODO: if the working copy is modified, show annotations on that 
 
3822
    #       with new uncommitted lines marked
 
3823
    aliases = ['ann', 'blame', 'praise']
 
3824
    takes_args = ['filename']
 
3825
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3826
                     Option('long', help='Show commit date in annotations.'),
 
3827
                     'revision',
 
3828
                     'show-ids',
 
3829
                     ]
 
3830
    encoding_type = 'exact'
 
3831
 
 
3832
    @display_command
 
3833
    def run(self, filename, all=False, long=False, revision=None,
 
3834
            show_ids=False):
 
3835
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
3836
        wt, branch, relpath = \
 
3837
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3838
        if wt is not None:
 
3839
            wt.lock_read()
 
3840
        else:
 
3841
            branch.lock_read()
 
3842
        try:
 
3843
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
3844
            if wt is not None:
 
3845
                file_id = wt.path2id(relpath)
 
3846
            else:
 
3847
                file_id = tree.path2id(relpath)
 
3848
            if file_id is None:
 
3849
                raise errors.NotVersionedError(filename)
 
3850
            file_version = tree.inventory[file_id].revision
 
3851
            if wt is not None and revision is None:
 
3852
                # If there is a tree and we're not annotating historical
 
3853
                # versions, annotate the working tree's content.
 
3854
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
3855
                    show_ids=show_ids)
 
3856
            else:
 
3857
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3858
                              show_ids=show_ids)
 
3859
        finally:
 
3860
            if wt is not None:
 
3861
                wt.unlock()
 
3862
            else:
 
3863
                branch.unlock()
 
3864
 
 
3865
 
 
3866
class cmd_re_sign(Command):
 
3867
    """Create a digital signature for an existing revision."""
 
3868
    # TODO be able to replace existing ones.
 
3869
 
 
3870
    hidden = True # is this right ?
 
3871
    takes_args = ['revision_id*']
 
3872
    takes_options = ['revision']
 
3873
    
 
3874
    def run(self, revision_id_list=None, revision=None):
 
3875
        if revision_id_list is not None and revision is not None:
 
3876
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3877
        if revision_id_list is None and revision is None:
 
3878
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3879
        b = WorkingTree.open_containing(u'.')[0].branch
 
3880
        b.lock_write()
 
3881
        try:
 
3882
            return self._run(b, revision_id_list, revision)
 
3883
        finally:
 
3884
            b.unlock()
 
3885
 
 
3886
    def _run(self, b, revision_id_list, revision):
 
3887
        import bzrlib.gpg as gpg
 
3888
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3889
        if revision_id_list is not None:
 
3890
            b.repository.start_write_group()
 
3891
            try:
 
3892
                for revision_id in revision_id_list:
 
3893
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3894
            except:
 
3895
                b.repository.abort_write_group()
 
3896
                raise
 
3897
            else:
 
3898
                b.repository.commit_write_group()
 
3899
        elif revision is not None:
 
3900
            if len(revision) == 1:
 
3901
                revno, rev_id = revision[0].in_history(b)
 
3902
                b.repository.start_write_group()
 
3903
                try:
 
3904
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3905
                except:
 
3906
                    b.repository.abort_write_group()
 
3907
                    raise
 
3908
                else:
 
3909
                    b.repository.commit_write_group()
 
3910
            elif len(revision) == 2:
 
3911
                # are they both on rh- if so we can walk between them
 
3912
                # might be nice to have a range helper for arbitrary
 
3913
                # revision paths. hmm.
 
3914
                from_revno, from_revid = revision[0].in_history(b)
 
3915
                to_revno, to_revid = revision[1].in_history(b)
 
3916
                if to_revid is None:
 
3917
                    to_revno = b.revno()
 
3918
                if from_revno is None or to_revno is None:
 
3919
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3920
                b.repository.start_write_group()
 
3921
                try:
 
3922
                    for revno in range(from_revno, to_revno + 1):
 
3923
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3924
                                                   gpg_strategy)
 
3925
                except:
 
3926
                    b.repository.abort_write_group()
 
3927
                    raise
 
3928
                else:
 
3929
                    b.repository.commit_write_group()
 
3930
            else:
 
3931
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3932
 
 
3933
 
 
3934
class cmd_bind(Command):
 
3935
    """Convert the current branch into a checkout of the supplied branch.
 
3936
 
 
3937
    Once converted into a checkout, commits must succeed on the master branch
 
3938
    before they will be applied to the local branch.
 
3939
 
 
3940
    Bound branches use the nickname of its master branch unless it is set
 
3941
    locally, in which case binding will update the the local nickname to be
 
3942
    that of the master.
 
3943
    """
 
3944
 
 
3945
    _see_also = ['checkouts', 'unbind']
 
3946
    takes_args = ['location?']
 
3947
    takes_options = []
 
3948
 
 
3949
    def run(self, location=None):
 
3950
        b, relpath = Branch.open_containing(u'.')
 
3951
        if location is None:
 
3952
            try:
 
3953
                location = b.get_old_bound_location()
 
3954
            except errors.UpgradeRequired:
 
3955
                raise errors.BzrCommandError('No location supplied.  '
 
3956
                    'This format does not remember old locations.')
 
3957
            else:
 
3958
                if location is None:
 
3959
                    raise errors.BzrCommandError('No location supplied and no '
 
3960
                        'previous location known')
 
3961
        b_other = Branch.open(location)
 
3962
        try:
 
3963
            b.bind(b_other)
 
3964
        except errors.DivergedBranches:
 
3965
            raise errors.BzrCommandError('These branches have diverged.'
 
3966
                                         ' Try merging, and then bind again.')
 
3967
        if b.get_config().has_explicit_nickname():
 
3968
            b.nick = b_other.nick
 
3969
 
 
3970
 
 
3971
class cmd_unbind(Command):
 
3972
    """Convert the current checkout into a regular branch.
 
3973
 
 
3974
    After unbinding, the local branch is considered independent and subsequent
 
3975
    commits will be local only.
 
3976
    """
 
3977
 
 
3978
    _see_also = ['checkouts', 'bind']
 
3979
    takes_args = []
 
3980
    takes_options = []
 
3981
 
 
3982
    def run(self):
 
3983
        b, relpath = Branch.open_containing(u'.')
 
3984
        if not b.unbind():
 
3985
            raise errors.BzrCommandError('Local branch is not bound')
 
3986
 
 
3987
 
 
3988
class cmd_uncommit(Command):
 
3989
    """Remove the last committed revision.
 
3990
 
 
3991
    --verbose will print out what is being removed.
 
3992
    --dry-run will go through all the motions, but not actually
 
3993
    remove anything.
 
3994
 
 
3995
    If --revision is specified, uncommit revisions to leave the branch at the
 
3996
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3997
    branch at revision 15.
 
3998
 
 
3999
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4000
    it may make is to restore any pending merges that were present before
 
4001
    the commit.
 
4002
    """
 
4003
 
 
4004
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
4005
    # unreferenced information in 'branch-as-repository' branches.
 
4006
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
4007
    # information in shared branches as well.
 
4008
    _see_also = ['commit']
 
4009
    takes_options = ['verbose', 'revision',
 
4010
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4011
                    Option('force', help='Say yes to all questions.'),
 
4012
                    Option('local',
 
4013
                           help="Only remove the commits from the local branch"
 
4014
                                " when in a checkout."
 
4015
                           ),
 
4016
                    ]
 
4017
    takes_args = ['location?']
 
4018
    aliases = []
 
4019
    encoding_type = 'replace'
 
4020
 
 
4021
    def run(self, location=None,
 
4022
            dry_run=False, verbose=False,
 
4023
            revision=None, force=False, local=False):
 
4024
        if location is None:
 
4025
            location = u'.'
 
4026
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4027
        try:
 
4028
            tree = control.open_workingtree()
 
4029
            b = tree.branch
 
4030
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4031
            tree = None
 
4032
            b = control.open_branch()
 
4033
 
 
4034
        if tree is not None:
 
4035
            tree.lock_write()
 
4036
        else:
 
4037
            b.lock_write()
 
4038
        try:
 
4039
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4040
                             local=local)
 
4041
        finally:
 
4042
            if tree is not None:
 
4043
                tree.unlock()
 
4044
            else:
 
4045
                b.unlock()
 
4046
 
 
4047
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4048
        from bzrlib.log import log_formatter, show_log
 
4049
        from bzrlib.uncommit import uncommit
 
4050
 
 
4051
        last_revno, last_rev_id = b.last_revision_info()
 
4052
 
 
4053
        rev_id = None
 
4054
        if revision is None:
 
4055
            revno = last_revno
 
4056
            rev_id = last_rev_id
 
4057
        else:
 
4058
            # 'bzr uncommit -r 10' actually means uncommit
 
4059
            # so that the final tree is at revno 10.
 
4060
            # but bzrlib.uncommit.uncommit() actually uncommits
 
4061
            # the revisions that are supplied.
 
4062
            # So we need to offset it by one
 
4063
            revno = revision[0].in_history(b).revno + 1
 
4064
            if revno <= last_revno:
 
4065
                rev_id = b.get_rev_id(revno)
 
4066
 
 
4067
        if rev_id is None or _mod_revision.is_null(rev_id):
 
4068
            self.outf.write('No revisions to uncommit.\n')
 
4069
            return 1
 
4070
 
 
4071
        lf = log_formatter('short',
 
4072
                           to_file=self.outf,
 
4073
                           show_timezone='original')
 
4074
 
 
4075
        show_log(b,
 
4076
                 lf,
 
4077
                 verbose=False,
 
4078
                 direction='forward',
 
4079
                 start_revision=revno,
 
4080
                 end_revision=last_revno)
 
4081
 
 
4082
        if dry_run:
 
4083
            print 'Dry-run, pretending to remove the above revisions.'
 
4084
            if not force:
 
4085
                val = raw_input('Press <enter> to continue')
 
4086
        else:
 
4087
            print 'The above revision(s) will be removed.'
 
4088
            if not force:
 
4089
                val = raw_input('Are you sure [y/N]? ')
 
4090
                if val.lower() not in ('y', 'yes'):
 
4091
                    print 'Canceled'
 
4092
                    return 0
 
4093
 
 
4094
        mutter('Uncommitting from {%s} to {%s}',
 
4095
               last_rev_id, rev_id)
 
4096
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
4097
                 revno=revno, local=local)
 
4098
        note('You can restore the old tip by running:\n'
 
4099
             '  bzr pull . -r revid:%s', last_rev_id)
 
4100
 
 
4101
 
 
4102
class cmd_break_lock(Command):
 
4103
    """Break a dead lock on a repository, branch or working directory.
 
4104
 
 
4105
    CAUTION: Locks should only be broken when you are sure that the process
 
4106
    holding the lock has been stopped.
 
4107
 
 
4108
    You can get information on what locks are open via the 'bzr info' command.
 
4109
    
 
4110
    :Examples:
 
4111
        bzr break-lock
 
4112
    """
 
4113
    takes_args = ['location?']
 
4114
 
 
4115
    def run(self, location=None, show=False):
 
4116
        if location is None:
 
4117
            location = u'.'
 
4118
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4119
        try:
 
4120
            control.break_lock()
 
4121
        except NotImplementedError:
 
4122
            pass
 
4123
        
 
4124
 
 
4125
class cmd_wait_until_signalled(Command):
 
4126
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4127
 
 
4128
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4129
    """
 
4130
 
 
4131
    hidden = True
 
4132
 
 
4133
    def run(self):
 
4134
        sys.stdout.write("running\n")
 
4135
        sys.stdout.flush()
 
4136
        sys.stdin.readline()
 
4137
 
 
4138
 
 
4139
class cmd_serve(Command):
 
4140
    """Run the bzr server."""
 
4141
 
 
4142
    aliases = ['server']
 
4143
 
 
4144
    takes_options = [
 
4145
        Option('inet',
 
4146
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4147
        Option('port',
 
4148
               help='Listen for connections on nominated port of the form '
 
4149
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4150
                    'result in a dynamically allocated port.  The default port is '
 
4151
                    '4155.',
 
4152
               type=str),
 
4153
        Option('directory',
 
4154
               help='Serve contents of this directory.',
 
4155
               type=unicode),
 
4156
        Option('allow-writes',
 
4157
               help='By default the server is a readonly server.  Supplying '
 
4158
                    '--allow-writes enables write access to the contents of '
 
4159
                    'the served directory and below.'
 
4160
                ),
 
4161
        ]
 
4162
 
 
4163
    def run_smart_server(self, smart_server):
 
4164
        """Run 'smart_server' forever, with no UI output at all."""
 
4165
        # For the duration of this server, no UI output is permitted. note
 
4166
        # that this may cause problems with blackbox tests. This should be
 
4167
        # changed with care though, as we dont want to use bandwidth sending
 
4168
        # progress over stderr to smart server clients!
 
4169
        from bzrlib import lockdir
 
4170
        old_factory = ui.ui_factory
 
4171
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4172
        try:
 
4173
            ui.ui_factory = ui.SilentUIFactory()
 
4174
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4175
            smart_server.serve()
 
4176
        finally:
 
4177
            ui.ui_factory = old_factory
 
4178
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4179
 
 
4180
    def get_host_and_port(self, port):
 
4181
        """Return the host and port to run the smart server on.
 
4182
 
 
4183
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4184
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4185
 
 
4186
        If 'port' has a colon in it, the string before the colon will be
 
4187
        interpreted as the host.
 
4188
 
 
4189
        :param port: A string of the port to run the server on.
 
4190
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4191
            and port is an integer TCP/IP port.
 
4192
        """
 
4193
        from bzrlib.smart import medium
 
4194
        host = medium.BZR_DEFAULT_INTERFACE
 
4195
        if port is None:
 
4196
            port = medium.BZR_DEFAULT_PORT
 
4197
        else:
 
4198
            if ':' in port:
 
4199
                host, port = port.split(':')
 
4200
            port = int(port)
 
4201
        return host, port
 
4202
 
 
4203
    def get_smart_server(self, transport, inet, port):
 
4204
        """Construct a smart server.
 
4205
 
 
4206
        :param transport: The base transport from which branches will be
 
4207
            served.
 
4208
        :param inet: If True, serve over stdin and stdout. Used for running
 
4209
            from inet.
 
4210
        :param port: The port to listen on. By default, it's `
 
4211
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4212
            information.
 
4213
        :return: A smart server.
 
4214
        """
 
4215
        from bzrlib.smart import medium, server
 
4216
        if inet:
 
4217
            smart_server = medium.SmartServerPipeStreamMedium(
 
4218
                sys.stdin, sys.stdout, transport)
 
4219
        else:
 
4220
            host, port = self.get_host_and_port(port)
 
4221
            smart_server = server.SmartTCPServer(
 
4222
                transport, host=host, port=port)
 
4223
            note('listening on port: %s' % smart_server.port)
 
4224
        return smart_server
 
4225
 
 
4226
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4227
        from bzrlib.transport import get_transport
 
4228
        from bzrlib.transport.chroot import ChrootServer
 
4229
        if directory is None:
 
4230
            directory = os.getcwd()
 
4231
        url = urlutils.local_path_to_url(directory)
 
4232
        if not allow_writes:
 
4233
            url = 'readonly+' + url
 
4234
        chroot_server = ChrootServer(get_transport(url))
 
4235
        chroot_server.setUp()
 
4236
        t = get_transport(chroot_server.get_url())
 
4237
        smart_server = self.get_smart_server(t, inet, port)
 
4238
        self.run_smart_server(smart_server)
 
4239
 
 
4240
 
 
4241
class cmd_join(Command):
 
4242
    """Combine a subtree into its containing tree.
 
4243
    
 
4244
    This command is for experimental use only.  It requires the target tree
 
4245
    to be in dirstate-with-subtree format, which cannot be converted into
 
4246
    earlier formats.
 
4247
 
 
4248
    The TREE argument should be an independent tree, inside another tree, but
 
4249
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4250
    running "bzr branch" with the target inside a tree.)
 
4251
 
 
4252
    The result is a combined tree, with the subtree no longer an independant
 
4253
    part.  This is marked as a merge of the subtree into the containing tree,
 
4254
    and all history is preserved.
 
4255
 
 
4256
    If --reference is specified, the subtree retains its independence.  It can
 
4257
    be branched by itself, and can be part of multiple projects at the same
 
4258
    time.  But operations performed in the containing tree, such as commit
 
4259
    and merge, will recurse into the subtree.
 
4260
    """
 
4261
 
 
4262
    _see_also = ['split']
 
4263
    takes_args = ['tree']
 
4264
    takes_options = [
 
4265
            Option('reference', help='Join by reference.'),
 
4266
            ]
 
4267
    hidden = True
 
4268
 
 
4269
    def run(self, tree, reference=False):
 
4270
        sub_tree = WorkingTree.open(tree)
 
4271
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4272
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4273
        repo = containing_tree.branch.repository
 
4274
        if not repo.supports_rich_root():
 
4275
            raise errors.BzrCommandError(
 
4276
                "Can't join trees because %s doesn't support rich root data.\n"
 
4277
                "You can use bzr upgrade on the repository."
 
4278
                % (repo,))
 
4279
        if reference:
 
4280
            try:
 
4281
                containing_tree.add_reference(sub_tree)
 
4282
            except errors.BadReferenceTarget, e:
 
4283
                # XXX: Would be better to just raise a nicely printable
 
4284
                # exception from the real origin.  Also below.  mbp 20070306
 
4285
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4286
                                             (tree, e.reason))
 
4287
        else:
 
4288
            try:
 
4289
                containing_tree.subsume(sub_tree)
 
4290
            except errors.BadSubsumeSource, e:
 
4291
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
4292
                                             (tree, e.reason))
 
4293
 
 
4294
 
 
4295
class cmd_split(Command):
 
4296
    """Split a subdirectory of a tree into a separate tree.
 
4297
 
 
4298
    This command will produce a target tree in a format that supports
 
4299
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4300
    converted into earlier formats like 'dirstate-tags'.
 
4301
 
 
4302
    The TREE argument should be a subdirectory of a working tree.  That
 
4303
    subdirectory will be converted into an independent tree, with its own
 
4304
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4305
    """
 
4306
 
 
4307
    # join is not un-hidden yet
 
4308
    #_see_also = ['join']
 
4309
    takes_args = ['tree']
 
4310
 
 
4311
    def run(self, tree):
 
4312
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4313
        sub_id = containing_tree.path2id(subdir)
 
4314
        if sub_id is None:
 
4315
            raise errors.NotVersionedError(subdir)
 
4316
        try:
 
4317
            containing_tree.extract(sub_id)
 
4318
        except errors.RootNotRich:
 
4319
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4320
 
 
4321
 
 
4322
class cmd_merge_directive(Command):
 
4323
    """Generate a merge directive for auto-merge tools.
 
4324
 
 
4325
    A directive requests a merge to be performed, and also provides all the
 
4326
    information necessary to do so.  This means it must either include a
 
4327
    revision bundle, or the location of a branch containing the desired
 
4328
    revision.
 
4329
 
 
4330
    A submit branch (the location to merge into) must be supplied the first
 
4331
    time the command is issued.  After it has been supplied once, it will
 
4332
    be remembered as the default.
 
4333
 
 
4334
    A public branch is optional if a revision bundle is supplied, but required
 
4335
    if --diff or --plain is specified.  It will be remembered as the default
 
4336
    after the first use.
 
4337
    """
 
4338
 
 
4339
    takes_args = ['submit_branch?', 'public_branch?']
 
4340
 
 
4341
    hidden = True
 
4342
 
 
4343
    _see_also = ['send']
 
4344
 
 
4345
    takes_options = [
 
4346
        RegistryOption.from_kwargs('patch-type',
 
4347
            'The type of patch to include in the directive.',
 
4348
            title='Patch type',
 
4349
            value_switches=True,
 
4350
            enum_switch=False,
 
4351
            bundle='Bazaar revision bundle (default).',
 
4352
            diff='Normal unified diff.',
 
4353
            plain='No patch, just directive.'),
 
4354
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4355
        Option('mail-to', type=str,
 
4356
            help='Instead of printing the directive, email to this address.'),
 
4357
        Option('message', type=str, short_name='m',
 
4358
            help='Message to use when committing this merge.')
 
4359
        ]
 
4360
 
 
4361
    encoding_type = 'exact'
 
4362
 
 
4363
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4364
            sign=False, revision=None, mail_to=None, message=None):
 
4365
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4366
        include_patch, include_bundle = {
 
4367
            'plain': (False, False),
 
4368
            'diff': (True, False),
 
4369
            'bundle': (True, True),
 
4370
            }[patch_type]
 
4371
        branch = Branch.open('.')
 
4372
        stored_submit_branch = branch.get_submit_branch()
 
4373
        if submit_branch is None:
 
4374
            submit_branch = stored_submit_branch
 
4375
        else:
 
4376
            if stored_submit_branch is None:
 
4377
                branch.set_submit_branch(submit_branch)
 
4378
        if submit_branch is None:
 
4379
            submit_branch = branch.get_parent()
 
4380
        if submit_branch is None:
 
4381
            raise errors.BzrCommandError('No submit branch specified or known')
 
4382
 
 
4383
        stored_public_branch = branch.get_public_branch()
 
4384
        if public_branch is None:
 
4385
            public_branch = stored_public_branch
 
4386
        elif stored_public_branch is None:
 
4387
            branch.set_public_branch(public_branch)
 
4388
        if not include_bundle and public_branch is None:
 
4389
            raise errors.BzrCommandError('No public branch specified or'
 
4390
                                         ' known')
 
4391
        base_revision_id = None
 
4392
        if revision is not None:
 
4393
            if len(revision) > 2:
 
4394
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4395
                    'at most two one revision identifiers')
 
4396
            revision_id = revision[-1].as_revision_id(branch)
 
4397
            if len(revision) == 2:
 
4398
                base_revision_id = revision[0].as_revision_id(branch)
 
4399
        else:
 
4400
            revision_id = branch.last_revision()
 
4401
        revision_id = ensure_null(revision_id)
 
4402
        if revision_id == NULL_REVISION:
 
4403
            raise errors.BzrCommandError('No revisions to bundle.')
 
4404
        directive = merge_directive.MergeDirective2.from_objects(
 
4405
            branch.repository, revision_id, time.time(),
 
4406
            osutils.local_time_offset(), submit_branch,
 
4407
            public_branch=public_branch, include_patch=include_patch,
 
4408
            include_bundle=include_bundle, message=message,
 
4409
            base_revision_id=base_revision_id)
 
4410
        if mail_to is None:
 
4411
            if sign:
 
4412
                self.outf.write(directive.to_signed(branch))
 
4413
            else:
 
4414
                self.outf.writelines(directive.to_lines())
 
4415
        else:
 
4416
            message = directive.to_email(mail_to, branch, sign)
 
4417
            s = SMTPConnection(branch.get_config())
 
4418
            s.send_email(message)
 
4419
 
 
4420
 
 
4421
class cmd_send(Command):
 
4422
    """Mail or create a merge-directive for submitting changes.
 
4423
 
 
4424
    A merge directive provides many things needed for requesting merges:
 
4425
 
 
4426
    * A machine-readable description of the merge to perform
 
4427
 
 
4428
    * An optional patch that is a preview of the changes requested
 
4429
 
 
4430
    * An optional bundle of revision data, so that the changes can be applied
 
4431
      directly from the merge directive, without retrieving data from a
 
4432
      branch.
 
4433
 
 
4434
    If --no-bundle is specified, then public_branch is needed (and must be
 
4435
    up-to-date), so that the receiver can perform the merge using the
 
4436
    public_branch.  The public_branch is always included if known, so that
 
4437
    people can check it later.
 
4438
 
 
4439
    The submit branch defaults to the parent, but can be overridden.  Both
 
4440
    submit branch and public branch will be remembered if supplied.
 
4441
 
 
4442
    If a public_branch is known for the submit_branch, that public submit
 
4443
    branch is used in the merge instructions.  This means that a local mirror
 
4444
    can be used as your actual submit branch, once you have set public_branch
 
4445
    for that mirror.
 
4446
 
 
4447
    Mail is sent using your preferred mail program.  This should be transparent
 
4448
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4449
    If the preferred client can't be found (or used), your editor will be used.
 
4450
    
 
4451
    To use a specific mail program, set the mail_client configuration option.
 
4452
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4453
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4454
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4455
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
4456
 
 
4457
    If mail is being sent, a to address is required.  This can be supplied
 
4458
    either on the commandline, by setting the submit_to configuration
 
4459
    option in the branch itself or the child_submit_to configuration option 
 
4460
    in the submit branch.
 
4461
 
 
4462
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4463
    merge directive format 2.  It is significantly faster and smaller than
 
4464
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4465
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4466
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4467
    
 
4468
    Merge directives are applied using the merge command or the pull command.
 
4469
    """
 
4470
 
 
4471
    encoding_type = 'exact'
 
4472
 
 
4473
    _see_also = ['merge', 'pull']
 
4474
 
 
4475
    takes_args = ['submit_branch?', 'public_branch?']
 
4476
 
 
4477
    takes_options = [
 
4478
        Option('no-bundle',
 
4479
               help='Do not include a bundle in the merge directive.'),
 
4480
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4481
               ' directive.'),
 
4482
        Option('remember',
 
4483
               help='Remember submit and public branch.'),
 
4484
        Option('from',
 
4485
               help='Branch to generate the submission from, '
 
4486
               'rather than the one containing the working directory.',
 
4487
               short_name='f',
 
4488
               type=unicode),
 
4489
        Option('output', short_name='o',
 
4490
               help='Write merge directive to this file; '
 
4491
                    'use - for stdout.',
 
4492
               type=unicode),
 
4493
        Option('mail-to', help='Mail the request to this address.',
 
4494
               type=unicode),
 
4495
        'revision',
 
4496
        'message',
 
4497
        RegistryOption.from_kwargs('format',
 
4498
        'Use the specified output format.',
 
4499
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4500
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4501
        ]
 
4502
 
 
4503
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4504
            no_patch=False, revision=None, remember=False, output=None,
 
4505
            format='4', mail_to=None, message=None, **kwargs):
 
4506
        return self._run(submit_branch, revision, public_branch, remember,
 
4507
                         format, no_bundle, no_patch, output,
 
4508
                         kwargs.get('from', '.'), mail_to, message)
 
4509
 
 
4510
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4511
             no_bundle, no_patch, output, from_, mail_to, message):
 
4512
        from bzrlib.revision import NULL_REVISION
 
4513
        branch = Branch.open_containing(from_)[0]
 
4514
        if output is None:
 
4515
            outfile = cStringIO.StringIO()
 
4516
        elif output == '-':
 
4517
            outfile = self.outf
 
4518
        else:
 
4519
            outfile = open(output, 'wb')
 
4520
        # we may need to write data into branch's repository to calculate
 
4521
        # the data to send.
 
4522
        branch.lock_write()
 
4523
        try:
 
4524
            if output is None:
 
4525
                config = branch.get_config()
 
4526
                if mail_to is None:
 
4527
                    mail_to = config.get_user_option('submit_to')
 
4528
                mail_client = config.get_mail_client()
 
4529
            if remember and submit_branch is None:
 
4530
                raise errors.BzrCommandError(
 
4531
                    '--remember requires a branch to be specified.')
 
4532
            stored_submit_branch = branch.get_submit_branch()
 
4533
            remembered_submit_branch = None
 
4534
            if submit_branch is None:
 
4535
                submit_branch = stored_submit_branch
 
4536
                remembered_submit_branch = "submit"
 
4537
            else:
 
4538
                if stored_submit_branch is None or remember:
 
4539
                    branch.set_submit_branch(submit_branch)
 
4540
            if submit_branch is None:
 
4541
                submit_branch = branch.get_parent()
 
4542
                remembered_submit_branch = "parent"
 
4543
            if submit_branch is None:
 
4544
                raise errors.BzrCommandError('No submit branch known or'
 
4545
                                             ' specified')
 
4546
            if remembered_submit_branch is not None:
 
4547
                note('Using saved %s location "%s" to determine what '
 
4548
                        'changes to submit.', remembered_submit_branch,
 
4549
                        submit_branch)
 
4550
 
 
4551
            if mail_to is None:
 
4552
                submit_config = Branch.open(submit_branch).get_config()
 
4553
                mail_to = submit_config.get_user_option("child_submit_to")
 
4554
 
 
4555
            stored_public_branch = branch.get_public_branch()
 
4556
            if public_branch is None:
 
4557
                public_branch = stored_public_branch
 
4558
            elif stored_public_branch is None or remember:
 
4559
                branch.set_public_branch(public_branch)
 
4560
            if no_bundle and public_branch is None:
 
4561
                raise errors.BzrCommandError('No public branch specified or'
 
4562
                                             ' known')
 
4563
            base_revision_id = None
 
4564
            revision_id = None
 
4565
            if revision is not None:
 
4566
                if len(revision) > 2:
 
4567
                    raise errors.BzrCommandError('bzr send takes '
 
4568
                        'at most two one revision identifiers')
 
4569
                revision_id = revision[-1].as_revision_id(branch)
 
4570
                if len(revision) == 2:
 
4571
                    base_revision_id = revision[0].as_revision_id(branch)
 
4572
            if revision_id is None:
 
4573
                revision_id = branch.last_revision()
 
4574
            if revision_id == NULL_REVISION:
 
4575
                raise errors.BzrCommandError('No revisions to submit.')
 
4576
            if format == '4':
 
4577
                directive = merge_directive.MergeDirective2.from_objects(
 
4578
                    branch.repository, revision_id, time.time(),
 
4579
                    osutils.local_time_offset(), submit_branch,
 
4580
                    public_branch=public_branch, include_patch=not no_patch,
 
4581
                    include_bundle=not no_bundle, message=message,
 
4582
                    base_revision_id=base_revision_id)
 
4583
            elif format == '0.9':
 
4584
                if not no_bundle:
 
4585
                    if not no_patch:
 
4586
                        patch_type = 'bundle'
 
4587
                    else:
 
4588
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4589
                            ' permit bundle with no patch')
 
4590
                else:
 
4591
                    if not no_patch:
 
4592
                        patch_type = 'diff'
 
4593
                    else:
 
4594
                        patch_type = None
 
4595
                directive = merge_directive.MergeDirective.from_objects(
 
4596
                    branch.repository, revision_id, time.time(),
 
4597
                    osutils.local_time_offset(), submit_branch,
 
4598
                    public_branch=public_branch, patch_type=patch_type,
 
4599
                    message=message)
 
4600
 
 
4601
            outfile.writelines(directive.to_lines())
 
4602
            if output is None:
 
4603
                subject = '[MERGE] '
 
4604
                if message is not None:
 
4605
                    subject += message
 
4606
                else:
 
4607
                    revision = branch.repository.get_revision(revision_id)
 
4608
                    subject += revision.get_summary()
 
4609
                basename = directive.get_disk_name(branch)
 
4610
                mail_client.compose_merge_request(mail_to, subject,
 
4611
                                                  outfile.getvalue(), basename)
 
4612
        finally:
 
4613
            if output != '-':
 
4614
                outfile.close()
 
4615
            branch.unlock()
 
4616
 
 
4617
 
 
4618
class cmd_bundle_revisions(cmd_send):
 
4619
 
 
4620
    """Create a merge-directive for submitting changes.
 
4621
 
 
4622
    A merge directive provides many things needed for requesting merges:
 
4623
 
 
4624
    * A machine-readable description of the merge to perform
 
4625
 
 
4626
    * An optional patch that is a preview of the changes requested
 
4627
 
 
4628
    * An optional bundle of revision data, so that the changes can be applied
 
4629
      directly from the merge directive, without retrieving data from a
 
4630
      branch.
 
4631
 
 
4632
    If --no-bundle is specified, then public_branch is needed (and must be
 
4633
    up-to-date), so that the receiver can perform the merge using the
 
4634
    public_branch.  The public_branch is always included if known, so that
 
4635
    people can check it later.
 
4636
 
 
4637
    The submit branch defaults to the parent, but can be overridden.  Both
 
4638
    submit branch and public branch will be remembered if supplied.
 
4639
 
 
4640
    If a public_branch is known for the submit_branch, that public submit
 
4641
    branch is used in the merge instructions.  This means that a local mirror
 
4642
    can be used as your actual submit branch, once you have set public_branch
 
4643
    for that mirror.
 
4644
 
 
4645
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4646
    merge directive format 2.  It is significantly faster and smaller than
 
4647
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4648
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4649
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4650
    """
 
4651
 
 
4652
    takes_options = [
 
4653
        Option('no-bundle',
 
4654
               help='Do not include a bundle in the merge directive.'),
 
4655
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4656
               ' directive.'),
 
4657
        Option('remember',
 
4658
               help='Remember submit and public branch.'),
 
4659
        Option('from',
 
4660
               help='Branch to generate the submission from, '
 
4661
               'rather than the one containing the working directory.',
 
4662
               short_name='f',
 
4663
               type=unicode),
 
4664
        Option('output', short_name='o', help='Write directive to this file.',
 
4665
               type=unicode),
 
4666
        'revision',
 
4667
        RegistryOption.from_kwargs('format',
 
4668
        'Use the specified output format.',
 
4669
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4670
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4671
        ]
 
4672
    aliases = ['bundle']
 
4673
 
 
4674
    _see_also = ['send', 'merge']
 
4675
 
 
4676
    hidden = True
 
4677
 
 
4678
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4679
            no_patch=False, revision=None, remember=False, output=None,
 
4680
            format='4', **kwargs):
 
4681
        if output is None:
 
4682
            output = '-'
 
4683
        return self._run(submit_branch, revision, public_branch, remember,
 
4684
                         format, no_bundle, no_patch, output,
 
4685
                         kwargs.get('from', '.'), None, None)
 
4686
 
 
4687
 
 
4688
class cmd_tag(Command):
 
4689
    """Create, remove or modify a tag naming a revision.
 
4690
    
 
4691
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4692
    (--revision) option can be given -rtag:X, where X is any previously
 
4693
    created tag.
 
4694
 
 
4695
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4696
    along when you branch, push, pull or merge.
 
4697
 
 
4698
    It is an error to give a tag name that already exists unless you pass 
 
4699
    --force, in which case the tag is moved to point to the new revision.
 
4700
 
 
4701
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
4702
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
4703
    """
 
4704
 
 
4705
    _see_also = ['commit', 'tags']
 
4706
    takes_args = ['tag_name']
 
4707
    takes_options = [
 
4708
        Option('delete',
 
4709
            help='Delete this tag rather than placing it.',
 
4710
            ),
 
4711
        Option('directory',
 
4712
            help='Branch in which to place the tag.',
 
4713
            short_name='d',
 
4714
            type=unicode,
 
4715
            ),
 
4716
        Option('force',
 
4717
            help='Replace existing tags.',
 
4718
            ),
 
4719
        'revision',
 
4720
        ]
 
4721
 
 
4722
    def run(self, tag_name,
 
4723
            delete=None,
 
4724
            directory='.',
 
4725
            force=None,
 
4726
            revision=None,
 
4727
            ):
 
4728
        branch, relpath = Branch.open_containing(directory)
 
4729
        branch.lock_write()
 
4730
        try:
 
4731
            if delete:
 
4732
                branch.tags.delete_tag(tag_name)
 
4733
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4734
            else:
 
4735
                if revision:
 
4736
                    if len(revision) != 1:
 
4737
                        raise errors.BzrCommandError(
 
4738
                            "Tags can only be placed on a single revision, "
 
4739
                            "not on a range")
 
4740
                    revision_id = revision[0].as_revision_id(branch)
 
4741
                else:
 
4742
                    revision_id = branch.last_revision()
 
4743
                if (not force) and branch.tags.has_tag(tag_name):
 
4744
                    raise errors.TagAlreadyExists(tag_name)
 
4745
                branch.tags.set_tag(tag_name, revision_id)
 
4746
                self.outf.write('Created tag %s.\n' % tag_name)
 
4747
        finally:
 
4748
            branch.unlock()
 
4749
 
 
4750
 
 
4751
class cmd_tags(Command):
 
4752
    """List tags.
 
4753
 
 
4754
    This command shows a table of tag names and the revisions they reference.
 
4755
    """
 
4756
 
 
4757
    _see_also = ['tag']
 
4758
    takes_options = [
 
4759
        Option('directory',
 
4760
            help='Branch whose tags should be displayed.',
 
4761
            short_name='d',
 
4762
            type=unicode,
 
4763
            ),
 
4764
        RegistryOption.from_kwargs('sort',
 
4765
            'Sort tags by different criteria.', title='Sorting',
 
4766
            alpha='Sort tags lexicographically (default).',
 
4767
            time='Sort tags chronologically.',
 
4768
            ),
 
4769
        'show-ids',
 
4770
        'revision',
 
4771
    ]
 
4772
 
 
4773
    @display_command
 
4774
    def run(self,
 
4775
            directory='.',
 
4776
            sort='alpha',
 
4777
            show_ids=False,
 
4778
            revision=None,
 
4779
            ):
 
4780
        branch, relpath = Branch.open_containing(directory)
 
4781
 
 
4782
        tags = branch.tags.get_tag_dict().items()
 
4783
        if not tags:
 
4784
            return
 
4785
 
 
4786
        if revision:
 
4787
            branch.lock_read()
 
4788
            try:
 
4789
                graph = branch.repository.get_graph()
 
4790
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
4791
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
4792
                # only show revisions between revid1 and revid2 (inclusive)
 
4793
                tags = [(tag, revid) for tag, revid in tags if
 
4794
                    graph.is_between(revid, revid1, revid2)]
 
4795
            finally:
 
4796
                branch.unlock()
 
4797
        if sort == 'alpha':
 
4798
            tags.sort()
 
4799
        elif sort == 'time':
 
4800
            timestamps = {}
 
4801
            for tag, revid in tags:
 
4802
                try:
 
4803
                    revobj = branch.repository.get_revision(revid)
 
4804
                except errors.NoSuchRevision:
 
4805
                    timestamp = sys.maxint # place them at the end
 
4806
                else:
 
4807
                    timestamp = revobj.timestamp
 
4808
                timestamps[revid] = timestamp
 
4809
            tags.sort(key=lambda x: timestamps[x[1]])
 
4810
        if not show_ids:
 
4811
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4812
            revno_map = branch.get_revision_id_to_revno_map()
 
4813
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4814
                        for tag, revid in tags ]
 
4815
        for tag, revspec in tags:
 
4816
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4817
 
 
4818
 
 
4819
class cmd_reconfigure(Command):
 
4820
    """Reconfigure the type of a bzr directory.
 
4821
 
 
4822
    A target configuration must be specified.
 
4823
 
 
4824
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4825
    The order of preference is
 
4826
    1. For a lightweight checkout, the current bound location.
 
4827
    2. For branches that used to be checkouts, the previously-bound location.
 
4828
    3. The push location.
 
4829
    4. The parent location.
 
4830
    If none of these is available, --bind-to must be specified.
 
4831
    """
 
4832
 
 
4833
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
4834
    takes_args = ['location?']
 
4835
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4836
                     title='Target type',
 
4837
                     help='The type to reconfigure the directory to.',
 
4838
                     value_switches=True, enum_switch=False,
 
4839
                     branch='Reconfigure to be an unbound branch '
 
4840
                        'with no working tree.',
 
4841
                     tree='Reconfigure to be an unbound branch '
 
4842
                        'with a working tree.',
 
4843
                     checkout='Reconfigure to be a bound branch '
 
4844
                        'with a working tree.',
 
4845
                     lightweight_checkout='Reconfigure to be a lightweight'
 
4846
                     ' checkout (with no local history).',
 
4847
                     standalone='Reconfigure to be a standalone branch '
 
4848
                        '(i.e. stop using shared repository).',
 
4849
                     use_shared='Reconfigure to use a shared repository.'),
 
4850
                     Option('bind-to', help='Branch to bind checkout to.',
 
4851
                            type=str),
 
4852
                     Option('force',
 
4853
                        help='Perform reconfiguration even if local changes'
 
4854
                        ' will be lost.')
 
4855
                     ]
 
4856
 
 
4857
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4858
        directory = bzrdir.BzrDir.open(location)
 
4859
        if target_type is None:
 
4860
            raise errors.BzrCommandError('No target configuration specified')
 
4861
        elif target_type == 'branch':
 
4862
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4863
        elif target_type == 'tree':
 
4864
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4865
        elif target_type == 'checkout':
 
4866
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4867
                                                                  bind_to)
 
4868
        elif target_type == 'lightweight-checkout':
 
4869
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4870
                directory, bind_to)
 
4871
        elif target_type == 'use-shared':
 
4872
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
4873
        elif target_type == 'standalone':
 
4874
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
4875
        reconfiguration.apply(force)
 
4876
 
 
4877
 
 
4878
class cmd_switch(Command):
 
4879
    """Set the branch of a checkout and update.
 
4880
    
 
4881
    For lightweight checkouts, this changes the branch being referenced.
 
4882
    For heavyweight checkouts, this checks that there are no local commits
 
4883
    versus the current bound branch, then it makes the local branch a mirror
 
4884
    of the new location and binds to it.
 
4885
 
 
4886
    In both cases, the working tree is updated and uncommitted changes
 
4887
    are merged. The user can commit or revert these as they desire.
 
4888
 
 
4889
    Pending merges need to be committed or reverted before using switch.
 
4890
 
 
4891
    The path to the branch to switch to can be specified relative to the parent
 
4892
    directory of the current branch. For example, if you are currently in a
 
4893
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
4894
    /path/to/newbranch.
 
4895
 
 
4896
    Bound branches use the nickname of its master branch unless it is set
 
4897
    locally, in which case switching will update the the local nickname to be
 
4898
    that of the master.
 
4899
    """
 
4900
 
 
4901
    takes_args = ['to_location']
 
4902
    takes_options = [Option('force',
 
4903
                        help='Switch even if local commits will be lost.')
 
4904
                     ]
 
4905
 
 
4906
    def run(self, to_location, force=False):
 
4907
        from bzrlib import switch
 
4908
        tree_location = '.'
 
4909
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4910
        branch = control_dir.open_branch()
 
4911
        try:
 
4912
            to_branch = Branch.open(to_location)
 
4913
        except errors.NotBranchError:
 
4914
            this_branch = control_dir.open_branch()
 
4915
            # This may be a heavy checkout, where we want the master branch
 
4916
            this_url = this_branch.get_bound_location()
 
4917
            # If not, use a local sibling
 
4918
            if this_url is None:
 
4919
                this_url = this_branch.base
 
4920
            to_branch = Branch.open(
 
4921
                urlutils.join(this_url, '..', to_location))
 
4922
        switch.switch(control_dir, to_branch, force)
 
4923
        if branch.get_config().has_explicit_nickname():
 
4924
            branch = control_dir.open_branch() #get the new branch!
 
4925
            branch.nick = to_branch.nick
 
4926
        note('Switched to branch: %s',
 
4927
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4928
 
 
4929
 
 
4930
class cmd_hooks(Command):
 
4931
    """Show a branch's currently registered hooks.
 
4932
    """
 
4933
 
 
4934
    hidden = True
 
4935
    takes_args = ['path?']
 
4936
 
 
4937
    def run(self, path=None):
 
4938
        if path is None:
 
4939
            path = '.'
 
4940
        branch_hooks = Branch.open(path).hooks
 
4941
        for hook_type in branch_hooks:
 
4942
            hooks = branch_hooks[hook_type]
 
4943
            self.outf.write("%s:\n" % (hook_type,))
 
4944
            if hooks:
 
4945
                for hook in hooks:
 
4946
                    self.outf.write("  %s\n" %
 
4947
                                    (branch_hooks.get_hook_name(hook),))
 
4948
            else:
 
4949
                self.outf.write("  <no hooks installed>\n")
 
4950
 
 
4951
 
 
4952
class cmd_shelve(Command):
 
4953
    """Temporarily set aside some changes from the current tree.
 
4954
 
 
4955
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
4956
    ie. out of the way, until a later time when you can bring them back from
 
4957
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
4958
    your working tree, and so they aren't propagated along with your branch nor
 
4959
    will they survive its deletion.
 
4960
 
 
4961
    If shelve --list is specified, previously-shelved changes are listed.
 
4962
 
 
4963
    Shelve is intended to help separate several sets of changes that have
 
4964
    been inappropriately mingled.  If you just want to get rid of all changes
 
4965
    and you don't need to restore them later, use revert.  If you want to
 
4966
    shelve all text changes at once, use shelve --all.
 
4967
 
 
4968
    If filenames are specified, only the changes to those files will be
 
4969
    shelved. Other files will be left untouched.
 
4970
 
 
4971
    If a revision is specified, changes since that revision will be shelved.
 
4972
 
 
4973
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
4974
    restore the most recently shelved changes.
 
4975
    """
 
4976
 
 
4977
    takes_args = ['file*']
 
4978
 
 
4979
    takes_options = [
 
4980
        'revision',
 
4981
        Option('all', help='Shelve all changes.'),
 
4982
        'message',
 
4983
        RegistryOption('writer', 'Method to use for writing diffs.',
 
4984
                       bzrlib.option.diff_writer_registry,
 
4985
                       value_switches=True, enum_switch=False),
 
4986
 
 
4987
        Option('list', help='List shelved changes.'),
 
4988
    ]
 
4989
    _see_also = ['unshelve']
 
4990
 
 
4991
    def run(self, revision=None, all=False, file_list=None, message=None,
 
4992
            writer=None, list=False):
 
4993
        if list:
 
4994
            return self.run_for_list()
 
4995
        from bzrlib.shelf_ui import Shelver
 
4996
        if writer is None:
 
4997
            writer = bzrlib.option.diff_writer_registry.get()
 
4998
        try:
 
4999
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5000
                              message).run()
 
5001
        except errors.UserAbort:
 
5002
            return 0
 
5003
 
 
5004
    def run_for_list(self):
 
5005
        tree = WorkingTree.open_containing('.')[0]
 
5006
        tree.lock_read()
 
5007
        try:
 
5008
            manager = tree.get_shelf_manager()
 
5009
            shelves = manager.active_shelves()
 
5010
            if len(shelves) == 0:
 
5011
                note('No shelved changes.')
 
5012
                return 0
 
5013
            for shelf_id in reversed(shelves):
 
5014
                message = manager.get_metadata(shelf_id).get('message')
 
5015
                if message is None:
 
5016
                    message = '<no message>'
 
5017
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5018
            return 1
 
5019
        finally:
 
5020
            tree.unlock()
 
5021
 
 
5022
 
 
5023
class cmd_unshelve(Command):
 
5024
    """Restore shelved changes.
 
5025
 
 
5026
    By default, the most recently shelved changes are restored. However if you
 
5027
    specify a shelf by id those changes will be restored instead.  This works
 
5028
    best when the changes don't depend on each other.
 
5029
    """
 
5030
 
 
5031
    takes_args = ['shelf_id?']
 
5032
    takes_options = [
 
5033
        RegistryOption.from_kwargs(
 
5034
            'action', help="The action to perform.",
 
5035
            enum_switch=False, value_switches=True,
 
5036
            apply="Apply changes and remove from the shelf.",
 
5037
            dry_run="Show changes, but do not apply or remove them.",
 
5038
            delete_only="Delete changes without applying them."
 
5039
        )
 
5040
    ]
 
5041
    _see_also = ['shelve']
 
5042
 
 
5043
    def run(self, shelf_id=None, action='apply'):
 
5044
        from bzrlib.shelf_ui import Unshelver
 
5045
        Unshelver.from_args(shelf_id, action).run()
 
5046
 
 
5047
 
 
5048
def _create_prefix(cur_transport):
 
5049
    needed = [cur_transport]
 
5050
    # Recurse upwards until we can create a directory successfully
 
5051
    while True:
 
5052
        new_transport = cur_transport.clone('..')
 
5053
        if new_transport.base == cur_transport.base:
 
5054
            raise errors.BzrCommandError(
 
5055
                "Failed to create path prefix for %s."
 
5056
                % cur_transport.base)
 
5057
        try:
 
5058
            new_transport.mkdir('.')
 
5059
        except errors.NoSuchFile:
 
5060
            needed.append(new_transport)
 
5061
            cur_transport = new_transport
 
5062
        else:
 
5063
            break
 
5064
    # Now we only need to create child directories
 
5065
    while needed:
 
5066
        cur_transport = needed.pop()
 
5067
        cur_transport.ensure_base()
 
5068
 
 
5069
 
 
5070
# these get imported and then picked up by the scan for cmd_*
 
5071
# TODO: Some more consistent way to split command definitions across files;
 
5072
# we do need to load at least some information about them to know of 
 
5073
# aliases.  ideally we would avoid loading the implementation until the
 
5074
# details were needed.
 
5075
from bzrlib.cmd_version_info import cmd_version_info
 
5076
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5077
from bzrlib.bundle.commands import (
 
5078
    cmd_bundle_info,
 
5079
    )
 
5080
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5081
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5082
        cmd_weave_plan_merge, cmd_weave_merge_text