~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-01 17:14:51 UTC
  • mfrom: (2662.1.1 bzr.easy_install)
  • Revision ID: pqm@pqm.ubuntu.com-20070801171451-en3tds1hzlru2j83
allow ``easy_install bzr`` runs without fatal errors. (#125521, bialix,
 r=mbp)

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.conflicts import ConflictList
 
57
from bzrlib.revisionspec import RevisionSpec
 
58
from bzrlib.smtp_connection import SMTPConnection
 
59
from bzrlib.workingtree import WorkingTree
 
60
""")
 
61
 
 
62
from bzrlib.commands import Command, display_command
 
63
from bzrlib.option import ListOption, Option, RegistryOption
 
64
from bzrlib.progress import DummyProgress, ProgressPhase
 
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
 
66
 
 
67
 
 
68
def tree_files(file_list, default_branch=u'.'):
 
69
    try:
 
70
        return internal_tree_files(file_list, default_branch)
 
71
    except errors.FileInWrongBranch, e:
 
72
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
73
                                     (e.path, file_list[0]))
 
74
 
 
75
 
 
76
# XXX: Bad function name; should possibly also be a class method of
 
77
# WorkingTree rather than a function.
 
78
def internal_tree_files(file_list, default_branch=u'.'):
 
79
    """Convert command-line paths to a WorkingTree and relative paths.
 
80
 
 
81
    This is typically used for command-line processors that take one or
 
82
    more filenames, and infer the workingtree that contains them.
 
83
 
 
84
    The filenames given are not required to exist.
 
85
 
 
86
    :param file_list: Filenames to convert.  
 
87
 
 
88
    :param default_branch: Fallback tree path to use if file_list is empty or
 
89
        None.
 
90
 
 
91
    :return: workingtree, [relative_paths]
 
92
    """
 
93
    if file_list is None or len(file_list) == 0:
 
94
        return WorkingTree.open_containing(default_branch)[0], file_list
 
95
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
96
    new_list = []
 
97
    for filename in file_list:
 
98
        try:
 
99
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
100
        except errors.PathNotChild:
 
101
            raise errors.FileInWrongBranch(tree.branch, filename)
 
102
    return tree, new_list
 
103
 
 
104
 
 
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
 
106
def get_format_type(typestring):
 
107
    """Parse and return a format specifier."""
 
108
    # Have to use BzrDirMetaFormat1 directly, so that
 
109
    # RepositoryFormat.set_default_format works
 
110
    if typestring == "default":
 
111
        return bzrdir.BzrDirMetaFormat1()
 
112
    try:
 
113
        return bzrdir.format_registry.make_bzrdir(typestring)
 
114
    except KeyError:
 
115
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
 
116
        raise errors.BzrCommandError(msg)
 
117
 
 
118
 
 
119
# TODO: Make sure no commands unconditionally use the working directory as a
 
120
# branch.  If a filename argument is used, the first of them should be used to
 
121
# specify the branch.  (Perhaps this can be factored out into some kind of
 
122
# Argument class, representing a file in a branch, where the first occurrence
 
123
# opens the branch?)
 
124
 
 
125
class cmd_status(Command):
 
126
    """Display status summary.
 
127
 
 
128
    This reports on versioned and unknown files, reporting them
 
129
    grouped by state.  Possible states are:
 
130
 
 
131
    added
 
132
        Versioned in the working copy but not in the previous revision.
 
133
 
 
134
    removed
 
135
        Versioned in the previous revision but removed or deleted
 
136
        in the working copy.
 
137
 
 
138
    renamed
 
139
        Path of this file changed from the previous revision;
 
140
        the text may also have changed.  This includes files whose
 
141
        parent directory was renamed.
 
142
 
 
143
    modified
 
144
        Text has changed since the previous revision.
 
145
 
 
146
    kind changed
 
147
        File kind has been changed (e.g. from file to directory).
 
148
 
 
149
    unknown
 
150
        Not versioned and not matching an ignore pattern.
 
151
 
 
152
    To see ignored files use 'bzr ignored'.  For details on the
 
153
    changes to file texts, use 'bzr diff'.
 
154
    
 
155
    --short gives a status flags for each item, similar to the SVN's status
 
156
    command.
 
157
 
 
158
    If no arguments are specified, the status of the entire working
 
159
    directory is shown.  Otherwise, only the status of the specified
 
160
    files or directories is reported.  If a directory is given, status
 
161
    is reported for everything inside that directory.
 
162
 
 
163
    If a revision argument is given, the status is calculated against
 
164
    that revision, or between two revisions if two are provided.
 
165
    """
 
166
    
 
167
    # TODO: --no-recurse, --recurse options
 
168
    
 
169
    takes_args = ['file*']
 
170
    takes_options = ['show-ids', 'revision',
 
171
                     Option('short', help='Give short SVN-style status lines.'),
 
172
                     Option('versioned', help='Only show versioned files.')]
 
173
    aliases = ['st', 'stat']
 
174
 
 
175
    encoding_type = 'replace'
 
176
    _see_also = ['diff', 'revert', 'status-flags']
 
177
    
 
178
    @display_command
 
179
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
180
            versioned=False):
 
181
        from bzrlib.status import show_tree_status
 
182
 
 
183
        tree, file_list = tree_files(file_list)
 
184
            
 
185
        show_tree_status(tree, show_ids=show_ids,
 
186
                         specific_files=file_list, revision=revision,
 
187
                         to_file=self.outf, short=short, versioned=versioned)
 
188
 
 
189
 
 
190
class cmd_cat_revision(Command):
 
191
    """Write out metadata for a revision.
 
192
    
 
193
    The revision to print can either be specified by a specific
 
194
    revision identifier, or you can use --revision.
 
195
    """
 
196
 
 
197
    hidden = True
 
198
    takes_args = ['revision_id?']
 
199
    takes_options = ['revision']
 
200
    # cat-revision is more for frontends so should be exact
 
201
    encoding = 'strict'
 
202
    
 
203
    @display_command
 
204
    def run(self, revision_id=None, revision=None):
 
205
 
 
206
        revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
207
        if revision_id is not None and revision is not None:
 
208
            raise errors.BzrCommandError('You can only supply one of'
 
209
                                         ' revision_id or --revision')
 
210
        if revision_id is None and revision is None:
 
211
            raise errors.BzrCommandError('You must supply either'
 
212
                                         ' --revision or a revision_id')
 
213
        b = WorkingTree.open_containing(u'.')[0].branch
 
214
 
 
215
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
216
        if revision_id is not None:
 
217
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
218
        elif revision is not None:
 
219
            for rev in revision:
 
220
                if rev is None:
 
221
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
222
                                                 ' revision.')
 
223
                revno, rev_id = rev.in_history(b)
 
224
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
225
    
 
226
 
 
227
class cmd_remove_tree(Command):
 
228
    """Remove the working tree from a given branch/checkout.
 
229
 
 
230
    Since a lightweight checkout is little more than a working tree
 
231
    this will refuse to run against one.
 
232
 
 
233
    To re-create the working tree, use "bzr checkout".
 
234
    """
 
235
    _see_also = ['checkout', 'working-trees']
 
236
 
 
237
    takes_args = ['location?']
 
238
 
 
239
    def run(self, location='.'):
 
240
        d = bzrdir.BzrDir.open(location)
 
241
        
 
242
        try:
 
243
            working = d.open_workingtree()
 
244
        except errors.NoWorkingTree:
 
245
            raise errors.BzrCommandError("No working tree to remove")
 
246
        except errors.NotLocalUrl:
 
247
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
248
                                         "remote path")
 
249
        
 
250
        working_path = working.bzrdir.root_transport.base
 
251
        branch_path = working.branch.bzrdir.root_transport.base
 
252
        if working_path != branch_path:
 
253
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
254
                                         "a lightweight checkout")
 
255
        
 
256
        d.destroy_workingtree()
 
257
        
 
258
 
 
259
class cmd_revno(Command):
 
260
    """Show current revision number.
 
261
 
 
262
    This is equal to the number of revisions on this branch.
 
263
    """
 
264
 
 
265
    _see_also = ['info']
 
266
    takes_args = ['location?']
 
267
 
 
268
    @display_command
 
269
    def run(self, location=u'.'):
 
270
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
271
        self.outf.write('\n')
 
272
 
 
273
 
 
274
class cmd_revision_info(Command):
 
275
    """Show revision number and revision id for a given revision identifier.
 
276
    """
 
277
    hidden = True
 
278
    takes_args = ['revision_info*']
 
279
    takes_options = ['revision']
 
280
 
 
281
    @display_command
 
282
    def run(self, revision=None, revision_info_list=[]):
 
283
 
 
284
        revs = []
 
285
        if revision is not None:
 
286
            revs.extend(revision)
 
287
        if revision_info_list is not None:
 
288
            for rev in revision_info_list:
 
289
                revs.append(RevisionSpec.from_string(rev))
 
290
 
 
291
        b = Branch.open_containing(u'.')[0]
 
292
 
 
293
        if len(revs) == 0:
 
294
            revs.append(RevisionSpec.from_string('-1'))
 
295
 
 
296
        for rev in revs:
 
297
            revinfo = rev.in_history(b)
 
298
            if revinfo.revno is None:
 
299
                dotted_map = b.get_revision_id_to_revno_map()
 
300
                revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
 
301
                print '%s %s' % (revno, revinfo.rev_id)
 
302
            else:
 
303
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
304
 
 
305
    
 
306
class cmd_add(Command):
 
307
    """Add specified files or directories.
 
308
 
 
309
    In non-recursive mode, all the named items are added, regardless
 
310
    of whether they were previously ignored.  A warning is given if
 
311
    any of the named files are already versioned.
 
312
 
 
313
    In recursive mode (the default), files are treated the same way
 
314
    but the behaviour for directories is different.  Directories that
 
315
    are already versioned do not give a warning.  All directories,
 
316
    whether already versioned or not, are searched for files or
 
317
    subdirectories that are neither versioned or ignored, and these
 
318
    are added.  This search proceeds recursively into versioned
 
319
    directories.  If no names are given '.' is assumed.
 
320
 
 
321
    Therefore simply saying 'bzr add' will version all files that
 
322
    are currently unknown.
 
323
 
 
324
    Adding a file whose parent directory is not versioned will
 
325
    implicitly add the parent, and so on up to the root. This means
 
326
    you should never need to explicitly add a directory, they'll just
 
327
    get added when you add a file in the directory.
 
328
 
 
329
    --dry-run will show which files would be added, but not actually 
 
330
    add them.
 
331
 
 
332
    --file-ids-from will try to use the file ids from the supplied path.
 
333
    It looks up ids trying to find a matching parent directory with the
 
334
    same filename, and then by pure path. This option is rarely needed
 
335
    but can be useful when adding the same logical file into two
 
336
    branches that will be merged later (without showing the two different
 
337
    adds as a conflict). It is also useful when merging another project
 
338
    into a subdirectory of this one.
 
339
    """
 
340
    takes_args = ['file*']
 
341
    takes_options = [
 
342
        Option('no-recurse',
 
343
               help="Don't recursively add the contents of directories."),
 
344
        Option('dry-run',
 
345
               help="Show what would be done, but don't actually do anything."),
 
346
        'verbose',
 
347
        Option('file-ids-from',
 
348
               type=unicode,
 
349
               help='Lookup file ids from this tree.'),
 
350
        ]
 
351
    encoding_type = 'replace'
 
352
    _see_also = ['remove']
 
353
 
 
354
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
355
            file_ids_from=None):
 
356
        import bzrlib.add
 
357
 
 
358
        base_tree = None
 
359
        if file_ids_from is not None:
 
360
            try:
 
361
                base_tree, base_path = WorkingTree.open_containing(
 
362
                                            file_ids_from)
 
363
            except errors.NoWorkingTree:
 
364
                base_branch, base_path = Branch.open_containing(
 
365
                                            file_ids_from)
 
366
                base_tree = base_branch.basis_tree()
 
367
 
 
368
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
369
                          to_file=self.outf, should_print=(not is_quiet()))
 
370
        else:
 
371
            action = bzrlib.add.AddAction(to_file=self.outf,
 
372
                should_print=(not is_quiet()))
 
373
 
 
374
        if base_tree:
 
375
            base_tree.lock_read()
 
376
        try:
 
377
            file_list = self._maybe_expand_globs(file_list)
 
378
            if file_list:
 
379
                tree = WorkingTree.open_containing(file_list[0])[0]
 
380
            else:
 
381
                tree = WorkingTree.open_containing(u'.')[0]
 
382
            added, ignored = tree.smart_add(file_list, not
 
383
                no_recurse, action=action, save=not dry_run)
 
384
        finally:
 
385
            if base_tree is not None:
 
386
                base_tree.unlock()
 
387
        if len(ignored) > 0:
 
388
            if verbose:
 
389
                for glob in sorted(ignored.keys()):
 
390
                    for path in ignored[glob]:
 
391
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
392
                                        % (path, glob))
 
393
            else:
 
394
                match_len = 0
 
395
                for glob, paths in ignored.items():
 
396
                    match_len += len(paths)
 
397
                self.outf.write("ignored %d file(s).\n" % match_len)
 
398
            self.outf.write("If you wish to add some of these files,"
 
399
                            " please add them by name.\n")
 
400
 
 
401
 
 
402
class cmd_mkdir(Command):
 
403
    """Create a new versioned directory.
 
