/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: John Arbash Meinel
  • Date: 2008-08-14 20:15:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3636.
  • Revision ID: john@arbash-meinel.com-20080814201521-vz11z6uh7b0pcnxg
Thunk over to the real branch's revision_id_to_revno.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
        if not is_quiet():
 
1315
            from bzrlib.info import show_bzrdir_info
 
1316
            show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
 
1317
                to_transport)[0], verbose=0, outfile=self.outf)
 
1318
 
 
1319
 
 
1320
class cmd_init_repository(Command):
 
1321
    """Create a shared repository to hold branches.
 
1322
 
 
1323
    New branches created under the repository directory will store their
 
1324
    revisions in the repository, not in the branch directory.
 
1325
 
 
1326
    If the --no-trees option is used then the branches in the repository
 
1327
    will not have working trees by default.
 
1328
 
 
1329
    :Examples:
 
1330
        Create a shared repositories holding just branches::
 
1331
 
 
1332
            bzr init-repo --no-trees repo
 
1333
            bzr init repo/trunk
 
1334
 
 
1335
        Make a lightweight checkout elsewhere::
 
1336
 
 
1337
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1338
            cd trunk-checkout
 
1339
            (add files here)
 
1340
    """
 
1341
 
 
1342
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1343
    takes_args = ["location"]
 
1344
    takes_options = [RegistryOption('format',
 
1345
                            help='Specify a format for this repository. See'
 
1346
                                 ' "bzr help formats" for details.',
 
1347
                            registry=bzrdir.format_registry,
 
1348
                            converter=bzrdir.format_registry.make_bzrdir,
 
1349
                            value_switches=True, title='Repository format'),
 
1350
                     Option('no-trees',
 
1351
                             help='Branches in the repository will default to'
 
1352
                                  ' not having a working tree.'),
 
1353
                    ]
 
1354
    aliases = ["init-repo"]
 
1355
 
 
1356
    def run(self, location, format=None, no_trees=False):
 
1357
        if format is None:
 
1358
            format = bzrdir.format_registry.make_bzrdir('default')
 
1359
 
 
1360
        if location is None:
 
1361
            location = '.'
 
1362
 
 
1363
        to_transport = transport.get_transport(location)
 
1364
        to_transport.ensure_base()
 
1365
 
 
1366
        newdir = format.initialize_on_transport(to_transport)
 
1367
        repo = newdir.create_repository(shared=True)
 
1368
        repo.set_make_working_trees(not no_trees)
 
1369
        if not is_quiet():
 
1370
            from bzrlib.info import show_bzrdir_info
 
1371
            show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
 
1372
                to_transport)[0], verbose=0, outfile=self.outf)
 
1373
 
 
1374
 
 
1375
class cmd_diff(Command):
 
1376
    """Show differences in the working tree, between revisions or branches.
 
1377
    
 
1378
    If no arguments are given, all changes for the current tree are listed.
 
1379
    If files are given, only the changes in those files are listed.
 
1380
    Remote and multiple branches can be compared by using the --old and
 
1381
    --new options. If not provided, the default for both is derived from
 
1382
    the first argument, if any, or the current tree if no arguments are
 
1383
    given.
 
1384
 
 
1385
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1386
    produces patches suitable for "patch -p1".
 
1387
 
 
1388
    :Exit values:
 
1389
        1 - changed
 
1390
        2 - unrepresentable changes
 
1391
        3 - error
 
1392
        0 - no change
 
1393
 
 
1394
    :Examples:
 
1395
        Shows the difference in the working tree versus the last commit::
 
1396
 
 
1397
            bzr diff
 
1398
 
 
1399
        Difference between the working tree and revision 1::
 
1400
 
 
1401
            bzr diff -r1
 
1402
 
 
1403
        Difference between revision 2 and revision 1::
 
1404
 
 
1405
            bzr diff -r1..2
 
1406
 
 
1407
        Difference between revision 2 and revision 1 for branch xxx::
 
1408
 
 
1409
            bzr diff -r1..2 xxx
 
1410
 
 
1411
        Show just the differences for file NEWS::
 
1412
 
 
1413
            bzr diff NEWS
 
1414
 
 
1415
        Show the differences in working tree xxx for file NEWS::
 
1416
 
 
1417
            bzr diff xxx/NEWS
 
1418
 
 
1419
        Show the differences from branch xxx to this working tree:
 
1420
 
 
1421
            bzr diff --old xxx
 
1422
 
 
1423
        Show the differences between two branches for file NEWS::
 
1424
 
 
1425
            bzr diff --old xxx --new yyy NEWS
 
1426
 
 
1427
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1428
 
 
1429
            bzr diff --prefix old/:new/
 
1430
    """
 
1431
    _see_also = ['status']
 
1432
    takes_args = ['file*']
 
1433
    takes_options = [
 
1434
        Option('diff-options', type=str,
 
1435
               help='Pass these options to the external diff program.'),
 
1436
        Option('prefix', type=str,
 
1437
               short_name='p',
 
1438
               help='Set prefixes added to old and new filenames, as '
 
1439
                    'two values separated by a colon. (eg "old/:new/").'),
 
1440
        Option('old',
 
1441
            help='Branch/tree to compare from.',
 
1442
            type=unicode,
 
1443
            ),
 
1444
        Option('new',
 
1445
            help='Branch/tree to compare to.',
 
1446
            type=unicode,
 
1447
            ),
 
1448
        'revision',
 
1449
        'change',
 
1450
        Option('using',
 
1451
            help='Use this command to compare files.',
 
1452
            type=unicode,
 
1453
            ),
 
1454
        ]
 
1455
    aliases = ['di', 'dif']
 
1456
    encoding_type = 'exact'
 
1457
 
 
1458
    @display_command
 
1459
    def run(self, revision=None, file_list=None, diff_options=None,
 
1460
            prefix=None, old=None, new=None, using=None):
 
1461
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1462
 
 
1463
        if (prefix is None) or (prefix == '0'):
 
1464
            # diff -p0 format
 
1465
            old_label = ''
 
1466
            new_label = ''
 
1467
        elif prefix == '1':
 
1468
            old_label = 'old/'
 
1469
            new_label = 'new/'
 
1470
        elif ':' in prefix:
 
1471
            old_label, new_label = prefix.split(":")
 
1472
        else:
 
1473
            raise errors.BzrCommandError(
 
1474
                '--prefix expects two values separated by a colon'
 
1475
                ' (eg "old/:new/")')
 
1476
 
 
1477
        if revision and len(revision) > 2:
 
1478
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1479
                                         ' one or two revision specifiers')
 
1480
 
 
1481
        old_tree, new_tree, specific_files, extra_trees = \
 
1482
                _get_trees_to_diff(file_list, revision, old, new)
 
1483
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1484
                               specific_files=specific_files,
 
1485
                               external_diff_options=diff_options,
 
1486
                               old_label=old_label, new_label=new_label,
 
1487
                               extra_trees=extra_trees, using=using)
 
1488
 
 
1489
 
 
1490
class cmd_deleted(Command):
 
1491
    """List files deleted in the working tree.
 
1492
    """
 
1493
    # TODO: Show files deleted since a previous revision, or
 
1494
    # between two revisions.
 
1495
    # TODO: Much more efficient way to do this: read in new
 
1496
    # directories with readdir, rather than stating each one.  Same
 
1497
    # level of effort but possibly much less IO.  (Or possibly not,
 
1498
    # if the directories are very large...)
 
1499
    _see_also = ['status', 'ls']
 
1500
    takes_options = ['show-ids']
 
1501
 
 
1502
    @display_command
 
1503
    def run(self, show_ids=False):
 
1504
        tree = WorkingTree.open_containing(u'.')[0]
 
1505
        tree.lock_read()
 
1506
        try:
 
1507
            old = tree.basis_tree()
 
1508
            old.lock_read()
 
1509
            try:
 
1510
                for path, ie in old.inventory.iter_entries():
 
1511
                    if not tree.has_id(ie.file_id):
 
1512
                        self.outf.write(path)
 
1513
                        if show_ids:
 
1514
                            self.outf.write(' ')
 
1515
                            self.outf.write(ie.file_id)
 
1516
                        self.outf.write('\n')
 
1517
            finally:
 
1518
                old.unlock()
 
1519
        finally:
 
1520
            tree.unlock()
 
1521
 
 
1522
 
 
1523
class cmd_modified(Command):
 
1524
    """List files modified in working tree.
 
1525
    """
 
1526
 
 
1527
    hidden = True
 
1528
    _see_also = ['status', 'ls']
 
1529
    takes_options = [
 
1530
            Option('null',
 
1531
                   help='Write an ascii NUL (\\0) separator '
 
1532
                   'between files rather than a newline.')
 
1533
            ]
 
1534
 
 
1535
    @display_command
 
1536
    def run(self, null=False):
 
1537
        tree = WorkingTree.open_containing(u'.')[0]
 
1538
        td = tree.changes_from(tree.basis_tree())
 
1539
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1540
            if null:
 
1541
                self.outf.write(path + '\0')
 
1542
            else:
 
1543
                self.outf.write(osutils.quotefn(path) + '\n')
 
1544
 
 
1545
 
 
1546
class cmd_added(Command):
 
1547
    """List files added in working tree.
 
1548
    """
 
1549
 
 
1550
    hidden = True
 
1551
    _see_also = ['status', 'ls']
 
1552
    takes_options = [
 
1553
            Option('null',
 
1554
                   help='Write an ascii NUL (\\0) separator '
 
1555
                   'between files rather than a newline.')
 
1556
            ]
 
1557
 
 
1558
    @display_command
 
1559
    def run(self, null=False):
 
1560
        wt = WorkingTree.open_containing(u'.')[0]
 
1561
        wt.lock_read()
 
1562
        try:
 
1563
            basis = wt.basis_tree()
 
1564
            basis.lock_read()
 
1565
            try:
 
1566
                basis_inv = basis.inventory
 
1567
                inv = wt.inventory
 
1568
                for file_id in inv:
 
1569
                    if file_id in basis_inv:
 
1570
                        continue
 
1571
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1572
                        continue
 
1573
                    path = inv.id2path(file_id)
 
1574
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1575
                        continue
 
1576
                    if null:
 
1577
                        self.outf.write(path + '\0')
 
1578
                    else:
 
1579
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1580
            finally:
 
1581
                basis.unlock()
 
1582
        finally:
 
1583
            wt.unlock()
 
1584
 
 
1585
 
 
1586
class cmd_root(Command):
 
1587
    """Show the tree root directory.
 
1588
 
 
1589
    The root is the nearest enclosing directory with a .bzr control
 
1590
    directory."""
 
1591
 
 
1592
    takes_args = ['filename?']
 
1593
    @display_command
 
1594
    def run(self, filename=None):
 
1595
        """Print the branch root."""
 
1596
        tree = WorkingTree.open_containing(filename)[0]
 
1597
        self.outf.write(tree.basedir + '\n')
 
1598
 
 
1599
 
 
1600
def _parse_limit(limitstring):
 
1601
    try:
 
1602
        return int(limitstring)
 
1603
    except ValueError:
 
1604
        msg = "The limit argument must be an integer."
 
1605
        raise errors.BzrCommandError(msg)
 
1606
 
 
1607
 
 
1608
class cmd_log(Command):
 
1609
    """Show log of a branch, file, or directory.
 
1610
 
 
1611
    By default show the log of the branch containing the working directory.
 
1612
 
 
1613
    To request a range of logs, you can use the command -r begin..end
 
1614
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1615
    also valid.
 
1616
 
 
1617
    :Examples:
 
1618
        Log the current branch::
 
1619
 
 
1620
            bzr log
 
1621
 
 
1622
        Log a file::
 
1623
 
 
1624
            bzr log foo.c
 
1625
 
 
1626
        Log the last 10 revisions of a branch::
 
1627
 
 
1628
            bzr log -r -10.. http://server/branch
 
1629
    """
 
1630
 
 
1631
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1632
 
 
1633
    takes_args = ['location?']
 
1634
    takes_options = [
 
1635
            Option('forward',
 
1636
                   help='Show from oldest to newest.'),
 
1637
            Option('timezone',
 
1638
                   type=str,
 
1639
                   help='Display timezone as local, original, or utc.'),
 
1640
            custom_help('verbose',
 
1641
                   help='Show files changed in each revision.'),
 
1642
            'show-ids',
 
1643
            'revision',
 
1644
            'log-format',
 
1645
            Option('message',
 
1646
                   short_name='m',
 
1647
                   help='Show revisions whose message matches this '
 
1648
                        'regular expression.',
 
1649
                   type=str),
 
1650
            Option('limit',
 
1651
                   short_name='l',
 
1652
                   help='Limit the output to the first N revisions.',
 
1653
                   argname='N',
 
1654
                   type=_parse_limit),
 
1655
            ]
 
1656
    encoding_type = 'replace'
 
1657
 
 
1658
    @display_command
 
1659
    def run(self, location=None, timezone='original',
 
1660
            verbose=False,
 
1661
            show_ids=False,
 
1662
            forward=False,
 
1663
            revision=None,
 
1664
            log_format=None,
 
1665
            message=None,
 
1666
            limit=None):
 
1667
        from bzrlib.log import show_log
 
1668
        direction = (forward and 'forward') or 'reverse'
 
1669
        
 
1670
        # log everything
 
1671
        file_id = None
 
1672
        if location:
 
1673
            # find the file id to log:
 
1674
 
 
1675
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1676
                location)
 
1677
            if fp != '':
 
1678
                if tree is None:
 
1679
                    tree = b.basis_tree()
 
1680
                file_id = tree.path2id(fp)
 
1681
                if file_id is None:
 
1682
                    raise errors.BzrCommandError(
 
1683
                        "Path does not have any revision history: %s" %
 
1684
                        location)
 
1685
        else:
 
1686
            # local dir only
 
1687
            # FIXME ? log the current subdir only RBC 20060203 
 
1688
            if revision is not None \
 
1689
                    and len(revision) > 0 and revision[0].get_branch():
 
1690
                location = revision[0].get_branch()
 
1691
            else:
 
1692
                location = '.'
 
1693
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1694
            b = dir.open_branch()
 
1695
 
 
1696
        b.lock_read()
 
1697
        try:
 
1698
            if revision is None:
 
1699
                rev1 = None
 
1700
                rev2 = None
 
1701
            elif len(revision) == 1:
 
1702
                rev1 = rev2 = revision[0].in_history(b)
 
1703
            elif len(revision) == 2:
 
1704
                if revision[1].get_branch() != revision[0].get_branch():
 
1705
                    # b is taken from revision[0].get_branch(), and
 
1706
                    # show_log will use its revision_history. Having
 
1707
                    # different branches will lead to weird behaviors.
 
1708
                    raise errors.BzrCommandError(
 
1709
                        "Log doesn't accept two revisions in different"
 
1710
                        " branches.")
 
1711
                rev1 = revision[0].in_history(b)
 
1712
                rev2 = revision[1].in_history(b)
 
1713
            else:
 
1714
                raise errors.BzrCommandError(
 
1715
                    'bzr log --revision takes one or two values.')
 
1716
 
 
1717
            if log_format is None:
 
1718
                log_format = log.log_formatter_registry.get_default(b)
 
1719
 
 
1720
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1721
                            show_timezone=timezone)
 
1722
 
 
1723
            show_log(b,
 
1724
                     lf,
 
1725
                     file_id,
 
1726
                     verbose=verbose,
 
1727
                     direction=direction,
 
1728
                     start_revision=rev1,
 
1729
                     end_revision=rev2,
 
1730
                     search=message,
 
1731
                     limit=limit)
 
1732
        finally:
 
1733
            b.unlock()
 
1734
 
 
1735
 
 
1736
def get_log_format(long=False, short=False, line=False, default='long'):
 
1737
    log_format = default
 
1738
    if long:
 
1739
        log_format = 'long'
 
1740
    if short:
 
1741
        log_format = 'short'
 
1742
    if line:
 
