/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2008-05-27 03:12:19 UTC
  • mto: (3724.1.1 lock-hooks)
  • mto: This revision was merged to the branch mainline in revision 3730.
  • Revision ID: mbp@sourcefrog.net-20080527031219-whr998jr17x233qh
Update test_help for hooks doc

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
                   short_name='V'),
 
1825
            Option('ignored', help='Print ignored files.'),
 
1826
            Option('null',
 
1827
                   help='Write an ascii NUL (\\0) separator '
 
1828
                   'between files rather than a newline.'),
 
1829
            Option('kind',
 
1830
                   help='List entries of a particular kind: file, directory, symlink.',
 
1831
                   type=unicode),
 
1832
            'show-ids',
 
1833
            ]
 
1834
    @display_command
 
1835
    def run(self, revision=None, verbose=False,
 
1836
            non_recursive=False, from_root=False,
 
1837
            unknown=False, versioned=False, ignored=False,
 
1838
            null=False, kind=None, show_ids=False, path=None):
 
1839
 
 
1840
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1841
            raise errors.BzrCommandError('invalid kind specified')
 
1842
 
 
1843
        if verbose and null:
 
1844
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1845
        all = not (unknown or versioned or ignored)
 
1846
 
 
1847
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1848
 
 
1849
        if path is None:
 
1850
            fs_path = '.'
 
1851
            prefix = ''
 
1852
        else:
 
1853
            if from_root:
 
1854
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1855
                                             ' and PATH')
 
1856
            fs_path = path
 
1857
            prefix = path
 
1858
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1859
            fs_path)
 
1860
        if from_root:
 
1861
            relpath = u''
 
1862
        elif relpath:
 
1863
            relpath += '/'
 
1864
        if revision is not None:
 
1865
            tree = branch.repository.revision_tree(
 
1866
                revision[0].as_revision_id(branch))
 
1867
        elif tree is None:
 
1868
            tree = branch.basis_tree()
 
1869
 
 
1870
        tree.lock_read()
 
1871
        try:
 
1872
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1873
                if fp.startswith(relpath):
 
1874
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1875
                    if non_recursive and '/' in fp:
 
1876
                        continue
 
1877
                    if not all and not selection[fc]:
 
1878
                        continue
 
1879
                    if kind is not None and fkind != kind:
 
1880
                        continue
 
1881
                    if verbose:
 
1882
                        kindch = entry.kind_character()
 
1883
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1884
                        if show_ids and fid is not None:
 
1885
                            outstring = "%-50s %s" % (outstring, fid)
 
1886
                        self.outf.write(outstring + '\n')
 
1887
                    elif null:
 
1888
                        self.outf.write(fp + '\0')
 
1889
                        if show_ids:
 
1890
                            if fid is not None:
 
1891
                                self.outf.write(fid)
 
1892
                            self.outf.write('\0')
 
1893
                        self.outf.flush()
 
1894
                    else:
 
1895
                        if fid is not None:
 
1896
                            my_id = fid
 
1897
                        else:
 
1898
                            my_id = ''
 
1899
                        if show_ids:
 
1900
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1901
                        else:
 
1902
                            self.outf.write(fp + '\n')
 
1903
        finally:
 
1904
            tree.unlock()
 
1905
 
 
1906
 
 
1907
class cmd_unknowns(Command):
 
1908
    """List unknown files.
 
1909
    """
 
1910
 
 
1911
    hidden = True
 
1912
    _see_also = ['ls']
 
1913
 
 
1914
    @display_command
 
1915
    def run(self):
 
1916
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1917
            self.outf.write(osutils.quotefn(f) + '\n')
 
1918
 
 
1919
 
 
1920
class cmd_ignore(Command):
 
1921
    """Ignore specified files or patterns.
 
1922
 
 
1923
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1924
 
 
1925
    Trailing slashes on patterns are ignored. 
 
1926
    If the pattern contains a slash or is a regular expression, it is compared 
 
1927
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1928
    the last component of the path.  To match a file only in the root 
 
1929
    directory, prepend './'.
 
1930
 
 
1931
    Ignore patterns specifying absolute paths are not allowed.
 
1932
 
 
1933
    Ignore patterns may include globbing wildcards such as::
 
1934
 
 
1935
      ? - Matches any single character except '/'
 
1936
      * - Matches 0 or more characters except '/'
 
1937
      /**/ - Matches 0 or more directories in a path
 
1938
      [a-z] - Matches a single character from within a group of characters
 
1939
 
 
1940
    Ignore patterns may also be Python regular expressions.  
 
1941
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1942
    followed by the regular expression.  Regular expression ignore patterns
 
1943
    may not include named or numbered groups.
 
1944
 
 
1945
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1946
    the shell on Unix.
 
1947
 
 
1948
    :Examples:
 
1949
        Ignore the top level Makefile::
 
1950
 
 
1951
            bzr ignore ./Makefile
 
1952
 
 
1953
        Ignore class files in all directories::
 
1954
 
 
1955
            bzr ignore "*.class"
 
1956
 
 
1957
        Ignore .o files under the lib directory::
 
1958
 
 
1959
            bzr ignore "lib/**/*.o"
 
1960
 
 
1961
        Ignore .o files under the lib directory::
 
1962
 
 
1963
            bzr ignore "RE:lib/.*\.o"
 
1964
 
 
1965
        Ignore everything but the "debian" toplevel directory::
 
1966
 
 
1967
            bzr ignore "RE:(?!debian/).*"
 
1968
    """
 
1969
 
 
1970
    _see_also = ['status', 'ignored']
 
1971
    takes_args = ['name_pattern*']
 
1972
    takes_options = [
 
1973
        Option('old-default-rules',
 
1974
               help='Write out the ignore rules bzr < 0.9 always used.')
 
1975
        ]
 
1976
    
 
1977
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1978
        from bzrlib.atomicfile import AtomicFile
 
1979
        if old_default_rules is not None:
 
1980
            # dump the rules and exit
 
1981
            for pattern in ignores.OLD_DEFAULTS:
 
1982
                print pattern
 
1983
            return
 
1984
        if not name_pattern_list:
 
1985
            raise errors.BzrCommandError("ignore requires at least one "
 
1986
                                  "NAME_PATTERN or --old-default-rules")
 
1987
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1988
                             for p in name_pattern_list]
 
1989
        for name_pattern in name_pattern_list:
 
1990
            if (name_pattern[0] == '/' or 
 
1991
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1992
                raise errors.BzrCommandError(
 
1993
                    "NAME_PATTERN should not be an absolute path")
 
1994
        tree, relpath = WorkingTree.open_containing(u'.')
 
1995
        ifn = tree.abspath('.bzrignore')
 
1996
        if os.path.exists(ifn):
 
1997
            f = open(ifn, 'rt')
 
1998
            try:
 
1999
                igns = f.read().decode('utf-8')
 
2000
            finally:
 
2001
                f.close()
 
2002
        else:
 
2003
            igns = ''
 
2004
 
 
2005
        # TODO: If the file already uses crlf-style termination, maybe
 
2006
        # we should use that for the newly added lines?
 
2007
 
 
2008
        if igns and igns[-1] != '\n':
 
2009
            igns += '\n'
 
2010
        for name_pattern in name_pattern_list:
 
2011
            igns += name_pattern + '\n'
 
2012
 
 
2013
        f = AtomicFile(ifn, 'wb')
 
2014
        try:
 
2015
            f.write(igns.encode('utf-8'))
 
2016
            f.commit()
 
2017
        finally:
 
2018
            f.close()
 
2019
 
 
2020
        if not tree.path2id('.bzrignore'):
 
2021
            tree.add(['.bzrignore'])
 
2022
 
 
2023
        ignored = globbing.Globster(name_pattern_list)
 
2024
        matches = []
 
2025
        tree.lock_read()
 
2026
        for entry in tree.list_files():
 
2027
            id = entry[3]
 
2028
            if id is not None:
 
2029
                filename = entry[0]
 
2030
                if ignored.match(filename):
 
2031
                    matches.append(filename.encode('utf-8'))
 
2032
        tree.unlock()
 
2033
        if len(matches) > 0:
 
2034
            print "Warning: the following files are version controlled and" \
 
2035
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
2036
 
 
2037
class cmd_ignored(Command):
 
2038
    """List ignored files and the patterns that matched them.
 
2039
    """
 
2040
 
 
2041
    encoding_type = 'replace'
 
2042
    _see_also = ['ignore']
 
2043
 
 
2044
    @display_command
 
2045
    def run(self):
 
2046
        tree = WorkingTree.open_containing(u'.')[0]
 
2047
        tree.lock_read()
 
2048
        try:
 
2049
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2050
                if file_class != 'I':
 
2051
                    continue
 
2052
                ## XXX: Slightly inefficient since this was already calculated
 
2053
                pat = tree.is_ignored(path)
 
2054
                self.outf.write('%-50s %s\n' % (path, pat))
 
2055
        finally:
 
2056
            tree.unlock()
 
2057
 
 
2058
 
 
2059
class cmd_lookup_revision(Command):
 
2060
    """Lookup the revision-id from a revision-number
 
2061
 
 
2062
    :Examples:
 
2063
        bzr lookup-revision 33
 
2064
    """
 
2065
    hidden = True
 
2066
    takes_args = ['revno']
 
2067
    
 
2068
    @display_command
 
2069
    def run(self, revno):
 
2070
        try:
 
2071
            revno = int(revno)
 
2072
        except ValueError:
 
2073
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2074
 
 
2075
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2076
 
 
2077
 
 
2078
class cmd_export(Command):
 
2079
    """Export current or past revision to a destination directory or archive.
 
2080
 
 
2081
    If no revision is specified this exports the last committed revision.
 
2082
 
 
2083
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2084
    given, try to find the format with the extension. If no extension
 
2085
    is found exports to a directory (equivalent to --format=dir).
 
2086
 
 
2087
    If root is supplied, it will be used as the root directory inside
 
2088
    container formats (tar, zip, etc). If it is not supplied it will default
 
2089
    to the exported filename. The root option has no effect for 'dir' format.
 
2090
 
 
2091
    If branch is omitted then the branch containing the current working
 
2092
    directory will be used.
 
2093
 
 
2094
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2095
 
 
2096
      =================       =========================
 
2097
      Supported formats       Autodetected by extension
 
2098
      =================       =========================
 
2099
         dir                         (none)
 
2100
         tar                          .tar
 
2101
         tbz2                    .tar.bz2, .tbz2
 
2102
         tgz                      .tar.gz, .tgz
 
2103
         zip                          .zip
 
2104
      =================       =========================
 
2105
    """
 
2106
    takes_args = ['dest', 'branch?']
 
2107
    takes_options = [
 
2108
        Option('format',
 
2109
               help="Type of file to export to.",
 
2110
               type=unicode),
 
2111
        'revision',
 
2112
        Option('root',
 
2113
               type=str,
 
2114
               help="Name of the root directory inside the exported file."),
 
2115
        ]
 
2116
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
2117
        from bzrlib.export import export
 
2118
 
 
2119
        if branch is None:
 
2120
            tree = WorkingTree.open_containing(u'.')[0]
 
2121
            b = tree.branch
 
2122
        else:
 
2123
            b = Branch.open(branch)
 
2124
            
 
2125
        if revision is None:
 
2126
            # should be tree.last_revision  FIXME
 
2127
            rev_id = b.last_revision()
 
2128
        else:
 
2129
            if len(revision) != 1:
 
2130
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2131
            rev_id = revision[0].as_revision_id(b)
 
2132
        t = b.repository.revision_tree(rev_id)
 
2133
        try:
 
2134
            export(t, dest, format, root)
 
2135
        except errors.NoSuchExportFormat, e:
 
2136
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2137
 
 
2138
 
 
2139
class cmd_cat(Command):
 
2140
    """Write the contents of a file as of a given revision to standard output.
 
2141
 
 
2142
    If no revision is nominated, the last revision is used.
 
2143
 
 
2144
    Note: Take care to redirect standard output when using this command on a
 
2145
    binary file. 
 
2146
    """
 
2147
 
 
2148
    _see_also = ['ls']
 
2149
    takes_options = [
 
2150
        Option('name-from-revision', help='The path name in the old tree.'),
 
2151
        'revision',
 
2152
        ]
 
2153
    takes_args = ['filename']
 
2154
    encoding_type = 'exact'
 
2155
 
 
2156
    @display_command
 
2157
    def run(self, filename, revision=None, name_from_revision=False):
 
2158
        if revision is not None and len(revision) != 1:
 
2159
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2160
                                         " one revision specifier")
 
2161
        tree, branch, relpath = \
 
2162
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2163
        branch.lock_read()
 
2164
        try:
 
2165
            return self._run(tree, branch, relpath, filename, revision,
 
2166
                             name_from_revision)
 
2167
        finally:
 
2168
            branch.unlock()
 
2169
 
 
2170
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2171
        if tree is None:
 
2172
            tree = b.basis_tree()
 
2173
        if revision is None:
 
2174
            revision_id = b.last_revision()
 
2175
        else:
 
2176
            revision_id = revision[0].as_revision_id(b)
 
2177
 
 
2178
        cur_file_id = tree.path2id(relpath)
 
2179
        rev_tree = b.repository.revision_tree(revision_id)
 
2180
        old_file_id = rev_tree.path2id(relpath)
 
2181
        
 
2182
        if name_from_revision:
 
2183
            if old_file_id is None:
 
2184
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2185
                                                % (filename, revision_id))
 
2186
            else:
 
2187
                rev_tree.print_file(old_file_id)
 
2188
        elif cur_file_id is not None:
 