404
 
 
405
    This is equivalent to creating the directory and then adding it.
 
406
    """
 
407
 
 
408
    takes_args = ['dir+']
 
409
    encoding_type = 'replace'
 
410
 
 
411
    def run(self, dir_list):
 
412
        for d in dir_list:
 
413
            os.mkdir(d)
 
414
            wt, dd = WorkingTree.open_containing(d)
 
415
            wt.add([dd])
 
416
            self.outf.write('added %s\n' % d)
 
417
 
 
418
 
 
419
class cmd_relpath(Command):
 
420
    """Show path of a file relative to root"""
 
421
 
 
422
    takes_args = ['filename']
 
423
    hidden = True
 
424
    
 
425
    @display_command
 
426
    def run(self, filename):
 
427
        # TODO: jam 20050106 Can relpath return a munged path if
 
428
        #       sys.stdout encoding cannot represent it?
 
429
        tree, relpath = WorkingTree.open_containing(filename)
 
430
        self.outf.write(relpath)
 
431
        self.outf.write('\n')
 
432
 
 
433
 
 
434
class cmd_inventory(Command):
 
435
    """Show inventory of the current working copy or a revision.
 
436
 
 
437
    It is possible to limit the output to a particular entry
 
438
    type using the --kind option.  For example: --kind file.
 
439
 
 
440
    It is also possible to restrict the list of files to a specific
 
441
    set. For example: bzr inventory --show-ids this/file
 
442
    """
 
443
 
 
444
    hidden = True
 
445
    _see_also = ['ls']
 
446
    takes_options = [
 
447
        'revision',
 
448
        'show-ids',
 
449
        Option('kind',
 
450
               help='List entries of a particular kind: file, directory, symlink.',
 
451
               type=unicode),
 
452
        ]
 
453
    takes_args = ['file*']
 
454
 
 
455
    @display_command
 
456
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
457
        if kind and kind not in ['file', 'directory', 'symlink']:
 
458
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
459
 
 
460
        work_tree, file_list = tree_files(file_list)
 
461
        work_tree.lock_read()
 
462
        try:
 
463
            if revision is not None:
 
464
                if len(revision) > 1:
 
465
                    raise errors.BzrCommandError(
 
466
                        'bzr inventory --revision takes exactly one revision'
 
467
                        ' identifier')
 
468
                revision_id = revision[0].in_history(work_tree.branch).rev_id
 
469
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
470
 
 
471
                extra_trees = [work_tree]
 
472
                tree.lock_read()
 
473
            else:
 
474
                tree = work_tree
 
475
                extra_trees = []
 
476
 
 
477
            if file_list is not None:
 
478
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
479
                                          require_versioned=True)
 
480
                # find_ids_across_trees may include some paths that don't
 
481
                # exist in 'tree'.
 
482
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
483
                                 for file_id in file_ids if file_id in tree)
 
484
            else:
 
485
                entries = tree.inventory.entries()
 
486
        finally:
 
487
            tree.unlock()
 
488
            if tree is not work_tree:
 
489
                work_tree.unlock()
 
490
 
 
491
        for path, entry in entries:
 
492
            if kind and kind != entry.kind:
 
493
                continue
 
494
            if show_ids:
 
495
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
496
            else:
 
497
                self.outf.write(path)
 
498
                self.outf.write('\n')
 
499
 
 
500
 
 
501
class cmd_mv(Command):
 
502
    """Move or rename a file.
 
503
 
 
504
    usage:
 
505
        bzr mv OLDNAME NEWNAME
 
506
        bzr mv SOURCE... DESTINATION
 
507
 
 
508
    If the last argument is a versioned directory, all the other names
 
509
    are moved into it.  Otherwise, there must be exactly two arguments
 
510
    and the file is changed to a new name.
 
511
 
 
512
    If OLDNAME does not exist on the filesystem but is versioned and
 
513
    NEWNAME does exist on the filesystem but is not versioned, mv
 
514
    assumes that the file has been manually moved and only updates
 
515
    its internal inventory to reflect that change.
 
516
    The same is valid when moving many SOURCE files to a DESTINATION.
 
517
 
 
518
    Files cannot be moved between branches.
 
519
    """
 
520
 
 
521
    takes_args = ['names*']
 
522
    takes_options = [Option("after", help="Move only the bzr identifier"
 
523
        " of the file, because the file has already been moved."),
 
524
        ]
 
525
    aliases = ['move', 'rename']
 
526
    encoding_type = 'replace'
 
527
 
 
528
    def run(self, names_list, after=False):
 
529
        if names_list is None:
 
530
            names_list = []
 
531
 
 
532
        if len(names_list) < 2:
 
533
            raise errors.BzrCommandError("missing file argument")
 
534
        tree, rel_names = tree_files(names_list)
 
535
        
 
536
        if os.path.isdir(names_list[-1]):
 
537
            # move into existing directory
 
538
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
539
                self.outf.write("%s => %s\n" % pair)
 
540
        else:
 
541
            if len(names_list) != 2:
 
542
                raise errors.BzrCommandError('to mv multiple files the'
 
543
                                             ' destination must be a versioned'
 
544
                                             ' directory')
 
545
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
546
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
547
            
 
548
    
 
549
class cmd_pull(Command):
 
550
    """Turn this branch into a mirror of another branch.
 
551
 
 
552
    This command only works on branches that have not diverged.  Branches are
 
553
    considered diverged if the destination branch's most recent commit is one
 
554
    that has not been merged (directly or indirectly) into the parent.
 
555
 
 
556
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
557
    from one into the other.  Once one branch has merged, the other should
 
558
    be able to pull it again.
 
559
 
 
560
    If you want to forget your local changes and just update your branch to
 
561
    match the remote one, use pull --overwrite.
 
562
 
 
563
    If there is no default location set, the first pull will set it.  After
 
564
    that, you can omit the location to use the default.  To change the
 
565
    default, use --remember. The value will only be saved if the remote
 
566
    location can be accessed.
 
567
    """
 
568
 
 
569
    _see_also = ['push', 'update', 'status-flags']
 
570
    takes_options = ['remember', 'overwrite', 'revision', 'verbose',
 
571
        Option('directory',
 
572
            help='Branch to pull into, '
 
573
                 'rather than the one containing the working directory.',
 
574
            short_name='d',
 
575
            type=unicode,
 
576
            ),
 
577
        ]
 
578
    takes_args = ['location?']
 
579
    encoding_type = 'replace'
 
580
 
 
581
    def run(self, location=None, remember=False, overwrite=False,
 
582
            revision=None, verbose=False,
 
583
            directory=None):
 
584
        # FIXME: too much stuff is in the command class
 
585
        revision_id = None
 
586
        mergeable = None
 
587
        if directory is None:
 
588
            directory = u'.'
 
589
        try:
 
590
            tree_to = WorkingTree.open_containing(directory)[0]
 
591
            branch_to = tree_to.branch
 
592
        except errors.NoWorkingTree:
 
593
            tree_to = None
 
594
            branch_to = Branch.open_containing(directory)[0]
 
595
 
 
596
        if location is not None:
 
597
            mergeable, location_transport = _get_mergeable_helper(location)
 
598
 
 
599
        stored_loc = branch_to.get_parent()
 
600
        if location is None:
 
601
            if stored_loc is None:
 
602
                raise errors.BzrCommandError("No pull location known or"
 
603
                                             " specified.")
 
604
            else:
 
605
                display_url = urlutils.unescape_for_display(stored_loc,
 
606
                        self.outf.encoding)
 
607
                self.outf.write("Using saved location: %s\n" % display_url)
 
608
                location = stored_loc
 
609
                location_transport = transport.get_transport(location)
 
610
 
 
611
        if mergeable is not None:
 
612
            if revision is not None:
 
613
                raise errors.BzrCommandError(
 
614
                    'Cannot use -r with merge directives or bundles')
 
615
            mergeable.install_revisions(branch_to.repository)
 
616
            base_revision_id, revision_id, verified = \
 
617
                mergeable.get_merge_request(branch_to.repository)
 
618
            branch_from = branch_to
 
619
        else:
 
620
            branch_from = Branch.open_from_transport(location_transport)
 
621
 
 
622
            if branch_to.get_parent() is None or remember:
 
623
                branch_to.set_parent(branch_from.base)
 
624
 
 
625
        if revision is not None:
 
626
            if len(revision) == 1:
 
627
                revision_id = revision[0].in_history(branch_from).rev_id
 
628
            else:
 
629
                raise errors.BzrCommandError(
 
630
                    'bzr pull --revision takes one value.')
 
631
 
 
632
        if verbose:
 
633
            old_rh = branch_to.revision_history()
 
634
        if tree_to is not None:
 
635
            result = tree_to.pull(branch_from, overwrite, revision_id,
 
636
                delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
 
637
        else:
 
638
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
639
 
 
640
        result.report(self.outf)
 
641
        if verbose:
 
642
            from bzrlib.log import show_changed_revisions
 
643
            new_rh = branch_to.revision_history()
 
644
            show_changed_revisions(branch_to, old_rh, new_rh,
 
645
                                   to_file=self.outf)
 
646
 
 
647
 
 
648
class cmd_push(Command):
 
649
    """Update a mirror of this branch.
 
650
    
 
651
    The target branch will not have its working tree populated because this
 
652
    is both expensive, and is not supported on remote file systems.
 
653
    
 
654
    Some smart servers or protocols *may* put the working tree in place in
 
655
    the future.
 
656
 
 
657
    This command only works on branches that have not diverged.  Branches are
 
658
    considered diverged if the destination branch's most recent commit is one
 
659
    that has not been merged (directly or indirectly) by the source branch.
 
660
 
 
661
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
662
    the other branch completely, discarding its unmerged changes.
 
663
    
 
664
    If you want to ensure you have the different changes in the other branch,
 
665
    do a merge (see bzr help merge) from the other branch, and commit that.
 
666
    After that you will be able to do a push without '--overwrite'.
 
667
 
 
668
    If there is no default push location set, the first push will set it.
 
669
    After that, you can omit the location to use the default.  To change the
 
670
    default, use --remember. The value will only be saved if the remote
 
671
    location can be accessed.
 