1743
        log_format = 'line'
 
1744
    return log_format
 
1745
 
 
1746
 
 
1747
class cmd_touching_revisions(Command):
 
1748
    """Return revision-ids which affected a particular file.
 
1749
 
 
1750
    A more user-friendly interface is "bzr log FILE".
 
1751
    """
 
1752
 
 
1753
    hidden = True
 
1754
    takes_args = ["filename"]
 
1755
 
 
1756
    @display_command
 
1757
    def run(self, filename):
 
1758
        tree, relpath = WorkingTree.open_containing(filename)
 
1759
        b = tree.branch
 
1760
        file_id = tree.path2id(relpath)
 
1761
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1762
            self.outf.write("%6d %s\n" % (revno, what))
 
1763
 
 
1764
 
 
1765
class cmd_ls(Command):
 
1766
    """List files in a tree.
 
1767
    """
 
1768
 
 
1769
    _see_also = ['status', 'cat']
 
1770
    takes_args = ['path?']
 
1771
    # TODO: Take a revision or remote path and list that tree instead.
 
1772
    takes_options = [
 
1773
            'verbose',
 
1774
            'revision',
 
1775
            Option('non-recursive',
 
1776
                   help='Don\'t recurse into subdirectories.'),
 
1777
            Option('from-root',
 
1778
                   help='Print paths relative to the root of the branch.'),
 
1779
            Option('unknown', help='Print unknown files.'),
 
1780
            Option('versioned', help='Print versioned files.',
 
1781
                   short_name='V'),
 
1782
            Option('ignored', help='Print ignored files.'),
 
1783
            Option('null',
 
1784
                   help='Write an ascii NUL (\\0) separator '
 
1785
                   'between files rather than a newline.'),
 
1786
            Option('kind',
 
1787
                   help='List entries of a particular kind: file, directory, symlink.',
 
1788
                   type=unicode),
 
1789
            'show-ids',
 
1790
            ]
 
1791
    @display_command
 
1792
    def run(self, revision=None, verbose=False,
 
1793
            non_recursive=False, from_root=False,
 
1794
            unknown=False, versioned=False, ignored=False,
 
1795
            null=False, kind=None, show_ids=False, path=None):
 
1796
 
 
1797
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1798
            raise errors.BzrCommandError('invalid kind specified')
 
1799
 
 
1800
        if verbose and null:
 
1801
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1802
        all = not (unknown or versioned or ignored)
 
1803
 
 
1804
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1805
 
 
1806
        if path is None:
 
1807
            fs_path = '.'
 
1808
            prefix = ''
 
1809
        else:
 
1810
            if from_root:
 
1811
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1812
                                             ' and PATH')
 
1813
            fs_path = path
 
1814
            prefix = path
 
1815
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1816
            fs_path)
 
1817
        if from_root:
 
1818
            relpath = u''
 
1819
        elif relpath:
 
1820
            relpath += '/'
 
1821
        if revision is not None:
 
1822
            tree = branch.repository.revision_tree(
 
1823
                revision[0].as_revision_id(branch))
 
1824
        elif tree is None:
 
1825
            tree = branch.basis_tree()
 
1826
 
 
1827
        tree.lock_read()
 
1828
        try:
 
1829
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1830
                if fp.startswith(relpath):
 
1831
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1832
                    if non_recursive and '/' in fp:
 
1833
                        continue
 
1834
                    if not all and not selection[fc]:
 
1835
                        continue
 
1836
                    if kind is not None and fkind != kind:
 
1837
                        continue
 
1838
                    if verbose:
 
1839
                        kindch = entry.kind_character()
 
1840
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1841
                        if show_ids and fid is not None:
 
1842
                            outstring = "%-50s %s" % (outstring, fid)
 
1843
                        self.outf.write(outstring + '\n')
 
1844
                    elif null:
 
1845
                        self.outf.write(fp + '\0')
 
1846
                        if show_ids:
 
1847
                            if fid is not None:
 
1848
                                self.outf.write(fid)
 
1849
                            self.outf.write('\0')
 
1850
                        self.outf.flush()
 
1851
                    else:
 
1852
                        if fid is not None:
 
1853
                            my_id = fid
 
1854
                        else:
 
1855
                            my_id = ''
 
1856
                        if show_ids:
 
1857
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1858
                        else:
 
1859
                            self.outf.write(fp + '\n')
 
1860
        finally:
 
1861
            tree.unlock()
 
1862
 
 
1863
 
 
1864
class cmd_unknowns(Command):
 
1865
    """List unknown files.
 
1866
    """
 
1867
 
 
1868
    hidden = True
 
1869
    _see_also = ['ls']
 
1870
 
 
1871
    @display_command
 
1872
    def run(self):
 
1873
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1874
            self.outf.write(osutils.quotefn(f) + '\n')
 
1875
 
 
1876
 
 
1877
class cmd_ignore(Command):
 
1878
    """Ignore specified files or patterns.
 
1879
 
 
1880
    See ``bzr help patterns`` for details on the syntax of patterns.
 
1881
 
 
1882
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1883
    After adding, editing or deleting that file either indirectly by
 
1884
    using this command or directly by using an editor, be sure to commit
 
1885
    it.
 
1886
 
 
1887
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1888
    the shell on Unix.
 
1889
 
 
1890
    :Examples:
 
1891
        Ignore the top level Makefile::
 
1892
 
 
1893
            bzr ignore ./Makefile
 
1894
 
 
1895
        Ignore class files in all directories::
 
1896
 
 
1897
            bzr ignore "*.class"
 
1898
 
 
1899
        Ignore .o files under the lib directory::
 
1900
 
 
1901
            bzr ignore "lib/**/*.o"
 
1902
 
 
1903
        Ignore .o files under the lib directory::
 
1904
 
 
1905
            bzr ignore "RE:lib/.*\.o"
 
1906
 
 
1907
        Ignore everything but the "debian" toplevel directory::
 
1908
 
 
1909
            bzr ignore "RE:(?!debian/).*"
 
1910
    """
 
1911
 
 
1912
    _see_also = ['status', 'ignored', 'patterns']
 
1913
    takes_args = ['name_pattern*']
 
1914
    takes_options = [
 
1915
        Option('old-default-rules',
 
1916
               help='Write out the ignore rules bzr < 0.9 always used.')
 
1917
        ]
 
1918
    
 
1919
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1920
        from bzrlib import ignores
 
1921
        if old_default_rules is not None:
 
1922
            # dump the rules and exit
 
1923
            for pattern in ignores.OLD_DEFAULTS:
 
1924
                print pattern
 
1925
            return
 
1926
        if not name_pattern_list:
 
1927
            raise errors.BzrCommandError("ignore requires at least one "
 
1928
                                  "NAME_PATTERN or --old-default-rules")
 
1929
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1930
                             for p in name_pattern_list]
 
1931
        for name_pattern in name_pattern_list:
 
1932
            if (name_pattern[0] == '/' or 
 
1933
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1934
                raise errors.BzrCommandError(
 
1935
                    "NAME_PATTERN should not be an absolute path")
 
1936
        tree, relpath = WorkingTree.open_containing(u'.')
 
1937
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
1938
        ignored = globbing.Globster(name_pattern_list)
 
1939
        matches = []
 
1940
        tree.lock_read()
 
1941
        for entry in tree.list_files():
 
1942
            id = entry[3]
 
1943
            if id is not None:
 
1944
                filename = entry[0]
 
1945
                if ignored.match(filename):
 
1946
                    matches.append(filename.encode('utf-8'))
 
1947
        tree.unlock()
 
1948
        if len(matches) > 0:
 
1949
            print "Warning: the following files are version controlled and" \
 
1950
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
1951
 
 
1952
 
 
1953
class cmd_ignored(Command):
 
1954
    """List ignored files and the patterns that matched them.
 
1955
 
 
1956
    List all the ignored files and the ignore pattern that caused the file to
 
1957
    be ignored.
 
1958
 
 
1959
    Alternatively, to list just the files::
 
1960
 
 
1961
        bzr ls --ignored
 
1962
    """
 
1963
 
 
1964
    encoding_type = 'replace'
 
1965
    _see_also = ['ignore', 'ls']
 
1966
 
 
1967
    @display_command
 
1968
    def run(self):
 
1969
        tree = WorkingTree.open_containing(u'.')[0]
 
1970
        tree.lock_read()
 
1971
        try:
 
1972
            for path, file_class, kind, file_id, entry in tree.list_files():
 
1973
                if file_class != 'I':
 
1974
                    continue
 
1975
                ## XXX: Slightly inefficient since this was already calculated
 
1976
                pat = tree.is_ignored(path)
 
1977
                self.outf.write('%-50s %s\n' % (path, pat))
 
1978
        finally:
 
1979
            tree.unlock()
 
1980
 
 
1981
 
 
1982
class cmd_lookup_revision(Command):
 
1983
    """Lookup the revision-id from a revision-number
 
1984
 
 
1985
    :Examples:
 
1986
        bzr lookup-revision 33
 
1987
    """
 
1988
    hidden = True
 
1989
    takes_args = ['revno']
 
1990
    
 
1991
    @display_command
 
1992
    def run(self, revno):
 
1993
        try:
 
1994
            revno = int(revno)
 
1995
        except ValueError:
 
1996
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
1997
 
 
1998
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1999
 
 
2000
 
 
2001
class cmd_export(Command):
 
2002
    """Export current or past revision to a destination directory or archive.
 
2003
 
 
2004
    If no revision is specified this exports the last committed revision.
 
2005
 
 
2006
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2007
    given, try to find the format with the extension. If no extension
 
2008
    is found exports to a directory (equivalent to --format=dir).
 
2009
 
 
2010
    If root is supplied, it will be used as the root directory inside
 
2011
    container formats (tar, zip, etc). If it is not supplied it will default
 
2012
    to the exported filename. The root option has no effect for 'dir' format.
 
2013
 
 
2014
    If branch is omitted then the branch containing the current working
 
2015
    directory will be used.
 
2016
 
 
2017
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2018
 
 
2019
      =================       =========================
 
2020
      Supported formats       Autodetected by extension
 
2021
      =================       =========================
 
2022
         dir                         (none)
 
2023
         tar                          .tar
 
2024
         tbz2                    .tar.bz2, .tbz2
 
2025
         tgz                      .tar.gz, .tgz
 
2026
         zip                          .zip
 
2027
      =================       =========================
 
2028
    """
 
2029
    takes_args = ['dest', 'branch_or_subdir?']
 
2030
    takes_options = [
 
2031
        Option('format',
 
2032
               help="Type of file to export to.",
 
2033
               type=unicode),
 
2034
        'revision',
 
2035
        Option('root',
 
2036
               type=str,
 
2037
               help="Name of the root directory inside the exported file."),
 
2038
        ]
 
2039
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2040
        root=None):
 
2041
        from bzrlib.export import export
 
2042
 
 
2043
        if branch_or_subdir is None:
 
2044
            tree = WorkingTree.open_containing(u'.')[0]
 
2045
            b = tree.branch
 
2046
            subdir = None
 
2047
        else:
 
2048
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2049
            
 
2050
        if revision is None:
 
2051
            # should be tree.last_revision  FIXME
 
2052
            rev_id = b.last_revision()
 
2053
        else:
 
2054
            if len(revision) != 1:
 
2055
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2056
            rev_id = revision[0].as_revision_id(b)
 
2057
        t = b.repository.revision_tree(rev_id)
 
2058
        try:
 
2059
            export(t, dest, format, root, subdir)
 
2060
        except errors.NoSuchExportFormat, e:
 
2061
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2062
 
 
2063
 
 
2064
class cmd_cat(Command):
 
2065
    """Write the contents of a file as of a given revision to standard output.
 
2066
 
 
2067
    If no revision is nominated, the last revision is used.
 
2068
 
 
2069
    Note: Take care to redirect standard output when using this command on a
 
2070
    binary file. 
 
2071
    """
 
2072
 
 
2073
    _see_also = ['ls']
 
2074
    takes_options = [
 
2075
        Option('name-from-revision', help='The path name in the old tree.'),
 
2076
        'revision',
 
2077
        ]
 
2078
    takes_args = ['filename']
 
2079
    encoding_type = 'exact'
 
2080
 
 
2081
    @display_command
 
2082
    def run(self, filename, revision=None, name_from_revision=False):
 
2083
        if revision is not None and len(revision) != 1:
 
2084
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2085
                                         " one revision specifier")
 
2086
        tree, branch, relpath = \
 
2087
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2088
        branch.lock_read()
 
2089
        try:
 
2090
            return self._run(tree, branch, relpath, filename, revision,
 
2091
                             name_from_revision)
 
2092
        finally:
 
2093
            branch.unlock()
 
2094
 
 
2095
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2096
        if tree is None:
 
2097
            tree = b.basis_tree()
 
2098
        if revision is None:
 
2099
            revision_id = b.last_revision()
 
2100
        else:
 
2101
            revision_id = revision[0].as_revision_id(b)
 
2102
 
 
2103
        cur_file_id = tree.path2id(relpath)
 
2104
        rev_tree = b.repository.revision_tree(revision_id)
 
2105
        old_file_id = rev_tree.path2id(relpath)
 
2106
        
 
2107
        if name_from_revision:
 
2108
            if old_file_id is None:
 
2109
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2110
                                                % (filename, revision_id))
 
2111
            else:
 
2112
                content = rev_tree.get_file_text(old_file_id)
 
2113
        elif cur_file_id is not None:
 
2114
            content = rev_tree.get_file_text(cur_file_id)
 
2115
        elif old_file_id is not None:
 
2116
            content = rev_tree.get_file_text(old_file_id)
 
2117
        else:
 
2118
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2119
                                         (filename, revision_id))
 
2120
        self.outf.write(content)
 
2121
 
 
2122
 
 
2123
class cmd_local_time_offset(Command):
 
2124
    """Show the offset in seconds from GMT to local time."""
 
2125
    hidden = True    
 
2126
    @display_command
 
2127
    def run(self):
 
2128
        print osutils.local_time_offset()
 
2129
 
 
2130
 
 
2131
 
 
2132
class cmd_commit(Command):
 
2133
    """Commit changes into a new revision.
 
2134
    
 
2135
    If no arguments are given, the entire tree is committed.
 
2136
 
 
2137
    If selected files are specified, only changes to those files are
 
2138
    committed.  If a directory is specified then the directory and everything 
 
2139
    within it is committed.
 
2140
 
 
2141
    When excludes are given, they take precedence over selected files.
 
2142
    For example, too commit only changes within foo, but not changes within
 
2143
    foo/bar::
 
2144
 
 
2145
      bzr commit foo -x foo/bar
 
2146
 
 
2147
    If author of the change is not the same person as the committer, you can
 
2148
    specify the author's name using the --author option. The name should be
 
2149
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2150
 
 
2151
    A selected-file commit may fail in some cases where the committed
 
2152
    tree would be invalid. Consider::
 
2153
 
 
2154
      bzr init foo
 
2155
      mkdir foo/bar
 
2156
      bzr add foo/bar
 
2157
      bzr commit foo -m "committing foo"
 
2158
      bzr mv foo/bar foo/baz
 
2159
      mkdir foo/bar
 
2160
      bzr add foo/bar
 
2161
      bzr commit foo/bar -m "committing bar but not baz"
 
2162
 
 
2163
    In the example above, the last commit will fail by design. This gives
 
2164
    the user the opportunity to decide whether they want to commit the
 
2165
    rename at the same time, separately first, or not at all. (As a general
 
2166
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2167
 
 
2168
    Note: A selected-file commit after a merge is not yet supported.
 
2169
    """
 
2170
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2171
 
 
2172
    # TODO: Strict commit that fails if there are deleted files.
 
2173
    #       (what does "deleted files" mean ??)
 
2174
 
 
2175
    # TODO: Give better message for -s, --summary, used by tla people
 
2176
 
 
2177
    # XXX: verbose currently does nothing
 
2178
 
 
2179
    _see_also = ['bugs', 'uncommit']
 
