/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2008-01-03 06:34:07 UTC
  • mto: (3144.5.2 specific-file)
  • mto: This revision was merged to the branch mainline in revision 3156.
  • Revision ID: aaron.bentley@utoronto.ca-20080103063407-yicj1hy2v9s3w39j
Add documentation of LCA merge

Show diffs side-by-side

added added

removed removed

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