/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: James Westby
  • Date: 2008-03-01 12:42:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3256.
  • Revision ID: jw+debian@jameswestby.net-20080301124212-4p3417gfs2pdwnbn
Add pack to the list of debug flags.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
import os
 
20
from StringIO import StringIO
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import codecs
 
25
import sys
 
26
import time
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    bugtracker,
 
31
    bundle,
 
32
    bzrdir,
 
33
    delta,
 
34
    config,
 
35
    errors,
 
36
    globbing,
 
37
    ignores,
 
38
    log,
 
39
    merge as _mod_merge,
 
40
    merge_directive,
 
41
    osutils,
 
42
    reconfigure,
 
43
    revision as _mod_revision,
 
44
    symbol_versioning,
 
45
    transport,
 
46
    tree as _mod_tree,
 
47
    ui,
 
48
    urlutils,
 
49
    )
 
50
from bzrlib.branch import Branch
 
51
from bzrlib.conflicts import ConflictList
 
52
from bzrlib.revisionspec import RevisionSpec
 
53
from bzrlib.smtp_connection import SMTPConnection
 
54
from bzrlib.workingtree import WorkingTree
 
55
""")
 
56
 
 
57
from bzrlib.commands import Command, display_command
 
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
 
60
 
 
61
 
 
62
def tree_files(file_list, default_branch=u'.'):
 
63
    try:
 
64
        return internal_tree_files(file_list, default_branch)
 
65
    except errors.FileInWrongBranch, e:
 
66
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
67
                                     (e.path, file_list[0]))
 
68
 
 
69
 
 
70
# XXX: Bad function name; should possibly also be a class method of
 
71
# WorkingTree rather than a function.
 
72
def internal_tree_files(file_list, default_branch=u'.'):
 
73
    """Convert command-line paths to a WorkingTree and relative paths.
 
74
 
 
75
    This is typically used for command-line processors that take one or
 
76
    more filenames, and infer the workingtree that contains them.
 
77
 
 
78
    The filenames given are not required to exist.
 
79
 
 
80
    :param file_list: Filenames to convert.  
 
81
 
 
82
    :param default_branch: Fallback tree path to use if file_list is empty or
 
83
        None.
 
84
 
 
85
    :return: workingtree, [relative_paths]
 
86
    """
 
87
    if file_list is None or len(file_list) == 0:
 
88
        return WorkingTree.open_containing(default_branch)[0], file_list
 
89
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
90
    new_list = []
 
91
    for filename in file_list:
 
92
        try:
 
93
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
94
        except errors.PathNotChild:
 
95
            raise errors.FileInWrongBranch(tree.branch, filename)
 
96
    return tree, new_list
 
97
 
 
98
 
 
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
 
100
def get_format_type(typestring):
 
101
    """Parse and return a format specifier."""
 
102
    # Have to use BzrDirMetaFormat1 directly, so that
 
103
    # RepositoryFormat.set_default_format works
 
104
    if typestring == "default":
 
105
        return bzrdir.BzrDirMetaFormat1()
 
106
    try:
 
107
        return bzrdir.format_registry.make_bzrdir(typestring)
 
108
    except KeyError:
 
109
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
 
110
        raise errors.BzrCommandError(msg)
 
111
 
 
112
 
 
113
# TODO: Make sure no commands unconditionally use the working directory as a
 
114
# branch.  If a filename argument is used, the first of them should be used to
 
115
# specify the branch.  (Perhaps this can be factored out into some kind of
 
116
# Argument class, representing a file in a branch, where the first occurrence
 
117
# opens the branch?)
 
118
 
 
119
class cmd_status(Command):
 
120
    """Display status summary.
 
121
 
 
122
    This reports on versioned and unknown files, reporting them
 
123
    grouped by state.  Possible states are:
 
124
 
 
125
    added
 
126
        Versioned in the working copy but not in the previous revision.
 
127
 
 
128
    removed
 
129
        Versioned in the previous revision but removed or deleted
 
130
        in the working copy.
 
131
 
 
132
    renamed
 
133
        Path of this file changed from the previous revision;
 
134
        the text may also have changed.  This includes files whose
 
135
        parent directory was renamed.
 
136
 
 
137
    modified
 
138
        Text has changed since the previous revision.
 
139
 
 
140
    kind changed
 
141
        File kind has been changed (e.g. from file to directory).
 
142
 
 
143
    unknown
 
144
        Not versioned and not matching an ignore pattern.
 
145
 
 
146
    To see ignored files use 'bzr ignored'.  For details on the
 
147
    changes to file texts, use 'bzr diff'.
 
148
    
 
149
    Note that --short or -S gives status flags for each item, similar
 
150
    to Subversion's status command. To get output similar to svn -q,
 
151
    use bzr -SV.
 
152
 
 
153
    If no arguments are specified, the status of the entire working
 
154
    directory is shown.  Otherwise, only the status of the specified
 
155
    files or directories is reported.  If a directory is given, status
 
156
    is reported for everything inside that directory.
 
157
 
 
158
    If a revision argument is given, the status is calculated against
 
159
    that revision, or between two revisions if two are provided.
 
160
    """
 
161
    
 
162
    # TODO: --no-recurse, --recurse options
 
163
    
 
164
    takes_args = ['file*']
 
165
    takes_options = ['show-ids', 'revision', 'change',
 
166
                     Option('short', help='Use short status indicators.',
 
167
                            short_name='S'),
 
168
                     Option('versioned', help='Only show versioned files.',
 
169
                            short_name='V')
 
170
                     ]
 
171
    aliases = ['st', 'stat']
 
172
 
 
173
    encoding_type = 'replace'
 
174
    _see_also = ['diff', 'revert', 'status-flags']
 
175
    
 
176
    @display_command
 
177
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
178
            versioned=False):
 
179
        from bzrlib.status import show_tree_status
 
180
 
 
181
        if revision and len(revision) > 2:
 
182
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
183
                                         ' one or two revision specifiers')
 
184
 
 
185
        tree, file_list = tree_files(file_list)
 
186
            
 
187
        show_tree_status(tree, show_ids=show_ids,
 
188
                         specific_files=file_list, revision=revision,
 
189
                         to_file=self.outf, short=short, versioned=versioned)
 
190
 
 
191
 
 
192
class cmd_cat_revision(Command):
 
193
    """Write out metadata for a revision.
 
194
    
 
195
    The revision to print can either be specified by a specific
 
196
    revision identifier, or you can use --revision.
 
197
    """
 
198
 
 
199
    hidden = True
 
200
    takes_args = ['revision_id?']
 
201
    takes_options = ['revision']
 
202
    # cat-revision is more for frontends so should be exact
 
203
    encoding = 'strict'
 
204
    
 
205
    @display_command
 
206
    def run(self, revision_id=None, revision=None):
 
207
        if revision_id is not None and revision is not None:
 
208
            raise errors.BzrCommandError('You can only supply one of'
 
209
                                         ' revision_id or --revision')
 
210
        if revision_id is None and revision is None:
 
211
            raise errors.BzrCommandError('You must supply either'
 
212
                                         ' --revision or a revision_id')
 
213
        b = WorkingTree.open_containing(u'.')[0].branch
 
214
 
 
215
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
216
        if revision_id is not None:
 
217
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
218
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
219
        elif revision is not None:
 
220
            for rev in revision:
 
221
                if rev is None:
 
222
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
223
                                                 ' revision.')
 
224
                revno, rev_id = rev.in_history(b)
 
225
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
226
    
 
227
 
 
228
class cmd_remove_tree(Command):
 
229
    """Remove the working tree from a given branch/checkout.
 
230
 
 
231
    Since a lightweight checkout is little more than a working tree
 
232
    this will refuse to run against one.
 
233
 
 
234
    To re-create the working tree, use "bzr checkout".
 
235
    """
 
236
    _see_also = ['checkout', 'working-trees']
 
237
 
 
238
    takes_args = ['location?']
 
239
 
 
240
    def run(self, location='.'):
 
241
        d = bzrdir.BzrDir.open(location)
 
242
        
 
243
        try:
 
244
            working = d.open_workingtree()
 
245
        except errors.NoWorkingTree:
 
246
            raise errors.BzrCommandError("No working tree to remove")
 
247
        except errors.NotLocalUrl:
 
248
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
249
                                         "remote path")
 
250
        
 
251
        working_path = working.bzrdir.root_transport.base
 
252
        branch_path = working.branch.bzrdir.root_transport.base
 
253
        if working_path != branch_path:
 
254
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
255
                                         "a lightweight checkout")
 
256
        
 
257
        d.destroy_workingtree()
 
258
        
 
259
 
 
260
class cmd_revno(Command):
 
261
    """Show current revision number.
 
262
 
 
263
    This is equal to the number of revisions on this branch.
 
264
    """
 
265
 
 
266
    _see_also = ['info']
 
267
    takes_args = ['location?']
 
268
 
 
269
    @display_command
 
270
    def run(self, location=u'.'):
 
271
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
272
        self.outf.write('\n')
 
273
 
 
274
 
 
275
class cmd_revision_info(Command):
 
276
    """Show revision number and revision id for a given revision identifier.
 
277
    """
 
278
    hidden = True
 
279
    takes_args = ['revision_info*']
 
280
    takes_options = ['revision']
 
281
 
 
282
    @display_command
 
283
    def run(self, revision=None, revision_info_list=[]):
 
284
 
 
285
        revs = []
 
286
        if revision is not None:
 
287
            revs.extend(revision)
 
288
        if revision_info_list is not None:
 
289
            for rev in revision_info_list:
 
290
                revs.append(RevisionSpec.from_string(rev))
 
291
 
 
292
        b = Branch.open_containing(u'.')[0]
 
293
 
 
294
        if len(revs) == 0:
 
295
            revs.append(RevisionSpec.from_string('-1'))
 
296
 
 
297
        for rev in revs:
 
298
            revinfo = rev.in_history(b)
 
299
            if revinfo.revno is None:
 
300
                dotted_map = b.get_revision_id_to_revno_map()
 
301
                revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
 
302
                print '%s %s' % (revno, revinfo.rev_id)
 
303
            else:
 
304
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
305
 
 
306
    
 
307
class cmd_add(Command):
 
308
    """Add specified files or directories.
 
309
 
 
310
    In non-recursive mode, all the named items are added, regardless
 
311
    of whether they were previously ignored.  A warning is given if
 
312
    any of the named files are already versioned.
 
313
 
 
314
    In recursive mode (the default), files are treated the same way
 
315
    but the behaviour for directories is different.  Directories that
 
316
    are already versioned do not give a warning.  All directories,
 
317
    whether already versioned or not, are searched for files or
 
318
    subdirectories that are neither versioned or ignored, and these
 
319
    are added.  This search proceeds recursively into versioned
 
320
    directories.  If no names are given '.' is assumed.
 
321
 
 
322
    Therefore simply saying 'bzr add' will version all files that
 
323
    are currently unknown.
 
324
 
 
325
    Adding a file whose parent directory is not versioned will
 
326
    implicitly add the parent, and so on up to the root. This means
 
327
    you should never need to explicitly add a directory, they'll just
 
328
    get added when you add a file in the directory.
 
329
 
 
330
    --dry-run will show which files would be added, but not actually 
 
331
    add them.
 
332
 
 
333
    --file-ids-from will try to use the file ids from the supplied path.
 
334
    It looks up ids trying to find a matching parent directory with the
 
335
    same filename, and then by pure path. This option is rarely needed
 
336
    but can be useful when adding the same logical file into two
 
337
    branches that will be merged later (without showing the two different
 
338
    adds as a conflict). It is also useful when merging another project
 
339
    into a subdirectory of this one.
 
340
    """
 
341
    takes_args = ['file*']
 
342
    takes_options = [
 
343
        Option('no-recurse',
 
344
               help="Don't recursively add the contents of directories."),
 
345
        Option('dry-run',
 
346
               help="Show what would be done, but don't actually do anything."),
 
347
        'verbose',
 
348
        Option('file-ids-from',
 
349
               type=unicode,
 
350
               help='Lookup file ids from this tree.'),
 
351
        ]
 
352
    encoding_type = 'replace'
 
353
    _see_also = ['remove']
 
354
 
 
355
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
356
            file_ids_from=None):
 
357
        import bzrlib.add
 
358
 
 
359
        base_tree = None
 
360
        if file_ids_from is not None:
 
361
            try:
 
362
                base_tree, base_path = WorkingTree.open_containing(
 
363
                                            file_ids_from)
 
364
            except errors.NoWorkingTree:
 
365
                base_branch, base_path = Branch.open_containing(
 
366
                                            file_ids_from)
 
367
                base_tree = base_branch.basis_tree()
 
368
 
 
369
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
370
                          to_file=self.outf, should_print=(not is_quiet()))
 
371
        else:
 
372
            action = bzrlib.add.AddAction(to_file=self.outf,
 
373
                should_print=(not is_quiet()))
 
374
 
 
375
        if base_tree:
 
376
            base_tree.lock_read()
 
377
        try:
 
378
            file_list = self._maybe_expand_globs(file_list)
 
379
            if file_list:
 
380
                tree = WorkingTree.open_containing(file_list[0])[0]
 
381
            else:
 
382
                tree = WorkingTree.open_containing(u'.')[0]
 
383
            added, ignored = tree.smart_add(file_list, not
 
384
                no_recurse, action=action, save=not dry_run)
 
385
        finally:
 
386
            if base_tree is not None:
 
387
                base_tree.unlock()
 
388
        if len(ignored) > 0:
 
389
            if verbose:
 
390
                for glob in sorted(ignored.keys()):
 
391
                    for path in ignored[glob]:
 
392
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
393
                                        % (path, glob))
 
394
            else:
 
395
                match_len = 0
 
396
                for glob, paths in ignored.items():
 
397
                    match_len += len(paths)
 
398
                self.outf.write("ignored %d file(s).\n" % match_len)
 
399
            self.outf.write("If you wish to add some of these files,"
 
400
                            " please add them by name.\n")
 
401
 
 
402
 
 
403
class cmd_mkdir(Command):
 
404
    """Create a new versioned directory.
 
