/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2008-05-02 07:31:24 UTC
  • mto: (3408.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3410.
  • Revision ID: mbp@sourcefrog.net-20080502073124-nxmeqrzkji6u2m76
Remove code deprecated prior to 1.1 and its tests

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