/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: Daniel Watkins
  • Date: 2008-03-09 18:08:36 UTC
  • mto: This revision was merged to the branch mainline in revision 3269.
  • Revision ID: d.m.watkins@warwick.ac.uk-20080309180836-y7wwg4o22e2tegjf
Added test to ensure that passing a range of revisions errors.

Show diffs side-by-side

added added

removed removed

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