/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2008-05-08 04:12:06 UTC
  • mto: This revision was merged to the branch mainline in revision 3415.
  • Revision ID: mbp@sourcefrog.net-20080508041206-tkrr8ucmcyrlzkum
Some review cleanups for assertion removal

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
                     Option('no-pending', help='Don\'t show pending merges.',
 
171
                           ),
 
172
                     ]
 
173
    aliases = ['st', 'stat']
 
174
 
 
175
    encoding_type = 'replace'
 
176
    _see_also = ['diff', 'revert', 'status-flags']
 
177
    
 
178
    @display_command
 
179
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
180
            versioned=False, no_pending=False):
 
181
        from bzrlib.status import show_tree_status
 
182
 
 
183
        if revision and len(revision) > 2:
 
184
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
185
                                         ' one or two revision specifiers')
 
186
 
 
187
        tree, file_list = tree_files(file_list)
 
188
            
 
189
        show_tree_status(tree, show_ids=show_ids,
 
190
                         specific_files=file_list, revision=revision,
 
191
                         to_file=self.outf, short=short, versioned=versioned,
 
192
                         show_pending=not no_pending)
 
193
 
 
194
 
 
195
class cmd_cat_revision(Command):
 
196
    """Write out metadata for a revision.
 
197
    
 
198
    The revision to print can either be specified by a specific
 
199
    revision identifier, or you can use --revision.
 
200
    """
 
201
 
 
202
    hidden = True
 
203
    takes_args = ['revision_id?']
 
204
    takes_options = ['revision']
 
205
    # cat-revision is more for frontends so should be exact
 
206
    encoding = 'strict'
 
207
    
 
208
    @display_command
 
209
    def run(self, revision_id=None, revision=None):
 
210
        if revision_id is not None and revision is not None:
 
211
            raise errors.BzrCommandError('You can only supply one of'
 
212
                                         ' revision_id or --revision')
 
213
        if revision_id is None and revision is None:
 
214
            raise errors.BzrCommandError('You must supply either'
 
215
                                         ' --revision or a revision_id')
 
216
        b = WorkingTree.open_containing(u'.')[0].branch
 
217
 
 
218
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
219
        if revision_id is not None:
 
220
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
221
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
222
        elif revision is not None:
 
223
            for rev in revision:
 
224
                if rev is None:
 
225
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
226
                                                 ' revision.')
 
227
                rev_id = rev.as_revision_id(b)
 
228
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
229
    
 
230
 
 
231
class cmd_remove_tree(Command):
 
232
    """Remove the working tree from a given branch/checkout.
 
233
 
 
234
    Since a lightweight checkout is little more than a working tree
 
235
    this will refuse to run against one.
 
236
 
 
237
    To re-create the working tree, use "bzr checkout".
 
238
    """
 
239
    _see_also = ['checkout', 'working-trees']
 
240
 
 
241
    takes_args = ['location?']
 
242
 
 
243
    def run(self, location='.'):
 
244
        d = bzrdir.BzrDir.open(location)
 
245
        
 
246
        try:
 
247
            working = d.open_workingtree()
 
248
        except errors.NoWorkingTree:
 
249
            raise errors.BzrCommandError("No working tree to remove")
 
250
        except errors.NotLocalUrl:
 
251
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
252
                                         "remote path")
 
253
        
 
254
        working_path = working.bzrdir.root_transport.base
 
255
        branch_path = working.branch.bzrdir.root_transport.base
 
256
        if working_path != branch_path:
 
257
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
258
                                         "a lightweight checkout")
 
259
        
 
260
        d.destroy_workingtree()
 
261
        
 
262
 
 
263
class cmd_revno(Command):
 
264
    """Show current revision number.
 
265
 
 
266
    This is equal to the number of revisions on this branch.
 
267
    """
 
268
 
 
269
    _see_also = ['info']
 
270
    takes_args = ['location?']
 
271
 
 
272
    @display_command
 
273
    def run(self, location=u'.'):
 
274
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
275
        self.outf.write('\n')
 
276
 
 
277
 
 
278
class cmd_revision_info(Command):
 
279
    """Show revision number and revision id for a given revision identifier.
 
280
    """
 
281
    hidden = True
 
282
    takes_args = ['revision_info*']
 
283
    takes_options = ['revision']
 
284
 
 
285
    @display_command
 
286
    def run(self, revision=None, revision_info_list=[]):
 
287
 
 
288
        revs = []
 
289
        if revision is not None:
 
290
            revs.extend(revision)
 
291
        if revision_info_list is not None:
 
292
            for rev in revision_info_list:
 
293
                revs.append(RevisionSpec.from_string(rev))
 
294
 
 
295
        b = Branch.open_containing(u'.')[0]
 
296
 
 
297
        if len(revs) == 0:
 
298
            revs.append(RevisionSpec.from_string('-1'))
 
299
 
 
300
        for rev in revs:
 
301
            revision_id = rev.as_revision_id(b)
 
302
            try:
 
303
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
304
            except errors.NoSuchRevision:
 
305
                dotted_map = b.get_revision_id_to_revno_map()
 
306
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
307
            print '%s %s' % (revno, revision_id)
 
308
 
 
309
    
 
310
class cmd_add(Command):
 
311
    """Add specified files or directories.
 
312
 
 
313
    In non-recursive mode, all the named items are added, regardless
 
314
    of whether they were previously ignored.  A warning is given if
 
315
    any of the named files are already versioned.
 
316
 
 
317
    In recursive mode (the default), files are treated the same way
 
318
    but the behaviour for directories is different.  Directories that
 
319
    are already versioned do not give a warning.  All directories,
 
320
    whether already versioned or not, are searched for files or
 
321
    subdirectories that are neither versioned or ignored, and these
 
322
    are added.  This search proceeds recursively into versioned
 
323
    directories.  If no names are given '.' is assumed.
 
324
 
 
325
    Therefore simply saying 'bzr add' will version all files that
 
326
    are currently unknown.
 
327
 
 
328
    Adding a file whose parent directory is not versioned will
 
329
    implicitly add the parent, and so on up to the root. This means
 
330
    you should never need to explicitly add a directory, they'll just
 
331
    get added when you add a file in the directory.
 
332
 
 
333
    --dry-run will show which files would be added, but not actually 
 
334
    add them.
 
335
 
 
336
    --file-ids-from will try to use the file ids from the supplied path.
 
337
    It looks up ids trying to find a matching parent directory with the
 
338
    same filename, and then by pure path. This option is rarely needed
 
339
    but can be useful when adding the same logical file into two
 
340
    branches that will be merged later (without showing the two different
 
341
    adds as a conflict). It is also useful when merging another project
 
342
    into a subdirectory of this one.
 
343
    """
 
344
    takes_args = ['file*']
 
345
    takes_options = [
 
346
        Option('no-recurse',
 
347
               help="Don't recursively add the contents of directories."),
 
348
        Option('dry-run',
 
349
               help="Show what would be done, but don't actually do anything."),
 
350
        'verbose',
 
351
        Option('file-ids-from',
 
352
               type=unicode,
 
353
               help='Lookup file ids from this tree.'),
 
354
        ]
 
355
    encoding_type = 'replace'
 
356
    _see_also = ['remove']
 
357
 
 
358
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
359
            file_ids_from=None):
 
360
        import bzrlib.add
 
361
 
 
362
        base_tree = None
 
363
        if file_ids_from is not None:
 
364
            try:
 
365
                base_tree, base_path = WorkingTree.open_containing(
 
366
                                            file_ids_from)
 
367
            except errors.NoWorkingTree:
 
368
                base_branch, base_path = Branch.open_containing(
 
369
                                            file_ids_from)
 
370
                base_tree = base_branch.basis_tree()
 
371
 
 
372
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
373
                          to_file=self.outf, should_print=(not is_quiet()))
 
374
        else:
 
375
            action = bzrlib.add.AddAction(to_file=self.outf,
 
376
                should_print=(not is_quiet()))
 
377
 
 
378
        if base_tree:
 
379
            base_tree.lock_read()
 
380
        try:
 
381
            file_list = self._maybe_expand_globs(file_list)
 
382
            if file_list:
 
383
                tree = WorkingTree.open_containing(file_list[0])[0]
 
384
            else:
 
385
                tree = WorkingTree.open_containing(u'.')[0]
 
386
            added, ignored = tree.smart_add(file_list, not
 
387
                no_recurse, action=action, save=not dry_run)
 
388
        finally:
 
389
            if base_tree is not None:
 
390
                base_tree.unlock()
 
391
        if len(ignored) > 0:
 
392
            if verbose:
 
393
                for glob in sorted(ignored.keys()):
 
394
                    for path in ignored[glob]:
 
395
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
396
                                        % (path, glob))
 
397
            else:
 
398
                match_len = 0
 
399
                for glob, paths in ignored.items():
 
400
                    match_len += len(paths)
 
401
                self.outf.write("ignored %d file(s).\n" % match_len)
 
402
            self.outf.write("If you wish to add some of these files,"
 
403
                            " please add them by name.\n")
 
404
 
 
405
 
 
406
class cmd_mkdir(Command):
 
407
    """Create a new versioned directory.
 
408
 
 
409
    This is equivalent to creating the directory and then adding it.
 
410
    """
 
411
 
 
412
    takes_args = ['dir+']
 
413
    encoding_type = 'replace'
 
414
 
 
415
    def run(self, dir_list):
 
416
        for d in dir_list:
 
417
            os.mkdir(d)
 
418
            wt, dd = WorkingTree.open_containing(d)
 
419
            wt.add([dd])
 
420
            self.outf.write('added %s\n' % d)
 
421
 
 
422
 
 
423
class cmd_relpath(Command):
 
424
    """Show path of a file relative to root"""
 
425
 
 
426
    takes_args = ['filename']
 
427
    hidden = True
 
428
    
 
429
    @display_command
 
430
    def run(self, filename):
 
431
        # TODO: jam 20050106 Can relpath return a munged path if
 
432
        #       sys.stdout encoding cannot represent it?
 
433
        tree, relpath = WorkingTree.open_containing(filename)
 
434
        self.outf.write(relpath)
 
435
        self.outf.write('\n')
 
436
 
 
437
 
 
438
class cmd_inventory(Command):
 
439
    """Show inventory of the current working copy or a revision.
 
440
 
 
441
    It is possible to limit the output to a particular entry
 
442
    type using the --kind option.  For example: --kind file.
 
443
 
 
444
    It is also possible to restrict the list of files to a specific
 
445
    set. For example: bzr inventory --show-ids this/file
 
446
    """
 
447
 
 
448
    hidden = True
 
449
    _see_also = ['ls']
 
450
    takes_options = [
 
451
        'revision',
 
452
        'show-ids',
 
453
        Option('kind',
 
454
               help='List entries of a particular kind: file, directory, symlink.',
 
455
               type=unicode),
 
456
        ]
 
457
    takes_args = ['file*']
 
458
 
 
459
    @display_command
 
460
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
461
        if kind and kind not in ['file', 'directory', 'symlink']:
 
462
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
463
 
 
464
        work_tree, file_list = tree_files(file_list)
 
465
        work_tree.lock_read()
 
466
        try:
 
467
            if revision is not None:
 
468
                if len(revision) > 1:
 
469
                    raise errors.BzrCommandError(
 
470
                        'bzr inventory --revision takes exactly one revision'
 
471
                        ' identifier')
 
472
                revision_id = revision[0].as_revision_id(work_tree.branch)
 
473
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
474
 
 
475
                extra_trees = [work_tree]
 
476
                tree.lock_read()
 
477
            else:
 
478
                tree = work_tree
 
479
                extra_trees = []
 
480
 
 
481
            if file_list is not None:
 
482
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
483
                                          require_versioned=True)
 
484
                # find_ids_across_trees may include some paths that don't
 
485
                # exist in 'tree'.
 
486
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
487
                                 for file_id in file_ids if file_id in tree)
 
488
            else:
 
489
                entries = tree.inventory.entries()
 
490
        finally:
 
491
            tree.unlock()
 
492
            if tree is not work_tree:
 
493
                work_tree.unlock()
 
494
 
 
495
        for path, entry in entries:
 
496
            if kind and kind != entry.kind:
 
497
                continue
 
498
            if show_ids:
 
499
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
500
            else:
 
501
                self.outf.write(path)
 
502
                self.outf.write('\n')
 
503
 
 
504
 
 
505
class cmd_mv(Command):
 
506
    """Move or rename a file.
 
507
 
 
508
    :Usage:
 
509
        bzr mv OLDNAME NEWNAME
 
510
 
 
511
        bzr mv SOURCE... DESTINATION
 
512
 
 
513
    If the last argument is a versioned directory, all the other names
 
514
    are moved into it.  Otherwise, there must be exactly two arguments
 
515
    and the file is changed to a new name.
 
516
 
 
517
    If OLDNAME does not exist on the filesystem but is versioned and
 
518
    NEWNAME does exist on the filesystem but is not versioned, mv
 
519
    assumes that the file has been manually moved and only updates
 
520
    its internal inventory to reflect that change.
 
521
    The same is valid when moving many SOURCE files to a DESTINATION.
 
522
 
 
523
    Files cannot be moved between branches.
 
524
    """
 
525
 
 
526
    takes_args = ['names*']
 
527
    takes_options = [Option("after", help="Move only the bzr identifier"
 
528
        " of the file, because the file has already been moved."),
 
529
        ]
 
530
    aliases = ['move', 'rename']
 
531
    encoding_type = 'replace'
 
532
 
 
533
    def run(self, names_list, after=False):
 
534
        if names_list is None:
 
535
            names_list = []
 
536
 
 
537
        if len(names_list) < 2:
 
538
            raise errors.BzrCommandError("missing file argument")
 
539
        tree, rel_names = tree_files(names_list)
 
540
        tree.lock_write()
 
541
        try:
 
542
            self._run(tree, names_list, rel_names, after)
 
543
        finally:
 
544
            tree.unlock()
 
545
 
 
546
    def _run(self, tree, names_list, rel_names, after):
 
547
        into_existing = osutils.isdir(names_list[-1])
 
548
        if into_existing and len(names_list) == 2:
 
549
            # special cases:
 
550
            # a. case-insensitive filesystem and change case of dir
 
551
            # b. move directory after the fact (if the source used to be
 
552
            #    a directory, but now doesn't exist in the working tree
 
553
            #    and the target is an existing directory, just rename it)
 
554
            if (not tree.case_sensitive
 
555
                and rel_names[0].lower() == rel_names[1].lower()):
 
556
                into_existing = False
 
557
            else:
 
558
                inv = tree.inventory
 
559
                from_id = tree.path2id(rel_names[0])
 
