/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: Martin Pool
  • Date: 2007-09-03 04:35:49 UTC
  • mfrom: (2778 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2779.
  • Revision ID: mbp@sourcefrog.net-20070903043549-0cfyrgx7z2h8ppks
merge trunk

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