/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: Andrew Bennetts
  • Date: 2008-01-22 05:04:50 UTC
  • mto: This revision was merged to the branch mainline in revision 3197.
  • Revision ID: andrew.bennetts@canonical.com-20080122050450-yxa7ohko0y745zg7
Remove accidentally added blank line.

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
    _see_also = ['status']
 
1457
    takes_args = ['file*']
 
1458
    takes_options = [
 
1459
        Option('diff-options', type=str,
 
1460
               help='Pass these options to the external diff program.'),
 
1461
        Option('prefix', type=str,
 
1462
               short_name='p',
 
1463
               help='Set prefixes added to old and new filenames, as '
 
1464
                    'two values separated by a colon. (eg "old/:new/").'),
 
1465
        Option('old',
 
1466
            help='Branch/tree to compare from.',
 
1467
            type=unicode,
 
1468
            ),
 
1469
        Option('new',
 
1470
            help='Branch/tree to compare to.',
 
1471
            type=unicode,
 
1472
            ),
 
1473
        'revision',
 
1474
        'change',
 
1475
        Option('using',
 
1476
            help='Use this command to compare files.',
 
1477
            type=unicode,
 
1478
            ),
 
1479
        ]
 
1480
    aliases = ['di', 'dif']
 
1481
    encoding_type = 'exact'
 
1482
 
 
1483
    @display_command
 
1484
    def run(self, revision=None, file_list=None, diff_options=None,
 
1485
            prefix=None, old=None, new=None, using=None):
 
1486
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1487
 
 
1488
        if (prefix is None) or (prefix == '0'):
 
1489
            # diff -p0 format
 
1490
            old_label = ''
 
1491
            new_label = ''
 
1492
        elif prefix == '1':
 
1493
            old_label = 'old/'
 
1494
            new_label = 'new/'
 
1495
        elif ':' in prefix:
 
1496
            old_label, new_label = prefix.split(":")
 
1497
        else:
 
1498
            raise errors.BzrCommandError(
 
1499
                '--prefix expects two values separated by a colon'
 
1500
                ' (eg "old/:new/")')
 
1501
 
 
1502
        if revision and len(revision) > 2:
 
1503
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1504
                                         ' one or two revision specifiers')
 
1505
 
 
1506
        old_tree, new_tree, specific_files, extra_trees = \
 
1507
                _get_trees_to_diff(file_list, revision, old, new)
 
1508
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1509
                               specific_files=specific_files,
 
1510
                               external_diff_options=diff_options,
 
1511
                               old_label=old_label, new_label=new_label,
 
1512
                               extra_trees=extra_trees, using=using)
 
1513
 
 
1514
 
 
1515
class cmd_deleted(Command):
 
1516
    """List files deleted in the working tree.
 
1517
    """
 
1518
    # TODO: Show files deleted since a previous revision, or
 
1519
    # between two revisions.
 
1520
    # TODO: Much more efficient way to do this: read in new
 
1521
    # directories with readdir, rather than stating each one.  Same
 
1522
    # level of effort but possibly much less IO.  (Or possibly not,
 
1523
    # if the directories are very large...)
 
1524
    _see_also = ['status', 'ls']
 
1525
    takes_options = ['show-ids']
 
1526
 
 
1527
    @display_command
 
1528
    def run(self, show_ids=False):
 
1529
        tree = WorkingTree.open_containing(u'.')[0]
 
1530
        tree.lock_read()
 
1531
        try:
 
1532
            old = tree.basis_tree()
 
1533
            old.lock_read()
 
1534
            try:
 
1535
                for path, ie in old.inventory.iter_entries():
 
1536
                    if not tree.has_id(ie.file_id):
 
1537
                        self.outf.write(path)
 
1538
                        if show_ids:
 
1539
                            self.outf.write(' ')
 
1540
                            self.outf.write(ie.file_id)
 
1541
                        self.outf.write('\n')
 
1542
            finally:
 
1543
                old.unlock()
 
1544
        finally:
 
1545
            tree.unlock()
 
1546
 
 
1547
 
 
1548
class cmd_modified(Command):
 
1549
    """List files modified in working tree.
 
1550
    """
 
1551
 
 
1552
    hidden = True
 
1553
    _see_also = ['status', 'ls']
 
1554
 
 
1555
    @display_command
 
1556
    def run(self):
 
1557
        tree = WorkingTree.open_containing(u'.')[0]
 
1558
        td = tree.changes_from(tree.basis_tree())
 
1559
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1560
            self.outf.write(path + '\n')
 
1561
 
 
1562
 
 
1563
class cmd_added(Command):
 
1564
    """List files added in working tree.
 
1565
    """
 
1566
 
 
1567
    hidden = True
 
1568
    _see_also = ['status', 'ls']
 
1569
 
 
1570
    @display_command
 
1571
    def run(self):
 
1572
        wt = WorkingTree.open_containing(u'.')[0]
 
1573
        wt.lock_read()
 
1574
        try:
 
1575
            basis = wt.basis_tree()
 
1576
            basis.lock_read()
 
1577
            try:
 
1578
                basis_inv = basis.inventory
 
1579
                inv = wt.inventory
 
1580
                for file_id in inv:
 
1581
                    if file_id in basis_inv:
 
1582
                        continue
 
1583
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1584
                        continue
 
1585
                    path = inv.id2path(file_id)
 
1586
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1587
                        continue
 
1588
                    self.outf.write(path + '\n')
 
1589
            finally:
 
1590
                basis.unlock()
 
1591
        finally:
 
1592
            wt.unlock()
 
1593
 
 
1594
 
 
1595
class cmd_root(Command):
 
1596
    """Show the tree root directory.
 
1597
 
 
1598
    The root is the nearest enclosing directory with a .bzr control
 
1599
    directory."""
 
1600
 
 
1601
    takes_args = ['filename?']
 
1602
    @display_command
 
1603
    def run(self, filename=None):
 
1604
        """Print the branch root."""
 
1605
        tree = WorkingTree.open_containing(filename)[0]
 
1606
        self.outf.write(tree.basedir + '\n')
 
1607
 
 
1608
 
 
1609
def _parse_limit(limitstring):
 
1610
    try:
 
1611
        return int(limitstring)
 
1612
    except ValueError:
 
1613
        msg = "The limit argument must be an integer."
 
1614
        raise errors.BzrCommandError(msg)
 
1615
 
 
1616
 
 
1617
class cmd_log(Command):
 
1618
    """Show log of a branch, file, or directory.
 
1619
 
 
1620
    By default show the log of the branch containing the working directory.
 
1621
 
 
1622
    To request a range of logs, you can use the command -r begin..end
 
1623
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1624
    also valid.
 
1625
 
 
1626
    :Examples:
 
1627
        Log the current branch::
 
1628
 
 
1629
            bzr log
 
1630
 
 
1631
        Log a file::
 
1632
 
 
1633
            bzr log foo.c
 
1634
 
 
1635
        Log the last 10 revisions of a branch::
 
1636
 
 
1637
            bzr log -r -10.. http://server/branch
 
1638
    """
 
1639
 
 
1640
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1641
 
 
1642
    takes_args = ['location?']
 
1643
    takes_options = [
 
1644
            Option('forward',
 
1645
                   help='Show from oldest to newest.'),
 
1646
            Option('timezone',
 
1647
                   type=str,
 
1648
                   help='Display timezone as local, original, or utc.'),
 
1649
            custom_help('verbose',
 
1650
                   help='Show files changed in each revision.'),
 
1651
            'show-ids',
 
1652
            'revision',
 
1653
            'log-format',
 
1654
            Option('message',
 
1655
                   short_name='m',
 
1656
                   help='Show revisions whose message matches this '
 
1657
                        'regular expression.',
 
1658
                   type=str),
 
1659
            Option('limit',
 
1660
                   short_name='l',
 
1661
                   help='Limit the output to the first N revisions.',
 
1662
                   argname='N',
 
1663
                   type=_parse_limit),
 
1664
            ]
 
1665
    encoding_type = 'replace'
 
1666
 
 
1667
    @display_command
 
1668
    def run(self, location=None, timezone='original',
 
1669
            verbose=False,
 
1670
            show_ids=False,
 
1671
            forward=False,
 
1672
            revision=None,
 
1673
            log_format=None,
 
1674
            message=None,
 
1675
            limit=None):
 
1676
        from bzrlib.log import show_log
 
1677
        assert message is None or isinstance(message, basestring), \
 
1678
            "invalid message argument %r" % message
 
1679
        direction = (forward and 'forward') or 'reverse'
 
1680
        
 
1681
        # log everything
 
1682
        file_id = None
 
1683
        if location:
 
1684
            # find the file id to log:
 
1685
 
 
1686
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1687
                location)
 
1688
            if fp != '':
 
1689
                if tree is None:
 
1690
                    tree = b.basis_tree()
 
1691
                file_id = tree.path2id(fp)
 
1692
                if file_id is None:
 
1693
                    raise errors.BzrCommandError(
 
1694
                        "Path does not have any revision history: %s" %
 
1695
                        location)
 
1696
        else:
 
1697
            # local dir only
 
1698
            # FIXME ? log the current subdir only RBC 20060203 
 
1699
            if revision is not None \
 
1700
                    and len(revision) > 0 and revision[0].get_branch():
 
1701
                location = revision[0].get_branch()
 
1702
            else:
 
1703
                location = '.'
 
1704
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1705
            b = dir.open_branch()
 
1706
 
 
1707
        b.lock_read()
 
1708
        try:
 
1709
            if revision is None:
 
1710
                rev1 = None
 
1711
                rev2 = None
 
1712
            elif len(revision) == 1:
 
1713
                rev1 = rev2 = revision[0].in_history(b)
 
1714
            elif len(revision) == 2:
 
1715
                if revision[1].get_branch() != revision[0].get_branch():
 
1716
                    # b is taken from revision[0].get_branch(), and
 
1717
                    # show_log will use its revision_history. Having
 
1718
                    # different branches will lead to weird behaviors.
 
1719
                    raise errors.BzrCommandError(
 
1720
                        "Log doesn't accept two revisions in different"
 
1721
                        " branches.")
 
1722
                rev1 = revision[0].in_history(b)
 
1723
                rev2 = revision[1].in_history(b)
 
1724
            else:
 
1725
                raise errors.BzrCommandError(
 
1726
                    'bzr log --revision takes one or two values.')
 
1727
 
 
1728
            if log_format is None:
 
1729
                log_format = log.log_formatter_registry.get_default(b)
 
1730
 
 
1731
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1732
                            show_timezone=timezone)
 
1733
 
 
1734
            show_log(b,
 
1735
                     lf,
 
1736
                     file_id,
 
1737
                     verbose=verbose,
 
1738
                     direction=direction,
 
1739
                     start_revision=rev1,
 
1740
                     end_revision=rev2,
 
1741
                     search=message,
 
1742
                     limit=limit)
 
1743
        finally:
 
1744
            b.unlock()
 
1745
 
 
1746
 
 
1747
def get_log_format(long=False, short=False, line=False, default='long'):
 
1748
    log_format = default
 
1749
    if long:
 
1750
        log_format = 'long'
 
1751
    if short:
 
1752
        log_format = 'short'
 
1753
    if line:
 
1754
        log_format = 'line'
 
1755
    return log_format
 
1756
 
 
1757
 
 
1758
class cmd_touching_revisions(Command):
 
1759
    """Return revision-ids which affected a particular file.
 
1760
 
 
1761
    A more user-friendly interface is "bzr log FILE".
 
1762
    """
 
1763
 
 
1764
    hidden = True
 
1765
    takes_args = ["filename"]
 
1766
 
 
1767
    @display_command
 
1768
    def run(self, filename):
 
1769
        tree, relpath = WorkingTree.open_containing(filename)
 
1770
        b = tree.branch
 
1771
        file_id = tree.path2id(relpath)
 
1772
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1773
            self.outf.write("%6d %s\n" % (revno, what))
 
1774
 
 
1775
 
 
1776
class cmd_ls(Command):
 
1777
    """List files in a tree.
 
1778
    """
 
1779
 
 
1780
    _see_also = ['status', 'cat']
 
1781
    takes_args = ['path?']
 
1782
    # TODO: Take a revision or remote path and list that tree instead.
 
1783
    takes_options = [
 
1784
            'verbose',
 
1785
            'revision',
 
1786
            Option('non-recursive',
 
1787
                   help='Don\'t recurse into subdirectories.'),
 
1788
            Option('from-root',
 
1789
                   help='Print paths relative to the root of the branch.'),
 
1790
            Option('unknown', help='Print unknown files.'),
 
1791
            Option('versioned', help='Print versioned files.'),
 
1792
            Option('ignored', help='Print ignored files.'),
 
1793
            Option('null',
 
1794
                   help='Write an ascii NUL (\\0) separator '
 
1795
                   'between files rather than a newline.'),
 
1796
            Option('kind',
 
1797
                   help='List entries of a particular kind: file, directory, symlink.',
 
1798
                   type=unicode),
 
1799
            'show-ids',
 
1800
            ]
 
1801
    @display_command
 
1802
    def run(self, revision=None, verbose=False,
 
1803
            non_recursive=False, from_root=False,
 
1804
            unknown=False, versioned=False, ignored=False,
 
1805
            null=False, kind=None, show_ids=False, path=None):
 
1806
 
 
1807
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1808
            raise errors.BzrCommandError('invalid kind specified')
 
1809
 
 
1810
        if verbose and null:
 
1811
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1812
        all = not (unknown or versioned or ignored)
 
1813
 
 
1814
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1815
 
 
1816
        if path is None:
 
1817
            fs_path = '.'
 
1818
            prefix = ''
 
1819
        else:
 
1820
            if from_root:
 
1821
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1822
                                             ' and PATH')
 
1823
            fs_path = path
 
1824
            prefix = path
 
1825
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1826
            fs_path)
 
1827
        if from_root:
 
1828
            relpath = u''
 
1829
        elif relpath:
 
1830
            relpath += '/'
 
1831
        if revision is not None:
 
1832
            tree = branch.repository.revision_tree(
 
1833
                revision[0].in_history(branch).rev_id)
 
1834
        elif tree is None:
 
1835
            tree = branch.basis_tree()
 
1836
 
 
1837
        tree.lock_read()
 
1838
        try:
 
1839
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1840
                if fp.startswith(relpath):
 
1841
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1842
                    if non_recursive and '/' in fp:
 
1843
                        continue
 
1844
                    if not all and not selection[fc]:
 
1845
                        continue
 
1846
                    if kind is not None and fkind != kind:
 
1847
                        continue
 
1848
                    if verbose:
 
1849
                        kindch = entry.kind_character()
 
1850
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1851
                        if show_ids and fid is not None:
 