672
    """
 
673
 
 
674
    _see_also = ['pull', 'update', 'working-trees']
 
675
    takes_options = ['remember', 'overwrite', 'verbose',
 
676
        Option('create-prefix',
 
677
               help='Create the path leading up to the branch '
 
678
                    'if it does not already exist.'),
 
679
        Option('directory',
 
680
            help='Branch to push from, '
 
681
                 'rather than the one containing the working directory.',
 
682
            short_name='d',
 
683
            type=unicode,
 
684
            ),
 
685
        Option('use-existing-dir',
 
686
               help='By default push will fail if the target'
 
687
                    ' directory exists, but does not already'
 
688
                    ' have a control directory.  This flag will'
 
689
                    ' allow push to proceed.'),
 
690
        ]
 
691
    takes_args = ['location?']
 
692
    encoding_type = 'replace'
 
693
 
 
694
    def run(self, location=None, remember=False, overwrite=False,
 
695
            create_prefix=False, verbose=False,
 
696
            use_existing_dir=False,
 
697
            directory=None):
 
698
        # FIXME: Way too big!  Put this into a function called from the
 
699
        # command.
 
700
        if directory is None:
 
701
            directory = '.'
 
702
        br_from = Branch.open_containing(directory)[0]
 
703
        stored_loc = br_from.get_push_location()
 
704
        if location is None:
 
705
            if stored_loc is None:
 
706
                raise errors.BzrCommandError("No push location known or specified.")
 
707
            else:
 
708
                display_url = urlutils.unescape_for_display(stored_loc,
 
709
                        self.outf.encoding)
 
710
                self.outf.write("Using saved location: %s\n" % display_url)
 
711
                location = stored_loc
 
712
 
 
713
        to_transport = transport.get_transport(location)
 
714
 
 
715
        br_to = repository_to = dir_to = None
 
716
        try:
 
717
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
718
        except errors.NotBranchError:
 
719
            pass # Didn't find anything
 
720
        else:
 
721
            # If we can open a branch, use its direct repository, otherwise see
 
722
            # if there is a repository without a branch.
 
723
            try:
 
724
                br_to = dir_to.open_branch()
 
725
            except errors.NotBranchError:
 
726
                # Didn't find a branch, can we find a repository?
 
727
                try:
 
728
                    repository_to = dir_to.find_repository()
 
729
                except errors.NoRepositoryPresent:
 
730
                    pass
 
731
            else:
 
732
                # Found a branch, so we must have found a repository
 
733
                repository_to = br_to.repository
 
734
        push_result = None
 
735
        if verbose:
 
736
            old_rh = []
 
737
        if dir_to is None:
 
738
            # The destination doesn't exist; create it.
 
739
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
740
            #      common helper function
 
741
            try:
 
742
                to_transport.mkdir('.')
 
743
            except errors.FileExists:
 
744
                if not use_existing_dir:
 
745
                    raise errors.BzrCommandError("Target directory %s"
 
746
                         " already exists, but does not have a valid .bzr"
 
747
                         " directory. Supply --use-existing-dir to push"
 
748
                         " there anyway." % location)
 
749
            except errors.NoSuchFile:
 
750
                if not create_prefix:
 
751
                    raise errors.BzrCommandError("Parent directory of %s"
 
752
                        " does not exist."
 
753
                        "\nYou may supply --create-prefix to create all"
 
754
                        " leading parent directories."
 
755
                        % location)
 
756
                _create_prefix(to_transport)
 
757
 
 
758
            # Now the target directory exists, but doesn't have a .bzr
 
759
            # directory. So we need to create it, along with any work to create
 
760
            # all of the dependent branches, etc.
 
761
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
762
                revision_id=br_from.last_revision())
 
763
            br_to = dir_to.open_branch()
 
764
            # TODO: Some more useful message about what was copied
 
765
            note('Created new branch.')
 
766
            # We successfully created the target, remember it
 
767
            if br_from.get_push_location() is None or remember:
 
768
                br_from.set_push_location(br_to.base)
 
769
        elif repository_to is None:
 
770
            # we have a bzrdir but no branch or repository
 
771
            # XXX: Figure out what to do other than complain.
 
772
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
773
                " directory, but not a branch or repository. This is an"
 
774
                " unsupported configuration. Please move the target directory"
 
775
                " out of the way and try again."
 
776
                % location)
 
777
        elif br_to is None:
 
778
            # We have a repository but no branch, copy the revisions, and then
 
779
            # create a branch.
 
780
            last_revision_id = br_from.last_revision()
 
781
            repository_to.fetch(br_from.repository,
 
782
                                revision_id=last_revision_id)
 
783
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
 
784
            note('Created new branch.')
 
785
            if br_from.get_push_location() is None or remember:
 
786
                br_from.set_push_location(br_to.base)
 
787
        else: # We have a valid to branch
 
788
            # We were able to connect to the remote location, so remember it
 
789
            # we don't need to successfully push because of possible divergence.
 
790
            if br_from.get_push_location() is None or remember:
 
791
                br_from.set_push_location(br_to.base)
 
792
            if verbose:
 
793
                old_rh = br_to.revision_history()
 
794
            try:
 
795
                try:
 
796
                    tree_to = dir_to.open_workingtree()
 
797
                except errors.NotLocalUrl:
 
798
                    warning("This transport does not update the working " 
 
799
                            "tree of: %s. See 'bzr help working-trees' for "
 
800
                            "more information." % br_to.base)
 
801
                    push_result = br_from.push(br_to, overwrite)
 
802
                except errors.NoWorkingTree:
 
803
                    push_result = br_from.push(br_to, overwrite)
 
804
                else:
 
805
                    tree_to.lock_write()
 
806
                    try:
 
807
                        push_result = br_from.push(tree_to.branch, overwrite)
 
808
                        tree_to.update()
 
809
                    finally:
 
810
                        tree_to.unlock()
 
811
            except errors.DivergedBranches:
 
812
                raise errors.BzrCommandError('These branches have diverged.'
 
813
                                        '  Try using "merge" and then "push".')
 
814
        if push_result is not None:
 
815
            push_result.report(self.outf)
 
816
        elif verbose:
 
817
            new_rh = br_to.revision_history()
 
818
            if old_rh != new_rh:
 
819
                # Something changed
 
820
                from bzrlib.log import show_changed_revisions
 
821
                show_changed_revisions(br_to, old_rh, new_rh,
 
822
                                       to_file=self.outf)
 
823
        else:
 
824
            # we probably did a clone rather than a push, so a message was
 
825
            # emitted above
 
826
            pass
 
827
 
 
828
 
 
829
class cmd_branch(Command):
 
830
    """Create a new copy of a branch.
 
831
 
 
832
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
833
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
834
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
835
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
836
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
837
    create ./foo-bar.
 
838
 
 
839
    To retrieve the branch as of a particular revision, supply the --revision
 
840
    parameter, as in "branch foo/bar -r 5".
 
841
    """
 
842
 
 
843
    _see_also = ['checkout']
 
844
    takes_args = ['from_location', 'to_location?']
 
845
    takes_options = ['revision']
 
846
    aliases = ['get', 'clone']
 
847
 
 
848
    def run(self, from_location, to_location=None, revision=None):
 
849
        from bzrlib.tag import _merge_tags_if_possible
 
850
        if revision is None:
 
851
            revision = [None]
 
852
        elif len(revision) > 1:
 
853
            raise errors.BzrCommandError(
 
854
                'bzr branch --revision takes exactly 1 revision value')
 
855
 
 
856
        br_from = Branch.open(from_location)
 
857
        br_from.lock_read()
 
858
        try:
 
859
            if len(revision) == 1 and revision[0] is not None:
 
860
                revision_id = revision[0].in_history(br_from)[1]
 
861
            else:
 
862
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
863
                # None or perhaps NULL_REVISION to mean copy nothing
 
864
                # RBC 20060209
 
865
                revision_id = br_from.last_revision()
 
866
            if to_location is None:
 
867
                to_location = urlutils.derive_to_location(from_location)
 
868
                name = None
 
869
            else:
 
870
                name = os.path.basename(to_location) + '\n'
 
871
 
 
872
            to_transport = transport.get_transport(to_location)
 
873
            try:
 
874
                to_transport.mkdir('.')
 
875
            except errors.FileExists:
 
876
                raise errors.BzrCommandError('Target directory "%s" already'
 
877
                                             ' exists.' % to_location)
 
878
            except errors.NoSuchFile:
 
879
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
880
                                             % to_location)
 
881
            try:
 
882
                # preserve whatever source format we have.
 
883
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
884
                                            possible_transports=[to_transport])
 
885
                branch = dir.open_branch()
 
886
            except errors.NoSuchRevision:
 
887
                to_transport.delete_tree('.')
 
888
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
889
                raise errors.BzrCommandError(msg)
 
890
            if name:
 
891
                branch.control_files.put_utf8('branch-name', name)
 
892
            _merge_tags_if_possible(br_from, branch)
 
893
            note('Branched %d revision(s).' % branch.revno())
 
894
        finally:
 
895
            br_from.unlock()
 
896
 
 
897
 
 
898
class cmd_checkout(Command):
 
899
    """Create a new checkout of an existing branch.
 
900
 
 
901
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
902
    the branch found in '.'. This is useful if you have removed the working tree
 
903
    or if it was never created - i.e. if you pushed the branch to its current
 
904
    location using SFTP.
 
905
    
 
906
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
907
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
908
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
909
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
910
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
911
    create ./foo-bar.
 
912
 
 
913
    To retrieve the branch as of a particular revision, supply the --revision
 
914
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
915
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
916
    code.)
 
917
    """
 
918
 
 
919
    _see_also = ['checkouts', 'branch']
 
920
    takes_args = ['branch_location?', 'to_location?']
 
921
    takes_options = ['revision',
 
922
                     Option('lightweight',
 
923
                            help="Perform a lightweight checkout.  Lightweight "
 
924
                                 "checkouts depend on access to the branch for "
 
925
                                 "every operation.  Normal checkouts can perform "
 
926
                                 "common operations like diff and status without "
 
927
                                 "such access, and also support local commits."
 
928
                            ),
 
929
                     ]
 
930
    aliases = ['co']
 
931
 
 
932
    def run(self, branch_location=None, to_location=None, revision=None,
 
933
            lightweight=False):
 
934
        if revision is None:
 
935
            revision = [None]
 
936
        elif len(revision) > 1:
 
937
            raise errors.BzrCommandError(
 
938
                'bzr checkout --revision takes exactly 1 revision value')
 
939
        if branch_location is None:
 
940
            branch_location = osutils.getcwd()
 
941
            to_location = branch_location
 
942
        source = Branch.open(branch_location)
 
943
        if len(revision) == 1 and revision[0] is not None:
 
944
            revision_id = _mod_revision.ensure_null(
 
945
                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(revision_id)
 
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', 'status-flags']
 
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
                if master is None or last_rev == _mod_revision.ensure_null(
 
1032
                    master.last_revision()):
 
1033
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1034
                    note("Tree is up to date at revision %d." % (revno,))
 
1035
                    return 0
 
1036
            conflicts = tree.update(delta._ChangeReporter(
 
1037
                                        unversioned_filter=tree.is_ignored))
 
1038
            revno = tree.branch.revision_id_to_revno(
 
1039
                _mod_revision.ensure_null(tree.last_revision()))
 
1040
            note('Updated to revision %d.' % (revno,))
 
1041
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1042
                note('Your local commits will now show as pending merges with '
 
1043
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1044
            if conflicts != 0:
 
1045
                return 1
 
1046
            else:
 
1047
                return 0
 
1048
        finally:
 
1049
            tree.unlock()
 
1050
 
 
1051
 
 
1052
class cmd_info(Command):
 
1053
    """Show information about a working tree, branch or repository.
 
1054
 
 
1055
    This command will show all known locations and formats associated to the
 
1056
    tree, branch or repository.  Statistical information is included with
 
1057
    each report.
 
1058
 
 
1059
    Branches and working trees will also report any missing revisions.
 
1060
    """
 
1061
    _see_also = ['revno', 'working-trees', 'repositories']
 
1062
    takes_args = ['location?']
 
1063
    takes_options = ['verbose']
 
1064
 
 
1065
    @display_command
 
1066
    def run(self, location=None, verbose=0):
 
1067
        from bzrlib.info import show_bzrdir_info
 
1068
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1069
                         verbose=verbose)
 
1070
 
 
1071
 
 
1072
class cmd_remove(Command):
 
1073
    """Remove files or directories.
 
1074
 
 
1075
    This makes bzr stop tracking changes to the specified files and
 
1076
    delete them if they can easily be recovered using revert.
 
1077
 
 
1078
    You can specify one or more files, and/or --new.  If you specify --new,
 
1079
    only 'added' files will be removed.  If you specify both, then new files
 
1080
    in the specified directories will be removed.  If the directories are
 
1081
    also new, they will also be removed.
 
1082
    """
 
1083
    takes_args = ['file*']
 
1084
    takes_options = ['verbose',
 
1085
        Option('new', help='Remove newly-added files.'),
 
1086
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1087
            'The file deletion mode to be used',
 
1088
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1089
            safe='Only delete files if they can be'
 
1090
                 ' safely recovered (default).',
 
1091
            keep="Don't delete any files.",
 
1092
            force='Delete all the specified files, even if they can not be '
 
1093
                'recovered and even if they are non-empty directories.')]
 
1094
    aliases = ['rm']
 
1095
    encoding_type = 'replace'
 
1096
 
 
1097
    def run(self, file_list, verbose=False, new=False,
 
1098
        file_deletion_strategy='safe'):
 
1099
        tree, file_list = tree_files(file_list)
 
1100
 
 
1101
        if file_list is not None:
 
1102
            file_list = [f for f in file_list if f != '']
 
1103
        elif not new:
 
1104
            raise errors.BzrCommandError('Specify one or more files to'
 
1105
            ' remove, or use --new.')
 
1106
 
 
1107
        if new:
 
1108
            added = tree.changes_from(tree.basis_tree(),
 
1109
                specific_files=file_list).added
 
1110
            file_list = sorted([f[0] for f in added], reverse=True)
 
1111
            if len(file_list) == 0:
 
1112
                raise errors.BzrCommandError('No matching files.')
 
1113
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1114
            keep_files=file_deletion_strategy=='keep',
 
1115
            force=file_deletion_strategy=='force')
 
1116
 
 
1117
 
 
1118
class cmd_file_id(Command):
 
1119
    """Print file_id of a particular file or directory.
 
1120
 
 
1121
    The file_id is assigned when the file is first added and remains the
 
1122
    same through all revisions where the file exists, even when it is
 
1123
    moved or renamed.
 
1124
    """
 
1125
 
 
1126
    hidden = True
 
1127
    _see_also = ['inventory', 'ls']
 
1128
    takes_args = ['filename']
 
1129
 
 
1130
    @display_command
 
1131
    def run(self, filename):
 
1132
        tree, relpath = WorkingTree.open_containing(filename)
 
1133
        i = tree.path2id(relpath)
 
1134
        if i is None:
 
1135
            raise errors.NotVersionedError(filename)
 
1136
        else:
 
1137
            self.outf.write(i + '\n')
 
1138
 
 
1139
 
 
1140
class cmd_file_path(Command):
 
1141
    """Print path of file_ids to a file or directory.
 
1142
 
 
1143
    This prints one line for each directory down to the target,
 
1144
    starting at the branch root.
 
1145
    """
 
1146
 
 
1147
    hidden = True
 
1148
    takes_args = ['filename']
 
1149
 
 
1150
    @display_command
 
1151
    def run(self, filename):
 
1152
        tree, relpath = WorkingTree.open_containing(filename)
 
1153
        fid = tree.path2id(relpath)
 
1154
        if fid is None:
 
1155
            raise errors.NotVersionedError(filename)
 
1156
        segments = osutils.splitpath(relpath)
 
1157
        for pos in range(1, len(segments) + 1):
 
1158
            path = osutils.joinpath(segments[:pos])
 
1159
            self.outf.write("%s\n" % tree.path2id(path))
 
1160
 
 
1161
 
 
1162
class cmd_reconcile(Command):
 
1163
    """Reconcile bzr metadata in a branch.
 
1164
 
 
1165
    This can correct data mismatches that may have been caused by
 
1166
    previous ghost operations or bzr upgrades. You should only
 
