/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

Fix some bit of fetching.

Show diffs side-by-side

added added

removed removed

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