/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2007-06-28 14:14:16 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070628141416-lf6u1noi6gk5lf1g
start work on directive cherry-picking

Show diffs side-by-side

added added

removed removed

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