/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: Robert Collins
  • Date: 2008-04-08 03:39:43 UTC
  • mto: This revision was merged to the branch mainline in revision 3350.
  • Revision ID: robertc@robertcollins.net-20080408033943-ihbgs5wyqnh61bit
 * ``VersionedFile.get_sha1`` is deprecated, please use
   ``VersionedFile.get_sha1s``. (Robert Collins)

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