/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: Andrew Bennetts
  • Date: 2008-04-02 00:14:00 UTC
  • mfrom: (3324 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080402001400-r1pqse38i03dl97w
Merge from bzr.dev.

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