/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2007-02-20 07:50:00 UTC
  • mto: This revision was merged to the branch mainline in revision 2309.
  • Revision ID: mbp@sourcefrog.net-20070220075000-2hz26ddu1hm28jrl
Tag methods now available through Branch.tags.add_tag, etc

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 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
 
 
18
from cStringIO import StringIO
 
19
 
 
20
from bzrlib.lazy_import import lazy_import
 
21
lazy_import(globals(), """
 
22
from copy import deepcopy
 
23
from unittest import TestSuite
 
24
from warnings import warn
 
25
 
 
26
import bzrlib
 
27
from bzrlib import (
 
28
        bzrdir,
 
29
        cache_utf8,
 
30
        config as _mod_config,
 
31
        errors,
 
32
        lockdir,
 
33
        lockable_files,
 
34
        osutils,
 
35
        revision as _mod_revision,
 
36
        transport,
 
37
        tree,
 
38
        ui,
 
39
        urlutils,
 
40
        )
 
41
from bzrlib.config import BranchConfig, TreeConfig
 
42
from bzrlib.lockable_files import LockableFiles, TransportLock
 
43
from bzrlib.tag import (
 
44
    BasicTags,
 
45
    DisabledTags,
 
46
    )
 
47
""")
 
48
 
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
 
51
                           HistoryMissing, InvalidRevisionId,
 
52
                           InvalidRevisionNumber, LockError, NoSuchFile,
 
53
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
 
54
                           NotBranchError, UninitializableFormat,
 
55
                           UnlistableStore, UnlistableBranch,
 
56
                           )
 
57
from bzrlib.symbol_versioning import (deprecated_function,
 
58
                                      deprecated_method,
 
59
                                      DEPRECATED_PARAMETER,
 
60
                                      deprecated_passed,
 
61
                                      zero_eight, zero_nine,
 
62
                                      )
 
63
from bzrlib.trace import mutter, note
 
64
 
 
65
 
 
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
68
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
 
69
 
 
70
 
 
71
# TODO: Maybe include checks for common corruption of newlines, etc?
 
72
 
 
73
# TODO: Some operations like log might retrieve the same revisions
 
74
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
75
# cache in memory to make this faster.  In general anything can be
 
76
# cached in memory between lock and unlock operations. .. nb thats
 
77
# what the transaction identity map provides
 
78
 
 
79
 
 
80
######################################################################
 
81
# branch objects
 
82
 
 
83
class Branch(object):
 
84
    """Branch holding a history of revisions.
 
85
 
 
86
    base
 
87
        Base directory/url of the branch.
 
88
 
 
89
    hooks: An instance of BranchHooks.
 
90
    """
 
91
    # this is really an instance variable - FIXME move it there
 
92
    # - RBC 20060112
 
93
    base = None
 
94
 
 
95
    # override this to set the strategy for storing tags
 
96
    def _make_tags(self):
 
97
        return DisabledTags(self)
 
98
 
 
99
    def __init__(self, *ignored, **ignored_too):
 
100
        self.tags = self._make_tags()
 
101
 
 
102
    def break_lock(self):
 
103
        """Break a lock if one is present from another instance.
 
104
 
 
105
        Uses the ui factory to ask for confirmation if the lock may be from
 
106
        an active process.
 
107
 
 
108
        This will probe the repository for its lock as well.
 
109
        """
 
110
        self.control_files.break_lock()
 
111
        self.repository.break_lock()
 
112
        master = self.get_master_branch()
 
113
        if master is not None:
 
114
            master.break_lock()
 
115
 
 
116
    @staticmethod
 
117
    @deprecated_method(zero_eight)
 
118
    def open_downlevel(base):
 
119
        """Open a branch which may be of an old format."""
 
120
        return Branch.open(base, _unsupported=True)
 
121
        
 
122
    @staticmethod
 
123
    def open(base, _unsupported=False):
 
124
        """Open the branch rooted at base.
 
125
 
 
126
        For instance, if the branch is at URL/.bzr/branch,
 
127
        Branch.open(URL) -> a Branch instance.
 
128
        """
 
129
        control = bzrdir.BzrDir.open(base, _unsupported)
 
130
        return control.open_branch(_unsupported)
 
131
 
 
132
    @staticmethod
 
133
    def open_containing(url):
 
134
        """Open an existing branch which contains url.
 
135
        
 
136
        This probes for a branch at url, and searches upwards from there.
 
137
 
 
138
        Basically we keep looking up until we find the control directory or
 
139
        run into the root.  If there isn't one, raises NotBranchError.
 
140
        If there is one and it is either an unrecognised format or an unsupported 
 
141
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
142
        If there is one, it is returned, along with the unused portion of url.
 
143
        """
 
144
        control, relpath = bzrdir.BzrDir.open_containing(url)
 
145
        return control.open_branch(), relpath
 
146
 
 
147
    @staticmethod
 
148
    @deprecated_function(zero_eight)
 
149
    def initialize(base):
 
150
        """Create a new working tree and branch, rooted at 'base' (url)
 
151
 
 
152
        NOTE: This will soon be deprecated in favour of creation
 
153
        through a BzrDir.
 
154
        """
 
155
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
 
156
 
 
157
    @deprecated_function(zero_eight)
 
158
    def setup_caching(self, cache_root):
 
159
        """Subclasses that care about caching should override this, and set
 
160
        up cached stores located under cache_root.
 
161
        
 
162
        NOTE: This is unused.
 
163
        """
 
164
        pass
 
165
 
 
166
    def get_config(self):
 
167
        return BranchConfig(self)
 
168
 
 
169
    def _get_nick(self):
 
170
        return self.get_config().get_nickname()
 
171
 
 
172
    def _set_nick(self, nick):
 
173
        self.get_config().set_user_option('nickname', nick)
 
174
 
 
175
    nick = property(_get_nick, _set_nick)
 
176
 
 
177
    def is_locked(self):
 
178
        raise NotImplementedError(self.is_locked)
 
179
 
 
180
    def lock_write(self):
 
181
        raise NotImplementedError(self.lock_write)
 
182
 
 
183
    def lock_read(self):
 
184
        raise NotImplementedError(self.lock_read)
 
185
 
 
186
    def unlock(self):
 
187
        raise NotImplementedError(self.unlock)
 
188
 
 
189
    def peek_lock_mode(self):
 
190
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
191
        raise NotImplementedError(self.peek_lock_mode)
 
192
 
 
193
    def get_physical_lock_status(self):
 
194
        raise NotImplementedError(self.get_physical_lock_status)
 
195
 
 
196
    def abspath(self, name):
 
197
        """Return absolute filename for something in the branch
 
198
        
 
199
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
200
        method and not a tree method.
 
201
        """
 
202
        raise NotImplementedError(self.abspath)
 
203
 
 
204
    def bind(self, other):
 
205
        """Bind the local branch the other branch.
 
206
 
 
207
        :param other: The branch to bind to
 
208
        :type other: Branch
 
209
        """
 
210
        raise errors.UpgradeRequired(self.base)
 
211
 
 
212
    @needs_write_lock
 
213
    def fetch(self, from_branch, last_revision=None, pb=None):
 
214
        """Copy revisions from from_branch into this branch.
 
215
 
 
216
        :param from_branch: Where to copy from.
 
217
        :param last_revision: What revision to stop at (None for at the end
 
218
                              of the branch.
 
219
        :param pb: An optional progress bar to use.
 
220
 
 
221
        Returns the copied revision count and the failed revisions in a tuple:
 
222
        (copied, failures).
 
223
        """
 
224
        if self.base == from_branch.base:
 
225
            return (0, [])
 
226
        if pb is None:
 
227
            nested_pb = ui.ui_factory.nested_progress_bar()
 
228
            pb = nested_pb
 
229
        else:
 
230
            nested_pb = None
 
231
 
 
232
        from_branch.lock_read()
 
233
        try:
 
234
            if last_revision is None:
 
235
                pb.update('get source history')
 
236
                last_revision = from_branch.last_revision_info()[1]
 
237
            return self.repository.fetch(from_branch.repository,
 
238
                                         revision_id=last_revision,
 
239
                                         pb=nested_pb)
 
240
        finally:
 
241
            if nested_pb is not None:
 
242
                nested_pb.finished()
 
243
            from_branch.unlock()
 
244
 
 
245
    def get_bound_location(self):
 
246
        """Return the URL of the branch we are bound to.
 
247
 
 
248
        Older format branches cannot bind, please be sure to use a metadir
 
249
        branch.
 
250
        """
 
251
        return None
 
252
    
 
253
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
254
                           timezone=None, committer=None, revprops=None, 
 
255
                           revision_id=None):
 