405
 
 
406
    This is equivalent to creating the directory and then adding it.
 
407
    """
 
408
 
 
409
    takes_args = ['dir+']
 
410
    encoding_type = 'replace'
 
411
 
 
412
    def run(self, dir_list):
 
413
        for d in dir_list:
 
414
            os.mkdir(d)
 
415
            wt, dd = WorkingTree.open_containing(d)
 
416
            wt.add([dd])
 
417
            self.outf.write('added %s\n' % d)
 
418
 
 
419
 
 
420
class cmd_relpath(Command):
 
421
    """Show path of a file relative to root"""
 
422
 
 
423
    takes_args = ['filename']
 
424
    hidden = True
 
425
    
 
426
    @display_command
 
427
    def run(self, filename):
 
428
        # TODO: jam 20050106 Can relpath return a munged path if
 
429
        #       sys.stdout encoding cannot represent it?
 
430
        tree, relpath = WorkingTree.open_containing(filename)
 
431
        self.outf.write(relpath)
 
432
        self.outf.write('\n')
 
433
 
 
434
 
 
435
class cmd_inventory(Command):
 
436
    """Show inventory of the current working copy or a revision.
 
437
 
 
438
    It is possible to limit the output to a particular entry
 
439
    type using the --kind option.  For example: --kind file.
 
440
 
 
441
    It is also possible to restrict the list of files to a specific
 
442
    set. For example: bzr inventory --show-ids this/file
 
443
    """
 
444
 
 
445
    hidden = True
 
446
    _see_also = ['ls']
 
447
    takes_options = [
 
448
        'revision',
 
449
        'show-ids',
 
450
        Option('kind',
 
451
               help='List entries of a particular kind: file, directory, symlink.',
 
452
               type=unicode),
 
453
        ]
 
454
    takes_args = ['file*']
 
455
 
 
456
    @display_command
 
457
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
458
        if kind and kind not in ['file', 'directory', 'symlink']:
 
459
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
460
 
 
461
        work_tree, file_list = tree_files(file_list)
 
462
        work_tree.lock_read()
 
463
        try:
 
464
            if revision is not None:
 
465
                if len(revision) > 1:
 
466
                    raise errors.BzrCommandError(
 
467
                        'bzr inventory --revision takes exactly one revision'
 
468
                        ' identifier')
 
469
                revision_id = revision[0].in_history(work_tree.branch).rev_id
 
470
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
471
 
 
472
                extra_trees = [work_tree]
 
473
                tree.lock_read()
 
474
            else:
 
475
                tree = work_tree
 
476
                extra_trees = []
 
477
 
 
478
            if file_list is not None:
 
479
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
480
                                          require_versioned=True)
 
481
                # find_ids_across_trees may include some paths that don't
 
482
                # exist in 'tree'.
 
483
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
484
                                 for file_id in file_ids if file_id in tree)
 
485
            else:
 
486
                entries = tree.inventory.entries()
 
487
        finally:
 
488
            tree.unlock()
 
489
            if tree is not work_tree:
 
490
                work_tree.unlock()
 
491
 
 
492
        for path, entry in entries:
 
493
            if kind and kind != entry.kind:
 
494
                continue
 
495
            if show_ids:
 
496
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
497
            else:
 
498
                self.outf.write(path)
 
499
                self.outf.write('\n')
 
500
 
 
501
 
 
502
class cmd_mv(Command):
 
503
    """Move or rename a file.
 
504
 
 
505
    :Usage:
 
506
        bzr mv OLDNAME NEWNAME
 
507
 
 
508
        bzr mv SOURCE... DESTINATION
 
509
 
 
510
    If the last argument is a versioned directory, all the other names
 
511
    are moved into it.  Otherwise, there must be exactly two arguments
 
512
    and the file is changed to a new name.
 
513
 
 
514
    If OLDNAME does not exist on the filesystem but is versioned and
 
515
    NEWNAME does exist on the filesystem but is not versioned, mv
 
516
    assumes that the file has been manually moved and only updates
 
517
    its internal inventory to reflect that change.
 
518
    The same is valid when moving many SOURCE files to a DESTINATION.
 
519
 
 
520
    Files cannot be moved between branches.
 
521
    """
 
522
 
 
523
    takes_args = ['names*']
 
524
    takes_options = [Option("after", help="Move only the bzr identifier"
 
525
        " of the file, because the file has already been moved."),
 
526
        ]
 
527
    aliases = ['move', 'rename']
 
528
    encoding_type = 'replace'
 
529
 
 
530
    def run(self, names_list, after=False):
 
531
        if names_list is None:
 
532
            names_list = []
 
533
 
 
534
        if len(names_list) < 2:
 
535
            raise errors.BzrCommandError("missing file argument")
 
536
        tree, rel_names = tree_files(names_list)
 
537
        
 
538
        if os.path.isdir(names_list[-1]):
 
539
            # move into existing directory
 
540
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
541
                self.outf.write("%s => %s\n" % pair)
 
542
        else:
 
543
            if len(names_list) != 2:
 
544
                raise errors.BzrCommandError('to mv multiple files the'
 
545
                                             ' destination must be a versioned'
 
546
                                             ' directory')
 
547
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
548
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
549
            
 
550
    
 
551
class cmd_pull(Command):
 
552
    """Turn this branch into a mirror of another branch.
 
553
 
 
554
    This command only works on branches that have not diverged.  Branches are
 
555
    considered diverged if the destination branch's most recent commit is one
 
556
    that has not been merged (directly or indirectly) into the parent.
 
557
 
 
558
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
559
    from one into the other.  Once one branch has merged, the other should
 
560
    be able to pull it again.
 
561
 
 
562
    If you want to forget your local changes and just update your branch to
 
563
    match the remote one, use pull --overwrite.
 
564
 
 
565
    If there is no default location set, the first pull will set it.  After
 
566
    that, you can omit the location to use the default.  To change the
 
567
    default, use --remember. The value will only be saved if the remote
 
568
    location can be accessed.
 
569
    """
 
570
 
 
571
    _see_also = ['push', 'update', 'status-flags']
 
572
    takes_options = ['remember', 'overwrite', 'revision',
 
573
        custom_help('verbose',
 
574
            help='Show logs of pulled revisions.'),
 
575
        Option('directory',
 
576
            help='Branch to pull into, '
 
577
                 'rather than the one containing the working directory.',
 
578
            short_name='d',
 
579
            type=unicode,
 
580
            ),
 
581
        ]
 
582
    takes_args = ['location?']
 
583
    encoding_type = 'replace'
 
584
 
 
585
    def run(self, location=None, remember=False, overwrite=False,
 
586
            revision=None, verbose=False,
 
587
            directory=None):
 
588
        # FIXME: too much stuff is in the command class
 
589
        revision_id = None
 
590
        mergeable = None
 
591
        if directory is None:
 
592
            directory = u'.'
 
593
        try:
 
594
            tree_to = WorkingTree.open_containing(directory)[0]
 
595
            branch_to = tree_to.branch
 
596
        except errors.NoWorkingTree:
 
597
            tree_to = None
 
598
            branch_to = Branch.open_containing(directory)[0]
 
599
 
 
600
        possible_transports = []
 
601
        if location is not None:
 
602
            mergeable, location_transport = _get_mergeable_helper(location)
 
603
            possible_transports.append(location_transport)
 
604
 
 
605
        stored_loc = branch_to.get_parent()
 
606
        if location is None:
 
607
            if stored_loc is None:
 
608
                raise errors.BzrCommandError("No pull location known or"
 
609
                                             " specified.")
 
610
            else:
 
611
                display_url = urlutils.unescape_for_display(stored_loc,
 
612
                        self.outf.encoding)
 
613
                if not is_quiet():
 
614
                    self.outf.write("Using saved location: %s\n" % display_url)
 
615
                location = stored_loc
 
616
                location_transport = transport.get_transport(
 
617
                    location, possible_transports=possible_transports)
 
618
 
 
619
        if mergeable is not None:
 
620
            if revision is not None:
 
621
                raise errors.BzrCommandError(
 
622
                    'Cannot use -r with merge directives or bundles')
 
623
            mergeable.install_revisions(branch_to.repository)
 
624
            base_revision_id, revision_id, verified = \
 
625
                mergeable.get_merge_request(branch_to.repository)
 
626
            branch_from = branch_to
 
627
        else:
 
628
            branch_from = Branch.open_from_transport(location_transport)
 
629
 
 
630
            if branch_to.get_parent() is None or remember:
 
631
                branch_to.set_parent(branch_from.base)
 
632
 
 
633
        if revision is not None:
 
634
            if len(revision) == 1:
 
635
                revision_id = revision[0].in_history(branch_from).rev_id
 
636
            else:
 
637
                raise errors.BzrCommandError(
 
638
                    'bzr pull --revision takes one value.')
 
639
 
 
640
        if verbose:
 
641
            old_rh = branch_to.revision_history()
 
642
        if tree_to is not None:
 
643
            change_reporter = delta._ChangeReporter(
 
644
                unversioned_filter=tree_to.is_ignored)
 
645
            result = tree_to.pull(branch_from, overwrite, revision_id,
 
646
                                  change_reporter,
 
647
                                  possible_transports=possible_transports)
 
648
        else:
 
649
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
650
 
 
651
        result.report(self.outf)
 
652
        if verbose:
 
653
            new_rh = branch_to.revision_history()
 
654
            log.show_changed_revisions(branch_to, old_rh, new_rh,
 
655
                                       to_file=self.outf)
 
656
 
 
657
 
 
658
class cmd_push(Command):
 
659
    """Update a mirror of this branch.
 
660
    
 
661
    The target branch will not have its working tree populated because this
 
662
    is both expensive, and is not supported on remote file systems.
 
663
    
 
664
    Some smart servers or protocols *may* put the working tree in place in
 
665
    the future.
 
666
 
 
667
    This command only works on branches that have not diverged.  Branches are
 
668
    considered diverged if the destination branch's most recent commit is one
 
669
    that has not been merged (directly or indirectly) by the source branch.
 
670
 
 
671
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
672
    the other branch completely, discarding its unmerged changes.
 
673
    
 
674
    If you want to ensure you have the different changes in the other branch,
 
675
    do a merge (see bzr help merge) from the other branch, and commit that.
 
676
    After that you will be able to do a push without '--overwrite'.
 
677
 
 
678
    If there is no default push location set, the first push will set it.
 
679
    After that, you can omit the location to use the default.  To change the
 
680
    default, use --remember. The value will only be saved if the remote
 
681
    location can be accessed.
 