2189
            rev_tree.print_file(cur_file_id)
 
2190
        elif old_file_id is not None:
 
2191
            rev_tree.print_file(old_file_id)
 
2192
        else:
 
2193
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2194
                                         (filename, revision_id))
 
2195
 
 
2196
 
 
2197
class cmd_local_time_offset(Command):
 
2198
    """Show the offset in seconds from GMT to local time."""
 
2199
    hidden = True    
 
2200
    @display_command
 
2201
    def run(self):
 
2202
        print osutils.local_time_offset()
 
2203
 
 
2204
 
 
2205
 
 
2206
class cmd_commit(Command):
 
2207
    """Commit changes into a new revision.
 
2208
    
 
2209
    If no arguments are given, the entire tree is committed.
 
2210
 
 
2211
    If selected files are specified, only changes to those files are
 
2212
    committed.  If a directory is specified then the directory and everything 
 
2213
    within it is committed.
 
2214
 
 
2215
    If author of the change is not the same person as the committer, you can
 
2216
    specify the author's name using the --author option. The name should be
 
2217
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2218
 
 
2219
    A selected-file commit may fail in some cases where the committed
 
2220
    tree would be invalid. Consider::
 
2221
 
 
2222
      bzr init foo
 
2223
      mkdir foo/bar
 
2224
      bzr add foo/bar
 
2225
      bzr commit foo -m "committing foo"
 
2226
      bzr mv foo/bar foo/baz
 
2227
      mkdir foo/bar
 
2228
      bzr add foo/bar
 
2229
      bzr commit foo/bar -m "committing bar but not baz"
 
2230
 
 
2231
    In the example above, the last commit will fail by design. This gives
 
2232
    the user the opportunity to decide whether they want to commit the
 
2233
    rename at the same time, separately first, or not at all. (As a general
 
2234
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2235
 
 
2236
    Note: A selected-file commit after a merge is not yet supported.
 
2237
    """
 
2238
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2239
 
 
2240
    # TODO: Strict commit that fails if there are deleted files.
 
2241
    #       (what does "deleted files" mean ??)
 
2242
 
 
2243
    # TODO: Give better message for -s, --summary, used by tla people
 
2244
 
 
2245
    # XXX: verbose currently does nothing
 
2246
 
 
2247
    _see_also = ['bugs', 'uncommit']
 
2248
    takes_args = ['selected*']
 
2249
    takes_options = [
 
2250
            Option('message', type=unicode,
 
2251
                   short_name='m',
 
2252
                   help="Description of the new revision."),
 
2253
            'verbose',
 
2254
             Option('unchanged',
 
2255
                    help='Commit even if nothing has changed.'),
 
2256
             Option('file', type=str,
 
2257
                    short_name='F',
 
2258
                    argname='msgfile',
 
2259
                    help='Take commit message from this file.'),
 
2260
             Option('strict',
 
2261
                    help="Refuse to commit if there are unknown "
 
2262
                    "files in the working tree."),
 
2263
             ListOption('fixes', type=str,
 
2264
                    help="Mark a bug as being fixed by this revision."),
 
2265
             Option('author', type=unicode,
 
2266
                    help="Set the author's name, if it's different "
 
2267
                         "from the committer."),
 
2268
             Option('local',
 
2269
                    help="Perform a local commit in a bound "
 
2270
                         "branch.  Local commits are not pushed to "
 
2271
                         "the master branch until a normal commit "
 
2272
                         "is performed."
 
2273
                    ),
 
2274
              Option('show-diff',
 
2275
                     help='When no message is supplied, show the diff along'
 
2276
                     ' with the status summary in the message editor.'),
 
2277
             ]
 
2278
    aliases = ['ci', 'checkin']
 
2279
 
 
2280
    def _get_bug_fix_properties(self, fixes, branch):
 
2281
        properties = []
 
2282
        # Configure the properties for bug fixing attributes.
 
2283
        for fixed_bug in fixes:
 
2284
            tokens = fixed_bug.split(':')
 
2285
            if len(tokens) != 2:
 
2286
                raise errors.BzrCommandError(
 
2287
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2288
                    "Commit refused." % fixed_bug)
 
2289
            tag, bug_id = tokens
 
2290
            try:
 
2291
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2292
            except errors.UnknownBugTrackerAbbreviation:
 
2293
                raise errors.BzrCommandError(
 
2294
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2295
            except errors.MalformedBugIdentifier:
 
2296
                raise errors.BzrCommandError(
 
2297
                    "Invalid bug identifier for %s. Commit refused."
 
2298
                    % fixed_bug)
 
2299
            properties.append('%s fixed' % bug_url)
 
2300
        return '\n'.join(properties)
 
2301
 
 
2302
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2303
            unchanged=False, strict=False, local=False, fixes=None,
 
2304
            author=None, show_diff=False):
 
2305
        from bzrlib.errors import (
 
2306
            PointlessCommit,
 
2307
            ConflictsInTree,
 
2308
            StrictCommitFailed
 
2309
        )
 
2310
        from bzrlib.msgeditor import (
 
2311
            edit_commit_message_encoded,
 
2312
            make_commit_message_template_encoded
 
2313
        )
 
2314
 
 
2315
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2316
        # slightly problematic to run this cross-platform.
 
2317
 
 
2318
        # TODO: do more checks that the commit will succeed before 
 
2319
        # spending the user's valuable time typing a commit message.
 
2320
 
 
2321
        properties = {}
 
2322
 
 
2323
        tree, selected_list = tree_files(selected_list)
 
2324
        if selected_list == ['']:
 
2325
            # workaround - commit of root of tree should be exactly the same
 
2326
            # as just default commit in that tree, and succeed even though
 
2327
            # selected-file merge commit is not done yet
 
2328
            selected_list = []
 
2329
 
 
2330
        if fixes is None:
 
2331
            fixes = []
 
2332
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2333
        if bug_property:
 
2334
            properties['bugs'] = bug_property
 
2335
 
 
2336
        if local and not tree.branch.get_bound_location():
 
2337
            raise errors.LocalRequiresBoundBranch()
 
2338
 
 
2339
        def get_message(commit_obj):
 
2340
            """Callback to get commit message"""
 
2341
            my_message = message
 
2342
            if my_message is None and not file:
 
2343
                t = make_commit_message_template_encoded(tree,
 
2344
                        selected_list, diff=show_diff,
 
2345
                        output_encoding=bzrlib.user_encoding)
 
2346
                my_message = edit_commit_message_encoded(t)
 
2347
                if my_message is None:
 
2348
                    raise errors.BzrCommandError("please specify a commit"
 
2349
                        " message with either --message or --file")
 
2350
            elif my_message and file:
 
2351
                raise errors.BzrCommandError(
 
2352
                    "please specify either --message or --file")
 
2353
            if file:
 
2354
                my_message = codecs.open(file, 'rt', 
 
2355
                                         bzrlib.user_encoding).read()
 
2356
            if my_message == "":
 
2357
                raise errors.BzrCommandError("empty commit message specified")
 
2358
            return my_message
 
2359
 
 
2360
        try:
 
2361
            tree.commit(message_callback=get_message,
 
2362
                        specific_files=selected_list,
 
2363
                        allow_pointless=unchanged, strict=strict, local=local,
 
2364
                        reporter=None, verbose=verbose, revprops=properties,
 
2365
                        author=author)
 
2366
        except PointlessCommit:
 
2367
            # FIXME: This should really happen before the file is read in;
 
2368
            # perhaps prepare the commit; get the message; then actually commit
 
2369
            raise errors.BzrCommandError("no changes to commit."
 
2370
                              " use --unchanged to commit anyhow")
 
2371
        except ConflictsInTree:
 
2372
            raise errors.BzrCommandError('Conflicts detected in working '
 
2373
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2374
                ' resolve.')
 
2375
        except StrictCommitFailed:
 
2376
            raise errors.BzrCommandError("Commit refused because there are"
 
2377
                              " unknown files in the working tree.")
 
2378
        except errors.BoundBranchOutOfDate, e:
 
2379
            raise errors.BzrCommandError(str(e) + "\n"
 
2380
            'To commit to master branch, run update and then commit.\n'
 
2381
            'You can also pass --local to commit to continue working '
 
2382
            'disconnected.')
 
2383
 
 
2384
 
 
2385
class cmd_check(Command):
 
2386
    """Validate consistency of branch history.
 
2387
 
 
2388
    This command checks various invariants about the branch storage to
 
2389
    detect data corruption or bzr bugs.
 
2390
 
 
2391
    Output fields:
 
2392
 
 
2393
        revisions: This is just the number of revisions checked.  It doesn't
 
2394
            indicate a problem.
 
2395
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2396
            doesn't indicate a problem.
 
2397
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2398
            are not properly referenced by the revision ancestry.  This is a
 
2399
            subtle problem that Bazaar can work around.
 
2400
        unique file texts: This is the total number of unique file contents
 
2401
            seen in the checked revisions.  It does not indicate a problem.
 
2402
        repeated file texts: This is the total number of repeated texts seen
 
2403
            in the checked revisions.  Texts can be repeated when their file
 
2404
            entries are modified, but the file contents are not.  It does not
 
2405
            indicate a problem.
 
2406
    """
 
2407
 
 
2408
    _see_also = ['reconcile']
 
2409
    takes_args = ['branch?']
 
2410
    takes_options = ['verbose']
 
2411
 
 
2412
    def run(self, branch=None, verbose=False):
 
2413
        from bzrlib.check import check
 
2414
        if branch is None:
 
2415
            branch_obj = Branch.open_containing('.')[0]
 
2416
        else:
 
2417
            branch_obj = Branch.open(branch)
 
2418
        check(branch_obj, verbose)
 
2419
        # bit hacky, check the tree parent is accurate
 
2420
        try:
 
2421
            if branch is None:
 
2422
                tree = WorkingTree.open_containing('.')[0]
 
2423
            else:
 
2424
                tree = WorkingTree.open(branch)
 
2425
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2426
            pass
 
2427
        else:
 
2428
            # This is a primitive 'check' for tree state. Currently this is not
 
2429
            # integrated into the main check logic as yet.
 
2430
            tree.lock_read()
 
2431
            try:
 
2432
                tree_basis = tree.basis_tree()
 
2433
                tree_basis.lock_read()
 
2434
                try:
 
2435
                    repo_basis = tree.branch.repository.revision_tree(
 
2436
                        tree.last_revision())
 
2437
                    if len(list(repo_basis.iter_changes(tree_basis))):
 
2438
                        raise errors.BzrCheckError(
 
2439
                            "Mismatched basis inventory content.")
 
2440
                    tree._validate()
 
2441
                finally:
 
2442
                    tree_basis.unlock()
 
2443
            finally:
 
2444
                tree.unlock()
 
2445
 
 
2446
 
 
2447
class cmd_upgrade(Command):
 
2448
    """Upgrade branch storage to current format.
 
2449
 
 
2450
    The check command or bzr developers may sometimes advise you to run
 
2451
    this command. When the default format has changed you may also be warned
 
2452
    during other operations to upgrade.
 
2453
    """
 
2454
 
 
2455
    _see_also = ['check']
 
2456
    takes_args = ['url?']
 
2457
    takes_options = [
 
2458
                    RegistryOption('format',
 
2459
                        help='Upgrade to a specific format.  See "bzr help'
 
2460
                             ' formats" for details.',
 
2461
                        registry=bzrdir.format_registry,
 
2462
                        converter=bzrdir.format_registry.make_bzrdir,
 
2463
                        value_switches=True, title='Branch format'),
 
2464
                    ]
 
2465
 
 
2466
    def run(self, url='.', format=None):
 
2467
        from bzrlib.upgrade import upgrade
 
2468
        if format is None:
 
2469
            format = bzrdir.format_registry.make_bzrdir('default')
 
2470
        upgrade(url, format)
 
2471
 
 
2472
 
 
2473
class cmd_whoami(Command):
 
2474
    """Show or set bzr user id.
 
2475
    
 
2476
    :Examples:
 
2477
        Show the email of the current user::
 
2478
 
 
2479
            bzr whoami --email
 
2480
 
 
2481
        Set the current user::
 
2482
 
 
2483
            bzr whoami "Frank Chu <fchu@example.com>"
 
2484
    """
 
2485
    takes_options = [ Option('email',
 
2486
                             help='Display email address only.'),
 
2487
                      Option('branch',
 
2488
                             help='Set identity for the current branch instead of '
 
2489
                                  'globally.'),
 
2490
                    ]
 
2491
    takes_args = ['name?']
 
2492
    encoding_type = 'replace'
 
2493
    
 
2494
    @display_command
 
2495
    def run(self, email=False, branch=False, name=None):
 
2496
        if name is None:
 
2497
            # use branch if we're inside one; otherwise global config
 
2498
            try:
 
2499
                c = Branch.open_containing('.')[0].get_config()
 
2500
            except errors.NotBranchError:
 
2501
                c = config.GlobalConfig()
 
2502
            if email:
 
2503
                self.outf.write(c.user_email() + '\n')
 
2504
            else:
 
2505
                self.outf.write(c.username() + '\n')
 
2506
            return
 
2507
 
 
2508
        # display a warning if an email address isn't included in the given name.
 
2509
        try:
 
2510
            config.extract_email_address(name)
 
2511
        except errors.NoEmailInUsername, e:
 
2512
            warning('"%s" does not seem to contain an email address.  '
 
2513
                    'This is allowed, but not recommended.', name)
 
2514
        
 
2515
        # use global config unless --branch given
 
2516
        if branch:
 
2517
            c = Branch.open_containing('.')[0].get_config()
 
2518
        else:
 