1852
                            outstring = "%-50s %s" % (outstring, fid)
 
1853
                        self.outf.write(outstring + '\n')
 
1854
                    elif null:
 
1855
                        self.outf.write(fp + '\0')
 
1856
                        if show_ids:
 
1857
                            if fid is not None:
 
1858
                                self.outf.write(fid)
 
1859
                            self.outf.write('\0')
 
1860
                        self.outf.flush()
 
1861
                    else:
 
1862
                        if fid is not None:
 
1863
                            my_id = fid
 
1864
                        else:
 
1865
                            my_id = ''
 
1866
                        if show_ids:
 
1867
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1868
                        else:
 
1869
                            self.outf.write(fp + '\n')
 
1870
        finally:
 
1871
            tree.unlock()
 
1872
 
 
1873
 
 
1874
class cmd_unknowns(Command):
 
1875
    """List unknown files.
 
1876
    """
 
1877
 
 
1878
    hidden = True
 
1879
    _see_also = ['ls']
 
1880
 
 
1881
    @display_command
 
1882
    def run(self):
 
1883
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1884
            self.outf.write(osutils.quotefn(f) + '\n')
 
1885
 
 
1886
 
 
1887
class cmd_ignore(Command):
 
1888
    """Ignore specified files or patterns.
 
1889
 
 
1890
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1891
 
 
1892
    Trailing slashes on patterns are ignored. 
 
1893
    If the pattern contains a slash or is a regular expression, it is compared 
 
1894
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1895
    the last component of the path.  To match a file only in the root 
 
1896
    directory, prepend './'.
 
1897
 
 
1898
    Ignore patterns specifying absolute paths are not allowed.
 
1899
 
 
1900
    Ignore patterns may include globbing wildcards such as::
 
1901
 
 
1902
      ? - Matches any single character except '/'
 
1903
      * - Matches 0 or more characters except '/'
 
1904
      /**/ - Matches 0 or more directories in a path
 
1905
      [a-z] - Matches a single character from within a group of characters
 
1906
 
 
1907
    Ignore patterns may also be Python regular expressions.  
 
1908
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1909
    followed by the regular expression.  Regular expression ignore patterns
 
1910
    may not include named or numbered groups.
 
1911
 
 
1912
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1913
    the shell on Unix.
 
1914
 
 
1915
    :Examples:
 
1916
        Ignore the top level Makefile::
 
1917
 
 
1918
            bzr ignore ./Makefile
 
1919
 
 
1920
        Ignore class files in all directories::
 
1921
 
 
1922
            bzr ignore "*.class"
 
1923
 
 
1924
        Ignore .o files under the lib directory::
 
1925
 
 
1926
            bzr ignore "lib/**/*.o"
 
1927
 
 
1928
        Ignore .o files under the lib directory::
 
1929
 
 
1930
            bzr ignore "RE:lib/.*\.o"
 
1931
    """
 
1932
 
 
1933
    _see_also = ['status', 'ignored']
 
1934
    takes_args = ['name_pattern*']
 
1935
    takes_options = [
 
1936
        Option('old-default-rules',
 
1937
               help='Write out the ignore rules bzr < 0.9 always used.')
 
1938
        ]
 
1939
    
 
1940
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1941
        from bzrlib.atomicfile import AtomicFile
 
1942
        if old_default_rules is not None:
 
1943
            # dump the rules and exit
 
1944
            for pattern in ignores.OLD_DEFAULTS:
 
1945
                print pattern
 
1946
            return
 
1947
        if not name_pattern_list:
 
1948
            raise errors.BzrCommandError("ignore requires at least one "
 
1949
                                  "NAME_PATTERN or --old-default-rules")
 
1950
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1951
                             for p in name_pattern_list]
 
1952
        for name_pattern in name_pattern_list:
 
1953
            if (name_pattern[0] == '/' or 
 
1954
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1955
                raise errors.BzrCommandError(
 
1956
                    "NAME_PATTERN should not be an absolute path")
 
1957
        tree, relpath = WorkingTree.open_containing(u'.')
 
1958
        ifn = tree.abspath('.bzrignore')
 
1959
        if os.path.exists(ifn):
 
1960
            f = open(ifn, 'rt')
 
1961
            try:
 
1962
                igns = f.read().decode('utf-8')
 
1963
            finally:
 
1964
                f.close()
 
1965
        else:
 
1966
            igns = ''
 
1967
 
 
1968
        # TODO: If the file already uses crlf-style termination, maybe
 
1969
        # we should use that for the newly added lines?
 
1970
 
 
1971
        if igns and igns[-1] != '\n':
 
1972
            igns += '\n'
 
1973
        for name_pattern in name_pattern_list:
 
1974
            igns += name_pattern + '\n'
 
1975
 
 
1976
        f = AtomicFile(ifn, 'wb')
 
1977
        try:
 
1978
            f.write(igns.encode('utf-8'))
 
1979
            f.commit()
 
1980
        finally:
 
1981
            f.close()
 
1982
 
 
1983
        if not tree.path2id('.bzrignore'):
 
1984
            tree.add(['.bzrignore'])
 
1985
 
 
1986
        ignored = globbing.Globster(name_pattern_list)
 
1987
        matches = []
 
1988
        tree.lock_read()
 
1989
        for entry in tree.list_files():
 
1990
            id = entry[3]
 
1991
            if id is not None:
 
1992
                filename = entry[0]
 
1993
                if ignored.match(filename):
 
1994
                    matches.append(filename.encode('utf-8'))
 
1995
        tree.unlock()
 
1996
        if len(matches) > 0:
 
1997
            print "Warning: the following files are version controlled and" \
 
1998
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
1999
 
 
2000
class cmd_ignored(Command):
 
2001
    """List ignored files and the patterns that matched them.
 
2002
    """
 
2003
 
 
2004
    encoding_type = 'replace'
 
2005
    _see_also = ['ignore']
 
2006
 
 
2007
    @display_command
 
2008
    def run(self):
 
2009
        tree = WorkingTree.open_containing(u'.')[0]
 
2010
        tree.lock_read()
 
2011
        try:
 
2012
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2013
                if file_class != 'I':
 
2014
                    continue
 
2015
                ## XXX: Slightly inefficient since this was already calculated
 
2016
                pat = tree.is_ignored(path)
 
2017
                self.outf.write('%-50s %s\n' % (path, pat))
 
2018
        finally:
 
2019
            tree.unlock()
 
2020
 
 
2021
 
 
2022
class cmd_lookup_revision(Command):
 
2023
    """Lookup the revision-id from a revision-number
 
2024
 
 
2025
    :Examples:
 
2026
        bzr lookup-revision 33
 
2027
    """
 
2028
    hidden = True
 
2029
    takes_args = ['revno']
 
2030
    
 
2031
    @display_command
 
2032
    def run(self, revno):
 
2033
        try:
 
2034
            revno = int(revno)
 
2035
        except ValueError:
 
2036
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2037
 
 
2038
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2039
 
 
2040
 
 
2041
class cmd_export(Command):
 
2042
    """Export current or past revision to a destination directory or archive.
 
2043
 
 
2044
    If no revision is specified this exports the last committed revision.
 
2045
 
 
2046
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2047
    given, try to find the format with the extension. If no extension
 
2048
    is found exports to a directory (equivalent to --format=dir).
 
2049
 
 
2050
    If root is supplied, it will be used as the root directory inside
 
2051
    container formats (tar, zip, etc). If it is not supplied it will default
 
2052
    to the exported filename. The root option has no effect for 'dir' format.
 
2053
 
 
2054
    If branch is omitted then the branch containing the current working
 
2055
    directory will be used.
 
2056
 
 
2057
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2058
 
 
2059
      =================       =========================
 
2060
      Supported formats       Autodetected by extension
 
2061
      =================       =========================
 
2062
         dir                         (none)
 
2063
         tar                          .tar
 
2064
         tbz2                    .tar.bz2, .tbz2
 
2065
         tgz                      .tar.gz, .tgz
 
2066
         zip                          .zip
 
2067
      =================       =========================
 
2068
    """
 
2069
    takes_args = ['dest', 'branch?']
 
2070
    takes_options = [
 
2071
        Option('format',
 
2072
               help="Type of file to export to.",
 
2073
               type=unicode),
 
2074
        'revision',
 
2075
        Option('root',
 
2076
               type=str,
 
2077
               help="Name of the root directory inside the exported file."),
 
2078
        ]
 
2079
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
2080
        from bzrlib.export import export
 
2081
 
 
2082
        if branch is None:
 
2083
            tree = WorkingTree.open_containing(u'.')[0]
 
2084
            b = tree.branch
 
2085
        else:
 
2086
            b = Branch.open(branch)
 
2087
            
 
2088
        if revision is None:
 
2089
            # should be tree.last_revision  FIXME
 
2090
            rev_id = b.last_revision()
 
2091
        else:
 
2092
            if len(revision) != 1:
 
2093
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2094
            rev_id = revision[0].in_history(b).rev_id
 
2095
        t = b.repository.revision_tree(rev_id)
 
2096
        try:
 
2097
            export(t, dest, format, root)
 
2098
        except errors.NoSuchExportFormat, e:
 
2099
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2100
 
 
2101
 
 
2102
class cmd_cat(Command):
 
2103
    """Write the contents of a file as of a given revision to standard output.
 
2104
 
 
2105
    If no revision is nominated, the last revision is used.
 
2106
 
 
2107
    Note: Take care to redirect standard output when using this command on a
 
2108
    binary file. 
 
2109
    """
 
2110
 
 
2111
    _see_also = ['ls']
 
2112
    takes_options = [
 
2113
        Option('name-from-revision', help='The path name in the old tree.'),
 
2114
        'revision',
 
2115
        ]
 
2116
    takes_args = ['filename']
 
2117
    encoding_type = 'exact'
 
2118
 
 
2119
    @display_command
 
2120
    def run(self, filename, revision=None, name_from_revision=False):
 
2121
        if revision is not None and len(revision) != 1:
 
2122
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2123
                                         " one revision specifier")
 
2124
        tree, branch, relpath = \
 
2125
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2126
        branch.lock_read()
 
2127
        try:
 
2128
            return self._run(tree, branch, relpath, filename, revision,
 
2129
                             name_from_revision)
 
2130
        finally:
 
2131
            branch.unlock()
 
2132
 
 
2133
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2134
        if tree is None:
 
2135
            tree = b.basis_tree()
 
2136
        if revision is None:
 
2137
            revision_id = b.last_revision()
 
2138
        else:
 
2139
            revision_id = revision[0].in_history(b).rev_id
 
2140
 
 
2141
        cur_file_id = tree.path2id(relpath)
 
2142
        rev_tree = b.repository.revision_tree(revision_id)
 
2143
        old_file_id = rev_tree.path2id(relpath)
 
2144
        
 
2145
        if name_from_revision:
 
2146
            if old_file_id is None:
 
2147
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2148
                                                % (filename, revision_id))
 
2149
            else:
 
2150
                rev_tree.print_file(old_file_id)
 
2151
        elif cur_file_id is not None:
 
2152
            rev_tree.print_file(cur_file_id)
 
2153
        elif old_file_id is not None:
 
2154
            rev_tree.print_file(old_file_id)
 
2155
        else:
 
2156
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2157
                                         (filename, revision_id))
 
2158
 
 
2159
 
 
2160
class cmd_local_time_offset(Command):
 
2161
    """Show the offset in seconds from GMT to local time."""
 
2162
    hidden = True    
 
2163
    @display_command
 
2164
    def run(self):
 
2165
        print osutils.local_time_offset()
 
2166
 
 
2167
 
 
2168
 
 
2169
class cmd_commit(Command):
 
2170
    """Commit changes into a new revision.
 
2171
    
 
2172
    If no arguments are given, the entire tree is committed.
 
2173
 
 
2174
    If selected files are specified, only changes to those files are
 
2175
    committed.  If a directory is specified then the directory and everything 
 
2176
    within it is committed.
 
2177
 
 
2178
    If author of the change is not the same person as the committer, you can
 
2179
    specify the author's name using the --author option. The name should be
 
2180
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2181
 
 
2182
    A selected-file commit may fail in some cases where the committed
 
2183
    tree would be invalid. Consider::
 
2184
 
 
2185
      bzr init foo
 
2186
      mkdir foo/bar
 
2187
      bzr add foo/bar
 
2188
      bzr commit foo -m "committing foo"
 
2189
      bzr mv foo/bar foo/baz
 
2190
      mkdir foo/bar
 
2191
      bzr add foo/bar
 
2192
      bzr commit foo/bar -m "committing bar but not baz"
 
2193
 
 
2194
    In the example above, the last commit will fail by design. This gives
 
2195
    the user the opportunity to decide whether they want to commit the
 
2196
    rename at the same time, separately first, or not at all. (As a general
 
2197
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2198
 
 
2199
    Note: A selected-file commit after a merge is not yet supported.
 
2200
    """
 
2201
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2202
 
 
2203
    # TODO: Strict commit that fails if there are deleted files.
 
2204
    #       (what does "deleted files" mean ??)
 
2205
 
 
2206
    # TODO: Give better message for -s, --summary, used by tla people
 
2207
 
 
2208
    # XXX: verbose currently does nothing
 
2209
 
 
2210
    _see_also = ['bugs', 'uncommit']
 
2211
    takes_args = ['selected*']
 
2212
    takes_options = [
 
2213
            Option('message', type=unicode,
 
2214
                   short_name='m',
 
2215
                   help="Description of the new revision."),
 
2216
            'verbose',
 
2217
             Option('unchanged',
 
2218
                    help='Commit even if nothing has changed.'),
 
2219
             Option('file', type=str,
 
2220
                    short_name='F',
 
2221
                    argname='msgfile',
 
2222
                    help='Take commit message from this file.'),
 
2223
             Option('strict',
 
2224
                    help="Refuse to commit if there are unknown "
 
2225
                    "files in the working tree."),
 
2226
             ListOption('fixes', type=str,
 
2227
                    help="Mark a bug as being fixed by this revision."),
 
2228
             Option('author', type=unicode,
 
2229
                    help="Set the author's name, if it's different "
 
2230
                         "from the committer."),
 
2231
             Option('local',
 
2232
                    help="Perform a local commit in a bound "
 
2233
                         "branch.  Local commits are not pushed to "
 
2234
                         "the master branch until a normal commit "
 
2235
                         "is performed."
 
2236
                    ),
 
2237
              Option('show-diff',
 
2238
                     help='When no message is supplied, show the diff along'
 
2239
                     ' with the status summary in the message editor.'),
 
2240
             ]
 
2241
    aliases = ['ci', 'checkin']
 
2242
 
 
2243
    def _get_bug_fix_properties(self, fixes, branch):
 