256
        """Obtain a CommitBuilder for this branch.
 
257
        
 
258
        :param parents: Revision ids of the parents of the new revision.
 
259
        :param config: Optional configuration to use.
 
260
        :param timestamp: Optional timestamp recorded for commit.
 
261
        :param timezone: Optional timezone for timestamp.
 
262
        :param committer: Optional committer to set for commit.
 
263
        :param revprops: Optional dictionary of revision properties.
 
264
        :param revision_id: Optional revision id.
 
265
        """
 
266
 
 
267
        if config is None:
 
268
            config = self.get_config()
 
269
        
 
270
        return self.repository.get_commit_builder(self, parents, config,
 
271
            timestamp, timezone, committer, revprops, revision_id)
 
272
 
 
273
    def get_master_branch(self):
 
274
        """Return the branch we are bound to.
 
275
        
 
276
        :return: Either a Branch, or None
 
277
        """
 
278
        return None
 
279
 
 
280
    def get_revision_delta(self, revno):
 
281
        """Return the delta for one revision.
 
282
 
 
283
        The delta is relative to its mainline predecessor, or the
 
284
        empty tree for revision 1.
 
285
        """
 
286
        assert isinstance(revno, int)
 
287
        rh = self.revision_history()
 
288
        if not (1 <= revno <= len(rh)):
 
289
            raise InvalidRevisionNumber(revno)
 
290
        return self.repository.get_revision_delta(rh[revno-1])
 
291
 
 
292
    def get_root_id(self):
 
293
        """Return the id of this branches root"""
 
294
        raise NotImplementedError(self.get_root_id)
 
295
 
 
296
    def print_file(self, file, revision_id):
 
297
        """Print `file` to stdout."""
 
298
        raise NotImplementedError(self.print_file)
 
299
 
 
300
    def append_revision(self, *revision_ids):
 
301
        raise NotImplementedError(self.append_revision)
 
302
 
 
303
    def set_revision_history(self, rev_history):
 
304
        raise NotImplementedError(self.set_revision_history)
 
305
 
 
306
    def revision_history(self):
 
307
        """Return sequence of revision hashes on to this branch."""
 
308
        raise NotImplementedError(self.revision_history)
 
309
 
 
310
    def revno(self):
 
311
        """Return current revision number for this branch.
 
312
 
 
313
        That is equivalent to the number of revisions committed to
 
314
        this branch.
 
315
        """
 
316
        return len(self.revision_history())
 
317
 
 
318
    def unbind(self):
 
319
        """Older format branches cannot bind or unbind."""
 
320
        raise errors.UpgradeRequired(self.base)
 
321
 
 
322
    def last_revision(self):
 
323
        """Return last revision id, or None"""
 
324
        ph = self.revision_history()
 
325
        if ph:
 
326
            return ph[-1]
 
327
        else:
 
328
            return None
 
329
 
 
330
    def last_revision_info(self):
 
331
        """Return information about the last revision.
 
332
 
 
333
        :return: A tuple (revno, last_revision_id).
 
334
        """
 
335
        rh = self.revision_history()
 
336
        revno = len(rh)
 
337
        if revno:
 
338
            return (revno, rh[-1])
 
339
        else:
 
340
            return (0, _mod_revision.NULL_REVISION)
 
341
 
 
342
    def missing_revisions(self, other, stop_revision=None):
 
343
        """Return a list of new revisions that would perfectly fit.
 
344
        
 
345
        If self and other have not diverged, return a list of the revisions
 
346
        present in other, but missing from self.
 
347
        """
 
348
        self_history = self.revision_history()
 
349
        self_len = len(self_history)
 
350
        other_history = other.revision_history()
 
351
        other_len = len(other_history)
 
352
        common_index = min(self_len, other_len) -1
 
353
        if common_index >= 0 and \
 
354
            self_history[common_index] != other_history[common_index]:
 
355
            raise DivergedBranches(self, other)
 
356
 
 
357
        if stop_revision is None:
 
358
            stop_revision = other_len
 
359
        else:
 
360
            assert isinstance(stop_revision, int)
 
361
            if stop_revision > other_len:
 
362
                raise errors.NoSuchRevision(self, stop_revision)
 
363
        return other_history[self_len:stop_revision]
 
364
 
 
365
    def update_revisions(self, other, stop_revision=None):
 
366
        """Pull in new perfect-fit revisions.
 
367
 
 
368
        :param other: Another Branch to pull from
 
369
        :param stop_revision: Updated until the given revision
 
370
        :return: None
 
371
        """
 
372
        raise NotImplementedError(self.update_revisions)
 
373
 
 
374
    def revision_id_to_revno(self, revision_id):
 
375
        """Given a revision id, return its revno"""
 
376
        if revision_id is None:
 
377
            return 0
 
378
        history = self.revision_history()
 
379
        try:
 
380
            return history.index(revision_id) + 1
 
381
        except ValueError:
 
382
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
383
 
 
384
    def get_rev_id(self, revno, history=None):
 
385
        """Find the revision id of the specified revno."""
 
386
        if revno == 0:
 
387
            return None
 
388
        if history is None:
 
389
            history = self.revision_history()
 
390
        if revno <= 0 or revno > len(history):
 
391
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
392
        return history[revno - 1]
 
393
 
 
394
    def pull(self, source, overwrite=False, stop_revision=None):
 
395
        """Mirror source into this branch.
 
396
 
 
397
        This branch is considered to be 'local', having low latency.
 
398
        """
 
399
        raise NotImplementedError(self.pull)
 
400
 
 
401
    def push(self, target, overwrite=False, stop_revision=None):
 
402
        """Mirror this branch into target.
 
403
 
 
404
        This branch is considered to be 'local', having low latency.
 
405
        """
 
406
        raise NotImplementedError(self.push)
 
407
 
 
408
    def basis_tree(self):
 
409
        """Return `Tree` object for last revision."""
 
410
        return self.repository.revision_tree(self.last_revision())
 
411
 
 
412
    def rename_one(self, from_rel, to_rel):
 
413
        """Rename one file.
 
414
 
 
415
        This can change the directory or the filename or both.
 
416
        """
 
417
        raise NotImplementedError(self.rename_one)
 
418
 
 
419
    def move(self, from_paths, to_name):
 
420
        """Rename files.
 
421
 
 
422
        to_name must exist as a versioned directory.
 
423
 
 
424
        If to_name exists and is a directory, the files are moved into
 
425
        it, keeping their old names.  If it is a directory, 
 
426
 
 
427
        Note that to_name is only the last component of the new name;
 
428
        this doesn't change the directory.
 
429
 
 
430
        This returns a list of (from_path, to_path) pairs for each
 
431
        entry that is moved.
 
432
        """
 
433
        raise NotImplementedError(self.move)
 
434
 
 
435
    def get_parent(self):
 
436
        """Return the parent location of the branch.
 
437
 
 
438
        This is the default location for push/pull/missing.  The usual
 
439
        pattern is that the user can override it by specifying a
 
440
        location.
 
441
        """
 
442
        raise NotImplementedError(self.get_parent)
 
443
 
 
444
    def get_submit_branch(self):
 
445
        """Return the submit location of the branch.
 
446
 
 
447
        This is the default location for bundle.  The usual
 
448
        pattern is that the user can override it by specifying a
 
449
        location.
 
450
        """
 
451
        return self.get_config().get_user_option('submit_branch')
 
452
 
 
453
    def set_submit_branch(self, location):
 
454
        """Return the submit location of the branch.
 
455
 
 
456
        This is the default location for bundle.  The usual
 
457
        pattern is that the user can override it by specifying a
 
458
        location.
 
459
        """
 
460
        self.get_config().set_user_option('submit_branch', location)
 
461
 
 
462
    def get_push_location(self):
 
463
        """Return the None or the location to push this branch to."""
 
464
        raise NotImplementedError(self.get_push_location)
 
465
 
 
466
    def set_push_location(self, location):
 
467
        """Set a new push location for this branch."""
 
468
        raise NotImplementedError(self.set_push_location)
 
469
 
 
470
    def set_parent(self, url):
 
471
        raise NotImplementedError(self.set_parent)
 
472
 
 
473
    @needs_write_lock
 
474
    def update(self):
 
475
        """Synchronise this branch with the master branch if any. 
 
476
 
 
477
        :return: None or the last_revision pivoted out during the update.
 
478
        """
 
479
        return None
 
480
 
 
481
    def check_revno(self, revno):
 
482
        """\
 
483
        Check whether a revno corresponds to any revision.
 
484
        Zero (the NULL revision) is considered valid.
 
485
        """
 
486
        if revno != 0:
 
487
            self.check_real_revno(revno)
 
488
            
 
489
    def check_real_revno(self, revno):
 
490
        """\
 
491
        Check whether a revno corresponds to a real revision.
 
492
        Zero (the NULL revision) is considered invalid
 
493
        """
 