682
    """
 
683
 
 
684
    _see_also = ['pull', 'update', 'working-trees']
 
685
    takes_options = ['remember', 'overwrite', 'verbose',
 
686
        Option('create-prefix',
 
687
               help='Create the path leading up to the branch '
 
688
                    'if it does not already exist.'),
 
689
        Option('directory',
 
690
            help='Branch to push from, '
 
691
                 'rather than the one containing the working directory.',
 
692
            short_name='d',
 
693
            type=unicode,
 
694
            ),
 
695
        Option('use-existing-dir',
 
696
               help='By default push will fail if the target'
 
697
                    ' directory exists, but does not already'
 
698
                    ' have a control directory.  This flag will'
 
699
                    ' allow push to proceed.'),
 
700
        ]
 
701
    takes_args = ['location?']
 
702
    encoding_type = 'replace'
 
703
 
 
704
    def run(self, location=None, remember=False, overwrite=False,
 
705
            create_prefix=False, verbose=False,
 
706
            use_existing_dir=False,
 
707
            directory=None):
 
708
        # FIXME: Way too big!  Put this into a function called from the
 
709
        # command.
 
710
        if directory is None:
 
711
            directory = '.'
 
712
        br_from = Branch.open_containing(directory)[0]
 
713
        stored_loc = br_from.get_push_location()
 
714
        if location is None:
 
715
            if stored_loc is None:
 
716
                raise errors.BzrCommandError("No push location known or specified.")
 
717
            else:
 
718
                display_url = urlutils.unescape_for_display(stored_loc,
 
719
                        self.outf.encoding)
 
720
                self.outf.write("Using saved location: %s\n" % display_url)
 
721
                location = stored_loc
 
722
 
 
723
        to_transport = transport.get_transport(location)
 
724
 
 
725
        br_to = repository_to = dir_to = None
 
726
        try:
 
727
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
728
        except errors.NotBranchError:
 
729
            pass # Didn't find anything
 
730
        else:
 
731
            # If we can open a branch, use its direct repository, otherwise see
 
732
            # if there is a repository without a branch.
 
733
            try:
 
734
                br_to = dir_to.open_branch()
 
735
            except errors.NotBranchError:
 
736
                # Didn't find a branch, can we find a repository?
 
737
                try:
 
738
                    repository_to = dir_to.find_repository()
 
739
                except errors.NoRepositoryPresent:
 
740
                    pass
 
741
            else:
 
742
                # Found a branch, so we must have found a repository
 
743
                repository_to = br_to.repository
 
744
        push_result = None
 
745
        if verbose:
 
746
            old_rh = []
 
747
        if dir_to is None:
 
748
            # The destination doesn't exist; create it.
 
749
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
750
            #      common helper function
 
751
 
 
752
            def make_directory(transport):
 
753
                transport.mkdir('.')
 
754
                return transport
 
755
 
 
756
            def redirected(redirected_transport, e, redirection_notice):
 
757
                return transport.get_transport(e.get_target_url())
 
758
 
 
759
            try:
 
760
                to_transport = transport.do_catching_redirections(
 
761
                    make_directory, to_transport, redirected)
 
762
            except errors.FileExists:
 
763
                if not use_existing_dir:
 
764
                    raise errors.BzrCommandError("Target directory %s"
 
765
                         " already exists, but does not have a valid .bzr"
 
766
                         " directory. Supply --use-existing-dir to push"
 
767
                         " there anyway." % location)
 
768
            except errors.NoSuchFile:
 
769
                if not create_prefix:
 
770
                    raise errors.BzrCommandError("Parent directory of %s"
 
771
                        " does not exist."
 
772
                        "\nYou may supply --create-prefix to create all"
 
773
                        " leading parent directories."
 
774
                        % location)
 
775
                _create_prefix(to_transport)
 
776
            except errors.TooManyRedirections:
 
777
                raise errors.BzrCommandError("Too many redirections trying "
 
778
                                             "to make %s." % location)
 
779
 
 
780
            # Now the target directory exists, but doesn't have a .bzr
 
781
            # directory. So we need to create it, along with any work to create
 
782
            # all of the dependent branches, etc.
 
783
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
784
                revision_id=br_from.last_revision())
 
785
            br_to = dir_to.open_branch()
 
786
            # TODO: Some more useful message about what was copied
 
787
            note('Created new branch.')
 
788
            # We successfully created the target, remember it
 
789
            if br_from.get_push_location() is None or remember:
 
790
                br_from.set_push_location(br_to.base)
 
791
        elif repository_to is None:
 
792
            # we have a bzrdir but no branch or repository
 
793
            # XXX: Figure out what to do other than complain.
 
794
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
795
                " directory, but not a branch or repository. This is an"
 
796
                " unsupported configuration. Please move the target directory"
 
797
                " out of the way and try again."
 
798
                % location)
 
799
        elif br_to is None:
 
800
            # We have a repository but no branch, copy the revisions, and then
 
801
            # create a branch.
 
802
            last_revision_id = br_from.last_revision()
 
803
            repository_to.fetch(br_from.repository,
 
804
                                revision_id=last_revision_id)
 
805
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
 
806
            note('Created new branch.')
 
807
            if br_from.get_push_location() is None or remember:
 
808
                br_from.set_push_location(br_to.base)
 
809
        else: # We have a valid to branch
 
810
            # We were able to connect to the remote location, so remember it
 
811
            # we don't need to successfully push because of possible divergence.
 
812
            if br_from.get_push_location() is None or remember:
 
813
                br_from.set_push_location(br_to.base)
 
814
            if verbose:
 
815
                old_rh = br_to.revision_history()
 
816
            try:
 
817
                try:
 
818
                    tree_to = dir_to.open_workingtree()
 
819
                except errors.NotLocalUrl:
 
820
                    warning("This transport does not update the working " 
 
821
                            "tree of: %s. See 'bzr help working-trees' for "
 
822
                            "more information." % br_to.base)
 
823
                    push_result = br_from.push(br_to, overwrite)
 
824
                except errors.NoWorkingTree:
 
825
                    push_result = br_from.push(br_to, overwrite)
 
826
                else:
 
827
                    tree_to.lock_write()
 
828
                    try:
 
829
                        push_result = br_from.push(tree_to.branch, overwrite)
 
830
                        tree_to.update()
 
831
                    finally:
 
832
                        tree_to.unlock()
 
833
            except errors.DivergedBranches:
 
834
                raise errors.BzrCommandError('These branches have diverged.'
 
835
                                        '  Try using "merge" and then "push".')
 
836
        if push_result is not None:
 
837
            push_result.report(self.outf)
 
838
        elif verbose:
 
839
            new_rh = br_to.revision_history()
 
840
            if old_rh != new_rh:
 
841
                # Something changed
 
842
                from bzrlib.log import show_changed_revisions
 
843
                show_changed_revisions(br_to, old_rh, new_rh,
 
844
                                       to_file=self.outf)
 
845
        else:
 
846
            # we probably did a clone rather than a push, so a message was
 
847
            # emitted above
 
848
            pass
 
849
 
 
850
 
 
851
class cmd_branch(Command):
 
852
    """Create a new copy of a branch.
 
853
 
 
854
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
855
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
856
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
857
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
858
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
859
    create ./foo-bar.
 
860
 
 
861
    To retrieve the branch as of a particular revision, supply the --revision
 
862
    parameter, as in "branch foo/bar -r 5".
 
863
    """
 
864
 
 
865
    _see_also = ['checkout']
 
866
    takes_args = ['from_location', 'to_location?']
 
867
    takes_options = ['revision']
 
868
    aliases = ['get', 'clone']
 
869
 
 
870
    def run(self, from_location, to_location=None, revision=None):
 
871
        from bzrlib.tag import _merge_tags_if_possible
 
872
        if revision is None:
 
873
            revision = [None]
 
874
        elif len(revision) > 1:
 
875
            raise errors.BzrCommandError(
 
876
                'bzr branch --revision takes exactly 1 revision value')
 
877
 
 
878
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
879
            from_location)
 
880
        br_from.lock_read()
 
881
        try:
 
882
            if len(revision) == 1 and revision[0] is not None:
 
883
                revision_id = revision[0].in_history(br_from)[1]
 
884
            else:
 
885
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
886
                # None or perhaps NULL_REVISION to mean copy nothing
 
887
                # RBC 20060209
 
888
                revision_id = br_from.last_revision()
 
889
            if to_location is None:
 
890
                to_location = urlutils.derive_to_location(from_location)
 
891
                name = None
 
892
            else:
 
893
                name = os.path.basename(to_location) + '\n'
 
894
 
 
895
            to_transport = transport.get_transport(to_location)
 
896
            try:
 
897
                to_transport.mkdir('.')
 
898
            except errors.FileExists:
 
899
                raise errors.BzrCommandError('Target directory "%s" already'
 
900
                                             ' exists.' % to_location)
 
901
            except errors.NoSuchFile:
 
902
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
903
                                             % to_location)
 
904
            try:
 
905
                # preserve whatever source format we have.
 
906
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
907
                                            possible_transports=[to_transport],
 
908
                                            accelerator_tree=accelerator_tree)
 
909
                branch = dir.open_branch()
 
910
            except errors.NoSuchRevision:
 
911
                to_transport.delete_tree('.')
 
912
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
913
                raise errors.BzrCommandError(msg)
 
914
            if name:
 
915
                branch.control_files.put_utf8('branch-name', name)
 
916
            _merge_tags_if_possible(br_from, branch)
 
917
            note('Branched %d revision(s).' % branch.revno())
 
918
        finally:
 
919
            br_from.unlock()
 
920
 
 
921
 
 
922
class cmd_checkout(Command):
 
923
    """Create a new checkout of an existing branch.
 
924
 
 
925
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
926
    the branch found in '.'. This is useful if you have removed the working tree
 
927
    or if it was never created - i.e. if you pushed the branch to its current
 
928
    location using SFTP.
 
929
    
 
930
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
931
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
932
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
933
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
934
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
935
    create ./foo-bar.
 
936
 
 
937
    To retrieve the branch as of a particular revision, supply the --revision
 
938
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
939
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
940
    code.)
 
