/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: Robert Collins
  • Date: 2008-08-08 06:59:48 UTC
  • mto: This revision was merged to the branch mainline in revision 3618.
  • Revision ID: robertc@robertcollins.net-20080808065948-io0c6pfo305ss5vj
Refactor exporters to remove obvious duplication to a helper function.

Show diffs side-by-side

added added

removed removed

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