~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2005-06-06 13:24:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050606132418-1082c87e2473e266
- manpage generator by Hans Ulrich Niedermann

Show diffs side-by-side

added added

removed removed

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