/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: Aaron Bentley
  • Date: 2007-12-19 13:20:40 UTC
  • mto: This revision was merged to the branch mainline in revision 3135.
  • Revision ID: aaron.bentley@utoronto.ca-20071219132040-bzbczkkcjko742i1
Work around double-opening lock issue

Show diffs side-by-side

added added

removed removed

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