/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: Andrew Bennetts
  • Date: 2008-05-07 22:47:56 UTC
  • mfrom: (3412 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3414.
  • Revision ID: andrew.bennetts@canonical.com-20080507224756-upxgmud0bdo4ysuf
Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

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