560
                if (not osutils.lexists(names_list[0]) and
 
561
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
562
                    into_existing = False
 
563
        # move/rename
 
564
        if into_existing:
 
565
            # move into existing directory
 
566
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
567
                self.outf.write("%s => %s\n" % pair)
 
568
        else:
 
569
            if len(names_list) != 2:
 
570
                raise errors.BzrCommandError('to mv multiple files the'
 
571
                                             ' destination must be a versioned'
 
572
                                             ' directory')
 
573
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
574
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
575
 
 
576
 
 
577
class cmd_pull(Command):
 
578
    """Turn this branch into a mirror of another branch.
 
579
 
 
580
    This command only works on branches that have not diverged.  Branches are
 
581
    considered diverged if the destination branch's most recent commit is one
 
582
    that has not been merged (directly or indirectly) into the parent.
 
583
 
 
584
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
585
    from one into the other.  Once one branch has merged, the other should
 
586
    be able to pull it again.
 
587
 
 
588
    If you want to forget your local changes and just update your branch to
 
589
    match the remote one, use pull --overwrite.
 
590
 
 
591
    If there is no default location set, the first pull will set it.  After
 
592
    that, you can omit the location to use the default.  To change the
 
593
    default, use --remember. The value will only be saved if the remote
 
594
    location can be accessed.
 
595
 
 
596
    Note: The location can be specified either in the form of a branch,
 
597
    or in the form of a path to a file containing a merge directive generated
 
598
    with bzr send.
 
599
    """
 
600
 
 
601
    _see_also = ['push', 'update', 'status-flags']
 
602
    takes_options = ['remember', 'overwrite', 'revision',
 
603
        custom_help('verbose',
 
604
            help='Show logs of pulled revisions.'),
 
605
        Option('directory',
 
606
            help='Branch to pull into, '
 
607
                 'rather than the one containing the working directory.',
 
608
            short_name='d',
 
609
            type=unicode,
 
610
            ),
 
611
        ]
 
612
    takes_args = ['location?']
 
613
    encoding_type = 'replace'
 
614
 
 
615
    def run(self, location=None, remember=False, overwrite=False,
 
616
            revision=None, verbose=False,
 
617
            directory=None):
 
618
        # FIXME: too much stuff is in the command class
 
619
        revision_id = None
 
620
        mergeable = None
 
621
        if directory is None:
 
622
            directory = u'.'
 
623
        try:
 
624
            tree_to = WorkingTree.open_containing(directory)[0]
 
625
            branch_to = tree_to.branch
 
626
        except errors.NoWorkingTree:
 
627
            tree_to = None
 
628
            branch_to = Branch.open_containing(directory)[0]
 
629
 
 
630
        possible_transports = []
 
631
        if location is not None:
 
632
            try:
 
633
                mergeable = bundle.read_mergeable_from_url(location,
 
634
                    possible_transports=possible_transports)
 
635
            except errors.NotABundle:
 
636
                mergeable = None
 
637
 
 
638
        stored_loc = branch_to.get_parent()
 
639
        if location is None:
 
640
            if stored_loc is None:
 
641
                raise errors.BzrCommandError("No pull location known or"
 
642
                                             " specified.")
 
643
            else:
 
644
                display_url = urlutils.unescape_for_display(stored_loc,
 
645
                        self.outf.encoding)
 
646
                if not is_quiet():
 
647
                    self.outf.write("Using saved location: %s\n" % display_url)
 
648
                location = stored_loc
 
649
 
 
650
        if mergeable is not None:
 
651
            if revision is not None:
 
652
                raise errors.BzrCommandError(
 
653
                    'Cannot use -r with merge directives or bundles')
 
654
            mergeable.install_revisions(branch_to.repository)
 
655
            base_revision_id, revision_id, verified = \
 
656
                mergeable.get_merge_request(branch_to.repository)
 
657
            branch_from = branch_to
 
658
        else:
 
659
            branch_from = Branch.open(location,
 
660
                possible_transports=possible_transports)
 
661
 
 
662
            if branch_to.get_parent() is None or remember:
 
663
                branch_to.set_parent(branch_from.base)
 
664
 
 
665
        if revision is not None:
 
666
            if len(revision) == 1:
 
667
                revision_id = revision[0].as_revision_id(branch_from)
 
668
            else:
 
669
                raise errors.BzrCommandError(
 
670
                    'bzr pull --revision takes one value.')
 
671
 
 
672
        if verbose:
 
673
            old_rh = branch_to.revision_history()
 
674
        if tree_to is not None:
 
675
            change_reporter = delta._ChangeReporter(
 
676
                unversioned_filter=tree_to.is_ignored)
 
677
            result = tree_to.pull(branch_from, overwrite, revision_id,
 
678
                                  change_reporter,
 
679
                                  possible_transports=possible_transports)
 
680
        else:
 
681
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
682
 
 
683
        result.report(self.outf)
 
684
        if verbose:
 
685
            new_rh = branch_to.revision_history()
 
686
            log.show_changed_revisions(branch_to, old_rh, new_rh,
 
687
                                       to_file=self.outf)
 
688
 
 
689
 
 
690
class cmd_push(Command):
 
691
    """Update a mirror of this branch.
 
692
    
 
693
    The target branch will not have its working tree populated because this
 
694
    is both expensive, and is not supported on remote file systems.
 
695
    
 
696
    Some smart servers or protocols *may* put the working tree in place in
 
697
    the future.
 
698
 
 
699
    This command only works on branches that have not diverged.  Branches are
 
700
    considered diverged if the destination branch's most recent commit is one
 
701
    that has not been merged (directly or indirectly) by the source branch.
 
702
 
 
703
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
704
    the other branch completely, discarding its unmerged changes.
 
705
    
 
706
    If you want to ensure you have the different changes in the other branch,
 
707
    do a merge (see bzr help merge) from the other branch, and commit that.
 
708
    After that you will be able to do a push without '--overwrite'.
 
709
 
 
710
    If there is no default push location set, the first push will set it.
 
711
    After that, you can omit the location to use the default.  To change the
 
712
    default, use --remember. The value will only be saved if the remote
 
713
    location can be accessed.
 
714
    """
 
715
 
 
716
    _see_also = ['pull', 'update', 'working-trees']
 
717
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
718
        Option('create-prefix',
 
719
               help='Create the path leading up to the branch '
 
720
                    'if it does not already exist.'),
 
721
        Option('directory',
 
722
            help='Branch to push from, '
 
723
                 'rather than the one containing the working directory.',
 
724
            short_name='d',
 
725
            type=unicode,
 
726
            ),
 
727
        Option('use-existing-dir',
 
728
               help='By default push will fail if the target'
 
729
                    ' directory exists, but does not already'
 
730
                    ' have a control directory.  This flag will'
 
731
                    ' allow push to proceed.'),
 
732
        ]
 
733
    takes_args = ['location?']
 
734
    encoding_type = 'replace'
 
735
 
 
736
    def run(self, location=None, remember=False, overwrite=False,
 
737
            create_prefix=False, verbose=False, revision=None,
 
738
            use_existing_dir=False,
 
739
            directory=None):
 
740
        # FIXME: Way too big!  Put this into a function called from the
 
741
        # command.
 
742
        if directory is None:
 
743
            directory = '.'
 
744
        br_from = Branch.open_containing(directory)[0]
 
745
        stored_loc = br_from.get_push_location()
 
746
        if location is None:
 
747
            if stored_loc is None:
 
748
                raise errors.BzrCommandError("No push location known or specified.")
 
749
            else:
 
750
                display_url = urlutils.unescape_for_display(stored_loc,
 
751
                        self.outf.encoding)
 
752
                self.outf.write("Using saved location: %s\n" % display_url)
 
753
                location = stored_loc
 
754
 
 
755
        to_transport = transport.get_transport(location)
 
756
 
 
757
        br_to = repository_to = dir_to = None
 
758
        try:
 
759
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
760
        except errors.NotBranchError:
 
761
            pass # Didn't find anything
 
762
        else:
 
763
            # If we can open a branch, use its direct repository, otherwise see
 
764
            # if there is a repository without a branch.
 
765
            try:
 
766
                br_to = dir_to.open_branch()
 
767
            except errors.NotBranchError:
 
768
                # Didn't find a branch, can we find a repository?
 
769
                try:
 
770
                    repository_to = dir_to.find_repository()
 
771
                except errors.NoRepositoryPresent:
 
772
                    pass
 
773
            else:
 
774
                # Found a branch, so we must have found a repository
 
775
                repository_to = br_to.repository
 
776
 
 
777
        if revision is not None:
 
778
            if len(revision) == 1:
 
779
                revision_id = revision[0].in_history(br_from).rev_id
 
780
            else:
 
781
                raise errors.BzrCommandError(
 
782
                    'bzr push --revision takes one value.')
 
783
        else:
 
784
            revision_id = br_from.last_revision()
 
785
 
 
786
        push_result = None
 
787
        if verbose:
 
788
            old_rh = []
 
789
        if dir_to is None:
 
790
            # The destination doesn't exist; create it.
 
791
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
792
            #      common helper function
 
793
 
 
794
            def make_directory(transport):
 
795
                transport.mkdir('.')
 
796
                return transport
 
797
 
 
798
            def redirected(redirected_transport, e, redirection_notice):
 
799
                return transport.get_transport(e.get_target_url())
 
800
 
 
801
            try:
 
802
                to_transport = transport.do_catching_redirections(
 
803
                    make_directory, to_transport, redirected)
 
804
            except errors.FileExists:
 
805
                if not use_existing_dir:
 
806
                    raise errors.BzrCommandError("Target directory %s"
 
807
                         " already exists, but does not have a valid .bzr"
 
808
                         " directory. Supply --use-existing-dir to push"
 
809
                         " there anyway." % location)
 
810
            except errors.NoSuchFile:
 
811
                if not create_prefix:
 
812
                    raise errors.BzrCommandError("Parent directory of %s"
 
813
                        " does not exist."
 
814
                        "\nYou may supply --create-prefix to create all"
 
815
                        " leading parent directories."
 
816
                        % location)
 
817
                _create_prefix(to_transport)
 
818
            except errors.TooManyRedirections:
 
819
                raise errors.BzrCommandError("Too many redirections trying "
 
820
                                             "to make %s." % location)
 
821
 
 
822
            # Now the target directory exists, but doesn't have a .bzr
 
823
            # directory. So we need to create it, along with any work to create
 
824
            # all of the dependent branches, etc.
 
825
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
826
                                                       revision_id=revision_id)
 
827
            br_to = dir_to.open_branch()
 
828
            # TODO: Some more useful message about what was copied
 
829
            note('Created new branch.')
 
830
            # We successfully created the target, remember it
 
831
            if br_from.get_push_location() is None or remember:
 
832
                br_from.set_push_location(br_to.base)
 
833
        elif repository_to is None:
 
834
            # we have a bzrdir but no branch or repository
 
835
            # XXX: Figure out what to do other than complain.
 
836
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
837
                " directory, but not a branch or repository. This is an"
 
838
                " unsupported configuration. Please move the target directory"
 
839
                " out of the way and try again."
 
840
                % location)
 
841
        elif br_to is None:
 
842
            # We have a repository but no branch, copy the revisions, and then
 
843
            # create a branch.
 
844
            repository_to.fetch(br_from.repository, revision_id=revision_id)
 
845
            br_to = br_from.clone(dir_to, revision_id=revision_id)
 
846
            note('Created new branch.')
 
847
            if br_from.get_push_location() is None or remember:
 
848
                br_from.set_push_location(br_to.base)
 
849
        else: # We have a valid to branch
 
850
            # We were able to connect to the remote location, so remember it
 
851
            # we don't need to successfully push because of possible divergence.
 
852
            if br_from.get_push_location() is None or remember:
 
853
                br_from.set_push_location(br_to.base)
 
854
            if verbose:
 
855
                old_rh = br_to.revision_history()
 
856
            try:
 
857
                try:
 
858
                    tree_to = dir_to.open_workingtree()
 
859
                except errors.NotLocalUrl:
 
860
                    warning("This transport does not update the working " 
 
861
                            "tree of: %s. See 'bzr help working-trees' for "
 
862
                            "more information." % br_to.base)
 
863
                    push_result = br_from.push(br_to, overwrite,
 
864
                                               stop_revision=revision_id)
 
865
                except errors.NoWorkingTree:
 
866
                    push_result = br_from.push(br_to, overwrite,
 
867
                                               stop_revision=revision_id)
 
868
                else:
 
869
                    tree_to.lock_write()
 
870
                    try:
 
871
                        push_result = br_from.push(tree_to.branch, overwrite,
 
872
                                                   stop_revision=revision_id)
 
873
                        tree_to.update()
 
874
                    finally:
 
875
                        tree_to.unlock()
 
876
            except errors.DivergedBranches:
 
877
                raise errors.BzrCommandError('These branches have diverged.'
 
878
                                        '  Try using "merge" and then "push".')
 
879
        if push_result is not None:
 
880
            push_result.report(self.outf)
 
881
        elif verbose:
 
882
            new_rh = br_to.revision_history()
 
883
            if old_rh != new_rh:
 
884
                # Something changed
 
885
                from bzrlib.log import show_changed_revisions
 
886
                show_changed_revisions(br_to, old_rh, new_rh,
 
887
                                       to_file=self.outf)
 
888
        else:
 
889
            # we probably did a clone rather than a push, so a message was
 
890
            # emitted above
 
891
            pass
 
892
 
 
893
 
 
894
class cmd_branch(Command):
 
895
    """Create a new copy of a branch.
 
896
 
 
897
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
898
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
899
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
900
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
901
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
902
    create ./foo-bar.
 
903
 
 
904
    To retrieve the branch as of a particular revision, supply the --revision
 
905
    parameter, as in "branch foo/bar -r 5".
 
906
    """
 
907
 
 
908
    _see_also = ['checkout']
 
909
    takes_args = ['from_location', 'to_location?']
 
910
    takes_options = ['revision', Option('hardlink',
 
911
        help='Hard-link working tree files where possible.')]
 
912
    aliases = ['get', 'clone']
 
913
 
 
914
    def run(self, from_location, to_location=None, revision=None,
 
915
            hardlink=False):
 
916
        from bzrlib.tag import _merge_tags_if_possible
 
917
        if revision is None:
 
918
            revision = [None]
 
919
        elif len(revision) > 1:
 
920
            raise errors.BzrCommandError(
 
921
                'bzr branch --revision takes exactly 1 revision value')
 
922
 
 
923
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
924
            from_location)
 
925
        br_from.lock_read()
 
926
        try:
 
927
            if len(revision) == 1 and revision[0] is not None:
 
928
                revision_id = revision[0].as_revision_id(br_from)
 
929
            else:
 
930
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
931
                # None or perhaps NULL_REVISION to mean copy nothing
 
932
                # RBC 20060209
 
933
                revision_id = br_from.last_revision()
 
934
            if to_location is None:
 
935
                to_location = urlutils.derive_to_location(from_location)
 
936
                name = None
 
937
            else:
 
938
                name = os.path.basename(to_location) + '\n'
 
939
 
 
940
            to_transport = transport.get_transport(to_location)
 
941
            try:
 
942
                to_transport.mkdir('.')
 
943
            except errors.FileExists:
 
944
                raise errors.BzrCommandError('Target directory "%s" already'
 
945
                                             ' exists.' % to_location)
 
946
            except errors.NoSuchFile:
 
947
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
948
                                             % to_location)
 
949
            try:
 
950
                # preserve whatever source format we have.
 
951
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
952
                                            possible_transports=[to_transport],
 
953
                                            accelerator_tree=accelerator_tree,
 
954
                                            hardlink=hardlink)
 
955
                branch = dir.open_branch()
 
956
            except errors.NoSuchRevision:
 
957
                to_transport.delete_tree('.')
 