2519
            c = config.GlobalConfig()
 
2520
        c.set_user_option('email', name)
 
2521
 
 
2522
 
 
2523
class cmd_nick(Command):
 
2524
    """Print or set the branch nickname.  
 
2525
 
 
2526
    If unset, the tree root directory name is used as the nickname
 
2527
    To print the current nickname, execute with no argument.  
 
2528
    """
 
2529
 
 
2530
    _see_also = ['info']
 
2531
    takes_args = ['nickname?']
 
2532
    def run(self, nickname=None):
 
2533
        branch = Branch.open_containing(u'.')[0]
 
2534
        if nickname is None:
 
2535
            self.printme(branch)
 
2536
        else:
 
2537
            branch.nick = nickname
 
2538
 
 
2539
    @display_command
 
2540
    def printme(self, branch):
 
2541
        print branch.nick
 
2542
 
 
2543
 
 
2544
class cmd_selftest(Command):
 
2545
    """Run internal test suite.
 
2546
    
 
2547
    If arguments are given, they are regular expressions that say which tests
 
2548
    should run.  Tests matching any expression are run, and other tests are
 
2549
    not run.
 
2550
 
 
2551
    Alternatively if --first is given, matching tests are run first and then
 
2552
    all other tests are run.  This is useful if you have been working in a
 
2553
    particular area, but want to make sure nothing else was broken.
 
2554
 
 
2555
    If --exclude is given, tests that match that regular expression are
 
2556
    excluded, regardless of whether they match --first or not.
 
2557
 
 
2558
    To help catch accidential dependencies between tests, the --randomize
 
2559
    option is useful. In most cases, the argument used is the word 'now'.
 
2560
    Note that the seed used for the random number generator is displayed
 
2561
    when this option is used. The seed can be explicitly passed as the
 
2562
    argument to this option if required. This enables reproduction of the
 
2563
    actual ordering used if and when an order sensitive problem is encountered.
 
2564
 
 
2565
    If --list-only is given, the tests that would be run are listed. This is
 
2566
    useful when combined with --first, --exclude and/or --randomize to
 
2567
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2568
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2569
 
 
2570
    If the global option '--no-plugins' is given, plugins are not loaded
 
2571
    before running the selftests.  This has two effects: features provided or
 
2572
    modified by plugins will not be tested, and tests provided by plugins will
 
2573
    not be run.
 
2574
 
 
2575
    Tests that need working space on disk use a common temporary directory, 
 
2576
    typically inside $TMPDIR or /tmp.
 
2577
 
 
2578
    :Examples:
 
2579
        Run only tests relating to 'ignore'::
 
2580
 
 
2581
            bzr selftest ignore
 
2582
 
 
2583
        Disable plugins and list tests as they're run::
 
2584
 
 
2585
            bzr --no-plugins selftest -v
 
2586
    """
 
2587
    # NB: this is used from the class without creating an instance, which is
 
2588
    # why it does not have a self parameter.
 
2589
    def get_transport_type(typestring):
 
2590
        """Parse and return a transport specifier."""
 
2591
        if typestring == "sftp":
 
2592
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2593
            return SFTPAbsoluteServer
 
2594
        if typestring == "memory":
 
2595
            from bzrlib.transport.memory import MemoryServer
 
2596
            return MemoryServer
 
2597
        if typestring == "fakenfs":
 
2598
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2599
            return FakeNFSServer
 
2600
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2601
            (typestring)
 
2602
        raise errors.BzrCommandError(msg)
 
2603
 
 
2604
    hidden = True
 
2605
    takes_args = ['testspecs*']
 
2606
    takes_options = ['verbose',
 
2607
                     Option('one',
 
2608
                             help='Stop when one test fails.',
 
2609
                             short_name='1',
 
2610
                             ),
 
2611
                     Option('transport',
 
2612
                            help='Use a different transport by default '
 
2613
                                 'throughout the test suite.',
 
2614
                            type=get_transport_type),
 
2615
                     Option('benchmark',
 
2616
                            help='Run the benchmarks rather than selftests.'),
 
2617
                     Option('lsprof-timed',
 
2618
                            help='Generate lsprof output for benchmarked'
 
2619
                                 ' sections of code.'),
 
2620
                     Option('cache-dir', type=str,
 
2621
                            help='Cache intermediate benchmark output in this '
 
2622
                                 'directory.'),
 
2623
                     Option('first',
 
2624
                            help='Run all tests, but run specified tests first.',
 
2625
                            short_name='f',
 
2626
                            ),
 
2627
                     Option('list-only',
 
2628
                            help='List the tests instead of running them.'),
 
2629
                     Option('randomize', type=str, argname="SEED",
 
2630
                            help='Randomize the order of tests using the given'
 
2631
                                 ' seed or "now" for the current time.'),
 
2632
                     Option('exclude', type=str, argname="PATTERN",
 
2633
                            short_name='x',
 
2634
                            help='Exclude tests that match this regular'
 
2635
                                 ' expression.'),
 
2636
                     Option('strict', help='Fail on missing dependencies or '
 
2637
                            'known failures.'),
 
2638
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
2639
                            help='Load a test id list from a text file.'),
 
2640
                     ListOption('debugflag', type=str, short_name='E',
 
2641
                                help='Turn on a selftest debug flag.'),
 
2642
                     Option('starting-with', type=str, argname='TESTID',
 
2643
                            short_name='s',
 
2644
                            help='Load only the tests starting with TESTID.'),
 
2645
                     ]
 
2646
    encoding_type = 'replace'
 
2647
 
 
2648
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2649
            transport=None, benchmark=None,
 
2650
            lsprof_timed=None, cache_dir=None,
 
2651
            first=False, list_only=False,
 
2652
            randomize=None, exclude=None, strict=False,
 
2653
            load_list=None, debugflag=None, starting_with=None):
 
2654
        import bzrlib.ui
 
2655
        from bzrlib.tests import selftest
 
2656
        import bzrlib.benchmarks as benchmarks
 
2657
        from bzrlib.benchmarks import tree_creator
 
2658
 
 
2659
        if cache_dir is not None:
 
2660
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2661
        if not list_only:
 
2662
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2663
            print '   %s (%s python%s)' % (
 
2664
                    bzrlib.__path__[0],
 
2665
                    bzrlib.version_string,
 
2666
                    bzrlib._format_version_tuple(sys.version_info),
 
2667
                    )
 
2668
        print
 
2669
        if testspecs_list is not None:
 
2670
            pattern = '|'.join(testspecs_list)
 
2671
        else:
 
2672
            pattern = ".*"
 
2673
        if benchmark:
 
2674
            test_suite_factory = benchmarks.test_suite
 
2675
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2676
            verbose = not is_quiet()
 
2677
            # TODO: should possibly lock the history file...
 
2678
            benchfile = open(".perf_history", "at", buffering=1)
 
2679
        else:
 
2680
            test_suite_factory = None
 
2681
            benchfile = None
 
2682
        try:
 
2683
            result = selftest(verbose=verbose,
 
2684
                              pattern=pattern,
 
2685
                              stop_on_failure=one,
 
2686
                              transport=transport,
 
2687
                              test_suite_factory=test_suite_factory,
 
2688
                              lsprof_timed=lsprof_timed,
 
2689
                              bench_history=benchfile,
 
2690
                              matching_tests_first=first,
 
2691
                              list_only=list_only,
 
2692
                              random_seed=randomize,
 
2693
                              exclude_pattern=exclude,
 
2694
                              strict=strict,
 
2695
                              load_list=load_list,
 
2696
                              debug_flags=debugflag,
 
2697
                              starting_with=starting_with,
 
2698
                              )
 
2699
        finally:
 
2700
            if benchfile is not None:
 
2701
                benchfile.close()
 
2702
        if result:
 
2703
            note('tests passed')
 
2704
        else:
 
2705
            note('tests failed')
 
2706
        return int(not result)
 
2707
 
 
2708
 
 
2709
class cmd_version(Command):
 
2710
    """Show version of bzr."""
 
2711
 
 
2712
    encoding_type = 'replace'
 
2713
    takes_options = [
 
2714
        Option("short", help="Print just the version number."),
 
2715
        ]
 
2716
 
 
2717
    @display_command
 
2718
    def run(self, short=False):
 
2719
        from bzrlib.version import show_version
 
2720
        if short:
 
2721
            self.outf.write(bzrlib.version_string + '\n')
 
2722
        else:
 
2723
            show_version(to_file=self.outf)
 
2724
 
 
2725
 
 
2726
class cmd_rocks(Command):
 
2727
    """Statement of optimism."""
 
2728
 
 
2729
    hidden = True
 
2730
 
 
2731
    @display_command
 
2732
    def run(self):
 
2733
        print "It sure does!"
 
2734
 
 
2735
 
 
2736
class cmd_find_merge_base(Command):
 
2737
    """Find and print a base revision for merging two branches."""
 
2738
    # TODO: Options to specify revisions on either side, as if
 
2739
    #       merging only part of the history.
 
2740
    takes_args = ['branch', 'other']
 
2741
    hidden = True
 
2742
    
 
2743
    @display_command
 
2744
    def run(self, branch, other):
 
2745
        from bzrlib.revision import ensure_null
 
2746
        
 
2747
        branch1 = Branch.open_containing(branch)[0]
 
2748
        branch2 = Branch.open_containing(other)[0]
 
2749
        branch1.lock_read()
 
2750
        try:
 
2751
            branch2.lock_read()
 
2752
            try:
 
2753
                last1 = ensure_null(branch1.last_revision())
 
2754
                last2 = ensure_null(branch2.last_revision())
 
2755
 
 
2756
                graph = branch1.repository.get_graph(branch2.repository)
 
2757
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2758
 
 
2759
                print 'merge base is revision %s' % base_rev_id
 
2760
            finally:
 
2761
                branch2.unlock()
 
2762
        finally:
 
2763
            branch1.unlock()
 
2764
 
 
2765
 
 
2766
class cmd_merge(Command):
 
2767
    """Perform a three-way merge.
 
2768
    
 
2769
    The source of the merge can be specified either in the form of a branch,
 
2770
    or in the form of a path to a file containing a merge directive generated
 
2771
    with bzr send. If neither is specified, the default is the upstream branch
 
2772
    or the branch most recently merged using --remember.
 
2773
 
 
2774
    When merging a branch, by default the tip will be merged. To pick a different
 
2775
    revision, pass --revision. If you specify two values, the first will be used as
 
2776
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
2777
    available revisions, like this is commonly referred to as "cherrypicking".
 
2778
 
 
2779
    Revision numbers are always relative to the branch being merged.
 
2780
 
 
2781
    By default, bzr will try to merge in all new work from the other
 
2782
    branch, automatically determining an appropriate base.  If this
 
2783
    fails, you may need to give an explicit base.
 
2784
    
 
2785
    Merge will do its best to combine the changes in two branches, but there
 
2786
    are some kinds of problems only a human can fix.  When it encounters those,
 
2787
    it will mark a conflict.  A conflict means that you need to fix something,
 
2788
    before you should commit.
 
2789
 
 
2790
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2791
 
 
2792
    If there is no default branch set, the first merge will set it. After
 
2793
    that, you can omit the branch to use the default.  To change the
 
2794
    default, use --remember. The value will only be saved if the remote
 
2795
    location can be accessed.
 
2796
 
 
2797
    The results of the merge are placed into the destination working
 
2798
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2799
    committed to record the result of the merge.
 
2800
    
 
2801
    merge refuses to run if there are any uncommitted changes, unless
 
2802
    --force is given.
 
2803
 
 
2804
    :Examples:
 
2805
        To merge the latest revision from bzr.dev::
 
2806
 
 
2807
            bzr merge ../bzr.dev
 
2808
 
 
2809
        To merge changes up to and including revision 82 from bzr.dev::
 
2810
 
 
2811
            bzr merge -r 82 ../bzr.dev
 
2812
 
 
2813
        To merge the changes introduced by 82, without previous changes::
 
2814
 
 
2815
            bzr merge -r 81..82 ../bzr.dev
 
2816
 
 
2817
        To apply a merge directive contained in in /tmp/merge:
 
2818
 
 
2819
            bzr merge /tmp/merge
 
2820
    """
 
2821
 
 
2822
    encoding_type = 'exact'
 
2823
    _see_also = ['update', 'remerge', 'status-flags']
 
2824
    takes_args = ['location?']
 
2825
    takes_options = [
 
2826
        'change',
 
2827
        'revision',
 
2828
        Option('force',
 
2829
               help='Merge even if the destination tree has uncommitted changes.'),
 
2830
        'merge-type',
 
2831
        'reprocess',
 
2832
        'remember',
 
2833
        Option('show-base', help="Show base revision text in "
 
2834
               "conflicts."),
 
2835
        Option('uncommitted', help='Apply uncommitted changes'
 
2836
               ' from a working copy, instead of branch changes.'),
 
2837
        Option('pull', help='If the destination is already'
 
2838
                ' completely merged into the source, pull from the'
 
2839
                ' source rather than merging.  When this happens,'
 
2840
                ' you do not need to commit the result.'),
 
2841
        Option('directory',
 
2842
               help='Branch to merge into, '
 
2843
                    'rather than the one containing the working directory.',
 
2844
               short_name='d',
 
2845
               type=unicode,
 
2846
               ),
 
2847
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
2848
    ]
 
2849
 
 
2850
    def run(self, location=None, revision=None, force=False,
 
2851
            merge_type=None, show_base=False, reprocess=False, remember=False,
 
2852
            uncommitted=False, pull=False,
 
2853
            directory=None,
 
2854
            preview=False,
 
2855
            ):
 
2856
        if merge_type is None:
 