2180
    takes_args = ['selected*']
 
2181
    takes_options = [
 
2182
            ListOption('exclude', type=str, short_name='x',
 
2183
                help="Do not consider changes made to a given path."),
 
2184
            Option('message', type=unicode,
 
2185
                   short_name='m',
 
2186
                   help="Description of the new revision."),
 
2187
            'verbose',
 
2188
             Option('unchanged',
 
2189
                    help='Commit even if nothing has changed.'),
 
2190
             Option('file', type=str,
 
2191
                    short_name='F',
 
2192
                    argname='msgfile',
 
2193
                    help='Take commit message from this file.'),
 
2194
             Option('strict',
 
2195
                    help="Refuse to commit if there are unknown "
 
2196
                    "files in the working tree."),
 
2197
             ListOption('fixes', type=str,
 
2198
                    help="Mark a bug as being fixed by this revision."),
 
2199
             Option('author', type=unicode,
 
2200
                    help="Set the author's name, if it's different "
 
2201
                         "from the committer."),
 
2202
             Option('local',
 
2203
                    help="Perform a local commit in a bound "
 
2204
                         "branch.  Local commits are not pushed to "
 
2205
                         "the master branch until a normal commit "
 
2206
                         "is performed."
 
2207
                    ),
 
2208
              Option('show-diff',
 
2209
                     help='When no message is supplied, show the diff along'
 
2210
                     ' with the status summary in the message editor.'),
 
2211
             ]
 
2212
    aliases = ['ci', 'checkin']
 
2213
 
 
2214
    def _get_bug_fix_properties(self, fixes, branch):
 
2215
        properties = []
 
2216
        # Configure the properties for bug fixing attributes.
 
2217
        for fixed_bug in fixes:
 
2218
            tokens = fixed_bug.split(':')
 
2219
            if len(tokens) != 2:
 
2220
                raise errors.BzrCommandError(
 
2221
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2222
                    "Commit refused." % fixed_bug)
 
2223
            tag, bug_id = tokens
 
2224
            try:
 
2225
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
2226
            except errors.UnknownBugTrackerAbbreviation:
 
2227
                raise errors.BzrCommandError(
 
2228
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2229
            except errors.MalformedBugIdentifier:
 
2230
                raise errors.BzrCommandError(
 
2231
                    "Invalid bug identifier for %s. Commit refused."
 
2232
                    % fixed_bug)
 
2233
            properties.append('%s fixed' % bug_url)
 
2234
        return '\n'.join(properties)
 
2235
 
 
2236
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2237
            unchanged=False, strict=False, local=False, fixes=None,
 
2238
            author=None, show_diff=False, exclude=None):
 
2239
        from bzrlib.errors import (
 
2240
            PointlessCommit,
 
2241
            ConflictsInTree,
 
2242
            StrictCommitFailed
 
2243
        )
 
2244
        from bzrlib.msgeditor import (
 
2245
            edit_commit_message_encoded,
 
2246
            make_commit_message_template_encoded
 
2247
        )
 
2248
 
 
2249
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2250
        # slightly problematic to run this cross-platform.
 
2251
 
 
2252
        # TODO: do more checks that the commit will succeed before 
 
2253
        # spending the user's valuable time typing a commit message.
 
2254
 
 
2255
        properties = {}
 
2256
 
 
2257
        tree, selected_list = tree_files(selected_list)
 
2258
        if selected_list == ['']:
 
2259
            # workaround - commit of root of tree should be exactly the same
 
2260
            # as just default commit in that tree, and succeed even though
 
2261
            # selected-file merge commit is not done yet
 
2262
            selected_list = []
 
2263
 
 
2264
        if fixes is None:
 
2265
            fixes = []
 
2266
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
2267
        if bug_property:
 
2268
            properties['bugs'] = bug_property
 
2269
 
 
2270
        if local and not tree.branch.get_bound_location():
 
2271
            raise errors.LocalRequiresBoundBranch()
 
2272
 
 
2273
        def get_message(commit_obj):
 
2274
            """Callback to get commit message"""
 
2275
            my_message = message
 
2276
            if my_message is None and not file:
 
2277
                t = make_commit_message_template_encoded(tree,
 
2278
                        selected_list, diff=show_diff,
 
2279
                        output_encoding=bzrlib.user_encoding)
 
2280
                my_message = edit_commit_message_encoded(t)
 
2281
                if my_message is None:
 
2282
                    raise errors.BzrCommandError("please specify a commit"
 
2283
                        " message with either --message or --file")
 
2284
            elif my_message and file:
 
2285
                raise errors.BzrCommandError(
 
2286
                    "please specify either --message or --file")
 
2287
            if file:
 
2288
                my_message = codecs.open(file, 'rt',
 
2289
                                         bzrlib.user_encoding).read()
 
2290
            if my_message == "":
 
2291
                raise errors.BzrCommandError("empty commit message specified")
 
2292
            return my_message
 
2293
 
 
2294
        try:
 
2295
            tree.commit(message_callback=get_message,
 
2296
                        specific_files=selected_list,
 
2297
                        allow_pointless=unchanged, strict=strict, local=local,
 
2298
                        reporter=None, verbose=verbose, revprops=properties,
 
2299
                        author=author,
 
2300
                        exclude=safe_relpath_files(tree, exclude))
 
2301
        except PointlessCommit:
 
2302
            # FIXME: This should really happen before the file is read in;
 
2303
            # perhaps prepare the commit; get the message; then actually commit
 
2304
            raise errors.BzrCommandError("no changes to commit."
 
2305
                              " use --unchanged to commit anyhow")
 
2306
        except ConflictsInTree:
 
2307
            raise errors.BzrCommandError('Conflicts detected in working '
 
2308
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2309
                ' resolve.')
 
2310
        except StrictCommitFailed:
 
2311
            raise errors.BzrCommandError("Commit refused because there are"
 
2312
                              " unknown files in the working tree.")
 
2313
        except errors.BoundBranchOutOfDate, e:
 
2314
            raise errors.BzrCommandError(str(e) + "\n"
 
2315
            'To commit to master branch, run update and then commit.\n'
 
2316
            'You can also pass --local to commit to continue working '
 
2317
            'disconnected.')
 
2318
 
 
2319
 
 
2320
class cmd_check(Command):
 
2321
    """Validate working tree structure, branch consistency and repository history.
 
2322
 
 
2323
    This command checks various invariants about branch and repository storage
 
2324
    to detect data corruption or bzr bugs.
 
2325
 
 
2326
    The working tree and branch checks will only give output if a problem is
 
2327
    detected. The output fields of the repository check are:
 
2328
 
 
2329
        revisions: This is just the number of revisions checked.  It doesn't
 
2330
            indicate a problem.
 
2331
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2332
            doesn't indicate a problem.
 
2333
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2334
            are not properly referenced by the revision ancestry.  This is a
 
2335
            subtle problem that Bazaar can work around.
 
2336
        unique file texts: This is the total number of unique file contents
 
2337
            seen in the checked revisions.  It does not indicate a problem.
 
2338
        repeated file texts: This is the total number of repeated texts seen
 
2339
            in the checked revisions.  Texts can be repeated when their file
 
2340
            entries are modified, but the file contents are not.  It does not
 
2341
            indicate a problem.
 
2342
 
 
2343
    If no restrictions are specified, all Bazaar data that is found at the given
 
2344
    location will be checked.
 
2345
 
 
2346
    :Examples:
 
2347
 
 
2348
        Check the tree and branch at 'foo'::
 
2349
 
 
2350
            bzr check --tree --branch foo
 
2351
 
 
2352
        Check only the repository at 'bar'::
 
2353
 
 
2354
            bzr check --repo bar
 
2355
 
 
2356
        Check everything at 'baz'::
 
2357
 
 
2358
            bzr check baz
 
2359
    """
 
2360
 
 
2361
    _see_also = ['reconcile']
 
2362
    takes_args = ['path?']
 
2363
    takes_options = ['verbose',
 
2364
                     Option('branch', help="Check the branch related to the"
 
2365
                                           " current directory."),
 
2366
                     Option('repo', help="Check the repository related to the"
 
2367
                                         " current directory."),
 
2368
                     Option('tree', help="Check the working tree related to"
 
2369
                                         " the current directory.")]
 
2370
 
 
2371
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
2372
            tree=False):
 
2373
        from bzrlib.check import check_dwim
 
2374
        if path is None:
 
2375
            path = '.'
 
2376
        if not branch and not repo and not tree:
 
2377
            branch = repo = tree = True
 
2378
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2379
 
 
2380
 
 
2381
class cmd_upgrade(Command):
 
2382
    """Upgrade branch storage to current format.
 
2383
 
 
2384
    The check command or bzr developers may sometimes advise you to run
 
2385
    this command. When the default format has changed you may also be warned
 
2386
    during other operations to upgrade.
 
2387
    """
 
2388
 
 
2389
    _see_also = ['check']
 
2390
    takes_args = ['url?']
 
2391
    takes_options = [
 
2392
                    RegistryOption('format',
 
2393
                        help='Upgrade to a specific format.  See "bzr help'
 
2394
                             ' formats" for details.',
 
2395
                        registry=bzrdir.format_registry,
 
2396
                        converter=bzrdir.format_registry.make_bzrdir,
 
2397
                        value_switches=True, title='Branch format'),
 
2398
                    ]
 
2399
 
 
2400
    def run(self, url='.', format=None):
 
2401
        from bzrlib.upgrade import upgrade
 
2402
        if format is None:
 
2403
            format = bzrdir.format_registry.make_bzrdir('default')
 
2404
        upgrade(url, format)
 
2405
 
 
2406
 
 
2407
class cmd_whoami(Command):
 
2408
    """Show or set bzr user id.
 
2409
    
 
2410
    :Examples:
 
2411
        Show the email of the current user::
 
2412
 
 
2413
            bzr whoami --email
 
2414
 
 
2415
        Set the current user::
 
2416
 
 
2417
            bzr whoami "Frank Chu <fchu@example.com>"
 
2418
    """
 
2419
    takes_options = [ Option('email',
 
2420
                             help='Display email address only.'),
 
2421
                      Option('branch',
 
2422
                             help='Set identity for the current branch instead of '
 
2423
                                  'globally.'),
 
2424
                    ]
 
2425
    takes_args = ['name?']
 
2426
    encoding_type = 'replace'
 
2427
    
 
2428
    @display_command
 
2429
    def run(self, email=False, branch=False, name=None):
 
2430
        if name is None:
 
2431
            # use branch if we're inside one; otherwise global config
 
2432
            try:
 
2433
                c = Branch.open_containing('.')[0].get_config()
 
2434
            except errors.NotBranchError:
 
2435
                c = config.GlobalConfig()
 
2436
            if email:
 
2437
                self.outf.write(c.user_email() + '\n')
 
2438
            else:
 
2439
                self.outf.write(c.username() + '\n')
 
2440
            return
 
2441
 
 
2442
        # display a warning if an email address isn't included in the given name.
 
2443
        try:
 
2444
            config.extract_email_address(name)
 
2445
        except errors.NoEmailInUsername, e:
 
2446
            warning('"%s" does not seem to contain an email address.  '
 
2447
                    'This is allowed, but not recommended.', name)
 
2448
        
 
2449
        # use global config unless --branch given
 
2450
        if branch:
 
2451
            c = Branch.open_containing('.')[0].get_config()
 
2452
        else:
 
2453
            c = config.GlobalConfig()
 
2454
        c.set_user_option('email', name)
 
2455
 
 
2456
 
 
2457
class cmd_nick(Command):
 
2458
    """Print or set the branch nickname.  
 
2459
 
 
2460
    If unset, the tree root directory name is used as the nickname
 
2461
    To print the current nickname, execute with no argument.  
 
2462
    """
 
2463
 
 
2464
    _see_also = ['info']
 
2465
    takes_args = ['nickname?']
 
2466
    def run(self, nickname=None):
 
2467
        branch = Branch.open_containing(u'.')[0]
 
2468
        if nickname is None:
 
2469
            self.printme(branch)
 
2470
        else:
 
2471
            branch.nick = nickname
 
2472
 
 
2473
    @display_command
 
2474
    def printme(self, branch):
 
2475
        print branch.nick
 
2476
 
 
2477
 
 
2478
class cmd_alias(Command):
 
2479
    """Set/unset and display aliases.
 
2480
 
 
2481
    :Examples:
 
2482
        Show the current aliases::
 
2483
 
 
2484
            bzr alias
 
2485
 
 
2486
        Show the alias specified for 'll'::
 
2487
 
 
2488
            bzr alias ll
 
2489
 
 
2490
        Set an alias for 'll'::
 
2491
 
 
2492
            bzr alias ll="log --line -r-10..-1"
 
2493
 
 
2494
        To remove an alias for 'll'::
 
2495
 
 
2496
            bzr alias --remove ll
 
2497
 
 
2498
    """
 
2499
    takes_args = ['name?']
 
2500
    takes_options = [
 
2501
        Option('remove', help='Remove the alias.'),
 
2502
        ]
 
2503
 
 
2504
    def run(self, name=None, remove=False):
 
2505
        if remove:
 
2506
            self.remove_alias(name)
 
2507
        elif name is None:
 
2508
            self.print_aliases()
 
2509
        else:
 
2510
            equal_pos = name.find('=')
 
2511
            if equal_pos == -1:
 
2512
                self.print_alias(name)
 
2513
            else:
 
2514
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
2515
 
 
2516
    def remove_alias(self, alias_name):
 
2517
        if alias_name is None:
 
2518
            raise errors.BzrCommandError(
 
2519
                'bzr alias --remove expects an alias to remove.')
 
2520
        # If alias is not found, print something like:
 
2521
        # unalias: foo: not found
 
2522
        c = config.GlobalConfig()
 
2523
        c.unset_alias(alias_name)
 
2524
 
 
2525
    @display_command
 
2526
    def print_aliases(self):
 
2527
        """Print out the defined aliases in a similar format to bash."""
 
2528
        aliases = config.GlobalConfig().get_aliases()
 
2529
        for key, value in sorted(aliases.iteritems()):
 
2530
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
2531
 
 
2532
    @display_command
 
2533
    def print_alias(self, alias_name):
 
2534
        from bzrlib.commands import get_alias
 
2535
        alias = get_alias(alias_name)
 
2536
        if alias is None:
 
2537
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
2538
        else:
 