1167
    need to run this command if 'bzr check' or a bzr developer 
 
1168
    advises you to run it.
 
1169
 
 
1170
    If a second branch is provided, cross-branch reconciliation is
 
1171
    also attempted, which will check that data like the tree root
 
1172
    id which was not present in very early bzr versions is represented
 
1173
    correctly in both branches.
 
1174
 
 
1175
    At the same time it is run it may recompress data resulting in 
 
1176
    a potential saving in disk space or performance gain.
 
1177
 
 
1178
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1179
    """
 
1180
 
 
1181
    _see_also = ['check']
 
1182
    takes_args = ['branch?']
 
1183
 
 
1184
    def run(self, branch="."):
 
1185
        from bzrlib.reconcile import reconcile
 
1186
        dir = bzrdir.BzrDir.open(branch)
 
1187
        reconcile(dir)
 
1188
 
 
1189
 
 
1190
class cmd_revision_history(Command):
 
1191
    """Display the list of revision ids on a branch."""
 
1192
 
 
1193
    _see_also = ['log']
 
1194
    takes_args = ['location?']
 
1195
 
 
1196
    hidden = True
 
1197
 
 
1198
    @display_command
 
1199
    def run(self, location="."):
 
1200
        branch = Branch.open_containing(location)[0]
 
1201
        for revid in branch.revision_history():
 
1202
            self.outf.write(revid)
 
1203
            self.outf.write('\n')
 
1204
 
 
1205
 
 
1206
class cmd_ancestry(Command):
 
1207
    """List all revisions merged into this branch."""
 
1208
 
 
1209
    _see_also = ['log', 'revision-history']
 
1210
    takes_args = ['location?']
 
1211
 
 
1212
    hidden = True
 
1213
 
 
1214
    @display_command
 
1215
    def run(self, location="."):
 
1216
        try:
 
1217
            wt = WorkingTree.open_containing(location)[0]
 
1218
        except errors.NoWorkingTree:
 
1219
            b = Branch.open(location)
 
1220
            last_revision = b.last_revision()
 
1221
        else:
 
1222
            b = wt.branch
 
1223
            last_revision = wt.last_revision()
 
1224
 
 
1225
        revision_ids = b.repository.get_ancestry(last_revision)
 
1226
        assert revision_ids[0] is None
 
1227
        revision_ids.pop(0)
 
1228
        for revision_id in revision_ids:
 
1229
            self.outf.write(revision_id + '\n')
 
1230
 
 
1231
 
 
1232
class cmd_init(Command):
 
1233
    """Make a directory into a versioned branch.
 
1234
 
 
1235
    Use this to create an empty branch, or before importing an
 
1236
    existing project.
 
1237
 
 
1238
    If there is a repository in a parent directory of the location, then 
 
1239
    the history of the branch will be stored in the repository.  Otherwise
 
1240
    init creates a standalone branch which carries its own history
 
1241
    in the .bzr directory.
 
1242
 
 
1243
    If there is already a branch at the location but it has no working tree,
 
1244
    the tree can be populated with 'bzr checkout'.
 
1245
 
 
1246
    Recipe for importing a tree of files:
 
1247
        cd ~/project
 
1248
        bzr init
 
1249
        bzr add .
 
1250
        bzr status
 
1251
        bzr commit -m 'imported project'
 
1252
    """
 
1253
 
 
1254
    _see_also = ['init-repo', 'branch', 'checkout']
 
1255
    takes_args = ['location?']
 
1256
    takes_options = [
 
1257
        Option('create-prefix',
 
1258
               help='Create the path leading up to the branch '
 
1259
                    'if it does not already exist.'),
 
1260
         RegistryOption('format',
 
1261
                help='Specify a format for this branch. '
 
1262
                'See "help formats".',
 
1263
                registry=bzrdir.format_registry,
 
1264
                converter=bzrdir.format_registry.make_bzrdir,
 
1265
                value_switches=True,
 
1266
                title="Branch Format",
 
1267
                ),
 
1268
         Option('append-revisions-only',
 
1269
                help='Never change revnos or the existing log.'
 
1270
                '  Append revisions to it only.')
 
1271
         ]
 
1272
    def run(self, location=None, format=None, append_revisions_only=False,
 
1273
            create_prefix=False):
 
1274
        if format is None:
 
1275
            format = bzrdir.format_registry.make_bzrdir('default')
 
1276
        if location is None:
 
1277
            location = u'.'
 
1278
 
 
1279
        to_transport = transport.get_transport(location)
 
1280
 
 
1281
        # The path has to exist to initialize a
 
1282
        # branch inside of it.
 
1283
        # Just using os.mkdir, since I don't
 
1284
        # believe that we want to create a bunch of
 
1285
        # locations if the user supplies an extended path
 
1286
        try:
 
1287
            to_transport.ensure_base()
 
1288
        except errors.NoSuchFile:
 
1289
            if not create_prefix:
 
1290
                raise errors.BzrCommandError("Parent directory of %s"
 
1291
                    " does not exist."
 
1292
                    "\nYou may supply --create-prefix to create all"
 
1293
                    " leading parent directories."
 
1294
                    % location)
 
1295
            _create_prefix(to_transport)
 
1296
 
 
1297
        try:
 
1298
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1299
        except errors.NotBranchError:
 
1300
            # really a NotBzrDir error...
 
1301
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1302
            branch = create_branch(to_transport.base, format=format,
 
1303
                                   possible_transports=[to_transport])
 
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
        from bzrlib.version import show_version
 
2480
 
 
2481
        if cache_dir is not None:
 
2482
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2483
        if not list_only:
 
2484
            show_version(show_config=False, show_copyright=False)
 
2485
        print
 
2486
        if testspecs_list is not None:
 
2487
            pattern = '|'.join(testspecs_list)
 
2488
        else:
 
2489
            pattern = ".*"
 
2490
        if benchmark:
 
2491
            test_suite_factory = benchmarks.test_suite
 
2492
            if verbose is None:
 
2493
                verbose = True
 
2494
            # TODO: should possibly lock the history file...
 
2495
            benchfile = open(".perf_history", "at", buffering=1)
 
2496
        else:
 
2497
            test_suite_factory = None
 
2498
            if verbose is None:
 
2499
                verbose = False
 
2500
            benchfile = None
 
2501
        try:
 
2502
            result = selftest(verbose=verbose,
 
2503
                              pattern=pattern,
 
2504
                              stop_on_failure=one,
 
2505
                              transport=transport,
 
2506
                              test_suite_factory=test_suite_factory,
 
2507
                              lsprof_timed=lsprof_timed,
 
2508
                              bench_history=benchfile,
 
2509
                              matching_tests_first=first,
 
2510
                              list_only=list_only,
 
2511
                              random_seed=randomize,
 
2512
                              exclude_pattern=exclude
 
2513
                              )
 
2514
        finally:
 
2515
            if benchfile is not None:
 
2516
                benchfile.close()
 
2517
        if result:
 
2518
            info('tests passed')
 
2519
        else:
 
2520
            info('tests failed')
 
2521
        return int(not result)
 
2522
 
 
2523
 
 
2524
class cmd_version(Command):
 
2525
    """Show version of bzr."""
 
2526
 
 
2527
    @display_command
 
2528
    def run(self):
 
2529
        from bzrlib.version import show_version
 
2530
        show_version()
 
2531
 
 
2532
 
 
2533
class cmd_rocks(Command):
 
2534
    """Statement of optimism."""
 
2535
 
 
2536
    hidden = True
 
2537
 
 
2538
    @display_command
 
2539
    def run(self):
 
2540
        print "It sure does!"
 
2541
 
 
2542
 
 
2543
class cmd_find_merge_base(Command):
 
2544
    """Find and print a base revision for merging two branches."""
 
2545
    # TODO: Options to specify revisions on either side, as if
 
2546
    #       merging only part of the history.
 
2547
    takes_args = ['branch', 'other']
 
2548
    hidden = True
 
2549
    
 
2550
    @display_command
 
2551
    def run(self, branch, other):
 
2552
        from bzrlib.revision import ensure_null, MultipleRevisionSources
 
2553
        
 
2554
        branch1 = Branch.open_containing(branch)[0]
 
2555
        branch2 = Branch.open_containing(other)[0]
 
2556
 
 
2557
        last1 = ensure_null(branch1.last_revision())
 
2558
        last2 = ensure_null(branch2.last_revision())
 
2559
 
 
2560
        graph = branch1.repository.get_graph(branch2.repository)
 
2561
        base_rev_id = graph.find_unique_lca(last1, last2)
 
2562
 
 
2563
        print 'merge base is revision %s' % base_rev_id
 
2564
 
 
2565
 
 
2566
class cmd_merge(Command):
 
2567
    """Perform a three-way merge.
 
2568
    
 
2569
    The branch is the branch you will merge from.  By default, it will merge
 
2570
    the latest revision.  If you specify a revision, that revision will be
 
2571
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2572
    and the second one as OTHER.  Revision numbers are always relative to the
 
2573
    specified branch.
 
2574
 
 
2575
    By default, bzr will try to merge in all new work from the other
 
2576
    branch, automatically determining an appropriate base.  If this
 
2577
    fails, you may need to give an explicit base.
 
2578
    
 
2579
    Merge will do its best to combine the changes in two branches, but there
 
2580
    are some kinds of problems only a human can fix.  When it encounters those,
 
2581
    it will mark a conflict.  A conflict means that you need to fix something,
 
2582
    before you should commit.
 
2583
 
 
2584
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2585
 
 
2586
    If there is no default branch set, the first merge will set it. After
 
2587
    that, you can omit the branch to use the default.  To change the
 
2588
    default, use --remember. The value will only be saved if the remote
 
2589
    location can be accessed.
 
2590
 
 
2591
    The results of the merge are placed into the destination working
 
2592
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2593
    committed to record the result of the merge.
 
2594
 
 
2595
    Examples:
 
2596
 
 
2597
    To merge the latest revision from bzr.dev:
 
2598
        bzr merge ../bzr.dev
 
2599
 
 
2600
    To merge changes up to and including revision 82 from bzr.dev:
 
2601
        bzr merge -r 82 ../bzr.dev
 
2602
 
 
2603
    To merge the changes introduced by 82, without previous changes:
 
2604
        bzr merge -r 81..82 ../bzr.dev
 
2605
    
 
2606
    merge refuses to run if there are any uncommitted changes, unless
 
2607
    --force is given.
 