494
        if revno < 1 or revno > self.revno():
 
495
            raise InvalidRevisionNumber(revno)
 
496
 
 
497
    @needs_read_lock
 
498
    def clone(self, *args, **kwargs):
 
499
        """Clone this branch into to_bzrdir preserving all semantic values.
 
500
        
 
501
        revision_id: if not None, the revision history in the new branch will
 
502
                     be truncated to end with revision_id.
 
503
        """
 
504
        # for API compatibility, until 0.8 releases we provide the old api:
 
505
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
 
506
        # after 0.8 releases, the *args and **kwargs should be changed:
 
507
        # def clone(self, to_bzrdir, revision_id=None):
 
508
        if (kwargs.get('to_location', None) or
 
509
            kwargs.get('revision', None) or
 
510
            kwargs.get('basis_branch', None) or
 
511
            (len(args) and isinstance(args[0], basestring))):
 
512
            # backwards compatibility api:
 
513
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
 
514
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
 
515
            # get basis_branch
 
516
            if len(args) > 2:
 
517
                basis_branch = args[2]
 
518
            else:
 
519
                basis_branch = kwargs.get('basis_branch', None)
 
520
            if basis_branch:
 
521
                basis = basis_branch.bzrdir
 
522
            else:
 
523
                basis = None
 
524
            # get revision
 
525
            if len(args) > 1:
 
526
                revision_id = args[1]
 
527
            else:
 
528
                revision_id = kwargs.get('revision', None)
 
529
            # get location
 
530
            if len(args):
 
531
                url = args[0]
 
532
            else:
 
533
                # no default to raise if not provided.
 
534
                url = kwargs.get('to_location')
 
535
            return self.bzrdir.clone(url,
 
536
                                     revision_id=revision_id,
 
537
                                     basis=basis).open_branch()
 
538
        # new cleaner api.
 
539
        # generate args by hand 
 
540
        if len(args) > 1:
 
541
            revision_id = args[1]
 
542
        else:
 
543
            revision_id = kwargs.get('revision_id', None)
 
544
        if len(args):
 
545
            to_bzrdir = args[0]
 
546
        else:
 
547
            # no default to raise if not provided.
 
548
            to_bzrdir = kwargs.get('to_bzrdir')
 
549
        result = self._format.initialize(to_bzrdir)
 
550
        self.copy_content_into(result, revision_id=revision_id)
 
551
        return  result
 
552
 
 
553
    @needs_read_lock
 
554
    def sprout(self, to_bzrdir, revision_id=None):
 
555
        """Create a new line of development from the branch, into to_bzrdir.
 
556
        
 
557
        revision_id: if not None, the revision history in the new branch will
 
558
                     be truncated to end with revision_id.
 
559
        """
 
560
        result = self._format.initialize(to_bzrdir)
 
561
        self.copy_content_into(result, revision_id=revision_id)
 
562
        result.set_parent(self.bzrdir.root_transport.base)
 
563
        return result
 
564
 
 
565
    @needs_read_lock
 
566
    def copy_content_into(self, destination, revision_id=None):
 
567
        """Copy the content of self into destination.
 
568
 
 
569
        revision_id: if not None, the revision history in the new branch will
 
570
                     be truncated to end with revision_id.
 
571
        """
 
572
        new_history = self.revision_history()
 
573
        if revision_id is not None:
 
574
            try:
 
575
                new_history = new_history[:new_history.index(revision_id) + 1]
 
576
            except ValueError:
 
577
                rev = self.repository.get_revision(revision_id)
 
578
                new_history = rev.get_history(self.repository)[1:]
 
579
        destination.set_revision_history(new_history)
 
580
        try:
 
581
            parent = self.get_parent()
 
582
        except errors.InaccessibleParent, e:
 
583
            mutter('parent was not accessible to copy: %s', e)
 
584
        else:
 
585
            if parent:
 
586
                destination.set_parent(parent)
 
587
 
 
588
    @needs_read_lock
 
589
    def check(self):
 
590
        """Check consistency of the branch.
 
591
 
 
592
        In particular this checks that revisions given in the revision-history
 
593
        do actually match up in the revision graph, and that they're all 
 
594
        present in the repository.
 
595
        
 
596
        Callers will typically also want to check the repository.
 
597
 
 
598
        :return: A BranchCheckResult.
 
599
        """
 
600
        mainline_parent_id = None
 
601
        for revision_id in self.revision_history():
 
602
            try:
 
603
                revision = self.repository.get_revision(revision_id)
 
604
            except errors.NoSuchRevision, e:
 
605
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
606
                            % revision_id)
 
607
            # In general the first entry on the revision history has no parents.
 
608
            # But it's not illegal for it to have parents listed; this can happen
 
609
            # in imports from Arch when the parents weren't reachable.
 
610
            if mainline_parent_id is not None:
 
611
                if mainline_parent_id not in revision.parent_ids:
 
612
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
613
                                        "parents of {%s}"
 
614
                                        % (mainline_parent_id, revision_id))
 
615
            mainline_parent_id = revision_id
 
616
        return BranchCheckResult(self)
 
617
 
 
618
    def _get_checkout_format(self):
 
619
        """Return the most suitable metadir for a checkout of this branch.
 
620
        Weaves are used if this branch's repostory uses weaves.
 
621
        """
 
622
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
623
            from bzrlib.repofmt import weaverepo
 
624
            format = bzrdir.BzrDirMetaFormat1()
 
625
            format.repository_format = weaverepo.RepositoryFormat7()
 
626
        else:
 
627
            format = self.repository.bzrdir.cloning_metadir()
 
628
        return format
 
629
 
 
630
    def create_checkout(self, to_location, revision_id=None,
 
631
                        lightweight=False):
 
632
        """Create a checkout of a branch.
 
633
        
 
634
        :param to_location: The url to produce the checkout at
 
635
        :param revision_id: The revision to check out
 
636
        :param lightweight: If True, produce a lightweight checkout, otherwise,
 
637
        produce a bound branch (heavyweight checkout)
 
638
        :return: The tree of the created checkout
 
639
        """
 
640
        t = transport.get_transport(to_location)
 
641
        try:
 
642
            t.mkdir('.')
 
643
        except errors.FileExists:
 
644
            pass
 
645
        if lightweight:
 
646
            checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
 
647
            BranchReferenceFormat().initialize(checkout, self)
 
648
        else:
 
649
            format = self._get_checkout_format()
 
650
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
651
                to_location, force_new_tree=False, format=format)
 
652
            checkout = checkout_branch.bzrdir
 
653
            checkout_branch.bind(self)
 
654
            # pull up to the specified revision_id to set the initial 
 
655
            # branch tip correctly, and seed it with history.
 
656
            checkout_branch.pull(self, stop_revision=revision_id)
 
657
        return checkout.create_workingtree(revision_id)
 
658
 
 
659
    def copy_tags_to(self, to_branch):
 
660
        """Copy tags to another branch.
 
661
        """
 
662
        # TODO: Allow for doing a smarter merge, etc
 
663
        if self == to_branch:
 
664
            return
 
665
        to_branch.lock_write()
 
666
        try:
 
667
            to_branch.tags._set_tag_dict(self.tags.get_tag_dict())
 
668
        finally:
 
669
            to_branch.unlock()
 
670
 
 
671
class BranchFormat(object):
 
672
    """An encapsulation of the initialization and open routines for a format.
 
673
 
 
674
    Formats provide three things:
 
675
     * An initialization routine,
 
676
     * a format string,
 
677
     * an open routine.
 
678
 
 
679
    Formats are placed in an dict by their format string for reference 
 
680
    during branch opening. Its not required that these be instances, they
 
681
    can be classes themselves with class methods - it simply depends on 
 
682
    whether state is needed for a given format or not.
 
683
 
 
684
    Once a format is deprecated, just deprecate the initialize and open
 
685
    methods on the format class. Do not deprecate the object, as the 
 
686
    object will be created every time regardless.
 
687
    """
 
688
 
 
689
    _default_format = None
 
690
    """The default format used for new branches."""
 
691
 
 
692
    _formats = {}
 
693
    """The known formats."""
 
694
 
 
695
    @classmethod
 
696
    def find_format(klass, a_bzrdir):
 
697
        """Return the format for the branch object in a_bzrdir."""
 
698
        try:
 
699
            transport = a_bzrdir.get_branch_transport(None)
 
700
            format_string = transport.get("format").read()
 
701
            return klass._formats[format_string]
 
702
        except NoSuchFile:
 
703
            raise NotBranchError(path=transport.base)
 
704
        except KeyError:
 
705
            raise errors.UnknownFormatError(format=format_string)
 
706
 
 
707
    @classmethod
 
708
    def get_default_format(klass):
 
