← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-01 21:56:19 UTC
  • mto: (2255.7.84 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: john@arbash-meinel.com-20070301215619-wpt6kz8yem3ypu1b
Update to dirstate locking.
Move all of WT4.lock_* functions locally, so that they can
properly interact and cleanup around when we lock/unlock the
dirstate file.
Change all Lock objects to be non-blocking. So that if someone
grabs a lock on the DirState we find out immediately, rather
than blocking.
Change WT4.unlock() so that if the dirstate is dirty, it will
save the contents even if it only has a read lock.
It does this by trying to take a write lock, if it fails
we just ignore it. If it succeeds, then we can flush to disk.
This is more important now that DirState tracks file changes.
It allows 'bzr status' to update the cached stat and sha values.

Show diffs side-by-side

added added

removed removed

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