2608
    """
 
2609
 
 
2610
    _see_also = ['update', 'remerge', 'status-flags']
 
2611
    takes_args = ['branch?']
 
2612
    takes_options = [
 
2613
        'revision',
 
2614
        Option('force',
 
2615
               help='Merge even if the destination tree has uncommitted changes.'),
 
2616
        'merge-type',
 
2617
        'reprocess',
 
2618
        'remember',
 
2619
        Option('show-base', help="Show base revision text in "
 
2620
               "conflicts."),
 
2621
        Option('uncommitted', help='Apply uncommitted changes'
 
2622
               ' from a working copy, instead of branch changes.'),
 
2623
        Option('pull', help='If the destination is already'
 
2624
                ' completely merged into the source, pull from the'
 
2625
                ' source rather than merging.  When this happens,'
 
2626
                ' you do not need to commit the result.'),
 
2627
        Option('directory',
 
2628
               help='Branch to merge into, '
 
2629
                    'rather than the one containing the working directory.',
 
2630
               short_name='d',
 
2631
               type=unicode,
 
2632
               ),
 
2633
    ]
 
2634
 
 
2635
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2636
            show_base=False, reprocess=False, remember=False,
 
2637
            uncommitted=False, pull=False,
 
2638
            directory=None,
 
2639
            ):
 
2640
        from bzrlib.tag import _merge_tags_if_possible
 
2641
        # This is actually a branch (or merge-directive) *location*.
 
2642
        location = branch
 
2643
        del branch
 
2644
 
 
2645
        if merge_type is None:
 
2646
            merge_type = _mod_merge.Merge3Merger
 
2647
 
 
2648
        if directory is None: directory = u'.'
 
2649
        possible_transports = []
 
2650
        merger = None
 
2651
        allow_pending = True
 
2652
        verified = 'inapplicable'
 
2653
        tree = WorkingTree.open_containing(directory)[0]
 
2654
        change_reporter = delta._ChangeReporter(
 
2655
            unversioned_filter=tree.is_ignored)
 
2656
        cleanups = []
 
2657
        try:
 
2658
            pb = ui.ui_factory.nested_progress_bar()
 
2659
            cleanups.append(pb.finished)
 
2660
            tree.lock_write()
 
2661
            cleanups.append(tree.unlock)
 
2662
            if location is not None:
 
2663
                mergeable, other_transport = _get_mergeable_helper(location)
 
2664
                if mergeable:
 
2665
                    if uncommitted:
 
2666
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2667
                            ' with bundles or merge directives.')
 
2668
 
 
2669
                    if revision is not None:
 
2670
                        raise errors.BzrCommandError(
 
2671
                            'Cannot use -r with merge directives or bundles')
 
2672
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2673
                       mergeable, pb)
 
2674
                possible_transports.append(other_transport)
 
2675
 
 
2676
            if merger is None and uncommitted:
 
2677
                if revision is not None and len(revision) > 0:
 
2678
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2679
                        ' --revision at the same time.')
 
2680
                location = self._select_branch_location(tree, location)[0]
 
2681
                other_tree, other_path = WorkingTree.open_containing(location)
 
2682
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2683
                    pb)
 
2684
                allow_pending = False
 
2685
 
 
2686
            if merger is None:
 
2687
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2688
                    location, revision, remember, possible_transports, pb)
 
2689
 
 
2690
            merger.merge_type = merge_type
 
2691
            merger.reprocess = reprocess
 
2692
            merger.show_base = show_base
 
2693
            merger.change_reporter = change_reporter
 
2694
            self.sanity_check_merger(merger)
 
2695
            if (merger.base_rev_id == merger.other_rev_id and
 
2696
                merger.other_rev_id != None):
 
2697
                note('Nothing to do.')
 
2698
                return 0
 
2699
            if pull:
 
2700
                if merger.interesting_files is not None:
 
2701
                    raise BzrCommandError('Cannot pull individual files')
 
2702
                if (merger.base_rev_id == tree.last_revision()):
 
2703
                    result = tree.pull(merger.other_branch, False,
 
2704
                                       merger.other_rev_id)
 
2705
                    result.report(self.outf)
 
2706
                    return 0
 
2707
            merger.check_basis(not force)
 
2708
            conflict_count = merger.do_merge()
 
2709
            if allow_pending:
 
2710
                merger.set_pending()
 
2711
            if verified == 'failed':
 
2712
                warning('Preview patch does not match changes')
 
2713
            if conflict_count != 0:
 
2714
                return 1
 
2715
            else:
 
2716
                return 0
 
2717
        finally:
 
2718
            for cleanup in reversed(cleanups):
 
2719
                cleanup()
 
2720
 
 
2721
    def sanity_check_merger(self, merger):
 
2722
        if (merger.show_base and
 
2723
            not merger.merge_type is _mod_merge.Merge3Merger):
 
2724
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2725
                                         " merge type. %s" % merge_type)
 
2726
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
2727
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2728
                                         " for merge type %s." % merge_type)
 
2729
        if merger.reprocess and merger.show_base:
 
2730
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2731
                                         " show base.")
 
2732
 
 
2733
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
2734
                                possible_transports, pb):
 
2735
        """Produce a merger from a location, assuming it refers to a branch."""
 
2736
        from bzrlib.tag import _merge_tags_if_possible
 
2737
        assert revision is None or len(revision) < 3
 
2738
        # find the branch locations
 
2739
        other_loc, location = self._select_branch_location(tree, location,
 
2740
            revision, -1)
 
2741
        if revision is not None and len(revision) == 2:
 
2742
            base_loc, location = self._select_branch_location(tree, location,
 
2743
                                                              revision, 0)
 
2744
        else:
 
2745
            base_loc = other_loc
 
2746
        # Open the branches
 
2747
        other_branch, other_path = Branch.open_containing(other_loc,
 
2748
            possible_transports)
 
2749
        if base_loc == other_loc:
 
2750
            base_branch = other_branch
 
2751
        else:
 
2752
            base_branch, base_path = Branch.open_containing(base_loc,
 
2753
                possible_transports)
 
2754
        # Find the revision ids
 
2755
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
2756
            other_revision_id = _mod_revision.ensure_null(
 
2757
                other_branch.last_revision())
 
2758
        else:
 
2759
            other_revision_id = \
 
2760
                _mod_revision.ensure_null(
 
2761
                    revision[-1].in_history(other_branch).rev_id)
 
2762
        if (revision is not None and len(revision) == 2
 
2763
            and revision[0] is not None):
 
2764
            base_revision_id = \
 
2765
                _mod_revision.ensure_null(
 
2766
                    revision[0].in_history(base_branch).rev_id)
 
2767
        else:
 
2768
            base_revision_id = None
 
2769
        # Remember where we merge from
 
2770
        if ((tree.branch.get_parent() is None or remember) and
 
2771
            other_branch is not None):
 
2772
            tree.branch.set_parent(other_branch.base)
 
2773
        _merge_tags_if_possible(other_branch, tree.branch)
 
2774
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
2775
            other_revision_id, base_revision_id, other_branch, base_branch)
 
2776
        if other_path != '':
 
2777
            allow_pending = False
 
2778
            merger.interesting_files = [other_path]
 
2779
        else:
 
2780
            allow_pending = True
 
2781
        return merger, allow_pending
 
2782
 
 
2783
    def _select_branch_location(self, tree, location, revision=None,
 
2784
                                index=None):
 
2785
        """Select a branch location, according to possible inputs.
 
2786
 
 
2787
        If provided, branches from ``revision`` are preferred.  (Both
 
2788
        ``revision`` and ``index`` must be supplied.)
 
2789
 
 
2790
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
2791
        ``parent`` location is used, and a note is printed.
 
2792
 
 
2793
        :param tree: The working tree to select a branch for merging into
 
2794
        :param location: The location entered by the user
 
2795
        :param revision: The revision parameter to the command
 
2796
        :param index: The index to use for the revision parameter.  Negative
 
2797
            indices are permitted.
 
2798
        :return: (selected_location, default_location).  The default location
 
2799
            will be the user-entered location, if any, or else the remembered
 
2800
            location.
 
2801
        """
 
2802
        if (revision is not None and index is not None
 
2803
            and revision[index] is not None):
 
2804
            branch = revision[index].get_branch()
 
2805
            if branch is not None:
 
2806
                return branch, location
 
2807
        location = self._get_remembered_parent(tree, location, 'Merging from')
 
2808
        return location, location
 
2809
 
 
2810
    # TODO: move up to common parent; this isn't merge-specific anymore. 
 
2811
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
2812
        """Use tree.branch's parent if none was supplied.
 
2813
 
 
2814
        Report if the remembered location was used.
 
2815
        """
 
2816
        if supplied_location is not None:
 
2817
            return supplied_location
 
2818
        stored_location = tree.branch.get_parent()
 
2819
        mutter("%s", stored_location)
 
2820
        if stored_location is None:
 
2821
            raise errors.BzrCommandError("No location specified or remembered")
 
2822
        display_url = urlutils.unescape_for_display(stored_location,
 
2823
            self.outf.encoding)
 
2824
        self.outf.write("%s remembered location %s\n" % (verb_string,
 
2825
            display_url))
 
2826
        return stored_location
 
2827
 
 
2828
 
 
2829
class cmd_remerge(Command):
 
2830
    """Redo a merge.
 
2831
 
 
2832
    Use this if you want to try a different merge technique while resolving
 
2833
    conflicts.  Some merge techniques are better than others, and remerge 
 
2834
    lets you try different ones on different files.
 
2835
 
 
2836
    The options for remerge have the same meaning and defaults as the ones for
 
2837
    merge.  The difference is that remerge can (only) be run when there is a
 
2838
    pending merge, and it lets you specify particular files.
 
2839
 
 
2840
    Examples:
 
2841
 
 
2842
    $ bzr remerge --show-base
 
2843
        Re-do the merge of all conflicted files, and show the base text in
 
2844
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2845
 
 
2846
    $ bzr remerge --merge-type weave --reprocess foobar
 
2847
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2848
        additional processing to reduce the size of conflict regions.
 
2849
    """
 
2850
    takes_args = ['file*']
 
2851
    takes_options = [
 
2852
            'merge-type',
 
2853
            'reprocess',
 
2854
            Option('show-base',
 
2855
                   help="Show base revision text in conflicts."),
 
2856
            ]
 
2857
 
 
2858
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2859
            reprocess=False):
 
2860
        if merge_type is None:
 
2861
            merge_type = _mod_merge.Merge3Merger
 
2862
        tree, file_list = tree_files(file_list)
 
2863
        tree.lock_write()
 
2864
        try:
 
2865
            parents = tree.get_parent_ids()
 
2866
            if len(parents) != 2:
 
2867
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
2868
                                             " merges.  Not cherrypicking or"
 
2869
                                             " multi-merges.")
 
2870
            repository = tree.branch.repository
 
2871
            graph = repository.get_graph()
 
2872
            base_revision = graph.find_unique_lca(parents[0], parents[1])
 
2873
            base_tree = repository.revision_tree(base_revision)
 
2874
            other_tree = repository.revision_tree(parents[1])
 
2875
            interesting_ids = None
 
2876
            new_conflicts = []
 
2877
            conflicts = tree.conflicts()
 
2878
            if file_list is not None:
 
2879
                interesting_ids = set()
 
2880
                for filename in file_list:
 
2881
                    file_id = tree.path2id(filename)
 
2882
                    if file_id is None:
 
2883
                        raise errors.NotVersionedError(filename)
 
2884
                    interesting_ids.add(file_id)
 
2885
                    if tree.kind(file_id) != "directory":
 
2886
                        continue
 
2887
                    
 
2888
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2889
                        interesting_ids.add(ie.file_id)
 
2890
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
2891
            else:
 
2892
                # Remerge only supports resolving contents conflicts
 
2893
                allowed_conflicts = ('text conflict', 'contents conflict')
 
2894
                restore_files = [c.path for c in conflicts
 
2895
                                 if c.typestring in allowed_conflicts]
 
2896
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
2897
            tree.set_conflicts(ConflictList(new_conflicts))
 
2898
            if file_list is not None:
 
2899
                restore_files = file_list
 
2900
            for filename in restore_files:
 
2901
                try:
 
2902
                    restore(tree.abspath(filename))
 
2903
                except errors.NotConflicted:
 
2904
                    pass
 
2905
            # Disable pending merges, because the file texts we are remerging
 
2906
            # have not had those merges performed.  If we use the wrong parents
 
2907
            # list, we imply that the working tree text has seen and rejected
 
2908
            # all the changes from the other tree, when in fact those changes
 
2909
            # have not yet been seen.
 
2910
            tree.set_parent_ids(parents[:1])
 
2911
            try:
 
2912
                conflicts = _mod_merge.merge_inner(
 
2913
                                          tree.branch, other_tree, base_tree,
 
2914
                                          this_tree=tree,
 
2915
                                          interesting_ids=interesting_ids,
 
2916
                                          other_rev_id=parents[1],
 
2917
                                          merge_type=merge_type,
 
2918
                                          show_base=show_base,
 
2919
                                          reprocess=reprocess)
 
2920
            finally:
 
2921
                tree.set_parent_ids(parents)
 
2922
        finally:
 
2923
            tree.unlock()
 
2924
        if conflicts > 0:
 
2925
            return 1
 
2926
        else:
 
2927
            return 0
 
2928
 
 
2929
 
 
2930
class cmd_revert(Command):
 
2931
    """Revert files to a previous revision.
 
2932
 
 
2933
    Giving a list of files will revert only those files.  Otherwise, all files
 
2934
    will be reverted.  If the revision is not specified with '--revision', the
 
2935
    last committed revision is used.
 
2936
 
 
2937
    To remove only some changes, without reverting to a prior version, use
 
2938
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
 
2939
    introduced by -2, without affecting the changes introduced by -1.  Or
 
2940
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
2941
    
 
2942
    By default, any files that have been manually changed will be backed up
 
2943
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
2944
    '.~#~' appended to their name, where # is a number.
 
2945
 
 
2946
    When you provide files, you can use their current pathname or the pathname
 
2947
    from the target revision.  So you can use revert to "undelete" a file by
 
2948
    name.  If you name a directory, all the contents of that directory will be
 
2949
    reverted.
 
2950
    """
 
2951
 
 
2952
    _see_also = ['cat', 'export']
 
2953
    takes_options = [
 
2954
            'revision',
 
2955
            Option('no-backup', "Do not save backups of reverted files."),
 
2956
            ]
 
2957
    takes_args = ['file*']
 
2958
 
 
2959
    def run(self, revision=None, no_backup=False, file_list=None):
 
2960
        if file_list is not None:
 
2961
            if len(file_list) == 0:
 
2962
                raise errors.BzrCommandError("No files specified")
 
2963
        else:
 
2964
            file_list = []
 
2965
        
 
2966
        tree, file_list = tree_files(file_list)
 
2967
        if revision is None:
 
2968
            # FIXME should be tree.last_revision
 
2969
            rev_id = tree.last_revision()
 
2970
        elif len(revision) != 1:
 
2971
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
2972
        else:
 
2973
            rev_id = revision[0].in_history(tree.branch).rev_id
 
2974
        pb = ui.ui_factory.nested_progress_bar()
 
2975
        try:
 
2976
            tree.revert(file_list, 
 
2977
                        tree.branch.repository.revision_tree(rev_id),
 
2978
                        not no_backup, pb, report_changes=True)
 
2979
        finally:
 
2980
            pb.finished()
 
2981
 
 
2982
 
 
2983
class cmd_assert_fail(Command):
 
2984
    """Test reporting of assertion failures"""
 
2985
    # intended just for use in testing
 
2986
 
 
2987
    hidden = True
 
2988
 
 
2989
    def run(self):
 
2990
        raise AssertionError("always fails")
 
2991
 
 
2992
 
 
2993
class cmd_help(Command):
 
2994
    """Show help on a command or other topic.
 