958
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
959
                raise errors.BzrCommandError(msg)
 
960
            if name:
 
961
                branch.control_files.put_utf8('branch-name', name)
 
962
            _merge_tags_if_possible(br_from, branch)
 
963
            note('Branched %d revision(s).' % branch.revno())
 
964
        finally:
 
965
            br_from.unlock()
 
966
 
 
967
 
 
968
class cmd_checkout(Command):
 
969
    """Create a new checkout of an existing branch.
 
970
 
 
971
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
972
    the branch found in '.'. This is useful if you have removed the working tree
 
973
    or if it was never created - i.e. if you pushed the branch to its current
 
974
    location using SFTP.
 
975
    
 
976
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
977
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
978
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
979
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
980
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
981
    create ./foo-bar.
 
982
 
 
983
    To retrieve the branch as of a particular revision, supply the --revision
 
984
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
985
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
986
    code.)
 
987
    """
 
988
 
 
989
    _see_also = ['checkouts', 'branch']
 
990
    takes_args = ['branch_location?', 'to_location?']
 
991
    takes_options = ['revision',
 
992
                     Option('lightweight',
 
993
                            help="Perform a lightweight checkout.  Lightweight "
 
994
                                 "checkouts depend on access to the branch for "
 
995
                                 "every operation.  Normal checkouts can perform "
 
996
                                 "common operations like diff and status without "
 
997
                                 "such access, and also support local commits."
 
998
                            ),
 
999
                     Option('files-from', type=str,
 
1000
                            help="Get file contents from this tree."),
 
1001
                     Option('hardlink',
 
1002
                            help='Hard-link working tree files where possible.'
 
1003
                            ),
 
1004
                     ]
 
1005
    aliases = ['co']
 
1006
 
 
1007
    def run(self, branch_location=None, to_location=None, revision=None,
 
1008
            lightweight=False, files_from=None, hardlink=False):
 
1009
        if revision is None:
 
1010
            revision = [None]
 
1011
        elif len(revision) > 1:
 
1012
            raise errors.BzrCommandError(
 
1013
                'bzr checkout --revision takes exactly 1 revision value')
 
1014
        if branch_location is None:
 
1015
            branch_location = osutils.getcwd()
 
1016
            to_location = branch_location
 
1017
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1018
            branch_location)
 
1019
        if files_from is not None:
 
1020
            accelerator_tree = WorkingTree.open(files_from)
 
1021
        if len(revision) == 1 and revision[0] is not None:
 
1022
            revision_id = revision[0].as_revision_id(source)
 
1023
        else:
 
1024
            revision_id = None
 
1025
        if to_location is None:
 
1026
            to_location = urlutils.derive_to_location(branch_location)
 
1027
        # if the source and to_location are the same, 
 
1028
        # and there is no working tree,
 
1029
        # then reconstitute a branch
 
1030
        if (osutils.abspath(to_location) ==
 
1031
            osutils.abspath(branch_location)):
 
1032
            try:
 
1033
                source.bzrdir.open_workingtree()
 
1034
            except errors.NoWorkingTree:
 
1035
                source.bzrdir.create_workingtree(revision_id)
 
1036
                return
 
1037
        source.create_checkout(to_location, revision_id, lightweight,
 
1038
                               accelerator_tree, hardlink)
 
1039
 
 
1040
 
 
1041
class cmd_renames(Command):
 
1042
    """Show list of renamed files.
 
1043
    """
 
1044
    # TODO: Option to show renames between two historical versions.
 
1045
 
 
1046
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1047
    _see_also = ['status']
 
1048
    takes_args = ['dir?']
 
1049
 
 
1050
    @display_command
 
1051
    def run(self, dir=u'.'):
 
1052
        tree = WorkingTree.open_containing(dir)[0]
 
1053
        tree.lock_read()
 
1054
        try:
 
1055
            new_inv = tree.inventory
 
1056
            old_tree = tree.basis_tree()
 
1057
            old_tree.lock_read()
 
1058
            try:
 
1059
                old_inv = old_tree.inventory
 
1060
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
1061
                renames.sort()
 
1062
                for old_name, new_name in renames:
 
1063
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1064
            finally:
 
1065
                old_tree.unlock()
 
1066
        finally:
 
1067
            tree.unlock()
 
1068
 
 
1069
 
 
1070
class cmd_update(Command):
 
1071
    """Update a tree to have the latest code committed to its branch.
 
1072
    
 
1073
    This will perform a merge into the working tree, and may generate
 
1074
    conflicts. If you have any local changes, you will still 
 
1075
    need to commit them after the update for the update to be complete.
 
1076
    
 
1077
    If you want to discard your local changes, you can just do a 
 
1078
    'bzr revert' instead of 'bzr commit' after the update.
 
1079
    """
 
1080
 
 
1081
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1082
    takes_args = ['dir?']
 
1083
    aliases = ['up']
 
1084
 
 
1085
    def run(self, dir='.'):
 
1086
        tree = WorkingTree.open_containing(dir)[0]
 
1087
        possible_transports = []
 
1088
        master = tree.branch.get_master_branch(
 
1089
            possible_transports=possible_transports)
 
1090
        if master is not None:
 
1091
            tree.lock_write()
 
1092
        else:
 
1093
            tree.lock_tree_write()
 
1094
        try:
 
1095
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1096
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1097
            if last_rev == _mod_revision.ensure_null(
 
1098
                tree.branch.last_revision()):
 
1099
                # may be up to date, check master too.
 
1100
                if master is None or last_rev == _mod_revision.ensure_null(
 
1101
                    master.last_revision()):
 
1102
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1103
                    note("Tree is up to date at revision %d." % (revno,))
 
1104
                    return 0
 
1105
            conflicts = tree.update(
 
1106
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1107
                possible_transports=possible_transports)
 
1108
            revno = tree.branch.revision_id_to_revno(
 
1109
                _mod_revision.ensure_null(tree.last_revision()))
 
1110
            note('Updated to revision %d.' % (revno,))
 
1111
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1112
                note('Your local commits will now show as pending merges with '
 
1113
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1114
            if conflicts != 0:
 
1115
                return 1
 
1116
            else:
 
1117
                return 0
 
1118
        finally:
 
1119
            tree.unlock()
 
1120
 
 
1121
 
 
1122
class cmd_info(Command):
 
1123
    """Show information about a working tree, branch or repository.
 
1124
 
 
1125
    This command will show all known locations and formats associated to the
 
1126
    tree, branch or repository.  Statistical information is included with
 
1127
    each report.
 
1128
 
 
1129
    Branches and working trees will also report any missing revisions.
 
1130
    """
 
1131
    _see_also = ['revno', 'working-trees', 'repositories']
 
1132
    takes_args = ['location?']
 
1133
    takes_options = ['verbose']
 
1134
    encoding_type = 'replace'
 
1135
 
 
1136
    @display_command
 
1137
    def run(self, location=None, verbose=False):
 
1138
        if verbose:
 
1139
            noise_level = 2
 
1140
        else:
 
1141
            noise_level = 0
 
1142
        from bzrlib.info import show_bzrdir_info
 
1143
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1144
                         verbose=noise_level, outfile=self.outf)
 
1145
 
 
1146
 
 
1147
class cmd_remove(Command):
 
1148
    """Remove files or directories.
 
1149
 
 
1150
    This makes bzr stop tracking changes to the specified files and
 
1151
    delete them if they can easily be recovered using revert.
 
1152
 
 
1153
    You can specify one or more files, and/or --new.  If you specify --new,
 
1154
    only 'added' files will be removed.  If you specify both, then new files
 
1155
    in the specified directories will be removed.  If the directories are
 
1156
    also new, they will also be removed.
 
1157
    """
 
1158
    takes_args = ['file*']
 
1159
    takes_options = ['verbose',
 
1160
        Option('new', help='Remove newly-added files.'),
 
1161
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1162
            'The file deletion mode to be used.',
 
1163
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1164
            safe='Only delete files if they can be'
 
1165
                 ' safely recovered (default).',
 
1166
            keep="Don't delete any files.",
 
1167
            force='Delete all the specified files, even if they can not be '
 
1168
                'recovered and even if they are non-empty directories.')]
 
1169
    aliases = ['rm']
 
1170
    encoding_type = 'replace'
 
1171
 
 
1172
    def run(self, file_list, verbose=False, new=False,
 
1173
        file_deletion_strategy='safe'):
 
1174
        tree, file_list = tree_files(file_list)
 
1175
 
 
1176
        if file_list is not None:
 
1177
            file_list = [f for f in file_list]
 
1178
        elif not new:
 
1179
            raise errors.BzrCommandError('Specify one or more files to'
 
1180
            ' remove, or use --new.')
 
1181
 
 
1182
        if new:
 
1183
            added = tree.changes_from(tree.basis_tree(),
 
1184
                specific_files=file_list).added
 
1185
            file_list = sorted([f[0] for f in added], reverse=True)
 
1186
            if len(file_list) == 0:
 
1187
                raise errors.BzrCommandError('No matching files.')
 
1188
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1189
            keep_files=file_deletion_strategy=='keep',
 
1190
            force=file_deletion_strategy=='force')
 
1191
 
 
1192
 
 
1193
class cmd_file_id(Command):
 
1194
    """Print file_id of a particular file or directory.
 
1195
 
 
1196
    The file_id is assigned when the file is first added and remains the
 
1197
    same through all revisions where the file exists, even when it is
 
1198
    moved or renamed.
 
1199
    """
 
1200
 
 
1201
    hidden = True
 
1202
    _see_also = ['inventory', 'ls']
 
1203
    takes_args = ['filename']
 
1204
 
 
1205
    @display_command
 
1206
    def run(self, filename):
 
1207
        tree, relpath = WorkingTree.open_containing(filename)
 
1208
        i = tree.path2id(relpath)
 
1209
        if i is None:
 
1210
            raise errors.NotVersionedError(filename)
 
1211
        else:
 
1212
            self.outf.write(i + '\n')
 
1213
 
 
1214
 
 
1215
class cmd_file_path(Command):
 
1216
    """Print path of file_ids to a file or directory.
 
1217
 
 
1218
    This prints one line for each directory down to the target,
 
1219
    starting at the branch root.
 
1220
    """
 
1221
 
 
1222
    hidden = True
 
1223
    takes_args = ['filename']
 
1224
 
 
1225
    @display_command
 
1226
    def run(self, filename):
 
1227
        tree, relpath = WorkingTree.open_containing(filename)
 
1228
        fid = tree.path2id(relpath)
 
1229
        if fid is None:
 
1230
            raise errors.NotVersionedError(filename)
 
1231
        segments = osutils.splitpath(relpath)
 
1232
        for pos in range(1, len(segments) + 1):
 
1233
            path = osutils.joinpath(segments[:pos])
 
1234
            self.outf.write("%s\n" % tree.path2id(path))
 
1235
 
 
1236
 
 
1237
class cmd_reconcile(Command):
 
1238
    """Reconcile bzr metadata in a branch.
 
1239
 
 
1240
    This can correct data mismatches that may have been caused by
 
1241
    previous ghost operations or bzr upgrades. You should only
 
1242
    need to run this command if 'bzr check' or a bzr developer 
 
1243
    advises you to run it.
 
1244
 
 
1245
    If a second branch is provided, cross-branch reconciliation is
 
1246
    also attempted, which will check that data like the tree root
 
1247
    id which was not present in very early bzr versions is represented
 
1248
    correctly in both branches.
 
1249
 
 
1250
    At the same time it is run it may recompress data resulting in 
 
1251
    a potential saving in disk space or performance gain.
 
1252
 
 
1253
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1254
    """
 
1255
 
 
1256
    _see_also = ['check']
 
1257
    takes_args = ['branch?']
 
1258
 
 
1259
    def run(self, branch="."):
 
1260
        from bzrlib.reconcile import reconcile
 
1261
        dir = bzrdir.BzrDir.open(branch)
 
1262
        reconcile(dir)
 
1263
 
 
1264
 
 
1265
class cmd_revision_history(Command):
 
1266
    """Display the list of revision ids on a branch."""
 
1267
 
 
1268
    _see_also = ['log']
 
1269
    takes_args = ['location?']
 
1270
 
 
1271
    hidden = True
 
1272
 
 
1273
    @display_command
 
1274
    def run(self, location="."):
 
1275
        branch = Branch.open_containing(location)[0]
 
1276
        for revid in branch.revision_history():
 
1277
            self.outf.write(revid)
 
1278
            self.outf.write('\n')
 
1279
 
 
1280
 
 
1281
class cmd_ancestry(Command):
 
1282
    """List all revisions merged into this branch."""
 
1283
 
 
1284
    _see_also = ['log', 'revision-history']
 
1285
    takes_args = ['location?']
 
1286
 
 
1287
    hidden = True
 
1288
 
 
1289
    @display_command
 
1290
    def run(self, location="."):
 
1291
        try:
 
1292
            wt = WorkingTree.open_containing(location)[0]
 
1293
        except errors.NoWorkingTree:
 
1294
            b = Branch.open(location)
 
1295
            last_revision = b.last_revision()
 
1296
        else:
 
1297
            b = wt.branch
 
1298
            last_revision = wt.last_revision()
 
1299
 
 
1300
        revision_ids = b.repository.get_ancestry(last_revision)
 
1301
        revision_ids.pop(0)
 
1302
        for revision_id in revision_ids:
 
1303
            self.outf.write(revision_id + '\n')
 
1304
 
 
1305
 
 
1306
class cmd_init(Command):
 
1307
    """Make a directory into a versioned branch.
 
1308
 
 
1309
    Use this to create an empty branch, or before importing an
 
1310
    existing project.
 
1311
 
 
1312
    If there is a repository in a parent directory of the location, then 
 
1313
    the history of the branch will be stored in the repository.  Otherwise
 
1314
    init creates a standalone branch which carries its own history
 
1315
    in the .bzr directory.
 
1316
 
 
1317
    If there is already a branch at the location but it has no working tree,
 
1318
    the tree can be populated with 'bzr checkout'.
 
1319
 
 
1320
    Recipe for importing a tree of files::
 
1321
 
 
1322
        cd ~/project
 
1323
        bzr init
 
1324
        bzr add .
 
1325
        bzr status
 
1326
        bzr commit -m "imported project"
 
1327
    """
 
1328
 
 
1329
    _see_also = ['init-repository', 'branch', 'checkout']
 
1330
    takes_args = ['location?']
 
1331
    takes_options = [
 
1332
        Option('create-prefix',
 
1333
               help='Create the path leading up to the branch '
 
1334
                    'if it does not already exist.'),
 
1335
         RegistryOption('format',
 
1336
                help='Specify a format for this branch. '
 
1337
                'See "help formats".',
 
1338
                registry=bzrdir.format_registry,
 
1339
                converter=bzrdir.format_registry.make_bzrdir,
 
1340
                value_switches=True,
 
1341
                title="Branch Format",
 
1342
                ),
 
1343
         Option('append-revisions-only',
 
1344
                help='Never change revnos or the existing log.'
 
1345
                '  Append revisions to it only.')
 
1346
         ]
 
1347
    def run(self, location=None, format=None, append_revisions_only=False,
 
1348
            create_prefix=False):
 
1349
        if format is None:
 
