/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: Canonical.com Patch Queue Manager
  • Date: 2008-08-14 17:25:43 UTC
  • mfrom: (3620.2.2 rules.disable)
  • Revision ID: pqm@pqm.ubuntu.com-20080814172543-nl22gdcodusa8rt0
(robertc) Disable .bzrrules from being read from the WT

Show diffs side-by-side

added added

removed removed

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