← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2010-06-16 12:47:51 UTC
  • mfrom: (4797.43.16 2.1-integration)
  • mto: This revision was merged to the branch mainline in revision 5298.
  • Revision ID: v.ladeuil+lp@free.fr-20100616124751-knove5iu86fxk089
Merge 2.1 into bzr.dev including fix for bug #586926

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
 
32
        remote,
32
33
        repository,
33
34
        revision as _mod_revision,
34
35
        rio,
49
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
51
from bzrlib.hooks import HookPoint, Hooks
51
52
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
54
from bzrlib import registry
54
55
from bzrlib.symbol_versioning import (
55
56
    deprecated_in,
197
198
        return self.supports_tags() and self.tags.get_tag_dict()
198
199
 
199
200
    def get_config(self):
 
201
        """Get a bzrlib.config.BranchConfig for this Branch.
 
202
 
 
203
        This can then be used to get and set configuration options for the
 
204
        branch.
 
205
 
 
206
        :return: A bzrlib.config.BranchConfig.
 
207
        """
200
208
        return BranchConfig(self)
201
209
 
202
210
    def _get_config(self):
283
291
        new_history.reverse()
284
292
        return new_history
285
293
 
286
 
    def lock_write(self):
 
294
    def lock_write(self, token=None):
 
295
        """Lock the branch for write operations.
 
296
 
 
297
        :param token: A token to permit reacquiring a previously held and
 
298
            preserved lock.
 
299
        :return: A BranchWriteLockResult.
 
300
        """
287
301
        raise NotImplementedError(self.lock_write)
288
302
 
289
303
    def lock_read(self):
 
304
        """Lock the branch for read operations.
 
305
 
 
306
        :return: A bzrlib.lock.LogicalLockResult.
 
307
        """
290
308
        raise NotImplementedError(self.lock_read)
291
309
 
292
310
    def unlock(self):
951
969
                raise errors.NoSuchRevision(self, stop_revision)
952
970
        return other_history[self_len:stop_revision]
953
971
 
954
 
    @needs_write_lock
955
972
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
973
                         graph=None):
957
974
        """Pull in new perfect-fit revisions.
1255
1272
                revno = 1
1256
1273
        destination.set_last_revision_info(revno, revision_id)
1257
1274
 
1258
 
    @needs_read_lock
1259
1275
    def copy_content_into(self, destination, revision_id=None):
1260
1276
        """Copy the content of self into destination.
1261
1277
 
1262
1278
        revision_id: if not None, the revision history in the new branch will
1263
1279
                     be truncated to end with revision_id.
1264
1280
        """
1265
 
        self.update_references(destination)
1266
 
        self._synchronize_history(destination, revision_id)
1267
 
        try:
1268
 
            parent = self.get_parent()
1269
 
        except errors.InaccessibleParent, e:
1270
 
            mutter('parent was not accessible to copy: %s', e)
1271
 
        else:
1272
 
            if parent:
1273
 
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
 
1281
        return InterBranch.get(self, destination).copy_content_into(
 
1282
            revision_id=revision_id)
1276
1283
 
1277
1284
    def update_references(self, target):
1278
1285
        if not getattr(self._format, 'supports_reference_locations', False):
1346
1353
        """
1347
1354
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1355
        # clone call. Or something. 20090224 RBC/spiv.
 
1356
        # XXX: Should this perhaps clone colocated branches as well, 
 
1357
        # rather than just the default branch? 20100319 JRV
1349
1358
        if revision_id is None:
1350
1359
            revision_id = self.last_revision()
1351
1360
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1521
1530
        """Return the current default format."""
1522
1531
        return klass._default_format
1523
1532
 
1524
 
    def get_reference(self, a_bzrdir):
 
1533
    def get_reference(self, a_bzrdir, name=None):
