/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Tim Penhey
  • Date: 2008-05-30 10:47:49 UTC
  • mto: (3473.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3474.
  • Revision ID: tim@penhey.net-20080530104749-qfb4l7ykcdr84zu3
Fixed the output in the tests.

Show diffs side-by-side

added added

removed removed

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