/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

Add simple tests and docstrings for GraphWalker.

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