/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-04 05:49:37 UTC
  • mto: (3118.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3119.
  • Revision ID: ian.clatworthy@internode.on.net-20071204054937-6v169ypv0lclbyuj
Improved diff based on feedback from abentley

Show diffs side-by-side

added added

removed removed

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