1350
            format = bzrdir.format_registry.make_bzrdir('default')
 
1351
        if location is None:
 
1352
            location = u'.'
 
1353
 
 
1354
        to_transport = transport.get_transport(location)
 
1355
 
 
1356
        # The path has to exist to initialize a
 
1357
        # branch inside of it.
 
1358
        # Just using os.mkdir, since I don't
 
1359
        # believe that we want to create a bunch of
 
1360
        # locations if the user supplies an extended path
 
1361
        try:
 
1362
            to_transport.ensure_base()
 
1363
        except errors.NoSuchFile:
 
1364
            if not create_prefix:
 
1365
                raise errors.BzrCommandError("Parent directory of %s"
 
1366
                    " does not exist."
 
1367
                    "\nYou may supply --create-prefix to create all"
 
1368
                    " leading parent directories."
 
1369
                    % location)
 
1370
            _create_prefix(to_transport)
 
1371
 
 
1372
        try:
 
1373
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1374
        except errors.NotBranchError:
 
1375
            # really a NotBzrDir error...
 
1376
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1377
            branch = create_branch(to_transport.base, format=format,
 
1378
                                   possible_transports=[to_transport])
 
1379
        else:
 
1380
            from bzrlib.transport.local import LocalTransport
 
1381
            if existing_bzrdir.has_branch():
 
1382
                if (isinstance(to_transport, LocalTransport)
 
1383
                    and not existing_bzrdir.has_workingtree()):
 
1384
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1385
                raise errors.AlreadyBranchError(location)
 
1386
            else:
 
1387
                branch = existing_bzrdir.create_branch()
 
1388
                existing_bzrdir.create_workingtree()
 
1389
        if append_revisions_only:
 
1390
            try:
 
1391
                branch.set_append_revisions_only(True)
 
1392
            except errors.UpgradeRequired:
 
1393
                raise errors.BzrCommandError('This branch format cannot be set'
 
1394
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1395
 
 
1396
 
 
1397
class cmd_init_repository(Command):
 
1398
    """Create a shared repository to hold branches.
 
1399
 
 
1400
    New branches created under the repository directory will store their
 
1401
    revisions in the repository, not in the branch directory.
 
1402
 
 
1403
    If the --no-trees option is used then the branches in the repository
 
1404
    will not have working trees by default.
 
1405
 
 
1406
    :Examples:
 
1407
        Create a shared repositories holding just branches::
 
1408
 
 
1409
            bzr init-repo --no-trees repo
 
1410
            bzr init repo/trunk
 
1411
 
 
1412
        Make a lightweight checkout elsewhere::
 
1413
 
 
1414
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1415
            cd trunk-checkout
 
1416
            (add files here)
 
1417
    """
 
1418
 
 
1419
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1420
    takes_args = ["location"]
 
1421
    takes_options = [RegistryOption('format',
 
1422
                            help='Specify a format for this repository. See'
 
1423
                                 ' "bzr help formats" for details.',
 
1424
                            registry=bzrdir.format_registry,
 
1425
                            converter=bzrdir.format_registry.make_bzrdir,
 
1426
                            value_switches=True, title='Repository format'),
 
1427
                     Option('no-trees',
 
1428
                             help='Branches in the repository will default to'
 
1429
                                  ' not having a working tree.'),
 
1430
                    ]
 
1431
    aliases = ["init-repo"]
 
1432
 
 
1433
    def run(self, location, format=None, no_trees=False):
 
1434
        if format is None:
 
1435
            format = bzrdir.format_registry.make_bzrdir('default')
 
1436
 
 
1437
        if location is None:
 
1438
            location = '.'
 
1439
 
 
1440
        to_transport = transport.get_transport(location)
 
1441
        to_transport.ensure_base()
 
1442
 
 
1443
        newdir = format.initialize_on_transport(to_transport)
 
1444
        repo = newdir.create_repository(shared=True)
 
1445
        repo.set_make_working_trees(not no_trees)
 
1446
 
 
1447
 
 
1448
class cmd_diff(Command):
 
1449
    """Show differences in the working tree, between revisions or branches.
 
1450
    
 
1451
    If no arguments are given, all changes for the current tree are listed.
 
1452
    If files are given, only the changes in those files are listed.
 
1453
    Remote and multiple branches can be compared by using the --old and
 
1454
    --new options. If not provided, the default for both is derived from
 
1455
    the first argument, if any, or the current tree if no arguments are
 
1456
    given.
 
1457
 
 
1458
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1459
    produces patches suitable for "patch -p1".
 
1460
 
 
1461
    :Exit values:
 
1462
        1 - changed
 
1463
        2 - unrepresentable changes
 
1464
        3 - error
 
1465
        0 - no change
 
1466
 
 
1467
    :Examples:
 
1468
        Shows the difference in the working tree versus the last commit::
 
1469
 
 
1470
            bzr diff
 
1471
 
 
1472
        Difference between the working tree and revision 1::
 
1473
 
 
1474
            bzr diff -r1
 
1475
 
 
1476
        Difference between revision 2 and revision 1::
 
1477
 
 
1478
            bzr diff -r1..2
 
1479
 
 
1480
        Difference between revision 2 and revision 1 for branch xxx::
 
1481
 
 
1482
            bzr diff -r1..2 xxx
 
1483
 
 
1484
        Show just the differences for file NEWS::
 
1485
 
 
1486
            bzr diff NEWS
 
1487
 
 
1488
        Show the differences in working tree xxx for file NEWS::
 
1489
 
 
1490
            bzr diff xxx/NEWS
 
1491
 
 
1492
        Show the differences from branch xxx to this working tree:
 
1493
 
 
1494
            bzr diff --old xxx
 
1495
 
 
1496
        Show the differences between two branches for file NEWS::
 
1497
 
 
1498
            bzr diff --old xxx --new yyy NEWS
 
1499
 
 
1500
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1501
 
 
1502
            bzr diff --prefix old/:new/
 
1503
    """
 
1504
    _see_also = ['status']
 
1505
    takes_args = ['file*']
 
1506
    takes_options = [
 
1507
        Option('diff-options', type=str,
 
1508
               help='Pass these options to the external diff program.'),
 
1509
        Option('prefix', type=str,
 
1510
               short_name='p',
 
1511
               help='Set prefixes added to old and new filenames, as '
 
1512
                    'two values separated by a colon. (eg "old/:new/").'),
 
1513
        Option('old',
 
1514
            help='Branch/tree to compare from.',
 
1515
            type=unicode,
 
1516
            ),
 
1517
        Option('new',
 
1518
            help='Branch/tree to compare to.',
 
1519
            type=unicode,
 
1520
            ),
 
1521
        'revision',
 
1522
        'change',
 
1523
        Option('using',
 
1524
            help='Use this command to compare files.',
 
1525
            type=unicode,
 
1526
            ),
 
1527
        ]
 
1528
    aliases = ['di', 'dif']
 
1529
    encoding_type = 'exact'
 
1530
 
 
1531
    @display_command
 
1532
    def run(self, revision=None, file_list=None, diff_options=None,
 
1533
            prefix=None, old=None, new=None, using=None):
 
1534
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1535
 
 
1536
        if (prefix is None) or (prefix == '0'):
 
1537
            # diff -p0 format
 
1538
            old_label = ''
 
1539
            new_label = ''
 
1540
        elif prefix == '1':
 
1541
            old_label = 'old/'
 
1542
            new_label = 'new/'
 
1543
        elif ':' in prefix:
 
1544
            old_label, new_label = prefix.split(":")
 
1545
        else:
 
1546
            raise errors.BzrCommandError(
 
1547
                '--prefix expects two values separated by a colon'
 
1548
                ' (eg "old/:new/")')
 
1549
 
 
1550
        if revision and len(revision) > 2:
 
1551
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1552
                                         ' one or two revision specifiers')
 
1553
 
 
1554
        old_tree, new_tree, specific_files, extra_trees = \
 
1555
                _get_trees_to_diff(file_list, revision, old, new)
 
1556
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1557
                               specific_files=specific_files,
 
1558
                               external_diff_options=diff_options,
 
1559
                               old_label=old_label, new_label=new_label,
 
1560
                               extra_trees=extra_trees, using=using)
 
1561
 
 
1562
 
 
1563
class cmd_deleted(Command):
 
1564
    """List files deleted in the working tree.
 
1565
    """
 
1566
    # TODO: Show files deleted since a previous revision, or
 
1567
    # between two revisions.
 
1568
    # TODO: Much more efficient way to do this: read in new
 
1569
    # directories with readdir, rather than stating each one.  Same
 
1570
    # level of effort but possibly much less IO.  (Or possibly not,
 
1571
    # if the directories are very large...)
 
1572
    _see_also = ['status', 'ls']
 
1573
    takes_options = ['show-ids']
 
1574
 
 
1575
    @display_command
 
1576
    def run(self, show_ids=False):
 
1577
        tree = WorkingTree.open_containing(u'.')[0]
 
1578
        tree.lock_read()
 
1579
        try:
 
1580
            old = tree.basis_tree()
 
1581
            old.lock_read()
 
1582
            try:
 
1583
                for path, ie in old.inventory.iter_entries():
 
1584
                    if not tree.has_id(ie.file_id):
 
1585
                        self.outf.write(path)
 
1586
                        if show_ids:
 
1587
                            self.outf.write(' ')
 
1588
                            self.outf.write(ie.file_id)
 
1589
                        self.outf.write('\n')
 
1590
            finally:
 
1591
                old.unlock()
 
1592
        finally:
 
1593
            tree.unlock()
 
1594
 
 
1595
 
 
1596
class cmd_modified(Command):
 
1597
    """List files modified in working tree.
 
1598
    """
 
1599
 
 
1600
    hidden = True
 
1601
    _see_also = ['status', 'ls']
 
1602
 
 
1603
    @display_command
 
1604
    def run(self):
 
1605
        tree = WorkingTree.open_containing(u'.')[0]
 
1606
        td = tree.changes_from(tree.basis_tree())
 
1607
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1608
            self.outf.write(path + '\n')
 
1609
 
 
1610
 
 
1611
class cmd_added(Command):
 
1612
    """List files added in working tree.
 
1613
    """
 
1614
 
 
1615
    hidden = True
 
1616
    _see_also = ['status', 'ls']
 
1617
 
 
1618
    @display_command
 
1619
    def run(self):
 
1620
        wt = WorkingTree.open_containing(u'.')[0]
 
1621
        wt.lock_read()
 
1622
        try:
 
1623
            basis = wt.basis_tree()
 
1624
            basis.lock_read()
 
1625
            try:
 
1626
                basis_inv = basis.inventory
 
1627
                inv = wt.inventory
 
1628
                for file_id in inv:
 
1629
                    if file_id in basis_inv:
 
1630
                        continue
 
1631
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1632
                        continue
 
1633
                    path = inv.id2path(file_id)
 
1634
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1635
                        continue
 
1636
                    self.outf.write(path + '\n')
 
1637
            finally:
 
1638
                basis.unlock()
 
1639
        finally:
 
1640
            wt.unlock()
 
1641
 
 
1642
 
 
1643
class cmd_root(Command):
 
1644
    """Show the tree root directory.
 
1645
 
 
1646
    The root is the nearest enclosing directory with a .bzr control
 
1647
    directory."""
 
1648
 
 
1649
    takes_args = ['filename?']
 
1650
    @display_command
 
1651
    def run(self, filename=None):
 
1652
        """Print the branch root."""
 
1653
        tree = WorkingTree.open_containing(filename)[0]
 
1654
        self.outf.write(tree.basedir + '\n')
 
1655
 
 
1656
 
 
1657
def _parse_limit(limitstring):
 
1658
    try:
 
1659
        return int(limitstring)
 
1660
    except ValueError:
 
1661
        msg = "The limit argument must be an integer."
 
1662
        raise errors.BzrCommandError(msg)
 
1663
 
 
1664
 
 
1665
class cmd_log(Command):
 
1666
    """Show log of a branch, file, or directory.
 
1667
 
 
1668
    By default show the log of the branch containing the working directory.
 
1669
 
 
1670
    To request a range of logs, you can use the command -r begin..end
 
1671
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1672
    also valid.
 
1673
 
 
1674
    :Examples:
 
1675
        Log the current branch::
 
1676
 
 
1677
            bzr log
 
1678
 
 
1679
        Log a file::
 
1680
 
 
1681
            bzr log foo.c
 
1682
 
 
1683
        Log the last 10 revisions of a branch::
 
1684
 
 
1685
            bzr log -r -10.. http://server/branch
 
1686
    """
 
1687
 
 
1688
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1689
 
 
1690
    takes_args = ['location?']
 
1691
    takes_options = [
 
1692
            Option('forward',
 
1693
                   help='Show from oldest to newest.'),
 
1694
            Option('timezone',
 
1695
                   type=str,
 
1696
                   help='Display timezone as local, original, or utc.'),
 
1697
            custom_help('verbose',
 
1698
                   help='Show files changed in each revision.'),
 
1699
            'show-ids',
 
1700
            'revision',
 
1701
            'log-format',
 
1702
            Option('message',
 
1703
                   short_name='m',
 
1704
                   help='Show revisions whose message matches this '
 
1705
                        'regular expression.',
 
1706
                   type=str),
 
1707
            Option('limit',
 
1708
                   short_name='l',
 
1709
                   help='Limit the output to the first N revisions.',
 
1710
                   argname='N',
 
1711
                   type=_parse_limit),
 
1712
            ]
 
1713
    encoding_type = 'replace'
 
1714
 
 
1715
    @display_command
 
1716
    def run(self, location=None, timezone='original',
 
1717
            verbose=False,
 
1718
            show_ids=False,
 
1719
            forward=False,
 
1720
            revision=None,
 
1721
            log_format=None,
 
1722
            message=None,
 
1723
            limit=None):
 
1724
        from bzrlib.log import show_log
 
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
        # find the branch locations
 
2973
        other_loc, user_location = self._select_branch_location(tree, location,
 
2974
            revision, -1)
 
2975
        if revision is not None and len(revision) == 2:
 
2976
            base_loc, _unused = self._select_branch_location(tree,
 
2977
                location, revision, 0)
 
2978
        else:
 
2979
            base_loc = other_loc
 
2980
        # Open the branches
 
2981
        other_branch, other_path = Branch.open_containing(other_loc,
 
2982
            possible_transports)
 
2983
        if base_loc == other_loc:
 
2984
            base_branch = other_branch
 
2985
        else:
 
2986
            base_branch, base_path = Branch.open_containing(base_loc,
 
2987
                possible_transports)
 
2988
        # Find the revision ids
 
2989
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2990
            other_revision_id = _mod_revision.ensure_null(
 
2991
                other_branch.last_revision())
 
2992
        else:
 
2993
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
2994
        if (revision is not None and len(revision) == 2
 
2995
            and revision[0] is not None):
 
2996
            base_revision_id = revision[0].as_revision_id(base_branch)
 
2997
        else:
 
2998
            base_revision_id = None
 
2999
        # Remember where we merge from
 
3000
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3001
             user_location is not None):
 
3002
            tree.branch.set_submit_branch(other_branch.base)
 
3003
        _merge_tags_if_possible(other_branch, tree.branch)
 
3004
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3005
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3006
        if other_path != '':
 