1525
1534
        """Get the target reference of the branch in a_bzrdir.
1526
1535
 
1527
1536
        format probing must have been completed before calling
1529
1538
        in a_bzrdir is correct.
1530
1539
 
1531
1540
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1541
        :param name: Name of the colocated branch to fetch
1532
1542
        :return: None if the branch is not a reference branch.
1533
1543
        """
1534
1544
        return None
1535
1545
 
1536
1546
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1547
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1548
        """Set the target reference of the branch in a_bzrdir.
1539
1549
 
1540
1550
        format probing must have been completed before calling
1542
1552
        in a_bzrdir is correct.
1543
1553
 
1544
1554
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1555
        :param name: Name of colocated branch to set, None for default
1545
1556
        :param to_branch: branch that the checkout is to reference
1546
1557
        """
1547
1558
        raise NotImplementedError(self.set_reference)
2157
2168
        """See BranchFormat.get_format_description()."""
2158
2169
        return "Checkout reference format 1"
2159
2170
 
2160
 
    def get_reference(self, a_bzrdir):
 
2171
    def get_reference(self, a_bzrdir, name=None):
2161
2172
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2173
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2174
        return transport.get_bytes('location')
2164
2175
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2176
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2177
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2178
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2179
        location = transport.put_bytes('location', to_branch.base)
2169
2180
 
2170
2181
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2221
2232
                raise AssertionError("wrong format %r found for %r" %
2222
2233
                    (format, self))
2223
2234
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2235
            location = self.get_reference(a_bzrdir, name)
2225
2236
        real_bzrdir = bzrdir.BzrDir.open(
2226
2237
            location, possible_transports=possible_transports)
2227
2238
        result = real_bzrdir.open_branch(name=name, 
2265
2276
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2277
 
2267
2278
 
 
2279
class BranchWriteLockResult(LogicalLockResult):
 
2280
    """The result of write locking a branch.
 
2281
 
 
2282
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2283
        None.
 
2284
    :ivar unlock: A callable which will unlock the lock.
 
2285
    """
 
2286
 
 
2287
    def __init__(self, unlock, branch_token):
 
2288
        LogicalLockResult.__init__(self, unlock)
 
2289
        self.branch_token = branch_token
 
2290
 
 
2291
    def __repr__(self):
 
2292
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2293
            self.unlock)
 
2294
 
 
2295
 
2268
2296
class BzrBranch(Branch, _RelockDebugMixin):
2269
2297
    """A branch stored in the actual filesystem.
2270
2298
 
2324
2352
        return self.control_files.is_locked()
2325
2353
 
2326
2354
    def lock_write(self, token=None):
 
2355
        """Lock the branch for write operations.
 
2356
 
 
2357
        :param token: A token to permit reacquiring a previously held and
 
2358
            preserved lock.
 
2359
        :return: A BranchWriteLockResult.
 
2360
        """
2327
2361
        if not self.is_locked():
2328
2362
            self._note_lock('w')
2329
2363
        # All-in-one needs to always unlock/lock.
2335
2369
        else:
2336
2370
            took_lock = False
2337
2371
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2372
            return BranchWriteLockResult(self.unlock,
 
2373
                self.control_files.lock_write(token=token))
2339
2374
        except:
2340
2375
            if took_lock:
2341
2376
                self.repository.unlock()
2342
2377
            raise
2343
2378
 
2344
2379
    def lock_read(self):
 
2380
        """Lock the branch for read operations.
 
2381
 
 
2382
        :return: A bzrlib.lock.LogicalLockResult.
 
