/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-21 06:34:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3140.
  • Revision ID: aaron.bentley@utoronto.ca-20071221063427-pavy148wf806gf11
Fix commit for a checkout sharing a repo with its branch (abentley, #177592)

Show diffs side-by-side

added added

removed removed

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