2244
        properties = []
 
2245
        # Configure the properties for bug fixing attributes.
 
2246
        for fixed_bug in fixes:
 
2247
            tokens = fixed_bug.split(':')
 
2248
            if len(tokens) != 2:
 
2249
                raise errors.BzrCommandError(
 
2250
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2251
                    "Commit refused." % fixed_bug)
 
2252
            tag, bug_id = tokens
 
2253
            try:
 
2254
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2255
            except errors.UnknownBugTrackerAbbreviation:
 
2256
                raise errors.BzrCommandError(
 
2257
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2258
            except errors.MalformedBugIdentifier:
 
2259
                raise errors.BzrCommandError(
 
2260
                    "Invalid bug identifier for %s. Commit refused."
 
2261
                    % fixed_bug)
 
2262
            properties.append('%s fixed' % bug_url)
 
2263
        return '\n'.join(properties)
 
2264
 
 
2265
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2266
            unchanged=False, strict=False, local=False, fixes=None,
 
2267
            author=None, show_diff=False):
 
2268
        from bzrlib.errors import (
 
2269
            PointlessCommit,
 
2270
            ConflictsInTree,
 
2271
            StrictCommitFailed
 
2272
        )
 
2273
        from bzrlib.msgeditor import (
 
2274
            edit_commit_message_encoded,
 
2275
            make_commit_message_template_encoded
 
2276
        )
 
2277
 
 
2278
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2279
        # slightly problematic to run this cross-platform.
 
2280
 
 
2281
        # TODO: do more checks that the commit will succeed before 
 
2282
        # spending the user's valuable time typing a commit message.
 
2283
 
 
2284
        properties = {}
 
2285
 
 
2286
        tree, selected_list = tree_files(selected_list)
 
2287
        if selected_list == ['']:
 
2288
            # workaround - commit of root of tree should be exactly the same
 
2289
            # as just default commit in that tree, and succeed even though
 
2290
            # selected-file merge commit is not done yet
 
2291
            selected_list = []
 
2292
 
 
2293
        if fixes is None:
 
2294
            fixes = []
 
2295
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2296
        if bug_property:
 
2297
            properties['bugs'] = bug_property
 
2298
 
 
2299
        if local and not tree.branch.get_bound_location():
 
2300
            raise errors.LocalRequiresBoundBranch()
 
2301
 
 
2302
        def get_message(commit_obj):
 
2303
            """Callback to get commit message"""
 
2304
            my_message = message
 
2305
            if my_message is None and not file:
 
2306
                t = make_commit_message_template_encoded(tree,
 
2307
                        selected_list, diff=show_diff,
 
2308
                        output_encoding=bzrlib.user_encoding)
 
2309
                my_message = edit_commit_message_encoded(t)
 
2310
                if my_message is None:
 
2311
                    raise errors.BzrCommandError("please specify a commit"
 
2312
                        " message with either --message or --file")
 
2313
            elif my_message and file:
 
2314
                raise errors.BzrCommandError(
 
2315
                    "please specify either --message or --file")
 
2316
            if file:
 
2317
                my_message = codecs.open(file, 'rt', 
 
2318
                                         bzrlib.user_encoding).read()
 
2319
            if my_message == "":
 
2320
                raise errors.BzrCommandError("empty commit message specified")
 
2321
            return my_message
 
2322
 
 
2323
        try:
 
2324
            tree.commit(message_callback=get_message,
 
2325
                        specific_files=selected_list,
 
2326
                        allow_pointless=unchanged, strict=strict, local=local,
 
2327
                        reporter=None, verbose=verbose, revprops=properties,
 
2328
                        author=author)
 
2329
        except PointlessCommit:
 
2330
            # FIXME: This should really happen before the file is read in;
 
2331
            # perhaps prepare the commit; get the message; then actually commit
 
2332
            raise errors.BzrCommandError("no changes to commit."
 
2333
                              " use --unchanged to commit anyhow")
 
2334
        except ConflictsInTree:
 
2335
            raise errors.BzrCommandError('Conflicts detected in working '
 
2336
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2337
                ' resolve.')
 
2338
        except StrictCommitFailed:
 
2339
            raise errors.BzrCommandError("Commit refused because there are"
 
2340
                              " unknown files in the working tree.")
 
2341
        except errors.BoundBranchOutOfDate, e:
 
2342
            raise errors.BzrCommandError(str(e) + "\n"
 
2343
            'To commit to master branch, run update and then commit.\n'
 
2344
            'You can also pass --local to commit to continue working '
 
2345
            'disconnected.')
 
2346
 
 
2347
 
 
2348
class cmd_check(Command):
 
2349
    """Validate consistency of branch history.
 
2350
 
 
2351
    This command checks various invariants about the branch storage to
 
2352
    detect data corruption or bzr bugs.
 
2353
 
 
2354
    Output fields:
 
2355
 
 
2356
        revisions: This is just the number of revisions checked.  It doesn't
 
2357
            indicate a problem.
 
2358
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2359
            doesn't indicate a problem.
 
2360
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2361
            are not properly referenced by the revision ancestry.  This is a
 
2362
            subtle problem that Bazaar can work around.
 
2363
        unique file texts: This is the total number of unique file contents
 
2364
            seen in the checked revisions.  It does not indicate a problem.
 
2365
        repeated file texts: This is the total number of repeated texts seen
 
2366
            in the checked revisions.  Texts can be repeated when their file
 
2367
            entries are modified, but the file contents are not.  It does not
 
2368
            indicate a problem.
 
2369
    """
 
2370
 
 
2371
    _see_also = ['reconcile']
 
2372
    takes_args = ['branch?']
 
2373
    takes_options = ['verbose']
 
2374
 
 
2375
    def run(self, branch=None, verbose=False):
 
2376
        from bzrlib.check import check
 
2377
        if branch is None:
 
2378
            branch_obj = Branch.open_containing('.')[0]
 
2379
        else:
 
2380
            branch_obj = Branch.open(branch)
 
2381
        check(branch_obj, verbose)
 
2382
        # bit hacky, check the tree parent is accurate
 
2383
        try:
 
2384
            if branch is None:
 
2385
                tree = WorkingTree.open_containing('.')[0]
 
2386
            else:
 
2387
                tree = WorkingTree.open(branch)
 
2388
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2389
            pass
 
2390
        else:
 
2391
            # This is a primitive 'check' for tree state. Currently this is not
 
2392
            # integrated into the main check logic as yet.
 
2393
            tree.lock_read()
 
2394
            try:
 
2395
                tree_basis = tree.basis_tree()
 
2396
                tree_basis.lock_read()
 
2397
                try:
 
2398
                    repo_basis = tree.branch.repository.revision_tree(
 
2399
                        tree.last_revision())
 
2400
                    if len(list(repo_basis._iter_changes(tree_basis))):
 
2401
                        raise errors.BzrCheckError(
 
2402
                            "Mismatched basis inventory content.")
 
2403
                    tree._validate()
 
2404
                finally:
 
2405
                    tree_basis.unlock()
 
2406
            finally:
 
2407
                tree.unlock()
 
2408
 
 
2409
 
 
2410
class cmd_upgrade(Command):
 
2411
    """Upgrade branch storage to current format.
 
2412
 
 
2413
    The check command or bzr developers may sometimes advise you to run
 
2414
    this command. When the default format has changed you may also be warned
 
2415
    during other operations to upgrade.
 
2416
    """
 
2417
 
 
2418
    _see_also = ['check']
 
2419
    takes_args = ['url?']
 
2420
    takes_options = [
 
2421
                    RegistryOption('format',
 
2422
                        help='Upgrade to a specific format.  See "bzr help'
 
2423
                             ' formats" for details.',
 
2424
                        registry=bzrdir.format_registry,
 
2425
                        converter=bzrdir.format_registry.make_bzrdir,
 
2426
                        value_switches=True, title='Branch format'),
 
2427
                    ]
 
2428
 
 
2429
    def run(self, url='.', format=None):
 
2430
        from bzrlib.upgrade import upgrade
 
2431
        if format is None:
 
2432
            format = bzrdir.format_registry.make_bzrdir('default')
 
2433
        upgrade(url, format)
 
2434
 
 
2435
 
 
2436
class cmd_whoami(Command):
 
2437
    """Show or set bzr user id.
 
2438
    
 
2439
    :Examples:
 
2440
        Show the email of the current user::
 
2441
 
 
2442
            bzr whoami --email
 
2443
 
 
2444
        Set the current user::
 
2445
 
 
2446
            bzr whoami "Frank Chu <fchu@example.com>"
 
2447
    """
 
2448
    takes_options = [ Option('email',
 
2449
                             help='Display email address only.'),
 
2450
                      Option('branch',
 
2451
                             help='Set identity for the current branch instead of '
 
2452
                                  'globally.'),
 
2453
                    ]
 
2454
    takes_args = ['name?']
 
2455
    encoding_type = 'replace'
 
2456
    
 
2457
    @display_command
 
2458
    def run(self, email=False, branch=False, name=None):
 
2459
        if name is None:
 
2460
            # use branch if we're inside one; otherwise global config
 
2461
            try:
 
2462
                c = Branch.open_containing('.')[0].get_config()
 
2463
            except errors.NotBranchError:
 
2464
                c = config.GlobalConfig()
 
2465
            if email:
 
2466
                self.outf.write(c.user_email() + '\n')
 
2467
            else:
 
2468
                self.outf.write(c.username() + '\n')
 
2469
            return
 
2470
 
 
2471
        # display a warning if an email address isn't included in the given name.
 
2472
        try:
 
2473
            config.extract_email_address(name)
 
2474
        except errors.NoEmailInUsername, e:
 
2475
            warning('"%s" does not seem to contain an email address.  '
 
2476
                    'This is allowed, but not recommended.', name)
 
2477
        
 
2478
        # use global config unless --branch given
 
2479
        if branch:
 
2480
            c = Branch.open_containing('.')[0].get_config()
 
2481
        else:
 
2482
            c = config.GlobalConfig()
 
2483
        c.set_user_option('email', name)
 
2484
 
 
2485
 
 
2486
class cmd_nick(Command):
 
2487
    """Print or set the branch nickname.  
 
2488
 
 
2489
    If unset, the tree root directory name is used as the nickname
 
2490
    To print the current nickname, execute with no argument.  
 
2491
    """
 
2492
 
 
2493
    _see_also = ['info']
 
2494
    takes_args = ['nickname?']
 
2495
    def run(self, nickname=None):
 
2496
        branch = Branch.open_containing(u'.')[0]
 
2497
        if nickname is None:
 
2498
            self.printme(branch)
 
2499
        else:
 
2500
            branch.nick = nickname
 
2501
 
 
2502
    @display_command
 
2503
    def printme(self, branch):
 
2504
        print branch.nick
 
2505
 
 
2506
 
 
2507
class cmd_selftest(Command):
 
2508
    """Run internal test suite.
 
2509
    
 
2510
    If arguments are given, they are regular expressions that say which tests
 
2511
    should run.  Tests matching any expression are run, and other tests are
 
2512
    not run.
 
2513
 
 
2514
    Alternatively if --first is given, matching tests are run first and then
 
2515
    all other tests are run.  This is useful if you have been working in a
 
2516
    particular area, but want to make sure nothing else was broken.
 
2517
 
 
2518
    If --exclude is given, tests that match that regular expression are
 
2519
    excluded, regardless of whether they match --first or not.
 
2520
 
 
2521
    To help catch accidential dependencies between tests, the --randomize
 
2522
    option is useful. In most cases, the argument used is the word 'now'.
 
2523
    Note that the seed used for the random number generator is displayed
 
2524
    when this option is used. The seed can be explicitly passed as the
 
2525
    argument to this option if required. This enables reproduction of the
 
2526
    actual ordering used if and when an order sensitive problem is encountered.
 
2527
 
 
2528
    If --list-only is given, the tests that would be run are listed. This is
 
2529
    useful when combined with --first, --exclude and/or --randomize to
 
2530
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2531
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2532
 
 
2533
    If the global option '--no-plugins' is given, plugins are not loaded
 
2534
    before running the selftests.  This has two effects: features provided or
 
2535
    modified by plugins will not be tested, and tests provided by plugins will
 
2536
    not be run.
 
2537
 
 
2538
    Tests that need working space on disk use a common temporary directory, 
 
2539
    typically inside $TMPDIR or /tmp.
 
2540
 
 
2541
    :Examples:
 
2542
        Run only tests relating to 'ignore'::
 
2543
 
 
2544
            bzr selftest ignore
 
2545
 
 
2546
        Disable plugins and list tests as they're run::
 
2547
 
 
2548
            bzr --no-plugins selftest -v
 
2549
    """
 
2550
    # NB: this is used from the class without creating an instance, which is
 
2551
    # why it does not have a self parameter.
 
2552
    def get_transport_type(typestring):
 
2553
        """Parse and return a transport specifier."""
 
2554
        if typestring == "sftp":
 
2555
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2556
            return SFTPAbsoluteServer
 
2557
        if typestring == "memory":
 
2558
            from bzrlib.transport.memory import MemoryServer
 
2559
            return MemoryServer
 
2560
        if typestring == "fakenfs":
 
2561
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2562
            return FakeNFSServer
 
2563
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2564
            (typestring)
 
2565
        raise errors.BzrCommandError(msg)
 
2566
 
 
2567
    hidden = True
 
2568
    takes_args = ['testspecs*']
 
2569
    takes_options = ['verbose',
 
2570
                     Option('one',
 
2571
                             help='Stop when one test fails.',
 
2572
                             short_name='1',
 
2573
                             ),
 
2574
                     Option('transport',
 
2575
                            help='Use a different transport by default '
 
2576
                                 'throughout the test suite.',
 
2577
                            type=get_transport_type),
 
2578
                     Option('benchmark',
 
2579
                            help='Run the benchmarks rather than selftests.'),
 
2580
                     Option('lsprof-timed',
 
2581
                            help='Generate lsprof output for benchmarked'
 
2582
                                 ' sections of code.'),
 
2583
                     Option('cache-dir', type=str,
 
2584
                            help='Cache intermediate benchmark output in this '
 
2585
                                 'directory.'),
 
2586
                     Option('first',
 
2587
                            help='Run all tests, but run specified tests first.',
 
2588
                            short_name='f',
 
2589
                            ),
 
2590
                     Option('list-only',
 
2591
                            help='List the tests instead of running them.'),
 
2592
                     Option('randomize', type=str, argname="SEED",
 
2593
                            help='Randomize the order of tests using the given'
 
2594
                                 ' seed or "now" for the current time.'),
 
2595
                     Option('exclude', type=str, argname="PATTERN",
 
2596
                            short_name='x',
 
2597
                            help='Exclude tests that match this regular'
 
2598
                                 ' expression.'),
 
2599
                     Option('strict', help='Fail on missing dependencies or '
 
2600
                            'known failures.'),
 
2601
                     ]
 
