/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

Make our version of rst2html monkey-patch around docutils not accepting . in an option name

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