/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

Deprecate LockableFiles.put_utf8 and put_bytes.

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