2539
            self.outf.write(
 
2540
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
2541
 
 
2542
    def set_alias(self, alias_name, alias_command):
 
2543
        """Save the alias in the global config."""
 
2544
        c = config.GlobalConfig()
 
2545
        c.set_alias(alias_name, alias_command)
 
2546
 
 
2547
 
 
2548
class cmd_selftest(Command):
 
2549
    """Run internal test suite.
 
2550
    
 
2551
    If arguments are given, they are regular expressions that say which tests
 
2552
    should run.  Tests matching any expression are run, and other tests are
 
2553
    not run.
 
2554
 
 
2555
    Alternatively if --first is given, matching tests are run first and then
 
2556
    all other tests are run.  This is useful if you have been working in a
 
2557
    particular area, but want to make sure nothing else was broken.
 
2558
 
 
2559
    If --exclude is given, tests that match that regular expression are
 
2560
    excluded, regardless of whether they match --first or not.
 
2561
 
 
2562
    To help catch accidential dependencies between tests, the --randomize
 
2563
    option is useful. In most cases, the argument used is the word 'now'.
 
2564
    Note that the seed used for the random number generator is displayed
 
2565
    when this option is used. The seed can be explicitly passed as the
 
2566
    argument to this option if required. This enables reproduction of the
 
2567
    actual ordering used if and when an order sensitive problem is encountered.
 
2568
 
 
2569
    If --list-only is given, the tests that would be run are listed. This is
 
2570
    useful when combined with --first, --exclude and/or --randomize to
 
2571
    understand their impact. The test harness reports "Listed nn tests in ..."
 
2572
    instead of "Ran nn tests in ..." when list mode is enabled.
 
2573
 
 
2574
    If the global option '--no-plugins' is given, plugins are not loaded
 
2575
    before running the selftests.  This has two effects: features provided or
 
2576
    modified by plugins will not be tested, and tests provided by plugins will
 
2577
    not be run.
 
2578
 
 
2579
    Tests that need working space on disk use a common temporary directory, 
 
2580
    typically inside $TMPDIR or /tmp.
 
2581
 
 
2582
    :Examples:
 
2583
        Run only tests relating to 'ignore'::
 
2584
 
 
2585
            bzr selftest ignore
 
2586
 
 
2587
        Disable plugins and list tests as they're run::
 
2588
 
 
2589
            bzr --no-plugins selftest -v
 
2590
    """
 
2591
    # NB: this is used from the class without creating an instance, which is
 
2592
    # why it does not have a self parameter.
 
2593
    def get_transport_type(typestring):
 
2594
        """Parse and return a transport specifier."""
 
2595
        if typestring == "sftp":
 
2596
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2597
            return SFTPAbsoluteServer
 
2598
        if typestring == "memory":
 
2599
            from bzrlib.transport.memory import MemoryServer
 
2600
            return MemoryServer
 
2601
        if typestring == "fakenfs":
 
2602
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2603
            return FakeNFSServer
 
2604
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2605
            (typestring)
 
2606
        raise errors.BzrCommandError(msg)
 
2607
 
 
2608
    hidden = True
 
2609
    takes_args = ['testspecs*']
 
2610
    takes_options = ['verbose',
 
2611
                     Option('one',
 
2612
                             help='Stop when one test fails.',
 
2613
                             short_name='1',
 
2614
                             ),
 
2615
                     Option('transport',
 
2616
                            help='Use a different transport by default '
 
2617
                                 'throughout the test suite.',
 
2618
                            type=get_transport_type),
 
2619
                     Option('benchmark',
 
2620
                            help='Run the benchmarks rather than selftests.'),
 
2621
                     Option('lsprof-timed',
 
2622
                            help='Generate lsprof output for benchmarked'
 
2623
                                 ' sections of code.'),
 
2624
                     Option('cache-dir', type=str,
 
2625
                            help='Cache intermediate benchmark output in this '
 
2626
                                 'directory.'),
 
2627
                     Option('first',
 
2628
                            help='Run all tests, but run specified tests first.',
 
2629
                            short_name='f',
 
2630
                            ),
 
2631
                     Option('list-only',
 
2632
                            help='List the tests instead of running them.'),
 
2633
                     Option('randomize', type=str, argname="SEED",
 
2634
                            help='Randomize the order of tests using the given'
 
2635
                                 ' seed or "now" for the current time.'),
 
2636
                     Option('exclude', type=str, argname="PATTERN",
 
2637
                            short_name='x',
 
2638
                            help='Exclude tests that match this regular'
 
2639
                                 ' expression.'),
 
2640
                     Option('strict', help='Fail on missing dependencies or '
 
2641
                            'known failures.'),
 
2642
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
2643
                            help='Load a test id list from a text file.'),
 
2644
                     ListOption('debugflag', type=str, short_name='E',
 
2645
                                help='Turn on a selftest debug flag.'),
 
2646
                     Option('starting-with', type=str, argname='TESTID',
 
2647
                            short_name='s',
 
2648
                            help='Load only the tests starting with TESTID.'),
 
2649
                     ]
 
2650
    encoding_type = 'replace'
 
2651
 
 
2652
    def run(self, testspecs_list=None, verbose=False, one=False,
 
2653
            transport=None, benchmark=None,
 
2654
            lsprof_timed=None, cache_dir=None,
 
2655
            first=False, list_only=False,
 
2656
            randomize=None, exclude=None, strict=False,
 
2657
            load_list=None, debugflag=None, starting_with=None):
 
2658
        import bzrlib.ui
 
2659
        from bzrlib.tests import selftest
 
2660
        import bzrlib.benchmarks as benchmarks
 
2661
        from bzrlib.benchmarks import tree_creator
 
2662
 
 
2663
        # Make deprecation warnings visible, unless -Werror is set
 
2664
        symbol_versioning.activate_deprecation_warnings(override=False)
 
2665
 
 
2666
        if cache_dir is not None:
 
2667
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2668
        if not list_only:
 
2669
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2670
            print '   %s (%s python%s)' % (
 
2671
                    bzrlib.__path__[0],
 
2672
                    bzrlib.version_string,
 
2673
                    bzrlib._format_version_tuple(sys.version_info),
 
2674
                    )
 
2675
        print
 
2676
        if testspecs_list is not None:
 
2677
            pattern = '|'.join(testspecs_list)
 
2678
        else:
 
2679
            pattern = ".*"
 
2680
        if benchmark:
 
2681
            test_suite_factory = benchmarks.test_suite
 
2682
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2683
            verbose = not is_quiet()
 
2684
            # TODO: should possibly lock the history file...
 
2685
            benchfile = open(".perf_history", "at", buffering=1)
 
2686
        else:
 
2687
            test_suite_factory = None
 
2688
            benchfile = None
 
2689
        try:
 
2690
            result = selftest(verbose=verbose,
 
2691
                              pattern=pattern,
 
2692
                              stop_on_failure=one,
 
2693
                              transport=transport,
 
2694
                              test_suite_factory=test_suite_factory,
 
2695
                              lsprof_timed=lsprof_timed,
 
2696
                              bench_history=benchfile,
 
2697
                              matching_tests_first=first,
 
2698
                              list_only=list_only,
 
2699
                              random_seed=randomize,
 
2700
                              exclude_pattern=exclude,
 
2701
                              strict=strict,
 
2702
                              load_list=load_list,
 
2703
                              debug_flags=debugflag,
 
2704
                              starting_with=starting_with,
 
2705
                              )
 
2706
        finally:
 
2707
            if benchfile is not None:
 
2708
                benchfile.close()
 
2709
        if result:
 
2710
            note('tests passed')
 
2711
        else:
 
2712
            note('tests failed')
 
2713
        return int(not result)
 
2714
 
 
2715
 
 
2716
class cmd_version(Command):
 
2717
    """Show version of bzr."""
 
2718
 
 
2719
    encoding_type = 'replace'
 
2720
    takes_options = [
 
2721
        Option("short", help="Print just the version number."),
 
2722
        ]
 
2723
 
 
2724
    @display_command
 
2725
    def run(self, short=False):
 
2726
        from bzrlib.version import show_version
 
2727
        if short:
 
2728
            self.outf.write(bzrlib.version_string + '\n')
 
2729
        else:
 
2730
            show_version(to_file=self.outf)
 
2731
 
 
2732
 
 
2733
class cmd_rocks(Command):
 
2734
    """Statement of optimism."""
 
2735
 
 
2736
    hidden = True
 
2737
 
 
2738
    @display_command
 
2739
    def run(self):
 
2740
        print "It sure does!"
 
2741
 
 
2742
 
 
2743
class cmd_find_merge_base(Command):
 
2744
    """Find and print a base revision for merging two branches."""
 
2745
    # TODO: Options to specify revisions on either side, as if
 
2746
    #       merging only part of the history.
 
2747
    takes_args = ['branch', 'other']
 
2748
    hidden = True
 
2749
    
 
2750
    @display_command
 
2751
    def run(self, branch, other):
 
2752
        from bzrlib.revision import ensure_null
 
2753
        
 
2754
        branch1 = Branch.open_containing(branch)[0]
 
2755
        branch2 = Branch.open_containing(other)[0]
 
2756
        branch1.lock_read()
 
2757
        try:
 
2758
            branch2.lock_read()
 
2759
            try:
 
2760
                last1 = ensure_null(branch1.last_revision())
 
2761
                last2 = ensure_null(branch2.last_revision())
 
2762
 
 
2763
                graph = branch1.repository.get_graph(branch2.repository)
 
2764
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2765
 
 
2766
                print 'merge base is revision %s' % base_rev_id
 
2767
            finally:
 
2768
                branch2.unlock()
 
2769
        finally:
 
2770
            branch1.unlock()
 
2771
 
 
2772
 
 
2773
class cmd_merge(Command):
 
2774
    """Perform a three-way merge.
 
2775
    
 
2776
    The source of the merge can be specified either in the form of a branch,
 
2777
    or in the form of a path to a file containing a merge directive generated
 
2778
    with bzr send. If neither is specified, the default is the upstream branch
 
2779
    or the branch most recently merged using --remember.
 
2780
 
 
2781
    When merging a branch, by default the tip will be merged. To pick a different
 
2782
    revision, pass --revision. If you specify two values, the first will be used as
 
2783
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
2784
    available revisions, like this is commonly referred to as "cherrypicking".
 
2785
 
 
2786
    Revision numbers are always relative to the branch being merged.
 
2787
 
 
2788
    By default, bzr will try to merge in all new work from the other
 
2789
    branch, automatically determining an appropriate base.  If this
 
2790
    fails, you may need to give an explicit base.
 
2791
    
 
2792
    Merge will do its best to combine the changes in two branches, but there
 
2793
    are some kinds of problems only a human can fix.  When it encounters those,
 
2794
    it will mark a conflict.  A conflict means that you need to fix something,
 
2795
    before you should commit.
 
2796
 
 
2797
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2798
 
 
2799
    If there is no default branch set, the first merge will set it. After
 
2800
    that, you can omit the branch to use the default.  To change the
 
2801
    default, use --remember. The value will only be saved if the remote
 
2802
    location can be accessed.
 
2803
 
 
2804
    The results of the merge are placed into the destination working
 
2805
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2806
    committed to record the result of the merge.
 
2807
    
 
2808
    merge refuses to run if there are any uncommitted changes, unless
 
2809
    --force is given.
 
2810
 
 
2811
    :Examples:
 
2812
        To merge the latest revision from bzr.dev::
 
2813
 
 
2814
            bzr merge ../bzr.dev
 
2815
 
 
2816
        To merge changes up to and including revision 82 from bzr.dev::
 
2817
 
 
2818
            bzr merge -r 82 ../bzr.dev
 
2819
 
 
2820
        To merge the changes introduced by 82, without previous changes::
 
2821
 
 
2822
            bzr merge -r 81..82 ../bzr.dev
 
2823
 
 
2824
        To apply a merge directive contained in in /tmp/merge:
 
2825
 
 
2826
            bzr merge /tmp/merge
 
2827
    """
 
2828
 
 
2829
    encoding_type = 'exact'
 
2830
    _see_also = ['update', 'remerge', 'status-flags']
 
2831
    takes_args = ['location?']
 
2832
    takes_options = [
 
2833
        'change',
 
2834
        'revision',
 
2835
        Option('force',
 
2836
               help='Merge even if the destination tree has uncommitted changes.'),
 
2837
        'merge-type',
 
2838
        'reprocess',
 
2839
        'remember',
 
2840
        Option('show-base', help="Show base revision text in "
 
2841
               "conflicts."),
 
2842
        Option('uncommitted', help='Apply uncommitted changes'
 
2843
               ' from a working copy, instead of branch changes.'),
 
2844
        Option('pull', help='If the destination is already'
 
2845
                ' completely merged into the source, pull from the'
 
2846
                ' source rather than merging.  When this happens,'
 
2847
                ' you do not need to commit the result.'),
 
2848
        Option('directory',
 
2849
               help='Branch to merge into, '
 
2850
                    'rather than the one containing the working directory.',
 
2851
               short_name='d',
 
2852
               type=unicode,
 
2853
               ),
 
2854
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
2855
    ]
 
2856
 
 
2857
    def run(self, location=None, revision=None, force=False,
 
2858
            merge_type=None, show_base=False, reprocess=False, remember=False,
 
2859
            uncommitted=False, pull=False,
 
2860
            directory=None,
 
2861
            preview=False,
 
2862
            ):
 
2863
        if merge_type is None:
 
2864
            merge_type = _mod_merge.Merge3Merger
 
2865
 
 
2866
        if directory is None: directory = u'.'
 
2867
        possible_transports = []
 
2868
        merger = None
 
2869
        allow_pending = True
 
2870
        verified = 'inapplicable'
 
2871
        tree = WorkingTree.open_containing(directory)[0]
 
2872
        change_reporter = delta._ChangeReporter(
 
2873
            unversioned_filter=tree.is_ignored)
 
2874
        cleanups = []
 
2875
        try:
 
2876
            pb = ui.ui_factory.nested_progress_bar()
 
2877
            cleanups.append(pb.finished)
 
2878
            tree.lock_write()
 
2879
            cleanups.append(tree.unlock)
 
2880
            if location is not None:
 
2881
                try:
 
2882
                    mergeable = bundle.read_mergeable_from_url(location,
 
2883
                        possible_transports=possible_transports)
 
2884
                except errors.NotABundle:
 
2885
                    mergeable = None
 
2886
                else:
 
2887
                    if uncommitted:
 
2888
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2889
                            ' with bundles or merge directives.')
 
2890
 
 
2891
                    if revision is not None:
 
2892
                        raise errors.BzrCommandError(
 
2893
                            'Cannot use -r with merge directives or bundles')
 
2894
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2895
                       mergeable, pb)
 
2896
 
 
2897
            if merger is None and uncommitted:
 
2898
                if revision is not None and len(revision) > 0:
 
2899
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2900
                        ' --revision at the same time.')
 
2901
                location = self._select_branch_location(tree, location)[0]
 
2902
                other_tree, other_path = WorkingTree.open_containing(location)
 
2903
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2904
                    pb)
 
2905
                allow_pending = False
 
2906
                if other_path != '':
 
2907
                    merger.interesting_files = [other_path]
 
2908
 
 
2909
            if merger is None:
 
2910
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2911
                    location, revision, remember, possible_transports, pb)
 
2912
 
 
2913
            merger.merge_type = merge_type
 
2914
            merger.reprocess = reprocess
 
2915
            merger.show_base = show_base
 
2916
            self.sanity_check_merger(merger)
 
2917
            if (merger.base_rev_id == merger.other_rev_id and
 
2918
                merger.other_rev_id is not None):
 
2919
                note('Nothing to do.')
 
2920
                return 0
 
2921
            if pull:
 
2922
                if merger.interesting_files is not None:
 
2923
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2924
                if (merger.base_rev_id == tree.last_revision()):
 
2925
                    result = tree.pull(merger.other_branch, False,
 
2926
                                       merger.other_rev_id)
 
2927
                    result.report(self.outf)
 
2928
                    return 0
 
2929
            merger.check_basis(not force)
 
2930
            if preview:
 
2931
                return self._do_preview(merger)
 
2932
            else:
 
2933
                return self._do_merge(merger, change_reporter, allow_pending,
 
2934
                                      verified)
 
2935
        finally:
 
2936
            for cleanup in reversed(cleanups):
 
2937
                cleanup()
 
2938
 
 
2939
    def _do_preview(self, merger):
 
2940
        from bzrlib.diff import show_diff_trees
 
2941
        tree_merger = merger.make_merger()
 
2942
        tt = tree_merger.make_preview_transform()
 
2943
        try:
 
2944
            result_tree = tt.get_preview_tree()
 
2945
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2946
                            old_label='', new_label='')
 
2947
        finally:
 
2948
            tt.finalize()
 
2949
 
 
2950
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
2951
        merger.change_reporter = change_reporter
 
2952
        conflict_count = merger.do_merge()
 
2953
        if allow_pending:
 
2954
            merger.set_pending()
 
2955
        if verified == 'failed':
 
2956
            warning('Preview patch does not match changes')
 
2957
        if conflict_count != 0:
 
2958
            return 1
 
2959
        else:
 
2960
            return 0
 
2961
 
 
2962
    def sanity_check_merger(self, merger):
 
2963
        if (merger.show_base and
 
2964
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2965
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2966
                                         " merge type. %s" % merger.merge_type)
 
2967
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2968
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2969
                                         " for merge type %s." %
 
2970
                                         merger.merge_type)
 
