/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: John Arbash Meinel
  • Date: 2008-06-05 16:24:53 UTC
  • mto: This revision was merged to the branch mainline in revision 3476.
  • Revision ID: john@arbash-meinel.com-20080605162453-txsytbd94p20kdwd
minor cleanups

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