~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2007-11-14 08:20:59 UTC
  • mfrom: (2990 +trunk)
  • mto: (2990.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 2991.
  • Revision ID: v.ladeuil+lp@free.fr-20071114082059-bx03o3laiqfnyleb
merge bzr.dev

Show diffs side-by-side

added added

removed removed

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