2971
        if merger.reprocess and merger.show_base:
 
2972
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2973
                                         " show base.")
 
2974
 
 
2975
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2976
                                possible_transports, pb):
 
2977
        """Produce a merger from a location, assuming it refers to a branch."""
 
2978
        from bzrlib.tag import _merge_tags_if_possible
 
2979
        # find the branch locations
 
2980
        other_loc, user_location = self._select_branch_location(tree, location,
 
2981
            revision, -1)
 
2982
        if revision is not None and len(revision) == 2:
 
2983
            base_loc, _unused = self._select_branch_location(tree,
 
2984
                location, revision, 0)
 
2985
        else:
 
2986
            base_loc = other_loc
 
2987
        # Open the branches
 
2988
        other_branch, other_path = Branch.open_containing(other_loc,
 
2989
            possible_transports)
 
2990
        if base_loc == other_loc:
 
2991
            base_branch = other_branch
 
2992
        else:
 
2993
            base_branch, base_path = Branch.open_containing(base_loc,
 
2994
                possible_transports)
 
2995
        # Find the revision ids
 
2996
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2997
            other_revision_id = _mod_revision.ensure_null(
 
2998
                other_branch.last_revision())
 
2999
        else:
 
3000
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3001
        if (revision is not None and len(revision) == 2
 
3002
            and revision[0] is not None):
 
3003
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3004
        else:
 
3005
            base_revision_id = None
 
3006
        # Remember where we merge from
 
3007
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3008
             user_location is not None):
 
3009
            tree.branch.set_submit_branch(other_branch.base)
 
3010
        _merge_tags_if_possible(other_branch, tree.branch)
 
3011
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3012
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3013
        if other_path != '':
 
3014
            allow_pending = False
 
3015
            merger.interesting_files = [other_path]
 
3016
        else:
 
3017
            allow_pending = True
 
3018
        return merger, allow_pending
 
3019
 
 
3020
    def _select_branch_location(self, tree, user_location, revision=None,
 
3021
                                index=None):
 
3022
        """Select a branch location, according to possible inputs.
 
3023
 
 
3024
        If provided, branches from ``revision`` are preferred.  (Both
 
3025
        ``revision`` and ``index`` must be supplied.)
 
3026
 
 
3027
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3028
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3029
 
 
3030
        :param tree: The working tree to select a branch for merging into
 
3031
        :param location: The location entered by the user
 
3032
        :param revision: The revision parameter to the command
 
3033
        :param index: The index to use for the revision parameter.  Negative
 
3034
            indices are permitted.
 
3035
        :return: (selected_location, user_location).  The default location
 
3036
            will be the user-entered location.
 
3037
        """
 
3038
        if (revision is not None and index is not None
 
3039
            and revision[index] is not None):
 
3040
            branch = revision[index].get_branch()
 
3041
            if branch is not None:
 
3042
                return branch, branch
 
3043
        if user_location is None:
 
3044
            location = self._get_remembered(tree, 'Merging from')
 
3045
        else:
 
3046
            location = user_location
 
3047
        return location, user_location
 
3048
 
 
3049
    def _get_remembered(self, tree, verb_string):
 
3050
        """Use tree.branch's parent if none was supplied.
 
3051
 
 
3052
        Report if the remembered location was used.
 
3053
        """
 
3054
        stored_location = tree.branch.get_submit_branch()
 
3055
        if stored_location is None:
 
3056
            stored_location = tree.branch.get_parent()
 
3057
        mutter("%s", stored_location)
 
3058
        if stored_location is None:
 
3059
            raise errors.BzrCommandError("No location specified or remembered")
 
3060
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3061
        note(u"%s remembered location %s", verb_string, display_url)
 
3062
        return stored_location
 
3063
 
 
3064
 
 
3065
class cmd_remerge(Command):
 
3066
    """Redo a merge.
 
3067
 
 
3068
    Use this if you want to try a different merge technique while resolving
 
3069
    conflicts.  Some merge techniques are better than others, and remerge 
 
3070
    lets you try different ones on different files.
 
3071
 
 
3072
    The options for remerge have the same meaning and defaults as the ones for
 
3073
    merge.  The difference is that remerge can (only) be run when there is a
 
3074
    pending merge, and it lets you specify particular files.
 
3075
 
 
3076
    :Examples:
 
3077
        Re-do the merge of all conflicted files, and show the base text in
 
3078
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3079
      
 
3080
            bzr remerge --show-base
 
3081
 
 
3082
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3083
        additional processing to reduce the size of conflict regions::
 
3084
      
 
3085
            bzr remerge --merge-type weave --reprocess foobar
 
3086
    """
 
3087
    takes_args = ['file*']
 
3088
    takes_options = [
 
3089
            'merge-type',
 
3090
            'reprocess',
 
3091
            Option('show-base',
 
3092
                   help="Show base revision text in conflicts."),
 
3093
            ]
 
3094
 
 
3095
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3096
            reprocess=False):
 
3097
        if merge_type is None:
 
3098
            merge_type = _mod_merge.Merge3Merger
 
3099
        tree, file_list = tree_files(file_list)
 
3100
        tree.lock_write()
 
3101
        try:
 
3102
            parents = tree.get_parent_ids()
 
3103
            if len(parents) != 2:
 
3104
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3105
                                             " merges.  Not cherrypicking or"
 
3106
                                             " multi-merges.")
 
3107
            repository = tree.branch.repository
 
3108
            interesting_ids = None
 
3109
            new_conflicts = []
 
3110
            conflicts = tree.conflicts()
 
3111
            if file_list is not None:
 
3112
                interesting_ids = set()
 
3113
                for filename in file_list:
 
3114
                    file_id = tree.path2id(filename)
 
3115
                    if file_id is None:
 
3116
                        raise errors.NotVersionedError(filename)
 
3117
                    interesting_ids.add(file_id)
 
3118
                    if tree.kind(file_id) != "directory":
 
3119
                        continue
 
3120
                    
 
3121
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3122
                        interesting_ids.add(ie.file_id)
 
3123
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3124
            else:
 
3125
                # Remerge only supports resolving contents conflicts
 
3126
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3127
                restore_files = [c.path for c in conflicts
 
3128
                                 if c.typestring in allowed_conflicts]
 
3129
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3130
            tree.set_conflicts(ConflictList(new_conflicts))
 
3131
            if file_list is not None:
 
3132
                restore_files = file_list
 
3133
            for filename in restore_files:
 
3134
                try:
 
3135
                    restore(tree.abspath(filename))
 
3136
                except errors.NotConflicted:
 
3137
                    pass
 
3138
            # Disable pending merges, because the file texts we are remerging
 
3139
            # have not had those merges performed.  If we use the wrong parents
 
3140
            # list, we imply that the working tree text has seen and rejected
 
3141
            # all the changes from the other tree, when in fact those changes
 
3142
            # have not yet been seen.
 
3143
            pb = ui.ui_factory.nested_progress_bar()
 
3144
            tree.set_parent_ids(parents[:1])
 
3145
            try:
 
3146
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3147
                                                             tree, parents[1])
 
3148
                merger.interesting_ids = interesting_ids
 
3149
                merger.merge_type = merge_type
 
3150
                merger.show_base = show_base
 
3151
                merger.reprocess = reprocess
 
3152
                conflicts = merger.do_merge()
 
3153
            finally:
 
3154
                tree.set_parent_ids(parents)
 
3155
                pb.finished()
 
3156
        finally:
 
3157
            tree.unlock()
 
3158
        if conflicts > 0:
 
3159
            return 1
 
3160
        else:
 
3161
            return 0
 
3162
 
 
3163
 
 
3164
class cmd_revert(Command):
 
3165
    """Revert files to a previous revision.
 
3166
 
 
3167
    Giving a list of files will revert only those files.  Otherwise, all files
 
3168
    will be reverted.  If the revision is not specified with '--revision', the
 
3169
    last committed revision is used.
 
3170
 
 
3171
    To remove only some changes, without reverting to a prior version, use
 
3172
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3173
    changes introduced by -2, without affecting the changes introduced by -1.
 
3174
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3175
    
 
3176
    By default, any files that have been manually changed will be backed up
 
3177
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3178
    '.~#~' appended to their name, where # is a number.
 
3179
 
 
3180
    When you provide files, you can use their current pathname or the pathname
 
3181
    from the target revision.  So you can use revert to "undelete" a file by
 
3182
    name.  If you name a directory, all the contents of that directory will be
 
3183
    reverted.
 
3184
 
 
3185
    Any files that have been newly added since that revision will be deleted,
 
3186
    with a backup kept if appropriate.  Directories containing unknown files
 
3187
    will not be deleted.
 
3188
 
 
3189
    The working tree contains a list of pending merged revisions, which will
 
3190
    be included as parents in the next commit.  Normally, revert clears that
 
3191
    list as well as reverting the files.  If any files are specified, revert
 
3192
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3193
    revert ." in the tree root to revert all files but keep the merge record,
 
3194
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3195
    reverting any files.
 
3196
    """
 
3197
 
 
3198
    _see_also = ['cat', 'export']
 
3199
    takes_options = [
 
3200
        'revision',
 
3201
        Option('no-backup', "Do not save backups of reverted files."),
 
3202
        Option('forget-merges',
 
3203
               'Remove pending merge marker, without changing any files.'),
 
3204
        ]
 
3205
    takes_args = ['file*']
 
3206
 
 
3207
    def run(self, revision=None, no_backup=False, file_list=None,
 
3208
            forget_merges=None):
 
3209
        tree, file_list = tree_files(file_list)
 
3210
        if forget_merges:
 
3211
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3212
        else:
 
3213
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3214
 
 
3215
    @staticmethod
 
3216
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3217
        if revision is None:
 
3218
            rev_id = tree.last_revision()
 
3219
        elif len(revision) != 1:
 
3220
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3221
        else:
 
3222
            rev_id = revision[0].as_revision_id(tree.branch)
 
3223
        pb = ui.ui_factory.nested_progress_bar()
 
3224
        try:
 
3225
            tree.revert(file_list,
 
3226
                        tree.branch.repository.revision_tree(rev_id),
 
3227
                        not no_backup, pb, report_changes=True)
 
3228
        finally:
 
3229
            pb.finished()
 
3230
 
 
3231
 
 
3232
class cmd_assert_fail(Command):
 
3233
    """Test reporting of assertion failures"""
 
3234
    # intended just for use in testing
 
3235
 
 
3236
    hidden = True
 
3237
 
 
3238
    def run(self):
 
3239
        raise AssertionError("always fails")
 
3240
 
 
3241
 
 
3242
class cmd_help(Command):
 
3243
    """Show help on a command or other topic.
 
3244
    """
 
3245
 
 
3246
    _see_also = ['topics']
 
3247
    takes_options = [
 
3248
            Option('long', 'Show help on all commands.'),
 
3249
            ]
 
3250
    takes_args = ['topic?']
 
3251
    aliases = ['?', '--help', '-?', '-h']
 
3252
    
 
3253
    @display_command
 
3254
    def run(self, topic=None, long=False):
 
3255
        import bzrlib.help
 
3256
        if topic is None and long:
 
3257
            topic = "commands"
 
3258
        bzrlib.help.help(topic)
 
3259
 
 
3260
 
 
3261
class cmd_shell_complete(Command):
 
3262
    """Show appropriate completions for context.
 
3263
 
 
3264
    For a list of all available commands, say 'bzr shell-complete'.
 
3265
    """
 
3266
    takes_args = ['context?']
 
3267
    aliases = ['s-c']
 
3268
    hidden = True
 
3269
    
 
3270
    @display_command
 
3271
    def run(self, context=None):
 
3272
        import shellcomplete
 
3273
        shellcomplete.shellcomplete(context)
 
3274
 
 
3275
 
 
3276
class cmd_missing(Command):
 
3277
    """Show unmerged/unpulled revisions between two branches.
 
3278
    
 
3279
    OTHER_BRANCH may be local or remote.
 
3280
    """
 
3281
 
 
3282
    _see_also = ['merge', 'pull']
 
3283
    takes_args = ['other_branch?']
 
3284
    takes_options = [
 
3285
            Option('reverse', 'Reverse the order of revisions.'),
 
3286
            Option('mine-only',
 
3287
                   'Display changes in the local branch only.'),
 
3288
            Option('this' , 'Same as --mine-only.'),
 
3289
            Option('theirs-only',
 
3290
                   'Display changes in the remote branch only.'),
 
3291
            Option('other', 'Same as --theirs-only.'),
 
3292
            'log-format',
 
3293
            'show-ids',
 
3294
            'verbose'
 
3295
            ]
 
3296
    encoding_type = 'replace'
 
3297
 
 
3298
    @display_command
 
3299
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3300
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3301
            show_ids=False, verbose=False, this=False, other=False):
 
3302
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3303
 
 
3304
        if this:
 
3305
            mine_only = this
 
3306
        if other:
 
3307
            theirs_only = other
 
3308
        # TODO: We should probably check that we don't have mine-only and
 
3309
        #       theirs-only set, but it gets complicated because we also have
 
3310
        #       this and other which could be used.
 
3311
        restrict = 'all'
 
3312
        if mine_only:
 
3313
            restrict = 'local'
 
3314
        elif theirs_only:
 
3315
            restrict = 'remote'
 
3316
 
 
3317
        local_branch = Branch.open_containing(u".")[0]
 
3318
        parent = local_branch.get_parent()
 
3319
        if other_branch is None:
 
3320
            other_branch = parent
 
3321
            if other_branch is None:
 
3322
                raise errors.BzrCommandError("No peer location known"
 
3323
                                             " or specified.")
 
3324
            display_url = urlutils.unescape_for_display(parent,
 
3325
                                                        self.outf.encoding)
 
3326
            self.outf.write("Using last location: " + display_url + "\n")
 
3327
 
 
3328
        remote_branch = Branch.open(other_branch)
 
3329
        if remote_branch.base == local_branch.base:
 
3330
            remote_branch = local_branch
 
3331
        local_branch.lock_read()
 
3332
        try:
 
3333
            remote_branch.lock_read()
 
3334
            try:
 
3335
                local_extra, remote_extra = find_unmerged(
 
3336
                    local_branch, remote_branch, restrict)
 
3337
 
 
3338
                if log_format is None:
 
3339
                    registry = log.log_formatter_registry
 
3340
                    log_format = registry.get_default(local_branch)
 
3341
                lf = log_format(to_file=self.outf,
 
3342
                                show_ids=show_ids,
 
3343
                                show_timezone='original')
 
3344
                if reverse is False:
 
3345
                    if local_extra is not None:
 
3346
                        local_extra.reverse()
 
3347
                    if remote_extra is not None:
 
3348
                        remote_extra.reverse()
 
3349
 
 
3350
                status_code = 0
 
3351
                if local_extra and not theirs_only:
 
3352
                    self.outf.write("You have %d extra revision(s):\n" %
 
3353
                                    len(local_extra))
 
3354
                    for revision in iter_log_revisions(local_extra,
 
3355
                                        local_branch.repository,
 
3356
                                        verbose):
 
3357
                        lf.log_revision(revision)
 
3358
                    printed_local = True
 
3359
                    status_code = 1
 
3360
                else:
 
3361
                    printed_local = False
 
3362
 
 
3363
                if remote_extra and not mine_only:
 
3364
                    if printed_local is True:
 
3365
                        self.outf.write("\n\n\n")
 
3366
                    self.outf.write("You are missing %d revision(s):\n" %
 
3367
                                    len(remote_extra))
 
3368
                    for revision in iter_log_revisions(remote_extra,
 
3369
                                        remote_branch.repository,
 
3370
                                        verbose):
 
3371
                        lf.log_revision(revision)
 
3372
                    status_code = 1
 
3373
 
 
3374
                if mine_only and not local_extra:
 
3375
                    # We checked local, and found nothing extra
 
3376
                    self.outf.write('This branch is up to date.\n')
 
3377
                elif theirs_only and not remote_extra:
 