2857
            merge_type = _mod_merge.Merge3Merger
 
2858
 
 
2859
        if directory is None: directory = u'.'
 
2860
        possible_transports = []
 
2861
        merger = None
 
2862
        allow_pending = True
 
2863
        verified = 'inapplicable'
 
2864
        tree = WorkingTree.open_containing(directory)[0]
 
2865
        change_reporter = delta._ChangeReporter(
 
2866
            unversioned_filter=tree.is_ignored)
 
2867
        cleanups = []
 
2868
        try:
 
2869
            pb = ui.ui_factory.nested_progress_bar()
 
2870
            cleanups.append(pb.finished)
 
2871
            tree.lock_write()
 
2872
            cleanups.append(tree.unlock)
 
2873
            if location is not None:
 
2874
                try:
 
2875
                    mergeable = bundle.read_mergeable_from_url(location,
 
2876
                        possible_transports=possible_transports)
 
2877
                except errors.NotABundle:
 
2878
                    mergeable = None
 
2879
                else:
 
2880
                    if uncommitted:
 
2881
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2882
                            ' with bundles or merge directives.')
 
2883
 
 
2884
                    if revision is not None:
 
2885
                        raise errors.BzrCommandError(
 
2886
                            'Cannot use -r with merge directives or bundles')
 
2887
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2888
                       mergeable, pb)
 
2889
 
 
2890
            if merger is None and uncommitted:
 
2891
                if revision is not None and len(revision) > 0:
 
2892
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2893
                        ' --revision at the same time.')
 
2894
                location = self._select_branch_location(tree, location)[0]
 
2895
                other_tree, other_path = WorkingTree.open_containing(location)
 
2896
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2897
                    pb)
 
2898
                allow_pending = False
 
2899
                if other_path != '':
 
2900
                    merger.interesting_files = [other_path]
 
2901
 
 
2902
            if merger is None:
 
2903
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2904
                    location, revision, remember, possible_transports, pb)
 
2905
 
 
2906
            merger.merge_type = merge_type
 
2907
            merger.reprocess = reprocess
 
2908
            merger.show_base = show_base
 
2909
            self.sanity_check_merger(merger)
 
2910
            if (merger.base_rev_id == merger.other_rev_id and
 
2911
                merger.other_rev_id is not None):
 
2912
                note('Nothing to do.')
 
2913
                return 0
 
2914
            if pull:
 
2915
                if merger.interesting_files is not None:
 
2916
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2917
                if (merger.base_rev_id == tree.last_revision()):
 
2918
                    result = tree.pull(merger.other_branch, False,
 
2919
                                       merger.other_rev_id)
 
2920
                    result.report(self.outf)
 
2921
                    return 0
 
2922
            merger.check_basis(not force)
 
2923
            if preview:
 
2924
                return self._do_preview(merger)
 
2925
            else:
 
2926
                return self._do_merge(merger, change_reporter, allow_pending,
 
2927
                                      verified)
 
2928
        finally:
 
2929
            for cleanup in reversed(cleanups):
 
2930
                cleanup()
 
2931
 
 
2932
    def _do_preview(self, merger):
 
2933
        from bzrlib.diff import show_diff_trees
 
2934
        tree_merger = merger.make_merger()
 
2935
        tt = tree_merger.make_preview_transform()
 
2936
        try:
 
2937
            result_tree = tt.get_preview_tree()
 
2938
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2939
                            old_label='', new_label='')
 
2940
        finally:
 
2941
            tt.finalize()
 
2942
 
 
2943
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
2944
        merger.change_reporter = change_reporter
 
2945
        conflict_count = merger.do_merge()
 
2946
        if allow_pending:
 
2947
            merger.set_pending()
 
2948
        if verified == 'failed':
 
2949
            warning('Preview patch does not match changes')
 
2950
        if conflict_count != 0:
 
2951
            return 1
 
2952
        else:
 
2953
            return 0
 
2954
 
 
2955
    def sanity_check_merger(self, merger):
 
2956
        if (merger.show_base and
 
2957
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2958
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2959
                                         " merge type. %s" % merger.merge_type)
 
2960
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2961
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2962
                                         " for merge type %s." %
 
2963
                                         merger.merge_type)
 
2964
        if merger.reprocess and merger.show_base:
 
2965
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2966
                                         " show base.")
 
2967
 
 
2968
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2969
                                possible_transports, pb):
 
2970
        """Produce a merger from a location, assuming it refers to a branch."""
 
2971
        from bzrlib.tag import _merge_tags_if_possible
 
2972
        # find the branch locations
 
2973
        other_loc, user_location = self._select_branch_location(tree, location,
 
2974
            revision, -1)
 
2975
        if revision is not None and len(revision) == 2:
 
2976
            base_loc, _unused = self._select_branch_location(tree,
 
2977
                location, revision, 0)
 
2978
        else:
 
2979
            base_loc = other_loc
 
2980
        # Open the branches
 
2981
        other_branch, other_path = Branch.open_containing(other_loc,
 
2982
            possible_transports)
 
2983
        if base_loc == other_loc:
 
2984
            base_branch = other_branch
 
2985
        else:
 
2986
            base_branch, base_path = Branch.open_containing(base_loc,
 
2987
                possible_transports)
 
2988
        # Find the revision ids
 
2989
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2990
            other_revision_id = _mod_revision.ensure_null(
 
2991
                other_branch.last_revision())
 
2992
        else:
 
2993
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
2994
        if (revision is not None and len(revision) == 2
 
2995
            and revision[0] is not None):
 
2996
            base_revision_id = revision[0].as_revision_id(base_branch)
 
2997
        else:
 
2998
            base_revision_id = None
 
2999
        # Remember where we merge from
 
3000
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3001
             user_location is not None):
 
3002
            tree.branch.set_submit_branch(other_branch.base)
 
3003
        _merge_tags_if_possible(other_branch, tree.branch)
 
3004
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3005
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3006
        if other_path != '':
 
3007
            allow_pending = False
 
3008
            merger.interesting_files = [other_path]
 
3009
        else:
 
3010
            allow_pending = True
 
3011
        return merger, allow_pending
 
3012
 
 
3013
    def _select_branch_location(self, tree, user_location, revision=None,
 
3014
                                index=None):
 
3015
        """Select a branch location, according to possible inputs.
 
3016
 
 
3017
        If provided, branches from ``revision`` are preferred.  (Both
 
3018
        ``revision`` and ``index`` must be supplied.)
 
3019
 
 
3020
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3021
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3022
 
 
3023
        :param tree: The working tree to select a branch for merging into
 
3024
        :param location: The location entered by the user
 
3025
        :param revision: The revision parameter to the command
 
3026
        :param index: The index to use for the revision parameter.  Negative
 
3027
            indices are permitted.
 
3028
        :return: (selected_location, user_location).  The default location
 
3029
            will be the user-entered location.
 
3030
        """
 
3031
        if (revision is not None and index is not None
 
3032
            and revision[index] is not None):
 
3033
            branch = revision[index].get_branch()
 
3034
            if branch is not None:
 
3035
                return branch, branch
 
3036
        if user_location is None:
 
3037
            location = self._get_remembered(tree, 'Merging from')
 
3038
        else:
 
3039
            location = user_location
 
3040
        return location, user_location
 
3041
 
 
3042
    def _get_remembered(self, tree, verb_string):
 
3043
        """Use tree.branch's parent if none was supplied.
 
3044
 
 
3045
        Report if the remembered location was used.
 
3046
        """
 
3047
        stored_location = tree.branch.get_submit_branch()
 
3048
        if stored_location is None:
 
3049
            stored_location = tree.branch.get_parent()
 
3050
        mutter("%s", stored_location)
 
3051
        if stored_location is None:
 
3052
            raise errors.BzrCommandError("No location specified or remembered")
 
3053
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3054
        note(u"%s remembered location %s", verb_string, display_url)
 
3055
        return stored_location
 
3056
 
 
3057
 
 
3058
class cmd_remerge(Command):
 
3059
    """Redo a merge.
 
3060
 
 
3061
    Use this if you want to try a different merge technique while resolving
 
3062
    conflicts.  Some merge techniques are better than others, and remerge 
 
3063
    lets you try different ones on different files.
 
3064
 
 
3065
    The options for remerge have the same meaning and defaults as the ones for
 
3066
    merge.  The difference is that remerge can (only) be run when there is a
 
3067
    pending merge, and it lets you specify particular files.
 
3068
 
 
3069
    :Examples:
 
3070
        Re-do the merge of all conflicted files, and show the base text in
 
3071
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3072
      
 
3073
            bzr remerge --show-base
 
3074
 
 
3075
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3076
        additional processing to reduce the size of conflict regions::
 
3077
      
 
3078
            bzr remerge --merge-type weave --reprocess foobar
 
3079
    """
 
3080
    takes_args = ['file*']
 
3081
    takes_options = [
 
3082
            'merge-type',
 
3083
            'reprocess',
 
3084
            Option('show-base',
 
3085
                   help="Show base revision text in conflicts."),
 
3086
            ]
 
3087
 
 
3088
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3089
            reprocess=False):
 
3090
        if merge_type is None:
 
3091
            merge_type = _mod_merge.Merge3Merger
 
3092
        tree, file_list = tree_files(file_list)
 
3093
        tree.lock_write()
 
3094
        try:
 
3095
            parents = tree.get_parent_ids()
 
3096
            if len(parents) != 2:
 
3097
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3098
                                             " merges.  Not cherrypicking or"
 
3099
                                             " multi-merges.")
 
3100
            repository = tree.branch.repository
 
3101
            interesting_ids = None
 
3102
            new_conflicts = []
 
3103
            conflicts = tree.conflicts()
 
3104
            if file_list is not None:
 
3105
                interesting_ids = set()
 
3106
                for filename in file_list:
 
3107
                    file_id = tree.path2id(filename)
 
3108
                    if file_id is None:
 
3109
                        raise errors.NotVersionedError(filename)
 
3110
                    interesting_ids.add(file_id)
 
3111
                    if tree.kind(file_id) != "directory":
 
3112
                        continue
 
3113
                    
 
3114
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3115
                        interesting_ids.add(ie.file_id)
 
3116
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3117
            else:
 
3118
                # Remerge only supports resolving contents conflicts
 
3119
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3120
                restore_files = [c.path for c in conflicts
 
3121
                                 if c.typestring in allowed_conflicts]
 
3122
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3123
            tree.set_conflicts(ConflictList(new_conflicts))
 
3124
            if file_list is not None:
 
3125
                restore_files = file_list
 
3126
            for filename in restore_files:
 
3127
                try:
 
3128
                    restore(tree.abspath(filename))
 
3129
                except errors.NotConflicted:
 
3130
                    pass
 
3131
            # Disable pending merges, because the file texts we are remerging
 
3132
            # have not had those merges performed.  If we use the wrong parents
 
3133
            # list, we imply that the working tree text has seen and rejected
 
3134
            # all the changes from the other tree, when in fact those changes
 
3135
            # have not yet been seen.
 
3136
            pb = ui.ui_factory.nested_progress_bar()
 
3137
            tree.set_parent_ids(parents[:1])
 
3138
            try:
 
3139
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3140
                                                             tree, parents[1])
 
3141
                merger.interesting_ids = interesting_ids
 
3142
                merger.merge_type = merge_type
 
3143
                merger.show_base = show_base
 
3144
                merger.reprocess = reprocess
 
3145
                conflicts = merger.do_merge()
 
3146
            finally:
 
3147
                tree.set_parent_ids(parents)
 
3148
                pb.finished()
 
3149
        finally:
 
3150
            tree.unlock()
 
3151
        if conflicts > 0:
 
3152
            return 1
 
3153
        else:
 
3154
            return 0
 
3155
 
 
3156
 
 
3157
class cmd_revert(Command):
 
3158
    """Revert files to a previous revision.
 
3159
 
 
3160
    Giving a list of files will revert only those files.  Otherwise, all files
 
3161
    will be reverted.  If the revision is not specified with '--revision', the
 
3162
    last committed revision is used.
 
3163
 
 
3164
    To remove only some changes, without reverting to a prior version, use
 
3165
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3166
    changes introduced by -2, without affecting the changes introduced by -1.
 
3167
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3168
    
 
3169
    By default, any files that have been manually changed will be backed up
 
3170
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3171
    '.~#~' appended to their name, where # is a number.
 
3172
 
 
3173
    When you provide files, you can use their current pathname or the pathname
 
3174
    from the target revision.  So you can use revert to "undelete" a file by
 
3175
    name.  If you name a directory, all the contents of that directory will be
 
3176
    reverted.
 
3177
 
 
3178
    Any files that have been newly added since that revision will be deleted,
 
3179
    with a backup kept if appropriate.  Directories containing unknown files
 
3180
    will not be deleted.
 
3181
 
 
3182
    The working tree contains a list of pending merged revisions, which will
 
3183
    be included as parents in the next commit.  Normally, revert clears that
 
3184
    list as well as reverting the files.  If any files are specified, revert
 
3185
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3186
    revert ." in the tree root to revert all files but keep the merge record,
 
3187
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3188
    reverting any files.
 
3189
    """
 
3190
 
 
3191
    _see_also = ['cat', 'export']
 
3192
    takes_options = [
 
3193
        'revision',
 
3194
        Option('no-backup', "Do not save backups of reverted files."),
 
3195
        Option('forget-merges',
 
3196
               'Remove pending merge marker, without changing any files.'),
 
3197
        ]
 
3198
    takes_args = ['file*']
 
3199
 
 
3200
    def run(self, revision=None, no_backup=False, file_list=None,
 
3201
            forget_merges=None):
 