709
        """Return the current default format."""
 
710
        return klass._default_format
 
711
 
 
712
    def get_format_string(self):
 
713
        """Return the ASCII format string that identifies this format."""
 
714
        raise NotImplementedError(self.get_format_string)
 
715
 
 
716
    def get_format_description(self):
 
717
        """Return the short format description for this format."""
 
718
        raise NotImplementedError(self.get_format_description)
 
719
 
 
720
    def initialize(self, a_bzrdir):
 
721
        """Create a branch of this format in a_bzrdir."""
 
722
        raise NotImplementedError(self.initialize)
 
723
 
 
724
    def is_supported(self):
 
725
        """Is this format supported?
 
726
 
 
727
        Supported formats can be initialized and opened.
 
728
        Unsupported formats may not support initialization or committing or 
 
729
        some other features depending on the reason for not being supported.
 
730
        """
 
731
        return True
 
732
 
 
733
    def open(self, a_bzrdir, _found=False):
 
734
        """Return the branch object for a_bzrdir
 
735
 
 
736
        _found is a private parameter, do not use it. It is used to indicate
 
737
               if format probing has already be done.
 
738
        """
 
739
        raise NotImplementedError(self.open)
 
740
 
 
741
    @classmethod
 
742
    def register_format(klass, format):
 
743
        klass._formats[format.get_format_string()] = format
 
744
 
 
745
    @classmethod
 
746
    def set_default_format(klass, format):
 
747
        klass._default_format = format
 
748
 
 
749
    @classmethod
 
750
    def unregister_format(klass, format):
 
751
        assert klass._formats[format.get_format_string()] is format
 
752
        del klass._formats[format.get_format_string()]
 
753
 
 
754
    def __str__(self):
 
755
        return self.get_format_string().rstrip()
 
756
 
 
757
    def supports_tags(self):
 
758
        """True if this format supports tags stored in the branch"""
 
759
        return False  # by default
 
760
 
 
761
    # XXX: Probably doesn't really belong here -- mbp 20070212
 
762
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
 
763
            lock_class):
 
764
        branch_transport = a_bzrdir.get_branch_transport(self)
 
765
        control_files = lockable_files.LockableFiles(branch_transport,
 
766
            lock_filename, lock_class)
 
767
        control_files.create_lock()
 
768
        control_files.lock_write()
 
769
        try:
 
770
            for filename, content in utf8_files:
 
771
                control_files.put_utf8(filename, content)
 
772
        finally:
 
773
            control_files.unlock()
 
774
 
 
775
 
 
776
class BranchHooks(dict):
 
777
    """A dictionary mapping hook name to a list of callables for branch hooks.
 
778
    
 
779
    e.g. ['set_rh'] Is the list of items to be called when the
 
780
    set_revision_history function is invoked.
 
781
    """
 
782
 
 
783
    def __init__(self):
 
784
        """Create the default hooks.
 
785
 
 
786
        These are all empty initially, because by default nothing should get
 
787
        notified.
 
788
        """
 
789
        dict.__init__(self)
 
790
        # Introduced in 0.15:
 
791
        # invoked whenever the revision history has been set
 
792
        # with set_revision_history. The api signature is
 
793
        # (branch, revision_history), and the branch will
 
794
        # be write-locked.
 
795
        self['set_rh'] = []
 
796
        # invoked after a push operation completes.
 
797
        # the api signature is
 
798
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
799
        # where local is the local branch or None, master is the target 
 
800
        # master branch, and the rest should be self explanatory. The source
 
801
        # is read locked and the target branches write locked. Source will
 
802
        # be the local low-latency branch.
 
803
        self['post_push'] = []
 
804
        # invoked after a pull operation completes.
 
805
        # the api signature is
 
806
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
807
        # where local is the local branch or None, master is the target 
 
808
        # master branch, and the rest should be self explanatory. The source
 
809
        # is read locked and the target branches write locked. The local
 
810
        # branch is the low-latency branch.
 
811
        self['post_pull'] = []
 
812
        # invoked after a commit operation completes.
 
813
        # the api signature is 
 
814
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
815
        # old_revid is NULL_REVISION for the first commit to a branch.
 
816
        self['post_commit'] = []
 
817
        # invoked after a uncommit operation completes.
 
818
        # the api signature is
 
819
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
820
        # local is the local branch or None, master is the target branch,
 
821
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
822
        self['post_uncommit'] = []
 
823
 
 
824
    def install_hook(self, hook_name, a_callable):
 
825
        """Install a_callable in to the hook hook_name.
 
826
 
 
827
        :param hook_name: A hook name. See the __init__ method of BranchHooks
 
828
            for the complete list of hooks.
 
829
        :param a_callable: The callable to be invoked when the hook triggers.
 
830
            The exact signature will depend on the hook - see the __init__ 
 
831
            method of BranchHooks for details on each hook.
 
832
        """
 
833
        try:
 
834
            self[hook_name].append(a_callable)
 
835
        except KeyError:
 
836
            raise errors.UnknownHook('branch', hook_name)
 
837
 
 
838
 
 
839
# install the default hooks into the Branch class.
 
840
Branch.hooks = BranchHooks()
 
841
 
 
842
 
 
843
class BzrBranchFormat4(BranchFormat):
 
844
    """Bzr branch format 4.
 
845
 
 
846
    This format has:
 
847
     - a revision-history file.
 
848
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
849
    """
 
850
 
 
851
    def get_format_description(self):
 
852
        """See BranchFormat.get_format_description()."""
 
853
        return "Branch format 4"
 
854
 
 
855
    def initialize(self, a_bzrdir):
 
856
        """Create a branch of this format in a_bzrdir."""
 
857
        utf8_files = [('revision-history', ''),
 
858
                      ('branch-name', ''),
 
859
                      ]
 
860
        self._initialize_control_files(a_bzrdir, utf8_files,
 
861
             'branch-lock', lockable_files.TransportLock)
 
862
        return self.open(a_bzrdir, _found=True)
 
863
 
 
864
    def __init__(self):
 
865
        super(BzrBranchFormat4, self).__init__()
 
866
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
867
 
 
868
    def open(self, a_bzrdir, _found=False):
 
869
        """Return the branch object for a_bzrdir
 
870
 
 
871
        _found is a private parameter, do not use it. It is used to indicate
 
872
               if format probing has already be done.
 
873
        """
 
874
        if not _found:
 
875
            # we are being called directly and must probe.
 
876
            raise NotImplementedError
 
877
        return BzrBranch(_format=self,
 
878
                         _control_files=a_bzrdir._control_files,
 
879
                         a_bzrdir=a_bzrdir,
 
880
                         _repository=a_bzrdir.open_repository())
 
881
 
 
882
    def __str__(self):
 
883
        return "Bazaar-NG branch format 4"
 
884
 
 
885
 
 
886
class BzrBranchFormat5(BranchFormat):
 
887
    """Bzr branch format 5.
 
888
 
 
889
    This format has:
 
890
     - a revision-history file.
 
891
     - a format string
 
892
     - a lock dir guarding the branch itself
 
893
     - all of this stored in a branch/ subdirectory
 
894
     - works with shared repositories.
 
895
 
 
896
    This format is new in bzr 0.8.
 
897
    """
 
898
 
 
899
    def get_format_string(self):
 
900
        """See BranchFormat.get_format_string()."""
 
901
        return "Bazaar-NG branch format 5\n"
 
902
 
 
903
    def get_format_description(self):
 
904
        """See BranchFormat.get_format_description()."""
 
905
        return "Branch format 5"
 
906
        
 
907
    def initialize(self, a_bzrdir):
 
908
        """Create a branch of this format in a_bzrdir."""
 
909
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
910
        branch_transport = a_bzrdir.get_branch_transport(self)
 
911
        utf8_files = [('revision-history', ''),
 
912
                      ('branch-name', ''),
 
913
                      ]
 
914
        control_files = lockable_files.LockableFiles(branch_transport, 'lock',
 
915
                                                     lockdir.LockDir)
 
916
        control_files.create_lock()
 
917
        control_files.lock_write()
 
918
        control_files.put_utf8('format', self.get_format_string())
 
919
        try:
 
920
            for file, content in utf8_files:
 
921
                control_files.put_utf8(file, content)
 
922
        finally:
 
923
            control_files.unlock()
 
924
        return self.open(a_bzrdir, _found=True, )
 
925
 
 
926
    def __init__(self):
 
927
        super(BzrBranchFormat5, self).__init__()
 
928
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
929
 
 
930
    def open(self, a_bzrdir, _found=False):
 
931
        """Return the branch object for a_bzrdir
 
932
 
 
933
        _found is a private parameter, do not use it. It is used to indicate
 
934
               if format probing has already be done.
 
935
        """
 
936
        if not _found:
 
