/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2007-12-19 04:04:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3135.
  • Revision ID: aaron.bentley@utoronto.ca-20071219040456-0bh3fruord0m08gz
Update NEWS

Show diffs side-by-side

added added

removed removed

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