/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

Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)

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