941
    """
 
942
 
 
943
    _see_also = ['checkouts', 'branch']
 
944
    takes_args = ['branch_location?', 'to_location?']
 
945
    takes_options = ['revision',
 
946
                     Option('lightweight',
 
947
                            help="Perform a lightweight checkout.  Lightweight "
 
948
                                 "checkouts depend on access to the branch for "
 
949
                                 "every operation.  Normal checkouts can perform "
 
950
                                 "common operations like diff and status without "
 
951
                                 "such access, and also support local commits."
 
952
                            ),
 
953
                     Option('files-from',
 
954
                            help="Get file contents from this tree.", type=str)
 
955
                     ]
 
956
    aliases = ['co']
 
957
 
 
958
    def run(self, branch_location=None, to_location=None, revision=None,
 
959
            lightweight=False, files_from=None):
 
960
        if revision is None:
 
961
            revision = [None]
 
962
        elif len(revision) > 1:
 
963
            raise errors.BzrCommandError(
 
964
                'bzr checkout --revision takes exactly 1 revision value')
 
965
        if branch_location is None:
 
966
            branch_location = osutils.getcwd()
 
967
            to_location = branch_location
 
968
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
969
            branch_location)
 
970
        if files_from is not None:
 
971
            accelerator_tree = WorkingTree.open(files_from)
 
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('load-list', type=str, argname='TESTLISTFILE',
 
2603
                            help='Load a test id list from a text file.'),
 
2604
                     ]
 
2605
    encoding_type = 'replace'
 
2606
 
 
2607
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2608
            transport=None, benchmark=None,
 
2609
            lsprof_timed=None, cache_dir=None,
 
2610
            first=False, list_only=False,
 
2611
            randomize=None, exclude=None, strict=False,
 
2612
            load_list=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
                              load_list=load_list,
 
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
    encoding_type = 'exact'
 
2764
    _see_also = ['update', 'remerge', 'status-flags']
 
2765
    takes_args = ['branch?']
 
2766
    takes_options = [
 
2767
        'change',
 
2768
        'revision',
 
2769
        Option('force',
 
2770
               help='Merge even if the destination tree has uncommitted changes.'),
 
2771
        'merge-type',
 
2772
        'reprocess',
 
2773
        'remember',
 
2774
        Option('show-base', help="Show base revision text in "
 
2775
               "conflicts."),
 
2776
        Option('uncommitted', help='Apply uncommitted changes'
 
2777
               ' from a working copy, instead of branch changes.'),
 
2778
        Option('pull', help='If the destination is already'
 
2779
                ' completely merged into the source, pull from the'
 
2780
                ' source rather than merging.  When this happens,'
 
2781
                ' you do not need to commit the result.'),
 
2782
        Option('directory',
 
2783
               help='Branch to merge into, '
 
2784
                    'rather than the one containing the working directory.',
 
2785
               short_name='d',
 
2786
               type=unicode,
 
2787
               ),
 
2788
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
2789
    ]
 
2790
 
 
2791
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2792
            show_base=False, reprocess=False, remember=False,
 
2793
            uncommitted=False, pull=False,
 
2794
            directory=None,
 
2795
            preview=False,
 
2796
            ):
 
2797
        # This is actually a branch (or merge-directive) *location*.
 
2798
        location = branch
 
2799
        del branch
 
2800
 
 
2801
        if merge_type is None:
 
2802
            merge_type = _mod_merge.Merge3Merger
 
2803
 
 
2804
        if directory is None: directory = u'.'
 
2805
        possible_transports = []
 
2806
        merger = None
 
2807
        allow_pending = True
 
2808
        verified = 'inapplicable'
 
2809
        tree = WorkingTree.open_containing(directory)[0]
 
2810
        change_reporter = delta._ChangeReporter(
 
2811
            unversioned_filter=tree.is_ignored)
 
2812
        cleanups = []
 
2813
        try:
 
2814
            pb = ui.ui_factory.nested_progress_bar()
 
2815
            cleanups.append(pb.finished)
 
2816
            tree.lock_write()
 
2817
            cleanups.append(tree.unlock)
 
2818
            if location is not None:
 
2819
                mergeable, other_transport = _get_mergeable_helper(location)
 
2820
                if mergeable:
 
2821
                    if uncommitted:
 
2822
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2823
                            ' with bundles or merge directives.')
 
2824
 
 
2825
                    if revision is not None:
 
2826
                        raise errors.BzrCommandError(
 
2827
                            'Cannot use -r with merge directives or bundles')
 
2828
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2829
                       mergeable, pb)
 
2830
                possible_transports.append(other_transport)
 
2831
 
 
2832
            if merger is None and uncommitted:
 
2833
                if revision is not None and len(revision) > 0:
 
2834
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2835
                        ' --revision at the same time.')
 
2836
                location = self._select_branch_location(tree, location)[0]
 
2837
                other_tree, other_path = WorkingTree.open_containing(location)
 
2838
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2839
                    pb)
 
2840
                allow_pending = False
 
2841
                if other_path != '':
 
2842
                    merger.interesting_files = [other_path]
 
2843
 
 
2844
            if merger is None:
 
2845
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2846
                    location, revision, remember, possible_transports, pb)
 
2847
 
 
2848
            merger.merge_type = merge_type
 
2849
            merger.reprocess = reprocess
 
2850
            merger.show_base = show_base
 
2851
            self.sanity_check_merger(merger)
 
2852
            if (merger.base_rev_id == merger.other_rev_id and
 
2853
                merger.other_rev_id != None):
 
2854
                note('Nothing to do.')
 
2855
                return 0
 
2856
            if pull:
 
2857
                if merger.interesting_files is not None:
 
2858
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2859
                if (merger.base_rev_id == tree.last_revision()):
 
2860
                    result = tree.pull(merger.other_branch, False,
 
2861
                                       merger.other_rev_id)
 
2862
                    result.report(self.outf)
 
2863
                    return 0
 
2864
            merger.check_basis(not force)
 
2865
            if preview:
 
2866
                return self._do_preview(merger)
 
2867
            else:
 
2868
                return self._do_merge(merger, change_reporter, allow_pending,
 
2869
                                      verified)
 
2870
        finally:
 
2871
            for cleanup in reversed(cleanups):
 
2872
                cleanup()
 
2873
 
 
2874
    def _do_preview(self, merger):
 
2875
        from bzrlib.diff import show_diff_trees
 
2876
        tree_merger = merger.make_merger()
 
2877
        tt = tree_merger.make_preview_transform()
 
2878
        try:
 
2879
            result_tree = tt.get_preview_tree()
 
2880
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2881
                            old_label='', new_label='')
 
2882
        finally:
 
2883
            tt.finalize()
 
2884
 
 
2885
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
2886
        merger.change_reporter = change_reporter
 
2887
        conflict_count = merger.do_merge()
 
2888
        if allow_pending:
 
2889
            merger.set_pending()
 
2890
        if verified == 'failed':
 
2891
            warning('Preview patch does not match changes')
 
2892
        if conflict_count != 0:
 
2893
            return 1
 
2894
        else:
 
2895
            return 0
 
2896
 
 
2897
    def sanity_check_merger(self, merger):
 
2898
        if (merger.show_base and
 
2899
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2900
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2901
                                         " merge type. %s" % merger.merge_type)
 
2902
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2903
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2904
                                         " for merge type %s." %
 
2905
                                         merger.merge_type)
 
2906
        if merger.reprocess and merger.show_base:
 
2907
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2908
                                         " show base.")
 
2909
 
 
2910
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2911
                                possible_transports, pb):
 
2912
        """Produce a merger from a location, assuming it refers to a branch."""
 
2913
        from bzrlib.tag import _merge_tags_if_possible
 
2914
        assert revision is None or len(revision) < 3
 
2915
        # find the branch locations
 
2916
        other_loc, user_location = self._select_branch_location(tree, location,
 
2917
            revision, -1)
 
2918
        if revision is not None and len(revision) == 2:
 
2919
            base_loc, _unused = self._select_branch_location(tree,
 
2920
                location, revision, 0)
 
2921
        else:
 
2922
            base_loc = other_loc
 
2923
        # Open the branches
 
2924
        other_branch, other_path = Branch.open_containing(other_loc,
 
2925
            possible_transports)
 
2926
        if base_loc == other_loc:
 
2927
            base_branch = other_branch
 
2928
        else:
 
2929
            base_branch, base_path = Branch.open_containing(base_loc,
 
2930
                possible_transports)
 
2931
        # Find the revision ids
 
2932
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2933
            other_revision_id = _mod_revision.ensure_null(
 
2934
                other_branch.last_revision())
 
2935
        else:
 
2936
            other_revision_id = \
 
2937
                _mod_revision.ensure_null(
 
2938
                    revision[-1].in_history(other_branch).rev_id)
 
2939
        if (revision is not None and len(revision) == 2
 
2940
            and revision[0] is not None):
 
2941
            base_revision_id = \
 
2942
                _mod_revision.ensure_null(
 
2943
                    revision[0].in_history(base_branch).rev_id)
 
2944
        else:
 
2945
            base_revision_id = None
 
2946
        # Remember where we merge from
 
2947
        if ((remember or tree.branch.get_submit_branch() is None) and
 
2948
             user_location is not None):
 
2949
            tree.branch.set_submit_branch(other_branch.base)
 
2950
        _merge_tags_if_possible(other_branch, tree.branch)
 
2951
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
2952
            other_revision_id, base_revision_id, other_branch, base_branch)
 
2953
        if other_path != '':
 
2954
            allow_pending = False
 
2955
            merger.interesting_files = [other_path]
 
2956
        else:
 
2957
            allow_pending = True
 
2958
        return merger, allow_pending
 
2959
 
 
2960
    def _select_branch_location(self, tree, user_location, revision=None,
 
2961
                                index=None):
 
2962
        """Select a branch location, according to possible inputs.
 
2963
 
 
2964
        If provided, branches from ``revision`` are preferred.  (Both
 
2965
        ``revision`` and ``index`` must be supplied.)
 
2966
 
 
2967
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
2968
        ``submit`` or ``parent`` location is used, and a note is printed.
 
2969
 
 
2970
        :param tree: The working tree to select a branch for merging into
 
2971
        :param location: The location entered by the user
 
2972
        :param revision: The revision parameter to the command
 
2973
        :param index: The index to use for the revision parameter.  Negative
 
2974
            indices are permitted.
 
2975
        :return: (selected_location, user_location).  The default location
 
2976
            will be the user-entered location.
 
2977
        """
 
2978
        if (revision is not None and index is not None
 
2979
            and revision[index] is not None):
 
2980
            branch = revision[index].get_branch()
 
2981
            if branch is not None:
 
2982
                return branch, branch
 
2983
        if user_location is None:
 
2984
            location = self._get_remembered(tree, 'Merging from')
 
2985
        else:
 
2986
            location = user_location
 
2987
        return location, user_location
 
2988
 
 
2989
    def _get_remembered(self, tree, verb_string):
 
2990
        """Use tree.branch's parent if none was supplied.
 
2991
 
 
2992
        Report if the remembered location was used.
 
2993
        """
 
2994
        stored_location = tree.branch.get_submit_branch()
 
2995
        if stored_location is None:
 
2996
            stored_location = tree.branch.get_parent()
 
2997
        mutter("%s", stored_location)
 
2998
        if stored_location is None:
 
2999
            raise errors.BzrCommandError("No location specified or remembered")
 
3000
        display_url = urlutils.unescape_for_display(stored_location,
 
3001
            self.outf.encoding)
 
3002
        self.outf.write("%s remembered location %s\n" % (verb_string,
 
3003
            display_url))
 
3004
        return stored_location
 
3005
 
 
3006
 
 
3007
class cmd_remerge(Command):
 
3008
    """Redo a merge.
 
3009
 
 
3010
    Use this if you want to try a different merge technique while resolving
 
3011
    conflicts.  Some merge techniques are better than others, and remerge 
 
3012
    lets you try different ones on different files.
 
3013
 
 
3014
    The options for remerge have the same meaning and defaults as the ones for
 
3015
    merge.  The difference is that remerge can (only) be run when there is a
 
3016
    pending merge, and it lets you specify particular files.
 
3017
 
 
3018
    :Examples:
 
3019
        Re-do the merge of all conflicted files, and show the base text in
 
3020
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3021
      
 
3022
            bzr remerge --show-base
 
3023
 
 
3024
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3025
        additional processing to reduce the size of conflict regions::
 
3026
      
 
3027
            bzr remerge --merge-type weave --reprocess foobar
 
3028
    """
 
3029
    takes_args = ['file*']
 
3030
    takes_options = [
 
3031
            'merge-type',
 
3032
            'reprocess',
 
3033
            Option('show-base',
 
3034
                   help="Show base revision text in conflicts."),
 
3035
            ]
 
3036
 
 
3037
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3038
            reprocess=False):
 
3039
        if merge_type is None:
 
3040
            merge_type = _mod_merge.Merge3Merger
 
3041
        tree, file_list = tree_files(file_list)
 
3042
        tree.lock_write()
 
3043
        try:
 
3044
            parents = tree.get_parent_ids()
 
3045
            if len(parents) != 2:
 
3046
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3047
                                             " merges.  Not cherrypicking or"
 
3048
                                             " multi-merges.")
 
3049
            repository = tree.branch.repository
 
3050
            interesting_ids = None
 
3051
            new_conflicts = []
 
3052
            conflicts = tree.conflicts()
 
3053
            if file_list is not None:
 
3054
                interesting_ids = set()
 
3055
                for filename in file_list:
 
3056
                    file_id = tree.path2id(filename)
 
3057
                    if file_id is None:
 
3058
                        raise errors.NotVersionedError(filename)
 
3059
                    interesting_ids.add(file_id)
 
3060
                    if tree.kind(file_id) != "directory":
 
3061
                        continue
 
3062
                    
 
3063
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3064
                        interesting_ids.add(ie.file_id)
 
3065
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3066
            else:
 
3067
                # Remerge only supports resolving contents conflicts
 
3068
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3069
                restore_files = [c.path for c in conflicts
 
3070
                                 if c.typestring in allowed_conflicts]
 
3071
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3072
            tree.set_conflicts(ConflictList(new_conflicts))
 
3073
            if file_list is not None:
 
3074
                restore_files = file_list
 
3075
            for filename in restore_files:
 
3076
                try:
 
3077
                    restore(tree.abspath(filename))
 
3078
                except errors.NotConflicted:
 
3079
                    pass
 
3080
            # Disable pending merges, because the file texts we are remerging
 
3081
            # have not had those merges performed.  If we use the wrong parents
 
3082
            # list, we imply that the working tree text has seen and rejected
 
3083
            # all the changes from the other tree, when in fact those changes
 
3084
            # have not yet been seen.
 
3085
            pb = ui.ui_factory.nested_progress_bar()
 
3086
            tree.set_parent_ids(parents[:1])
 
3087
            try:
 
3088
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3089
                                                             tree, parents[1])
 
3090
                merger.interesting_ids = interesting_ids
 
3091
                merger.merge_type = merge_type
 
3092
                merger.show_base = show_base
 
3093
                merger.reprocess = reprocess
 
3094
                conflicts = merger.do_merge()
 
3095
            finally:
 
3096
                tree.set_parent_ids(parents)
 
3097
                pb.finished()
 
3098
        finally:
 
3099
            tree.unlock()
 
3100
        if conflicts > 0:
 
3101
            return 1
 
3102
        else:
 
3103
            return 0
 
3104
 
 
3105
 
 
3106
class cmd_revert(Command):
 
3107
    """Revert files to a previous revision.
 
3108
 
 
3109
    Giving a list of files will revert only those files.  Otherwise, all files
 
3110
    will be reverted.  If the revision is not specified with '--revision', the
 
3111
    last committed revision is used.
 
3112
 
 
3113
    To remove only some changes, without reverting to a prior version, use
 
3114
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3115
    changes introduced by -2, without affecting the changes introduced by -1.
 
3116
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3117
    
 
3118
    By default, any files that have been manually changed will be backed up
 
3119
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3120
    '.~#~' appended to their name, where # is a number.
 
3121
 
 
3122
    When you provide files, you can use their current pathname or the pathname
 
3123
    from the target revision.  So you can use revert to "undelete" a file by
 
3124
    name.  If you name a directory, all the contents of that directory will be
 
3125
    reverted.
 
3126
 
 
3127
    Any files that have been newly added since that revision will be deleted,
 
3128
    with a backup kept if appropriate.  Directories containing unknown files
 
3129
    will not be deleted.
 
3130
 
 
3131
    The working tree contains a list of pending merged revisions, which will
 
3132
    be included as parents in the next commit.  Normally, revert clears that
 
3133
    list as well as reverting the files.  If any files are specified, revert
 
3134
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3135
    revert ." in the tree root to revert all files but keep the merge record,
 
3136
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3137
    reverting any files.
 