3202
        tree, file_list = tree_files(file_list)
 
3203
        if forget_merges:
 
3204
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3205
        else:
 
3206
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3207
 
 
3208
    @staticmethod
 
3209
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3210
        if revision is None:
 
3211
            rev_id = tree.last_revision()
 
3212
        elif len(revision) != 1:
 
3213
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3214
        else:
 
3215
            rev_id = revision[0].as_revision_id(tree.branch)
 
3216
        pb = ui.ui_factory.nested_progress_bar()
 
3217
        try:
 
3218
            tree.revert(file_list,
 
3219
                        tree.branch.repository.revision_tree(rev_id),
 
3220
                        not no_backup, pb, report_changes=True)
 
3221
        finally:
 
3222
            pb.finished()
 
3223
 
 
3224
 
 
3225
class cmd_assert_fail(Command):
 
3226
    """Test reporting of assertion failures"""
 
3227
    # intended just for use in testing
 
3228
 
 
3229
    hidden = True
 
3230
 
 
3231
    def run(self):
 
3232
        raise AssertionError("always fails")
 
3233
 
 
3234
 
 
3235
class cmd_help(Command):
 
3236
    """Show help on a command or other topic.
 
3237
    """
 
3238
 
 
3239
    _see_also = ['topics']
 
3240
    takes_options = [
 
3241
            Option('long', 'Show help on all commands.'),
 
3242
            ]
 
3243
    takes_args = ['topic?']
 
3244
    aliases = ['?', '--help', '-?', '-h']
 
3245
    
 
3246
    @display_command
 
3247
    def run(self, topic=None, long=False):
 
3248
        import bzrlib.help
 
3249
        if topic is None and long:
 
3250
            topic = "commands"
 
3251
        bzrlib.help.help(topic)
 
3252
 
 
3253
 
 
3254
class cmd_shell_complete(Command):
 
3255
    """Show appropriate completions for context.
 
3256
 
 
3257
    For a list of all available commands, say 'bzr shell-complete'.
 
3258
    """
 
3259
    takes_args = ['context?']
 
3260
    aliases = ['s-c']
 
3261
    hidden = True
 
3262
    
 
3263
    @display_command
 
3264
    def run(self, context=None):
 
3265
        import shellcomplete
 
3266
        shellcomplete.shellcomplete(context)
 
3267
 
 
3268
 
 
3269
class cmd_fetch(Command):
 
3270
    """Copy in history from another branch but don't merge it.
 
3271
 
 
3272
    This is an internal method used for pull and merge.
 
3273
    """
 
3274
    hidden = True
 
3275
    takes_args = ['from_branch', 'to_branch']
 
3276
    def run(self, from_branch, to_branch):
 
3277
        from bzrlib.fetch import Fetcher
 
3278
        from_b = Branch.open(from_branch)
 
3279
        to_b = Branch.open(to_branch)
 
3280
        Fetcher(to_b, from_b)
 
3281
 
 
3282
 
 
3283
class cmd_missing(Command):
 
3284
    """Show unmerged/unpulled revisions between two branches.
 
3285
    
 
3286
    OTHER_BRANCH may be local or remote.
 
3287
    """
 
3288
 
 
3289
    _see_also = ['merge', 'pull']
 
3290
    takes_args = ['other_branch?']
 
3291
    takes_options = [
 
3292
            Option('reverse', 'Reverse the order of revisions.'),
 
3293
            Option('mine-only',
 
3294
                   'Display changes in the local branch only.'),
 
3295
            Option('this' , 'Same as --mine-only.'),
 
3296
            Option('theirs-only',
 
3297
                   'Display changes in the remote branch only.'),
 
3298
            Option('other', 'Same as --theirs-only.'),
 
3299
            'log-format',
 
3300
            'show-ids',
 
3301
            'verbose'
 
3302
            ]
 
3303
    encoding_type = 'replace'
 
3304
 
 
3305
    @display_command
 
3306
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3307
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3308
            show_ids=False, verbose=False, this=False, other=False):
 
3309
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3310
 
 
3311
        if this:
 
3312
            mine_only = this
 
3313
        if other:
 
3314
            theirs_only = other
 
3315
        # TODO: We should probably check that we don't have mine-only and
 
3316
        #       theirs-only set, but it gets complicated because we also have
 
3317
        #       this and other which could be used.
 
3318
        restrict = 'all'
 
3319
        if mine_only:
 
3320
            restrict = 'local'
 
3321
        elif theirs_only:
 
3322
            restrict = 'remote'
 
3323
 
 
3324
        local_branch = Branch.open_containing(u".")[0]
 
3325
        parent = local_branch.get_parent()
 
3326
        if other_branch is None:
 
3327
            other_branch = parent
 
3328
            if other_branch is None:
 
3329
                raise errors.BzrCommandError("No peer location known"
 
3330
                                             " or specified.")
 
3331
            display_url = urlutils.unescape_for_display(parent,
 
3332
                                                        self.outf.encoding)
 
3333
            self.outf.write("Using last location: " + display_url + "\n")
 
3334
 
 
3335
        remote_branch = Branch.open(other_branch)
 
3336
        if remote_branch.base == local_branch.base:
 
3337
            remote_branch = local_branch
 
3338
        local_branch.lock_read()
 
3339
        try:
 
3340
            remote_branch.lock_read()
 
3341
            try:
 
3342
                local_extra, remote_extra = find_unmerged(
 
3343
                    local_branch, remote_branch, restrict)
 
3344
 
 
3345
                if log_format is None:
 
3346
                    registry = log.log_formatter_registry
 
3347
                    log_format = registry.get_default(local_branch)
 
3348
                lf = log_format(to_file=self.outf,
 
3349
                                show_ids=show_ids,
 
3350
                                show_timezone='original')
 
3351
                if reverse is False:
 
3352
                    if local_extra is not None:
 
3353
                        local_extra.reverse()
 
3354
                    if remote_extra is not None:
 
3355
                        remote_extra.reverse()
 
3356
 
 
3357
                status_code = 0
 
3358
                if local_extra and not theirs_only:
 
3359
                    self.outf.write("You have %d extra revision(s):\n" %
 
3360
                                    len(local_extra))
 
3361
                    for revision in iter_log_revisions(local_extra,
 
3362
                                        local_branch.repository,
 
3363
                                        verbose):
 
3364
                        lf.log_revision(revision)
 
3365
                    printed_local = True
 
3366
                    status_code = 1
 
3367
                else:
 
3368
                    printed_local = False
 
3369
 
 
3370
                if remote_extra and not mine_only:
 
3371
                    if printed_local is True:
 
3372
                        self.outf.write("\n\n\n")
 
3373
                    self.outf.write("You are missing %d revision(s):\n" %
 
3374
                                    len(remote_extra))
 
3375
                    for revision in iter_log_revisions(remote_extra,
 
3376
                                        remote_branch.repository,
 
3377
                                        verbose):
 
3378
                        lf.log_revision(revision)
 
3379
                    status_code = 1
 
3380
 
 
3381
                if mine_only and not local_extra:
 
3382
                    # We checked local, and found nothing extra
 
3383
                    self.outf.write('This branch is up to date.\n')
 
3384
                elif theirs_only and not remote_extra:
 
3385
                    # We checked remote, and found nothing extra
 
3386
                    self.outf.write('Other branch is up to date.\n')
 
3387
                elif not (mine_only or theirs_only or local_extra or
 
3388
                          remote_extra):
 
3389
                    # We checked both branches, and neither one had extra
 
3390
                    # revisions
 
3391
                    self.outf.write("Branches are up to date.\n")
 
3392
            finally:
 
3393
                remote_branch.unlock()
 
3394
        finally:
 
3395
            local_branch.unlock()
 
3396
        if not status_code and parent is None and other_branch is not None:
 
3397
            local_branch.lock_write()
 
3398
            try:
 
3399
                # handle race conditions - a parent might be set while we run.
 
3400
                if local_branch.get_parent() is None:
 
3401
                    local_branch.set_parent(remote_branch.base)
 
3402
            finally:
 
3403
                local_branch.unlock()
 
3404
        return status_code
 
3405
 
 
3406
 
 
3407
class cmd_pack(Command):
 
3408
    """Compress the data within a repository."""
 
3409
 
 
3410
    _see_also = ['repositories']
 
3411
    takes_args = ['branch_or_repo?']
 
3412
 
 
3413
    def run(self, branch_or_repo='.'):
 
3414
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3415
        try:
 
3416
            branch = dir.open_branch()
 
3417
            repository = branch.repository
 
3418
        except errors.NotBranchError:
 
3419
            repository = dir.open_repository()
 
3420
        repository.pack()
 
3421
 
 
3422
 
 
3423
class cmd_plugins(Command):
 
3424
    """List the installed plugins.
 
3425
    
 
3426
    This command displays the list of installed plugins including
 
3427
    version of plugin and a short description of each.
 
3428
 
 
3429
    --verbose shows the path where each plugin is located.
 
3430
 
 
3431
    A plugin is an external component for Bazaar that extends the
 
3432
    revision control system, by adding or replacing code in Bazaar.
 
3433
    Plugins can do a variety of things, including overriding commands,
 
3434
    adding new commands, providing additional network transports and
 
3435
    customizing log output.
 
3436
 
 
3437
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3438
    information on plugins including where to find them and how to
 
3439
    install them. Instructions are also provided there on how to
 
3440
    write new plugins using the Python programming language.
 
3441
    """
 
3442
    takes_options = ['verbose']
 
3443
 
 
3444
    @display_command
 
3445
    def run(self, verbose=False):
 
3446
        import bzrlib.plugin
 
3447
        from inspect import getdoc
 
3448
        result = []
 
3449
        for name, plugin in bzrlib.plugin.plugins().items():
 
3450
            version = plugin.__version__
 
3451
            if version == 'unknown':
 
3452
                version = ''
 
3453
            name_ver = '%s %s' % (name, version)
 
3454
            d = getdoc(plugin.module)
 
3455
            if d:
 
3456
                doc = d.split('\n')[0]
 
3457
            else:
 
3458
                doc = '(no description)'
 
3459
            result.append((name_ver, doc, plugin.path()))
 
3460
        for name_ver, doc, path in sorted(result):
 
3461
            print name_ver
 
3462
            print '   ', doc
 
3463
            if verbose:
 
3464
                print '   ', path
 
3465
            print
 
3466
 
 
3467
 
 
3468
class cmd_testament(Command):
 
3469
    """Show testament (signing-form) of a revision."""
 
3470
    takes_options = [
 
3471
            'revision',
 
3472
            Option('long', help='Produce long-format testament.'),
 
3473
            Option('strict',
 
3474
                   help='Produce a strict-format testament.')]
 
3475
    takes_args = ['branch?']
 
3476
    @display_command
 
3477
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3478
        from bzrlib.testament import Testament, StrictTestament
 
3479
        if strict is True:
 
3480
            testament_class = StrictTestament
 
3481
        else:
 
3482
            testament_class = Testament
 
3483
        b = WorkingTree.open_containing(branch)[0].branch
 
3484
        b.lock_read()
 
3485
        try:
 
3486
            if revision is None:
 
3487
                rev_id = b.last_revision()
 
3488
            else:
 
3489
                rev_id = revision[0].as_revision_id(b)
 
3490
            t = testament_class.from_revision(b.repository, rev_id)
 
3491
            if long:
 
3492
                sys.stdout.writelines(t.as_text_lines())
 
3493
            else:
 
3494
                sys.stdout.write(t.as_short_text())
 
3495
        finally:
 
3496
            b.unlock()
 
3497
 
 
3498
 
 
3499
class cmd_annotate(Command):
 
3500
    """Show the origin of each line in a file.
 
3501
 
 
3502
    This prints out the given file with an annotation on the left side
 
3503
    indicating which revision, author and date introduced the change.
 
3504
 
 
3505
    If the origin is the same for a run of consecutive lines, it is 
 
3506
    shown only at the top, unless the --all option is given.
 
3507
    """
 
3508
    # TODO: annotate directories; showing when each file was last changed
 
3509
    # TODO: if the working copy is modified, show annotations on that 
 
3510
    #       with new uncommitted lines marked
 
3511
    aliases = ['ann', 'blame', 'praise']
 
3512
    takes_args = ['filename']
 
3513
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3514
                     Option('long', help='Show commit date in annotations.'),
 
3515
                     'revision',
 
3516
                     'show-ids',
 
3517
                     ]
 
3518
    encoding_type = 'exact'
 
3519
 
 
3520
    @display_command
 
3521
    def run(self, filename, all=False, long=False, revision=None,
 
3522
            show_ids=False):
 
3523
        from bzrlib.annotate import annotate_file
 
3524
        wt, branch, relpath = \
 
3525
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3526
        if wt is not None:
 
3527
            wt.lock_read()
 
3528
        else:
 
3529
            branch.lock_read()
 
3530
        try:
 
3531
            if revision is None:
 
3532
                revision_id = branch.last_revision()
 
3533
            elif len(revision) != 1:
 
3534
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3535
            else:
 
3536
                revision_id = revision[0].as_revision_id(branch)
 
3537
            tree = branch.repository.revision_tree(revision_id)
 
3538
            if wt is not None:
 
3539
                file_id = wt.path2id(relpath)
 
3540
            else:
 
3541
                file_id = tree.path2id(relpath)
 
3542
            if file_id is None:
 
3543
                raise errors.NotVersionedError(filename)
 
3544
            file_version = tree.inventory[file_id].revision
 
3545
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3546
                          show_ids=show_ids)
 
3547
        finally:
 
3548
            if wt is not None:
 