937
            format = BranchFormat.find_format(a_bzrdir)
 
938
            assert format.__class__ == self.__class__
 
939
        transport = a_bzrdir.get_branch_transport(None)
 
940
        control_files = lockable_files.LockableFiles(transport, 'lock',
 
941
                                                     lockdir.LockDir)
 
942
        return BzrBranch5(_format=self,
 
943
                          _control_files=control_files,
 
944
                          a_bzrdir=a_bzrdir,
 
945
                          _repository=a_bzrdir.find_repository())
 
946
 
 
947
 
 
948
class BranchReferenceFormat(BranchFormat):
 
949
    """Bzr branch reference format.
 
950
 
 
951
    Branch references are used in implementing checkouts, they
 
952
    act as an alias to the real branch which is at some other url.
 
953
 
 
954
    This format has:
 
955
     - A location file
 
956
     - a format string
 
957
    """
 
958
 
 
959
    def get_format_string(self):
 
960
        """See BranchFormat.get_format_string()."""
 
961
        return "Bazaar-NG Branch Reference Format 1\n"
 
962
 
 
963
    def get_format_description(self):
 
964
        """See BranchFormat.get_format_description()."""
 
965
        return "Checkout reference format 1"
 
966
        
 
967
    def initialize(self, a_bzrdir, target_branch=None):
 
968
        """Create a branch of this format in a_bzrdir."""
 
969
        if target_branch is None:
 
970
            # this format does not implement branch itself, thus the implicit
 
971
            # creation contract must see it as uninitializable
 
972
            raise errors.UninitializableFormat(self)
 
973
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
974
        branch_transport = a_bzrdir.get_branch_transport(self)
 
975
        branch_transport.put_bytes('location',
 
976
            target_branch.bzrdir.root_transport.base)
 
977
        branch_transport.put_bytes('format', self.get_format_string())
 
978
        return self.open(a_bzrdir, _found=True)
 
979
 
 
980
    def __init__(self):
 
981
        super(BranchReferenceFormat, self).__init__()
 
982
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
983
 
 
984
    def _make_reference_clone_function(format, a_branch):
 
985
        """Create a clone() routine for a branch dynamically."""
 
986
        def clone(to_bzrdir, revision_id=None):
 
987
            """See Branch.clone()."""
 
988
            return format.initialize(to_bzrdir, a_branch)
 
989
            # cannot obey revision_id limits when cloning a reference ...
 
990
            # FIXME RBC 20060210 either nuke revision_id for clone, or
 
991
            # emit some sort of warning/error to the caller ?!
 
992
        return clone
 
993
 
 
994
    def open(self, a_bzrdir, _found=False):
 
995
        """Return the branch that the branch reference in a_bzrdir points at.
 
996
 
 
997
        _found is a private parameter, do not use it. It is used to indicate
 
998
               if format probing has already be done.
 
999
        """
 
1000
        if not _found:
 
1001
            format = BranchFormat.find_format(a_bzrdir)
 
1002
            assert format.__class__ == self.__class__
 
1003
        transport = a_bzrdir.get_branch_transport(None)
 
1004
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
 
1005
        result = real_bzrdir.open_branch()
 
1006
        # this changes the behaviour of result.clone to create a new reference
 
1007
        # rather than a copy of the content of the branch.
 
1008
        # I did not use a proxy object because that needs much more extensive
 
1009
        # testing, and we are only changing one behaviour at the moment.
 
1010
        # If we decide to alter more behaviours - i.e. the implicit nickname
 
1011
        # then this should be refactored to introduce a tested proxy branch
 
1012
        # and a subclass of that for use in overriding clone() and ....
 
1013
        # - RBC 20060210
 
1014
        result.clone = self._make_reference_clone_function(result)
 
1015
        return result
 
1016
 
 
1017
 
 
1018
# formats which have no format string are not discoverable
 
1019
# and not independently creatable, so are not registered.
 
1020
__default_format = BzrBranchFormat5()
 
1021
BranchFormat.register_format(__default_format)
 
1022
BranchFormat.register_format(BranchReferenceFormat())
 
1023
BranchFormat.set_default_format(__default_format)
 
1024
_legacy_formats = [BzrBranchFormat4(),
 
1025
                   ]
 
1026
 
 
1027
class BzrBranch(Branch):
 
1028
    """A branch stored in the actual filesystem.
 
1029
 
 
1030
    Note that it's "local" in the context of the filesystem; it doesn't
 
1031
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
1032
    it's writable, and can be accessed via the normal filesystem API.
 
1033
    """
 
1034
    
 
1035
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
 
1036
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
 
1037
                 _control_files=None, a_bzrdir=None, _repository=None):
 
1038
        """Create new branch object at a particular location.
 
1039
 
 
1040
        transport -- A Transport object, defining how to access files.
 
1041
        
 
1042
        init -- If True, create new control files in a previously
 
1043
             unversioned directory.  If False, the branch must already
 
1044
             be versioned.
 
1045
 
 
1046
        relax_version_check -- If true, the usual check for the branch
 
1047
            version is not applied.  This is intended only for
 
1048
            upgrade/recovery type use; it's not guaranteed that
 
1049
            all operations will work on old format branches.
 
1050
        """
 
1051
        Branch.__init__(self)
 
1052
        if a_bzrdir is None:
 
1053
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
 
1054
        else:
 
1055
            self.bzrdir = a_bzrdir
 
1056
        # self._transport used to point to the directory containing the
 
1057
        # control directory, but was not used - now it's just the transport
 
1058
        # for the branch control files.  mbp 20070212
 
1059
        self._base = self.bzrdir.transport.clone('..').base
 
1060
        self._format = _format
 
1061
        if _control_files is None:
 
1062
            raise ValueError('BzrBranch _control_files is None')
 
1063
        self.control_files = _control_files
 
1064
        self._transport = _control_files._transport
 
1065
        if deprecated_passed(init):
 
1066
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
 
1067
                 "deprecated as of bzr 0.8. Please use Branch.create().",
 
1068
                 DeprecationWarning,
 
1069
                 stacklevel=2)
 
1070
            if init:
 
1071
                # this is slower than before deprecation, oh well never mind.
 
1072
                # -> its deprecated.
 
1073
                self._initialize(transport.base)
 
1074
        self._check_format(_format)
 
1075
        if deprecated_passed(relax_version_check):
 
1076
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
 
1077
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
 
1078
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
 
1079
                 "open() method.",
 
1080
                 DeprecationWarning,
 
1081
                 stacklevel=2)
 
1082
            if (not relax_version_check
 
1083
                and not self._format.is_supported()):
 
1084
                raise errors.UnsupportedFormatError(format=fmt)
 
1085
        if deprecated_passed(transport):
 
1086
            warn("BzrBranch.__init__(transport=XXX...): The transport "
 
1087
                 "parameter is deprecated as of bzr 0.8. "
 
1088
                 "Please use Branch.open, or bzrdir.open_branch().",
 
1089
                 DeprecationWarning,
 
1090
                 stacklevel=2)
 
1091
        self.repository = _repository
 
1092
 
 
1093
    def __str__(self):
 
1094
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
1095
 
 
1096
    __repr__ = __str__
 
1097
 
 
1098
    def _get_base(self):
 
1099
        """Returns the directory containing the control directory."""
 
1100
        return self._base
 
1101
 
 
1102
    base = property(_get_base, doc="The URL for the root of this branch.")
 
1103
 
 
1104
    def _finish_transaction(self):
 
1105
        """Exit the current transaction."""
 
1106
        return self.control_files._finish_transaction()
 
1107
 
 
1108
    def get_transaction(self):
 
1109
        """Return the current active transaction.
 
1110
 
 
1111
        If no transaction is active, this returns a passthrough object
 
1112
        for which all data is immediately flushed and no caching happens.
 
1113
        """
 
1114
        # this is an explicit function so that we can do tricky stuff
 
1115
        # when the storage in rev_storage is elsewhere.
 
1116
        # we probably need to hook the two 'lock a location' and 
 
1117
        # 'have a transaction' together more delicately, so that
 
1118
        # we can have two locks (branch and storage) and one transaction
 
1119
        # ... and finishing the transaction unlocks both, but unlocking
 
1120
        # does not. - RBC 20051121
 
1121
        return self.control_files.get_transaction()
 
1122
 
 
1123
    def _set_transaction(self, transaction):
 
1124
        """Set a new active transaction."""
 
1125
        return self.control_files._set_transaction(transaction)
 
1126
 
 
1127
    def abspath(self, name):
 
1128
        """See Branch.abspath."""
 
1129
        return self.control_files._transport.abspath(name)
 
1130
 
 
1131
    def _check_format(self, format):
 