3138
    """
 
3139
 
 
3140
    _see_also = ['cat', 'export']
 
3141
    takes_options = [
 
3142
        'revision',
 
3143
        Option('no-backup', "Do not save backups of reverted files."),
 
3144
        Option('forget-merges',
 
3145
               'Remove pending merge marker, without changing any files.'),
 
3146
        ]
 
3147
    takes_args = ['file*']
 
3148
 
 
3149
    def run(self, revision=None, no_backup=False, file_list=None,
 
3150
            forget_merges=None):
 
3151
        tree, file_list = tree_files(file_list)
 
3152
        if forget_merges:
 
3153
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3154
        else:
 
3155
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3156
 
 
3157
    @staticmethod
 
3158
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3159
        if revision is None:
 
3160
            rev_id = tree.last_revision()
 
3161
        elif len(revision) != 1:
 
3162
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3163
        else:
 
3164
            rev_id = revision[0].in_history(tree.branch).rev_id
 
3165
        pb = ui.ui_factory.nested_progress_bar()
 
3166
        try:
 
3167
            tree.revert(file_list,
 
3168
                        tree.branch.repository.revision_tree(rev_id),
 
3169
                        not no_backup, pb, report_changes=True)
 
3170
        finally:
 
3171
            pb.finished()
 
3172
 
 
3173
 
 
3174
class cmd_assert_fail(Command):
 
3175
    """Test reporting of assertion failures"""
 
3176
    # intended just for use in testing
 
3177
 
 
3178
    hidden = True
 
3179
 
 
3180
    def run(self):
 
3181
        raise AssertionError("always fails")
 
3182
 
 
3183
 
 
3184
class cmd_help(Command):
 
3185
    """Show help on a command or other topic.
 
3186
    """
 
3187
 
 
3188
    _see_also = ['topics']
 
3189
    takes_options = [
 
3190
            Option('long', 'Show help on all commands.'),
 
3191
            ]
 
3192
    takes_args = ['topic?']
 
3193
    aliases = ['?', '--help', '-?', '-h']
 
3194
    
 
3195
    @display_command
 
3196
    def run(self, topic=None, long=False):
 
3197
        import bzrlib.help
 
3198
        if topic is None and long:
 
3199
            topic = "commands"
 
3200
        bzrlib.help.help(topic)
 
3201
 
 
3202
 
 
3203
class cmd_shell_complete(Command):
 
3204
    """Show appropriate completions for context.
 
3205
 
 
3206
    For a list of all available commands, say 'bzr shell-complete'.
 
3207
    """
 
3208
    takes_args = ['context?']
 
3209
    aliases = ['s-c']
 
3210
    hidden = True
 
3211
    
 
3212
    @display_command
 
3213
    def run(self, context=None):
 
3214
        import shellcomplete
 
3215
        shellcomplete.shellcomplete(context)
 
3216
 
 
3217
 
 
3218
class cmd_fetch(Command):
 
3219
    """Copy in history from another branch but don't merge it.
 
3220
 
 
3221
    This is an internal method used for pull and merge.
 
3222
    """
 
3223
    hidden = True
 
3224
    takes_args = ['from_branch', 'to_branch']
 
3225
    def run(self, from_branch, to_branch):
 
3226
        from bzrlib.fetch import Fetcher
 
3227
        from_b = Branch.open(from_branch)
 
3228
        to_b = Branch.open(to_branch)
 
3229
        Fetcher(to_b, from_b)
 
3230
 
 
3231
 
 
3232
class cmd_missing(Command):
 
3233
    """Show unmerged/unpulled revisions between two branches.
 
3234
    
 
3235
    OTHER_BRANCH may be local or remote.
 
3236
    """
 
3237
 
 
3238
    _see_also = ['merge', 'pull']
 
3239
    takes_args = ['other_branch?']
 
3240
    takes_options = [
 
3241
            Option('reverse', 'Reverse the order of revisions.'),
 
3242
            Option('mine-only',
 
3243
                   'Display changes in the local branch only.'),
 
3244
            Option('this' , 'Same as --mine-only.'),
 
3245
            Option('theirs-only',
 
3246
                   'Display changes in the remote branch only.'),
 
3247
            Option('other', 'Same as --theirs-only.'),
 
3248
            'log-format',
 
3249
            'show-ids',
 
3250
            'verbose'
 
3251
            ]
 
3252
    encoding_type = 'replace'
 
3253
 
 
3254
    @display_command
 
3255
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3256
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3257
            show_ids=False, verbose=False, this=False, other=False):
 
3258
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3259
 
 
3260
        if this:
 
3261
          mine_only = this
 
3262
        if other:
 
3263
          theirs_only = other
 
3264
 
 
3265
        local_branch = Branch.open_containing(u".")[0]
 
3266
        parent = local_branch.get_parent()
 
3267
        if other_branch is None:
 
3268
            other_branch = parent
 
3269
            if other_branch is None:
 
3270
                raise errors.BzrCommandError("No peer location known"
 
3271
                                             " or specified.")
 
3272
            display_url = urlutils.unescape_for_display(parent,
 
3273
                                                        self.outf.encoding)
 
3274
            self.outf.write("Using last location: " + display_url + "\n")
 
3275
 
 
3276
        remote_branch = Branch.open(other_branch)
 
3277
        if remote_branch.base == local_branch.base:
 
3278
            remote_branch = local_branch
 
3279
        local_branch.lock_read()
 
3280
        try:
 
3281
            remote_branch.lock_read()
 
3282
            try:
 
3283
                local_extra, remote_extra = find_unmerged(local_branch,
 
3284
                                                          remote_branch)
 
3285
                if log_format is None:
 
3286
                    registry = log.log_formatter_registry
 
3287
                    log_format = registry.get_default(local_branch)
 
3288
                lf = log_format(to_file=self.outf,
 
3289
                                show_ids=show_ids,
 
3290
                                show_timezone='original')
 
3291
                if reverse is False:
 
3292
                    local_extra.reverse()
 
3293
                    remote_extra.reverse()
 
3294
                if local_extra and not theirs_only:
 
3295
                    self.outf.write("You have %d extra revision(s):\n" %
 
3296
                                    len(local_extra))
 
3297
                    for revision in iter_log_revisions(local_extra,
 
3298
                                        local_branch.repository,
 
3299
                                        verbose):
 
3300
                        lf.log_revision(revision)
 
3301
                    printed_local = True
 
3302
                else:
 
3303
                    printed_local = False
 
3304
                if remote_extra and not mine_only:
 
3305
                    if printed_local is True:
 
3306
                        self.outf.write("\n\n\n")
 
3307
                    self.outf.write("You are missing %d revision(s):\n" %
 
3308
                                    len(remote_extra))
 
3309
                    for revision in iter_log_revisions(remote_extra,
 
3310
                                        remote_branch.repository,
 
3311
                                        verbose):
 
3312
                        lf.log_revision(revision)
 
3313
                if not remote_extra and not local_extra:
 
3314
                    status_code = 0
 
3315
                    self.outf.write("Branches are up to date.\n")
 
3316
                else:
 
3317
                    status_code = 1
 
3318
            finally:
 
3319
                remote_branch.unlock()
 
3320
        finally:
 
3321
            local_branch.unlock()
 
3322
        if not status_code and parent is None and other_branch is not None:
 
3323
            local_branch.lock_write()
 
3324
            try:
 
3325
                # handle race conditions - a parent might be set while we run.
 
3326
                if local_branch.get_parent() is None:
 
3327
                    local_branch.set_parent(remote_branch.base)
 
3328
            finally:
 
3329
                local_branch.unlock()
 
3330
        return status_code
 
3331
 
 
3332
 
 
3333
class cmd_pack(Command):
 
3334
    """Compress the data within a repository."""
 
3335
 
 
3336
    _see_also = ['repositories']
 
3337
    takes_args = ['branch_or_repo?']
 
3338
 
 
3339
    def run(self, branch_or_repo='.'):
 
3340
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3341
        try:
 
3342
            branch = dir.open_branch()
 
3343
            repository = branch.repository
 
3344
        except errors.NotBranchError:
 
3345
            repository = dir.open_repository()
 
3346
        repository.pack()
 
3347
 
 
3348
 
 
3349
class cmd_plugins(Command):
 
3350
    """List the installed plugins.
 
3351
    
 
3352
    This command displays the list of installed plugins including
 
3353
    version of plugin and a short description of each.
 
3354
 
 
3355
    --verbose shows the path where each plugin is located.
 
3356
 
 
3357
    A plugin is an external component for Bazaar that extends the
 
3358
    revision control system, by adding or replacing code in Bazaar.
 
3359
    Plugins can do a variety of things, including overriding commands,
 
3360
    adding new commands, providing additional network transports and
 
3361
    customizing log output.
 
3362
 
 
3363
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3364
    information on plugins including where to find them and how to
 
3365
    install them. Instructions are also provided there on how to
 
3366
    write new plugins using the Python programming language.
 
3367
    """
 
3368
    takes_options = ['verbose']
 
3369
 
 
3370
    @display_command
 
3371
    def run(self, verbose=False):
 
3372
        import bzrlib.plugin
 
3373
        from inspect import getdoc
 
3374
        result = []
 
3375
        for name, plugin in bzrlib.plugin.plugins().items():
 
3376
            version = plugin.__version__
 
3377
            if version == 'unknown':
 
3378
                version = ''
 
3379
            name_ver = '%s %s' % (name, version)
 
3380
            d = getdoc(plugin.module)
 
3381
            if d:
 
3382
                doc = d.split('\n')[0]
 
3383
            else:
 
3384
                doc = '(no description)'
 
3385
            result.append((name_ver, doc, plugin.path()))
 
3386
        for name_ver, doc, path in sorted(result):
 
3387
            print name_ver
 
3388
            print '   ', doc
 
3389
            if verbose:
 
3390
                print '   ', path
 
3391
            print
 
3392
 
 
3393
 
 
3394
class cmd_testament(Command):
 
3395
    """Show testament (signing-form) of a revision."""
 
3396
    takes_options = [
 
3397
            'revision',
 
3398
            Option('long', help='Produce long-format testament.'),
 
3399
            Option('strict',
 
3400
                   help='Produce a strict-format testament.')]
 
3401
    takes_args = ['branch?']
 
3402
    @display_command
 
3403
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3404
        from bzrlib.testament import Testament, StrictTestament
 
3405
        if strict is True:
 
3406
            testament_class = StrictTestament
 
3407
        else:
 
3408
            testament_class = Testament
 
3409
        b = WorkingTree.open_containing(branch)[0].branch
 
3410
        b.lock_read()
 
3411
        try:
 
3412
            if revision is None:
 
3413
                rev_id = b.last_revision()
 
3414
            else:
 
3415
                rev_id = revision[0].in_history(b).rev_id
 
3416
            t = testament_class.from_revision(b.repository, rev_id)
 
3417
            if long:
 
3418
                sys.stdout.writelines(t.as_text_lines())
 
3419
            else:
 
3420
                sys.stdout.write(t.as_short_text())
 
3421
        finally:
 
3422
            b.unlock()
 
3423
 
 
3424
 
 
3425
class cmd_annotate(Command):
 
3426
    """Show the origin of each line in a file.
 
3427
 
 
3428
    This prints out the given file with an annotation on the left side
 
3429
    indicating which revision, author and date introduced the change.
 
3430
 
 
3431
    If the origin is the same for a run of consecutive lines, it is 
 
3432
    shown only at the top, unless the --all option is given.
 
3433
    """
 
3434
    # TODO: annotate directories; showing when each file was last changed
 
3435
    # TODO: if the working copy is modified, show annotations on that 
 
3436
    #       with new uncommitted lines marked
 
3437
    aliases = ['ann', 'blame', 'praise']
 
3438
    takes_args = ['filename']
 
3439
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3440
                     Option('long', help='Show commit date in annotations.'),
 
3441
                     'revision',
 
3442
                     'show-ids',
 
3443
                     ]
 
3444
    encoding_type = 'exact'
 
3445
 
 
3446
    @display_command
 
3447
    def run(self, filename, all=False, long=False, revision=None,
 
3448
            show_ids=False):
 
3449
        from bzrlib.annotate import annotate_file
 
3450
        wt, branch, relpath = \
 
3451
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3452
        if wt is not None:
 
3453
            wt.lock_read()
 
3454
        else:
 
3455
            branch.lock_read()
 
3456
        try:
 
3457
            if revision is None:
 
3458
                revision_id = branch.last_revision()
 
3459
            elif len(revision) != 1:
 
3460
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3461
            else:
 
3462
                revision_id = revision[0].in_history(branch).rev_id
 
3463
            tree = branch.repository.revision_tree(revision_id)
 
3464
            if wt is not None:
 
3465
                file_id = wt.path2id(relpath)
 
3466
            else:
 
3467
                file_id = tree.path2id(relpath)
 
3468
            if file_id is None:
 
3469
                raise errors.NotVersionedError(filename)
 
3470
            file_version = tree.inventory[file_id].revision
 
3471
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3472
                          show_ids=show_ids)
 
3473
        finally:
 
3474
            if wt is not None:
 
3475
                wt.unlock()
 
3476
            else:
 
3477
                branch.unlock()
 
3478
 
 
3479
 
 
3480
class cmd_re_sign(Command):
 
3481
    """Create a digital signature for an existing revision."""
 
3482
    # TODO be able to replace existing ones.
 
3483
 
 
3484
    hidden = True # is this right ?
 
3485
    takes_args = ['revision_id*']
 
3486
    takes_options = ['revision']
 
3487
    
 
3488
    def run(self, revision_id_list=None, revision=None):
 
3489
        if revision_id_list is not None and revision is not None:
 
3490
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3491
        if revision_id_list is None and revision is None:
 
3492
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3493
        b = WorkingTree.open_containing(u'.')[0].branch
 
3494
        b.lock_write()
 
3495
        try:
 
3496
            return self._run(b, revision_id_list, revision)
 
3497
        finally:
 
3498
            b.unlock()
 
3499
 
 
3500
    def _run(self, b, revision_id_list, revision):
 
3501
        import bzrlib.gpg as gpg
 
3502
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3503
        if revision_id_list is not None:
 
3504
            b.repository.start_write_group()
 
3505
            try:
 
3506
                for revision_id in revision_id_list:
 
3507
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3508
            except:
 
3509
                b.repository.abort_write_group()
 
3510
                raise
 
3511
            else:
 
3512
                b.repository.commit_write_group()
 
3513
        elif revision is not None:
 
3514
            if len(revision) == 1:
 
3515
                revno, rev_id = revision[0].in_history(b)
 
3516
                b.repository.start_write_group()
 
3517
                try:
 
3518
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3519
                except:
 
3520
                    b.repository.abort_write_group()
 
3521
                    raise
 
3522
                else:
 
3523
                    b.repository.commit_write_group()
 
3524
            elif len(revision) == 2:
 
3525
                # are they both on rh- if so we can walk between them
 
3526
                # might be nice to have a range helper for arbitrary
 
3527
                # revision paths. hmm.
 
3528
                from_revno, from_revid = revision[0].in_history(b)
 
3529
                to_revno, to_revid = revision[1].in_history(b)
 
3530
                if to_revid is None:
 
3531
                    to_revno = b.revno()
 
3532
                if from_revno is None or to_revno is None:
 
3533
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3534
                b.repository.start_write_group()
 
3535
                try:
 
3536
                    for revno in range(from_revno, to_revno + 1):
 
3537
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3538
                                                   gpg_strategy)
 
3539
                except:
 
3540
                    b.repository.abort_write_group()
 
3541
                    raise
 
3542
                else:
 
3543
                    b.repository.commit_write_group()
 
3544
            else:
 
3545
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3546
 
 
3547
 
 
3548
class cmd_bind(Command):
 
3549
    """Convert the current branch into a checkout of the supplied branch.
 