3549
                wt.unlock()
 
3550
            else:
 
3551
                branch.unlock()
 
3552
 
 
3553
 
 
3554
class cmd_re_sign(Command):
 
3555
    """Create a digital signature for an existing revision."""
 
3556
    # TODO be able to replace existing ones.
 
3557
 
 
3558
    hidden = True # is this right ?
 
3559
    takes_args = ['revision_id*']
 
3560
    takes_options = ['revision']
 
3561
    
 
3562
    def run(self, revision_id_list=None, revision=None):
 
3563
        if revision_id_list is not None and revision is not None:
 
3564
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3565
        if revision_id_list is None and revision is None:
 
3566
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3567
        b = WorkingTree.open_containing(u'.')[0].branch
 
3568
        b.lock_write()
 
3569
        try:
 
3570
            return self._run(b, revision_id_list, revision)
 
3571
        finally:
 
3572
            b.unlock()
 
3573
 
 
3574
    def _run(self, b, revision_id_list, revision):
 
3575
        import bzrlib.gpg as gpg
 
3576
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3577
        if revision_id_list is not None:
 
3578
            b.repository.start_write_group()
 
3579
            try:
 
3580
                for revision_id in revision_id_list:
 
3581
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3582
            except:
 
3583
                b.repository.abort_write_group()
 
3584
                raise
 
3585
            else:
 
3586
                b.repository.commit_write_group()
 
3587
        elif revision is not None:
 
3588
            if len(revision) == 1:
 
3589
                revno, rev_id = revision[0].in_history(b)
 
3590
                b.repository.start_write_group()
 
3591
                try:
 
3592
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3593
                except:
 
3594
                    b.repository.abort_write_group()
 
3595
                    raise
 
3596
                else:
 
3597
                    b.repository.commit_write_group()
 
3598
            elif len(revision) == 2:
 
3599
                # are they both on rh- if so we can walk between them
 
3600
                # might be nice to have a range helper for arbitrary
 
3601
                # revision paths. hmm.
 
3602
                from_revno, from_revid = revision[0].in_history(b)
 
3603
                to_revno, to_revid = revision[1].in_history(b)
 
3604
                if to_revid is None:
 
3605
                    to_revno = b.revno()
 
3606
                if from_revno is None or to_revno is None:
 
3607
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3608
                b.repository.start_write_group()
 
3609
                try:
 
3610
                    for revno in range(from_revno, to_revno + 1):
 
3611
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3612
                                                   gpg_strategy)
 
3613
                except:
 
3614
                    b.repository.abort_write_group()
 
3615
                    raise
 
3616
                else:
 
3617
                    b.repository.commit_write_group()
 
3618
            else:
 
3619
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3620
 
 
3621
 
 
3622
class cmd_bind(Command):
 
3623
    """Convert the current branch into a checkout of the supplied branch.
 
3624
 
 
3625
    Once converted into a checkout, commits must succeed on the master branch
 
3626
    before they will be applied to the local branch.
 
3627
    """
 
3628
 
 
3629
    _see_also = ['checkouts', 'unbind']
 
3630
    takes_args = ['location?']
 
3631
    takes_options = []
 
3632
 
 
3633
    def run(self, location=None):
 
3634
        b, relpath = Branch.open_containing(u'.')
 
3635
        if location is None:
 
3636
            try:
 
3637
                location = b.get_old_bound_location()
 
3638
            except errors.UpgradeRequired:
 
3639
                raise errors.BzrCommandError('No location supplied.  '
 
3640
                    'This format does not remember old locations.')
 
3641
            else:
 
3642
                if location is None:
 
3643
                    raise errors.BzrCommandError('No location supplied and no '
 
3644
                        'previous location known')
 
3645
        b_other = Branch.open(location)
 
3646
        try:
 
3647
            b.bind(b_other)
 
3648
        except errors.DivergedBranches:
 
3649
            raise errors.BzrCommandError('These branches have diverged.'
 
3650
                                         ' Try merging, and then bind again.')
 
3651
 
 
3652
 
 
3653
class cmd_unbind(Command):
 
3654
    """Convert the current checkout into a regular branch.
 
3655
 
 
3656
    After unbinding, the local branch is considered independent and subsequent
 
3657
    commits will be local only.
 
3658
    """
 
3659
 
 
3660
    _see_also = ['checkouts', 'bind']
 
3661
    takes_args = []
 
3662
    takes_options = []
 
3663
 
 
3664
    def run(self):
 
3665
        b, relpath = Branch.open_containing(u'.')
 
3666
        if not b.unbind():
 
3667
            raise errors.BzrCommandError('Local branch is not bound')
 
3668
 
 
3669
 
 
3670
class cmd_uncommit(Command):
 
3671
    """Remove the last committed revision.
 
3672
 
 
3673
    --verbose will print out what is being removed.
 
3674
    --dry-run will go through all the motions, but not actually
 
3675
    remove anything.
 
3676
 
 
3677
    If --revision is specified, uncommit revisions to leave the branch at the
 
3678
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3679
    branch at revision 15.
 
3680
 
 
3681
    Uncommit leaves the working tree ready for a new commit.  The only change
 
3682
    it may make is to restore any pending merges that were present before
 
3683
    the commit.
 
3684
    """
 
3685
 
 
3686
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3687
    # unreferenced information in 'branch-as-repository' branches.
 
3688
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3689
    # information in shared branches as well.
 
3690
    _see_also = ['commit']
 
3691
    takes_options = ['verbose', 'revision',
 
3692
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3693
                    Option('force', help='Say yes to all questions.'),
 
3694
                    Option('local',
 
3695
                           help="Only remove the commits from the local branch"
 
3696
                                " when in a checkout."
 
3697
                           ),
 
3698
                    ]
 
3699
    takes_args = ['location?']
 
3700
    aliases = []
 
3701
    encoding_type = 'replace'
 
3702
 
 
3703
    def run(self, location=None,
 
3704
            dry_run=False, verbose=False,
 
3705
            revision=None, force=False, local=False):
 
3706
        if location is None:
 
3707
            location = u'.'
 
3708
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3709
        try:
 
3710
            tree = control.open_workingtree()
 
3711
            b = tree.branch
 
3712
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3713
            tree = None
 
3714
            b = control.open_branch()
 
3715
 
 
3716
        if tree is not None:
 
3717
            tree.lock_write()
 
3718
        else:
 
3719
            b.lock_write()
 
3720
        try:
 
3721
            return self._run(b, tree, dry_run, verbose, revision, force,
 
3722
                             local=local)
 
3723
        finally:
 
3724
            if tree is not None:
 
3725
                tree.unlock()
 
3726
            else:
 
3727
                b.unlock()
 
3728
 
 
3729
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
3730
        from bzrlib.log import log_formatter, show_log
 
3731
        from bzrlib.uncommit import uncommit
 
3732
 
 
3733
        last_revno, last_rev_id = b.last_revision_info()
 
3734
 
 
3735
        rev_id = None
 
3736
        if revision is None:
 
3737
            revno = last_revno
 
3738
            rev_id = last_rev_id
 
3739
        else:
 
3740
            # 'bzr uncommit -r 10' actually means uncommit
 
3741
            # so that the final tree is at revno 10.
 
3742
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3743
            # the revisions that are supplied.
 
3744
            # So we need to offset it by one
 
3745
            revno = revision[0].in_history(b).revno + 1
 
3746
            if revno <= last_revno:
 
3747
                rev_id = b.get_rev_id(revno)
 
3748
 
 
3749
        if rev_id is None or _mod_revision.is_null(rev_id):
 
3750
            self.outf.write('No revisions to uncommit.\n')
 
3751
            return 1
 
3752
 
 
3753
        lf = log_formatter('short',
 
3754
                           to_file=self.outf,
 
3755
                           show_timezone='original')
 
3756
 
 
3757
        show_log(b,
 
3758
                 lf,
 
3759
                 verbose=False,
 
3760
                 direction='forward',
 
3761
                 start_revision=revno,
 
3762
                 end_revision=last_revno)
 
3763
 
 
3764
        if dry_run:
 
3765
            print 'Dry-run, pretending to remove the above revisions.'
 
3766
            if not force:
 
3767
                val = raw_input('Press <enter> to continue')
 
3768
        else:
 
3769
            print 'The above revision(s) will be removed.'
 
3770
            if not force:
 
3771
                val = raw_input('Are you sure [y/N]? ')
 
3772
                if val.lower() not in ('y', 'yes'):
 
3773
                    print 'Canceled'
 
3774
                    return 0
 
3775
 
 
3776
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3777
                 revno=revno, local=local)
 
3778
 
 
3779
 
 
3780
class cmd_break_lock(Command):
 
3781
    """Break a dead lock on a repository, branch or working directory.
 
3782
 
 
3783
    CAUTION: Locks should only be broken when you are sure that the process
 
3784
    holding the lock has been stopped.
 
3785
 
 
3786
    You can get information on what locks are open via the 'bzr info' command.
 
3787
    
 
3788
    :Examples:
 
3789
        bzr break-lock
 
3790
    """
 
3791
    takes_args = ['location?']
 
3792
 
 
3793
    def run(self, location=None, show=False):
 
3794
        if location is None:
 
3795
            location = u'.'
 
3796
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3797
        try:
 
3798
            control.break_lock()
 
3799
        except NotImplementedError:
 
3800
            pass
 
3801
        
 
3802
 
 
3803
class cmd_wait_until_signalled(Command):
 
3804
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3805
 
 
3806
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3807
    """
 
3808
 
 
3809
    hidden = True
 
3810
 
 
3811
    def run(self):
 
3812
        sys.stdout.write("running\n")
 
3813
        sys.stdout.flush()
 
3814
        sys.stdin.readline()
 
3815
 
 
3816
 
 
3817
class cmd_serve(Command):
 
3818
    """Run the bzr server."""
 
3819
 
 
3820
    aliases = ['server']
 
3821
 
 
3822
    takes_options = [
 
3823
        Option('inet',
 
3824
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3825
        Option('port',
 
3826
               help='Listen for connections on nominated port of the form '
 
3827
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3828
                    'result in a dynamically allocated port.  The default port is '
 
3829
                    '4155.',
 
3830
               type=str),
 
3831
        Option('directory',
 
3832
               help='Serve contents of this directory.',
 
3833
               type=unicode),
 
3834
        Option('allow-writes',
 
3835
               help='By default the server is a readonly server.  Supplying '
 
3836
                    '--allow-writes enables write access to the contents of '
 
3837
                    'the served directory and below.'
 
3838
                ),
 
3839
        ]
 
3840
 
 
3841
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3842
        from bzrlib import lockdir
 
3843
        from bzrlib.smart import medium, server
 
3844
        from bzrlib.transport import get_transport
 
3845
        from bzrlib.transport.chroot import ChrootServer
 
3846
        if directory is None:
 
3847
            directory = os.getcwd()
 
3848
        url = urlutils.local_path_to_url(directory)
 
3849
        if not allow_writes:
 
3850
            url = 'readonly+' + url
 
3851
        chroot_server = ChrootServer(get_transport(url))
 
3852
        chroot_server.setUp()
 
3853
        t = get_transport(chroot_server.get_url())
 
3854
        if inet:
 
3855
            smart_server = medium.SmartServerPipeStreamMedium(
 
3856
                sys.stdin, sys.stdout, t)
 
3857
        else:
 
3858
            host = medium.BZR_DEFAULT_INTERFACE
 
3859
            if port is None:
 
3860
                port = medium.BZR_DEFAULT_PORT
 
3861
            else:
 
3862
                if ':' in port:
 
3863
                    host, port = port.split(':')
 
3864
                port = int(port)
 
3865
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3866
            print 'listening on port: ', smart_server.port
 
3867
            sys.stdout.flush()
 
3868
        # for the duration of this server, no UI output is permitted.
 
3869
        # note that this may cause problems with blackbox tests. This should
 
3870
        # be changed with care though, as we dont want to use bandwidth sending
 
3871
        # progress over stderr to smart server clients!
 
3872
        old_factory = ui.ui_factory
 
3873
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3874
        try:
 
3875
            ui.ui_factory = ui.SilentUIFactory()
 
3876
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3877
            smart_server.serve()
 
3878
        finally:
 
3879
            ui.ui_factory = old_factory
 
3880
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
3881
 
 
3882
 
 
3883
class cmd_join(Command):
 
3884
    """Combine a subtree into its containing tree.
 
3885
    
 
3886
    This command is for experimental use only.  It requires the target tree
 
3887
    to be in dirstate-with-subtree format, which cannot be converted into
 
3888
    earlier formats.
 
3889
 
 
3890
    The TREE argument should be an independent tree, inside another tree, but
 
3891
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3892
    running "bzr branch" with the target inside a tree.)
 
3893
 
 
3894
    The result is a combined tree, with the subtree no longer an independant
 
3895
    part.  This is marked as a merge of the subtree into the containing tree,
 
3896
    and all history is preserved.
 
3897
 
 
3898
    If --reference is specified, the subtree retains its independence.  It can
 
3899
    be branched by itself, and can be part of multiple projects at the same
 
3900
    time.  But operations performed in the containing tree, such as commit
 
3901
    and merge, will recurse into the subtree.
 
