/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-17 01:45:32 UTC
  • mto: (3119.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071217014532-dmbv2mm72nzq0ai6
follow-up tweaks to bzr.dev integration

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