3550
 
 
3551
    Once converted into a checkout, commits must succeed on the master branch
 
3552
    before they will be applied to the local branch.
 
3553
    """
 
3554
 
 
3555
    _see_also = ['checkouts', 'unbind']
 
3556
    takes_args = ['location?']
 
3557
    takes_options = []
 
3558
 
 
3559
    def run(self, location=None):
 
3560
        b, relpath = Branch.open_containing(u'.')
 
3561
        if location is None:
 
3562
            try:
 
3563
                location = b.get_old_bound_location()
 
3564
            except errors.UpgradeRequired:
 
3565
                raise errors.BzrCommandError('No location supplied.  '
 
3566
                    'This format does not remember old locations.')
 
3567
            else:
 
3568
                if location is None:
 
3569
                    raise errors.BzrCommandError('No location supplied and no '
 
3570
                        'previous location known')
 
3571
        b_other = Branch.open(location)
 
3572
        try:
 
3573
            b.bind(b_other)
 
3574
        except errors.DivergedBranches:
 
3575
            raise errors.BzrCommandError('These branches have diverged.'
 
3576
                                         ' Try merging, and then bind again.')
 
3577
 
 
3578
 
 
3579
class cmd_unbind(Command):
 
3580
    """Convert the current checkout into a regular branch.
 
3581
 
 
3582
    After unbinding, the local branch is considered independent and subsequent
 
3583
    commits will be local only.
 
3584
    """
 
3585
 
 
3586
    _see_also = ['checkouts', 'bind']
 
3587
    takes_args = []
 
3588
    takes_options = []
 
3589
 
 
3590
    def run(self):
 
3591
        b, relpath = Branch.open_containing(u'.')
 
3592
        if not b.unbind():
 
3593
            raise errors.BzrCommandError('Local branch is not bound')
 
3594
 
 
3595
 
 
3596
class cmd_uncommit(Command):
 
3597
    """Remove the last committed revision.
 
3598
 
 
3599
    --verbose will print out what is being removed.
 
3600
    --dry-run will go through all the motions, but not actually
 
3601
    remove anything.
 
3602
 
 
3603
    If --revision is specified, uncommit revisions to leave the branch at the
 
3604
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3605
    branch at revision 15.
 
3606
 
 
3607
    In the future, uncommit will create a revision bundle, which can then
 
3608
    be re-applied.
 
3609
    """
 
3610
 
 
3611
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3612
    # unreferenced information in 'branch-as-repository' branches.
 
3613
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3614
    # information in shared branches as well.
 
3615
    _see_also = ['commit']
 
3616
    takes_options = ['verbose', 'revision',
 
3617
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3618
                    Option('force', help='Say yes to all questions.')]
 
3619
    takes_args = ['location?']
 
3620
    aliases = []
 
3621
    encoding_type = 'replace'
 
3622
 
 
3623
    def run(self, location=None,
 
3624
            dry_run=False, verbose=False,
 
3625
            revision=None, force=False):
 
3626
        if location is None:
 
3627
            location = u'.'
 
3628
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3629
        try:
 
3630
            tree = control.open_workingtree()
 
3631
            b = tree.branch
 
3632
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3633
            tree = None
 
3634
            b = control.open_branch()
 
3635
 
 
3636
        if tree is not None:
 
3637
            tree.lock_write()
 
3638
        else:
 
3639
            b.lock_write()
 
3640
        try:
 
3641
            return self._run(b, tree, dry_run, verbose, revision, force)
 
3642
        finally:
 
3643
            if tree is not None:
 
3644
                tree.unlock()
 
3645
            else:
 
3646
                b.unlock()
 
3647
 
 
3648
    def _run(self, b, tree, dry_run, verbose, revision, force):
 
3649
        from bzrlib.log import log_formatter, show_log
 
3650
        from bzrlib.uncommit import uncommit
 
3651
 
 
3652
        last_revno, last_rev_id = b.last_revision_info()
 
3653
 
 
3654
        rev_id = None
 
3655
        if revision is None:
 
3656
            revno = last_revno
 
3657
            rev_id = last_rev_id
 
3658
        else:
 
3659
            # 'bzr uncommit -r 10' actually means uncommit
 
3660
            # so that the final tree is at revno 10.
 
3661
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3662
            # the revisions that are supplied.
 
3663
            # So we need to offset it by one
 
3664
            revno = revision[0].in_history(b).revno + 1
 
3665
            if revno <= last_revno:
 
3666
                rev_id = b.get_rev_id(revno)
 
3667
 
 
3668
        if rev_id is None or _mod_revision.is_null(rev_id):
 
3669
            self.outf.write('No revisions to uncommit.\n')
 
3670
            return 1
 
3671
 
 
3672
        lf = log_formatter('short',
 
3673
                           to_file=self.outf,
 
3674
                           show_timezone='original')
 
3675
 
 
3676
        show_log(b,
 
3677
                 lf,
 
3678
                 verbose=False,
 
3679
                 direction='forward',
 
3680
                 start_revision=revno,
 
3681
                 end_revision=last_revno)
 
3682
 
 
3683
        if dry_run:
 
3684
            print 'Dry-run, pretending to remove the above revisions.'
 
3685
            if not force:
 
3686
                val = raw_input('Press <enter> to continue')
 
3687
        else:
 
3688
            print 'The above revision(s) will be removed.'
 
3689
            if not force:
 
3690
                val = raw_input('Are you sure [y/N]? ')
 
3691
                if val.lower() not in ('y', 'yes'):
 
3692
                    print 'Canceled'
 
3693
                    return 0
 
3694
 
 
3695
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3696
                 revno=revno)
 
3697
 
 
3698
 
 
3699
class cmd_break_lock(Command):
 
3700
    """Break a dead lock on a repository, branch or working directory.
 
3701
 
 
3702
    CAUTION: Locks should only be broken when you are sure that the process
 
3703
    holding the lock has been stopped.
 
3704
 
 
3705
    You can get information on what locks are open via the 'bzr info' command.
 
3706
    
 
3707
    :Examples:
 
3708
        bzr break-lock
 
3709
    """
 
3710
    takes_args = ['location?']
 
3711
 
 
3712
    def run(self, location=None, show=False):
 
3713
        if location is None:
 
3714
            location = u'.'
 
3715
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3716
        try:
 
3717
            control.break_lock()
 
3718
        except NotImplementedError:
 
3719
            pass
 
3720
        
 
3721
 
 
3722
class cmd_wait_until_signalled(Command):
 
3723
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3724
 
 
3725
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3726
    """
 
3727
 
 
3728
    hidden = True
 
3729
 
 
3730
    def run(self):
 
3731
        sys.stdout.write("running\n")
 
3732
        sys.stdout.flush()
 
3733
        sys.stdin.readline()
 
3734
 
 
3735
 
 
3736
class cmd_serve(Command):
 
3737
    """Run the bzr server."""
 
3738
 
 
3739
    aliases = ['server']
 
3740
 
 
3741
    takes_options = [
 
3742
        Option('inet',
 
3743
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3744
        Option('port',
 
3745
               help='Listen for connections on nominated port of the form '
 
3746
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3747
                    'result in a dynamically allocated port.  The default port is '
 
3748
                    '4155.',
 
3749
               type=str),
 
3750
        Option('directory',
 
3751
               help='Serve contents of this directory.',
 
3752
               type=unicode),
 
3753
        Option('allow-writes',
 
3754
               help='By default the server is a readonly server.  Supplying '
 
3755
                    '--allow-writes enables write access to the contents of '
 
3756
                    'the served directory and below.'
 
3757
                ),
 
3758
        ]
 
3759
 
 
3760
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3761
        from bzrlib import lockdir
 
3762
        from bzrlib.smart import medium, server
 
3763
        from bzrlib.transport import get_transport
 
3764
        from bzrlib.transport.chroot import ChrootServer
 
3765
        if directory is None:
 
3766
            directory = os.getcwd()
 
3767
        url = urlutils.local_path_to_url(directory)
 
3768
        if not allow_writes:
 
3769
            url = 'readonly+' + url
 
3770
        chroot_server = ChrootServer(get_transport(url))
 
3771
        chroot_server.setUp()
 
3772
        t = get_transport(chroot_server.get_url())
 
3773
        if inet:
 
3774
            smart_server = medium.SmartServerPipeStreamMedium(
 
3775
                sys.stdin, sys.stdout, t)
 
3776
        else:
 
3777
            host = medium.BZR_DEFAULT_INTERFACE
 
3778
            if port is None:
 
3779
                port = medium.BZR_DEFAULT_PORT
 
3780
            else:
 
3781
                if ':' in port:
 
3782
                    host, port = port.split(':')
 
3783
                port = int(port)
 
3784
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3785
            print 'listening on port: ', smart_server.port
 
3786
            sys.stdout.flush()
 
3787
        # for the duration of this server, no UI output is permitted.
 
3788
        # note that this may cause problems with blackbox tests. This should
 
3789
        # be changed with care though, as we dont want to use bandwidth sending
 
3790
        # progress over stderr to smart server clients!
 
3791
        old_factory = ui.ui_factory
 
3792
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3793
        try:
 
3794
            ui.ui_factory = ui.SilentUIFactory()
 
3795
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3796
            smart_server.serve()
 
3797
        finally:
 
3798
            ui.ui_factory = old_factory
 
3799
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
3800
 
 
3801
 
 
3802
class cmd_join(Command):
 
3803
    """Combine a subtree into its containing tree.
 
3804
    
 
3805
    This command is for experimental use only.  It requires the target tree
 
3806
    to be in dirstate-with-subtree format, which cannot be converted into
 
3807
    earlier formats.
 
3808
 
 
3809
    The TREE argument should be an independent tree, inside another tree, but
 
3810
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3811
    running "bzr branch" with the target inside a tree.)
 
3812
 
 
3813
    The result is a combined tree, with the subtree no longer an independant
 
3814
    part.  This is marked as a merge of the subtree into the containing tree,
 
3815
    and all history is preserved.
 
3816
 
 
3817
    If --reference is specified, the subtree retains its independence.  It can
 
3818
    be branched by itself, and can be part of multiple projects at the same
 
3819
    time.  But operations performed in the containing tree, such as commit
 
3820
    and merge, will recurse into the subtree.
 
3821
    """
 
3822
 
 
3823
    _see_also = ['split']
 
3824
    takes_args = ['tree']
 
3825
    takes_options = [
 
3826
            Option('reference', help='Join by reference.'),
 
3827
            ]
 
3828
    hidden = True
 
3829
 
 
3830
    def run(self, tree, reference=False):
 
3831
        sub_tree = WorkingTree.open(tree)
 
3832
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3833
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3834
        repo = containing_tree.branch.repository
 
3835
        if not repo.supports_rich_root():
 
3836
            raise errors.BzrCommandError(
 
3837
                "Can't join trees because %s doesn't support rich root data.\n"
 
3838
                "You can use bzr upgrade on the repository."
 
3839
                % (repo,))
 
3840
        if reference:
 
3841
            try:
 
3842
                containing_tree.add_reference(sub_tree)
 
3843
            except errors.BadReferenceTarget, e:
 
3844
                # XXX: Would be better to just raise a nicely printable
 
3845
                # exception from the real origin.  Also below.  mbp 20070306
 
3846
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3847
                                             (tree, e.reason))
 