3378
                    # We checked remote, and found nothing extra
 
3379
                    self.outf.write('Other branch is up to date.\n')
 
3380
                elif not (mine_only or theirs_only or local_extra or
 
3381
                          remote_extra):
 
3382
                    # We checked both branches, and neither one had extra
 
3383
                    # revisions
 
3384
                    self.outf.write("Branches are up to date.\n")
 
3385
            finally:
 
3386
                remote_branch.unlock()
 
3387
        finally:
 
3388
            local_branch.unlock()
 
3389
        if not status_code and parent is None and other_branch is not None:
 
3390
            local_branch.lock_write()
 
3391
            try:
 
3392
                # handle race conditions - a parent might be set while we run.
 
3393
                if local_branch.get_parent() is None:
 
3394
                    local_branch.set_parent(remote_branch.base)
 
3395
            finally:
 
3396
                local_branch.unlock()
 
3397
        return status_code
 
3398
 
 
3399
 
 
3400
class cmd_pack(Command):
 
3401
    """Compress the data within a repository."""
 
3402
 
 
3403
    _see_also = ['repositories']
 
3404
    takes_args = ['branch_or_repo?']
 
3405
 
 
3406
    def run(self, branch_or_repo='.'):
 
3407
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3408
        try:
 
3409
            branch = dir.open_branch()
 
3410
            repository = branch.repository
 
3411
        except errors.NotBranchError:
 
3412
            repository = dir.open_repository()
 
3413
        repository.pack()
 
3414
 
 
3415
 
 
3416
class cmd_plugins(Command):
 
3417
    """List the installed plugins.
 
3418
    
 
3419
    This command displays the list of installed plugins including
 
3420
    version of plugin and a short description of each.
 
3421
 
 
3422
    --verbose shows the path where each plugin is located.
 
3423
 
 
3424
    A plugin is an external component for Bazaar that extends the
 
3425
    revision control system, by adding or replacing code in Bazaar.
 
3426
    Plugins can do a variety of things, including overriding commands,
 
3427
    adding new commands, providing additional network transports and
 
3428
    customizing log output.
 
3429
 
 
3430
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3431
    information on plugins including where to find them and how to
 
3432
    install them. Instructions are also provided there on how to
 
3433
    write new plugins using the Python programming language.
 
3434
    """
 
3435
    takes_options = ['verbose']
 
3436
 
 
3437
    @display_command
 
3438
    def run(self, verbose=False):
 
3439
        import bzrlib.plugin
 
3440
        from inspect import getdoc
 
3441
        result = []
 
3442
        for name, plugin in bzrlib.plugin.plugins().items():
 
3443
            version = plugin.__version__
 
3444
            if version == 'unknown':
 
3445
                version = ''
 
3446
            name_ver = '%s %s' % (name, version)
 
3447
            d = getdoc(plugin.module)
 
3448
            if d:
 
3449
                doc = d.split('\n')[0]
 
3450
            else:
 
3451
                doc = '(no description)'
 
3452
            result.append((name_ver, doc, plugin.path()))
 
3453
        for name_ver, doc, path in sorted(result):
 
3454
            print name_ver
 
3455
            print '   ', doc
 
3456
            if verbose:
 
3457
                print '   ', path
 
3458
            print
 
3459
 
 
3460
 
 
3461
class cmd_testament(Command):
 
3462
    """Show testament (signing-form) of a revision."""
 
3463
    takes_options = [
 
3464
            'revision',
 
3465
            Option('long', help='Produce long-format testament.'),
 
3466
            Option('strict',
 
3467
                   help='Produce a strict-format testament.')]
 
3468
    takes_args = ['branch?']
 
3469
    @display_command
 
3470
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3471
        from bzrlib.testament import Testament, StrictTestament
 
3472
        if strict is True:
 
3473
            testament_class = StrictTestament
 
3474
        else:
 
3475
            testament_class = Testament
 
3476
        if branch == '.':
 
3477
            b = Branch.open_containing(branch)[0]
 
3478
        else:
 
3479
            b = Branch.open(branch)
 
3480
        b.lock_read()
 
3481
        try:
 
3482
            if revision is None:
 
3483
                rev_id = b.last_revision()
 
3484
            else:
 
3485
                rev_id = revision[0].as_revision_id(b)
 
3486
            t = testament_class.from_revision(b.repository, rev_id)
 
3487
            if long:
 
3488
                sys.stdout.writelines(t.as_text_lines())
 
3489
            else:
 
3490
                sys.stdout.write(t.as_short_text())
 
3491
        finally:
 
3492
            b.unlock()
 
3493
 
 
3494
 
 
3495
class cmd_annotate(Command):
 
3496
    """Show the origin of each line in a file.
 
3497
 
 
3498
    This prints out the given file with an annotation on the left side
 
3499
    indicating which revision, author and date introduced the change.
 
3500
 
 
3501
    If the origin is the same for a run of consecutive lines, it is 
 
3502
    shown only at the top, unless the --all option is given.
 
3503
    """
 
3504
    # TODO: annotate directories; showing when each file was last changed
 
3505
    # TODO: if the working copy is modified, show annotations on that 
 
3506
    #       with new uncommitted lines marked
 
3507
    aliases = ['ann', 'blame', 'praise']
 
3508
    takes_args = ['filename']
 
3509
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3510
                     Option('long', help='Show commit date in annotations.'),
 
3511
                     'revision',
 
3512
                     'show-ids',
 
3513
                     ]
 
3514
    encoding_type = 'exact'
 
3515
 
 
3516
    @display_command
 
3517
    def run(self, filename, all=False, long=False, revision=None,
 
3518
            show_ids=False):
 
3519
        from bzrlib.annotate import annotate_file
 
3520
        wt, branch, relpath = \
 
3521
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3522
        if wt is not None:
 
3523
            wt.lock_read()
 
3524
        else:
 
3525
            branch.lock_read()
 
3526
        try:
 
3527
            if revision is None:
 
3528
                revision_id = branch.last_revision()
 
3529
            elif len(revision) != 1:
 
3530
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3531
            else:
 
3532
                revision_id = revision[0].as_revision_id(branch)
 
3533
            tree = branch.repository.revision_tree(revision_id)
 
3534
            if wt is not None:
 
3535
                file_id = wt.path2id(relpath)
 
3536
            else:
 
3537
                file_id = tree.path2id(relpath)
 
3538
            if file_id is None:
 
3539
                raise errors.NotVersionedError(filename)
 
3540
            file_version = tree.inventory[file_id].revision
 
3541
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3542
                          show_ids=show_ids)
 
3543
        finally:
 
3544
            if wt is not None:
 
3545
                wt.unlock()
 
3546
            else:
 
3547
                branch.unlock()
 
3548
 
 
3549
 
 
3550
class cmd_re_sign(Command):
 
3551
    """Create a digital signature for an existing revision."""
 
3552
    # TODO be able to replace existing ones.
 
3553
 
 
3554
    hidden = True # is this right ?
 
3555
    takes_args = ['revision_id*']
 
3556
    takes_options = ['revision']
 
3557
    
 
3558
    def run(self, revision_id_list=None, revision=None):
 
3559
        if revision_id_list is not None and revision is not None:
 
3560
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3561
        if revision_id_list is None and revision is None:
 
3562
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3563
        b = WorkingTree.open_containing(u'.')[0].branch
 
3564
        b.lock_write()
 
3565
        try:
 
3566
            return self._run(b, revision_id_list, revision)
 
3567
        finally:
 
3568
            b.unlock()
 
3569
 
 
3570
    def _run(self, b, revision_id_list, revision):
 
3571
        import bzrlib.gpg as gpg
 
3572
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3573
        if revision_id_list is not None:
 
3574
            b.repository.start_write_group()
 
3575
            try:
 
3576
                for revision_id in revision_id_list:
 
3577
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
3578
            except:
 
3579
                b.repository.abort_write_group()
 
3580
                raise
 
3581
            else:
 
3582
                b.repository.commit_write_group()
 
3583
        elif revision is not None:
 
3584
            if len(revision) == 1:
 
3585
                revno, rev_id = revision[0].in_history(b)
 
3586
                b.repository.start_write_group()
 
3587
                try:
 
3588
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
3589
                except:
 
3590
                    b.repository.abort_write_group()
 
3591
                    raise
 
3592
                else:
 
3593
                    b.repository.commit_write_group()
 
3594
            elif len(revision) == 2:
 
3595
                # are they both on rh- if so we can walk between them
 
3596
                # might be nice to have a range helper for arbitrary
 
3597
                # revision paths. hmm.
 
3598
                from_revno, from_revid = revision[0].in_history(b)
 
3599
                to_revno, to_revid = revision[1].in_history(b)
 
3600
                if to_revid is None:
 
3601
                    to_revno = b.revno()
 
3602
                if from_revno is None or to_revno is None:
 
3603
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3604
                b.repository.start_write_group()
 
3605
                try:
 
3606
                    for revno in range(from_revno, to_revno + 1):
 
3607
                        b.repository.sign_revision(b.get_rev_id(revno),
 
3608
                                                   gpg_strategy)
 
3609
                except:
 
3610
                    b.repository.abort_write_group()
 
3611
                    raise
 
3612
                else:
 
3613
                    b.repository.commit_write_group()
 
3614
            else:
 
3615
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3616
 
 
3617
 
 
3618
class cmd_bind(Command):
 
3619
    """Convert the current branch into a checkout of the supplied branch.
 
3620
 
 
3621
    Once converted into a checkout, commits must succeed on the master branch
 
3622
    before they will be applied to the local branch.
 
3623
    """
 
3624
 
 
3625
    _see_also = ['checkouts', 'unbind']
 
3626
    takes_args = ['location?']
 
3627
    takes_options = []
 
3628
 
 
3629
    def run(self, location=None):
 
3630
        b, relpath = Branch.open_containing(u'.')
 
3631
        if location is None:
 
3632
            try:
 
3633
                location = b.get_old_bound_location()
 
3634
            except errors.UpgradeRequired:
 
3635
                raise errors.BzrCommandError('No location supplied.  '
 
3636
                    'This format does not remember old locations.')
 
3637
            else:
 
3638
                if location is None:
 
3639
                    raise errors.BzrCommandError('No location supplied and no '
 
3640
                        'previous location known')
 
3641
        b_other = Branch.open(location)
 
3642
        try:
 
3643
            b.bind(b_other)
 
3644
        except errors.DivergedBranches:
 
3645
            raise errors.BzrCommandError('These branches have diverged.'
 
3646
                                         ' Try merging, and then bind again.')
 
3647
 
 
3648
 
 
3649
class cmd_unbind(Command):
 
3650
    """Convert the current checkout into a regular branch.
 
3651
 
 
3652
    After unbinding, the local branch is considered independent and subsequent
 
3653
    commits will be local only.
 
3654
    """
 
3655
 
 
3656
    _see_also = ['checkouts', 'bind']
 
3657
    takes_args = []
 
3658
    takes_options = []
 
3659
 
 
3660
    def run(self):
 
3661
        b, relpath = Branch.open_containing(u'.')
 
3662
        if not b.unbind():
 
3663
            raise errors.BzrCommandError('Local branch is not bound')
 
3664
 
 
3665
 
 
3666
class cmd_uncommit(Command):
 
3667
    """Remove the last committed revision.
 
3668
 
 
3669
    --verbose will print out what is being removed.
 
3670
    --dry-run will go through all the motions, but not actually
 
3671
    remove anything.
 
3672
 
 
3673
    If --revision is specified, uncommit revisions to leave the branch at the
 
3674
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
3675
    branch at revision 15.
 
3676
 
 
3677
    Uncommit leaves the working tree ready for a new commit.  The only change
 
3678
    it may make is to restore any pending merges that were present before
 
3679
    the commit.
 
3680
    """
 
3681
 
 
3682
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3683
    # unreferenced information in 'branch-as-repository' branches.
 
3684
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3685
    # information in shared branches as well.
 
3686
    _see_also = ['commit']
 
3687
    takes_options = ['verbose', 'revision',
 
3688
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3689
                    Option('force', help='Say yes to all questions.'),
 
3690
                    Option('local',
 
3691
                           help="Only remove the commits from the local branch"
 
3692
                                " when in a checkout."
 
3693
                           ),
 
3694
                    ]
 
3695
    takes_args = ['location?']
 
3696
    aliases = []
 
3697
    encoding_type = 'replace'
 
3698
 
 
3699
    def run(self, location=None,
 
3700
            dry_run=False, verbose=False,
 
3701
            revision=None, force=False, local=False):
 
3702
        if location is None:
 
3703
            location = u'.'
 
3704
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3705
        try:
 
3706
            tree = control.open_workingtree()
 
3707
            b = tree.branch
 
3708
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3709
            tree = None
 
3710
            b = control.open_branch()
 
3711
 
 
3712
        if tree is not None:
 
3713
            tree.lock_write()
 
3714
        else:
 
3715
            b.lock_write()
 
3716
        try:
 
3717
            return self._run(b, tree, dry_run, verbose, revision, force,
 
3718
                             local=local)
 
3719
        finally:
 
3720
            if tree is not None:
 
3721
                tree.unlock()
 
3722
            else:
 
3723
                b.unlock()
 
3724
 
 
3725
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
3726
        from bzrlib.log import log_formatter, show_log
 
3727
        from bzrlib.uncommit import uncommit
 
3728
 
 
3729
        last_revno, last_rev_id = b.last_revision_info()
 
3730
 
 
3731
        rev_id = None
 
3732
        if revision is None:
 
3733
            revno = last_revno
 
3734
            rev_id = last_rev_id
 
3735
        else:
 
3736
            # 'bzr uncommit -r 10' actually means uncommit
 
3737
            # so that the final tree is at revno 10.
 
3738
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3739
            # the revisions that are supplied.
 
3740
            # So we need to offset it by one
 
3741
            revno = revision[0].in_history(b).revno + 1
 
3742
            if revno <= last_revno:
 
3743
                rev_id = b.get_rev_id(revno)
 
3744
 
 
3745
        if rev_id is None or _mod_revision.is_null(rev_id):
 
3746
            self.outf.write('No revisions to uncommit.\n')
 
3747
            return 1
 
3748
 
 
3749
        lf = log_formatter('short',
 
3750
                           to_file=self.outf,
 
3751
                           show_timezone='original')
 
3752
 
 
3753
        show_log(b,
 
3754
                 lf,
 
3755
                 verbose=False,
 
3756
                 direction='forward',
 
3757
                 start_revision=revno,
 
3758
                 end_revision=last_revno)
 
3759
 
 
3760
        if dry_run:
 
3761
            print 'Dry-run, pretending to remove the above revisions.'
 
3762
            if not force:
 
3763
                val = raw_input('Press <enter> to continue')
 
3764
        else:
 
3765
            print 'The above revision(s) will be removed.'
 
3766
            if not force:
 
3767
                val = raw_input('Are you sure [y/N]? ')
 
3768
                if val.lower() not in ('y', 'yes'):
 
3769
                    print 'Canceled'
 
3770
                    return 0
 
3771
 
 
3772
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3773
                 revno=revno, local=local)
 
3774
 
 
3775
 
 
3776
class cmd_break_lock(Command):
 
3777
    """Break a dead lock on a repository, branch or working directory.
 
3778
 
 
3779
    CAUTION: Locks should only be broken when you are sure that the process
 
3780
    holding the lock has been stopped.
 
3781
 
 
3782
    You can get information on what locks are open via the 'bzr info' command.
 
3783
    
 
3784
    :Examples:
 
3785
        bzr break-lock
 
3786
    """
 
3787
    takes_args = ['location?']
 
3788
 
 
3789
    def run(self, location=None, show=False):
 
3790
        if location is None:
 
3791
            location = u'.'
 
3792
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3793
        try:
 
3794
            control.break_lock()
 
3795
        except NotImplementedError:
 
3796
            pass
 
3797
        
 
3798
 
 
3799
class cmd_wait_until_signalled(Command):
 