1132
        """Identify the branch format if needed.
 
1133
 
 
1134
        The format is stored as a reference to the format object in
 
1135
        self._format for code that needs to check it later.
 
1136
 
 
1137
        The format parameter is either None or the branch format class
 
1138
        used to open this branch.
 
1139
 
 
1140
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
 
1141
        """
 
1142
        if format is None:
 
1143
            format = BranchFormat.find_format(self.bzrdir)
 
1144
        self._format = format
 
1145
        mutter("got branch format %s", self._format)
 
1146
 
 
1147
    @needs_read_lock
 
1148
    def get_root_id(self):
 
1149
        """See Branch.get_root_id."""
 
1150
        tree = self.repository.revision_tree(self.last_revision())
 
1151
        return tree.inventory.root.file_id
 
1152
 
 
1153
    def is_locked(self):
 
1154
        return self.control_files.is_locked()
 
1155
 
 
1156
    def lock_write(self):
 
1157
        self.repository.lock_write()
 
1158
        try:
 
1159
            self.control_files.lock_write()
 
1160
        except:
 
1161
            self.repository.unlock()
 
1162
            raise
 
1163
 
 
1164
    def lock_read(self):
 
1165
        self.repository.lock_read()
 
1166
        try:
 
1167
            self.control_files.lock_read()
 
1168
        except:
 
1169
            self.repository.unlock()
 
1170
            raise
 
1171
 
 
1172
    def unlock(self):
 
1173
        # TODO: test for failed two phase locks. This is known broken.
 
1174
        try:
 
1175
            self.control_files.unlock()
 
1176
        finally:
 
1177
            self.repository.unlock()
 
1178
        
 
1179
    def peek_lock_mode(self):
 
1180
        if self.control_files._lock_count == 0:
 
1181
            return None
 
1182
        else:
 
1183
            return self.control_files._lock_mode
 
1184
 
 
1185
    def get_physical_lock_status(self):
 
1186
        return self.control_files.get_physical_lock_status()
 
1187
 
 
1188
    @needs_read_lock
 
1189
    def print_file(self, file, revision_id):
 
1190
        """See Branch.print_file."""
 
1191
        return self.repository.print_file(file, revision_id)
 
1192
 
 
1193
    @needs_write_lock
 
1194
    def append_revision(self, *revision_ids):
 
1195
        """See Branch.append_revision."""
 
1196
        for revision_id in revision_ids:
 
1197
            _mod_revision.check_not_reserved_id(revision_id)
 
1198
            mutter("add {%s} to revision-history" % revision_id)
 
1199
        rev_history = self.revision_history()
 
1200
        rev_history.extend(revision_ids)
 
1201
        self.set_revision_history(rev_history)
 
1202
 
 
1203
    @needs_write_lock
 
1204
    def set_revision_history(self, rev_history):
 
1205
        """See Branch.set_revision_history."""
 
1206
        self.control_files.put_utf8(
 
1207
            'revision-history', '\n'.join(rev_history))
 
1208
        transaction = self.get_transaction()
 
1209
        history = transaction.map.find_revision_history()
 
1210
        if history is not None:
 
1211
            # update the revision history in the identity map.
 
1212
            history[:] = list(rev_history)
 
1213
            # this call is disabled because revision_history is 
 
1214
            # not really an object yet, and the transaction is for objects.
 
1215
            # transaction.register_dirty(history)
 
1216
        else:
 
1217
            transaction.map.add_revision_history(rev_history)
 
1218
            # this call is disabled because revision_history is 
 
1219
            # not really an object yet, and the transaction is for objects.
 
1220
            # transaction.register_clean(history)
 
1221
        for hook in Branch.hooks['set_rh']:
 
1222
            hook(self, rev_history)
 
1223
 
 
1224
    @needs_read_lock
 
1225
    def revision_history(self):
 
1226
        """See Branch.revision_history."""
 
1227
        transaction = self.get_transaction()
 
1228
        history = transaction.map.find_revision_history()
 
1229
        if history is not None:
 
1230
            # mutter("cache hit for revision-history in %s", self)
 
1231
            return list(history)
 
1232
        decode_utf8 = cache_utf8.decode
 
1233
        history = [decode_utf8(l.rstrip('\r\n')) for l in
 
1234
                self.control_files.get('revision-history').readlines()]
 
1235
        transaction.map.add_revision_history(history)
 
1236
        # this call is disabled because revision_history is 
 
1237
        # not really an object yet, and the transaction is for objects.
 
1238
        # transaction.register_clean(history, precious=True)
 
1239
        return list(history)
 
1240
 
 
1241
    @needs_write_lock
 
1242
    def generate_revision_history(self, revision_id, last_rev=None, 
 
1243
        other_branch=None):
 
1244
        """Create a new revision history that will finish with revision_id.
 
1245
        
 
1246
        :param revision_id: the new tip to use.
 
1247
        :param last_rev: The previous last_revision. If not None, then this
 
1248
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
1249
        :param other_branch: The other branch that DivergedBranches should
 
1250
            raise with respect to.
 
1251
        """
 
1252
        # stop_revision must be a descendant of last_revision
 
1253
        stop_graph = self.repository.get_revision_graph(revision_id)
 
1254
        if last_rev is not None and last_rev not in stop_graph:
 
1255
            # our previous tip is not merged into stop_revision
 
1256
            raise errors.DivergedBranches(self, other_branch)
 
1257
        # make a new revision history from the graph
 
1258
        current_rev_id = revision_id
 
1259
        new_history = []
 
1260
        while current_rev_id not in (None, _mod_revision.NULL_REVISION):
 
1261
            new_history.append(current_rev_id)
 
1262
            current_rev_id_parents = stop_graph[current_rev_id]
 
1263
            try:
 
1264
                current_rev_id = current_rev_id_parents[0]
 
1265
            except IndexError:
 
1266
                current_rev_id = None
 
1267
        new_history.reverse()
 
1268
        self.set_revision_history(new_history)
 
1269
 
 
1270
    @needs_write_lock
 
1271
    def update_revisions(self, other, stop_revision=None):
 
1272
        """See Branch.update_revisions."""
 
1273
        other.lock_read()
 
1274
        try:
 
1275
            if stop_revision is None:
 
1276
                stop_revision = other.last_revision()
 
1277
                if stop_revision is None:
 
1278
                    # if there are no commits, we're done.
 
1279
                    return
 
1280
            # whats the current last revision, before we fetch [and change it
 
1281
            # possibly]
 
1282
            last_rev = self.last_revision()
 
1283
            # we fetch here regardless of whether we need to so that we pickup
 
1284
            # filled in ghosts.
 
1285
            self.fetch(other, stop_revision)
 
1286
            my_ancestry = self.repository.get_ancestry(last_rev)
 
1287
            if stop_revision in my_ancestry:
 
1288
                # last_revision is a descendant of stop_revision
 
1289
                return
 
1290
            self.generate_revision_history(stop_revision, last_rev=last_rev,
 
1291
                other_branch=other)
 
1292
        finally:
 
1293
            other.unlock()
 
1294
 
 
1295
    def basis_tree(self):
 
1296
        """See Branch.basis_tree."""
 
1297
        return self.repository.revision_tree(self.last_revision())
 
1298
 
 
1299
    @deprecated_method(zero_eight)
 
1300
    def working_tree(self):
 
1301
        """Create a Working tree object for this branch."""
 
1302
 
 
1303
        from bzrlib.transport.local import LocalTransport
 
1304
        if (self.base.find('://') != -1 or 
 
1305
            not isinstance(self._transport, LocalTransport)):
 
1306
            raise NoWorkingTree(self.base)
 
1307
        return self.bzrdir.open_workingtree()
 
1308
 
 
1309
    @needs_write_lock
 
1310
    def pull(self, source, overwrite=False, stop_revision=None,
 
1311
        _hook_master=None, _run_hooks=True):
 
1312
        """See Branch.pull.
 
1313
 
 
1314
        :param _hook_master: Private parameter - set the branch to 
 
1315
            be supplied as the master to push hooks.
 
1316
        :param _run_hooks: Private parameter - allow disabling of
 
1317
            hooks, used when pushing to a master branch.
 
1318
        """
 
1319
        source.lock_read()
 
1320
        try:
 
1321
            old_count, old_tip = self.last_revision_info()
 
1322
            try:
 
1323
                self.update_revisions(source, stop_revision)
 
1324
            except DivergedBranches:
 
1325
                if not overwrite:
 
1326
                    raise
 
1327
            if overwrite:
 
1328
                self.set_revision_history(source.revision_history())
 
1329
            new_count, new_tip = self.last_revision_info()
 
1330
            if _run_hooks:
 
1331
                if _hook_master:
 
1332
                    _hook_local = self
 
1333
                else:
 
1334
                    _hook_master = self
 
1335
                    _hook_local = None
 