2602
    encoding_type = 'replace'
 
2603
 
 
2604
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2605
            transport=None, benchmark=None,
 
2606
            lsprof_timed=None, cache_dir=None,
 
2607
            first=False, list_only=False,
 
2608
            randomize=None, exclude=None, strict=False):
 
2609
        import bzrlib.ui
 
2610
        from bzrlib.tests import selftest
 
2611
        import bzrlib.benchmarks as benchmarks
 
2612
        from bzrlib.benchmarks import tree_creator
 
2613
 
 
2614
        if cache_dir is not None:
 
2615
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2616
        if not list_only:
 
2617
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2618
            print '   %s (%s python%s)' % (
 
2619
                    bzrlib.__path__[0],
 
2620
                    bzrlib.version_string,
 
2621
                    '.'.join(map(str, sys.version_info)),
 
2622
                    )
 
2623
        print
 
2624
        if testspecs_list is not None:
 
2625
            pattern = '|'.join(testspecs_list)
 
2626
        else:
 
2627
            pattern = ".*"
 
2628
        if benchmark:
 
2629
            test_suite_factory = benchmarks.test_suite
 
2630
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2631
            verbose = not is_quiet()
 
2632
            # TODO: should possibly lock the history file...
 
2633
            benchfile = open(".perf_history", "at", buffering=1)
 
2634
        else:
 
2635
            test_suite_factory = None
 
2636
            benchfile = None
 
2637
        try:
 
2638
            result = selftest(verbose=verbose,
 
2639
                              pattern=pattern,
 
2640
                              stop_on_failure=one,
 
2641
                              transport=transport,
 
2642
                              test_suite_factory=test_suite_factory,
 
2643
                              lsprof_timed=lsprof_timed,
 
2644
                              bench_history=benchfile,
 
2645
                              matching_tests_first=first,
 
2646
                              list_only=list_only,
 
2647
                              random_seed=randomize,
 
2648
                              exclude_pattern=exclude,
 
2649
                              strict=strict,
 
2650
                              )
 
2651
        finally:
 
2652
            if benchfile is not None:
 
2653
                benchfile.close()
 
2654
        if result:
 
2655
            info('tests passed')
 
2656
        else:
 
2657
            info('tests failed')
 
2658
        return int(not result)
 
2659
 
 
2660
 
 
2661
class cmd_version(Command):
 
2662
    """Show version of bzr."""
 
2663
 
 
2664
    encoding_type = 'replace'
 
2665
 
 
2666
    @display_command
 
2667
    def run(self):
 
2668
        from bzrlib.version import show_version
 
2669
        show_version(to_file=self.outf)
 
2670
 
 
2671
 
 
2672
class cmd_rocks(Command):
 
2673
    """Statement of optimism."""
 
2674
 
 
2675
    hidden = True
 
2676
 
 
2677
    @display_command
 
2678
    def run(self):
 
2679
        print "It sure does!"
 
2680
 
 
2681
 
 
2682
class cmd_find_merge_base(Command):
 
2683
    """Find and print a base revision for merging two branches."""
 
2684
    # TODO: Options to specify revisions on either side, as if
 
2685
    #       merging only part of the history.
 
2686
    takes_args = ['branch', 'other']
 
2687
    hidden = True
 
2688
    
 
2689
    @display_command
 
2690
    def run(self, branch, other):
 
2691
        from bzrlib.revision import ensure_null
 
2692
        
 
2693
        branch1 = Branch.open_containing(branch)[0]
 
2694
        branch2 = Branch.open_containing(other)[0]
 
2695
        branch1.lock_read()
 
2696
        try:
 
2697
            branch2.lock_read()
 
2698
            try:
 
2699
                last1 = ensure_null(branch1.last_revision())
 
2700
                last2 = ensure_null(branch2.last_revision())
 
2701
 
 
2702
                graph = branch1.repository.get_graph(branch2.repository)
 
2703
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2704
 
 
2705
                print 'merge base is revision %s' % base_rev_id
 
2706
            finally:
 
2707
                branch2.unlock()
 
2708
        finally:
 
2709
            branch1.unlock()
 
2710
 
 
2711
 
 
2712
class cmd_merge(Command):
 
2713
    """Perform a three-way merge.
 
2714
    
 
2715
    The branch is the branch you will merge from.  By default, it will merge
 
2716
    the latest revision.  If you specify a revision, that revision will be
 
2717
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2718
    and the second one as OTHER.  Revision numbers are always relative to the
 
2719
    specified branch.
 
2720
 
 
2721
    By default, bzr will try to merge in all new work from the other
 
2722
    branch, automatically determining an appropriate base.  If this
 
2723
    fails, you may need to give an explicit base.
 
2724
    
 
2725
    Merge will do its best to combine the changes in two branches, but there
 
2726
    are some kinds of problems only a human can fix.  When it encounters those,
 
2727
    it will mark a conflict.  A conflict means that you need to fix something,
 
2728
    before you should commit.
 
2729
 
 
2730
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2731
 
 
2732
    If there is no default branch set, the first merge will set it. After
 
2733
    that, you can omit the branch to use the default.  To change the
 
2734
    default, use --remember. The value will only be saved if the remote
 
2735
    location can be accessed.
 
2736
 
 
2737
    The results of the merge are placed into the destination working
 
2738
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2739
    committed to record the result of the merge.
 
2740
    
 
2741
    merge refuses to run if there are any uncommitted changes, unless
 
2742
    --force is given.
 
2743
 
 
2744
    :Examples:
 
2745
        To merge the latest revision from bzr.dev::
 
2746
 
 
2747
            bzr merge ../bzr.dev
 
2748
 
 
2749
        To merge changes up to and including revision 82 from bzr.dev::
 
2750
 
 
2751
            bzr merge -r 82 ../bzr.dev
 
2752
 
 
2753
        To merge the changes introduced by 82, without previous changes::
 
2754
 
 
2755
            bzr merge -r 81..82 ../bzr.dev
 
2756
    """
 
2757
 
 
2758
    encoding_type = 'exact'
 
2759
    _see_also = ['update', 'remerge', 'status-flags']
 
2760
    takes_args = ['branch?']
 
2761
    takes_options = [
 
2762
        'change',
 
2763
        'revision',
 
2764
        Option('force',
 
2765
               help='Merge even if the destination tree has uncommitted changes.'),
 
2766
        'merge-type',
 
2767
        'reprocess',
 
2768
        'remember',
 
2769
        Option('show-base', help="Show base revision text in "
 
2770
               "conflicts."),
 
2771
        Option('uncommitted', help='Apply uncommitted changes'
 
2772
               ' from a working copy, instead of branch changes.'),
 
2773
        Option('pull', help='If the destination is already'
 
2774
                ' completely merged into the source, pull from the'
 
2775
                ' source rather than merging.  When this happens,'
 
2776
                ' you do not need to commit the result.'),
 
2777
        Option('directory',
 
2778
               help='Branch to merge into, '
 
2779
                    'rather than the one containing the working directory.',
 
2780
               short_name='d',
 
2781
               type=unicode,
 
2782
               ),
 
2783
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
2784
    ]
 
2785
 
 
2786
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2787
            show_base=False, reprocess=False, remember=False,
 
2788
            uncommitted=False, pull=False,
 
2789
            directory=None,
 
2790
            preview=False,
 
2791
            ):
 
2792
        # This is actually a branch (or merge-directive) *location*.
 
2793
        location = branch
 
2794
        del branch
 
2795
 
 
2796
        if merge_type is None:
 
2797
            merge_type = _mod_merge.Merge3Merger
 
2798
 
 
2799
        if directory is None: directory = u'.'
 
2800
        possible_transports = []
 
2801
        merger = None
 
2802
        allow_pending = True
 
2803
        verified = 'inapplicable'
 
2804
        tree = WorkingTree.open_containing(directory)[0]
 
2805
        change_reporter = delta._ChangeReporter(
 
2806
            unversioned_filter=tree.is_ignored)
 
2807
        cleanups = []
 
2808
        try:
 
2809
            pb = ui.ui_factory.nested_progress_bar()
 
2810
            cleanups.append(pb.finished)
 
2811
            tree.lock_write()
 
2812
            cleanups.append(tree.unlock)
 
2813
            if location is not None:
 
2814
                mergeable, other_transport = _get_mergeable_helper(location)
 
2815
                if mergeable:
 
2816
                    if uncommitted:
 
2817
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2818
                            ' with bundles or merge directives.')
 
2819
 
 
2820
                    if revision is not None:
 
2821
                        raise errors.BzrCommandError(
 
2822
                            'Cannot use -r with merge directives or bundles')
 
2823
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2824
                       mergeable, pb)
 
2825
                possible_transports.append(other_transport)
 
2826
 
 
2827
            if merger is None and uncommitted:
 
2828
                if revision is not None and len(revision) > 0:
 
2829
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2830
                        ' --revision at the same time.')
 
2831
                location = self._select_branch_location(tree, location)[0]
 
2832
                other_tree, other_path = WorkingTree.open_containing(location)
 
2833
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2834
                    pb)
 
2835
                allow_pending = False
 
2836
                if other_path != '':
 
2837
                    merger.interesting_files = [other_path]
 
2838
 
 
2839
            if merger is None:
 
2840
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2841
                    location, revision, remember, possible_transports, pb)
 
2842
 
 
2843
            merger.merge_type = merge_type
 
2844
            merger.reprocess = reprocess
 
2845
            merger.show_base = show_base
 
2846
            self.sanity_check_merger(merger)
 
2847
            if (merger.base_rev_id == merger.other_rev_id and
 
2848
                merger.other_rev_id != None):
 
2849
                note('Nothing to do.')
 
2850
                return 0
 
2851
            if pull:
 
2852
                if merger.interesting_files is not None:
 
2853
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2854
                if (merger.base_rev_id == tree.last_revision()):
 
2855
                    result = tree.pull(merger.other_branch, False,
 
2856
                                       merger.other_rev_id)
 
2857
                    result.report(self.outf)
 
2858
                    return 0
 
2859
            merger.check_basis(not force)
 
2860
            if preview:
 
2861
                return self._do_preview(merger)
 
2862
            else:
 
2863
                return self._do_merge(merger, change_reporter, allow_pending,
 
2864
                                      verified)
 
2865
        finally:
 
2866
            for cleanup in reversed(cleanups):
 
2867
                cleanup()
 
2868
 
 
2869
    def _do_preview(self, merger):
 
2870
        from bzrlib.diff import show_diff_trees
 
2871
        tree_merger = merger.make_merger()
 
2872
        tt = tree_merger.make_preview_transform()
 
2873
        result_tree = tt.get_preview_tree()
 
2874
        show_diff_trees(merger.this_tree, result_tree, self.outf, old_label='',
 
2875
                        new_label='')
 
2876
 
 
2877
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
2878
        merger.change_reporter = change_reporter
 
2879
        conflict_count = merger.do_merge()
 
2880
        if allow_pending:
 
2881
            merger.set_pending()
 
2882
        if verified == 'failed':
 
2883
            warning('Preview patch does not match changes')
 
2884
        if conflict_count != 0:
 
2885
            return 1
 
2886
        else:
 
2887
            return 0
 
2888
 
 
2889
    def sanity_check_merger(self, merger):
 
2890
        if (merger.show_base and
 
2891
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2892
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2893
                                         " merge type. %s" % merger.merge_type)
 
2894
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2895
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2896
                                         " for merge type %s." %
 
2897
                                         merger.merge_type)
 
2898
        if merger.reprocess and merger.show_base:
 
2899
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2900
                                         " show base.")
 
2901
 
 
2902
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2903
                                possible_transports, pb):
 
2904
        """Produce a merger from a location, assuming it refers to a branch."""
 
2905
        from bzrlib.tag import _merge_tags_if_possible
 
2906
        assert revision is None or len(revision) < 3
 
2907
        # find the branch locations
 
2908
        other_loc, user_location = self._select_branch_location(tree, location,
 
2909
            revision, -1)
 
2910
        if revision is not None and len(revision) == 2:
 
2911
            base_loc, _unused = self._select_branch_location(tree,
 
2912
                location, revision, 0)
 
2913
        else:
 
2914
            base_loc = other_loc
 
2915
        # Open the branches
 
2916
        other_branch, other_path = Branch.open_containing(other_loc,
 
2917
            possible_transports)
 
2918
        if base_loc == other_loc:
 
2919
            base_branch = other_branch
 
2920
        else:
 
2921
            base_branch, base_path = Branch.open_containing(base_loc,
 
2922
                possible_transports)
 
2923
        # Find the revision ids
 
2924
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2925
            other_revision_id = _mod_revision.ensure_null(
 
2926
                other_branch.last_revision())
 
2927
        else:
 
2928
            other_revision_id = \
 
2929
                _mod_revision.ensure_null(
 
2930
                    revision[-1].in_history(other_branch).rev_id)
 
2931
        if (revision is not None and len(revision) == 2
 
2932
            and revision[0] is not None):
 
2933
            base_revision_id = \
 
2934
                _mod_revision.ensure_null(
 
2935
                    revision[0].in_history(base_branch).rev_id)
 
2936
        else:
 
2937
            base_revision_id = None
 
2938
        # Remember where we merge from
 
2939
        if ((remember or tree.branch.get_submit_branch() is None) and
 
2940
             user_location is not None):
 
2941
            tree.branch.set_submit_branch(other_branch.base)
 
2942
        _merge_tags_if_possible(other_branch, tree.branch)
 
2943
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
2944
            other_revision_id, base_revision_id, other_branch, base_branch)
 
2945
        if other_path != '':
 
2946
            allow_pending = False
 
2947
            merger.interesting_files = [other_path]
 
2948
        else:
 
2949
            allow_pending = True
 
2950
        return merger, allow_pending
 
2951
 
 
2952
    def _select_branch_location(self, tree, user_location, revision=None,
 
2953
                                index=None):
 
2954
        """Select a branch location, according to possible inputs.
 
2955
 
 
2956
        If provided, branches from ``revision`` are preferred.  (Both
 
2957
        ``revision`` and ``index`` must be supplied.)
 
2958
 
 
2959
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
2960
        ``submit`` or ``parent`` location is used, and a note is printed.
 
2961
 
 
2962
        :param tree: The working tree to select a branch for merging into
 
2963
        :param location: The location entered by the user
 
2964
        :param revision: The revision parameter to the command
 
2965
        :param index: The index to use for the revision parameter.  Negative
 
2966
            indices are permitted.
 
2967
        :return: (selected_location, user_location).  The default location
 
2968
            will be the user-entered location.
 
2969
        """
 