2383
        """
2345
2384
        if not self.is_locked():
2346
2385
            self._note_lock('r')
2347
2386
        # All-in-one needs to always unlock/lock.
2354
2393
            took_lock = False
2355
2394
        try:
2356
2395
            self.control_files.lock_read()
 
2396
            return LogicalLockResult(self.unlock)
2357
2397
        except:
2358
2398
            if took_lock:
2359
2399
                self.repository.unlock()
3183
3223
 
3184
3224
 
3185
3225
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
 
3226
    """InterBranch implementation that uses public Branch functions."""
 
3227
 
 
3228
    @classmethod
 
3229
    def is_compatible(klass, source, target):
 
3230
        # GenericBranch uses the public API, so always compatible
 
3231
        return True
3188
3232
 
3189
3233
    @staticmethod
3190
3234
    def _get_branch_formats_to_test():
3191
3235
        return BranchFormat._default_format, BranchFormat._default_format
3192
3236
 
 
3237
    @classmethod
 
3238
    def unwrap_format(klass, format):
 
3239
        if isinstance(format, remote.RemoteBranchFormat):
 
3240
            format._ensure_real()
 
3241
            return format._custom_format
 
3242
        return format                                                                                                  
 
3243
 
 
3244
    @needs_write_lock
 
3245
    def copy_content_into(self, revision_id=None):
 
3246
        """Copy the content of source into target
 
3247
 
 
3248
        revision_id: if not None, the revision history in the new branch will
 
3249
                     be truncated to end with revision_id.
 
3250
        """
 
3251
        self.source.update_references(self.target)
 
3252
        self.source._synchronize_history(self.target, revision_id)
 
3253
        try:
 
3254
            parent = self.source.get_parent()
 
3255
        except errors.InaccessibleParent, e:
 
3256
            mutter('parent was not accessible to copy: %s', e)
 
3257
        else:
 
3258
            if parent:
 
3259
                self.target.set_parent(parent)
 
3260
        if self.source._push_should_merge_tags():
 
3261
            self.source.tags.merge_to(self.target.tags)
 
3262
 
 
3263
    @needs_write_lock
3193
3264
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
3265
        graph=None):
3195
3266
        """See InterBranch.update_revisions()."""
3196
 
        self.source.lock_read()
3197
 
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
 
3267
        other_revno, other_last_revision = self.source.last_revision_info()
 
3268
        stop_revno = None # unknown
 
3269
        if stop_revision is None:
 
3270
            stop_revision = other_last_revision
 
3271
            if _mod_revision.is_null(stop_revision):
 
3272
                # if there are no commits, we're done.
 
3273
                return
 
3274
            stop_revno = other_revno
3206
3275
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3233
 
        finally:
3234
 
            self.source.unlock()
 
3276
        # what's the current last revision, before we fetch [and change it
 
3277
        # possibly]
 
3278
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3279
        # we fetch here so that we don't process data twice in the common
 
3280
        # case of having something to pull, and so that the check for
 
3281
        # already merged can operate on the just fetched graph, which will
 
3282
        # be cached in memory.
 
3283
        self.target.fetch(self.source, stop_revision)
 
3284
        # Check to see if one is an ancestor of the other
 
3285
        if not overwrite:
 
3286
            if graph is None:
 
3287
                graph = self.target.repository.get_graph()
 
3288
            if self.target._check_if_descendant_or_diverged(
 
3289
                    stop_revision, last_rev, graph, self.source):
 
3290
                # stop_revision is a descendant of last_rev, but we aren't
 
3291
                # overwriting, so we're done.
 
3292
                return
 
3293
        if stop_revno is None:
 
3294
            if graph is None:
 
3295
                graph = self.target.repository.get_graph()
 
3296
            this_revno, this_last_revision = \
 
3297
                    self.target.last_revision_info()
 
3298
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3299
                            [(other_last_revision, other_revno),
 
3300
                             (this_last_revision, this_revno)])
 
3301
        self.target.set_last_revision_info(stop_revno, stop_revision)
3235
3302
 
3236
3303
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3304
             possible_transports=None, run_hooks=True,
3238
3305
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3306
        """Pull from source into self, updating my master if any.
3240
3307
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3308
        :param run_hooks: Private parameter - if false, this branch
3244
3309
            is being called because it's the master of the primary branch,
3245
3310
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
3311
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3312
        bound_location = self.target.get_bound_location()
 
