/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: Jelmer Vernooij
  • Date: 2009-01-30 18:12:41 UTC
  • mto: This revision was merged to the branch mainline in revision 3975.
  • Revision ID: jelmer@samba.org-20090130181241-cbb2x802djvfp6cs
Skip unicode symlink tests on non-unicode file systems.

Show diffs side-by-side

added added

removed removed

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