3007
            allow_pending = False
 
3008
            merger.interesting_files = [other_path]
 
3009
        else:
 
3010
            allow_pending = True
 
3011
        return merger, allow_pending
 
3012
 
 
3013
    def _select_branch_location(self, tree, user_location, revision=None,
 
3014
                                index=None):
 
3015
        """Select a branch location, according to possible inputs.
 
3016
 
 
3017
        If provided, branches from ``revision`` are preferred.  (Both
 
3018
        ``revision`` and ``index`` must be supplied.)
 
3019
 
 
3020
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3021
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3022
 
 
3023
        :param tree: The working tree to select a branch for merging into
 
3024
        :param location: The location entered by the user
 
3025
        :param revision: The revision parameter to the command
 
3026
        :param index: The index to use for the revision parameter.  Negative
 
3027
            indices are permitted.
 
3028
        :return: (selected_location, user_location).  The default location
 
3029
            will be the user-entered location.
 
3030
        """
 
3031
        if (revision is not None and index is not None
 
3032
            and revision[index] is not None):
 
3033
            branch = revision[index].get_branch()
 
3034
            if branch is not None:
 
3035
                return branch, branch
 
3036
        if user_location is None:
 
3037
            location = self._get_remembered(tree, 'Merging from')
 
3038
        else:
 
3039
            location = user_location
 
3040
        return location, user_location
 
3041
 
 
3042
    def _get_remembered(self, tree, verb_string):
 
3043
        """Use tree.branch's parent if none was supplied.
 
3044
 
 
3045
        Report if the remembered location was used.
 
3046
        """
 
3047
        stored_location = tree.branch.get_submit_branch()
 
3048
        if stored_location is None:
 
3049
            stored_location = tree.branch.get_parent()
 
3050
        mutter("%s", stored_location)
 
3051
        if stored_location is None:
 
3052
            raise errors.BzrCommandError("No location specified or remembered")
 
3053
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3054
        note(u"%s remembered location %s", verb_string, display_url)
 
3055
        return stored_location
 
3056
 
 
3057
 
 
3058
class cmd_remerge(Command):
 
3059
    """Redo a merge.
 
3060
 
 
3061
    Use this if you want to try a different merge technique while resolving
 
3062
    conflicts.  Some merge techniques are better than others, and remerge 
 
3063
    lets you try different ones on different files.
 
3064
 
 
3065
    The options for remerge have the same meaning and defaults as the ones for
 
3066
    merge.  The difference is that remerge can (only) be run when there is a
 
3067
    pending merge, and it lets you specify particular files.
 
3068
 
 
3069
    :Examples:
 
3070
        Re-do the merge of all conflicted files, and show the base text in
 
3071
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3072
      
 
3073
            bzr remerge --show-base
 
3074
 
 
3075
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3076
        additional processing to reduce the size of conflict regions::
 
3077
      
 
3078
            bzr remerge --merge-type weave --reprocess foobar
 
3079
    """
 
3080
    takes_args = ['file*']
 
3081
    takes_options = [
 
3082
            'merge-type',
 
3083
            'reprocess',
 
3084
            Option('show-base',
 
3085
                   help="Show base revision text in conflicts."),
 
3086
            ]
 
3087
 
 
3088
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3089
            reprocess=False):
 
3090
        if merge_type is None:
 
3091
            merge_type = _mod_merge.Merge3Merger
 
3092
        tree, file_list = tree_files(file_list)
 
3093
        tree.lock_write()
 
3094
        try:
 
3095
            parents = tree.get_parent_ids()
 
3096
            if len(parents) != 2:
 
3097
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3098
                                             " merges.  Not cherrypicking or"
 
3099
                                             " multi-merges.")
 
3100
            repository = tree.branch.repository
 
3101
            interesting_ids = None
 
3102
            new_conflicts = []
 
3103
            conflicts = tree.conflicts()
 
3104
            if file_list is not None:
 
3105
                interesting_ids = set()
 
3106
                for filename in file_list:
 
3107
                    file_id = tree.path2id(filename)
 
3108
                    if file_id is None:
 
3109
                        raise errors.NotVersionedError(filename)
 
3110
                    interesting_ids.add(file_id)
 
3111
                    if tree.kind(file_id) != "directory":
 
3112
                        continue
 
3113
                    
 
3114
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3115
                        interesting_ids.add(ie.file_id)
 
3116
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3117
            else:
 
3118
                # Remerge only supports resolving contents conflicts
 
3119
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3120
                restore_files = [c.path for c in conflicts
 
3121
                                 if c.typestring in allowed_conflicts]
 
3122
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3123
            tree.set_conflicts(ConflictList(new_conflicts))
 
3124
            if file_list is not None:
 
3125
                restore_files = file_list
 
3126
            for filename in restore_files:
 
3127
                try:
 
3128
                    restore(tree.abspath(filename))
 
3129
                except errors.NotConflicted:
 
3130
                    pass
 
3131
            # Disable pending merges, because the file texts we are remerging
 
3132
            # have not had those merges performed.  If we use the wrong parents
 
3133
            # list, we imply that the working tree text has seen and rejected
 
3134
            # all the changes from the other tree, when in fact those changes
 
3135
            # have not yet been seen.
 
3136
            pb = ui.ui_factory.nested_progress_bar()
 
3137
            tree.set_parent_ids(parents[:1])
 
3138
            try:
 
3139
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3140
                                                             tree, parents[1])
 
3141
                merger.interesting_ids = interesting_ids
 
3142
                merger.merge_type = merge_type
 
3143
                merger.show_base = show_base
 
3144
                merger.reprocess = reprocess
 
3145
                conflicts = merger.do_merge()
 
3146
            finally:
 
3147
                tree.set_parent_ids(parents)
 
3148
                pb.finished()
 
3149
        finally:
 
3150
            tree.unlock()
 
3151
        if conflicts > 0:
 
3152
            return 1
 
3153
        else:
 
3154
            return 0
 
3155
 
 
3156
 
 
3157
class cmd_revert(Command):
 
3158
    """Revert files to a previous revision.
 
3159
 
 
3160
    Giving a list of files will revert only those files.  Otherwise, all files
 
3161
    will be reverted.  If the revision is not specified with '--revision', the
 
3162
    last committed revision is used.
 
3163
 
 
3164
    To remove only some changes, without reverting to a prior version, use
 
3165
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3166
    changes introduced by -2, without affecting the changes introduced by -1.
 
3167
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3168
    
 
3169
    By default, any files that have been manually changed will be backed up
 
3170
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3171
    '.~#~' appended to their name, where # is a number.
 
3172
 
 
3173
    When you provide files, you can use their current pathname or the pathname
 
3174
    from the target revision.  So you can use revert to "undelete" a file by
 
3175
    name.  If you name a directory, all the contents of that directory will be
 
3176
    reverted.
 
3177
 
 
3178
    Any files that have been newly added since that revision will be deleted,
 
3179
    with a backup kept if appropriate.  Directories containing unknown files
 
3180
    will not be deleted.
 
3181
 
 
3182
    The working tree contains a list of pending merged revisions, which will
 
3183
    be included as parents in the next commit.  Normally, revert clears that
 
3184
    list as well as reverting the files.  If any files are specified, revert
 
3185
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3186
    revert ." in the tree root to revert all files but keep the merge record,
 
3187
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3188
    reverting any files.
 
3189
    """
 
3190
 
 
3191
    _see_also = ['cat', 'export']
 
3192
    takes_options = [
 
3193
        'revision',
 
3194
        Option('no-backup', "Do not save backups of reverted files."),
 
3195
        Option('forget-merges',
 
3196
               'Remove pending merge marker, without changing any files.'),
 
3197
        ]
 
3198
    takes_args = ['file*']
 
3199
 
 
3200
    def run(self, revision=None, no_backup=False, file_list=None,
 
3201
            forget_merges=None):
 
3202
        tree, file_list = tree_files(file_list)
 
3203
        if forget_merges:
 
3204
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3205
        else:
 
3206
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3207
 
 
3208
    @staticmethod
 
3209
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3210
        if revision is None:
 
3211
            rev_id = tree.last_revision()
 
3212
        elif len(revision) != 1:
 
3213
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3214
        else:
 
3215
            rev_id = revision[0].as_revision_id(tree.branch)
 
3216
        pb = ui.ui_factory.nested_progress_bar()
 
3217
        try:
 
3218
            tree.revert(file_list,
 
3219
                        tree.branch.repository.revision_tree(rev_id),
 
3220
                        not no_backup, pb, report_changes=True)
 
3221
        finally:
 
3222
            pb.finished()
 
3223
 
 
3224
 
 
3225
class cmd_assert_fail(Command):
 
3226
    """Test reporting of assertion failures"""
 
3227
    # intended just for use in testing
 
3228
 
 
3229
    hidden = True
 
3230
 
 
3231
    def run(self):
 
3232
        raise AssertionError("always fails")
 
3233
 
 
3234
 
 
3235
class cmd_help(Command):
 
3236
    """Show help on a command or other topic.
 
3237
    """
 
3238
 
 
3239
    _see_also = ['topics']
 
3240
    takes_options = [
 
3241
            Option('long', 'Show help on all commands.'),
 
3242
            ]
 
3243
    takes_args = ['topic?']
 
3244
    aliases = ['?', '--help', '-?', '-h']
 
3245
    
 
3246
    @display_command
 
3247
    def run(self, topic=None, long=False):
 
3248
        import bzrlib.help
 
3249
        if topic is None and long:
 
3250
            topic = "commands"
 
3251
        bzrlib.help.help(topic)
 
3252
 
 
3253
 
 
3254
class cmd_shell_complete(Command):
 
3255
    """Show appropriate completions for context.
 
3256
 
 
3257
    For a list of all available commands, say 'bzr shell-complete'.
 
3258
    """
 
3259
    takes_args = ['context?']
 
3260
    aliases = ['s-c']
 
3261
    hidden = True
 
3262
    
 
3263
    @display_command
 
3264
    def run(self, context=None):
 
3265
        import shellcomplete
 
3266
        shellcomplete.shellcomplete(context)
 
3267
 
 
3268
 
 
3269
class cmd_fetch(Command):
 
3270
    """Copy in history from another branch but don't merge it.
 
3271
 
 
3272
    This is an internal method used for pull and merge.
 
3273
    """
 
3274
    hidden = True
 
3275
    takes_args = ['from_branch', 'to_branch']
 
3276
    def run(self, from_branch, to_branch):
 
3277
        from bzrlib.fetch import Fetcher
 
3278
        from_b = Branch.open(from_branch)
 
3279
        to_b = Branch.open(to_branch)
 
3280
        Fetcher(to_b, from_b)
 
3281
 
 
3282
 
 
3283
class cmd_missing(Command):
 
3284
    """Show unmerged/unpulled revisions between two branches.
 
3285
    
 
3286
    OTHER_BRANCH may be local or remote.
 
3287
    """
 
3288
 
 
3289
    _see_also = ['merge', 'pull']
 
3290
    takes_args = ['other_branch?']
 
3291
    takes_options = [
 
3292
            Option('reverse', 'Reverse the order of revisions.'),
 
3293
            Option('mine-only',
 
3294
                   'Display changes in the local branch only.'),
 
3295
            Option('this' , 'Same as --mine-only.'),
 
3296
            Option('theirs-only',
 
3297
                   'Display changes in the remote branch only.'),
 
3298
            Option('other', 'Same as --theirs-only.'),
 
3299
            'log-format',
 
3300
            'show-ids',
 
3301
            'verbose'
 
3302
            ]
 
3303
    encoding_type = 'replace'
 
3304
 
 
3305
    @display_command
 
3306
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3307
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3308
            show_ids=False, verbose=False, this=False, other=False):
 
3309
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3310
 
 
3311
        if this:
 
3312
          mine_only = this
 
3313
        if other:
 
3314
          theirs_only = other
 
3315
 
 
3316
        local_branch = Branch.open_containing(u".")[0]
 
3317
        parent = local_branch.get_parent()
 
3318
        if other_branch is None:
 
3319
            other_branch = parent
 
3320
            if other_branch is None:
 
3321
                raise errors.BzrCommandError("No peer location known"
 
3322
                                             " or specified.")
 
3323
            display_url = urlutils.unescape_for_display(parent,
 
3324
                                                        self.outf.encoding)
 
3325
            self.outf.write("Using last location: " + display_url + "\n")
 
3326
 
 
3327
        remote_branch = Branch.open(other_branch)
 
3328
        if remote_branch.base == local_branch.base:
 
3329
            remote_branch = local_branch
 
3330
        local_branch.lock_read()
 
3331
        try:
 
3332
            remote_branch.lock_read()
 
3333
            try:
 
3334
                local_extra, remote_extra = find_unmerged(local_branch,
 
3335
                                                          remote_branch)
 
3336
                if log_format is None:
 
3337
                    registry = log.log_formatter_registry
 
3338
                    log_format = registry.get_default(local_branch)
 
3339
                lf = log_format(to_file=self.outf,
 
3340
                                show_ids=show_ids,
 
3341
                                show_timezone='original')
 
3342
                if reverse is False:
 
3343
                    local_extra.reverse()
 
3344
                    remote_extra.reverse()
 
3345
                if local_extra and not theirs_only:
 
3346
                    self.outf.write("You have %d extra revision(s):\n" %
 
3347
                                    len(local_extra))
 
3348
                    for revision in iter_log_revisions(local_extra,
 
3349
                                        local_branch.repository,
 
3350
                                        verbose):
 
3351
                        lf.log_revision(revision)
 
3352
                    printed_local = True
 
3353
                else:
 
3354
                    printed_local = False
 
3355
                if remote_extra and not mine_only:
 
3356
                    if printed_local is True:
 
3357
                        self.outf.write("\n\n\n")
 
3358
                    self.outf.write("You are missing %d revision(s):\n" %
 
3359
                                    len(remote_extra))
 
3360
                    for revision in iter_log_revisions(remote_extra,
 
3361
                                        remote_branch.repository,
 
3362
                                        verbose):
 
3363
                        lf.log_revision(revision)
 
3364
                if not remote_extra and not local_extra:
 
3365
                    status_code = 0
 
3366
                    self.outf.write("Branches are up to date.\n")
 
3367
                else:
 
3368
                    status_code = 1
 
3369
            finally:
 
3370
                remote_branch.unlock()
 
3371
        finally:
 
3372
            local_branch.unlock()
 
3373
        if not status_code and parent is None and other_branch is not None:
 
3374
            local_branch.lock_write()
 
3375
            try:
 
3376
                # handle race conditions - a parent might be set while we run.
 
3377
                if local_branch.get_parent() is None:
 
3378
                    local_branch.set_parent(remote_branch.base)
 
3379
            finally:
 
3380
                local_branch.unlock()
 
3381
        return status_code
 
3382
 
 
3383
 
 
3384
class cmd_pack(Command):
 
3385
    """Compress the data within a repository."""
 
3386
 
 
3387
    _see_also = ['repositories']
 
3388
    takes_args = ['branch_or_repo?']
 
3389
 
 
3390
    def run(self, branch_or_repo='.'):
 
3391
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3392
        try:
 
3393
            branch = dir.open_branch()
 
3394
            repository = branch.repository
 
3395
        except errors.NotBranchError:
 
