/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

More work on roundtrip push support.

Show diffs side-by-side

added added

removed removed

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