/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: Robert Collins
  • Date: 2008-08-15 02:45:42 UTC
  • mto: This revision was merged to the branch mainline in revision 3637.
  • Revision ID: robertc@robertcollins.net-20080815024542-leg2xenbvo883tcc
Review feedback.

Show diffs side-by-side

added added

removed removed

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