/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: Alexander Belchenko
  • Date: 2007-04-25 04:46:07 UTC
  • mto: This revision was merged to the branch mainline in revision 2454.
  • Revision ID: bialix@ukr.net-20070425044607-qbl5oce7jygaxat2
explicitly check for SIGQUIT in 'signal' stdlib module (it's absent on win32)

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