/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-12-22 00:03:14 UTC
  • mfrom: (3140.1.7 find-branches)
  • Revision ID: pqm@pqm.ubuntu.com-20071222000314-vq5b7m2jkaxvofm9
Add find_branch, find_trees, find_bzrdirs methods (abentley)

Show diffs side-by-side

added added

removed removed

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