/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: Canonical.com Patch Queue Manager
  • Date: 2007-07-20 17:25:20 UTC
  • mfrom: (2625.7.1 hacking)
  • Revision ID: pqm@pqm.ubuntu.com-20070720172520-i2ezksmrduaonojd
(Matthew Fuller) Fix URL to built copy of HACKING (bug #109149)

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