/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2007-12-21 15:43:24 UTC
  • mto: This revision was merged to the branch mainline in revision 3146.
  • Revision ID: abentley@panoramicfeedback.com-20071221154324-f4zh3umcv61mt68o
Change failing test to use another command, since checkout now uses trees

Show diffs side-by-side

added added

removed removed

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