3902
    """
 
3903
 
 
3904
    _see_also = ['split']
 
3905
    takes_args = ['tree']
 
3906
    takes_options = [
 
3907
            Option('reference', help='Join by reference.'),
 
3908
            ]
 
3909
    hidden = True
 
3910
 
 
3911
    def run(self, tree, reference=False):
 
3912
        sub_tree = WorkingTree.open(tree)
 
3913
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3914
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3915
        repo = containing_tree.branch.repository
 
3916
        if not repo.supports_rich_root():
 
3917
            raise errors.BzrCommandError(
 
3918
                "Can't join trees because %s doesn't support rich root data.\n"
 
3919
                "You can use bzr upgrade on the repository."
 
3920
                % (repo,))
 
3921
        if reference:
 
3922
            try:
 
3923
                containing_tree.add_reference(sub_tree)
 
3924
            except errors.BadReferenceTarget, e:
 
3925
                # XXX: Would be better to just raise a nicely printable
 
3926
                # exception from the real origin.  Also below.  mbp 20070306
 
3927
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3928
                                             (tree, e.reason))
 
3929
        else:
 
3930
            try:
 
3931
                containing_tree.subsume(sub_tree)
 
3932
            except errors.BadSubsumeSource, e:
 
3933
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3934
                                             (tree, e.reason))
 
3935
 
 
3936
 
 
3937
class cmd_split(Command):
 
3938
    """Split a subdirectory of a tree into a separate tree.
 
3939
 
 
3940
    This command will produce a target tree in a format that supports
 
3941
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
3942
    converted into earlier formats like 'dirstate-tags'.
 
3943
 
 
3944
    The TREE argument should be a subdirectory of a working tree.  That
 
3945
    subdirectory will be converted into an independent tree, with its own
 
3946
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3947
    """
 
3948
 
 
3949
    # join is not un-hidden yet
 
3950
    #_see_also = ['join']
 
3951
    takes_args = ['tree']
 
3952
 
 
3953
    def run(self, tree):
 
3954
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3955
        sub_id = containing_tree.path2id(subdir)
 
3956
        if sub_id is None:
 
3957
            raise errors.NotVersionedError(subdir)
 
3958
        try:
 
3959
            containing_tree.extract(sub_id)
 
3960
        except errors.RootNotRich:
 
3961
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3962
 
 
3963
 
 
3964
class cmd_merge_directive(Command):
 
3965
    """Generate a merge directive for auto-merge tools.
 
3966
 
 
3967
    A directive requests a merge to be performed, and also provides all the
 
3968
    information necessary to do so.  This means it must either include a
 
3969
    revision bundle, or the location of a branch containing the desired
 
3970
    revision.
 
3971
 
 
3972
    A submit branch (the location to merge into) must be supplied the first
 
3973
    time the command is issued.  After it has been supplied once, it will
 
3974
    be remembered as the default.
 
3975
 
 
3976
    A public branch is optional if a revision bundle is supplied, but required
 
3977
    if --diff or --plain is specified.  It will be remembered as the default
 
3978
    after the first use.
 
3979
    """
 
3980
 
 
3981
    takes_args = ['submit_branch?', 'public_branch?']
 
3982
 
 
3983
    hidden = True
 
3984
 
 
3985
    _see_also = ['send']
 
3986
 
 
3987
    takes_options = [
 
3988
        RegistryOption.from_kwargs('patch-type',
 
3989
            'The type of patch to include in the directive.',
 
3990
            title='Patch type',
 
3991
            value_switches=True,
 
3992
            enum_switch=False,
 
3993
            bundle='Bazaar revision bundle (default).',
 
3994
            diff='Normal unified diff.',
 
3995
            plain='No patch, just directive.'),
 
3996
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3997
        Option('mail-to', type=str,
 
3998
            help='Instead of printing the directive, email to this address.'),
 
3999
        Option('message', type=str, short_name='m',
 
4000
            help='Message to use when committing this merge.')
 
4001
        ]
 
4002
 
 
4003
    encoding_type = 'exact'
 
4004
 
 
4005
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4006
            sign=False, revision=None, mail_to=None, message=None):
 
4007
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4008
        include_patch, include_bundle = {
 
4009
            'plain': (False, False),
 
4010
            'diff': (True, False),
 
4011
            'bundle': (True, True),
 
4012
            }[patch_type]
 
4013
        branch = Branch.open('.')
 
4014
        stored_submit_branch = branch.get_submit_branch()
 
4015
        if submit_branch is None:
 
4016
            submit_branch = stored_submit_branch
 
4017
        else:
 
4018
            if stored_submit_branch is None:
 
4019
                branch.set_submit_branch(submit_branch)
 
4020
        if submit_branch is None:
 
4021
            submit_branch = branch.get_parent()
 
4022
        if submit_branch is None:
 
4023
            raise errors.BzrCommandError('No submit branch specified or known')
 
4024
 
 
4025
        stored_public_branch = branch.get_public_branch()
 
4026
        if public_branch is None:
 
4027
            public_branch = stored_public_branch
 
4028
        elif stored_public_branch is None:
 
4029
            branch.set_public_branch(public_branch)
 
4030
        if not include_bundle and public_branch is None:
 
4031
            raise errors.BzrCommandError('No public branch specified or'
 
4032
                                         ' known')
 
4033
        base_revision_id = None
 
4034
        if revision is not None:
 
4035
            if len(revision) > 2:
 
4036
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4037
                    'at most two one revision identifiers')
 
4038
            revision_id = revision[-1].as_revision_id(branch)
 
4039
            if len(revision) == 2:
 
4040
                base_revision_id = revision[0].as_revision_id(branch)
 
4041
        else:
 
4042
            revision_id = branch.last_revision()
 
4043
        revision_id = ensure_null(revision_id)
 
4044
        if revision_id == NULL_REVISION:
 
4045
            raise errors.BzrCommandError('No revisions to bundle.')
 
4046
        directive = merge_directive.MergeDirective2.from_objects(
 
4047
            branch.repository, revision_id, time.time(),
 
4048
            osutils.local_time_offset(), submit_branch,
 
4049
            public_branch=public_branch, include_patch=include_patch,
 
4050
            include_bundle=include_bundle, message=message,
 
4051
            base_revision_id=base_revision_id)
 
4052
        if mail_to is None:
 
4053
            if sign:
 
4054
                self.outf.write(directive.to_signed(branch))
 
4055
            else:
 
4056
                self.outf.writelines(directive.to_lines())
 
4057
        else:
 
4058
            message = directive.to_email(mail_to, branch, sign)
 
4059
            s = SMTPConnection(branch.get_config())
 
4060
            s.send_email(message)
 
4061
 
 
4062
 
 
4063
class cmd_send(Command):
 
4064
    """Mail or create a merge-directive for submiting changes.
 
4065
 
 
4066
    A merge directive provides many things needed for requesting merges:
 
4067
 
 
4068
    * A machine-readable description of the merge to perform
 
4069
 
 
4070
    * An optional patch that is a preview of the changes requested
 
4071
 
 
4072
    * An optional bundle of revision data, so that the changes can be applied
 
4073
      directly from the merge directive, without retrieving data from a
 
4074
      branch.
 
4075
 
 
4076
    If --no-bundle is specified, then public_branch is needed (and must be
 
4077
    up-to-date), so that the receiver can perform the merge using the
 
4078
    public_branch.  The public_branch is always included if known, so that
 
4079
    people can check it later.
 
4080
 
 
4081
    The submit branch defaults to the parent, but can be overridden.  Both
 
4082
    submit branch and public branch will be remembered if supplied.
 
4083
 
 
4084
    If a public_branch is known for the submit_branch, that public submit
 
4085
    branch is used in the merge instructions.  This means that a local mirror
 
4086
    can be used as your actual submit branch, once you have set public_branch
 
4087
    for that mirror.
 
4088
 
 
4089
    Mail is sent using your preferred mail program.  This should be transparent
 
4090
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4091
    If the preferred client can't be found (or used), your editor will be used.
 
4092
    
 
4093
    To use a specific mail program, set the mail_client configuration option.
 
4094
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4095
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4096
    generic options are "default", "editor", "mapi", and "xdg-email".
 
4097
 
 
4098
    If mail is being sent, a to address is required.  This can be supplied
 
4099
    either on the commandline, by setting the submit_to configuration
 
4100
    option in the branch itself or the child_submit_to configuration option 
 
4101
    in the submit branch.
 
4102
 
 
4103
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4104
    merge directive format 2.  It is significantly faster and smaller than
 
4105
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4106
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4107
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4108
    
 
4109
    Merge directives are applied using the merge command or the pull command.
 
4110
    """
 
4111
 
 
4112
    encoding_type = 'exact'
 
4113
 
 
4114
    _see_also = ['merge', 'pull']
 
4115
 
 
4116
    takes_args = ['submit_branch?', 'public_branch?']
 
4117
 
 
4118
    takes_options = [
 
4119
        Option('no-bundle',
 
4120
               help='Do not include a bundle in the merge directive.'),
 
4121
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4122
               ' directive.'),
 
4123
        Option('remember',
 
4124
               help='Remember submit and public branch.'),
 
4125
        Option('from',
 
4126
               help='Branch to generate the submission from, '
 
4127
               'rather than the one containing the working directory.',
 
4128
               short_name='f',
 
4129
               type=unicode),
 
4130
        Option('output', short_name='o',
 
4131
               help='Write merge directive to this file; '
 
4132
                    'use - for stdout.',
 
4133
               type=unicode),
 
4134
        Option('mail-to', help='Mail the request to this address.',
 
4135
               type=unicode),
 
4136
        'revision',
 
4137
        'message',
 
4138
        RegistryOption.from_kwargs('format',
 
4139
        'Use the specified output format.',
 
4140
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4141
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4142
        ]
 
4143
 
 
4144
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4145
            no_patch=False, revision=None, remember=False, output=None,
 
4146
            format='4', mail_to=None, message=None, **kwargs):
 
4147
        return self._run(submit_branch, revision, public_branch, remember,
 
4148
                         format, no_bundle, no_patch, output,
 
4149
                         kwargs.get('from', '.'), mail_to, message)
 
4150
 
 
4151
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4152
             no_bundle, no_patch, output, from_, mail_to, message):
 
4153
        from bzrlib.revision import NULL_REVISION
 
4154
        branch = Branch.open_containing(from_)[0]
 
4155
        if output is None:
 
4156
            outfile = StringIO()
 
4157
        elif output == '-':
 
4158
            outfile = self.outf
 
4159
        else:
 
4160
            outfile = open(output, 'wb')
 
4161
        # we may need to write data into branch's repository to calculate
 
4162
        # the data to send.
 
4163
        branch.lock_write()
 
4164
        try:
 
4165
            if output is None:
 
4166
                config = branch.get_config()
 
4167
                if mail_to is None:
 
4168
                    mail_to = config.get_user_option('submit_to')
 
4169
                mail_client = config.get_mail_client()
 
4170
            if remember and submit_branch is None:
 
4171
                raise errors.BzrCommandError(
 
4172
                    '--remember requires a branch to be specified.')
 
4173
            stored_submit_branch = branch.get_submit_branch()
 
4174
            remembered_submit_branch = False
 
4175
            if submit_branch is None:
 
4176
                submit_branch = stored_submit_branch
 
4177
                remembered_submit_branch = True
 
4178
            else:
 
4179
                if stored_submit_branch is None or remember:
 
4180
                    branch.set_submit_branch(submit_branch)
 
4181
            if submit_branch is None:
 
4182
                submit_branch = branch.get_parent()
 
4183
                remembered_submit_branch = True
 
4184
            if submit_branch is None:
 
4185
                raise errors.BzrCommandError('No submit branch known or'
 
4186
                                             ' specified')
 
4187
            if remembered_submit_branch:
 
4188
                note('Using saved location: %s', submit_branch)
 
4189
 
 
4190
            if mail_to is None:
 
4191
                submit_config = Branch.open(submit_branch).get_config()
 
4192
                mail_to = submit_config.get_user_option("child_submit_to")
 
4193
 
 
4194
            stored_public_branch = branch.get_public_branch()
 
4195
            if public_branch is None:
 
4196
                public_branch = stored_public_branch
 
4197
            elif stored_public_branch is None or remember:
 
4198
                branch.set_public_branch(public_branch)
 
4199
            if no_bundle and public_branch is None:
 
4200
                raise errors.BzrCommandError('No public branch specified or'
 
4201
                                             ' known')
 
4202
            base_revision_id = None
 
4203
            revision_id = None
 
4204
            if revision is not None:
 
4205
                if len(revision) > 2:
 
4206
                    raise errors.BzrCommandError('bzr send takes '
 
4207
                        'at most two one revision identifiers')
 
4208
                revision_id = revision[-1].as_revision_id(branch)
 
4209
                if len(revision) == 2:
 
4210
                    base_revision_id = revision[0].as_revision_id(branch)
 
4211
            if revision_id is None:
 
4212
                revision_id = branch.last_revision()
 
4213
            if revision_id == NULL_REVISION:
 
4214
                raise errors.BzrCommandError('No revisions to submit.')
 
4215
            if format == '4':
 
4216
                directive = merge_directive.MergeDirective2.from_objects(
 
4217
                    branch.repository, revision_id, time.time(),
 
4218
                    osutils.local_time_offset(), submit_branch,
 
4219
                    public_branch=public_branch, include_patch=not no_patch,
 
4220
                    include_bundle=not no_bundle, message=message,
 
4221
                    base_revision_id=base_revision_id)
 
4222
            elif format == '0.9':
 
4223
                if not no_bundle:
 
4224
                    if not no_patch:
 
4225
                        patch_type = 'bundle'
 
4226
                    else:
 
4227
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4228
                            ' permit bundle with no patch')
 
4229
                else:
 
4230
                    if not no_patch:
 
4231
                        patch_type = 'diff'
 
4232
                    else:
 
4233
                        patch_type = None
 
4234
                directive = merge_directive.MergeDirective.from_objects(
 
4235
                    branch.repository, revision_id, time.time(),
 
4236
                    osutils.local_time_offset(), submit_branch,
 
4237
                    public_branch=public_branch, patch_type=patch_type,
 
4238
                    message=message)
 
4239
 
 
4240
            outfile.writelines(directive.to_lines())
 
4241
            if output is None:
 
4242
                subject = '[MERGE] '
 
4243
                if message is not None:
 
4244
                    subject += message
 
4245
                else:
 
4246
                    revision = branch.repository.get_revision(revision_id)
 
4247
                    subject += revision.get_summary()
 
4248
                basename = directive.get_disk_name(branch)
 
4249
                mail_client.compose_merge_request(mail_to, subject,
 
4250
                                                  outfile.getvalue(), basename)
 
4251
        finally:
 
4252
            if output != '-':
 
4253
                outfile.close()
 
4254
            branch.unlock()
 
4255
 
 
4256
 
 
4257
class cmd_bundle_revisions(cmd_send):
 
4258
 
 
4259
    """Create a merge-directive for submiting changes.
 