2970
        if (revision is not None and index is not None
 
2971
            and revision[index] is not None):
 
2972
            branch = revision[index].get_branch()
 
2973
            if branch is not None:
 
2974
                return branch, branch
 
2975
        if user_location is None:
 
2976
            location = self._get_remembered(tree, 'Merging from')
 
2977
        else:
 
2978
            location = user_location
 
2979
        return location, user_location
 
2980
 
 
2981
    def _get_remembered(self, tree, verb_string):
 
2982
        """Use tree.branch's parent if none was supplied.
 
2983
 
 
2984
        Report if the remembered location was used.
 
2985
        """
 
2986
        stored_location = tree.branch.get_submit_branch()
 
2987
        if stored_location is None:
 
2988
            stored_location = tree.branch.get_parent()
 
2989
        mutter("%s", stored_location)
 
2990
        if stored_location is None:
 
2991
            raise errors.BzrCommandError("No location specified or remembered")
 
2992
        display_url = urlutils.unescape_for_display(stored_location,
 
2993
            self.outf.encoding)
 
2994
        self.outf.write("%s remembered location %s\n" % (verb_string,
 
2995
            display_url))
 
2996
        return stored_location
 
2997
 
 
2998
 
 
2999
class cmd_remerge(Command):
 
3000
    """Redo a merge.
 
3001
 
 
3002
    Use this if you want to try a different merge technique while resolving
 
3003
    conflicts.  Some merge techniques are better than others, and remerge 
 
3004
    lets you try different ones on different files.
 
3005
 
 
3006
    The options for remerge have the same meaning and defaults as the ones for
 
3007
    merge.  The difference is that remerge can (only) be run when there is a
 
3008
    pending merge, and it lets you specify particular files.
 
3009
 
 
3010
    :Examples:
 
3011
        Re-do the merge of all conflicted files, and show the base text in
 
3012
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3013
      
 
3014
            bzr remerge --show-base
 
3015
 
 
3016
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3017
        additional processing to reduce the size of conflict regions::
 
3018
      
 
3019
            bzr remerge --merge-type weave --reprocess foobar
 
3020
    """
 
3021
    takes_args = ['file*']
 
3022
    takes_options = [
 
3023
            'merge-type',
 
3024
            'reprocess',
 
3025
            Option('show-base',
 
3026
                   help="Show base revision text in conflicts."),
 
3027
            ]
 
3028
 
 
3029
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3030
            reprocess=False):
 
3031
        if merge_type is None:
 
3032
            merge_type = _mod_merge.Merge3Merger
 
3033
        tree, file_list = tree_files(file_list)
 
3034
        tree.lock_write()
 
3035
        try:
 
3036
            parents = tree.get_parent_ids()
 
3037
            if len(parents) != 2:
 
3038
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3039
                                             " merges.  Not cherrypicking or"
 
3040
                                             " multi-merges.")
 
3041
            repository = tree.branch.repository
 
3042
            interesting_ids = None
 
3043
            new_conflicts = []
 
3044
            conflicts = tree.conflicts()
 
3045
            if file_list is not None:
 
3046
                interesting_ids = set()
 
3047
                for filename in file_list:
 
3048
                    file_id = tree.path2id(filename)
 
3049
                    if file_id is None:
 
3050
                        raise errors.NotVersionedError(filename)
 
3051
                    interesting_ids.add(file_id)
 
3052
                    if tree.kind(file_id) != "directory":
 
3053
                        continue
 
3054
                    
 
3055
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3056
                        interesting_ids.add(ie.file_id)
 
3057
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3058
            else:
 
3059
                # Remerge only supports resolving contents conflicts
 
3060
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3061
                restore_files = [c.path for c in conflicts
 
3062
                                 if c.typestring in allowed_conflicts]
 
3063
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3064
            tree.set_conflicts(ConflictList(new_conflicts))
 
3065
            if file_list is not None:
 
3066
                restore_files = file_list
 
3067
            for filename in restore_files:
 
3068
                try:
 
3069
                    restore(tree.abspath(filename))
 
3070
                except errors.NotConflicted:
 
3071
                    pass
 
3072
            # Disable pending merges, because the file texts we are remerging
 
3073
            # have not had those merges performed.  If we use the wrong parents
 
3074
            # list, we imply that the working tree text has seen and rejected
 
3075
            # all the changes from the other tree, when in fact those changes
 
3076
            # have not yet been seen.
 
3077
            pb = ui.ui_factory.nested_progress_bar()
 
3078
            tree.set_parent_ids(parents[:1])
 
3079
            try:
 
3080
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3081
                                                             tree, parents[1])
 
3082
                merger.interesting_ids = interesting_ids
 
3083
                merger.merge_type = merge_type
 
3084
                merger.show_base = show_base
 
3085
                merger.reprocess = reprocess
 
3086
                conflicts = merger.do_merge()
 
3087
            finally:
 
3088
                tree.set_parent_ids(parents)
 
3089
                pb.finished()
 
3090
        finally:
 
3091
            tree.unlock()
 
3092
        if conflicts > 0:
 
3093
            return 1
 
3094
        else:
 
3095
            return 0
 
3096
 
 
3097
 
 
3098
class cmd_revert(Command):
 
3099
    """Revert files to a previous revision.
 
3100
 
 
3101
    Giving a list of files will revert only those files.  Otherwise, all files
 
3102
    will be reverted.  If the revision is not specified with '--revision', the
 
3103
    last committed revision is used.
 
3104
 
 
3105
    To remove only some changes, without reverting to a prior version, use
 
3106
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3107
    changes introduced by -2, without affecting the changes introduced by -1.
 
3108
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3109
    
 
3110
    By default, any files that have been manually changed will be backed up
 
3111
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3112
    '.~#~' appended to their name, where # is a number.
 
3113
 
 
3114
    When you provide files, you can use their current pathname or the pathname
 
3115
    from the target revision.  So you can use revert to "undelete" a file by
 
3116
    name.  If you name a directory, all the contents of that directory will be
 
3117
    reverted.
 
3118
 
 
3119
    Any files that have been newly added since that revision will be deleted,
 
3120
    with a backup kept if appropriate.  Directories containing unknown files
 
3121
    will not be deleted.
 
3122
 
 
3123
    The working tree contains a list of pending merged revisions, which will
 
3124
    be included as parents in the next commit.  Normally, revert clears that
 
3125
    list as well as reverting the files.  If any files are specified, revert
 
3126
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3127
    revert ." in the tree root to revert all files but keep the merge record,
 
3128
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3129
    reverting any files.
 
3130
    """
 
3131
 
 
3132
    _see_also = ['cat', 'export']
 
3133
    takes_options = [
 
3134
        'revision',
 
3135
        Option('no-backup', "Do not save backups of reverted files."),
 
3136
        Option('forget-merges',
 
3137
               'Remove pending merge marker, without changing any files.'),
 
3138
        ]
 
3139
    takes_args = ['file*']
 
3140
 
 
3141
    def run(self, revision=None, no_backup=False, file_list=None,
 
3142
            forget_merges=None):
 
3143
        tree, file_list = tree_files(file_list)
 
3144
        if forget_merges:
 
3145
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3146
        else:
 
3147
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3148
 
 
3149
    @staticmethod
 
3150
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3151
        if revision is None:
 
3152
            rev_id = tree.last_revision()
 
3153
        elif len(revision) != 1:
 
3154
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3155
        else:
 
3156
            rev_id = revision[0].in_history(tree.branch).rev_id
 
3157
        pb = ui.ui_factory.nested_progress_bar()
 
3158
        try:
 
3159
            tree.revert(file_list,
 
3160
                        tree.branch.repository.revision_tree(rev_id),
 
3161
                        not no_backup, pb, report_changes=True)
 
3162
        finally:
 
3163
            pb.finished()
 
3164
 
 
3165
 
 
3166
class cmd_assert_fail(Command):
 
3167
    """Test reporting of assertion failures"""
 
3168
    # intended just for use in testing
 
3169
 
 
3170
    hidden = True
 
3171
 
 
3172
    def run(self):
 
3173
        raise AssertionError("always fails")
 
3174
 
 
3175
 
 
3176
class cmd_help(Command):
 
3177
    """Show help on a command or other topic.
 
3178
    """
 
3179
 
 
3180
    _see_also = ['topics']
 
3181
    takes_options = [
 
3182
            Option('long', 'Show help on all commands.'),
 
3183
            ]
 
3184
    takes_args = ['topic?']
 
3185
    aliases = ['?', '--help', '-?', '-h']
 
3186
    
 
3187
    @display_command
 
3188
    def run(self, topic=None, long=False):
 
3189
        import bzrlib.help
 
3190
        if topic is None and long:
 
3191
            topic = "commands"
 
3192
        bzrlib.help.help(topic)
 
3193
 
 
3194
 
 
3195
class cmd_shell_complete(Command):
 
3196
    """Show appropriate completions for context.
 
3197
 
 
3198
    For a list of all available commands, say 'bzr shell-complete'.
 
3199
    """
 
3200
    takes_args = ['context?']
 
3201
    aliases = ['s-c']
 
3202
    hidden = True
 
3203
    
 
3204
    @display_command
 
3205
    def run(self, context=None):
 
3206
        import shellcomplete
 
3207
        shellcomplete.shellcomplete(context)
 
3208
 
 
3209
 
 
3210
class cmd_fetch(Command):
 
3211
    """Copy in history from another branch but don't merge it.
 
3212
 
 
3213
    This is an internal method used for pull and merge.
 
3214
    """
 
3215
    hidden = True
 
3216
    takes_args = ['from_branch', 'to_branch']
 
3217
    def run(self, from_branch, to_branch):
 
3218
        from bzrlib.fetch import Fetcher
 
3219
        from_b = Branch.open(from_branch)
 
3220
        to_b = Branch.open(to_branch)
 
3221
        Fetcher(to_b, from_b)
 
3222
 
 
3223
 
 
3224
class cmd_missing(Command):
 
3225
    """Show unmerged/unpulled revisions between two branches.
 
3226
    
 
3227
    OTHER_BRANCH may be local or remote.
 
3228
    """
 
3229
 
 
3230
    _see_also = ['merge', 'pull']
 
3231
    takes_args = ['other_branch?']
 
3232
    takes_options = [
 
3233
            Option('reverse', 'Reverse the order of revisions.'),
 
3234
            Option('mine-only',
 
3235
                   'Display changes in the local branch only.'),
 
3236
            Option('this' , 'Same as --mine-only.'),
 
3237
            Option('theirs-only',
 
3238
                   'Display changes in the remote branch only.'),
 
3239
            Option('other', 'Same as --theirs-only.'),
 
3240
            'log-format',
 
3241
            'show-ids',
 
3242
            'verbose'
 
3243
            ]
 
3244
    encoding_type = 'replace'
 
3245
 
 
3246
    @display_command
 
3247
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3248
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3249
            show_ids=False, verbose=False, this=False, other=False):
 
3250
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3251
 
 
3252
        if this:
 
3253
          mine_only = this
 
3254
        if other:
 
3255
          theirs_only = other
 
3256
 
 
3257
        local_branch = Branch.open_containing(u".")[0]
 
3258
        parent = local_branch.get_parent()
 
3259
        if other_branch is None:
 
3260
            other_branch = parent
 
3261
            if other_branch is None:
 
3262
                raise errors.BzrCommandError("No peer location known"
 
3263
                                             " or specified.")
 
3264
            display_url = urlutils.unescape_for_display(parent,
 
3265
                                                        self.outf.encoding)
 
3266
            self.outf.write("Using last location: " + display_url + "\n")
 
3267
 
 
3268
        remote_branch = Branch.open(other_branch)
 
3269
        if remote_branch.base == local_branch.base:
 
3270
            remote_branch = local_branch
 
3271
        local_branch.lock_read()
 
3272
        try:
 
3273
            remote_branch.lock_read()
 
3274
            try:
 
3275
                local_extra, remote_extra = find_unmerged(local_branch,
 
3276
                                                          remote_branch)
 
3277
                if log_format is None:
 
3278
                    registry = log.log_formatter_registry
 
3279
                    log_format = registry.get_default(local_branch)
 
3280
                lf = log_format(to_file=self.outf,
 
3281
                                show_ids=show_ids,
 
3282
                                show_timezone='original')
 
3283
                if reverse is False:
 
3284
                    local_extra.reverse()
 
3285
                    remote_extra.reverse()
 
3286
                if local_extra and not theirs_only:
 
3287
                    self.outf.write("You have %d extra revision(s):\n" %
 
3288
                                    len(local_extra))
 
3289
                    for revision in iter_log_revisions(local_extra,
 
3290
                                        local_branch.repository,
 
3291
                                        verbose):
 
3292
                        lf.log_revision(revision)
 
3293
                    printed_local = True
 
3294
                else:
 
3295
                    printed_local = False
 
3296
                if remote_extra and not mine_only:
 
3297
                    if printed_local is True:
 
3298
                        self.outf.write("\n\n\n")
 
3299
                    self.outf.write("You are missing %d revision(s):\n" %
 
3300
                                    len(remote_extra))
 
3301
                    for revision in iter_log_revisions(remote_extra,
 
3302
                                        remote_branch.repository,
 
3303
                                        verbose):
 
3304
                        lf.log_revision(revision)
 
3305
                if not remote_extra and not local_extra:
 
3306
                    status_code = 0
 
3307
                    self.outf.write("Branches are up to date.\n")
 
3308
                else:
 
3309
                    status_code = 1
 
3310
            finally:
 
3311
                remote_branch.unlock()
 
3312
        finally:
 
3313
            local_branch.unlock()
 
3314
        if not status_code and parent is None and other_branch is not None:
 
3315
            local_branch.lock_write()
 
3316
            try:
 
3317
                # handle race conditions - a parent might be set while we run.
 
3318
                if local_branch.get_parent() is None:
 
3319
                    local_branch.set_parent(remote_branch.base)
 
3320
            finally:
 
3321
                local_branch.unlock()
 
3322
        return status_code
 
3323
 
 
3324
 
 
3325
class cmd_pack(Command):
 
3326
    """Compress the data within a repository."""
 
3327
 
 
3328
    _see_also = ['repositories']
 
3329
    takes_args = ['branch_or_repo?']
 
3330
 
 
3331
    def run(self, branch_or_repo='.'):
 
3332
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3333
        try:
 
3334
            branch = dir.open_branch()
 
3335
            repository = branch.repository
 
3336
        except errors.NotBranchError:
 
3337
            repository = dir.open_repository()
 
3338
        repository.pack()
 
3339
 
 
3340
 
 
3341
class cmd_plugins(Command):
 