3800
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3801
 
 
3802
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3803
    """
 
3804
 
 
3805
    hidden = True
 
3806
 
 
3807
    def run(self):
 
3808
        sys.stdout.write("running\n")
 
3809
        sys.stdout.flush()
 
3810
        sys.stdin.readline()
 
3811
 
 
3812
 
 
3813
class cmd_serve(Command):
 
3814
    """Run the bzr server."""
 
3815
 
 
3816
    aliases = ['server']
 
3817
 
 
3818
    takes_options = [
 
3819
        Option('inet',
 
3820
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3821
        Option('port',
 
3822
               help='Listen for connections on nominated port of the form '
 
3823
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3824
                    'result in a dynamically allocated port.  The default port is '
 
3825
                    '4155.',
 
3826
               type=str),
 
3827
        Option('directory',
 
3828
               help='Serve contents of this directory.',
 
3829
               type=unicode),
 
3830
        Option('allow-writes',
 
3831
               help='By default the server is a readonly server.  Supplying '
 
3832
                    '--allow-writes enables write access to the contents of '
 
3833
                    'the served directory and below.'
 
3834
                ),
 
3835
        ]
 
3836
 
 
3837
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3838
        from bzrlib import lockdir
 
3839
        from bzrlib.smart import medium, server
 
3840
        from bzrlib.transport import get_transport
 
3841
        from bzrlib.transport.chroot import ChrootServer
 
3842
        if directory is None:
 
3843
            directory = os.getcwd()
 
3844
        url = urlutils.local_path_to_url(directory)
 
3845
        if not allow_writes:
 
3846
            url = 'readonly+' + url
 
3847
        chroot_server = ChrootServer(get_transport(url))
 
3848
        chroot_server.setUp()
 
3849
        t = get_transport(chroot_server.get_url())
 
3850
        if inet:
 
3851
            smart_server = medium.SmartServerPipeStreamMedium(
 
3852
                sys.stdin, sys.stdout, t)
 
3853
        else:
 
3854
            host = medium.BZR_DEFAULT_INTERFACE
 
3855
            if port is None:
 
3856
                port = medium.BZR_DEFAULT_PORT
 
3857
            else:
 
3858
                if ':' in port:
 
3859
                    host, port = port.split(':')
 
3860
                port = int(port)
 
3861
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3862
            print 'listening on port: ', smart_server.port
 
3863
            sys.stdout.flush()
 
3864
        # for the duration of this server, no UI output is permitted.
 
3865
        # note that this may cause problems with blackbox tests. This should
 
3866
        # be changed with care though, as we dont want to use bandwidth sending
 
3867
        # progress over stderr to smart server clients!
 
3868
        old_factory = ui.ui_factory
 
3869
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3870
        try:
 
3871
            ui.ui_factory = ui.SilentUIFactory()
 
3872
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3873
            smart_server.serve()
 
3874
        finally:
 
3875
            ui.ui_factory = old_factory
 
3876
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
3877
 
 
3878
 
 
3879
class cmd_join(Command):
 
3880
    """Combine a subtree into its containing tree.
 
3881
    
 
3882
    This command is for experimental use only.  It requires the target tree
 
3883
    to be in dirstate-with-subtree format, which cannot be converted into
 
3884
    earlier formats.
 
3885
 
 
3886
    The TREE argument should be an independent tree, inside another tree, but
 
3887
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3888
    running "bzr branch" with the target inside a tree.)
 
3889
 
 
3890
    The result is a combined tree, with the subtree no longer an independant
 
3891
    part.  This is marked as a merge of the subtree into the containing tree,
 
3892
    and all history is preserved.
 
3893
 
 
3894
    If --reference is specified, the subtree retains its independence.  It can
 
3895
    be branched by itself, and can be part of multiple projects at the same
 
3896
    time.  But operations performed in the containing tree, such as commit
 
3897
    and merge, will recurse into the subtree.
 
3898
    """
 
3899
 
 
3900
    _see_also = ['split']
 
3901
    takes_args = ['tree']
 
3902
    takes_options = [
 
3903
            Option('reference', help='Join by reference.'),
 
3904
            ]
 
3905
    hidden = True
 
3906
 
 
3907
    def run(self, tree, reference=False):
 
3908
        sub_tree = WorkingTree.open(tree)
 
3909
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3910
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3911
        repo = containing_tree.branch.repository
 
3912
        if not repo.supports_rich_root():
 
3913
            raise errors.BzrCommandError(
 
3914
                "Can't join trees because %s doesn't support rich root data.\n"
 
3915
                "You can use bzr upgrade on the repository."
 
3916
                % (repo,))
 
3917
        if reference:
 
3918
            try:
 
3919
                containing_tree.add_reference(sub_tree)
 
3920
            except errors.BadReferenceTarget, e:
 
3921
                # XXX: Would be better to just raise a nicely printable
 
3922
                # exception from the real origin.  Also below.  mbp 20070306
 
3923
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3924
                                             (tree, e.reason))
 
3925
        else:
 
3926
            try:
 
3927
                containing_tree.subsume(sub_tree)
 
3928
            except errors.BadSubsumeSource, e:
 
3929
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3930
                                             (tree, e.reason))
 
3931
 
 
3932
 
 
3933
class cmd_split(Command):
 
3934
    """Split a subdirectory of a tree into a separate tree.
 
3935
 
 
3936
    This command will produce a target tree in a format that supports
 
3937
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
3938
    converted into earlier formats like 'dirstate-tags'.
 
3939
 
 
3940
    The TREE argument should be a subdirectory of a working tree.  That
 
3941
    subdirectory will be converted into an independent tree, with its own
 
3942
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3943
    """
 
3944
 
 
3945
    # join is not un-hidden yet
 
3946
    #_see_also = ['join']
 
3947
    takes_args = ['tree']
 
3948
 
 
3949
    def run(self, tree):
 
3950
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3951
        sub_id = containing_tree.path2id(subdir)
 
3952
        if sub_id is None:
 
3953
            raise errors.NotVersionedError(subdir)
 
3954
        try:
 
3955
            containing_tree.extract(sub_id)
 
3956
        except errors.RootNotRich:
 
3957
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3958
 
 
3959
 
 
3960
class cmd_merge_directive(Command):
 
3961
    """Generate a merge directive for auto-merge tools.
 
3962
 
 
3963
    A directive requests a merge to be performed, and also provides all the
 
3964
    information necessary to do so.  This means it must either include a
 
3965
    revision bundle, or the location of a branch containing the desired
 
3966
    revision.
 
3967
 
 
3968
    A submit branch (the location to merge into) must be supplied the first
 
3969
    time the command is issued.  After it has been supplied once, it will
 
3970
    be remembered as the default.
 
3971
 
 
3972
    A public branch is optional if a revision bundle is supplied, but required
 
3973
    if --diff or --plain is specified.  It will be remembered as the default
 
3974
    after the first use.
 
3975
    """
 
3976
 
 
3977
    takes_args = ['submit_branch?', 'public_branch?']
 
3978
 
 
3979
    hidden = True
 
3980
 
 
3981
    _see_also = ['send']
 
3982
 
 
3983
    takes_options = [
 
3984
        RegistryOption.from_kwargs('patch-type',
 
3985
            'The type of patch to include in the directive.',
 
3986
            title='Patch type',
 
3987
            value_switches=True,
 
3988
            enum_switch=False,
 
3989
            bundle='Bazaar revision bundle (default).',
 
3990
            diff='Normal unified diff.',
 
3991
            plain='No patch, just directive.'),
 
3992
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3993
        Option('mail-to', type=str,
 
3994
            help='Instead of printing the directive, email to this address.'),
 
3995
        Option('message', type=str, short_name='m',
 
3996
            help='Message to use when committing this merge.')
 
3997
        ]
 
3998
 
 
3999
    encoding_type = 'exact'
 
4000
 
 
4001
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4002
            sign=False, revision=None, mail_to=None, message=None):
 
4003
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4004
        include_patch, include_bundle = {
 
4005
            'plain': (False, False),
 
4006
            'diff': (True, False),
 
4007
            'bundle': (True, True),
 
4008
            }[patch_type]
 
4009
        branch = Branch.open('.')
 
4010
        stored_submit_branch = branch.get_submit_branch()
 
4011
        if submit_branch is None:
 
4012
            submit_branch = stored_submit_branch
 
4013
        else:
 
4014
            if stored_submit_branch is None:
 
4015
                branch.set_submit_branch(submit_branch)
 
4016
        if submit_branch is None:
 
4017
            submit_branch = branch.get_parent()
 
4018
        if submit_branch is None:
 
4019
            raise errors.BzrCommandError('No submit branch specified or known')
 
4020
 
 
4021
        stored_public_branch = branch.get_public_branch()
 
4022
        if public_branch is None:
 
4023
            public_branch = stored_public_branch
 
4024
        elif stored_public_branch is None:
 
4025
            branch.set_public_branch(public_branch)
 
4026
        if not include_bundle and public_branch is None:
 
4027
            raise errors.BzrCommandError('No public branch specified or'
 
4028
                                         ' known')
 
4029
        base_revision_id = None
 
4030
        if revision is not None:
 
4031
            if len(revision) > 2:
 
4032
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4033
                    'at most two one revision identifiers')
 
4034
            revision_id = revision[-1].as_revision_id(branch)
 
4035
            if len(revision) == 2:
 
4036
                base_revision_id = revision[0].as_revision_id(branch)
 
4037
        else:
 
4038
            revision_id = branch.last_revision()
 
4039
        revision_id = ensure_null(revision_id)
 
4040
        if revision_id == NULL_REVISION:
 
4041
            raise errors.BzrCommandError('No revisions to bundle.')
 
4042
        directive = merge_directive.MergeDirective2.from_objects(
 
4043
            branch.repository, revision_id, time.time(),
 
4044
            osutils.local_time_offset(), submit_branch,
 
4045
            public_branch=public_branch, include_patch=include_patch,
 
4046
            include_bundle=include_bundle, message=message,
 
4047
            base_revision_id=base_revision_id)
 
4048
        if mail_to is None:
 
4049
            if sign:
 
4050
                self.outf.write(directive.to_signed(branch))
 
4051
            else:
 
4052
                self.outf.writelines(directive.to_lines())
 
4053
        else:
 
4054
            message = directive.to_email(mail_to, branch, sign)
 
4055
            s = SMTPConnection(branch.get_config())
 
4056
            s.send_email(message)
 
4057
 
 
4058
 
 
4059
class cmd_send(Command):
 
4060
    """Mail or create a merge-directive for submiting changes.
 
4061
 
 
4062
    A merge directive provides many things needed for requesting merges:
 
4063
 
 
4064
    * A machine-readable description of the merge to perform
 
4065
 
 
4066
    * An optional patch that is a preview of the changes requested
 
4067
 
 
4068
    * An optional bundle of revision data, so that the changes can be applied
 
4069
      directly from the merge directive, without retrieving data from a
 
4070
      branch.
 
4071
 
 
4072
    If --no-bundle is specified, then public_branch is needed (and must be
 
4073
    up-to-date), so that the receiver can perform the merge using the
 
4074
    public_branch.  The public_branch is always included if known, so that
 
4075
    people can check it later.
 
4076
 
 
4077
    The submit branch defaults to the parent, but can be overridden.  Both
 
4078
    submit branch and public branch will be remembered if supplied.
 
4079
 
 
4080
    If a public_branch is known for the submit_branch, that public submit
 
4081
    branch is used in the merge instructions.  This means that a local mirror
 
4082
    can be used as your actual submit branch, once you have set public_branch
 
4083
    for that mirror.
 
4084
 
 
4085
    Mail is sent using your preferred mail program.  This should be transparent
 
4086
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4087
    If the preferred client can't be found (or used), your editor will be used.
 
4088
    
 
4089
    To use a specific mail program, set the mail_client configuration option.
 
4090
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4091
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4092
    generic options are "default", "editor", "emacsclient", "mapi", and
 
4093
    "xdg-email".
 
4094
 
 
4095
    If mail is being sent, a to address is required.  This can be supplied
 
4096
    either on the commandline, by setting the submit_to configuration
 
4097
    option in the branch itself or the child_submit_to configuration option 
 
4098
    in the submit branch.
 
4099
 
 
4100
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4101
    merge directive format 2.  It is significantly faster and smaller than
 
4102
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4103
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4104
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4105
    
 
4106
    Merge directives are applied using the merge command or the pull command.
 
4107
    """
 
4108
 
 
4109
    encoding_type = 'exact'
 
4110
 
 
4111
    _see_also = ['merge', 'pull']
 
4112
 
 
4113
    takes_args = ['submit_branch?', 'public_branch?']
 
4114
 
 
4115
    takes_options = [
 
4116
        Option('no-bundle',
 
4117
               help='Do not include a bundle in the merge directive.'),
 
4118
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4119
               ' directive.'),
 
4120
        Option('remember',
 
4121
               help='Remember submit and public branch.'),
 
4122
        Option('from',
 
4123
               help='Branch to generate the submission from, '
 
4124
               'rather than the one containing the working directory.',
 
4125
               short_name='f',
 
4126
               type=unicode),
 
4127
        Option('output', short_name='o',
 
4128
               help='Write merge directive to this file; '
 
4129
                    'use - for stdout.',
 
4130
               type=unicode),
 
4131
        Option('mail-to', help='Mail the request to this address.',
 
4132
               type=unicode),
 
4133
        'revision',
 
4134
        'message',
 
4135
        RegistryOption.from_kwargs('format',
 
4136
        'Use the specified output format.',
 
4137
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4138
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4139
        ]
 
4140
 
 
4141
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4142
            no_patch=False, revision=None, remember=False, output=None,
 
4143
            format='4', mail_to=None, message=None, **kwargs):
 
4144
        return self._run(submit_branch, revision, public_branch, remember,
 
4145
                         format, no_bundle, no_patch, output,
 
4146
                         kwargs.get('from', '.'), mail_to, message)
 
4147
 
 
4148
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4149
             no_bundle, no_patch, output, from_, mail_to, message):
 
4150
        from bzrlib.revision import NULL_REVISION
 
4151
        branch = Branch.open_containing(from_)[0]
 
4152
        if output is None:
 
4153
            outfile = StringIO()
 
4154
        elif output == '-':
 
4155
            outfile = self.outf
 
4156
        else:
 
4157
            outfile = open(output, 'wb')
 
4158
        # we may need to write data into branch's repository to calculate
 
4159
        # the data to send.
 
4160
        branch.lock_write()
 
4161
        try:
 
4162
            if output is None:
 
4163
                config = branch.get_config()
 
4164
                if mail_to is None:
 
4165
                    mail_to = config.get_user_option('submit_to')
 
4166
                mail_client = config.get_mail_client()
 
4167
            if remember and submit_branch is None:
 
4168
                raise errors.BzrCommandError(
 
4169
                    '--remember requires a branch to be specified.')
 
4170
            stored_submit_branch = branch.get_submit_branch()
 
4171
            remembered_submit_branch = False
 
4172
            if submit_branch is None:
 
4173
                submit_branch = stored_submit_branch
 
4174
                remembered_submit_branch = True
 
4175
            else:
 
4176
                if stored_submit_branch is None or remember:
 
4177
                    branch.set_submit_branch(submit_branch)
 
4178
            if submit_branch is None:
 
4179
                submit_branch = branch.get_parent()
 
4180
                remembered_submit_branch = True
 
4181
            if submit_branch is None:
 
4182
                raise errors.BzrCommandError('No submit branch known or'
 
4183
                                             ' specified')
 
4184
            if remembered_submit_branch:
 
4185
                note('Using saved location "%s" to determine what changes to submit.', submit_branch)
 
4186
 
 
4187
            if mail_to is None:
 
4188
                submit_config = Branch.open(submit_branch).get_config()
 
4189
                mail_to = submit_config.get_user_option("child_submit_to")
 
4190
 
 
4191
            stored_public_branch = branch.get_public_branch()
 
4192
            if public_branch is None:
 
4193
                public_branch = stored_public_branch
 
4194
            elif stored_public_branch is None or remember:
 
4195
                branch.set_public_branch(public_branch)
 
4196
            if no_bundle and public_branch is None:
 
4197
                raise errors.BzrCommandError('No public branch specified or'
 
4198
                                             ' known')
 
4199
            base_revision_id = None
 
4200
            revision_id = None
 
4201
            if revision is not None:
 
4202
                if len(revision) > 2:
 
4203
                    raise errors.BzrCommandError('bzr send takes '
 
4204
                        'at most two one revision identifiers')
 
4205
                revision_id = revision[-1].as_revision_id(branch)
 
4206
                if len(revision) == 2:
 
4207
                    base_revision_id = revision[0].as_revision_id(branch)
 
4208
            if revision_id is None:
 
4209
                revision_id = branch.last_revision()
 
4210
            if revision_id == NULL_REVISION:
 
4211
                raise errors.BzrCommandError('No revisions to submit.')
 
4212
            if format == '4':
 
4213
                directive = merge_directive.MergeDirective2.from_objects(
 
4214
                    branch.repository, revision_id, time.time(),
 
4215
                    osutils.local_time_offset(), submit_branch,
 
4216
                    public_branch=public_branch, include_patch=not no_patch,
 
4217
                    include_bundle=not no_bundle, message=message,
 
4218
                    base_revision_id=base_revision_id)
 
4219
            elif format == '0.9':
 
4220
                if not no_bundle:
 
4221
                    if not no_patch:
 
4222
                        patch_type = 'bundle'
 
4223
                    else:
 
4224
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4225
                            ' permit bundle with no patch')
 
4226
                else:
 
4227
                    if not no_patch:
 
4228
                        patch_type = 'diff'
 
4229
                    else:
 
4230
                        patch_type = None
 
4231
                directive = merge_directive.MergeDirective.from_objects(
 
4232
                    branch.repository, revision_id, time.time(),
 
4233
                    osutils.local_time_offset(), submit_branch,
 
4234
                    public_branch=public_branch, patch_type=patch_type,
 
4235
                    message=message)
 
4236
 
 
4237
            outfile.writelines(directive.to_lines())
 
4238
            if output is None:
 
4239
                subject = '[MERGE] '
 
4240
                if message is not None:
 
4241
                    subject += message
 
4242
                else:
 
4243
                    revision = branch.repository.get_revision(revision_id)
 
4244
                    subject += revision.get_summary()
 
4245
                basename = directive.get_disk_name(branch)
 
4246
                mail_client.compose_merge_request(mail_to, subject,
 
4247
                                                  outfile.getvalue(), basename)
 
4248
        finally:
 
4249
            if output != '-':
 
4250
                outfile.close()
 
4251
            branch.unlock()
 
4252
 
 
4253
 
 
4254
class cmd_bundle_revisions(cmd_send):
 
4255
 
 
4256
    """Create a merge-directive for submiting changes.
 