3396
            repository = dir.open_repository()
 
3397
        repository.pack()
 
3398
 
 
3399
 
 
3400
class cmd_plugins(Command):
 
3401
    """List the installed plugins.
 
3402
    
 
3403
    This command displays the list of installed plugins including
 
3404
    version of plugin and a short description of each.
 
3405
 
 
3406
    --verbose shows the path where each plugin is located.
 
3407
 
 
3408
    A plugin is an external component for Bazaar that extends the
 
3409
    revision control system, by adding or replacing code in Bazaar.
 
3410
    Plugins can do a variety of things, including overriding commands,
 
3411
    adding new commands, providing additional network transports and
 
3412
    customizing log output.
 
3413
 
 
3414
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3415
    information on plugins including where to find them and how to
 
3416
    install them. Instructions are also provided there on how to
 
3417
    write new plugins using the Python programming language.
 
3418
    """
 
3419
    takes_options = ['verbose']
 
3420
 
 
3421
    @display_command
 
3422
    def run(self, verbose=False):
 
3423
        import bzrlib.plugin
 
3424
        from inspect import getdoc
 
3425
        result = []
 
3426
        for name, plugin in bzrlib.plugin.plugins().items():
 
3427
            version = plugin.__version__
 
3428
            if version == 'unknown':
 
3429
                version = ''
 
3430
            name_ver = '%s %s' % (name, version)
 
3431
            d = getdoc(plugin.module)
 
3432
            if d:
 
3433
                doc = d.split('\n')[0]
 
3434
            else:
 
3435
                doc = '(no description)'
 
3436
            result.append((name_ver, doc, plugin.path()))
 
3437
        for name_ver, doc, path in sorted(result):
 
3438
            print name_ver
 
3439
            print '   ', doc
 
3440
            if verbose:
 
3441
                print '   ', path
 
3442
            print
 
3443
 
 
3444
 
 
3445
class cmd_testament(Command):
 
3446
    """Show testament (signing-form) of a revision."""
 
3447
    takes_options = [
 
3448
            'revision',
 
3449
            Option('long', help='Produce long-format testament.'),
 
3450
            Option('strict',
 
3451
                   help='Produce a strict-format testament.')]
 
3452
    takes_args = ['branch?']
 
3453
    @display_command
 
3454
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3455
        from bzrlib.testament import Testament, StrictTestament
 
3456
        if strict is True:
 
3457
            testament_class = StrictTestament
 
3458
        else:
 
3459
            testament_class = Testament
 
3460
        b = WorkingTree.open_containing(branch)[0].branch
 
3461
        b.lock_read()
 
3462
        try:
 
3463
            if revision is None:
 
3464
                rev_id = b.last_revision()
 
3465
            else:
 
3466
                rev_id = revision[0].as_revision_id(b)
 
3467
            t = testament_class.from_revision(b.repository, rev_id)
 
3468
            if long:
 
3469
                sys.stdout.writelines(t.as_text_lines())
 
3470
            else:
 
3471
                sys.stdout.write(t.as_short_text())
 
3472
        finally:
 
3473
            b.unlock()
 
3474
 
 
3475
 
 
3476
class cmd_annotate(Command):
 
3477
    """Show the origin of each line in a file.
 
3478
 
 
3479
    This prints out the given file with an annotation on the left side
 
3480
    indicating which revision, author and date introduced the change.
 
3481
 
 
3482
    If the origin is the same for a run of consecutive lines, it is 
 
3483
    shown only at the top, unless the --all option is given.
 
3484
    """
 
3485
    # TODO: annotate directories; showing when each file was last changed
 
3486
    # TODO: if the working copy is modified, show annotations on that 
 
3487
    #       with new uncommitted lines marked
 
3488
    aliases = ['ann', 'blame', 'praise']
 
3489
    takes_args = ['filename']
 
3490
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3491
                     Option('long', help='Show commit date in annotations.'),
 
3492
                     'revision',
 
3493
                     'show-ids',
 
3494
                     ]
 
3495
    encoding_type = 'exact'
 
3496
 
 
3497
    @display_command
 
3498
    def run(self, filename, all=False, long=False, revision=None,
 
3499
            show_ids=False):
 
3500
        from bzrlib.annotate import annotate_file
 
3501
        wt, branch, relpath = \
 
3502
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3503
        if wt is not None:
 
3504
            wt.lock_read()
 
3505
        else:
 
3506
            branch.lock_read()
 
3507
        try:
 
3508
            if revision is None:
 
3509
                revision_id = branch.last_revision()
 
3510
            elif len(revision) != 1:
 
3511
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3512
            else:
 
3513
                revision_id = revision[0].as_revision_id(branch)
 
3514
            tree = branch.repository.revision_tree(revision_id)
 
3515
            if wt is not None:
 
3516
                file_id = wt.path2id(relpath)
 
3517
            else:
 
3518
                file_id = tree.path2id(relpath)
 
3519
            if file_id is None:
 
3520
                raise errors.NotVersionedError(filename)
 
3521
            file_version = tree.inventory[file_id].revision
 
3522
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3523
                          show_ids=show_ids)
 
3524
        finally:
 
3525
            if wt is not None:
 
3526
                wt.unlock()
 
3527
            else:
 
3528
                branch.unlock()
 
3529
 
 
3530
 
 
3531
class cmd_re_sign(Command):
 
3532
    """Create a digital signature for an existing revision."""
 
3533
    # TODO be able to replace existing ones.
 
3534
 
 
3535
    hidden = True # is this right ?
 
3536
    takes_args = ['revision_id*']
 
3537
    takes_options = ['revision']
 
3538
    
 
3539
    def run(self, revision_id_list=None, revision=None):
 
3540
        if revision_id_list is not None and revision is not None:
 
3541
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3542
        if revision_id_list is None and revision is None:
 
3543
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3544
        b = WorkingTree.open_containing(u'.')[0].branch
 
3545
        b.lock_write()
 
3546
        try:
 
3547
            return self._run(b, revision_id_list, revision)
 
3548
        finally:
 
3549
            b.unlock()
 
3550
 
 
3551
    def _run(self, b, revision_id_list, revision):
 
3552
        import bzrlib.gpg as gpg
 
3553
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3554
        if revision_id_list is not None:
 
3555
            b.repository.start_write_group()
 
3556
            try:
 
3557
                for revision_id in revision_id_list:
 
3558
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3559
            except:
 
3560
                b.repository.abort_write_group()
 
3561
                raise
 
3562
            else:
 
3563
                b.repository.commit_write_group()
 
3564
        elif revision is not None:
 
3565
            if len(revision) == 1:
 
3566
                revno, rev_id = revision[0].in_history(b)
 
3567
                b.repository.start_write_group()
 
3568
                try:
 
3569
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3570
                except:
 
3571
                    b.repository.abort_write_group()
 
3572
                    raise
 
3573
                else:
 
3574
                    b.repository.commit_write_group()
 
3575
            elif len(revision) == 2:
 
3576
                # are they both on rh- if so we can walk between them
 
3577
                # might be nice to have a range helper for arbitrary
 
3578
                # revision paths. hmm.
 
3579
                from_revno, from_revid = revision[0].in_history(b)
 
3580
                to_revno, to_revid = revision[1].in_history(b)
 
3581
                if to_revid is None:
 
3582
                    to_revno = b.revno()
 
3583
                if from_revno is None or to_revno is None:
 
3584
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3585
                b.repository.start_write_group()
 
3586
                try:
 
3587
                    for revno in range(from_revno, to_revno + 1):
 
3588
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3589
                                                   gpg_strategy)
 
3590
                except:
 
3591
                    b.repository.abort_write_group()
 
3592
                    raise
 
3593
                else:
 
3594
                    b.repository.commit_write_group()
 
3595
            else:
 
3596
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3597
 
 
3598
 
 
3599
class cmd_bind(Command):
 
3600
    """Convert the current branch into a checkout of the supplied branch.
 
3601
 
 
3602
    Once converted into a checkout, commits must succeed on the master branch
 
3603
    before they will be applied to the local branch.
 
3604
    """
 
3605
 
 
3606
    _see_also = ['checkouts', 'unbind']
 
3607
    takes_args = ['location?']
 
3608
    takes_options = []
 
3609
 
 
3610
    def run(self, location=None):
 
3611
        b, relpath = Branch.open_containing(u'.')
 
3612
        if location is None:
 
3613
            try:
 
3614
                location = b.get_old_bound_location()
 
3615
            except errors.UpgradeRequired:
 
3616
                raise errors.BzrCommandError('No location supplied.  '
 
3617
                    'This format does not remember old locations.')
 
3618
            else:
 
3619
                if location is None:
 
3620
                    raise errors.BzrCommandError('No location supplied and no '
 
3621
                        'previous location known')
 
3622
        b_other = Branch.open(location)
 
3623
        try:
 
3624
            b.bind(b_other)
 
3625
        except errors.DivergedBranches:
 
3626
            raise errors.BzrCommandError('These branches have diverged.'
 
3627
                                         ' Try merging, and then bind again.')
 
3628
 
 
3629
 
 
3630
class cmd_unbind(Command):
 
3631
    """Convert the current checkout into a regular branch.
 
3632
 
 
3633
    After unbinding, the local branch is considered independent and subsequent
 
3634
    commits will be local only.
 
3635
    """
 
3636
 
 
3637
    _see_also = ['checkouts', 'bind']
 
3638
    takes_args = []
 
3639
    takes_options = []
 
3640
 
 
3641
    def run(self):
 
3642
        b, relpath = Branch.open_containing(u'.')
 
3643
        if not b.unbind():
 
3644
            raise errors.BzrCommandError('Local branch is not bound')
 
3645
 
 
3646
 
 
3647
class cmd_uncommit(Command):
 
3648
    """Remove the last committed revision.
 
3649
 
 
3650
    --verbose will print out what is being removed.
 
3651
    --dry-run will go through all the motions, but not actually
 
3652
    remove anything.
 
3653
 
 
3654
    If --revision is specified, uncommit revisions to leave the branch at the
 
3655
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3656
    branch at revision 15.
 
3657
 
 
3658
    In the future, uncommit will create a revision bundle, which can then
 
3659
    be re-applied.
 
3660
    """
 
3661
 
 
3662
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3663
    # unreferenced information in 'branch-as-repository' branches.
 
3664
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3665
    # information in shared branches as well.
 
3666
    _see_also = ['commit']
 
3667
    takes_options = ['verbose', 'revision',
 
3668
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3669
                    Option('force', help='Say yes to all questions.'),
 
3670
                    Option('local',
 
3671
                           help="Only remove the commits from the local branch"
 
3672
                                " when in a checkout."
 
3673
                           ),
 
3674
                    ]
 
3675
    takes_args = ['location?']
 
3676
    aliases = []
 
3677
    encoding_type = 'replace'
 
3678
 
 
3679
    def run(self, location=None,
 
3680
            dry_run=False, verbose=False,
 
3681
            revision=None, force=False, local=False):
 
3682
        if location is None:
 
3683
            location = u'.'
 
3684
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3685
        try:
 
3686
            tree = control.open_workingtree()
 
3687
            b = tree.branch
 
3688
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3689
            tree = None
 
3690
            b = control.open_branch()
 
3691
 
 
3692
        if tree is not None:
 
3693
            tree.lock_write()
 
3694
        else:
 
3695
            b.lock_write()
 
3696
        try:
 
3697
            return self._run(b, tree, dry_run, verbose, revision, force,
 
3698
                             local=local)
 
3699
        finally:
 
3700
            if tree is not None:
 
3701
                tree.unlock()
 
3702
            else:
 
3703
                b.unlock()
 
3704
 
 
3705
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
3706
        from bzrlib.log import log_formatter, show_log
 
3707
        from bzrlib.uncommit import uncommit
 
3708
 
 
3709
        last_revno, last_rev_id = b.last_revision_info()
 
3710
 
 
3711
        rev_id = None
 
3712
        if revision is None:
 
3713
            revno = last_revno
 
3714
            rev_id = last_rev_id
 
3715
        else:
 
3716
            # 'bzr uncommit -r 10' actually means uncommit
 
3717
            # so that the final tree is at revno 10.
 
3718
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3719
            # the revisions that are supplied.
 
3720
            # So we need to offset it by one
 
3721
            revno = revision[0].in_history(b).revno + 1
 
3722
            if revno <= last_revno:
 
3723
                rev_id = b.get_rev_id(revno)
 
3724
 
 
3725
        if rev_id is None or _mod_revision.is_null(rev_id):
 
3726
            self.outf.write('No revisions to uncommit.\n')
 
3727
            return 1
 
3728
 
 
3729
        lf = log_formatter('short',
 
3730
                           to_file=self.outf,
 
3731
                           show_timezone='original')
 
3732
 
 
3733
        show_log(b,
 
3734
                 lf,
 
3735
                 verbose=False,
 
3736
                 direction='forward',
 
3737
                 start_revision=revno,
 
3738
                 end_revision=last_revno)
 
3739
 
 
3740
        if dry_run:
 
3741
            print 'Dry-run, pretending to remove the above revisions.'
 
3742
            if not force:
 
3743
                val = raw_input('Press <enter> to continue')
 
3744
        else:
 
3745
            print 'The above revision(s) will be removed.'
 
3746
            if not force:
 
3747
                val = raw_input('Are you sure [y/N]? ')
 
3748
                if val.lower() not in ('y', 'yes'):
 
3749
                    print 'Canceled'
 
3750
                    return 0
 
3751
 
 
3752
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3753
                 revno=revno, local=local)
 
3754
 
 
3755
 
 
3756
class cmd_break_lock(Command):
 
3757
    """Break a dead lock on a repository, branch or working directory.
 
3758
 
 
3759
    CAUTION: Locks should only be broken when you are sure that the process
 
3760
    holding the lock has been stopped.
 
3761
 
 
3762
    You can get information on what locks are open via the 'bzr info' command.
 
3763
    
 
3764
    :Examples:
 
3765
        bzr break-lock
 
3766
    """
 
3767
    takes_args = ['location?']
 
3768
 
 
3769
    def run(self, location=None, show=False):
 
3770
        if location is None:
 
3771
            location = u'.'
 
3772
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3773
        try:
 
3774
            control.break_lock()
 
3775
        except NotImplementedError:
 
3776
            pass
 
3777
        
 
3778
 
 
3779
class cmd_wait_until_signalled(Command):
 