3342
    """List the installed plugins.
 
3343
    
 
3344
    This command displays the list of installed plugins including the
 
3345
    path where each one is located and a short description of each.
 
3346
 
 
3347
    A plugin is an external component for Bazaar that extends the
 
3348
    revision control system, by adding or replacing code in Bazaar.
 
3349
    Plugins can do a variety of things, including overriding commands,
 
3350
    adding new commands, providing additional network transports and
 
3351
    customizing log output.
 
3352
 
 
3353
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3354
    information on plugins including where to find them and how to
 
3355
    install them. Instructions are also provided there on how to
 
3356
    write new plugins using the Python programming language.
 
3357
    """
 
3358
 
 
3359
    @display_command
 
3360
    def run(self):
 
3361
        import bzrlib.plugin
 
3362
        from inspect import getdoc
 
3363
        for name, plugin in bzrlib.plugin.plugins().items():
 
3364
            print plugin.path(), "[%s]" % plugin.__version__
 
3365
            d = getdoc(plugin.module)
 
3366
            if d:
 
3367
                print '\t', d.split('\n')[0]
 
3368
 
 
3369
 
 
3370
class cmd_testament(Command):
 
3371
    """Show testament (signing-form) of a revision."""
 
3372
    takes_options = [
 
3373
            'revision',
 
3374
            Option('long', help='Produce long-format testament.'),
 
3375
            Option('strict',
 
3376
                   help='Produce a strict-format testament.')]
 
3377
    takes_args = ['branch?']
 
3378
    @display_command
 
3379
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3380
        from bzrlib.testament import Testament, StrictTestament
 
3381
        if strict is True:
 
3382
            testament_class = StrictTestament
 
3383
        else:
 
3384
            testament_class = Testament
 
3385
        b = WorkingTree.open_containing(branch)[0].branch
 
3386
        b.lock_read()
 
3387
        try:
 
3388
            if revision is None:
 
3389
                rev_id = b.last_revision()
 
3390
            else:
 
3391
                rev_id = revision[0].in_history(b).rev_id
 
3392
            t = testament_class.from_revision(b.repository, rev_id)
 
3393
            if long:
 
3394
                sys.stdout.writelines(t.as_text_lines())
 
3395
            else:
 
3396
                sys.stdout.write(t.as_short_text())
 
3397
        finally:
 
3398
            b.unlock()
 
3399
 
 
3400
 
 
3401
class cmd_annotate(Command):
 
3402
    """Show the origin of each line in a file.
 
3403
 
 
3404
    This prints out the given file with an annotation on the left side
 
3405
    indicating which revision, author and date introduced the change.
 
3406
 
 
3407
    If the origin is the same for a run of consecutive lines, it is 
 
3408
    shown only at the top, unless the --all option is given.
 
3409
    """
 
3410
    # TODO: annotate directories; showing when each file was last changed
 
3411
    # TODO: if the working copy is modified, show annotations on that 
 
3412
    #       with new uncommitted lines marked
 
3413
    aliases = ['ann', 'blame', 'praise']
 
3414
    takes_args = ['filename']
 
3415
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3416
                     Option('long', help='Show commit date in annotations.'),
 
3417
                     'revision',
 
3418
                     'show-ids',
 
3419
                     ]
 
3420
    encoding_type = 'exact'
 
3421
 
 
3422
    @display_command
 
3423
    def run(self, filename, all=False, long=False, revision=None,
 
3424
            show_ids=False):
 
3425
        from bzrlib.annotate import annotate_file
 
3426
        wt, branch, relpath = \
 
3427
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3428
        if wt is not None:
 
3429
            wt.lock_read()
 
3430
        else:
 
3431
            branch.lock_read()
 
3432
        try:
 
3433
            if revision is None:
 
3434
                revision_id = branch.last_revision()
 
3435
            elif len(revision) != 1:
 
3436
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3437
            else:
 
3438
                revision_id = revision[0].in_history(branch).rev_id
 
3439
            tree = branch.repository.revision_tree(revision_id)
 
3440
            if wt is not None:
 
3441
                file_id = wt.path2id(relpath)
 
3442
            else:
 
3443
                file_id = tree.path2id(relpath)
 
3444
            if file_id is None:
 
3445
                raise errors.NotVersionedError(filename)
 
3446
            file_version = tree.inventory[file_id].revision
 
3447
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3448
                          show_ids=show_ids)
 
3449
        finally:
 
3450
            if wt is not None:
 
3451
                wt.unlock()
 
3452
            else:
 
3453
                branch.unlock()
 
3454
 
 
3455
 
 
3456
class cmd_re_sign(Command):
 
3457
    """Create a digital signature for an existing revision."""
 
3458
    # TODO be able to replace existing ones.
 
3459
 
 
3460
    hidden = True # is this right ?
 
3461
    takes_args = ['revision_id*']
 
3462
    takes_options = ['revision']
 
3463
    
 
3464
    def run(self, revision_id_list=None, revision=None):
 
3465
        if revision_id_list is not None and revision is not None:
 
3466
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3467
        if revision_id_list is None and revision is None:
 
3468
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3469
        b = WorkingTree.open_containing(u'.')[0].branch
 
3470
        b.lock_write()
 
3471
        try:
 
3472
            return self._run(b, revision_id_list, revision)
 
3473
        finally:
 
3474
            b.unlock()
 
3475
 
 
3476
    def _run(self, b, revision_id_list, revision):
 
3477
        import bzrlib.gpg as gpg
 
3478
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3479
        if revision_id_list is not None:
 
3480
            b.repository.start_write_group()
 
3481
            try:
 
3482
                for revision_id in revision_id_list:
 
3483
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3484
            except:
 
3485
                b.repository.abort_write_group()
 
3486
                raise
 
3487
            else:
 
3488
                b.repository.commit_write_group()
 
3489
        elif revision is not None:
 
3490
            if len(revision) == 1:
 
3491
                revno, rev_id = revision[0].in_history(b)
 
3492
                b.repository.start_write_group()
 
3493
                try:
 
3494
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3495
                except:
 
3496
                    b.repository.abort_write_group()
 
3497
                    raise
 
3498
                else:
 
3499
                    b.repository.commit_write_group()
 
3500
            elif len(revision) == 2:
 
3501
                # are they both on rh- if so we can walk between them
 
3502
                # might be nice to have a range helper for arbitrary
 
3503
                # revision paths. hmm.
 
3504
                from_revno, from_revid = revision[0].in_history(b)
 
3505
                to_revno, to_revid = revision[1].in_history(b)
 
3506
                if to_revid is None:
 
3507
                    to_revno = b.revno()
 
3508
                if from_revno is None or to_revno is None:
 
3509
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3510
                b.repository.start_write_group()
 
3511
                try:
 
3512
                    for revno in range(from_revno, to_revno + 1):
 
3513
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3514
                                                   gpg_strategy)
 
3515
                except:
 
3516
                    b.repository.abort_write_group()
 
3517
                    raise
 
3518
                else:
 
3519
                    b.repository.commit_write_group()
 
3520
            else:
 
3521
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3522
 
 
3523
 
 
3524
class cmd_bind(Command):
 
3525
    """Convert the current branch into a checkout of the supplied branch.
 
3526
 
 
3527
    Once converted into a checkout, commits must succeed on the master branch
 
3528
    before they will be applied to the local branch.
 
3529
    """
 
3530
 
 
3531
    _see_also = ['checkouts', 'unbind']
 
3532
    takes_args = ['location?']
 
3533
    takes_options = []
 
3534
 
 
3535
    def run(self, location=None):
 
3536
        b, relpath = Branch.open_containing(u'.')
 
3537
        if location is None:
 
3538
            try:
 
3539
                location = b.get_old_bound_location()
 
3540
            except errors.UpgradeRequired:
 
3541
                raise errors.BzrCommandError('No location supplied.  '
 
3542
                    'This format does not remember old locations.')
 
3543
            else:
 
3544
                if location is None:
 
3545
                    raise errors.BzrCommandError('No location supplied and no '
 
3546
                        'previous location known')
 
3547
        b_other = Branch.open(location)
 
3548
        try:
 
3549
            b.bind(b_other)
 
3550
        except errors.DivergedBranches:
 
3551
            raise errors.BzrCommandError('These branches have diverged.'
 
3552
                                         ' Try merging, and then bind again.')
 
3553
 
 
3554
 
 
3555
class cmd_unbind(Command):
 
3556
    """Convert the current checkout into a regular branch.
 
3557
 
 
3558
    After unbinding, the local branch is considered independent and subsequent
 
3559
    commits will be local only.
 
3560
    """
 
3561
 
 
3562
    _see_also = ['checkouts', 'bind']
 
3563
    takes_args = []
 
3564
    takes_options = []
 
3565
 
 
3566
    def run(self):
 
3567
        b, relpath = Branch.open_containing(u'.')
 
3568
        if not b.unbind():
 
3569
            raise errors.BzrCommandError('Local branch is not bound')
 
3570
 
 
3571
 
 
3572
class cmd_uncommit(Command):
 
3573
    """Remove the last committed revision.
 
3574
 
 
3575
    --verbose will print out what is being removed.
 
3576
    --dry-run will go through all the motions, but not actually
 
3577
    remove anything.
 
3578
 
 
3579
    If --revision is specified, uncommit revisions to leave the branch at the
 
3580
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3581
    branch at revision 15.
 
3582
 
 
3583
    In the future, uncommit will create a revision bundle, which can then
 
3584
    be re-applied.
 
3585
    """
 
3586
 
 
3587
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3588
    # unreferenced information in 'branch-as-repository' branches.
 
3589
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3590
    # information in shared branches as well.
 
3591
    _see_also = ['commit']
 
3592
    takes_options = ['verbose', 'revision',
 
3593
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3594
                    Option('force', help='Say yes to all questions.')]
 
3595
    takes_args = ['location?']
 
3596
    aliases = []
 
3597
    encoding_type = 'replace'
 
3598
 
 
3599
    def run(self, location=None,
 
3600
            dry_run=False, verbose=False,
 
3601
            revision=None, force=False):
 
3602
        if location is None:
 
3603
            location = u'.'
 
3604
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3605
        try:
 
3606
            tree = control.open_workingtree()
 
3607
            b = tree.branch
 
3608
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3609
            tree = None
 
3610
            b = control.open_branch()
 
3611
 
 
3612
        if tree is not None:
 
3613
            tree.lock_write()
 
3614
        else:
 
3615
            b.lock_write()
 
3616
        try:
 
3617
            return self._run(b, tree, dry_run, verbose, revision, force)
 
3618
        finally:
 
3619
            if tree is not None:
 
3620
                tree.unlock()
 
3621
            else:
 
3622
                b.unlock()
 
3623
 
 
3624
    def _run(self, b, tree, dry_run, verbose, revision, force):
 
3625
        from bzrlib.log import log_formatter, show_log
 
3626
        from bzrlib.uncommit import uncommit
 
3627
 
 
3628
        last_revno, last_rev_id = b.last_revision_info()
 
3629
 
 
3630
        rev_id = None
 
3631
        if revision is None:
 
3632
            revno = last_revno
 
3633
            rev_id = last_rev_id
 
3634
        else:
 
3635
            # 'bzr uncommit -r 10' actually means uncommit
 
3636
            # so that the final tree is at revno 10.
 
3637
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3638
            # the revisions that are supplied.
 
3639
            # So we need to offset it by one
 
3640
            revno = revision[0].in_history(b).revno + 1
 
3641
            if revno <= last_revno:
 
3642
                rev_id = b.get_rev_id(revno)
 
3643
 
 
3644
        if rev_id is None or _mod_revision.is_null(rev_id):
 
3645
            self.outf.write('No revisions to uncommit.\n')
 
3646
            return 1
 
3647
 
 
3648
        lf = log_formatter('short',
 
3649
                           to_file=self.outf,
 
3650
                           show_timezone='original')
 
3651
 
 
3652
        show_log(b,
 
3653
                 lf,
 
3654
                 verbose=False,
 
3655
                 direction='forward',
 
3656
                 start_revision=revno,
 
3657
                 end_revision=last_revno)
 
3658
 
 
3659
        if dry_run:
 
3660
            print 'Dry-run, pretending to remove the above revisions.'
 
3661
            if not force:
 
3662
                val = raw_input('Press <enter> to continue')
 
3663
        else:
 
3664
            print 'The above revision(s) will be removed.'
 
3665
            if not force:
 
3666
                val = raw_input('Are you sure [y/N]? ')
 
3667
                if val.lower() not in ('y', 'yes'):
 
3668
                    print 'Canceled'
 
3669
                    return 0
 
3670
 
 
3671
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3672
                 revno=revno)
 
3673
 
 
3674
 
 
3675
class cmd_break_lock(Command):
 
3676
    """Break a dead lock on a repository, branch or working directory.
 
3677
 
 
3678
    CAUTION: Locks should only be broken when you are sure that the process
 
3679
    holding the lock has been stopped.
 
3680
 
 
3681
    You can get information on what locks are open via the 'bzr info' command.
 
3682
    
 
3683
    :Examples:
 
3684
        bzr break-lock
 
3685
    """
 
3686
    takes_args = ['location?']
 
3687
 
 
3688
    def run(self, location=None, show=False):
 
3689
        if location is None:
 
3690
            location = u'.'
 
3691
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3692
        try:
 
3693
            control.break_lock()
 
3694
        except NotImplementedError:
 
3695
            pass
 
3696
        
 
3697
 
 
3698
class cmd_wait_until_signalled(Command):
 