2995
    """
 
2996
 
 
2997
    _see_also = ['topics']
 
2998
    takes_options = [
 
2999
            Option('long', 'Show help on all commands.'),
 
3000
            ]
 
3001
    takes_args = ['topic?']
 
3002
    aliases = ['?', '--help', '-?', '-h']
 
3003
    
 
3004
    @display_command
 
3005
    def run(self, topic=None, long=False):
 
3006
        import bzrlib.help
 
3007
        if topic is None and long:
 
3008
            topic = "commands"
 
3009
        bzrlib.help.help(topic)
 
3010
 
 
3011
 
 
3012
class cmd_shell_complete(Command):
 
3013
    """Show appropriate completions for context.
 
3014
 
 
3015
    For a list of all available commands, say 'bzr shell-complete'.
 
3016
    """
 
3017
    takes_args = ['context?']
 
3018
    aliases = ['s-c']
 
3019
    hidden = True
 
3020
    
 
3021
    @display_command
 
3022
    def run(self, context=None):
 
3023
        import shellcomplete
 
3024
        shellcomplete.shellcomplete(context)
 
3025
 
 
3026
 
 
3027
class cmd_fetch(Command):
 
3028
    """Copy in history from another branch but don't merge it.
 
3029
 
 
3030
    This is an internal method used for pull and merge.
 
3031
    """
 
3032
    hidden = True
 
3033
    takes_args = ['from_branch', 'to_branch']
 
3034
    def run(self, from_branch, to_branch):
 
3035
        from bzrlib.fetch import Fetcher
 
3036
        from_b = Branch.open(from_branch)
 
3037
        to_b = Branch.open(to_branch)
 
3038
        Fetcher(to_b, from_b)
 
3039
 
 
3040
 
 
3041
class cmd_missing(Command):
 
3042
    """Show unmerged/unpulled revisions between two branches.
 
3043
    
 
3044
    OTHER_BRANCH may be local or remote.
 
3045
    """
 
3046
 
 
3047
    _see_also = ['merge', 'pull']
 
3048
    takes_args = ['other_branch?']
 
3049
    takes_options = [
 
3050
            Option('reverse', 'Reverse the order of revisions.'),
 
3051
            Option('mine-only',
 
3052
                   'Display changes in the local branch only.'),
 
3053
            Option('this' , 'Same as --mine-only.'),
 
3054
            Option('theirs-only',
 
3055
                   'Display changes in the remote branch only.'),
 
3056
            Option('other', 'Same as --theirs-only.'),
 
3057
            'log-format',
 
3058
            'show-ids',
 
3059
            'verbose'
 
3060
            ]
 
3061
    encoding_type = 'replace'
 
3062
 
 
3063
    @display_command
 
3064
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3065
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3066
            show_ids=False, verbose=False, this=False, other=False):
 
3067
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3068
        from bzrlib.log import log_formatter
 
3069
 
 
3070
        if this:
 
3071
          mine_only = this
 
3072
        if other:
 
3073
          theirs_only = other
 
3074
 
 
3075
        local_branch = Branch.open_containing(u".")[0]
 
3076
        parent = local_branch.get_parent()
 
3077
        if other_branch is None:
 
3078
            other_branch = parent
 
3079
            if other_branch is None:
 
3080
                raise errors.BzrCommandError("No peer location known"
 
3081
                                             " or specified.")
 
3082
            display_url = urlutils.unescape_for_display(parent,
 
3083
                                                        self.outf.encoding)
 
3084
            self.outf.write("Using last location: " + display_url + "\n")
 
3085
 
 
3086
        remote_branch = Branch.open(other_branch)
 
3087
        if remote_branch.base == local_branch.base:
 
3088
            remote_branch = local_branch
 
3089
        local_branch.lock_read()
 
3090
        try:
 
3091
            remote_branch.lock_read()
 
3092
            try:
 
3093
                local_extra, remote_extra = find_unmerged(local_branch,
 
3094
                                                          remote_branch)
 
3095
                if log_format is None:
 
3096
                    registry = log.log_formatter_registry
 
3097
                    log_format = registry.get_default(local_branch)
 
3098
                lf = log_format(to_file=self.outf,
 
3099
                                show_ids=show_ids,
 
3100
                                show_timezone='original')
 
3101
                if reverse is False:
 
3102
                    local_extra.reverse()
 
3103
                    remote_extra.reverse()
 
3104
                if local_extra and not theirs_only:
 
3105
                    self.outf.write("You have %d extra revision(s):\n" %
 
3106
                                    len(local_extra))
 
3107
                    for revision in iter_log_revisions(local_extra,
 
3108
                                        local_branch.repository,
 
3109
                                        verbose):
 
3110
                        lf.log_revision(revision)
 
3111
                    printed_local = True
 
3112
                else:
 
3113
                    printed_local = False
 
3114
                if remote_extra and not mine_only:
 
3115
                    if printed_local is True:
 
3116
                        self.outf.write("\n\n\n")
 
3117
                    self.outf.write("You are missing %d revision(s):\n" %
 
3118
                                    len(remote_extra))
 
3119
                    for revision in iter_log_revisions(remote_extra,
 
3120
                                        remote_branch.repository,
 
3121
                                        verbose):
 
3122
                        lf.log_revision(revision)
 
3123
                if not remote_extra and not local_extra:
 
3124
                    status_code = 0
 
3125
                    self.outf.write("Branches are up to date.\n")
 
3126
                else:
 
3127
                    status_code = 1
 
3128
            finally:
 
3129
                remote_branch.unlock()
 
3130
        finally:
 
3131
            local_branch.unlock()
 
3132
        if not status_code and parent is None and other_branch is not None:
 
3133
            local_branch.lock_write()
 
3134
            try:
 
3135
                # handle race conditions - a parent might be set while we run.
 
3136
                if local_branch.get_parent() is None:
 
3137
                    local_branch.set_parent(remote_branch.base)
 
3138
            finally:
 
3139
                local_branch.unlock()
 
3140
        return status_code
 
3141
 
 
3142
 
 
3143
class cmd_pack(Command):
 
3144
    """Compress the data within a repository."""
 
3145
 
 
3146
    _see_also = ['repositories']
 
3147
    takes_args = ['branch_or_repo?']
 
3148
 
 
3149
    def run(self, branch_or_repo='.'):
 
3150
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
3151
        try:
 
3152
            branch = dir.open_branch()
 
3153
            repository = branch.repository
 
3154
        except errors.NotBranchError:
 
3155
            repository = dir.open_repository()
 
3156
        repository.pack()
 
3157
 
 
3158
 
 
3159
class cmd_plugins(Command):
 
3160
    """List the installed plugins.
 
3161
    
 
3162
    This command displays the list of installed plugins including the
 
3163
    path where each one is located and a short description of each.
 
3164
 
 
3165
    A plugin is an external component for Bazaar that extends the
 
3166
    revision control system, by adding or replacing code in Bazaar.
 
3167
    Plugins can do a variety of things, including overriding commands,
 
3168
    adding new commands, providing additional network transports and
 
3169
    customizing log output.
 
3170
 
 
3171
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3172
    information on plugins including where to find them and how to
 
3173
    install them. Instructions are also provided there on how to
 
3174
    write new plugins using the Python programming language.
 
3175
    """
 
3176
 
 
3177
    @display_command
 
3178
    def run(self):
 
3179
        import bzrlib.plugin
 
3180
        from inspect import getdoc
 
3181
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
3182
            if getattr(plugin, '__path__', None) is not None:
 
3183
                print plugin.__path__[0]
 
3184
            elif getattr(plugin, '__file__', None) is not None:
 
3185
                print plugin.__file__
 
3186
            else:
 
3187
                print repr(plugin)
 
3188
                
 
3189
            d = getdoc(plugin)
 
3190
            if d:
 
3191
                print '\t', d.split('\n')[0]
 
3192
 
 
3193
 
 
3194
class cmd_testament(Command):
 
3195
    """Show testament (signing-form) of a revision."""
 
3196
    takes_options = [
 
3197
            'revision',
 
3198
            Option('long', help='Produce long-format testament.'),
 
3199
            Option('strict',
 
3200
                   help='Produce a strict-format testament.')]
 
3201
    takes_args = ['branch?']
 
3202
    @display_command
 
3203
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
3204
        from bzrlib.testament import Testament, StrictTestament
 
3205
        if strict is True:
 
3206
            testament_class = StrictTestament
 
3207
        else:
 
3208
            testament_class = Testament
 
3209
        b = WorkingTree.open_containing(branch)[0].branch
 
3210
        b.lock_read()
 
3211
        try:
 
3212
            if revision is None:
 
3213
                rev_id = b.last_revision()
 
3214
            else:
 
3215
                rev_id = revision[0].in_history(b).rev_id
 
3216
            t = testament_class.from_revision(b.repository, rev_id)
 
3217
            if long:
 
3218
                sys.stdout.writelines(t.as_text_lines())
 
3219
            else:
 
3220
                sys.stdout.write(t.as_short_text())
 
3221
        finally:
 
3222
            b.unlock()
 
3223
 
 
3224
 
 
3225
class cmd_annotate(Command):
 
3226
    """Show the origin of each line in a file.
 
3227
 
 
3228
    This prints out the given file with an annotation on the left side
 
3229
    indicating which revision, author and date introduced the change.
 
3230
 
 
3231
    If the origin is the same for a run of consecutive lines, it is 
 
3232
    shown only at the top, unless the --all option is given.
 
3233
    """
 
3234
    # TODO: annotate directories; showing when each file was last changed
 
3235
    # TODO: if the working copy is modified, show annotations on that 
 
3236
    #       with new uncommitted lines marked
 
3237
    aliases = ['ann', 'blame', 'praise']
 
3238
    takes_args = ['filename']
 
3239
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
3240
                     Option('long', help='Show commit date in annotations.'),
 
3241
                     'revision',
 
3242
                     'show-ids',
 
3243
                     ]
 
3244
    encoding_type = 'exact'
 
3245
 
 
3246
    @display_command
 
3247
    def run(self, filename, all=False, long=False, revision=None,
 
3248
            show_ids=False):
 
3249
        from bzrlib.annotate import annotate_file
 
3250
        tree, relpath = WorkingTree.open_containing(filename)
 
3251
        branch = tree.branch
 
3252
        branch.lock_read()
 
3253
        try:
 
3254
            if revision is None:
 
3255
                revision_id = branch.last_revision()
 
3256
            elif len(revision) != 1:
 
3257
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3258
            else:
 
3259
                revision_id = revision[0].in_history(branch).rev_id
 
3260
            file_id = tree.path2id(relpath)
 
3261
            if file_id is None:
 
3262
                raise errors.NotVersionedError(filename)
 
3263
            tree = branch.repository.revision_tree(revision_id)
 
3264
            file_version = tree.inventory[file_id].revision
 
3265
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3266
                          show_ids=show_ids)
 
3267
        finally:
 
3268
            branch.unlock()
 
3269
 
 
3270
 
 
3271
class cmd_re_sign(Command):
 
3272
    """Create a digital signature for an existing revision."""
 
3273
    # TODO be able to replace existing ones.
 
3274
 
 
3275
    hidden = True # is this right ?
 
3276
    takes_args = ['revision_id*']
 
3277
    takes_options = ['revision']
 
3278
    
 
3279
    def run(self, revision_id_list=None, revision=None):
 
3280
        import bzrlib.gpg as gpg
 
3281
        if revision_id_list is not None and revision is not None:
 
3282
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3283
        if revision_id_list is None and revision is None:
 
3284
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3285
        b = WorkingTree.open_containing(u'.')[0].branch
 
3286
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3287
        if revision_id_list is not None:
 
3288
            for revision_id in revision_id_list:
 
3289
                b.repository.sign_revision(revision_id, gpg_strategy)
 
3290
        elif revision is not None:
 
3291
            if len(revision) == 1:
 
3292
                revno, rev_id = revision[0].in_history(b)
 
3293
                b.repository.sign_revision(rev_id, gpg_strategy)
 
3294
            elif len(revision) == 2:
 
3295
                # are they both on rh- if so we can walk between them
 
3296
                # might be nice to have a range helper for arbitrary
 
3297
                # revision paths. hmm.
 
3298
                from_revno, from_revid = revision[0].in_history(b)
 
3299
                to_revno, to_revid = revision[1].in_history(b)
 
3300
                if to_revid is None:
 
3301
                    to_revno = b.revno()
 
3302
                if from_revno is None or to_revno is None:
 
3303
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3304
                for revno in range(from_revno, to_revno + 1):
 
3305
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
3306
                                               gpg_strategy)
 
3307
            else:
 
3308
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3309
 
 
3310
 
 
3311
class cmd_bind(Command):
 
3312
    """Convert the current branch into a checkout of the supplied branch.
 
3313
 
 
3314
    Once converted into a checkout, commits must succeed on the master branch
 
3315
    before they will be applied to the local branch.
 
3316
    """
 
3317
 
 
3318
    _see_also = ['checkouts', 'unbind']
 
3319
    takes_args = ['location?']
 
3320
    takes_options = []
 
3321
 
 
3322
    def run(self, location=None):
 
3323
        b, relpath = Branch.open_containing(u'.')
 
3324
        if location is None:
 
3325
            try:
 
3326
                location = b.get_old_bound_location()
 
3327
            except errors.UpgradeRequired:
 
3328
                raise errors.BzrCommandError('No location supplied.  '
 
3329
                    'This format does not remember old locations.')
 
3330
            else:
 
3331
                if location is None:
 
3332
                    raise errors.BzrCommandError('No location supplied and no '
 
3333
                        'previous location known')
 
3334
        b_other = Branch.open(location)
 
3335
        try:
 
3336
            b.bind(b_other)
 
3337
        except errors.DivergedBranches:
 
3338
            raise errors.BzrCommandError('These branches have diverged.'
 
3339
                                         ' Try merging, and then bind again.')
 
3340
 
 
3341
 
 
3342
class cmd_unbind(Command):
 
3343
    """Convert the current checkout into a regular branch.
 
