/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

Merge with stacked-fixes

Show diffs side-by-side

added added

removed removed

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