3848
        else:
 
3849
            try:
 
3850
                containing_tree.subsume(sub_tree)
 
3851
            except errors.BadSubsumeSource, e:
 
3852
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3853
                                             (tree, e.reason))
 
3854
 
 
3855
 
 
3856
class cmd_split(Command):
 
3857
    """Split a subdirectory of a tree into a separate tree.
 
3858
 
 
3859
    This command will produce a target tree in a format that supports
 
3860
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
3861
    converted into earlier formats like 'dirstate-tags'.
 
3862
 
 
3863
    The TREE argument should be a subdirectory of a working tree.  That
 
3864
    subdirectory will be converted into an independent tree, with its own
 
3865
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3866
    """
 
3867
 
 
3868
    # join is not un-hidden yet
 
3869
    #_see_also = ['join']
 
3870
    takes_args = ['tree']
 
3871
 
 
3872
    def run(self, tree):
 
3873
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3874
        sub_id = containing_tree.path2id(subdir)
 
3875
        if sub_id is None:
 
3876
            raise errors.NotVersionedError(subdir)
 
3877
        try:
 
3878
            containing_tree.extract(sub_id)
 
3879
        except errors.RootNotRich:
 
3880
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3881
 
 
3882
 
 
3883
class cmd_merge_directive(Command):
 
3884
    """Generate a merge directive for auto-merge tools.
 
3885
 
 
3886
    A directive requests a merge to be performed, and also provides all the
 
3887
    information necessary to do so.  This means it must either include a
 
3888
    revision bundle, or the location of a branch containing the desired
 
3889
    revision.
 
3890
 
 
3891
    A submit branch (the location to merge into) must be supplied the first
 
3892
    time the command is issued.  After it has been supplied once, it will
 
3893
    be remembered as the default.
 
3894
 
 
3895
    A public branch is optional if a revision bundle is supplied, but required
 
3896
    if --diff or --plain is specified.  It will be remembered as the default
 
3897
    after the first use.
 
3898
    """
 
3899
 
 
3900
    takes_args = ['submit_branch?', 'public_branch?']
 
3901
 
 
3902
    hidden = True
 
3903
 
 
3904
    _see_also = ['send']
 
3905
 
 
3906
    takes_options = [
 
3907
        RegistryOption.from_kwargs('patch-type',
 
3908
            'The type of patch to include in the directive.',
 
3909
            title='Patch type',
 
3910
            value_switches=True,
 
3911
            enum_switch=False,
 
3912
            bundle='Bazaar revision bundle (default).',
 
3913
            diff='Normal unified diff.',
 
3914
            plain='No patch, just directive.'),
 
3915
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3916
        Option('mail-to', type=str,
 
3917
            help='Instead of printing the directive, email to this address.'),
 
3918
        Option('message', type=str, short_name='m',
 
3919
            help='Message to use when committing this merge.')
 
3920
        ]
 
3921
 
 
3922
    encoding_type = 'exact'
 
3923
 
 
3924
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3925
            sign=False, revision=None, mail_to=None, message=None):
 
3926
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3927
        include_patch, include_bundle = {
 
3928
            'plain': (False, False),
 
3929
            'diff': (True, False),
 
3930
            'bundle': (True, True),
 
3931
            }[patch_type]
 
3932
        branch = Branch.open('.')
 
3933
        stored_submit_branch = branch.get_submit_branch()
 
3934
        if submit_branch is None:
 
3935
            submit_branch = stored_submit_branch
 
3936
        else:
 
3937
            if stored_submit_branch is None:
 
3938
                branch.set_submit_branch(submit_branch)
 
3939
        if submit_branch is None:
 
3940
            submit_branch = branch.get_parent()
 
3941
        if submit_branch is None:
 
3942
            raise errors.BzrCommandError('No submit branch specified or known')
 
3943
 
 
3944
        stored_public_branch = branch.get_public_branch()
 
3945
        if public_branch is None:
 
3946
            public_branch = stored_public_branch
 
3947
        elif stored_public_branch is None:
 
3948
            branch.set_public_branch(public_branch)
 
3949
        if not include_bundle and public_branch is None:
 
3950
            raise errors.BzrCommandError('No public branch specified or'
 
3951
                                         ' known')
 
3952
        base_revision_id = None
 
3953
        if revision is not None:
 
3954
            if len(revision) > 2:
 
3955
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3956
                    'at most two one revision identifiers')
 
3957
            revision_id = revision[-1].in_history(branch).rev_id
 
3958
            if len(revision) == 2:
 
3959
                base_revision_id = revision[0].in_history(branch).rev_id
 
3960
                base_revision_id = ensure_null(base_revision_id)
 
3961
        else:
 
3962
            revision_id = branch.last_revision()
 
3963
        revision_id = ensure_null(revision_id)
 
3964
        if revision_id == NULL_REVISION:
 
3965
            raise errors.BzrCommandError('No revisions to bundle.')
 
3966
        directive = merge_directive.MergeDirective2.from_objects(
 
3967
            branch.repository, revision_id, time.time(),
 
3968
            osutils.local_time_offset(), submit_branch,
 
3969
            public_branch=public_branch, include_patch=include_patch,
 
3970
            include_bundle=include_bundle, message=message,
 
3971
            base_revision_id=base_revision_id)
 
3972
        if mail_to is None:
 
3973
            if sign:
 
3974
                self.outf.write(directive.to_signed(branch))
 
3975
            else:
 
3976
                self.outf.writelines(directive.to_lines())
 
3977
        else:
 
3978
            message = directive.to_email(mail_to, branch, sign)
 
3979
            s = SMTPConnection(branch.get_config())
 
3980
            s.send_email(message)
 
3981
 
 
3982
 
 
3983
class cmd_send(Command):
 
3984
    """Mail or create a merge-directive for submiting changes.
 
3985
 
 
3986
    A merge directive provides many things needed for requesting merges:
 
3987
 
 
3988
    * A machine-readable description of the merge to perform
 
3989
 
 
3990
    * An optional patch that is a preview of the changes requested
 
3991
 
 
3992
    * An optional bundle of revision data, so that the changes can be applied
 
3993
      directly from the merge directive, without retrieving data from a
 
3994
      branch.
 
3995
 
 
3996
    If --no-bundle is specified, then public_branch is needed (and must be
 
3997
    up-to-date), so that the receiver can perform the merge using the
 
3998
    public_branch.  The public_branch is always included if known, so that
 
3999
    people can check it later.
 
4000
 
 
4001
    The submit branch defaults to the parent, but can be overridden.  Both
 
4002
    submit branch and public branch will be remembered if supplied.
 
4003
 
 
4004
    If a public_branch is known for the submit_branch, that public submit
 
4005
    branch is used in the merge instructions.  This means that a local mirror
 
4006
    can be used as your actual submit branch, once you have set public_branch
 
4007
    for that mirror.
 
4008
 
 
4009
    Mail is sent using your preferred mail program.  This should be transparent
 
4010
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4011
    If the preferred client can't be found (or used), your editor will be used.
 
4012
    
 
4013
    To use a specific mail program, set the mail_client configuration option.
 
4014
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4015
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4016
    generic options are "default", "editor", "mapi", and "xdg-email".
 
4017
 
 
4018
    If mail is being sent, a to address is required.  This can be supplied
 
4019
    either on the commandline, or by setting the submit_to configuration
 
4020
    option.
 
4021
 
 
4022
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4023
    merge directive format 2.  It is significantly faster and smaller than
 
4024
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4025
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4026
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4027
    """
 
4028
 
 
4029
    encoding_type = 'exact'
 
4030
 
 
4031
    _see_also = ['merge']
 
4032
 
 
4033
    takes_args = ['submit_branch?', 'public_branch?']
 
4034
 
 
4035
    takes_options = [
 
4036
        Option('no-bundle',
 
4037
               help='Do not include a bundle in the merge directive.'),
 
4038
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4039
               ' directive.'),
 
4040
        Option('remember',
 
4041
               help='Remember submit and public branch.'),
 
4042
        Option('from',
 
4043
               help='Branch to generate the submission from, '
 
4044
               'rather than the one containing the working directory.',
 
4045
               short_name='f',
 
4046
               type=unicode),
 
4047
        Option('output', short_name='o', help='Write directive to this file.',
 
4048
               type=unicode),
 
4049
        Option('mail-to', help='Mail the request to this address.',
 
4050
               type=unicode),
 
4051
        'revision',
 
4052
        'message',
 
4053
        RegistryOption.from_kwargs('format',
 
4054
        'Use the specified output format.',
 
4055
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4056
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4057
        ]
 
4058
 
 
4059
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4060
            no_patch=False, revision=None, remember=False, output=None,
 
4061
            format='4', mail_to=None, message=None, **kwargs):
 
4062
        return self._run(submit_branch, revision, public_branch, remember,
 
4063
                         format, no_bundle, no_patch, output,
 
4064
                         kwargs.get('from', '.'), mail_to, message)
 
4065
 
 
4066
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4067
             no_bundle, no_patch, output, from_, mail_to, message):
 
4068
        from bzrlib.revision import NULL_REVISION
 
4069
        branch = Branch.open_containing(from_)[0]
 
4070
        if output is None:
 
4071
            outfile = StringIO()
 
4072
        elif output == '-':
 
4073
            outfile = self.outf
 
4074
        else:
 
4075
            outfile = open(output, 'wb')
 
4076
        # we may need to write data into branch's repository to calculate
 
4077
        # the data to send.
 
4078
        branch.lock_write()
 
4079
        try:
 
4080
            if output is None:
 
4081
                config = branch.get_config()
 
4082
                if mail_to is None:
 
4083
                    mail_to = config.get_user_option('submit_to')
 
4084
                mail_client = config.get_mail_client()
 
4085
            if remember and submit_branch is None:
 
4086
                raise errors.BzrCommandError(
 
4087
                    '--remember requires a branch to be specified.')
 
4088
            stored_submit_branch = branch.get_submit_branch()
 
4089
            remembered_submit_branch = False
 
4090
            if submit_branch is None:
 
4091
                submit_branch = stored_submit_branch
 
4092
                remembered_submit_branch = True
 
4093
            else:
 
4094
                if stored_submit_branch is None or remember:
 
4095
                    branch.set_submit_branch(submit_branch)
 
4096
            if submit_branch is None:
 
4097
                submit_branch = branch.get_parent()
 
4098
                remembered_submit_branch = True
 
4099
            if submit_branch is None:
 
4100
                raise errors.BzrCommandError('No submit branch known or'
 
4101
                                             ' specified')
 
4102
            if remembered_submit_branch:
 
4103
                note('Using saved location: %s', submit_branch)
 
4104
 
 
4105
            stored_public_branch = branch.get_public_branch()
 
4106
            if public_branch is None:
 
4107
                public_branch = stored_public_branch
 
4108
            elif stored_public_branch is None or remember:
 
4109
                branch.set_public_branch(public_branch)
 
4110
            if no_bundle and public_branch is None:
 
4111
                raise errors.BzrCommandError('No public branch specified or'
 
4112
                                             ' known')
 
4113
            base_revision_id = None
 
4114
            revision_id = None
 
4115
            if revision is not None:
 
4116
                if len(revision) > 2:
 
4117
                    raise errors.BzrCommandError('bzr send takes '
 
4118
                        'at most two one revision identifiers')
 
4119
                revision_id = revision[-1].in_history(branch).rev_id
 
4120
                if len(revision) == 2:
 
4121
                    base_revision_id = revision[0].in_history(branch).rev_id
 
4122
            if revision_id is None:
 
4123
                revision_id = branch.last_revision()
 
4124
            if revision_id == NULL_REVISION:
 
4125
                raise errors.BzrCommandError('No revisions to submit.')
 
4126
            if format == '4':
 
4127
                directive = merge_directive.MergeDirective2.from_objects(
 
4128
                    branch.repository, revision_id, time.time(),
 
4129
                    osutils.local_time_offset(), submit_branch,
 
4130
                    public_branch=public_branch, include_patch=not no_patch,
 
4131
                    include_bundle=not no_bundle, message=message,
 
4132
                    base_revision_id=base_revision_id)
 
4133
            elif format == '0.9':
 
4134
                if not no_bundle:
 
4135
                    if not no_patch:
 
4136
                        patch_type = 'bundle'
 
4137
                    else:
 
4138
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4139
                            ' permit bundle with no patch')
 
4140
                else:
 
4141
                    if not no_patch:
 
4142
                        patch_type = 'diff'
 
4143
                    else:
 
4144
                        patch_type = None
 
4145
                directive = merge_directive.MergeDirective.from_objects(
 
4146
                    branch.repository, revision_id, time.time(),
 
4147
                    osutils.local_time_offset(), submit_branch,
 
4148
                    public_branch=public_branch, patch_type=patch_type,
 
4149
                    message=message)
 