4257
 
 
4258
    A merge directive provides many things needed for requesting merges:
 
4259
 
 
4260
    * A machine-readable description of the merge to perform
 
4261
 
 
4262
    * An optional patch that is a preview of the changes requested
 
4263
 
 
4264
    * An optional bundle of revision data, so that the changes can be applied
 
4265
      directly from the merge directive, without retrieving data from a
 
4266
      branch.
 
4267
 
 
4268
    If --no-bundle is specified, then public_branch is needed (and must be
 
4269
    up-to-date), so that the receiver can perform the merge using the
 
4270
    public_branch.  The public_branch is always included if known, so that
 
4271
    people can check it later.
 
4272
 
 
4273
    The submit branch defaults to the parent, but can be overridden.  Both
 
4274
    submit branch and public branch will be remembered if supplied.
 
4275
 
 
4276
    If a public_branch is known for the submit_branch, that public submit
 
4277
    branch is used in the merge instructions.  This means that a local mirror
 
4278
    can be used as your actual submit branch, once you have set public_branch
 
4279
    for that mirror.
 
4280
 
 
4281
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4282
    merge directive format 2.  It is significantly faster and smaller than
 
4283
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4284
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4285
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4286
    """
 
4287
 
 
4288
    takes_options = [
 
4289
        Option('no-bundle',
 
4290
               help='Do not include a bundle in the merge directive.'),
 
4291
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4292
               ' directive.'),
 
4293
        Option('remember',
 
4294
               help='Remember submit and public branch.'),
 
4295
        Option('from',
 
4296
               help='Branch to generate the submission from, '
 
4297
               'rather than the one containing the working directory.',
 
4298
               short_name='f',
 
4299
               type=unicode),
 
4300
        Option('output', short_name='o', help='Write directive to this file.',
 
4301
               type=unicode),
 
4302
        'revision',
 
4303
        RegistryOption.from_kwargs('format',
 
4304
        'Use the specified output format.',
 
4305
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4306
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4307
        ]
 
4308
    aliases = ['bundle']
 
4309
 
 
4310
    _see_also = ['send', 'merge']
 
4311
 
 
4312
    hidden = True
 
4313
 
 
4314
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4315
            no_patch=False, revision=None, remember=False, output=None,
 
4316
            format='4', **kwargs):
 
4317
        if output is None:
 
4318
            output = '-'
 
4319
        return self._run(submit_branch, revision, public_branch, remember,
 
4320
                         format, no_bundle, no_patch, output,
 
4321
                         kwargs.get('from', '.'), None, None)
 
4322
 
 
4323
 
 
4324
class cmd_tag(Command):
 
4325
    """Create, remove or modify a tag naming a revision.
 
4326
    
 
4327
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
4328
    (--revision) option can be given -rtag:X, where X is any previously
 
4329
    created tag.
 
4330
 
 
4331
    Tags are stored in the branch.  Tags are copied from one branch to another
 
4332
    along when you branch, push, pull or merge.
 
4333
 
 
4334
    It is an error to give a tag name that already exists unless you pass 
 
4335
    --force, in which case the tag is moved to point to the new revision.
 
4336
 
 
4337
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
4338
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
4339
    """
 
4340
 
 
4341
    _see_also = ['commit', 'tags']
 
4342
    takes_args = ['tag_name']
 
4343
    takes_options = [
 
4344
        Option('delete',
 
4345
            help='Delete this tag rather than placing it.',
 
4346
            ),
 
4347
        Option('directory',
 
4348
            help='Branch in which to place the tag.',
 
4349
            short_name='d',
 
4350
            type=unicode,
 
4351
            ),
 
4352
        Option('force',
 
4353
            help='Replace existing tags.',
 
4354
            ),
 
4355
        'revision',
 
4356
        ]
 
4357
 
 
4358
    def run(self, tag_name,
 
4359
            delete=None,
 
4360
            directory='.',
 
4361
            force=None,
 
4362
            revision=None,
 
4363
            ):
 
4364
        branch, relpath = Branch.open_containing(directory)
 
4365
        branch.lock_write()
 
4366
        try:
 
4367
            if delete:
 
4368
                branch.tags.delete_tag(tag_name)
 
4369
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4370
            else:
 
4371
                if revision:
 
4372
                    if len(revision) != 1:
 
4373
                        raise errors.BzrCommandError(
 
4374
                            "Tags can only be placed on a single revision, "
 
4375
                            "not on a range")
 
4376
                    revision_id = revision[0].as_revision_id(branch)
 
4377
                else:
 
4378
                    revision_id = branch.last_revision()
 
4379
                if (not force) and branch.tags.has_tag(tag_name):
 
4380
                    raise errors.TagAlreadyExists(tag_name)
 
4381
                branch.tags.set_tag(tag_name, revision_id)
 
4382
                self.outf.write('Created tag %s.\n' % tag_name)
 
4383
        finally:
 
4384
            branch.unlock()
 
4385
 
 
4386
 
 
4387
class cmd_tags(Command):
 
4388
    """List tags.
 
4389
 
 
4390
    This command shows a table of tag names and the revisions they reference.
 
4391
    """
 
4392
 
 
4393
    _see_also = ['tag']
 
4394
    takes_options = [
 
4395
        Option('directory',
 
4396
            help='Branch whose tags should be displayed.',
 
4397
            short_name='d',
 
4398
            type=unicode,
 
4399
            ),
 
4400
        RegistryOption.from_kwargs('sort',
 
4401
            'Sort tags by different criteria.', title='Sorting',
 
4402
            alpha='Sort tags lexicographically (default).',
 
4403
            time='Sort tags chronologically.',
 
4404
            ),
 
4405
        'show-ids',
 
4406
    ]
 
4407
 
 
4408
    @display_command
 
4409
    def run(self,
 
4410
            directory='.',
 
4411
            sort='alpha',
 
4412
            show_ids=False,
 
4413
            ):
 
4414
        branch, relpath = Branch.open_containing(directory)
 
4415
        tags = branch.tags.get_tag_dict().items()
 
4416
        if not tags:
 
4417
            return
 
4418
        if sort == 'alpha':
 
4419
            tags.sort()
 
4420
        elif sort == 'time':
 
4421
            timestamps = {}
 
4422
            for tag, revid in tags:
 
4423
                try:
 
4424
                    revobj = branch.repository.get_revision(revid)
 
4425
                except errors.NoSuchRevision:
 
4426
                    timestamp = sys.maxint # place them at the end
 
4427
                else:
 
4428
                    timestamp = revobj.timestamp
 
4429
                timestamps[revid] = timestamp
 
4430
            tags.sort(key=lambda x: timestamps[x[1]])
 
4431
        if not show_ids:
 
4432
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
4433
            revno_map = branch.get_revision_id_to_revno_map()
 
4434
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4435
                        for tag, revid in tags ]
 
4436
        for tag, revspec in tags:
 
4437
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
4438
 
 
4439
 
 
4440
class cmd_reconfigure(Command):
 
4441
    """Reconfigure the type of a bzr directory.
 
4442
 
 
4443
    A target configuration must be specified.
 
4444
 
 
4445
    For checkouts, the bind-to location will be auto-detected if not specified.
 
4446
    The order of preference is
 
4447
    1. For a lightweight checkout, the current bound location.
 
4448
    2. For branches that used to be checkouts, the previously-bound location.
 
4449
    3. The push location.
 
4450
    4. The parent location.
 
4451
    If none of these is available, --bind-to must be specified.
 
4452
    """
 
4453
 
 
4454
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
4455
    takes_args = ['location?']
 
4456
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4457
                     title='Target type',
 
4458
                     help='The type to reconfigure the directory to.',
 
4459
                     value_switches=True, enum_switch=False,
 
4460
                     branch='Reconfigure to be an unbound branch '
 
4461
                        'with no working tree.',
 
4462
                     tree='Reconfigure to be an unbound branch '
 
4463
                        'with a working tree.',
 
4464
                     checkout='Reconfigure to be a bound branch '
 
4465
                        'with a working tree.',
 
4466
                     lightweight_checkout='Reconfigure to be a lightweight'
 
4467
                     ' checkout (with no local history).',
 
4468
                     standalone='Reconfigure to be a standalone branch '
 
4469
                        '(i.e. stop using shared repository).',
 
4470
                     use_shared='Reconfigure to use a shared repository.'),
 
4471
                     Option('bind-to', help='Branch to bind checkout to.',
 
4472
                            type=str),
 
4473
                     Option('force',
 
4474
                        help='Perform reconfiguration even if local changes'
 
4475
                        ' will be lost.')
 
4476
                     ]
 
4477
 
 
4478
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
4479
        directory = bzrdir.BzrDir.open(location)
 
4480
        if target_type is None:
 
4481
            raise errors.BzrCommandError('No target configuration specified')
 
4482
        elif target_type == 'branch':
 
4483
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
4484
        elif target_type == 'tree':
 
4485
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
4486
        elif target_type == 'checkout':
 
4487
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4488
                                                                  bind_to)
 
4489
        elif target_type == 'lightweight-checkout':
 
4490
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
4491
                directory, bind_to)
 
4492
        elif target_type == 'use-shared':
 
4493
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
4494
        elif target_type == 'standalone':
 
4495
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
4496
        reconfiguration.apply(force)
 
4497
 
 
4498
 
 
4499
class cmd_switch(Command):
 
4500
    """Set the branch of a checkout and update.
 
4501
    
 
4502
    For lightweight checkouts, this changes the branch being referenced.
 
4503
    For heavyweight checkouts, this checks that there are no local commits
 
4504
    versus the current bound branch, then it makes the local branch a mirror
 
4505
    of the new location and binds to it.
 
4506
    
 
4507
    In both cases, the working tree is updated and uncommitted changes
 
4508
    are merged. The user can commit or revert these as they desire.
 
4509
 
 
4510
    Pending merges need to be committed or reverted before using switch.
 
4511
 
 
4512
    The path to the branch to switch to can be specified relative to the parent
 
4513
    directory of the current branch. For example, if you are currently in a
 
4514
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
4515
    /path/to/newbranch.
 
4516
    """
 
4517
 
 
4518
    takes_args = ['to_location']
 
4519
    takes_options = [Option('force',
 
4520
                        help='Switch even if local commits will be lost.')
 
4521
                     ]
 
4522
 
 
4523
    def run(self, to_location, force=False):
 
4524
        from bzrlib import switch
 
4525
        tree_location = '.'
 
4526
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
4527
        try:
 
4528
            to_branch = Branch.open(to_location)
 
4529
        except errors.NotBranchError:
 
4530
            to_branch = Branch.open(
 
4531
                control_dir.open_branch().base + '../' + to_location)
 
4532
        switch.switch(control_dir, to_branch, force)
 
4533
        note('Switched to branch: %s',
 
4534
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
4535
 
 
4536
 
 
4537
class cmd_hooks(Command):
 
4538
    """Show a branch's currently registered hooks.
 
4539
    """
 
4540
 
 
4541
    hidden = True
 
4542
    takes_args = ['path?']
 
4543
 
 
4544
    def run(self, path=None):
 
4545
        if path is None:
 
4546
            path = '.'
 
4547
        branch_hooks = Branch.open(path).hooks
 
4548
        for hook_type in branch_hooks:
 
4549
            hooks = branch_hooks[hook_type]
 
4550
            self.outf.write("%s:\n" % (hook_type,))
 
4551
            if hooks:
 
4552
                for hook in hooks:
 
4553
                    self.outf.write("  %s\n" %
 
4554
                                    (branch_hooks.get_hook_name(hook),))
 
4555
            else:
 
4556
                self.outf.write("  <no hooks installed>\n")
 
4557
 
 
4558
 
 
4559
def _create_prefix(cur_transport):
 
4560
    needed = [cur_transport]
 
4561
    # Recurse upwards until we can create a directory successfully
 
4562
    while True:
 
4563
        new_transport = cur_transport.clone('..')
 
4564
        if new_transport.base == cur_transport.base:
 
4565
            raise errors.BzrCommandError(
 
4566
                "Failed to create path prefix for %s."
 
4567
                % cur_transport.base)
 
4568
        try:
 
4569
            new_transport.mkdir('.')
 
4570
        except errors.NoSuchFile:
 
4571
            needed.append(new_transport)
 
4572
            cur_transport = new_transport
 
4573
        else:
 
4574
            break
 
4575
    # Now we only need to create child directories
 
4576
    while needed:
 
4577
        cur_transport = needed.pop()
 
4578
        cur_transport.ensure_base()
 
4579
 
 
4580
 
 
4581
# these get imported and then picked up by the scan for cmd_*
 
4582
# TODO: Some more consistent way to split command definitions across files;
 
4583
# we do need to load at least some information about them to know of 
 
4584
# aliases.  ideally we would avoid loading the implementation until the
 
4585
# details were needed.
 
4586
from bzrlib.cmd_version_info import cmd_version_info
 
4587
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4588
from bzrlib.bundle.commands import (
 
4589
    cmd_bundle_info,
 
4590
    )
 
4591
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4592
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
4593
        cmd_weave_plan_merge, cmd_weave_merge_text