/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: Andrew Bennetts
  • Date: 2008-09-14 10:46:46 UTC
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080914104646-sjo6u2nk8bi54nzn
Polish lazy_registry feature a little.

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