4150
 
 
4151
            outfile.writelines(directive.to_lines())
 
4152
            if output is None:
 
4153
                subject = '[MERGE] '
 
4154
                if message is not None:
 
4155
                    subject += message
 
4156
                else:
 
4157
                    revision = branch.repository.get_revision(revision_id)
 
4158
                    subject += revision.get_summary()
 
4159
                mail_client.compose_merge_request(mail_to, subject,
 
4160
                                                  outfile.getvalue())
 
4161
        finally:
 
4162
            if output != '-':
 
4163
                outfile.close()
 
4164
            branch.unlock()
 
4165
 
 
4166
 
 
4167
class cmd_bundle_revisions(cmd_send):
 
4168
 
 
4169
    """Create a merge-directive for submiting changes.
 
4170
 
 
4171
    A merge directive provides many things needed for requesting merges:
 
4172
 
 
4173
    * A machine-readable description of the merge to perform
 
4174
 
 
4175
    * An optional patch that is a preview of the changes requested
 
4176
 
 
4177
    * An optional bundle of revision data, so that the changes can be applied
 
4178
      directly from the merge directive, without retrieving data from a
 
4179
      branch.
 
4180
 
 
4181
    If --no-bundle is specified, then public_branch is needed (and must be
 
4182
    up-to-date), so that the receiver can perform the merge using the
 
4183
    public_branch.  The public_branch is always included if known, so that
 
4184
    people can check it later.
 
4185
 
 
4186
    The submit branch defaults to the parent, but can be overridden.  Both
 
4187
    submit branch and public branch will be remembered if supplied.
 
4188
 
 
4189
    If a public_branch is known for the submit_branch, that public submit
 
4190
    branch is used in the merge instructions.  This means that a local mirror
 
4191
    can be used as your actual submit branch, once you have set public_branch
 
4192
    for that mirror.
 
4193
 
 
4194
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4195
    merge directive format 2.  It is significantly faster and smaller than
 
4196
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4197
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4198
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4199
    """
 
4200
 
 
4201
    takes_options = [
 
4202
        Option('no-bundle',
 
4203
               help='Do not include a bundle in the merge directive.'),
 
4204
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4205
               ' directive.'),
 
4206
        Option('remember',
 
4207
               help='Remember submit and public branch.'),
 
4208
        Option('from',
 
4209
               help='Branch to generate the submission from, '
 
4210
               'rather than the one containing the working directory.',
 
4211
               short_name='f',
 
4212
               type=unicode),
 
4213
        Option('output', short_name='o', help='Write directive to this file.',
 
4214
               type=unicode),
 
4215
        'revision',
 
4216
        RegistryOption.from_kwargs('format',
 
4217
        'Use the specified output format.',
 
4218
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4219
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4220
        ]
 
4221
    aliases = ['bundle']
 
4222
 
 
4223
    _see_also = ['send', 'merge']
 
4224
 
 
4225
    hidden = True
 
4226
 
 
4227
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4228
            no_patch=False, revision=None, remember=False, output=None,
 
4229
            format='4', **kwargs):
 
4230
        if output is None:
 
4231
            output = '-'
 
4232
        return self._run(submit_branch, revision, public_branch, remember,
 
4233
                         format, no_bundle, no_patch, output,
 
4234
                         kwargs.get('from', '.'), None, None)
 
4235
 
 
4236
 
 
4237
class cmd_tag(Command):
 
4238
    """Create, remove or modify a tag naming a revision.
 
4239
    
 
4240
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4241
    (--revision) option can be given -rtag:X, where X is any previously
 
4242
    created tag.
 
4243
 
 
4244
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4245
    along when you branch, push, pull or merge.
 
4246
 
 
4247
    It is an error to give a tag name that already exists unless you pass 
 
4248
    --force, in which case the tag is moved to point to the new revision.
 
4249
    """
 
4250
 
 
4251
    _see_also = ['commit', 'tags']
 
4252
    takes_args = ['tag_name']
 
4253
    takes_options = [
 
4254
        Option('delete',
 
4255
            help='Delete this tag rather than placing it.',
 
4256
            ),
 
4257
        Option('directory',
 
4258
            help='Branch in which to place the tag.',
 
4259
            short_name='d',
 
4260
            type=unicode,
 
4261
            ),
 
4262
        Option('force',
 
4263
            help='Replace existing tags.',
 
4264
            ),
 
4265
        'revision',
 
4266
        ]
 
4267
 
 
4268
    def run(self, tag_name,
 
4269
            delete=None,
 
4270
            directory='.',
 
4271
            force=None,
 
4272
            revision=None,
 
4273
            ):
 
4274
        branch, relpath = Branch.open_containing(directory)
 
4275
        branch.lock_write()
 
4276
        try:
 
4277
            if delete:
 
4278
                branch.tags.delete_tag(tag_name)
 
4279
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4280
            else:
 
4281
                if revision:
 
4282
                    if len(revision) != 1:
 
4283
                        raise errors.BzrCommandError(
 
4284
                            "Tags can only be placed on a single revision, "
 
4285
                            "not on a range")
 
4286
                    revision_id = revision[0].in_history(branch).rev_id
 
4287
                else:
 
4288
                    revision_id = branch.last_revision()
 
4289
                if (not force) and branch.tags.has_tag(tag_name):
 
4290
                    raise errors.TagAlreadyExists(tag_name)
 
4291
                branch.tags.set_tag(tag_name, revision_id)
 
4292
                self.outf.write('Created tag %s.\n' % tag_name)
 
4293
        finally:
 
4294
            branch.unlock()
 
4295
 
 
4296
 
 
4297
class cmd_tags(Command):
 
4298
    """List tags.
 
4299
 
 
4300
    This command shows a table of tag names and the revisions they reference.
 
4301
    """
 
4302
 
 
4303
    _see_also = ['tag']
 
4304
    takes_options = [
 
4305
        Option('directory',
 
4306
            help='Branch whose tags should be displayed.',
 
4307
            short_name='d',
 
4308
            type=unicode,
 
4309
            ),
 
4310
        RegistryOption.from_kwargs('sort',
 
4311
            'Sort tags by different criteria.', title='Sorting',
 
4312
            alpha='Sort tags lexicographically (default).',
 
4313
            time='Sort tags chronologically.',
 
4314
            ),
 
4315
        'show-ids',
 
4316
    ]
 
4317
 
 
4318
    @display_command
 
4319
    def run(self,
 
4320
            directory='.',
 
4321
            sort='alpha',
 
4322
            show_ids=False,
 
4323
            ):
 
4324
        branch, relpath = Branch.open_containing(directory)
 
4325
        tags = branch.tags.get_tag_dict().items()
 
4326
        if sort == 'alpha':
 
4327
            tags.sort()
 
4328
        elif sort == 'time':
 
4329
            timestamps = {}
 
4330
            for tag, revid in tags:
 
4331
                try:
 
4332
                    revobj = branch.repository.get_revision(revid)
 
4333
                except errors.NoSuchRevision:
 
4334
                    timestamp = sys.maxint # place them at the end
 
4335
                else:
 
4336
                    timestamp = revobj.timestamp
 
4337
                timestamps[revid] = timestamp
 
4338
            tags.sort(key=lambda x: timestamps[x[1]])
 
4339
        if not show_ids:
 
4340
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4341
            revno_map = branch.get_revision_id_to_revno_map()
 
4342
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4343
                        for tag, revid in tags ]
 
4344
        for tag, revspec in tags:
 
4345
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4346
 
 
4347
 
 
4348
class cmd_reconfigure(Command):
 
4349
    """Reconfigure the type of a bzr directory.
 
4350
 
 
4351
    A target configuration must be specified.
 
4352
 
 
4353
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4354
    The order of preference is
 
4355
    1. For a lightweight checkout, the current bound location.
 
4356
    2. For branches that used to be checkouts, the previously-bound location.
 
4357
    3. The push location.
 
4358
    4. The parent location.
 
4359
    If none of these is available, --bind-to must be specified.
 
4360
    """
 
4361
 
 
4362
    takes_args = ['location?']
 
4363
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4364
                     title='Target type',
 
4365
                     help='The type to reconfigure the directory to.',
 
4366
                     value_switches=True, enum_switch=False,
 
4367
                     branch='Reconfigure to a branch.',
 
4368
                     tree='Reconfigure to a tree.',
 
4369
                     checkout='Reconfigure to a checkout.',
 
4370
                     lightweight_checkout='Reconfigure to a lightweight'
 
4371
                     ' checkout.'),
 
4372
                     Option('bind-to', help='Branch to bind checkout to.',
 
4373
                            type=str),
 
4374
                     Option('force',
 
4375
                        help='Perform reconfiguration even if local changes'
 
4376
                        ' will be lost.')
 
4377
                     ]
 
4378
 
 
4379
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4380
        directory = bzrdir.BzrDir.open(location)
 
4381
        if target_type is None:
 
4382
            raise errors.BzrCommandError('No target configuration specified')
 
4383
        elif target_type == 'branch':
 
4384
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4385
        elif target_type == 'tree':
 
4386
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4387
        elif target_type == 'checkout':
 
4388
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4389
                                                                  bind_to)
 
4390
        elif target_type == 'lightweight-checkout':
 
4391
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4392
                directory, bind_to)
 
4393
        reconfiguration.apply(force)
 
4394
 
 
4395
 
 
4396
class cmd_switch(Command):
 
4397
    """Set the branch of a checkout and update.
 
4398
    
 
4399
    For lightweight checkouts, this changes the branch being referenced.
 
4400
    For heavyweight checkouts, this checks that there are no local commits
 
4401
    versus the current bound branch, then it makes the local branch a mirror
 
4402
    of the new location and binds to it.
 
4403
    
 
4404
    In both cases, the working tree is updated and uncommitted changes
 
4405
    are merged. The user can commit or revert these as they desire.
 
4406
 
 
4407
    Pending merges need to be committed or reverted before using switch.
 
4408
    """
 
4409
 
 
4410
    takes_args = ['to_location']
 
4411
    takes_options = [Option('force',
 
4412
                        help='Switch even if local commits will be lost.')
 
4413
                     ]
 
4414
 
 
4415
    def run(self, to_location, force=False):
 
4416
        from bzrlib import switch
 
4417
        to_branch = Branch.open(to_location)
 
4418
        tree_location = '.'
 
4419
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4420
        switch.switch(control_dir, to_branch, force)
 
4421
        note('Switched to branch: %s',
 
4422
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4423
 
 
4424
 
 
4425
def _create_prefix(cur_transport):
 
4426
    needed = [cur_transport]
 
4427
    # Recurse upwards until we can create a directory successfully
 
4428
    while True:
 
4429
        new_transport = cur_transport.clone('..')
 
4430
        if new_transport.base == cur_transport.base:
 
4431
            raise errors.BzrCommandError(
 
4432
                "Failed to create path prefix for %s."
 
4433
                % cur_transport.base)
 
4434
        try:
 
4435
            new_transport.mkdir('.')
 
4436
        except errors.NoSuchFile:
 
4437
            needed.append(new_transport)
 
4438
            cur_transport = new_transport
 
4439
        else:
 
4440
            break
 
4441
    # Now we only need to create child directories
 
4442
    while needed:
 
4443
        cur_transport = needed.pop()
 
4444
        cur_transport.ensure_base()
 
4445
 
 
4446
 
 
4447
def _get_mergeable_helper(location):
 
4448
    """Get a merge directive or bundle if 'location' points to one.
 
4449
 
 
4450
    Try try to identify a bundle and returns its mergeable form. If it's not,
 
4451
    we return the tried transport anyway so that it can reused to access the
 
4452
    branch
 
4453
 
 
4454
    :param location: can point to a bundle or a branch.
 
4455
 
 
4456
    :return: mergeable, transport
 
4457
    """
 
4458
    mergeable = None
 
4459
    url = urlutils.normalize_url(location)
 
4460
    url, filename = urlutils.split(url, exclude_trailing_slash=False)
 
4461
    location_transport = transport.get_transport(url)
 
4462
    if filename:
 
4463
        try:
 
4464
            # There may be redirections but we ignore the intermediate
 
4465
            # and final transports used
 
4466
            read = bundle.read_mergeable_from_transport
 
4467
            mergeable, t = read(location_transport, filename)
 
4468
        except errors.NotABundle:
 
4469
            # Continue on considering this url a Branch but adjust the
 
4470
            # location_transport
 
4471
            location_transport = location_transport.clone(filename)
 
4472
    return mergeable, location_transport
 
4473
 
 
4474
 
 
4475
# these get imported and then picked up by the scan for cmd_*
 
4476
# TODO: Some more consistent way to split command definitions across files;
 
4477
# we do need to load at least some information about them to know of 
 
4478
# aliases.  ideally we would avoid loading the implementation until the
 
4479
# details were needed.
 
4480
from bzrlib.cmd_version_info import cmd_version_info
 
4481
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4482
from bzrlib.bundle.commands import (
 
4483
    cmd_bundle_info,
 
4484
    )
 
4485
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4486
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4487
        cmd_weave_plan_merge, cmd_weave_merge_text