← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

[merge] bzr.dev 2294

Show diffs side-by-side

added added

removed removed

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