/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

Make list-weave list knits, rename to list-versionedfile

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