4260
 
 
4261
    A merge directive provides many things needed for requesting merges:
 
4262
 
 
4263
    * A machine-readable description of the merge to perform
 
4264
 
 
4265
    * An optional patch that is a preview of the changes requested
 
4266
 
 
4267
    * An optional bundle of revision data, so that the changes can be applied
 
4268
      directly from the merge directive, without retrieving data from a
 
4269
      branch.
 
4270
 
 
4271
    If --no-bundle is specified, then public_branch is needed (and must be
 
4272
    up-to-date), so that the receiver can perform the merge using the
 
4273
    public_branch.  The public_branch is always included if known, so that
 
4274
    people can check it later.
 
4275
 
 
4276
    The submit branch defaults to the parent, but can be overridden.  Both
 
4277
    submit branch and public branch will be remembered if supplied.
 
4278
 
 
4279
    If a public_branch is known for the submit_branch, that public submit
 
4280
    branch is used in the merge instructions.  This means that a local mirror
 
4281
    can be used as your actual submit branch, once you have set public_branch
 
4282
    for that mirror.
 
4283
 
 
4284
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4285
    merge directive format 2.  It is significantly faster and smaller than
 
4286
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4287
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4288
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4289
    """
 
4290
 
 
4291
    takes_options = [
 
4292
        Option('no-bundle',
 
4293
               help='Do not include a bundle in the merge directive.'),
 
4294
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4295
               ' directive.'),
 
4296
        Option('remember',
 
4297
               help='Remember submit and public branch.'),
 
4298
        Option('from',
 
4299
               help='Branch to generate the submission from, '
 
4300
               'rather than the one containing the working directory.',
 
4301
               short_name='f',
 
4302
               type=unicode),
 
4303
        Option('output', short_name='o', help='Write directive to this file.',
 
4304
               type=unicode),
 
4305
        'revision',
 
4306
        RegistryOption.from_kwargs('format',
 
4307
        'Use the specified output format.',
 
4308
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4309
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4310
        ]
 
4311
    aliases = ['bundle']
 
4312
 
 
4313
    _see_also = ['send', 'merge']
 
4314
 
 
4315
    hidden = True
 
4316
 
 
4317
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4318
            no_patch=False, revision=None, remember=False, output=None,
 
4319
            format='4', **kwargs):
 
4320
        if output is None:
 
4321
            output = '-'
 
4322
        return self._run(submit_branch, revision, public_branch, remember,
 
4323
                         format, no_bundle, no_patch, output,
 
4324
                         kwargs.get('from', '.'), None, None)
 
4325
 
 
4326
 
 
4327
class cmd_tag(Command):
 
4328
    """Create, remove or modify a tag naming a revision.
 
4329
    
 
4330
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4331
    (--revision) option can be given -rtag:X, where X is any previously
 
4332
    created tag.
 
4333
 
 
4334
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4335
    along when you branch, push, pull or merge.
 
4336
 
 
4337
    It is an error to give a tag name that already exists unless you pass 
 
4338
    --force, in which case the tag is moved to point to the new revision.
 
4339
    """
 
4340
 
 
4341
    _see_also = ['commit', 'tags']
 
4342
    takes_args = ['tag_name']
 
4343
    takes_options = [
 
4344
        Option('delete',
 
4345
            help='Delete this tag rather than placing it.',
 
4346
            ),
 
4347
        Option('directory',
 
4348
            help='Branch in which to place the tag.',
 
4349
            short_name='d',
 
4350
            type=unicode,
 
4351
            ),
 
4352
        Option('force',
 
4353
            help='Replace existing tags.',
 
4354
            ),
 
4355
        'revision',
 
4356
        ]
 
4357
 
 
4358
    def run(self, tag_name,
 
4359
            delete=None,
 
4360
            directory='.',
 
4361
            force=None,
 
4362
            revision=None,
 
4363
            ):
 
4364
        branch, relpath = Branch.open_containing(directory)
 
4365
        branch.lock_write()
 
4366
        try:
 
4367
            if delete:
 
4368
                branch.tags.delete_tag(tag_name)
 
4369
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4370
            else:
 
4371
                if revision:
 
4372
                    if len(revision) != 1:
 
4373
                        raise errors.BzrCommandError(
 
4374
                            "Tags can only be placed on a single revision, "
 
4375
                            "not on a range")
 
4376
                    revision_id = revision[0].as_revision_id(branch)
 
4377
                else:
 
4378
                    revision_id = branch.last_revision()
 
4379
                if (not force) and branch.tags.has_tag(tag_name):
 
4380
                    raise errors.TagAlreadyExists(tag_name)
 
4381
                branch.tags.set_tag(tag_name, revision_id)
 
4382
                self.outf.write('Created tag %s.\n' % tag_name)
 
4383
        finally:
 
4384
            branch.unlock()
 
4385
 
 
4386
 
 
4387
class cmd_tags(Command):
 
4388
    """List tags.
 
4389
 
 
4390
    This command shows a table of tag names and the revisions they reference.
 
4391
    """
 
4392
 
 
4393
    _see_also = ['tag']
 
4394
    takes_options = [
 
4395
        Option('directory',
 
4396
            help='Branch whose tags should be displayed.',
 
4397
            short_name='d',
 
4398
            type=unicode,
 
4399
            ),
 
4400
        RegistryOption.from_kwargs('sort',
 
4401
            'Sort tags by different criteria.', title='Sorting',
 
4402
            alpha='Sort tags lexicographically (default).',
 
4403
            time='Sort tags chronologically.',
 
4404
            ),
 
4405
        'show-ids',
 
4406
    ]
 
4407
 
 
4408
    @display_command
 
4409
    def run(self,
 
4410
            directory='.',
 
4411
            sort='alpha',
 
4412
            show_ids=False,
 
4413
            ):
 
4414
        branch, relpath = Branch.open_containing(directory)
 
4415
        tags = branch.tags.get_tag_dict().items()
 
4416
        if sort == 'alpha':
 
4417
            tags.sort()
 
4418
        elif sort == 'time':
 
4419
            timestamps = {}
 
4420
            for tag, revid in tags:
 
4421
                try:
 
4422
                    revobj = branch.repository.get_revision(revid)
 
4423
                except errors.NoSuchRevision:
 
4424
                    timestamp = sys.maxint # place them at the end
 
4425
                else:
 
4426
                    timestamp = revobj.timestamp
 
4427
                timestamps[revid] = timestamp
 
4428
            tags.sort(key=lambda x: timestamps[x[1]])
 
4429
        if not show_ids:
 
4430
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4431
            revno_map = branch.get_revision_id_to_revno_map()
 
4432
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4433
                        for tag, revid in tags ]
 
4434
        for tag, revspec in tags:
 
4435
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4436
 
 
4437
 
 
4438
class cmd_reconfigure(Command):
 
4439
    """Reconfigure the type of a bzr directory.
 
4440
 
 
4441
    A target configuration must be specified.
 
4442
 
 
4443
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4444
    The order of preference is
 
4445
    1. For a lightweight checkout, the current bound location.
 
4446
    2. For branches that used to be checkouts, the previously-bound location.
 
4447
    3. The push location.
 
4448
    4. The parent location.
 
4449
    If none of these is available, --bind-to must be specified.
 
4450
    """
 
4451
 
 
4452
    takes_args = ['location?']
 
4453
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4454
                     title='Target type',
 
4455
                     help='The type to reconfigure the directory to.',
 
4456
                     value_switches=True, enum_switch=False,
 
4457
                     branch='Reconfigure to a branch.',
 
4458
                     tree='Reconfigure to a tree.',
 
4459
                     checkout='Reconfigure to a checkout.',
 
4460
                     lightweight_checkout='Reconfigure to a lightweight'
 
4461
                     ' checkout.',
 
4462
                     standalone='Reconfigure to be standalone.',
 
4463
                     use_shared='Reconfigure to use a shared repository.'),
 
4464
                     Option('bind-to', help='Branch to bind checkout to.',
 
4465
                            type=str),
 
4466
                     Option('force',
 
4467
                        help='Perform reconfiguration even if local changes'
 
4468
                        ' will be lost.')
 
4469
                     ]
 
4470
 
 
4471
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4472
        directory = bzrdir.BzrDir.open(location)
 
4473
        if target_type is None:
 
4474
            raise errors.BzrCommandError('No target configuration specified')
 
4475
        elif target_type == 'branch':
 
4476
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4477
        elif target_type == 'tree':
 
4478
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4479
        elif target_type == 'checkout':
 
4480
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4481
                                                                  bind_to)
 
4482
        elif target_type == 'lightweight-checkout':
 
4483
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4484
                directory, bind_to)
 
4485
        elif target_type == 'use-shared':
 
4486
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
4487
        elif target_type == 'standalone':
 
4488
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
4489
        reconfiguration.apply(force)
 
4490
 
 
4491
 
 
4492
class cmd_switch(Command):
 
4493
    """Set the branch of a checkout and update.
 
4494
    
 
4495
    For lightweight checkouts, this changes the branch being referenced.
 
4496
    For heavyweight checkouts, this checks that there are no local commits
 
4497
    versus the current bound branch, then it makes the local branch a mirror
 
4498
    of the new location and binds to it.
 
4499
    
 
4500
    In both cases, the working tree is updated and uncommitted changes
 
4501
    are merged. The user can commit or revert these as they desire.
 
4502
 
 
4503
    Pending merges need to be committed or reverted before using switch.
 
4504
 
 
4505
    The path to the branch to switch to can be specified relative to the parent
 
4506
    directory of the current branch. For example, if you are currently in a
 
4507
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
4508
    /path/to/newbranch.
 
4509
    """
 
4510
 
 
4511
    takes_args = ['to_location']
 
4512
    takes_options = [Option('force',
 
4513
                        help='Switch even if local commits will be lost.')
 
4514
                     ]
 
4515
 
 
4516
    def run(self, to_location, force=False):
 
4517
        from bzrlib import switch
 
4518
        tree_location = '.'
 
4519
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4520
        try:
 
4521
            to_branch = Branch.open(to_location)
 
4522
        except errors.NotBranchError:
 
4523
            to_branch = Branch.open(
 
4524
                control_dir.open_branch().base + '../' + to_location)
 
4525
        switch.switch(control_dir, to_branch, force)
 
4526
        note('Switched to branch: %s',
 
4527
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4528
 
 
4529
 
 
4530
class cmd_hooks(Command):
 
4531
    """Show a branch's currently registered hooks.
 
4532
    """
 
4533
 
 
4534
    hidden = True
 
4535
    takes_args = ['path?']
 
4536
 
 
4537
    def run(self, path=None):
 
4538
        if path is None:
 
4539
            path = '.'
 
4540
        branch_hooks = Branch.open(path).hooks
 
4541
        for hook_type in branch_hooks:
 
4542
            hooks = branch_hooks[hook_type]
 
4543
            self.outf.write("%s:\n" % (hook_type,))
 
4544
            if hooks:
 
4545
                for hook in hooks:
 
4546
                    self.outf.write("  %s\n" %
 
4547
                                    (branch_hooks.get_hook_name(hook),))
 
4548
            else:
 
4549
                self.outf.write("  <no hooks installed>\n")
 
4550
 
 
4551
 
 
4552
def _create_prefix(cur_transport):
 
4553
    needed = [cur_transport]
 
4554
    # Recurse upwards until we can create a directory successfully
 
4555
    while True:
 
4556
        new_transport = cur_transport.clone('..')
 
4557
        if new_transport.base == cur_transport.base:
 
4558
            raise errors.BzrCommandError(
 
4559
                "Failed to create path prefix for %s."
 
4560
                % cur_transport.base)
 
4561
        try:
 
4562
            new_transport.mkdir('.')
 
4563
        except errors.NoSuchFile:
 
4564
            needed.append(new_transport)
 
4565
            cur_transport = new_transport
 
4566
        else:
 
4567
            break
 
4568
    # Now we only need to create child directories
 
4569
    while needed:
 
4570
        cur_transport = needed.pop()
 
4571
        cur_transport.ensure_base()
 
4572
 
 
4573
 
 
4574
# these get imported and then picked up by the scan for cmd_*
 
4575
# TODO: Some more consistent way to split command definitions across files;
 
4576
# we do need to load at least some information about them to know of 
 
4577
# aliases.  ideally we would avoid loading the implementation until the
 
4578
# details were needed.
 
4579
from bzrlib.cmd_version_info import cmd_version_info
 
4580
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4581
from bzrlib.bundle.commands import (
 
4582
    cmd_bundle_info,
 
4583
    )
 
4584
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4585
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4586
        cmd_weave_plan_merge, cmd_weave_merge_text