/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: Marius Kruger
  • Date: 2008-07-18 07:29:06 UTC
  • mto: This revision was merged to the branch mainline in revision 3633.
  • Revision ID: amanic@gmail.com-20080718072906-yu692u98u9aj17z8
add explicit blackbox tests for 'init -q' and 'init-repo -q'

Show diffs side-by-side

added added

removed removed

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