/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

Remove more cases of getting transport via control_files

Show diffs side-by-side

added added

removed removed

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