3780
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3781
 
 
3782
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3783
    """
 
3784
 
 
3785
    hidden = True
 
3786
 
 
3787
    def run(self):
 
3788
        sys.stdout.write("running\n")
 
3789
        sys.stdout.flush()
 
3790
        sys.stdin.readline()
 
3791
 
 
3792
 
 
3793
class cmd_serve(Command):
 
3794
    """Run the bzr server."""
 
3795
 
 
3796
    aliases = ['server']
 
3797
 
 
3798
    takes_options = [
 
3799
        Option('inet',
 
3800
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3801
        Option('port',
 
3802
               help='Listen for connections on nominated port of the form '
 
3803
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3804
                    'result in a dynamically allocated port.  The default port is '
 
3805
                    '4155.',
 
3806
               type=str),
 
3807
        Option('directory',
 
3808
               help='Serve contents of this directory.',
 
3809
               type=unicode),
 
3810
        Option('allow-writes',
 
3811
               help='By default the server is a readonly server.  Supplying '
 
3812
                    '--allow-writes enables write access to the contents of '
 
3813
                    'the served directory and below.'
 
3814
                ),
 
3815
        ]
 
3816
 
 
3817
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3818
        from bzrlib import lockdir
 
3819
        from bzrlib.smart import medium, server
 
3820
        from bzrlib.transport import get_transport
 
3821
        from bzrlib.transport.chroot import ChrootServer
 
3822
        if directory is None:
 
3823
            directory = os.getcwd()
 
3824
        url = urlutils.local_path_to_url(directory)
 
3825
        if not allow_writes:
 
3826
            url = 'readonly+' + url
 
3827
        chroot_server = ChrootServer(get_transport(url))
 
3828
        chroot_server.setUp()
 
3829
        t = get_transport(chroot_server.get_url())
 
3830
        if inet:
 
3831
            smart_server = medium.SmartServerPipeStreamMedium(
 
3832
                sys.stdin, sys.stdout, t)
 
3833
        else:
 
3834
            host = medium.BZR_DEFAULT_INTERFACE
 
3835
            if port is None:
 
3836
                port = medium.BZR_DEFAULT_PORT
 
3837
            else:
 
3838
                if ':' in port:
 
3839
                    host, port = port.split(':')
 
3840
                port = int(port)
 
3841
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3842
            print 'listening on port: ', smart_server.port
 
3843
            sys.stdout.flush()
 
3844
        # for the duration of this server, no UI output is permitted.
 
3845
        # note that this may cause problems with blackbox tests. This should
 
3846
        # be changed with care though, as we dont want to use bandwidth sending
 
3847
        # progress over stderr to smart server clients!
 
3848
        old_factory = ui.ui_factory
 
3849
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3850
        try:
 
3851
            ui.ui_factory = ui.SilentUIFactory()
 
3852
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3853
            smart_server.serve()
 
3854
        finally:
 
3855
            ui.ui_factory = old_factory
 
3856
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
3857
 
 
3858
 
 
3859
class cmd_join(Command):
 
3860
    """Combine a subtree into its containing tree.
 
3861
    
 
3862
    This command is for experimental use only.  It requires the target tree
 
3863
    to be in dirstate-with-subtree format, which cannot be converted into
 
3864
    earlier formats.
 
3865
 
 
3866
    The TREE argument should be an independent tree, inside another tree, but
 
3867
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3868
    running "bzr branch" with the target inside a tree.)
 
3869
 
 
3870
    The result is a combined tree, with the subtree no longer an independant
 
3871
    part.  This is marked as a merge of the subtree into the containing tree,
 
3872
    and all history is preserved.
 
3873
 
 
3874
    If --reference is specified, the subtree retains its independence.  It can
 
3875
    be branched by itself, and can be part of multiple projects at the same
 
3876
    time.  But operations performed in the containing tree, such as commit
 
3877
    and merge, will recurse into the subtree.
 
3878
    """
 
3879
 
 
3880
    _see_also = ['split']
 
3881
    takes_args = ['tree']
 
3882
    takes_options = [
 
3883
            Option('reference', help='Join by reference.'),
 
3884
            ]
 
3885
    hidden = True
 
3886
 
 
3887
    def run(self, tree, reference=False):
 
3888
        sub_tree = WorkingTree.open(tree)
 
3889
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3890
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3891
        repo = containing_tree.branch.repository
 
3892
        if not repo.supports_rich_root():
 
3893
            raise errors.BzrCommandError(
 
3894
                "Can't join trees because %s doesn't support rich root data.\n"
 
3895
                "You can use bzr upgrade on the repository."
 
3896
                % (repo,))
 
3897
        if reference:
 
3898
            try:
 
3899
                containing_tree.add_reference(sub_tree)
 
3900
            except errors.BadReferenceTarget, e:
 
3901
                # XXX: Would be better to just raise a nicely printable
 
3902
                # exception from the real origin.  Also below.  mbp 20070306
 
3903
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3904
                                             (tree, e.reason))
 
3905
        else:
 
3906
            try:
 
3907
                containing_tree.subsume(sub_tree)
 
3908
            except errors.BadSubsumeSource, e:
 
3909
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3910
                                             (tree, e.reason))
 
3911
 
 
3912
 
 
3913
class cmd_split(Command):
 
3914
    """Split a subdirectory of a tree into a separate tree.
 
3915
 
 
3916
    This command will produce a target tree in a format that supports
 
3917
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
3918
    converted into earlier formats like 'dirstate-tags'.
 
3919
 
 
3920
    The TREE argument should be a subdirectory of a working tree.  That
 
3921
    subdirectory will be converted into an independent tree, with its own
 
3922
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3923
    """
 
3924
 
 
3925
    # join is not un-hidden yet
 
3926
    #_see_also = ['join']
 
3927
    takes_args = ['tree']
 
3928
 
 
3929
    def run(self, tree):
 
3930
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3931
        sub_id = containing_tree.path2id(subdir)
 
3932
        if sub_id is None:
 
3933
            raise errors.NotVersionedError(subdir)
 
3934
        try:
 
3935
            containing_tree.extract(sub_id)
 
3936
        except errors.RootNotRich:
 
3937
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3938
 
 
3939
 
 
3940
class cmd_merge_directive(Command):
 
3941
    """Generate a merge directive for auto-merge tools.
 
3942
 
 
3943
    A directive requests a merge to be performed, and also provides all the
 
3944
    information necessary to do so.  This means it must either include a
 
3945
    revision bundle, or the location of a branch containing the desired
 
3946
    revision.
 
3947
 
 
3948
    A submit branch (the location to merge into) must be supplied the first
 
3949
    time the command is issued.  After it has been supplied once, it will
 
3950
    be remembered as the default.
 
3951
 
 
3952
    A public branch is optional if a revision bundle is supplied, but required
 
3953
    if --diff or --plain is specified.  It will be remembered as the default
 
3954
    after the first use.
 
3955
    """
 
3956
 
 
3957
    takes_args = ['submit_branch?', 'public_branch?']
 
3958
 
 
3959
    hidden = True
 
3960
 
 
3961
    _see_also = ['send']
 
3962
 
 
3963
    takes_options = [
 
3964
        RegistryOption.from_kwargs('patch-type',
 
3965
            'The type of patch to include in the directive.',
 
3966
            title='Patch type',
 
3967
            value_switches=True,
 
3968
            enum_switch=False,
 
3969
            bundle='Bazaar revision bundle (default).',
 
3970
            diff='Normal unified diff.',
 
3971
            plain='No patch, just directive.'),
 
3972
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3973
        Option('mail-to', type=str,
 
3974
            help='Instead of printing the directive, email to this address.'),
 
3975
        Option('message', type=str, short_name='m',
 
3976
            help='Message to use when committing this merge.')
 
3977
        ]
 
3978
 
 
3979
    encoding_type = 'exact'
 
3980
 
 
3981
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3982
            sign=False, revision=None, mail_to=None, message=None):
 
3983
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3984
        include_patch, include_bundle = {
 
3985
            'plain': (False, False),
 
3986
            'diff': (True, False),
 
3987
            'bundle': (True, True),
 
3988
            }[patch_type]
 
3989
        branch = Branch.open('.')
 
3990
        stored_submit_branch = branch.get_submit_branch()
 
3991
        if submit_branch is None:
 
3992
            submit_branch = stored_submit_branch
 
3993
        else:
 
3994
            if stored_submit_branch is None:
 
3995
                branch.set_submit_branch(submit_branch)
 
3996
        if submit_branch is None:
 
3997
            submit_branch = branch.get_parent()
 
3998
        if submit_branch is None:
 
3999
            raise errors.BzrCommandError('No submit branch specified or known')
 
4000
 
 
4001
        stored_public_branch = branch.get_public_branch()
 
4002
        if public_branch is None:
 
4003
            public_branch = stored_public_branch
 
4004
        elif stored_public_branch is None:
 
4005
            branch.set_public_branch(public_branch)
 
4006
        if not include_bundle and public_branch is None:
 
4007
            raise errors.BzrCommandError('No public branch specified or'
 
4008
                                         ' known')
 
4009
        base_revision_id = None
 
4010
        if revision is not None:
 
4011
            if len(revision) > 2:
 
4012
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4013
                    'at most two one revision identifiers')
 
4014
            revision_id = revision[-1].as_revision_id(branch)
 
4015
            if len(revision) == 2:
 
4016
                base_revision_id = revision[0].as_revision_id(branch)
 
4017
        else:
 
4018
            revision_id = branch.last_revision()
 
4019
        revision_id = ensure_null(revision_id)
 
4020
        if revision_id == NULL_REVISION:
 
4021
            raise errors.BzrCommandError('No revisions to bundle.')
 
4022
        directive = merge_directive.MergeDirective2.from_objects(
 
4023
            branch.repository, revision_id, time.time(),
 
4024
            osutils.local_time_offset(), submit_branch,
 
4025
            public_branch=public_branch, include_patch=include_patch,
 
4026
            include_bundle=include_bundle, message=message,
 
4027
            base_revision_id=base_revision_id)
 
4028
        if mail_to is None:
 
4029
            if sign:
 
4030
                self.outf.write(directive.to_signed(branch))
 
4031
            else:
 
4032
                self.outf.writelines(directive.to_lines())
 
4033
        else:
 
4034
            message = directive.to_email(mail_to, branch, sign)
 
4035
            s = SMTPConnection(branch.get_config())
 
4036
            s.send_email(message)
 
4037
 
 
4038
 
 
4039
class cmd_send(Command):
 
4040
    """Mail or create a merge-directive for submiting changes.
 
4041
 
 
4042
    A merge directive provides many things needed for requesting merges:
 
4043
 
 
4044
    * A machine-readable description of the merge to perform
 
4045
 
 
4046
    * An optional patch that is a preview of the changes requested
 
4047
 
 
4048
    * An optional bundle of revision data, so that the changes can be applied
 
4049
      directly from the merge directive, without retrieving data from a
 
4050
      branch.
 
4051
 
 
4052
    If --no-bundle is specified, then public_branch is needed (and must be
 
4053
    up-to-date), so that the receiver can perform the merge using the
 
4054
    public_branch.  The public_branch is always included if known, so that
 
4055
    people can check it later.
 
4056
 
 
4057
    The submit branch defaults to the parent, but can be overridden.  Both
 
4058
    submit branch and public branch will be remembered if supplied.
 
4059
 
 
4060
    If a public_branch is known for the submit_branch, that public submit
 
4061
    branch is used in the merge instructions.  This means that a local mirror
 
4062
    can be used as your actual submit branch, once you have set public_branch
 
4063
    for that mirror.
 
4064
 
 
4065
    Mail is sent using your preferred mail program.  This should be transparent
 
4066
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4067
    If the preferred client can't be found (or used), your editor will be used.
 
4068
    
 
4069
    To use a specific mail program, set the mail_client configuration option.
 
4070
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4071
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4072
    generic options are "default", "editor", "mapi", and "xdg-email".
 
4073
 
 
4074
    If mail is being sent, a to address is required.  This can be supplied
 
4075
    either on the commandline, by setting the submit_to configuration
 
4076
    option in the branch itself or the child_submit_to configuration option 
 
4077
    in the submit branch.
 
4078
 
 
4079
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4080
    merge directive format 2.  It is significantly faster and smaller than
 
4081
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4082
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4083
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4084
    
 
4085
    Merge directives are applied using the merge command or the pull command.
 
4086
    """
 
4087
 
 
4088
    encoding_type = 'exact'
 
4089
 
 
4090
    _see_also = ['merge', 'pull']
 
4091
 
 
4092
    takes_args = ['submit_branch?', 'public_branch?']
 
4093
 
 
4094
    takes_options = [
 
4095
        Option('no-bundle',
 
4096
               help='Do not include a bundle in the merge directive.'),
 
4097
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4098
               ' directive.'),
 
4099
        Option('remember',
 
4100
               help='Remember submit and public branch.'),
 
4101
        Option('from',
 
4102
               help='Branch to generate the submission from, '
 
4103
               'rather than the one containing the working directory.',
 
4104
               short_name='f',
 
4105
               type=unicode),
 
4106
        Option('output', short_name='o', help='Write directive to this file.',
 
4107
               type=unicode),
 
4108
        Option('mail-to', help='Mail the request to this address.',
 
4109
               type=unicode),
 
4110
        'revision',
 
4111
        'message',
 
4112
        RegistryOption.from_kwargs('format',
 
4113
        'Use the specified output format.',
 
4114
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4115
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4116
        ]
 
4117
 
 
4118
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4119
            no_patch=False, revision=None, remember=False, output=None,
 
4120
            format='4', mail_to=None, message=None, **kwargs):
 
4121
        return self._run(submit_branch, revision, public_branch, remember,
 
4122
                         format, no_bundle, no_patch, output,
 
4123
                         kwargs.get('from', '.'), mail_to, message)
 
4124
 
 
4125
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4126
             no_bundle, no_patch, output, from_, mail_to, message):
 
4127
        from bzrlib.revision import NULL_REVISION
 
4128
        branch = Branch.open_containing(from_)[0]
 
4129
        if output is None:
 
4130
            outfile = StringIO()
 
4131
        elif output == '-':
 
4132
            outfile = self.outf
 
4133
        else:
 
4134
            outfile = open(output, 'wb')
 
4135
        # we may need to write data into branch's repository to calculate
 
4136
        # the data to send.
 
4137
        branch.lock_write()
 
4138
        try:
 
4139
            if output is None:
 
4140
                config = branch.get_config()
 
4141
                if mail_to is None:
 
4142
                    mail_to = config.get_user_option('submit_to')
 
4143
                mail_client = config.get_mail_client()
 
4144
            if remember and submit_branch is None:
 
4145
                raise errors.BzrCommandError(
 
4146
                    '--remember requires a branch to be specified.')
 
4147
            stored_submit_branch = branch.get_submit_branch()
 
4148
            remembered_submit_branch = False
 
4149
            if submit_branch is None:
 
4150
                submit_branch = stored_submit_branch
 
4151
                remembered_submit_branch = True
 
4152
            else:
 
4153
                if stored_submit_branch is None or remember:
 
4154
                    branch.set_submit_branch(submit_branch)
 
4155
            if submit_branch is None:
 
4156
                submit_branch = branch.get_parent()
 
4157
                remembered_submit_branch = True
 
4158
            if submit_branch is None:
 
4159
                raise errors.BzrCommandError('No submit branch known or'
 
4160
                                             ' specified')
 
4161
            if remembered_submit_branch:
 
4162
                note('Using saved location: %s', submit_branch)
 
4163
 
 
4164
            if mail_to is None:
 
4165
                submit_config = Branch.open(submit_branch).get_config()
 
4166
                mail_to = submit_config.get_user_option("child_submit_to")
 
4167
 
 
4168
            stored_public_branch = branch.get_public_branch()
 
4169
            if public_branch is None:
 
4170
                public_branch = stored_public_branch
 
4171
            elif stored_public_branch is None or remember:
 
4172
                branch.set_public_branch(public_branch)
 
4173
            if no_bundle and public_branch is None:
 
4174
                raise errors.BzrCommandError('No public branch specified or'
 
4175
                                             ' known')
 
4176
            base_revision_id = None
 
4177
            revision_id = None
 
4178
            if revision is not None:
 
4179
                if len(revision) > 2:
 
4180
                    raise errors.BzrCommandError('bzr send takes '
 
4181
                        'at most two one revision identifiers')
 
4182
                revision_id = revision[-1].as_revision_id(branch)
 
4183
                if len(revision) == 2:
 
4184
                    base_revision_id = revision[0].as_revision_id(branch)
 
4185
            if revision_id is None:
 
4186
                revision_id = branch.last_revision()
 
4187
            if revision_id == NULL_REVISION:
 
4188
                raise errors.BzrCommandError('No revisions to submit.')
 
4189
            if format == '4':
 
4190
                directive = merge_directive.MergeDirective2.from_objects(
 
4191
                    branch.repository, revision_id, time.time(),
 
4192
                    osutils.local_time_offset(), submit_branch,
 
4193
                    public_branch=public_branch, include_patch=not no_patch,
 
4194
                    include_bundle=not no_bundle, message=message,
 
4195
                    base_revision_id=base_revision_id)
 
4196
            elif format == '0.9':
 
4197
                if not no_bundle:
 
4198
                    if not no_patch:
 
4199
                        patch_type = 'bundle'
 
4200
                    else:
 
4201
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4202
                            ' permit bundle with no patch')
 
4203
                else:
 
4204
                    if not no_patch:
 
4205
                        patch_type = 'diff'
 
4206
                    else:
 
4207
                        patch_type = None
 
4208
                directive = merge_directive.MergeDirective.from_objects(
 
4209
                    branch.repository, revision_id, time.time(),
 
4210
                    osutils.local_time_offset(), submit_branch,
 
4211
                    public_branch=public_branch, patch_type=patch_type,
 
4212
                    message=message)
 
4213
 
 
4214
            outfile.writelines(directive.to_lines())
 
4215
            if output is None:
 
4216
                subject = '[MERGE] '
 
4217
                if message is not None:
 
4218
                    subject += message
 
4219
                else:
 
4220
                    revision = branch.repository.get_revision(revision_id)
 
4221
                    subject += revision.get_summary()
 
4222
                basename = directive.get_disk_name(branch)
 
4223
                mail_client.compose_merge_request(mail_to, subject,
 
4224
                                                  outfile.getvalue(), basename)
 
4225
        finally:
 
4226
            if output != '-':
 
4227
                outfile.close()
 
4228
            branch.unlock()
 
4229
 
 
4230
 
 
4231
class cmd_bundle_revisions(cmd_send):
 
4232
 
 
4233
    """Create a merge-directive for submiting changes.
 