3313
        if local and not bound_location:
3252
3314
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
 
3315
        master_branch = None
 
3316
        if not local and bound_location and self.source.user_url != bound_location:
 
3317
            # not pulling from master, so we need to update master.
 
3318
            master_branch = self.target.get_master_branch(possible_transports)
 
3319
            master_branch.lock_write()
3260
3320
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
 
3321
            if master_branch:
 
3322
                # pull from source into master.
 
3323
                master_branch.pull(self.source, overwrite, stop_revision,
 
3324
                    run_hooks=False)
 
3325
            return self._pull(overwrite,
 
3326
                stop_revision, _hook_master=master_branch,
 
3327
                run_hooks=run_hooks,
 
3328
                _override_hook_target=_override_hook_target)
3287
3329
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3330
            if master_branch:
 
3331
                master_branch.unlock()
3290
3332
 
3291
3333
    def push(self, overwrite=False, stop_revision=None,
3292
3334
             _override_hook_source_branch=None):
3354
3396
            _run_hooks()
3355
3397
            return result
3356
3398
 
3357
 
    @classmethod
3358
 
    def is_compatible(self, source, target):
3359
 
        # GenericBranch uses the public API, so always compatible
3360
 
        return True
3361
 
 
3362
 
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
 
3399
    def _pull(self, overwrite=False, stop_revision=None,
 
3400
             possible_transports=None, _hook_master=None, run_hooks=True,
3371
3401
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
 
3402
        """See Branch.pull.
 
3403
 
 
3404
        This function is the core worker, used by GenericInterBranch.pull to
 
3405
        avoid duplication when pulling source->master and source->local.
 
3406
 
 
3407
        :param _hook_master: Private parameter - set the branch to
 
3408
            be supplied as the master to pull hooks.
3374
3409
        :param run_hooks: Private parameter - if false, this branch
3375
3410
            is being called because it's the master of the primary branch,
3376
3411
            so it should not run its hooks.
 
3412
        :param _override_hook_target: Private parameter - set the branch to be
 
3413
            supplied as the target_branch to pull hooks.
 
3414
        :param local: Only update the local branch, and not the bound branch.
3377
3415
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3416
        # This type of branch can't be bound.
 
3417
        if local:
3380
3418
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
 
3419
        result = PullResult()
 
3420
        result.source_branch = self.source
 
3421
        if _override_hook_target is None:
 
3422
            result.target_branch = self.target
 
3423
        else:
 
3424
            result.target_branch = _override_hook_target
 
3425
        self.source.lock_read()
3386
3426
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
 
3427
            # We assume that during 'pull' the target repository is closer than
 
3428
            # the source one.
 
3429
            self.source.update_references(self.target)
 
3430
            graph = self.target.repository.get_graph(self.source.repository)
 
3431
            # TODO: Branch formats should have a flag that indicates 
 
3432
            # that revno's are expensive, and pull() should honor that flag.
 
3433
            # -- JRV20090506
 
3434
            result.old_revno, result.old_revid = \
 
3435
                self.target.last_revision_info()
 
3436
            self.target.update_revisions(self.source, stop_revision,
 
3437
                overwrite=overwrite, graph=graph)
 
3438
            # TODO: The old revid should be specified when merging tags, 
 
3439
            # so a tags implementation that versions tags can only 
 
3440
            # pull in the most recent changes. -- JRV20090506
 
3441
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3442
                overwrite)
 
3443
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3444
            if _hook_master:
 
3445
                result.master_branch = _hook_master
 
3446
                result.local_branch = result.target_branch
 
3447
            else:
 
3448
                result.master_branch = result.target_branch
 
3449
                result.local_branch = None
 
3450
            if run_hooks:
 
3451
                for hook in Branch.hooks['post_pull']:
 
3452
                    hook(result)
3395
3453
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3454
            self.source.unlock()
 
3455
        return result
3398
3456
 
3399
3457
 
3400
3458
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)