3344
 
 
3345
    After unbinding, the local branch is considered independent and subsequent
 
3346
    commits will be local only.
 
3347
    """
 
3348
 
 
3349
    _see_also = ['checkouts', 'bind']
 
3350
    takes_args = []
 
3351
    takes_options = []
 
3352
 
 
3353
    def run(self):
 
3354
        b, relpath = Branch.open_containing(u'.')
 
3355
        if not b.unbind():
 
3356
            raise errors.BzrCommandError('Local branch is not bound')
 
3357
 
 
3358
 
 
3359
class cmd_uncommit(Command):
 
3360
    """Remove the last committed revision.
 
3361
 
 
3362
    --verbose will print out what is being removed.
 
3363
    --dry-run will go through all the motions, but not actually
 
3364
    remove anything.
 
3365
    
 
3366
    In the future, uncommit will create a revision bundle, which can then
 
3367
    be re-applied.
 
3368
    """
 
3369
 
 
3370
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3371
    # unreferenced information in 'branch-as-repository' branches.
 
3372
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3373
    # information in shared branches as well.
 
3374
    _see_also = ['commit']
 
3375
    takes_options = ['verbose', 'revision',
 
3376
                    Option('dry-run', help='Don\'t actually make changes.'),
 
3377
                    Option('force', help='Say yes to all questions.')]
 
3378
    takes_args = ['location?']
 
3379
    aliases = []
 
3380
 
 
3381
    def run(self, location=None,
 
3382
            dry_run=False, verbose=False,
 
3383
            revision=None, force=False):
 
3384
        from bzrlib.log import log_formatter, show_log
 
3385
        import sys
 
3386
        from bzrlib.uncommit import uncommit
 
3387
 
 
3388
        if location is None:
 
3389
            location = u'.'
 
3390
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3391
        try:
 
3392
            tree = control.open_workingtree()
 
3393
            b = tree.branch
 
3394
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3395
            tree = None
 
3396
            b = control.open_branch()
 
3397
 
 
3398
        rev_id = None
 
3399
        if revision is None:
 
3400
            revno = b.revno()
 
3401
        else:
 
3402
            # 'bzr uncommit -r 10' actually means uncommit
 
3403
            # so that the final tree is at revno 10.
 
3404
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3405
            # the revisions that are supplied.
 
3406
            # So we need to offset it by one
 
3407
            revno = revision[0].in_history(b).revno+1
 
3408
 
 
3409
        if revno <= b.revno():
 
3410
            rev_id = b.get_rev_id(revno)
 
3411
        if rev_id is None:
 
3412
            self.outf.write('No revisions to uncommit.\n')
 
3413
            return 1
 
3414
 
 
3415
        lf = log_formatter('short',
 
3416
                           to_file=self.outf,
 
3417
                           show_timezone='original')
 
3418
 
 
3419
        show_log(b,
 
3420
                 lf,
 
3421
                 verbose=False,
 
3422
                 direction='forward',
 
3423
                 start_revision=revno,
 
3424
                 end_revision=b.revno())
 
3425
 
 
3426
        if dry_run:
 
3427
            print 'Dry-run, pretending to remove the above revisions.'
 
3428
            if not force:
 
3429
                val = raw_input('Press <enter> to continue')
 
3430
        else:
 
3431
            print 'The above revision(s) will be removed.'
 
3432
            if not force:
 
3433
                val = raw_input('Are you sure [y/N]? ')
 
3434
                if val.lower() not in ('y', 'yes'):
 
3435
                    print 'Canceled'
 
3436
                    return 0
 
3437
 
 
3438
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3439
                revno=revno)
 
3440
 
 
3441
 
 
3442
class cmd_break_lock(Command):
 
3443
    """Break a dead lock on a repository, branch or working directory.
 
3444
 
 
3445
    CAUTION: Locks should only be broken when you are sure that the process
 
3446
    holding the lock has been stopped.
 
3447
 
 
3448
    You can get information on what locks are open via the 'bzr info' command.
 
3449
    
 
3450
    example:
 
3451
        bzr break-lock
 
3452
    """
 
3453
    takes_args = ['location?']
 
3454
 
 
3455
    def run(self, location=None, show=False):
 
3456
        if location is None:
 
3457
            location = u'.'
 
3458
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3459
        try:
 
3460
            control.break_lock()
 
3461
        except NotImplementedError:
 
3462
            pass
 
3463
        
 
3464
 
 
3465
class cmd_wait_until_signalled(Command):
 
3466
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3467
 
 
3468
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3469
    """
 
3470
 
 
3471
    hidden = True
 
3472
 
 
3473
    def run(self):
 
3474
        sys.stdout.write("running\n")
 
3475
        sys.stdout.flush()
 
3476
        sys.stdin.readline()
 
3477
 
 
3478
 
 
3479
class cmd_serve(Command):
 
3480
    """Run the bzr server."""
 
3481
 
 
3482
    aliases = ['server']
 
3483
 
 
3484
    takes_options = [
 
3485
        Option('inet',
 
3486
               help='Serve on stdin/out for use from inetd or sshd.'),
 
3487
        Option('port',
 
3488
               help='Listen for connections on nominated port of the form '
 
3489
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
3490
                    'result in a dynamically allocated port.  The default port is '
 
3491
                    '4155.',
 
3492
               type=str),
 
3493
        Option('directory',
 
3494
               help='Serve contents of this directory.',
 
3495
               type=unicode),
 
3496
        Option('allow-writes',
 
3497
               help='By default the server is a readonly server.  Supplying '
 
3498
                    '--allow-writes enables write access to the contents of '
 
3499
                    'the served directory and below.'
 
3500
                ),
 
3501
        ]
 
3502
 
 
3503
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3504
        from bzrlib.smart import medium, server
 
3505
        from bzrlib.transport import get_transport
 
3506
        from bzrlib.transport.chroot import ChrootServer
 
3507
        from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
 
3508
        if directory is None:
 
3509
            directory = os.getcwd()
 
3510
        url = urlutils.local_path_to_url(directory)
 
3511
        if not allow_writes:
 
3512
            url = 'readonly+' + url
 
3513
        chroot_server = ChrootServer(get_transport(url))
 
3514
        chroot_server.setUp()
 
3515
        t = get_transport(chroot_server.get_url())
 
3516
        if inet:
 
3517
            smart_server = medium.SmartServerPipeStreamMedium(
 
3518
                sys.stdin, sys.stdout, t)
 
3519
        else:
 
3520
            host = BZR_DEFAULT_INTERFACE
 
3521
            if port is None:
 
3522
                port = BZR_DEFAULT_PORT
 
3523
            else:
 
3524
                if ':' in port:
 
3525
                    host, port = port.split(':')
 
3526
                port = int(port)
 
3527
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3528
            print 'listening on port: ', smart_server.port
 
3529
            sys.stdout.flush()
 
3530
        # for the duration of this server, no UI output is permitted.
 
3531
        # note that this may cause problems with blackbox tests. This should
 
3532
        # be changed with care though, as we dont want to use bandwidth sending
 
3533
        # progress over stderr to smart server clients!
 
3534
        old_factory = ui.ui_factory
 
3535
        try:
 
3536
            ui.ui_factory = ui.SilentUIFactory()
 
3537
            smart_server.serve()
 
3538
        finally:
 
3539
            ui.ui_factory = old_factory
 
3540
 
 
3541
 
 
3542
class cmd_join(Command):
 
3543
    """Combine a subtree into its containing tree.
 
3544
    
 
3545
    This command is for experimental use only.  It requires the target tree
 
3546
    to be in dirstate-with-subtree format, which cannot be converted into
 
3547
    earlier formats.
 
3548
 
 
3549
    The TREE argument should be an independent tree, inside another tree, but
 
3550
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3551
    running "bzr branch" with the target inside a tree.)
 
3552
 
 
3553
    The result is a combined tree, with the subtree no longer an independant
 
3554
    part.  This is marked as a merge of the subtree into the containing tree,
 
3555
    and all history is preserved.
 
3556
 
 
3557
    If --reference is specified, the subtree retains its independence.  It can
 
3558
    be branched by itself, and can be part of multiple projects at the same
 
3559
    time.  But operations performed in the containing tree, such as commit
 
3560
    and merge, will recurse into the subtree.
 
3561
    """
 
3562
 
 
3563
    _see_also = ['split']
 
3564
    takes_args = ['tree']
 
3565
    takes_options = [
 
3566
            Option('reference', help='Join by reference.'),
 
3567
            ]
 
3568
    hidden = True
 
3569
 
 
3570
    def run(self, tree, reference=False):
 
3571
        sub_tree = WorkingTree.open(tree)
 
3572
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3573
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3574
        repo = containing_tree.branch.repository
 
3575
        if not repo.supports_rich_root():
 
3576
            raise errors.BzrCommandError(
 
3577
                "Can't join trees because %s doesn't support rich root data.\n"
 
3578
                "You can use bzr upgrade on the repository."
 
3579
                % (repo,))
 
3580
        if reference:
 
3581
            try:
 
3582
                containing_tree.add_reference(sub_tree)
 
3583
            except errors.BadReferenceTarget, e:
 
3584
                # XXX: Would be better to just raise a nicely printable
 
3585
                # exception from the real origin.  Also below.  mbp 20070306
 
3586
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3587
                                             (tree, e.reason))
 
3588
        else:
 
3589
            try:
 
3590
                containing_tree.subsume(sub_tree)
 
3591
            except errors.BadSubsumeSource, e:
 
3592
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3593
                                             (tree, e.reason))
 
3594
 
 
3595
 
 
3596
class cmd_split(Command):
 
3597
    """Split a tree into two trees.
 
3598
 
 
3599
    This command is for experimental use only.  It requires the target tree
 
3600
    to be in dirstate-with-subtree format, which cannot be converted into
 
3601
    earlier formats.
 
3602
 
 
3603
    The TREE argument should be a subdirectory of a working tree.  That
 
3604
    subdirectory will be converted into an independent tree, with its own
 
3605
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3606
    If you want that behavior, do "bzr join --reference TREE".
 
3607
    """
 
3608
 
 
3609
    _see_also = ['join']
 
3610
    takes_args = ['tree']
 
3611
 
 
3612
    hidden = True
 
3613
 
 
3614
    def run(self, tree):
 
3615
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3616
        sub_id = containing_tree.path2id(subdir)
 
3617
        if sub_id is None:
 
3618
            raise errors.NotVersionedError(subdir)
 
3619
        try:
 
3620
            containing_tree.extract(sub_id)
 
3621
        except errors.RootNotRich:
 
3622
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3623
 
 
3624
 
 
3625
 
 
3626
class cmd_merge_directive(Command):
 
3627
    """Generate a merge directive for auto-merge tools.
 
3628
 
 
3629
    A directive requests a merge to be performed, and also provides all the
 
3630
    information necessary to do so.  This means it must either include a
 
3631
    revision bundle, or the location of a branch containing the desired
 
3632
    revision.
 
3633
 
 
3634
    A submit branch (the location to merge into) must be supplied the first
 
3635
    time the command is issued.  After it has been supplied once, it will
 
3636
    be remembered as the default.
 
3637
 
 
3638
    A public branch is optional if a revision bundle is supplied, but required
 
3639
    if --diff or --plain is specified.  It will be remembered as the default
 
3640
    after the first use.
 
3641
    """
 
3642
 
 
3643
    takes_args = ['submit_branch?', 'public_branch?']
 
3644
 
 
3645
    hidden = True
 
3646
 
 
3647
    _see_also = ['submit']
 
3648
 
 
3649
    takes_options = [
 
3650
        RegistryOption.from_kwargs('patch-type',
 
3651
            'The type of patch to include in the directive',
 
3652
            title='Patch type',
 
3653
            value_switches=True,
 
3654
            enum_switch=False,
 
3655
            bundle='Bazaar revision bundle (default).',
 
3656
            diff='Normal unified diff.',
 
3657
            plain='No patch, just directive.'),
 
3658
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
3659
        Option('mail-to', type=str,
 
3660
            help='Instead of printing the directive, email to this address.'),
 
3661
        Option('message', type=str, short_name='m',
 
3662
            help='Message to use when committing this merge.')
 
3663
        ]
 
3664
 
 
3665
    encoding_type = 'exact'
 
3666
 
 
3667
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3668
            sign=False, revision=None, mail_to=None, message=None):
 
3669
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3670
        include_patch, include_bundle = {
 
3671
            'plain': (False, False),
 
3672
            'diff': (True, False),
 
3673
            'bundle': (True, True),
 
3674
            }[patch_type]
 
3675
        branch = Branch.open('.')
 
3676
        stored_submit_branch = branch.get_submit_branch()
 
3677
        if submit_branch is None:
 
3678
            submit_branch = stored_submit_branch
 
3679
        else:
 