3699
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3700
 
 
3701
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3702
    """
 
3703
 
 
3704
    hidden = True
 
3705
 
 
3706
    def run(self):
 
3707
        sys.stdout.write("running\n")
 
3708
        sys.stdout.flush()
 
3709
        sys.stdin.readline()
 
3710
 
 
3711
 
 
3712
class cmd_serve(Command):
 
3713
    """Run the bzr server."""
 
3714
 
 
3715
    aliases = ['server']
 
3716
 
 
3717
    takes_options = [
 
3718
        Option('inet',
 
3719
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3720
        Option('port',
 
3721
               help='Listen for connections on nominated port of the form '
 
3722
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3723
                    'result in a dynamically allocated port.  The default port is '
 
3724
                    '4155.',
 
3725
               type=str),
 
3726
        Option('directory',
 
3727
               help='Serve contents of this directory.',
 
3728
               type=unicode),
 
3729
        Option('allow-writes',
 
3730
               help='By default the server is a readonly server.  Supplying '
 
3731
                    '--allow-writes enables write access to the contents of '
 
3732
                    'the served directory and below.'
 
3733
                ),
 
3734
        ]
 
3735
 
 
3736
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3737
        from bzrlib import lockdir
 
3738
        from bzrlib.smart import medium, server
 
3739
        from bzrlib.transport import get_transport
 
3740
        from bzrlib.transport.chroot import ChrootServer
 
3741
        if directory is None:
 
3742
            directory = os.getcwd()
 
3743
        url = urlutils.local_path_to_url(directory)
 
3744
        if not allow_writes:
 
3745
            url = 'readonly+' + url
 
3746
        chroot_server = ChrootServer(get_transport(url))
 
3747
        chroot_server.setUp()
 
3748
        t = get_transport(chroot_server.get_url())
 
3749
        if inet:
 
3750
            smart_server = medium.SmartServerPipeStreamMedium(
 
3751
                sys.stdin, sys.stdout, t)
 
3752
        else:
 
3753
            host = medium.BZR_DEFAULT_INTERFACE
 
3754
            if port is None:
 
3755
                port = medium.BZR_DEFAULT_PORT
 
3756
            else:
 
3757
                if ':' in port:
 
3758
                    host, port = port.split(':')
 
3759
                port = int(port)
 
3760
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3761
            print 'listening on port: ', smart_server.port
 
3762
            sys.stdout.flush()
 
3763
        # for the duration of this server, no UI output is permitted.
 
3764
        # note that this may cause problems with blackbox tests. This should
 
3765
        # be changed with care though, as we dont want to use bandwidth sending
 
3766
        # progress over stderr to smart server clients!
 
3767
        old_factory = ui.ui_factory
 
3768
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3769
        try:
 
3770
            ui.ui_factory = ui.SilentUIFactory()
 
3771
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3772
            smart_server.serve()
 
3773
        finally:
 
3774
            ui.ui_factory = old_factory
 
3775
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
3776
 
 
3777
 
 
3778
class cmd_join(Command):
 
3779
    """Combine a subtree into its containing tree.
 
3780
    
 
3781
    This command is for experimental use only.  It requires the target tree
 
3782
    to be in dirstate-with-subtree format, which cannot be converted into
 
3783
    earlier formats.
 
3784
 
 
3785
    The TREE argument should be an independent tree, inside another tree, but
 
3786
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3787
    running "bzr branch" with the target inside a tree.)
 
3788
 
 
3789
    The result is a combined tree, with the subtree no longer an independant
 
3790
    part.  This is marked as a merge of the subtree into the containing tree,
 
3791
    and all history is preserved.
 
3792
 
 
3793
    If --reference is specified, the subtree retains its independence.  It can
 
3794
    be branched by itself, and can be part of multiple projects at the same
 
3795
    time.  But operations performed in the containing tree, such as commit
 
3796
    and merge, will recurse into the subtree.
 
3797
    """
 
3798
 
 
3799
    _see_also = ['split']
 
3800
    takes_args = ['tree']
 
3801
    takes_options = [
 
3802
            Option('reference', help='Join by reference.'),
 
3803
            ]
 
3804
    hidden = True
 
3805
 
 
3806
    def run(self, tree, reference=False):
 
3807
        sub_tree = WorkingTree.open(tree)
 
3808
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3809
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3810
        repo = containing_tree.branch.repository
 
3811
        if not repo.supports_rich_root():
 
3812
            raise errors.BzrCommandError(
 
3813
                "Can't join trees because %s doesn't support rich root data.\n"
 
3814
                "You can use bzr upgrade on the repository."
 
3815
                % (repo,))
 
3816
        if reference:
 
3817
            try:
 
3818
                containing_tree.add_reference(sub_tree)
 
3819
            except errors.BadReferenceTarget, e:
 
3820
                # XXX: Would be better to just raise a nicely printable
 
3821
                # exception from the real origin.  Also below.  mbp 20070306
 
3822
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3823
                                             (tree, e.reason))
 
3824
        else:
 
3825
            try:
 
3826
                containing_tree.subsume(sub_tree)
 
3827
            except errors.BadSubsumeSource, e:
 
3828
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3829
                                             (tree, e.reason))
 
3830
 
 
3831
 
 
3832
class cmd_split(Command):
 
3833
    """Split a subdirectory of a tree into a separate tree.
 
3834
 
 
3835
    This command will produce a target tree in a format that supports
 
3836
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
3837
    converted into earlier formats like 'dirstate-tags'.
 
3838
 
 
3839
    The TREE argument should be a subdirectory of a working tree.  That
 
3840
    subdirectory will be converted into an independent tree, with its own
 
3841
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3842
    """
 
3843
 
 
3844
    # join is not un-hidden yet
 
3845
    #_see_also = ['join']
 
3846
    takes_args = ['tree']
 
3847
 
 
3848
    def run(self, tree):
 
3849
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3850
        sub_id = containing_tree.path2id(subdir)
 
3851
        if sub_id is None:
 
3852
            raise errors.NotVersionedError(subdir)
 
3853
        try:
 
3854
            containing_tree.extract(sub_id)
 
3855
        except errors.RootNotRich:
 
3856
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3857
 
 
3858
 
 
3859
class cmd_merge_directive(Command):
 
3860
    """Generate a merge directive for auto-merge tools.
 
3861
 
 
3862
    A directive requests a merge to be performed, and also provides all the
 
3863
    information necessary to do so.  This means it must either include a
 
3864
    revision bundle, or the location of a branch containing the desired
 
3865
    revision.
 
3866
 
 
3867
    A submit branch (the location to merge into) must be supplied the first
 
3868
    time the command is issued.  After it has been supplied once, it will
 
3869
    be remembered as the default.
 
3870
 
 
3871
    A public branch is optional if a revision bundle is supplied, but required
 
3872
    if --diff or --plain is specified.  It will be remembered as the default
 
3873
    after the first use.
 
3874
    """
 
3875
 
 
3876
    takes_args = ['submit_branch?', 'public_branch?']
 
3877
 
 
3878
    hidden = True
 
3879
 
 
3880
    _see_also = ['send']
 
3881
 
 
3882
    takes_options = [
 
3883
        RegistryOption.from_kwargs('patch-type',
 
3884
            'The type of patch to include in the directive.',
 
3885
            title='Patch type',
 
3886
            value_switches=True,
 
3887
            enum_switch=False,
 
3888
            bundle='Bazaar revision bundle (default).',
 
3889
            diff='Normal unified diff.',
 
3890
            plain='No patch, just directive.'),
 
3891
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3892
        Option('mail-to', type=str,
 
3893
            help='Instead of printing the directive, email to this address.'),
 
3894
        Option('message', type=str, short_name='m',
 
3895
            help='Message to use when committing this merge.')
 
3896
        ]
 
3897
 
 
3898
    encoding_type = 'exact'
 
3899
 
 
3900
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3901
            sign=False, revision=None, mail_to=None, message=None):
 
3902
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3903
        include_patch, include_bundle = {
 
3904
            'plain': (False, False),
 
3905
            'diff': (True, False),
 
3906
            'bundle': (True, True),
 
3907
            }[patch_type]
 
3908
        branch = Branch.open('.')
 
3909
        stored_submit_branch = branch.get_submit_branch()
 
3910
        if submit_branch is None:
 
3911
            submit_branch = stored_submit_branch
 
3912
        else:
 
3913
            if stored_submit_branch is None:
 
3914
                branch.set_submit_branch(submit_branch)
 
3915
        if submit_branch is None:
 
3916
            submit_branch = branch.get_parent()
 
3917
        if submit_branch is None:
 
3918
            raise errors.BzrCommandError('No submit branch specified or known')
 
3919
 
 
3920
        stored_public_branch = branch.get_public_branch()
 
3921
        if public_branch is None:
 
3922
            public_branch = stored_public_branch
 
3923
        elif stored_public_branch is None:
 
3924
            branch.set_public_branch(public_branch)
 
3925
        if not include_bundle and public_branch is None:
 
3926
            raise errors.BzrCommandError('No public branch specified or'
 
3927
                                         ' known')
 
3928
        base_revision_id = None
 
3929
        if revision is not None:
 
3930
            if len(revision) > 2:
 
3931
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3932
                    'at most two one revision identifiers')
 
3933
            revision_id = revision[-1].in_history(branch).rev_id
 
3934
            if len(revision) == 2:
 
3935
                base_revision_id = revision[0].in_history(branch).rev_id
 
3936
                base_revision_id = ensure_null(base_revision_id)
 
3937
        else:
 
3938
            revision_id = branch.last_revision()
 
3939
        revision_id = ensure_null(revision_id)
 
3940
        if revision_id == NULL_REVISION:
 
3941
            raise errors.BzrCommandError('No revisions to bundle.')
 
3942
        directive = merge_directive.MergeDirective2.from_objects(
 
3943
            branch.repository, revision_id, time.time(),
 
3944
            osutils.local_time_offset(), submit_branch,
 
3945
            public_branch=public_branch, include_patch=include_patch,
 
3946
            include_bundle=include_bundle, message=message,
 
3947
            base_revision_id=base_revision_id)
 
3948
        if mail_to is None:
 
3949
            if sign:
 
3950
                self.outf.write(directive.to_signed(branch))
 
3951
            else:
 
3952
                self.outf.writelines(directive.to_lines())
 
3953
        else:
 
3954
            message = directive.to_email(mail_to, branch, sign)
 
3955
            s = SMTPConnection(branch.get_config())
 
3956
            s.send_email(message)
 
3957
 
 
3958
 
 
3959
class cmd_send(Command):
 
3960
    """Mail or create a merge-directive for submiting changes.
 
3961
 
 
3962
    A merge directive provides many things needed for requesting merges:
 
3963
 
 
3964
    * A machine-readable description of the merge to perform
 
3965
 
 
3966
    * An optional patch that is a preview of the changes requested
 
3967
 
 
3968
    * An optional bundle of revision data, so that the changes can be applied
 
3969
      directly from the merge directive, without retrieving data from a
 
3970
      branch.
 
3971
 
 
3972
    If --no-bundle is specified, then public_branch is needed (and must be
 
3973
    up-to-date), so that the receiver can perform the merge using the
 
3974
    public_branch.  The public_branch is always included if known, so that
 
3975
    people can check it later.
 
3976
 
 
3977
    The submit branch defaults to the parent, but can be overridden.  Both
 
3978
    submit branch and public branch will be remembered if supplied.
 
3979
 
 
3980
    If a public_branch is known for the submit_branch, that public submit
 
3981
    branch is used in the merge instructions.  This means that a local mirror
 
3982
    can be used as your actual submit branch, once you have set public_branch
 
3983
    for that mirror.
 
3984
 
 
3985
    Mail is sent using your preferred mail program.  This should be transparent
 
3986
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
3987
    If the preferred client can't be found (or used), your editor will be used.
 
3988
    
 
3989
    To use a specific mail program, set the mail_client configuration option.
 
3990
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
3991
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
3992
    generic options are "default", "editor", "mapi", and "xdg-email".
 
3993
 
 
3994
    If mail is being sent, a to address is required.  This can be supplied
 
3995
    either on the commandline, or by setting the submit_to configuration
 
3996
    option.
 
3997
 
 
3998
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
3999
    merge directive format 2.  It is significantly faster and smaller than
 
4000
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4001
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4002
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4003
    """
 
4004
 
 
4005
    encoding_type = 'exact'
 
4006
 
 
4007
    _see_also = ['merge']
 
4008
 
 
4009
    takes_args = ['submit_branch?', 'public_branch?']
 
4010
 
 
4011
    takes_options = [
 
4012
        Option('no-bundle',
 
4013
               help='Do not include a bundle in the merge directive.'),
 
4014
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4015
               ' directive.'),
 
4016
        Option('remember',
 
4017
               help='Remember submit and public branch.'),
 
4018
        Option('from',
 
4019
               help='Branch to generate the submission from, '
 
4020
               'rather than the one containing the working directory.',
 
4021
               short_name='f',
 
4022
               type=unicode),
 
4023
        Option('output', short_name='o', help='Write directive to this file.',
 
4024
               type=unicode),
 
4025
        Option('mail-to', help='Mail the request to this address.',
 
4026
               type=unicode),
 
4027
        'revision',
 
4028
        'message',
 
4029
        RegistryOption.from_kwargs('format',
 
4030
        'Use the specified output format.',
 
4031
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4032
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4033
        ]
 
4034
 
 
4035
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4036
            no_patch=False, revision=None, remember=False, output=None,
 
4037
            format='4', mail_to=None, message=None, **kwargs):
 
4038
        return self._run(submit_branch, revision, public_branch, remember,
 
4039
                         format, no_bundle, no_patch, output,
 
4040
                         kwargs.get('from', '.'), mail_to, message)
 
4041
 
 
4042
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4043
             no_bundle, no_patch, output, from_, mail_to, message):
 
4044
        from bzrlib.revision import NULL_REVISION
 
4045
        branch = Branch.open_containing(from_)[0]
 
4046
        if output is None:
 
4047
            outfile = StringIO()
 
4048
        elif output == '-':
 
4049
            outfile = self.outf
 
4050
        else:
 
4051
            outfile = open(output, 'wb')
 
4052
        # we may need to write data into branch's repository to calculate
 
4053
        # the data to send.
 
4054
        branch.lock_write()
 
4055
        try:
 
4056
            if output is None:
 
4057
                config = branch.get_config()
 
4058
                if mail_to is None:
 
4059
                    mail_to = config.get_user_option('submit_to')
 
4060
                mail_client = config.get_mail_client()
 
4061
            if remember and submit_branch is None:
 
4062
                raise errors.BzrCommandError(
 
4063
                    '--remember requires a branch to be specified.')
 
4064
            stored_submit_branch = branch.get_submit_branch()
 
4065
            remembered_submit_branch = False
 
4066
            if submit_branch is None:
 
4067
                submit_branch = stored_submit_branch
 
4068
                remembered_submit_branch = True
 
4069
            else:
 
4070
                if stored_submit_branch is None or remember:
 
4071
                    branch.set_submit_branch(submit_branch)
 
4072
            if submit_branch is None:
 
4073
                submit_branch = branch.get_parent()
 
4074
                remembered_submit_branch = True
 
4075
            if submit_branch is None:
 
4076
                raise errors.BzrCommandError('No submit branch known or'
 
4077
                                             ' specified')
 
4078
            if remembered_submit_branch:
 
4079
                note('Using saved location: %s', submit_branch)
 
4080
 
 
4081
            stored_public_branch = branch.get_public_branch()
 
4082
            if public_branch is None:
 
4083
                public_branch = stored_public_branch
 
4084
            elif stored_public_branch is None or remember:
 
4085
                branch.set_public_branch(public_branch)
 
4086
            if no_bundle and public_branch is None:
 
4087
                raise errors.BzrCommandError('No public branch specified or'
 
4088
                                             ' known')
 
4089
            base_revision_id = None
 
4090
            revision_id = None
 
4091
            if revision is not None:
 
4092
                if len(revision) > 2:
 
4093
                    raise errors.BzrCommandError('bzr send takes '
 
4094
                        'at most two one revision identifiers')
 
4095
                revision_id = revision[-1].in_history(branch).rev_id
 
4096
                if len(revision) == 2:
 
4097
                    base_revision_id = revision[0].in_history(branch).rev_id
 
4098
            if revision_id is None:
 
4099
                revision_id = branch.last_revision()
 
4100
            if revision_id == NULL_REVISION:
 
4101
                raise errors.BzrCommandError('No revisions to submit.')
 
4102
            if format == '4':
 
4103
                directive = merge_directive.MergeDirective2.from_objects(
 
4104
                    branch.repository, revision_id, time.time(),
 
4105
                    osutils.local_time_offset(), submit_branch,
 
4106
                    public_branch=public_branch, include_patch=not no_patch,
 
4107
                    include_bundle=not no_bundle, message=message,
 
4108
                    base_revision_id=base_revision_id)
 
4109
            elif format == '0.9':
 
4110
                if not no_bundle:
 
4111
                    if not no_patch:
 
4112
                        patch_type = 'bundle'
 
4113
                    else:
 
4114
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4115
                            ' permit bundle with no patch')
 
4116
                else:
 
4117
                    if not no_patch:
 
4118
                        patch_type = 'diff'
 
4119
                    else:
 
4120
                        patch_type = None
 
4121
                directive = merge_directive.MergeDirective.from_objects(
 
4122
                    branch.repository, revision_id, time.time(),
 
4123
                    osutils.local_time_offset(), submit_branch,
 
4124
                    public_branch=public_branch, patch_type=patch_type,
 
4125
                    message=message)
 
4126
 
 
4127
            outfile.writelines(directive.to_lines())
 
4128
            if output is None:
 
4129
                subject = '[MERGE] '
 
4130
                if message is not None:
 
4131
                    subject += message
 
4132
                else:
 
4133
                    revision = branch.repository.get_revision(revision_id)
 
4134
                    subject += revision.get_summary()
 
4135
                mail_client.compose_merge_request(mail_to, subject,
 
4136
                                                  outfile.getvalue())
 
4137
        finally:
 
4138
            if output != '-':
 
4139
                outfile.close()
 
4140
            branch.unlock()
 
4141
 
 
4142
 
 
4143
class cmd_bundle_revisions(cmd_send):
 
4144
 
 
4145
    """Create a merge-directive for submiting changes.
 