4234
 
 
4235
    A merge directive provides many things needed for requesting merges:
 
4236
 
 
4237
    * A machine-readable description of the merge to perform
 
4238
 
 
4239
    * An optional patch that is a preview of the changes requested
 
4240
 
 
4241
    * An optional bundle of revision data, so that the changes can be applied
 
4242
      directly from the merge directive, without retrieving data from a
 
4243
      branch.
 
4244
 
 
4245
    If --no-bundle is specified, then public_branch is needed (and must be
 
4246
    up-to-date), so that the receiver can perform the merge using the
 
4247
    public_branch.  The public_branch is always included if known, so that
 
4248
    people can check it later.
 
4249
 
 
4250
    The submit branch defaults to the parent, but can be overridden.  Both
 
4251
    submit branch and public branch will be remembered if supplied.
 
4252
 
 
4253
    If a public_branch is known for the submit_branch, that public submit
 
4254
    branch is used in the merge instructions.  This means that a local mirror
 
4255
    can be used as your actual submit branch, once you have set public_branch
 
4256
    for that mirror.
 
4257
 
 
4258
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4259
    merge directive format 2.  It is significantly faster and smaller than
 
4260
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4261
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4262
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4263
    """
 
4264
 
 
4265
    takes_options = [
 
4266
        Option('no-bundle',
 
4267
               help='Do not include a bundle in the merge directive.'),
 
4268
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4269
               ' directive.'),
 
4270
        Option('remember',
 
4271
               help='Remember submit and public branch.'),
 
4272
        Option('from',
 
4273
               help='Branch to generate the submission from, '
 
4274
               'rather than the one containing the working directory.',
 
4275
               short_name='f',
 
4276
               type=unicode),
 
4277
        Option('output', short_name='o', help='Write directive to this file.',
 
4278
               type=unicode),
 
4279
        'revision',
 
4280
        RegistryOption.from_kwargs('format',
 
4281
        'Use the specified output format.',
 
4282
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4283
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4284
        ]
 
4285
    aliases = ['bundle']
 
4286
 
 
4287
    _see_also = ['send', 'merge']
 
4288
 
 
4289
    hidden = True
 
4290
 
 
4291
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4292
            no_patch=False, revision=None, remember=False, output=None,
 
4293
            format='4', **kwargs):
 
4294
        if output is None:
 
4295
            output = '-'
 
4296
        return self._run(submit_branch, revision, public_branch, remember,
 
4297
                         format, no_bundle, no_patch, output,
 
4298
                         kwargs.get('from', '.'), None, None)
 
4299
 
 
4300
 
 
4301
class cmd_tag(Command):
 
4302
    """Create, remove or modify a tag naming a revision.
 
4303
    
 
4304
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4305
    (--revision) option can be given -rtag:X, where X is any previously
 
4306
    created tag.
 
4307
 
 
4308
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4309
    along when you branch, push, pull or merge.
 
4310
 
 
4311
    It is an error to give a tag name that already exists unless you pass 
 
4312
    --force, in which case the tag is moved to point to the new revision.
 
4313
    """
 
4314
 
 
4315
    _see_also = ['commit', 'tags']
 
4316
    takes_args = ['tag_name']
 
4317
    takes_options = [
 
4318
        Option('delete',
 
4319
            help='Delete this tag rather than placing it.',
 
4320
            ),
 
4321
        Option('directory',
 
4322
            help='Branch in which to place the tag.',
 
4323
            short_name='d',
 
4324
            type=unicode,
 
4325
            ),
 
4326
        Option('force',
 
4327
            help='Replace existing tags.',
 
4328
            ),
 
4329
        'revision',
 
4330
        ]
 
4331
 
 
4332
    def run(self, tag_name,
 
4333
            delete=None,
 
4334
            directory='.',
 
4335
            force=None,
 
4336
            revision=None,
 
4337
            ):
 
4338
        branch, relpath = Branch.open_containing(directory)
 
4339
        branch.lock_write()
 
4340
        try:
 
4341
            if delete:
 
4342
                branch.tags.delete_tag(tag_name)
 
4343
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4344
            else:
 
4345
                if revision:
 
4346
                    if len(revision) != 1:
 
4347
                        raise errors.BzrCommandError(
 
4348
                            "Tags can only be placed on a single revision, "
 
4349
                            "not on a range")
 
4350
                    revision_id = revision[0].as_revision_id(branch)
 
4351
                else:
 
4352
                    revision_id = branch.last_revision()
 
4353
                if (not force) and branch.tags.has_tag(tag_name):
 
4354
                    raise errors.TagAlreadyExists(tag_name)
 
4355
                branch.tags.set_tag(tag_name, revision_id)
 
4356
                self.outf.write('Created tag %s.\n' % tag_name)
 
4357
        finally:
 
4358
            branch.unlock()
 
4359
 
 
4360
 
 
4361
class cmd_tags(Command):
 
4362
    """List tags.
 
4363
 
 
4364
    This command shows a table of tag names and the revisions they reference.
 
4365
    """
 
4366
 
 
4367
    _see_also = ['tag']
 
4368
    takes_options = [
 
4369
        Option('directory',
 
4370
            help='Branch whose tags should be displayed.',
 
4371
            short_name='d',
 
4372
            type=unicode,
 
4373
            ),
 
4374
        RegistryOption.from_kwargs('sort',
 
4375
            'Sort tags by different criteria.', title='Sorting',
 
4376
            alpha='Sort tags lexicographically (default).',
 
4377
            time='Sort tags chronologically.',
 
4378
            ),
 
4379
        'show-ids',
 
4380
    ]
 
4381
 
 
4382
    @display_command
 
4383
    def run(self,
 
4384
            directory='.',
 
4385
            sort='alpha',
 
4386
            show_ids=False,
 
4387
            ):
 
4388
        branch, relpath = Branch.open_containing(directory)
 
4389
        tags = branch.tags.get_tag_dict().items()
 
4390
        if sort == 'alpha':
 
4391
            tags.sort()
 
4392
        elif sort == 'time':
 
4393
            timestamps = {}
 
4394
            for tag, revid in tags:
 
4395
                try:
 
4396
                    revobj = branch.repository.get_revision(revid)
 
4397
                except errors.NoSuchRevision:
 
4398
                    timestamp = sys.maxint # place them at the end
 
4399
                else:
 
4400
                    timestamp = revobj.timestamp
 
4401
                timestamps[revid] = timestamp
 
4402
            tags.sort(key=lambda x: timestamps[x[1]])
 
4403
        if not show_ids:
 
4404
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4405
            revno_map = branch.get_revision_id_to_revno_map()
 
4406
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4407
                        for tag, revid in tags ]
 
4408
        for tag, revspec in tags:
 
4409
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4410
 
 
4411
 
 
4412
class cmd_reconfigure(Command):
 
4413
    """Reconfigure the type of a bzr directory.
 
4414
 
 
4415
    A target configuration must be specified.
 
4416
 
 
4417
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4418
    The order of preference is
 
4419
    1. For a lightweight checkout, the current bound location.
 
4420
    2. For branches that used to be checkouts, the previously-bound location.
 
4421
    3. The push location.
 
4422
    4. The parent location.
 
4423
    If none of these is available, --bind-to must be specified.
 
4424
    """
 
4425
 
 
4426
    takes_args = ['location?']
 
4427
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4428
                     title='Target type',
 
4429
                     help='The type to reconfigure the directory to.',
 
4430
                     value_switches=True, enum_switch=False,
 
4431
                     branch='Reconfigure to a branch.',
 
4432
                     tree='Reconfigure to a tree.',
 
4433
                     checkout='Reconfigure to a checkout.',
 
4434
                     lightweight_checkout='Reconfigure to a lightweight'
 
4435
                     ' checkout.',
 
4436
                     standalone='Reconfigure to be standalone.',
 
4437
                     use_shared='Reconfigure to use a shared repository.'),
 
4438
                     Option('bind-to', help='Branch to bind checkout to.',
 
4439
                            type=str),
 
4440
                     Option('force',
 
4441
                        help='Perform reconfiguration even if local changes'
 
4442
                        ' will be lost.')
 
4443
                     ]
 
4444
 
 
4445
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4446
        directory = bzrdir.BzrDir.open(location)
 
4447
        if target_type is None:
 
4448
            raise errors.BzrCommandError('No target configuration specified')
 
4449
        elif target_type == 'branch':
 
4450
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4451
        elif target_type == 'tree':
 
4452
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4453
        elif target_type == 'checkout':
 
4454
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4455
                                                                  bind_to)
 
4456
        elif target_type == 'lightweight-checkout':
 
4457
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4458
                directory, bind_to)
 
4459
        elif target_type == 'use-shared':
 
4460
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
4461
        elif target_type == 'standalone':
 
4462
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
4463
        reconfiguration.apply(force)
 
4464
 
 
4465
 
 
4466
class cmd_switch(Command):
 
4467
    """Set the branch of a checkout and update.
 
4468
    
 
4469
    For lightweight checkouts, this changes the branch being referenced.
 
4470
    For heavyweight checkouts, this checks that there are no local commits
 
4471
    versus the current bound branch, then it makes the local branch a mirror
 
4472
    of the new location and binds to it.
 
4473
    
 
4474
    In both cases, the working tree is updated and uncommitted changes
 
4475
    are merged. The user can commit or revert these as they desire.
 
4476
 
 
4477
    Pending merges need to be committed or reverted before using switch.
 
4478
 
 
4479
    The path to the branch to switch to can be specified relative to the parent
 
4480
    directory of the current branch. For example, if you are currently in a
 
4481
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
4482
    /path/to/newbranch.
 
4483
    """
 
4484
 
 
4485
    takes_args = ['to_location']
 
4486
    takes_options = [Option('force',
 
4487
                        help='Switch even if local commits will be lost.')
 
4488
                     ]
 
4489
 
 
4490
    def run(self, to_location, force=False):
 
4491
        from bzrlib import switch
 
4492
        tree_location = '.'
 
4493
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4494
        try:
 
4495
            to_branch = Branch.open(to_location)
 
4496
        except errors.NotBranchError:
 
4497
            to_branch = Branch.open(
 
4498
                control_dir.open_branch().base + '../' + to_location)
 
4499
        switch.switch(control_dir, to_branch, force)
 
4500
        note('Switched to branch: %s',
 
4501
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4502
 
 
4503
 
 
4504
class cmd_hooks(Command):
 
4505
    """Show a branch's currently registered hooks.
 
4506
    """
 
4507
 
 
4508
    hidden = True
 
4509
    takes_args = ['path?']
 
4510
 
 
4511
    def run(self, path=None):
 
4512
        if path is None:
 
4513
            path = '.'
 
4514
        branch_hooks = Branch.open(path).hooks
 
4515
        for hook_type in branch_hooks:
 
4516
            hooks = branch_hooks[hook_type]
 
4517
            self.outf.write("%s:\n" % (hook_type,))
 
4518
            if hooks:
 
4519
                for hook in hooks:
 
4520
                    self.outf.write("  %s\n" %
 
4521
                                    (branch_hooks.get_hook_name(hook),))
 
4522
            else:
 
4523
                self.outf.write("  <no hooks installed>\n")
 
4524
 
 
4525
 
 
4526
def _create_prefix(cur_transport):
 
4527
    needed = [cur_transport]
 
4528
    # Recurse upwards until we can create a directory successfully
 
4529
    while True:
 
4530
        new_transport = cur_transport.clone('..')
 
4531
        if new_transport.base == cur_transport.base:
 
4532
            raise errors.BzrCommandError(
 
4533
                "Failed to create path prefix for %s."
 
4534
                % cur_transport.base)
 
4535
        try:
 
4536
            new_transport.mkdir('.')
 
4537
        except errors.NoSuchFile:
 
4538
            needed.append(new_transport)
 
4539
            cur_transport = new_transport
 
4540
        else:
 
4541
            break
 
4542
    # Now we only need to create child directories
 
4543
    while needed:
 
4544
        cur_transport = needed.pop()
 
4545
        cur_transport.ensure_base()
 
4546
 
 
4547
 
 
4548
# these get imported and then picked up by the scan for cmd_*
 
4549
# TODO: Some more consistent way to split command definitions across files;
 
4550
# we do need to load at least some information about them to know of 
 
4551
# aliases.  ideally we would avoid loading the implementation until the
 
4552
# details were needed.
 
4553
from bzrlib.cmd_version_info import cmd_version_info
 
4554
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4555
from bzrlib.bundle.commands import (
 
4556
    cmd_bundle_info,
 
4557
    )
 
4558
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4559
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4560
        cmd_weave_plan_merge, cmd_weave_merge_text