1336
                for hook in Branch.hooks['post_pull']:
 
1337
                    hook(source, _hook_local, _hook_master, old_count, old_tip,
 
1338
                        new_count, new_tip)
 
1339
            return new_count - old_count
 
1340
        finally:
 
1341
            source.unlock()
 
1342
 
 
1343
    @needs_read_lock
 
1344
    def push(self, target, overwrite=False, stop_revision=None,
 
1345
        _hook_master=None, _run_hooks=True):
 
1346
        """See Branch.push.
 
1347
        
 
1348
        :param _hook_master: Private parameter - set the branch to 
 
1349
            be supplied as the master to push hooks.
 
1350
        :param _run_hooks: Private parameter - allow disabling of
 
1351
            hooks, used when pushing to a master branch.
 
1352
        """
 
1353
        target.lock_write()
 
1354
        try:
 
1355
            old_count, old_tip = target.last_revision_info()
 
1356
            try:
 
1357
                target.update_revisions(self, stop_revision)
 
1358
            except DivergedBranches:
 
1359
                if not overwrite:
 
1360
                    raise
 
1361
            if overwrite:
 
1362
                target.set_revision_history(self.revision_history())
 
1363
            new_count, new_tip = target.last_revision_info()
 
1364
            if _run_hooks:
 
1365
                if _hook_master:
 
1366
                    _hook_local = target
 
1367
                else:
 
1368
                    _hook_master = target
 
1369
                    _hook_local = None
 
1370
                for hook in Branch.hooks['post_push']:
 
1371
                    hook(self, _hook_local, _hook_master, old_count, old_tip,
 
1372
                        new_count, new_tip)
 
1373
            return new_count - old_count
 
1374
        finally:
 
1375
            target.unlock()
 
1376
 
 
1377
    def get_parent(self):
 
1378
        """See Branch.get_parent."""
 
1379
 
 
1380
        _locs = ['parent', 'pull', 'x-pull']
 
1381
        assert self.base[-1] == '/'
 
1382
        for l in _locs:
 
1383
            try:
 
1384
                parent = self.control_files.get(l).read().strip('\n')
 
1385
            except NoSuchFile:
 
1386
                continue
 
1387
            # This is an old-format absolute path to a local branch
 
1388
            # turn it into a url
 
1389
            if parent.startswith('/'):
 
1390
                parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1391
            try:
 
1392
                return urlutils.join(self.base[:-1], parent)
 
1393
            except errors.InvalidURLJoin, e:
 
1394
                raise errors.InaccessibleParent(parent, self.base)
 
1395
        return None
 
1396
 
 
1397
    def get_push_location(self):
 
1398
        """See Branch.get_push_location."""
 
1399
        push_loc = self.get_config().get_user_option('push_location')
 
1400
        return push_loc
 
1401
 
 
1402
    def set_push_location(self, location):
 
1403
        """See Branch.set_push_location."""
 
1404
        self.get_config().set_user_option(
 
1405
            'push_location', location,
 
1406
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
1407
 
 
1408
    @needs_write_lock
 
1409
    def set_parent(self, url):
 
1410
        """See Branch.set_parent."""
 
1411
        # TODO: Maybe delete old location files?
 
1412
        # URLs should never be unicode, even on the local fs,
 
1413
        # FIXUP this and get_parent in a future branch format bump:
 
1414
        # read and rewrite the file, and have the new format code read
 
1415
        # using .get not .get_utf8. RBC 20060125
 
1416
        if url is None:
 
1417
            self.control_files._transport.delete('parent')
 
1418
        else:
 
1419
            if isinstance(url, unicode):
 
1420
                try: 
 
1421
                    url = url.encode('ascii')
 
1422
                except UnicodeEncodeError:
 
1423
                    raise bzrlib.errors.InvalidURL(url,
 
1424
                        "Urls must be 7-bit ascii, "
 
1425
                        "use bzrlib.urlutils.escape")
 
1426
                    
 
1427
            url = urlutils.relative_url(self.base, url)
 
1428
            self.control_files.put('parent', StringIO(url + '\n'))
 
1429
 
 
1430
    @deprecated_function(zero_nine)
 
1431
    def tree_config(self):
 
1432
        """DEPRECATED; call get_config instead.  
 
1433
        TreeConfig has become part of BranchConfig."""
 
1434
        return TreeConfig(self)
 
1435
 
 
1436
 
 
1437
class BzrBranch5(BzrBranch):
 
1438
    """A format 5 branch. This supports new features over plan branches.
 
1439
 
 
1440
    It has support for a master_branch which is the data for bound branches.
 
1441
    """
 
1442
 
 
1443
    def __init__(self,
 
1444
                 _format,
 
1445
                 _control_files,
 
1446
                 a_bzrdir,
 
1447
                 _repository):
 
1448
        super(BzrBranch5, self).__init__(_format=_format,
 
1449
                                         _control_files=_control_files,
 
1450
                                         a_bzrdir=a_bzrdir,
 
1451
                                         _repository=_repository)
 
1452
        
 
1453
    @needs_write_lock
 
1454
    def pull(self, source, overwrite=False, stop_revision=None,
 
1455
        _run_hooks=True):
 
1456
        """Extends branch.pull to be bound branch aware.
 
1457
        
 
1458
        :param _run_hooks: Private parameter used to force hook running
 
1459
            off during bound branch double-pushing.
 
1460
        """
 
1461
        bound_location = self.get_bound_location()
 
1462
        master_branch = None
 
1463
        if bound_location and source.base != bound_location:
 
1464
            # not pulling from master, so we need to update master.
 
1465
            master_branch = self.get_master_branch()
 
1466
            master_branch.lock_write()
 
1467
        try:
 
1468
            if master_branch:
 
1469
                # pull from source into master.
 
1470
                master_branch.pull(source, overwrite, stop_revision,
 
1471
                    _run_hooks=False)
 
1472
            return super(BzrBranch5, self).pull(source, overwrite,
 
1473
                stop_revision, _hook_master=master_branch,
 
1474
                _run_hooks=_run_hooks)
 
1475
        finally:
 
1476
            if master_branch:
 
1477
                master_branch.unlock()
 
1478
 
 
1479
    @needs_read_lock
 
1480
    def push(self, target, overwrite=False, stop_revision=None):
 
1481
        """Updates branch.push to be bound branch aware."""
 
1482
        bound_location = target.get_bound_location()
 
1483
        master_branch = None
 
1484
        if bound_location and target.base != bound_location:
 
1485
            # not pushing to master, so we need to update master.
 
1486
            master_branch = target.get_master_branch()
 
1487
            master_branch.lock_write()
 
1488
        try:
 
1489
            if master_branch:
 
1490
                # push into the master from this branch.
 
1491
                super(BzrBranch5, self).push(master_branch, overwrite,
 
1492
                    stop_revision, _run_hooks=False)
 
1493
            # and push into the target branch from this. Note that we push from
 
1494
            # this branch again, because its considered the highest bandwidth
 
1495
            # repository.
 
1496
            return super(BzrBranch5, self).push(target, overwrite,
 
1497
                stop_revision, _hook_master=master_branch)
 
1498
        finally:
 
1499
            if master_branch:
 
1500
                master_branch.unlock()
 
1501
 
 
1502
    def get_bound_location(self):
 
1503
        try:
 
1504
            return self.control_files.get_utf8('bound').read()[:-1]
 
1505
        except errors.NoSuchFile:
 
1506
            return None
 
1507
 
 
1508
    @needs_read_lock
 
1509
    def get_master_branch(self):
 
1510
        """Return the branch we are bound to.
 
1511
        
 
1512
        :return: Either a Branch, or None
 
1513
 
 
1514
        This could memoise the branch, but if thats done
 
1515
        it must be revalidated on each new lock.
 
1516
        So for now we just don't memoise it.
 
1517
        # RBC 20060304 review this decision.
 
1518
        """
 
1519
        bound_loc = self.get_bound_location()
 
1520
        if not bound_loc:
 
1521
            return None
 
1522
        try:
 
1523
            return Branch.open(bound_loc)
 
1524
        except (errors.NotBranchError, errors.ConnectionError), e:
 
1525
            raise errors.BoundBranchConnectionFailure(
 
1526
                    self, bound_loc, e)
 
1527
 
 
1528
    @needs_write_lock
 
1529
    def set_bound_location(self, location):
 
1530
        """Set the target where this branch is bound to.
 
1531
 
 
1532
        :param location: URL to the target branch
 
1533
        """
 
1534
        if location:
 
1535
            self.control_files.put_utf8('bound', location+'\n')
 
1536
        else:
 
1537
            try:
 
1538
                self.control_files._transport.delete('bound')
 
1539
            except NoSuchFile:
 
1540
                return False
 
1541
            return True
 
1542
 
 
1543
    @needs_write_lock
 
1544
    def bind(self, other):
 
1545
        """Bind this branch to the branch other.
 
1546
 
 
1547
        This does not push or pull data between the branches, though it does
 
1548
        check for divergence to raise an error when the branches are not
 
1549
        either the same, or one a prefix of the other. That behaviour may not
 
1550
        be useful, so that check may be removed in future.
 
1551
        
 
1552
        :param other: The branch to bind to
 
1553
        :type other: Branch
 
1554
        """
 
1555
        # TODO: jam 20051230 Consider checking if the target is bound
 
1556
        #       It is debatable whether you should be able to bind to
 
1557
        #       a branch which is itself bound.
 
1558
        #       Committing is obviously forbidden,
 
1559
        #       but binding itself may not be.
 
1560
        #       Since we *have* to check at commit time, we don't
 
1561
        #       *need* to check here
 
1562
 
 
1563
        # we want to raise diverged if:
 
1564
        # last_rev is not in the other_last_rev history, AND
 
1565
        # other_last_rev is not in our history, and do it without pulling
 
1566
        # history around
 
1567
        last_rev = self.last_revision()
 
1568
        if last_rev is not None:
 
1569
            other.lock_read()
 
1570
            try:
 
1571
                other_last_rev = other.last_revision()
 
1572
                if other_last_rev is not None:
 
1573
                    # neither branch is new, we have to do some work to
 
1574
                    # ascertain diversion.
 
1575
                    remote_graph = other.repository.get_revision_graph(
 
1576
                        other_last_rev)
 
1577
                    local_graph = self.repository.get_revision_graph(last_rev)
 
1578
                    if (last_rev not in remote_graph and
 
1579
                        other_last_rev not in local_graph):
 
1580
                        raise errors.DivergedBranches(self, other)
 
1581
            finally:
 
1582
                other.unlock()
 
1583
        self.set_bound_location(other.base)
 
1584
 
 
1585
    @needs_write_lock
 
1586
    def unbind(self):
 
1587
        """If bound, unbind"""
 
1588
        return self.set_bound_location(None)
 
1589
 
 
1590
    @needs_write_lock
 
1591
    def update(self):
 
1592
        """Synchronise this branch with the master branch if any. 
 
1593
 
 
1594
        :return: None or the last_revision that was pivoted out during the
 
1595
                 update.
 
1596
        """
 
1597
        master = self.get_master_branch()
 
1598
        if master is not None:
 
1599
            old_tip = self.last_revision()
 
1600
            self.pull(master, overwrite=True)
 
1601
            if old_tip in self.repository.get_ancestry(self.last_revision()):
 
1602
                return None
 
1603
            return old_tip
 
1604
        return None
 
1605
 
 
1606
 
 
1607
class BzrBranchExperimental(BzrBranch5):
 
1608
    """Bzr experimental branch format
 
1609
 
 
1610
    This format has:
 
1611
     - a revision-history file.
 
1612
     - a format string
 
1613
     - a lock dir guarding the branch itself
 
1614
     - all of this stored in a branch/ subdirectory
 
1615
     - works with shared repositories.
 
1616
     - a tag dictionary in the branch
 
1617
 
 
1618
    This format is new in bzr 0.15, but shouldn't be used for real data, 
 
1619
    only for testing.
 
1620
 
 
1621
    This class acts as it's own BranchFormat.
 
1622
    """
 
1623
 
 
1624
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1625
 
 
1626
    @classmethod
 
1627
    def get_format_string(cls):
 
1628
        """See BranchFormat.get_format_string()."""
 
1629
        return "Bazaar-NG branch format experimental\n"
 
1630
 
 
1631
    @classmethod
 
1632
    def get_format_description(cls):
 
1633
        """See BranchFormat.get_format_description()."""
 
1634
        return "Experimental branch format"
 
1635
 
 
1636
    @classmethod
 
1637
    def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
 
1638
            lock_class):
 