4146
 
 
4147
    A merge directive provides many things needed for requesting merges:
 
4148
 
 
4149
    * A machine-readable description of the merge to perform
 
4150
 
 
4151
    * An optional patch that is a preview of the changes requested
 
4152
 
 
4153
    * An optional bundle of revision data, so that the changes can be applied
 
4154
      directly from the merge directive, without retrieving data from a
 
4155
      branch.
 
4156
 
 
4157
    If --no-bundle is specified, then public_branch is needed (and must be
 
4158
    up-to-date), so that the receiver can perform the merge using the
 
4159
    public_branch.  The public_branch is always included if known, so that
 
4160
    people can check it later.
 
4161
 
 
4162
    The submit branch defaults to the parent, but can be overridden.  Both
 
4163
    submit branch and public branch will be remembered if supplied.
 
4164
 
 
4165
    If a public_branch is known for the submit_branch, that public submit
 
4166
    branch is used in the merge instructions.  This means that a local mirror
 
4167
    can be used as your actual submit branch, once you have set public_branch
 
4168
    for that mirror.
 
4169
 
 
4170
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4171
    merge directive format 2.  It is significantly faster and smaller than
 
4172
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4173
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4174
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4175
    """
 
4176
 
 
4177
    takes_options = [
 
4178
        Option('no-bundle',
 
4179
               help='Do not include a bundle in the merge directive.'),
 
4180
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4181
               ' directive.'),
 
4182
        Option('remember',
 
4183
               help='Remember submit and public branch.'),
 
4184
        Option('from',
 
4185
               help='Branch to generate the submission from, '
 
4186
               'rather than the one containing the working directory.',
 
4187
               short_name='f',
 
4188
               type=unicode),
 
4189
        Option('output', short_name='o', help='Write directive to this file.',
 
4190
               type=unicode),
 
4191
        'revision',
 
4192
        RegistryOption.from_kwargs('format',
 
4193
        'Use the specified output format.',
 
4194
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4195
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4196
        ]
 
4197
    aliases = ['bundle']
 
4198
 
 
4199
    _see_also = ['send', 'merge']
 
4200
 
 
4201
    hidden = True
 
4202
 
 
4203
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4204
            no_patch=False, revision=None, remember=False, output=None,
 
4205
            format='4', **kwargs):
 
4206
        if output is None:
 
4207
            output = '-'
 
4208
        return self._run(submit_branch, revision, public_branch, remember,
 
4209
                         format, no_bundle, no_patch, output,
 
4210
                         kwargs.get('from', '.'), None, None)
 
4211
 
 
4212
 
 
4213
class cmd_tag(Command):
 
4214
    """Create, remove or modify a tag naming a revision.
 
4215
    
 
4216
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4217
    (--revision) option can be given -rtag:X, where X is any previously
 
4218
    created tag.
 
4219
 
 
4220
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4221
    along when you branch, push, pull or merge.
 
4222
 
 
4223
    It is an error to give a tag name that already exists unless you pass 
 
4224
    --force, in which case the tag is moved to point to the new revision.
 
4225
    """
 
4226
 
 
4227
    _see_also = ['commit', 'tags']
 
4228
    takes_args = ['tag_name']
 
4229
    takes_options = [
 
4230
        Option('delete',
 
4231
            help='Delete this tag rather than placing it.',
 
4232
            ),
 
4233
        Option('directory',
 
4234
            help='Branch in which to place the tag.',
 
4235
            short_name='d',
 
4236
            type=unicode,
 
4237
            ),
 
4238
        Option('force',
 
4239
            help='Replace existing tags.',
 
4240
            ),
 
4241
        'revision',
 
4242
        ]
 
4243
 
 
4244
    def run(self, tag_name,
 
4245
            delete=None,
 
4246
            directory='.',
 
4247
            force=None,
 
4248
            revision=None,
 
4249
            ):
 
4250
        branch, relpath = Branch.open_containing(directory)
 
4251
        branch.lock_write()
 
4252
        try:
 
4253
            if delete:
 
4254
                branch.tags.delete_tag(tag_name)
 
4255
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4256
            else:
 
4257
                if revision:
 
4258
                    if len(revision) != 1:
 
4259
                        raise errors.BzrCommandError(
 
4260
                            "Tags can only be placed on a single revision, "
 
4261
                            "not on a range")
 
4262
                    revision_id = revision[0].in_history(branch).rev_id
 
4263
                else:
 
4264
                    revision_id = branch.last_revision()
 
4265
                if (not force) and branch.tags.has_tag(tag_name):
 
4266
                    raise errors.TagAlreadyExists(tag_name)
 
4267
                branch.tags.set_tag(tag_name, revision_id)
 
4268
                self.outf.write('Created tag %s.\n' % tag_name)
 
4269
        finally:
 
4270
            branch.unlock()
 
4271
 
 
4272
 
 
4273
class cmd_tags(Command):
 
4274
    """List tags.
 
4275
 
 
4276
    This command shows a table of tag names and the revisions they reference.
 
4277
    """
 
4278
 
 
4279
    _see_also = ['tag']
 
4280
    takes_options = [
 
4281
        Option('directory',
 
4282
            help='Branch whose tags should be displayed.',
 
4283
            short_name='d',
 
4284
            type=unicode,
 
4285
            ),
 
4286
        RegistryOption.from_kwargs('sort',
 
4287
            'Sort tags by different criteria.', title='Sorting',
 
4288
            alpha='Sort tags lexicographically (default).',
 
4289
            time='Sort tags chronologically.',
 
4290
            ),
 
4291
        'show-ids',
 
4292
    ]
 
4293
 
 
4294
    @display_command
 
4295
    def run(self,
 
4296
            directory='.',
 
4297
            sort='alpha',
 
4298
            show_ids=False,
 
4299
            ):
 
4300
        branch, relpath = Branch.open_containing(directory)
 
4301
        tags = branch.tags.get_tag_dict().items()
 
4302
        if sort == 'alpha':
 
4303
            tags.sort()
 
4304
        elif sort == 'time':
 
4305
            timestamps = {}
 
4306
            for tag, revid in tags:
 
4307
                try:
 
4308
                    revobj = branch.repository.get_revision(revid)
 
4309
                except errors.NoSuchRevision:
 
4310
                    timestamp = sys.maxint # place them at the end
 
4311
                else:
 
4312
                    timestamp = revobj.timestamp
 
4313
                timestamps[revid] = timestamp
 
4314
            tags.sort(key=lambda x: timestamps[x[1]])
 
4315
        if not show_ids:
 
4316
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4317
            revno_map = branch.get_revision_id_to_revno_map()
 
4318
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4319
                        for tag, revid in tags ]
 
4320
        for tag, revspec in tags:
 
4321
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4322
 
 
4323
 
 
4324
class cmd_reconfigure(Command):
 
4325
    """Reconfigure the type of a bzr directory.
 
4326
 
 
4327
    A target configuration must be specified.
 
4328
 
 
4329
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4330
    The order of preference is
 
4331
    1. For a lightweight checkout, the current bound location.
 
4332
    2. For branches that used to be checkouts, the previously-bound location.
 
4333
    3. The push location.
 
4334
    4. The parent location.
 
4335
    If none of these is available, --bind-to must be specified.
 
4336
    """
 
4337
 
 
4338
    takes_args = ['location?']
 
4339
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4340
                     title='Target type',
 
4341
                     help='The type to reconfigure the directory to.',
 
4342
                     value_switches=True, enum_switch=False,
 
4343
                     branch='Reconfigure to a branch.',
 
4344
                     tree='Reconfigure to a tree.',
 
4345
                     checkout='Reconfigure to a checkout.',
 
4346
                     lightweight_checkout='Reconfigure to a lightweight'
 
4347
                     ' checkout.'),
 
4348
                     Option('bind-to', help='Branch to bind checkout to.',
 
4349
                            type=str),
 
4350
                     Option('force',
 
4351
                        help='Perform reconfiguration even if local changes'
 
4352
                        ' will be lost.')
 
4353
                     ]
 
4354
 
 
4355
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4356
        directory = bzrdir.BzrDir.open(location)
 
4357
        if target_type is None:
 
4358
            raise errors.BzrCommandError('No target configuration specified')
 
4359
        elif target_type == 'branch':
 
4360
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4361
        elif target_type == 'tree':
 
4362
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4363
        elif target_type == 'checkout':
 
4364
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4365
                                                                  bind_to)
 
4366
        elif target_type == 'lightweight-checkout':
 
4367
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4368
                directory, bind_to)
 
4369
        reconfiguration.apply(force)
 
4370
 
 
4371
 
 
4372
class cmd_switch(Command):
 
4373
    """Set the branch of a checkout and update.
 
4374
    
 
4375
    For lightweight checkouts, this changes the branch being referenced.
 
4376
    For heavyweight checkouts, this checks that there are no local commits
 
4377
    versus the current bound branch, then it makes the local branch a mirror
 
4378
    of the new location and binds to it.
 
4379
    
 
4380
    In both cases, the working tree is updated and uncommitted changes
 
4381
    are merged. The user can commit or revert these as they desire.
 
4382
 
 
4383
    Pending merges need to be committed or reverted before using switch.
 
4384
    """
 
4385
 
 
4386
    takes_args = ['to_location']
 
4387
    takes_options = [Option('force',
 
4388
                        help='Switch even if local commits will be lost.')
 
4389
                     ]
 
4390
 
 
4391
    def run(self, to_location, force=False):
 
4392
        from bzrlib import switch
 
4393
        to_branch = Branch.open(to_location)
 
4394
        tree_location = '.'
 
4395
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4396
        switch.switch(control_dir, to_branch, force)
 
4397
        note('Switched to branch: %s',
 
4398
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4399
 
 
4400
 
 
4401
def _create_prefix(cur_transport):
 
4402
    needed = [cur_transport]
 
4403
    # Recurse upwards until we can create a directory successfully
 
4404
    while True:
 
4405
        new_transport = cur_transport.clone('..')
 
4406
        if new_transport.base == cur_transport.base:
 
4407
            raise errors.BzrCommandError(
 
4408
                "Failed to create path prefix for %s."
 
4409
                % cur_transport.base)
 
4410
        try:
 
4411
            new_transport.mkdir('.')
 
4412
        except errors.NoSuchFile:
 
4413
            needed.append(new_transport)
 
4414
            cur_transport = new_transport
 
4415
        else:
 
4416
            break
 
4417
    # Now we only need to create child directories
 
4418
    while needed:
 
4419
        cur_transport = needed.pop()
 
4420
        cur_transport.ensure_base()
 
4421
 
 
4422
 
 
4423
def _get_mergeable_helper(location):
 
4424
    """Get a merge directive or bundle if 'location' points to one.
 
4425
 
 
4426
    Try try to identify a bundle and returns its mergeable form. If it's not,
 
4427
    we return the tried transport anyway so that it can reused to access the
 
4428
    branch
 
4429
 
 
4430
    :param location: can point to a bundle or a branch.
 
4431
 
 
4432
    :return: mergeable, transport
 
4433
    """
 
4434
    mergeable = None
 
4435
    url = urlutils.normalize_url(location)
 
4436
    url, filename = urlutils.split(url, exclude_trailing_slash=False)
 
4437
    location_transport = transport.get_transport(url)
 
4438
    if filename:
 
4439
        try:
 
4440
            # There may be redirections but we ignore the intermediate
 
4441
            # and final transports used
 
4442
            read = bundle.read_mergeable_from_transport
 
4443
            mergeable, t = read(location_transport, filename)
 
4444
        except errors.NotABundle:
 
4445
            # Continue on considering this url a Branch but adjust the
 
4446
            # location_transport
 
4447
            location_transport = location_transport.clone(filename)
 
4448
    return mergeable, location_transport
 
4449
 
 
4450
 
 
4451
# these get imported and then picked up by the scan for cmd_*
 
4452
# TODO: Some more consistent way to split command definitions across files;
 
4453
# we do need to load at least some information about them to know of 
 
4454
# aliases.  ideally we would avoid loading the implementation until the
 
4455
# details were needed.
 
4456
from bzrlib.cmd_version_info import cmd_version_info
 
4457
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4458
from bzrlib.bundle.commands import (
 
4459
    cmd_bundle_info,
 
4460
    )
 
4461
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4462
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4463
        cmd_weave_plan_merge, cmd_weave_merge_text