3680
            if stored_submit_branch is None:
 
3681
                branch.set_submit_branch(submit_branch)
 
3682
        if submit_branch is None:
 
3683
            submit_branch = branch.get_parent()
 
3684
        if submit_branch is None:
 
3685
            raise errors.BzrCommandError('No submit branch specified or known')
 
3686
 
 
3687
        stored_public_branch = branch.get_public_branch()
 
3688
        if public_branch is None:
 
3689
            public_branch = stored_public_branch
 
3690
        elif stored_public_branch is None:
 
3691
            branch.set_public_branch(public_branch)
 
3692
        if not include_bundle and public_branch is None:
 
3693
            raise errors.BzrCommandError('No public branch specified or'
 
3694
                                         ' known')
 
3695
        base_revision_id = None
 
3696
        if revision is not None:
 
3697
            if len(revision) > 2:
 
3698
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3699
                    'at most two one revision identifiers')
 
3700
            revision_id = revision[-1].in_history(branch).rev_id
 
3701
            if len(revision) == 2:
 
3702
                base_revision_id = revision[0].in_history(branch).rev_id
 
3703
                base_revision_id = ensure_null(base_revision_id)
 
3704
        else:
 
3705
            revision_id = branch.last_revision()
 
3706
        revision_id = ensure_null(revision_id)
 
3707
        if revision_id == NULL_REVISION:
 
3708
            raise errors.BzrCommandError('No revisions to bundle.')
 
3709
        directive = merge_directive.MergeDirective2.from_objects(
 
3710
            branch.repository, revision_id, time.time(),
 
3711
            osutils.local_time_offset(), submit_branch,
 
3712
            public_branch=public_branch, include_patch=include_patch,
 
3713
            include_bundle=include_bundle, message=message,
 
3714
            base_revision_id=base_revision_id)
 
3715
        if mail_to is None:
 
3716
            if sign:
 
3717
                self.outf.write(directive.to_signed(branch))
 
3718
            else:
 
3719
                self.outf.writelines(directive.to_lines())
 
3720
        else:
 
3721
            message = directive.to_email(mail_to, branch, sign)
 
3722
            s = SMTPConnection(branch.get_config())
 
3723
            s.send_email(message)
 
3724
 
 
3725
 
 
3726
class cmd_send(Command):
 
3727
    """Create a merge-directive for submiting changes.
 
3728
 
 
3729
    A merge directive provides many things needed for requesting merges:
 
3730
    - A machine-readable description of the merge to perform
 
3731
    - An optional patch that is a preview of the changes requested
 
3732
    - An optional bundle of revision data, so that the changes can be applied
 
3733
      directly from the merge directive, without retrieving data from a
 
3734
      branch.
 
3735
 
 
3736
    If --no-bundle is specified, then public_branch is needed (and must be
 
3737
    up-to-date), so that the receiver can perform the merge using the
 
3738
    public_branch.  The public_branch is always included if known, so that
 
3739
    people can check it later.
 
3740
 
 
3741
    The submit branch defaults to the parent, but can be overridden.  Both
 
3742
    submit branch and public branch will be remembered if supplied.
 
3743
 
 
3744
    If a public_branch is known for the submit_branch, that public submit
 
3745
    branch is used in the merge instructions.  This means that a local mirror
 
3746
    can be used as your actual submit branch, once you have set public_branch
 
3747
    for that mirror.
 
3748
    """
 
3749
 
 
3750
    encoding_type = 'exact'
 
3751
 
 
3752
    aliases = ['bundle', 'bundle-revisions']
 
3753
 
 
3754
    _see_also = ['merge']
 
3755
 
 
3756
    takes_args = ['submit_branch?', 'public_branch?']
 
3757
 
 
3758
    takes_options = [
 
3759
        Option('no-bundle',
 
3760
               help='Do not include a bundle in the merge directive.'),
 
3761
        Option('no-patch', help='Do not include a preview patch in the merge'
 
3762
               ' directive.'),
 
3763
        Option('remember',
 
3764
               help='Remember submit and public branch.'),
 
3765
        Option('from',
 
3766
               help='Branch to generate the submission from, '
 
3767
               'rather than the one containing the working directory.',
 
3768
               short_name='f',
 
3769
               type=unicode),
 
3770
        Option('output', short_name='o', help='Write directive to this file.',
 
3771
               type=unicode),
 
3772
        'revision',
 
3773
        ]
 
3774
 
 
3775
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
3776
            no_patch=False, revision=None, remember=False, output=None,
 
3777
            **kwargs):
 
3778
        from bzrlib.revision import ensure_null, NULL_REVISION
 
3779
        if output is None:
 
3780
            raise errors.BzrCommandError('File must be specified with'
 
3781
                                         ' --output')
 
3782
        elif output == '-':
 
3783
            outfile = self.outf
 
3784
        else:
 
3785
            outfile = open(output, 'wb')
 
3786
        try:
 
3787
            from_ = kwargs.get('from', '.')
 
3788
            branch = Branch.open_containing(from_)[0]
 
3789
            if remember and submit_branch is None:
 
3790
                raise errors.BzrCommandError(
 
3791
                    '--remember requires a branch to be specified.')
 
3792
            stored_submit_branch = branch.get_submit_branch()
 
3793
            remembered_submit_branch = False
 
3794
            if submit_branch is None:
 
3795
                submit_branch = stored_submit_branch
 
3796
                remembered_submit_branch = True
 
3797
            else:
 
3798
                if stored_submit_branch is None or remember:
 
3799
                    branch.set_submit_branch(submit_branch)
 
3800
            if submit_branch is None:
 
3801
                submit_branch = branch.get_parent()
 
3802
                remembered_submit_branch = True
 
3803
            if submit_branch is None:
 
3804
                raise errors.BzrCommandError('No submit branch known or'
 
3805
                                             ' specified')
 
3806
            if remembered_submit_branch:
 
3807
                note('Using saved location: %s', submit_branch)
 
3808
 
 
3809
            stored_public_branch = branch.get_public_branch()
 
3810
            if public_branch is None:
 
3811
                public_branch = stored_public_branch
 
3812
            elif stored_public_branch is None or remember:
 
3813
                branch.set_public_branch(public_branch)
 
3814
            if no_bundle and public_branch is None:
 
3815
                raise errors.BzrCommandError('No public branch specified or'
 
3816
                                             ' known')
 
3817
            base_revision_id = None
 
3818
            if revision is not None:
 
3819
                if len(revision) > 2:
 
3820
                    raise errors.BzrCommandError('bzr send takes '
 
3821
                        'at most two one revision identifiers')
 
3822
                revision_id = revision[-1].in_history(branch).rev_id
 
3823
                if len(revision) == 2:
 
3824
                    base_revision_id = revision[0].in_history(branch).rev_id
 
3825
                    base_revision_id = ensure_null(base_revision_id)
 
3826
            else:
 
3827
                revision_id = branch.last_revision()
 
3828
            revision_id = ensure_null(revision_id)
 
3829
            if revision_id == NULL_REVISION:
 
3830
                raise errors.BzrCommandError('No revisions to submit.')
 
3831
            directive = merge_directive.MergeDirective2.from_objects(
 
3832
                branch.repository, revision_id, time.time(),
 
3833
                osutils.local_time_offset(), submit_branch,
 
3834
                public_branch=public_branch, include_patch=not no_patch,
 
3835
                include_bundle=not no_bundle, message=None,
 
3836
                base_revision_id=base_revision_id)
 
3837
            outfile.writelines(directive.to_lines())
 
3838
        finally:
 
3839
            if output != '-':
 
3840
                outfile.close()
 
3841
 
 
3842
 
 
3843
class cmd_tag(Command):
 
3844
    """Create, remove or modify a tag naming a revision.
 
3845
    
 
3846
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
3847
    (--revision) option can be given -rtag:X, where X is any previously
 
3848
    created tag.
 
3849
 
 
3850
    Tags are stored in the branch.  Tags are copied from one branch to another
 
3851
    along when you branch, push, pull or merge.
 
3852
 
 
3853
    It is an error to give a tag name that already exists unless you pass 
 
3854
    --force, in which case the tag is moved to point to the new revision.
 
3855
    """
 
3856
 
 
3857
    _see_also = ['commit', 'tags']
 
3858
    takes_args = ['tag_name']
 
3859
    takes_options = [
 
3860
        Option('delete',
 
3861
            help='Delete this tag rather than placing it.',
 
3862
            ),
 
3863
        Option('directory',
 
3864
            help='Branch in which to place the tag.',
 
3865
            short_name='d',
 
3866
            type=unicode,
 
3867
            ),
 
3868
        Option('force',
 
3869
            help='Replace existing tags.',
 
3870
            ),
 
3871
        'revision',
 
3872
        ]
 
3873
 
 
3874
    def run(self, tag_name,
 
3875
            delete=None,
 
3876
            directory='.',
 
3877
            force=None,
 
3878
            revision=None,
 
3879
            ):
 
3880
        branch, relpath = Branch.open_containing(directory)
 
3881
        branch.lock_write()
 
3882
        try:
 
3883
            if delete:
 
3884
                branch.tags.delete_tag(tag_name)
 
3885
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
3886
            else:
 
3887
                if revision:
 
3888
                    if len(revision) != 1:
 
3889
                        raise errors.BzrCommandError(
 
3890
                            "Tags can only be placed on a single revision, "
 
3891
                            "not on a range")
 
3892
                    revision_id = revision[0].in_history(branch).rev_id
 
3893
                else:
 
3894
                    revision_id = branch.last_revision()
 
3895
                if (not force) and branch.tags.has_tag(tag_name):
 
3896
                    raise errors.TagAlreadyExists(tag_name)
 
3897
                branch.tags.set_tag(tag_name, revision_id)
 
3898
                self.outf.write('Created tag %s.\n' % tag_name)
 
3899
        finally:
 
3900
            branch.unlock()
 
3901
 
 
3902
 
 
3903
class cmd_tags(Command):
 
3904
    """List tags.
 
3905
 
 
3906
    This tag shows a table of tag names and the revisions they reference.
 
3907
    """
 
3908
 
 
3909
    _see_also = ['tag']
 
3910
    takes_options = [
 
3911
        Option('directory',
 
3912
            help='Branch whose tags should be displayed.',
 
3913
            short_name='d',
 
3914
            type=unicode,
 
3915
            ),
 
3916
    ]
 
3917
 
 
3918
    @display_command
 
3919
    def run(self,
 
3920
            directory='.',
 
3921
            ):
 
3922
        branch, relpath = Branch.open_containing(directory)
 
3923
        for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
 
3924
            self.outf.write('%-20s %s\n' % (tag_name, target))
 
3925
 
 
3926
 
 
3927
def _create_prefix(cur_transport):
 
3928
    needed = [cur_transport]
 
3929
    # Recurse upwards until we can create a directory successfully
 
3930
    while True:
 
3931
        new_transport = cur_transport.clone('..')
 
3932
        if new_transport.base == cur_transport.base:
 
3933
            raise errors.BzrCommandError(
 
3934
                "Failed to create path prefix for %s."
 
3935
                % cur_transport.base)
 
3936
        try:
 
3937
            new_transport.mkdir('.')
 
3938
        except errors.NoSuchFile:
 
3939
            needed.append(new_transport)
 
3940
            cur_transport = new_transport
 
3941
        else:
 
3942
            break
 
3943
    # Now we only need to create child directories
 
3944
    while needed:
 
3945
        cur_transport = needed.pop()
 
3946
        cur_transport.ensure_base()
 
3947
 
 
3948
 
 
3949
def _get_mergeable_helper(location):
 
3950
    """Get a merge directive or bundle if 'location' points to one.
 
3951
 
 
3952
    Try try to identify a bundle and returns its mergeable form. If it's not,
 
3953
    we return the tried transport anyway so that it can reused to access the
 
3954
    branch
 
3955
 
 
3956
    :param location: can point to a bundle or a branch.
 
3957
 
 
3958
    :return: mergeable, transport
 
3959
    """
 
3960
    mergeable = None
 
3961
    url = urlutils.normalize_url(location)
 
3962
    url, filename = urlutils.split(url, exclude_trailing_slash=False)
 
3963
    location_transport = transport.get_transport(url)
 
3964
    if filename:
 
3965
        try:
 
3966
            # There may be redirections but we ignore the intermediate
 
3967
            # and final transports used
 
3968
            read = bundle.read_mergeable_from_transport
 
3969
            mergeable, t = read(location_transport, filename)
 
3970
        except errors.NotABundle:
 
3971
            # Continue on considering this url a Branch but adjust the
 
3972
            # location_transport
 
3973
            location_transport = location_transport.clone(filename)
 
3974
    return mergeable, location_transport
 
3975
 
 
3976
 
 
3977
# these get imported and then picked up by the scan for cmd_*
 
3978
# TODO: Some more consistent way to split command definitions across files;
 
3979
# we do need to load at least some information about them to know of 
 
3980
# aliases.  ideally we would avoid loading the implementation until the
 
3981
# details were needed.
 
3982
from bzrlib.cmd_version_info import cmd_version_info
 
3983
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
3984
from bzrlib.bundle.commands import (
 
3985
    cmd_bundle_info,
 
3986
    )
 
3987
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
3988
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
3989
        cmd_weave_plan_merge, cmd_weave_merge_text