1639
        branch_transport = a_bzrdir.get_branch_transport(cls)
 
1640
        control_files = lockable_files.LockableFiles(branch_transport,
 
1641
            lock_filename, lock_class)
 
1642
        control_files.create_lock()
 
1643
        control_files.lock_write()
 
1644
        try:
 
1645
            for filename, content in utf8_files:
 
1646
                control_files.put_utf8(filename, content)
 
1647
        finally:
 
1648
            control_files.unlock()
 
1649
        
 
1650
    @classmethod
 
1651
    def initialize(cls, a_bzrdir):
 
1652
        """Create a branch of this format in a_bzrdir."""
 
1653
        utf8_files = [('format', cls.get_format_string()),
 
1654
                      ('revision-history', ''),
 
1655
                      ('branch-name', ''),
 
1656
                      ('tags', ''),
 
1657
                      ]
 
1658
        cls._initialize_control_files(a_bzrdir, utf8_files,
 
1659
            'lock', lockdir.LockDir)
 
1660
        return cls.open(a_bzrdir, _found=True)
 
1661
 
 
1662
    @classmethod
 
1663
    def open(cls, a_bzrdir, _found=False):
 
1664
        """Return the branch object for a_bzrdir
 
1665
 
 
1666
        _found is a private parameter, do not use it. It is used to indicate
 
1667
               if format probing has already be done.
 
1668
        """
 
1669
        if not _found:
 
1670
            format = BranchFormat.find_format(a_bzrdir)
 
1671
            assert format.__class__ == cls
 
1672
        transport = a_bzrdir.get_branch_transport(None)
 
1673
        control_files = lockable_files.LockableFiles(transport, 'lock',
 
1674
                                                     lockdir.LockDir)
 
1675
        return cls(_format=cls,
 
1676
            _control_files=control_files,
 
1677
            a_bzrdir=a_bzrdir,
 
1678
            _repository=a_bzrdir.find_repository())
 
1679
 
 
1680
    @classmethod
 
1681
    def is_supported(cls):
 
1682
        return True
 
1683
 
 
1684
    def _make_tags(self):
 
1685
        return BasicTags(self)
 
1686
 
 
1687
    @classmethod
 
1688
    def supports_tags(cls):
 
1689
        return True
 
1690
 
 
1691
 
 
1692
BranchFormat.register_format(BzrBranchExperimental)
 
1693
 
 
1694
 
 
1695
class BranchTestProviderAdapter(object):
 
1696
    """A tool to generate a suite testing multiple branch formats at once.
 
1697
 
 
1698
    This is done by copying the test once for each transport and injecting
 
1699
    the transport_server, transport_readonly_server, and branch_format
 
1700
    classes into each copy. Each copy is also given a new id() to make it
 
1701
    easy to identify.
 
1702
    """
 
1703
 
 
1704
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1705
        self._transport_server = transport_server
 
1706
        self._transport_readonly_server = transport_readonly_server
 
1707
        self._formats = formats
 
1708
    
 
1709
    def adapt(self, test):
 
1710
        result = TestSuite()
 
1711
        for branch_format, bzrdir_format in self._formats:
 
1712
            new_test = deepcopy(test)
 
1713
            new_test.transport_server = self._transport_server
 
1714
            new_test.transport_readonly_server = self._transport_readonly_server
 
1715
            new_test.bzrdir_format = bzrdir_format
 
1716
            new_test.branch_format = branch_format
 
1717
            def make_new_test_id():
 
1718
                # the format can be either a class or an instance
 
1719
                name = getattr(branch_format, '__name__',
 
1720
                        branch_format.__class__.__name__)
 
1721
                new_id = "%s(%s)" % (new_test.id(), name)
 
1722
                return lambda: new_id
 
1723
            new_test.id = make_new_test_id()
 
1724
            result.addTest(new_test)
 
1725
        return result
 
1726
 
 
1727
 
 
1728
class BranchCheckResult(object):
 
1729
    """Results of checking branch consistency.
 
1730
 
 
1731
    :see: Branch.check
 
1732
    """
 
1733
 
 
1734
    def __init__(self, branch):
 
1735
        self.branch = branch
 
1736
 
 
1737
    def report_results(self, verbose):
 
1738
        """Report the check results via trace.note.
 
1739
        
 
1740
        :param verbose: Requests more detailed display of what was checked,
 
1741
            if any.
 
1742
        """
 
1743
        note('checked branch %s format %s',
 
1744
             self.branch.base,
 
1745
             self.branch._format)
 
1746
 
 
1747
 
 
1748
######################################################################
 
1749
# predicates
 
1750
 
 
1751
 
 
1752
@deprecated_function(zero_eight)
 
1753
def is_control_file(*args, **kwargs):
 
1754
    """See bzrlib.workingtree.is_control_file."""
 
1755
    from bzrlib import workingtree
 
1756
    return workingtree.is_control_file(*args, **kwargs)