/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: Kuno Meyer
  • Date: 2007-07-24 19:40:40 UTC
  • mto: This revision was merged to the branch mainline in revision 2655.
  • Revision ID: kuno.meyer@gmx.ch-20070724194040-ocyjulqhy31xe3j1
Extended tests for unicode chars outside of the iso-8859-* range
Two workarounds for incorrect glob.glob() implementation

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