/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-07-12 09:49:37 UTC
  • mfrom: (2598.5.9 nullrevision)
  • Revision ID: pqm@pqm.ubuntu.com-20070712094937-rw5qbi81enh0pvhw
Make most functions prefer NULL_REVISION

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