/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: Aaron Bentley
  • Date: 2008-10-16 18:30:32 UTC
  • mto: (3777.1.13 launchpad-login)
  • mto: This revision was merged to the branch mainline in revision 3783.
  • Revision ID: aaron@aaronbentley.com-20081016183032-cybgqp6y0ip27mem
Reverse order of scheme and password

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
import sys
 
19
 
 
20
from bzrlib.lazy_import import lazy_import
 
21
lazy_import(globals(), """
 
22
from itertools import chain
 
23
from bzrlib import (
 
24
        bzrdir,
 
25
        cache_utf8,
 
26
        config as _mod_config,
 
27
        debug,
 
28
        errors,
 
29
        lockdir,
 
30
        lockable_files,
 
31
        repository,
 
32
        revision as _mod_revision,
 
33
        transport,
 
34
        tsort,
 
35
        ui,
 
36
        urlutils,
 
37
        )
 
38
from bzrlib.config import BranchConfig
 
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
40
from bzrlib.tag import (
 
41
    BasicTags,
 
42
    DisabledTags,
 
43
    )
 
44
""")
 
45
 
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
 
48
from bzrlib.symbol_versioning import (
 
49
    deprecated_in,
 
50
    deprecated_method,
 
51
    )
 
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
53
 
 
54
 
 
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
58
 
 
59
 
 
60
# TODO: Maybe include checks for common corruption of newlines, etc?
 
61
 
 
62
# TODO: Some operations like log might retrieve the same revisions
 
63
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
64
# cache in memory to make this faster.  In general anything can be
 
65
# cached in memory between lock and unlock operations. .. nb thats
 
66
# what the transaction identity map provides
 
67
 
 
68
 
 
69
######################################################################
 
70
# branch objects
 
71
 
 
72
class Branch(object):
 
73
    """Branch holding a history of revisions.
 
74
 
 
75
    base
 
76
        Base directory/url of the branch.
 
77
 
 
78
    hooks: An instance of BranchHooks.
 
79
    """
 
80
    # this is really an instance variable - FIXME move it there
 
81
    # - RBC 20060112
 
82
    base = None
 
83
 
 
84
    # override this to set the strategy for storing tags
 
85
    def _make_tags(self):
 
86
        return DisabledTags(self)
 
87
 
 
88
    def __init__(self, *ignored, **ignored_too):
 
89
        self.tags = self._make_tags()
 
90
        self._revision_history_cache = None
 
91
        self._revision_id_to_revno_cache = None
 
92
        self._last_revision_info_cache = None
 
93
        self._open_hook()
 
94
        hooks = Branch.hooks['open']
 
95
        for hook in hooks:
 
96
            hook(self)
 
97
 
 
98
    def _open_hook(self):
 
99
        """Called by init to allow simpler extension of the base class."""
 
100
 
 
101
    def break_lock(self):
 
102
        """Break a lock if one is present from another instance.
 
103
 
 
104
        Uses the ui factory to ask for confirmation if the lock may be from
 
105
        an active process.
 
106
 
 
107
        This will probe the repository for its lock as well.
 
108
        """
 
109
        self.control_files.break_lock()
 
110
        self.repository.break_lock()
 
111
        master = self.get_master_branch()
 
112
        if master is not None:
 
113
            master.break_lock()
 
114
 
 
115
    @staticmethod
 
116
    def open(base, _unsupported=False, possible_transports=None):
 
117
        """Open the branch rooted at base.
 
118
 
 
119
        For instance, if the branch is at URL/.bzr/branch,
 
120
        Branch.open(URL) -> a Branch instance.
 
121
        """
 
122
        control = bzrdir.BzrDir.open(base, _unsupported,
 
123
                                     possible_transports=possible_transports)
 
124
        return control.open_branch(_unsupported)
 
125
 
 
126
    @staticmethod
 
127
    def open_from_transport(transport, _unsupported=False):
 
128
        """Open the branch rooted at transport"""
 
129
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
 
130
        return control.open_branch(_unsupported)
 
131
 
 
132
    @staticmethod
 
133
    def open_containing(url, possible_transports=None):
 
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
                                                         possible_transports)
 
146
        return control.open_branch(), relpath
 
147
 
 
148
    def get_config(self):
 
149
        return BranchConfig(self)
 
150
 
 
151
    def _get_nick(self):
 
152
        return self.get_config().get_nickname()
 
153
 
 
154
    def _set_nick(self, nick):
 
155
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
156
 
 
157
    nick = property(_get_nick, _set_nick)
 
158
 
 
159
    def is_locked(self):
 
160
        raise NotImplementedError(self.is_locked)
 
161
 
 
162
    def lock_write(self):
 
163
        raise NotImplementedError(self.lock_write)
 
164
 
 
165
    def lock_read(self):
 
166
        raise NotImplementedError(self.lock_read)
 
167
 
 
168
    def unlock(self):
 
169
        raise NotImplementedError(self.unlock)
 
170
 
 
171
    def peek_lock_mode(self):
 
172
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
173
        raise NotImplementedError(self.peek_lock_mode)
 
174
 
 
175
    def get_physical_lock_status(self):
 
176
        raise NotImplementedError(self.get_physical_lock_status)
 
177
 
 
178
    @needs_read_lock
 
179
    def get_revision_id_to_revno_map(self):
 
180
        """Return the revision_id => dotted revno map.
 
181
 
 
182
        This will be regenerated on demand, but will be cached.
 
183
 
 
184
        :return: A dictionary mapping revision_id => dotted revno.
 
185
            This dictionary should not be modified by the caller.
 
186
        """
 
187
        if self._revision_id_to_revno_cache is not None:
 
188
            mapping = self._revision_id_to_revno_cache
 
189
        else:
 
190
            mapping = self._gen_revno_map()
 
191
            self._cache_revision_id_to_revno(mapping)
 
192
        # TODO: jam 20070417 Since this is being cached, should we be returning
 
193
        #       a copy?
 
194
        # I would rather not, and instead just declare that users should not
 
195
        # modify the return value.
 
196
        return mapping
 
197
 
 
198
    def _gen_revno_map(self):
 
199
        """Create a new mapping from revision ids to dotted revnos.
 
200
 
 
201
        Dotted revnos are generated based on the current tip in the revision
 
202
        history.
 
203
        This is the worker function for get_revision_id_to_revno_map, which
 
204
        just caches the return value.
 
205
 
 
206
        :return: A dictionary mapping revision_id => dotted revno.
 
207
        """
 
208
        last_revision = self.last_revision()
 
209
        revision_graph = repository._old_get_graph(self.repository,
 
210
            last_revision)
 
211
        merge_sorted_revisions = tsort.merge_sort(
 
212
            revision_graph,
 
213
            last_revision,
 
214
            None,
 
215
            generate_revno=True)
 
216
        revision_id_to_revno = dict((rev_id, revno)
 
217
                                    for seq_num, rev_id, depth, revno, end_of_merge
 
218
                                     in merge_sorted_revisions)
 
219
        return revision_id_to_revno
 
220
 
 
221
    def leave_lock_in_place(self):
 
222
        """Tell this branch object not to release the physical lock when this
 
223
        object is unlocked.
 
224
        
 
225
        If lock_write doesn't return a token, then this method is not supported.
 
226
        """
 
227
        self.control_files.leave_in_place()
 
228
 
 
229
    def dont_leave_lock_in_place(self):
 
230
        """Tell this branch object to release the physical lock when this
 
231
        object is unlocked, even if it didn't originally acquire it.
 
232
 
 
233
        If lock_write doesn't return a token, then this method is not supported.
 
234
        """
 
235
        self.control_files.dont_leave_in_place()
 
236
 
 
237
    def bind(self, other):
 
238
        """Bind the local branch the other branch.
 
239
 
 
240
        :param other: The branch to bind to
 
241
        :type other: Branch
 
242
        """
 
243
        raise errors.UpgradeRequired(self.base)
 
244
 
 
245
    @needs_write_lock
 
246
    def fetch(self, from_branch, last_revision=None, pb=None):
 
247
        """Copy revisions from from_branch into this branch.
 
248
 
 
249
        :param from_branch: Where to copy from.
 
250
        :param last_revision: What revision to stop at (None for at the end
 
251
                              of the branch.
 
252
        :param pb: An optional progress bar to use.
 
253
 
 
254
        Returns the copied revision count and the failed revisions in a tuple:
 
255
        (copied, failures).
 
256
        """
 
257
        if self.base == from_branch.base:
 
258
            return (0, [])
 
259
        if pb is None:
 
260
            nested_pb = ui.ui_factory.nested_progress_bar()
 
261
            pb = nested_pb
 
262
        else:
 
263
            nested_pb = None
 
264
 
 
265
        from_branch.lock_read()
 
266
        try:
 
267
            if last_revision is None:
 
268
                pb.update('get source history')
 
269
                last_revision = from_branch.last_revision()
 
270
                last_revision = _mod_revision.ensure_null(last_revision)
 
271
            return self.repository.fetch(from_branch.repository,
 
272
                                         revision_id=last_revision,
 
273
                                         pb=nested_pb)
 
274
        finally:
 
275
            if nested_pb is not None:
 
276
                nested_pb.finished()
 
277
            from_branch.unlock()
 
278
 
 
279
    def get_bound_location(self):
 
280
        """Return the URL of the branch we are bound to.
 
281
 
 
282
        Older format branches cannot bind, please be sure to use a metadir
 
283
        branch.
 
284
        """
 
285
        return None
 
286
    
 
287
    def get_old_bound_location(self):
 
288
        """Return the URL of the branch we used to be bound to
 
289
        """
 
290
        raise errors.UpgradeRequired(self.base)
 
291
 
 
292
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
293
                           timezone=None, committer=None, revprops=None, 
 
294
                           revision_id=None):
 
295
        """Obtain a CommitBuilder for this branch.
 
296
        
 
297
        :param parents: Revision ids of the parents of the new revision.
 
298
        :param config: Optional configuration to use.
 
299
        :param timestamp: Optional timestamp recorded for commit.
 
300
        :param timezone: Optional timezone for timestamp.
 
301
        :param committer: Optional committer to set for commit.
 
302
        :param revprops: Optional dictionary of revision properties.
 
303
        :param revision_id: Optional revision id.
 
304
        """
 
305
 
 
306
        if config is None:
 
307
            config = self.get_config()
 
308
        
 
309
        return self.repository.get_commit_builder(self, parents, config,
 
310
            timestamp, timezone, committer, revprops, revision_id)
 
311
 
 
312
    def get_master_branch(self, possible_transports=None):
 
313
        """Return the branch we are bound to.
 
314
        
 
315
        :return: Either a Branch, or None
 
316
        """
 
317
        return None
 
318
 
 
319
    def get_revision_delta(self, revno):
 
320
        """Return the delta for one revision.
 
321
 
 
322
        The delta is relative to its mainline predecessor, or the
 
323
        empty tree for revision 1.
 
324
        """
 
325
        rh = self.revision_history()
 
326
        if not (1 <= revno <= len(rh)):
 
327
            raise errors.InvalidRevisionNumber(revno)
 
328
        return self.repository.get_revision_delta(rh[revno-1])
 
329
 
 
330
    def get_stacked_on_url(self):
 
331
        """Get the URL this branch is stacked against.
 
332
 
 
333
        :raises NotStacked: If the branch is not stacked.
 
334
        :raises UnstackableBranchFormat: If the branch does not support
 
335
            stacking.
 
336
        """
 
337
        raise NotImplementedError(self.get_stacked_on_url)
 
338
 
 
339
    def print_file(self, file, revision_id):
 
340
        """Print `file` to stdout."""
 
341
        raise NotImplementedError(self.print_file)
 
342
 
 
343
    def set_revision_history(self, rev_history):
 
344
        raise NotImplementedError(self.set_revision_history)
 
345
 
 
346
    def set_stacked_on_url(self, url):
 
347
        """Set the URL this branch is stacked against.
 
348
 
 
349
        :raises UnstackableBranchFormat: If the branch does not support
 
350
            stacking.
 
351
        :raises UnstackableRepositoryFormat: If the repository does not support
 
352
            stacking.
 
353
        """
 
354
        raise NotImplementedError(self.set_stacked_on_url)
 
355
 
 
356
    def _cache_revision_history(self, rev_history):
 
357
        """Set the cached revision history to rev_history.
 
358
 
 
359
        The revision_history method will use this cache to avoid regenerating
 
360
        the revision history.
 
361
 
 
362
        This API is semi-public; it only for use by subclasses, all other code
 
363
        should consider it to be private.
 
364
        """
 
365
        self._revision_history_cache = rev_history
 
366
 
 
367
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
 
368
        """Set the cached revision_id => revno map to revision_id_to_revno.
 
369
 
 
370
        This API is semi-public; it only for use by subclasses, all other code
 
371
        should consider it to be private.
 
372
        """
 
373
        self._revision_id_to_revno_cache = revision_id_to_revno
 
374
 
 
375
    def _clear_cached_state(self):
 
376
        """Clear any cached data on this branch, e.g. cached revision history.
 
377
 
 
378
        This means the next call to revision_history will need to call
 
379
        _gen_revision_history.
 
380
 
 
381
        This API is semi-public; it only for use by subclasses, all other code
 
382
        should consider it to be private.
 
383
        """
 
384
        self._revision_history_cache = None
 
385
        self._revision_id_to_revno_cache = None
 
386
        self._last_revision_info_cache = None
 
387
 
 
388
    def _gen_revision_history(self):
 
389
        """Return sequence of revision hashes on to this branch.
 
390
        
 
391
        Unlike revision_history, this method always regenerates or rereads the
 
392
        revision history, i.e. it does not cache the result, so repeated calls
 
393
        may be expensive.
 
394
 
 
395
        Concrete subclasses should override this instead of revision_history so
 
396
        that subclasses do not need to deal with caching logic.
 
397
        
 
398
        This API is semi-public; it only for use by subclasses, all other code
 
399
        should consider it to be private.
 
400
        """
 
401
        raise NotImplementedError(self._gen_revision_history)
 
402
 
 
403
    @needs_read_lock
 
404
    def revision_history(self):
 
405
        """Return sequence of revision ids on this branch.
 
406
        
 
407
        This method will cache the revision history for as long as it is safe to
 
408
        do so.
 
409
        """
 
410
        if 'evil' in debug.debug_flags:
 
411
            mutter_callsite(3, "revision_history scales with history.")
 
412
        if self._revision_history_cache is not None:
 
413
            history = self._revision_history_cache
 
414
        else:
 
415
            history = self._gen_revision_history()
 
416
            self._cache_revision_history(history)
 
417
        return list(history)
 
418
 
 
419
    def revno(self):
 
420
        """Return current revision number for this branch.
 
421
 
 
422
        That is equivalent to the number of revisions committed to
 
423
        this branch.
 
424
        """
 
425
        return self.last_revision_info()[0]
 
426
 
 
427
    def unbind(self):
 
428
        """Older format branches cannot bind or unbind."""
 
429
        raise errors.UpgradeRequired(self.base)
 
430
 
 
431
    def set_append_revisions_only(self, enabled):
 
432
        """Older format branches are never restricted to append-only"""
 
433
        raise errors.UpgradeRequired(self.base)
 
434
 
 
435
    def last_revision(self):
 
436
        """Return last revision id, or NULL_REVISION."""
 
437
        return self.last_revision_info()[1]
 
438
 
 
439
    @needs_read_lock
 
440
    def last_revision_info(self):
 
441
        """Return information about the last revision.
 
442
 
 
443
        :return: A tuple (revno, revision_id).
 
444
        """
 
445
        if self._last_revision_info_cache is None:
 
446
            self._last_revision_info_cache = self._last_revision_info()
 
447
        return self._last_revision_info_cache
 
448
 
 
449
    def _last_revision_info(self):
 
450
        rh = self.revision_history()
 
451
        revno = len(rh)
 
452
        if revno:
 
453
            return (revno, rh[-1])
 
454
        else:
 
455
            return (0, _mod_revision.NULL_REVISION)
 
456
 
 
457
    @deprecated_method(deprecated_in((1, 6, 0)))
 
458
    def missing_revisions(self, other, stop_revision=None):
 
459
        """Return a list of new revisions that would perfectly fit.
 
460
        
 
461
        If self and other have not diverged, return a list of the revisions
 
462
        present in other, but missing from self.
 
463
        """
 
464
        self_history = self.revision_history()
 
465
        self_len = len(self_history)
 
466
        other_history = other.revision_history()
 
467
        other_len = len(other_history)
 
468
        common_index = min(self_len, other_len) -1
 
469
        if common_index >= 0 and \
 
470
            self_history[common_index] != other_history[common_index]:
 
471
            raise errors.DivergedBranches(self, other)
 
472
 
 
473
        if stop_revision is None:
 
474
            stop_revision = other_len
 
475
        else:
 
476
            if stop_revision > other_len:
 
477
                raise errors.NoSuchRevision(self, stop_revision)
 
478
        return other_history[self_len:stop_revision]
 
479
 
 
480
    @needs_write_lock
 
481
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
482
                         graph=None):
 
483
        """Pull in new perfect-fit revisions.
 
484
 
 
485
        :param other: Another Branch to pull from
 
486
        :param stop_revision: Updated until the given revision
 
487
        :param overwrite: Always set the branch pointer, rather than checking
 
488
            to see if it is a proper descendant.
 
489
        :param graph: A Graph object that can be used to query history
 
490
            information. This can be None.
 
491
        :return: None
 
492
        """
 
493
        other.lock_read()
 
494
        try:
 
495
            other_revno, other_last_revision = other.last_revision_info()
 
496
            stop_revno = None # unknown
 
497
            if stop_revision is None:
 
498
                stop_revision = other_last_revision
 
499
                if _mod_revision.is_null(stop_revision):
 
500
                    # if there are no commits, we're done.
 
501
                    return
 
502
                stop_revno = other_revno
 
503
 
 
504
            # what's the current last revision, before we fetch [and change it
 
505
            # possibly]
 
506
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
507
            # we fetch here so that we don't process data twice in the common
 
508
            # case of having something to pull, and so that the check for 
 
509
            # already merged can operate on the just fetched graph, which will
 
510
            # be cached in memory.
 
511
            self.fetch(other, stop_revision)
 
512
            # Check to see if one is an ancestor of the other
 
513
            if not overwrite:
 
514
                if graph is None:
 
515
                    graph = self.repository.get_graph()
 
516
                if self._check_if_descendant_or_diverged(
 
517
                        stop_revision, last_rev, graph, other):
 
518
                    # stop_revision is a descendant of last_rev, but we aren't
 
519
                    # overwriting, so we're done.
 
520
                    return
 
521
            if stop_revno is None:
 
522
                if graph is None:
 
523
                    graph = self.repository.get_graph()
 
524
                this_revno, this_last_revision = self.last_revision_info()
 
525
                stop_revno = graph.find_distance_to_null(stop_revision,
 
526
                                [(other_last_revision, other_revno),
 
527
                                 (this_last_revision, this_revno)])
 
528
            self.set_last_revision_info(stop_revno, stop_revision)
 
529
        finally:
 
530
            other.unlock()
 
531
 
 
532
    def revision_id_to_revno(self, revision_id):
 
533
        """Given a revision id, return its revno"""
 
534
        if _mod_revision.is_null(revision_id):
 
535
            return 0
 
536
        history = self.revision_history()
 
537
        try:
 
538
            return history.index(revision_id) + 1
 
539
        except ValueError:
 
540
            raise errors.NoSuchRevision(self, revision_id)
 
541
 
 
542
    def get_rev_id(self, revno, history=None):
 
543
        """Find the revision id of the specified revno."""
 
544
        if revno == 0:
 
545
            return _mod_revision.NULL_REVISION
 
546
        if history is None:
 
547
            history = self.revision_history()
 
548
        if revno <= 0 or revno > len(history):
 
549
            raise errors.NoSuchRevision(self, revno)
 
550
        return history[revno - 1]
 
551
 
 
552
    def pull(self, source, overwrite=False, stop_revision=None,
 
553
             possible_transports=None, _override_hook_target=None):
 
554
        """Mirror source into this branch.
 
555
 
 
556
        This branch is considered to be 'local', having low latency.
 
557
 
 
558
        :returns: PullResult instance
 
559
        """
 
560
        raise NotImplementedError(self.pull)
 
561
 
 
562
    def push(self, target, overwrite=False, stop_revision=None):
 
563
        """Mirror this branch into target.
 
564
 
 
565
        This branch is considered to be 'local', having low latency.
 
566
        """
 
567
        raise NotImplementedError(self.push)
 
568
 
 
569
    def basis_tree(self):
 
570
        """Return `Tree` object for last revision."""
 
571
        return self.repository.revision_tree(self.last_revision())
 
572
 
 
573
    def get_parent(self):
 
574
        """Return the parent location of the branch.
 
575
 
 
576
        This is the default location for push/pull/missing.  The usual
 
577
        pattern is that the user can override it by specifying a
 
578
        location.
 
579
        """
 
580
        raise NotImplementedError(self.get_parent)
 
581
 
 
582
    def _set_config_location(self, name, url, config=None,
 
583
                             make_relative=False):
 
584
        if config is None:
 
585
            config = self.get_config()
 
586
        if url is None:
 
587
            url = ''
 
588
        elif make_relative:
 
589
            url = urlutils.relative_url(self.base, url)
 
590
        config.set_user_option(name, url, warn_masked=True)
 
591
 
 
592
    def _get_config_location(self, name, config=None):
 
593
        if config is None:
 
594
            config = self.get_config()
 
595
        location = config.get_user_option(name)
 
596
        if location == '':
 
597
            location = None
 
598
        return location
 
599
 
 
600
    def get_submit_branch(self):
 
601
        """Return the submit location of the branch.
 
602
 
 
603
        This is the default location for bundle.  The usual
 
604
        pattern is that the user can override it by specifying a
 
605
        location.
 
606
        """
 
607
        return self.get_config().get_user_option('submit_branch')
 
608
 
 
609
    def set_submit_branch(self, location):
 
610
        """Return the submit location of the branch.
 
611
 
 
612
        This is the default location for bundle.  The usual
 
613
        pattern is that the user can override it by specifying a
 
614
        location.
 
615
        """
 
616
        self.get_config().set_user_option('submit_branch', location,
 
617
            warn_masked=True)
 
618
 
 
619
    def get_public_branch(self):
 
620
        """Return the public location of the branch.
 
621
 
 
622
        This is is used by merge directives.
 
623
        """
 
624
        return self._get_config_location('public_branch')
 
625
 
 
626
    def set_public_branch(self, location):
 
627
        """Return the submit location of the branch.
 
628
 
 
629
        This is the default location for bundle.  The usual
 
630
        pattern is that the user can override it by specifying a
 
631
        location.
 
632
        """
 
633
        self._set_config_location('public_branch', location)
 
634
 
 
635
    def get_push_location(self):
 
636
        """Return the None or the location to push this branch to."""
 
637
        push_loc = self.get_config().get_user_option('push_location')
 
638
        return push_loc
 
639
 
 
640
    def set_push_location(self, location):
 
641
        """Set a new push location for this branch."""
 
642
        raise NotImplementedError(self.set_push_location)
 
643
 
 
644
    def set_parent(self, url):
 
645
        raise NotImplementedError(self.set_parent)
 
646
 
 
647
    @needs_write_lock
 
648
    def update(self):
 
649
        """Synchronise this branch with the master branch if any. 
 
650
 
 
651
        :return: None or the last_revision pivoted out during the update.
 
652
        """
 
653
        return None
 
654
 
 
655
    def check_revno(self, revno):
 
656
        """\
 
657
        Check whether a revno corresponds to any revision.
 
658
        Zero (the NULL revision) is considered valid.
 
659
        """
 
660
        if revno != 0:
 
661
            self.check_real_revno(revno)
 
662
            
 
663
    def check_real_revno(self, revno):
 
664
        """\
 
665
        Check whether a revno corresponds to a real revision.
 
666
        Zero (the NULL revision) is considered invalid
 
667
        """
 
668
        if revno < 1 or revno > self.revno():
 
669
            raise errors.InvalidRevisionNumber(revno)
 
670
 
 
671
    @needs_read_lock
 
672
    def clone(self, to_bzrdir, revision_id=None):
 
673
        """Clone this branch into to_bzrdir preserving all semantic values.
 
674
        
 
675
        revision_id: if not None, the revision history in the new branch will
 
676
                     be truncated to end with revision_id.
 
677
        """
 
678
        result = to_bzrdir.create_branch()
 
679
        self.copy_content_into(result, revision_id=revision_id)
 
680
        return  result
 
681
 
 
682
    @needs_read_lock
 
683
    def sprout(self, to_bzrdir, revision_id=None):
 
684
        """Create a new line of development from the branch, into to_bzrdir.
 
685
 
 
686
        to_bzrdir controls the branch format.
 
687
 
 
688
        revision_id: if not None, the revision history in the new branch will
 
689
                     be truncated to end with revision_id.
 
690
        """
 
691
        result = to_bzrdir.create_branch()
 
692
        self.copy_content_into(result, revision_id=revision_id)
 
693
        result.set_parent(self.bzrdir.root_transport.base)
 
694
        return result
 
695
 
 
696
    def _synchronize_history(self, destination, revision_id):
 
697
        """Synchronize last revision and revision history between branches.
 
698
 
 
699
        This version is most efficient when the destination is also a
 
700
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
701
        history is the true lefthand parent history, and all of the revisions
 
702
        are in the destination's repository.  If not, set_revision_history
 
703
        will fail.
 
704
 
 
705
        :param destination: The branch to copy the history into
 
706
        :param revision_id: The revision-id to truncate history at.  May
 
707
          be None to copy complete history.
 
708
        """
 
709
        if revision_id == _mod_revision.NULL_REVISION:
 
710
            new_history = []
 
711
        else:
 
712
            new_history = self.revision_history()
 
713
        if revision_id is not None and new_history != []:
 
714
            try:
 
715
                new_history = new_history[:new_history.index(revision_id) + 1]
 
716
            except ValueError:
 
717
                rev = self.repository.get_revision(revision_id)
 
718
                new_history = rev.get_history(self.repository)[1:]
 
719
        destination.set_revision_history(new_history)
 
720
 
 
721
    @needs_read_lock
 
722
    def copy_content_into(self, destination, revision_id=None):
 
723
        """Copy the content of self into destination.
 
724
 
 
725
        revision_id: if not None, the revision history in the new branch will
 
726
                     be truncated to end with revision_id.
 
727
        """
 
728
        self._synchronize_history(destination, revision_id)
 
729
        try:
 
730
            parent = self.get_parent()
 
731
        except errors.InaccessibleParent, e:
 
732
            mutter('parent was not accessible to copy: %s', e)
 
733
        else:
 
734
            if parent:
 
735
                destination.set_parent(parent)
 
736
        self.tags.merge_to(destination.tags)
 
737
 
 
738
    @needs_read_lock
 
739
    def check(self):
 
740
        """Check consistency of the branch.
 
741
 
 
742
        In particular this checks that revisions given in the revision-history
 
743
        do actually match up in the revision graph, and that they're all 
 
744
        present in the repository.
 
745
        
 
746
        Callers will typically also want to check the repository.
 
747
 
 
748
        :return: A BranchCheckResult.
 
749
        """
 
750
        mainline_parent_id = None
 
751
        last_revno, last_revision_id = self.last_revision_info()
 
752
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
753
                                last_revision_id))
 
754
        real_rev_history.reverse()
 
755
        if len(real_rev_history) != last_revno:
 
756
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
757
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
758
        # TODO: We should probably also check that real_rev_history actually
 
759
        #       matches self.revision_history()
 
760
        for revision_id in real_rev_history:
 
761
            try:
 
762
                revision = self.repository.get_revision(revision_id)
 
763
            except errors.NoSuchRevision, e:
 
764
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
765
                            % revision_id)
 
766
            # In general the first entry on the revision history has no parents.
 
767
            # But it's not illegal for it to have parents listed; this can happen
 
768
            # in imports from Arch when the parents weren't reachable.
 
769
            if mainline_parent_id is not None:
 
770
                if mainline_parent_id not in revision.parent_ids:
 
771
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
772
                                        "parents of {%s}"
 
773
                                        % (mainline_parent_id, revision_id))
 
774
            mainline_parent_id = revision_id
 
775
        return BranchCheckResult(self)
 
776
 
 
777
    def _get_checkout_format(self):
 
778
        """Return the most suitable metadir for a checkout of this branch.
 
779
        Weaves are used if this branch's repository uses weaves.
 
780
        """
 
781
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
782
            from bzrlib.repofmt import weaverepo
 
783
            format = bzrdir.BzrDirMetaFormat1()
 
784
            format.repository_format = weaverepo.RepositoryFormat7()
 
785
        else:
 
786
            format = self.repository.bzrdir.checkout_metadir()
 
787
            format.set_branch_format(self._format)
 
788
        return format
 
789
 
 
790
    def create_checkout(self, to_location, revision_id=None,
 
791
                        lightweight=False, accelerator_tree=None,
 
792
                        hardlink=False):
 
793
        """Create a checkout of a branch.
 
794
        
 
795
        :param to_location: The url to produce the checkout at
 
796
        :param revision_id: The revision to check out
 
797
        :param lightweight: If True, produce a lightweight checkout, otherwise,
 
798
        produce a bound branch (heavyweight checkout)
 
799
        :param accelerator_tree: A tree which can be used for retrieving file
 
800
            contents more quickly than the revision tree, i.e. a workingtree.
 
801
            The revision tree will be used for cases where accelerator_tree's
 
802
            content is different.
 
803
        :param hardlink: If true, hard-link files from accelerator_tree,
 
804
            where possible.
 
805
        :return: The tree of the created checkout
 
806
        """
 
807
        t = transport.get_transport(to_location)
 
808
        t.ensure_base()
 
809
        if lightweight:
 
810
            format = self._get_checkout_format()
 
811
            checkout = format.initialize_on_transport(t)
 
812
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
813
        else:
 
814
            format = self._get_checkout_format()
 
815
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
816
                to_location, force_new_tree=False, format=format)
 
817
            checkout = checkout_branch.bzrdir
 
818
            checkout_branch.bind(self)
 
819
            # pull up to the specified revision_id to set the initial 
 
820
            # branch tip correctly, and seed it with history.
 
821
            checkout_branch.pull(self, stop_revision=revision_id)
 
822
            from_branch=None
 
823
        tree = checkout.create_workingtree(revision_id,
 
824
                                           from_branch=from_branch,
 
825
                                           accelerator_tree=accelerator_tree,
 
826
                                           hardlink=hardlink)
 
827
        basis_tree = tree.basis_tree()
 
828
        basis_tree.lock_read()
 
829
        try:
 
830
            for path, file_id in basis_tree.iter_references():
 
831
                reference_parent = self.reference_parent(file_id, path)
 
832
                reference_parent.create_checkout(tree.abspath(path),
 
833
                    basis_tree.get_reference_revision(file_id, path),
 
834
                    lightweight)
 
835
        finally:
 
836
            basis_tree.unlock()
 
837
        return tree
 
838
 
 
839
    @needs_write_lock
 
840
    def reconcile(self, thorough=True):
 
841
        """Make sure the data stored in this branch is consistent."""
 
842
        from bzrlib.reconcile import BranchReconciler
 
843
        reconciler = BranchReconciler(self, thorough=thorough)
 
844
        reconciler.reconcile()
 
845
        return reconciler
 
846
 
 
847
    def reference_parent(self, file_id, path):
 
848
        """Return the parent branch for a tree-reference file_id
 
849
        :param file_id: The file_id of the tree reference
 
850
        :param path: The path of the file_id in the tree
 
851
        :return: A branch associated with the file_id
 
852
        """
 
853
        # FIXME should provide multiple branches, based on config
 
854
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
855
 
 
856
    def supports_tags(self):
 
857
        return self._format.supports_tags()
 
858
 
 
859
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
 
860
                                         other_branch):
 
861
        """Ensure that revision_b is a descendant of revision_a.
 
862
 
 
863
        This is a helper function for update_revisions.
 
864
        
 
865
        :raises: DivergedBranches if revision_b has diverged from revision_a.
 
866
        :returns: True if revision_b is a descendant of revision_a.
 
867
        """
 
868
        relation = self._revision_relations(revision_a, revision_b, graph)
 
869
        if relation == 'b_descends_from_a':
 
870
            return True
 
871
        elif relation == 'diverged':
 
872
            raise errors.DivergedBranches(self, other_branch)
 
873
        elif relation == 'a_descends_from_b':
 
874
            return False
 
875
        else:
 
876
            raise AssertionError("invalid relation: %r" % (relation,))
 
877
 
 
878
    def _revision_relations(self, revision_a, revision_b, graph):
 
879
        """Determine the relationship between two revisions.
 
880
        
 
881
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
 
882
        """
 
883
        heads = graph.heads([revision_a, revision_b])
 
884
        if heads == set([revision_b]):
 
885
            return 'b_descends_from_a'
 
886
        elif heads == set([revision_a, revision_b]):
 
887
            # These branches have diverged
 
888
            return 'diverged'
 
889
        elif heads == set([revision_a]):
 
890
            return 'a_descends_from_b'
 
891
        else:
 
892
            raise AssertionError("invalid heads: %r" % (heads,))
 
893
 
 
894
 
 
895
class BranchFormat(object):
 
896
    """An encapsulation of the initialization and open routines for a format.
 
897
 
 
898
    Formats provide three things:
 
899
     * An initialization routine,
 
900
     * a format string,
 
901
     * an open routine.
 
902
 
 
903
    Formats are placed in an dict by their format string for reference 
 
904
    during branch opening. Its not required that these be instances, they
 
905
    can be classes themselves with class methods - it simply depends on 
 
906
    whether state is needed for a given format or not.
 
907
 
 
908
    Once a format is deprecated, just deprecate the initialize and open
 
909
    methods on the format class. Do not deprecate the object, as the 
 
910
    object will be created every time regardless.
 
911
    """
 
912
 
 
913
    _default_format = None
 
914
    """The default format used for new branches."""
 
915
 
 
916
    _formats = {}
 
917
    """The known formats."""
 
918
 
 
919
    def __eq__(self, other):
 
920
        return self.__class__ is other.__class__
 
921
 
 
922
    def __ne__(self, other):
 
923
        return not (self == other)
 
924
 
 
925
    @classmethod
 
926
    def find_format(klass, a_bzrdir):
 
927
        """Return the format for the branch object in a_bzrdir."""
 
928
        try:
 
929
            transport = a_bzrdir.get_branch_transport(None)
 
930
            format_string = transport.get("format").read()
 
931
            return klass._formats[format_string]
 
932
        except errors.NoSuchFile:
 
933
            raise errors.NotBranchError(path=transport.base)
 
934
        except KeyError:
 
935
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
936
 
 
937
    @classmethod
 
938
    def get_default_format(klass):
 
939
        """Return the current default format."""
 
940
        return klass._default_format
 
941
 
 
942
    def get_reference(self, a_bzrdir):
 
943
        """Get the target reference of the branch in a_bzrdir.
 
944
 
 
945
        format probing must have been completed before calling
 
946
        this method - it is assumed that the format of the branch
 
947
        in a_bzrdir is correct.
 
948
 
 
949
        :param a_bzrdir: The bzrdir to get the branch data from.
 
950
        :return: None if the branch is not a reference branch.
 
951
        """
 
952
        return None
 
953
 
 
954
    @classmethod
 
955
    def set_reference(self, a_bzrdir, to_branch):
 
956
        """Set the target reference of the branch in a_bzrdir.
 
957
 
 
958
        format probing must have been completed before calling
 
959
        this method - it is assumed that the format of the branch
 
960
        in a_bzrdir is correct.
 
961
 
 
962
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
963
        :param to_branch: branch that the checkout is to reference
 
964
        """
 
965
        raise NotImplementedError(self.set_reference)
 
966
 
 
967
    def get_format_string(self):
 
968
        """Return the ASCII format string that identifies this format."""
 
969
        raise NotImplementedError(self.get_format_string)
 
970
 
 
971
    def get_format_description(self):
 
972
        """Return the short format description for this format."""
 
973
        raise NotImplementedError(self.get_format_description)
 
974
 
 
975
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
976
                           set_format=True):
 
977
        """Initialize a branch in a bzrdir, with specified files
 
978
 
 
979
        :param a_bzrdir: The bzrdir to initialize the branch in
 
980
        :param utf8_files: The files to create as a list of
 
981
            (filename, content) tuples
 
982
        :param set_format: If True, set the format with
 
983
            self.get_format_string.  (BzrBranch4 has its format set
 
984
            elsewhere)
 
985
        :return: a branch in this format
 
986
        """
 
987
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
988
        branch_transport = a_bzrdir.get_branch_transport(self)
 
989
        lock_map = {
 
990
            'metadir': ('lock', lockdir.LockDir),
 
991
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
992
        }
 
993
        lock_name, lock_class = lock_map[lock_type]
 
994
        control_files = lockable_files.LockableFiles(branch_transport,
 
995
            lock_name, lock_class)
 
996
        control_files.create_lock()
 
997
        control_files.lock_write()
 
998
        if set_format:
 
999
            utf8_files += [('format', self.get_format_string())]
 
1000
        try:
 
1001
            for (filename, content) in utf8_files:
 
1002
                branch_transport.put_bytes(
 
1003
                    filename, content,
 
1004
                    mode=a_bzrdir._get_file_mode())
 
1005
        finally:
 
1006
            control_files.unlock()
 
1007
        return self.open(a_bzrdir, _found=True)
 
1008
 
 
1009
    def initialize(self, a_bzrdir):
 
1010
        """Create a branch of this format in a_bzrdir."""
 
1011
        raise NotImplementedError(self.initialize)
 
1012
 
 
1013
    def is_supported(self):
 
1014
        """Is this format supported?
 
1015
 
 
1016
        Supported formats can be initialized and opened.
 
1017
        Unsupported formats may not support initialization or committing or 
 
1018
        some other features depending on the reason for not being supported.
 
1019
        """
 
1020
        return True
 
1021
 
 
1022
    def open(self, a_bzrdir, _found=False):
 
1023
        """Return the branch object for a_bzrdir
 
1024
 
 
1025
        _found is a private parameter, do not use it. It is used to indicate
 
1026
               if format probing has already be done.
 
1027
        """
 
1028
        raise NotImplementedError(self.open)
 
1029
 
 
1030
    @classmethod
 
1031
    def register_format(klass, format):
 
1032
        klass._formats[format.get_format_string()] = format
 
1033
 
 
1034
    @classmethod
 
1035
    def set_default_format(klass, format):
 
1036
        klass._default_format = format
 
1037
 
 
1038
    def supports_stacking(self):
 
1039
        """True if this format records a stacked-on branch."""
 
1040
        return False
 
1041
 
 
1042
    @classmethod
 
1043
    def unregister_format(klass, format):
 
1044
        del klass._formats[format.get_format_string()]
 
1045
 
 
1046
    def __str__(self):
 
1047
        return self.get_format_string().rstrip()
 
1048
 
 
1049
    def supports_tags(self):
 
1050
        """True if this format supports tags stored in the branch"""
 
1051
        return False  # by default
 
1052
 
 
1053
 
 
1054
class BranchHooks(Hooks):
 
1055
    """A dictionary mapping hook name to a list of callables for branch hooks.
 
1056
    
 
1057
    e.g. ['set_rh'] Is the list of items to be called when the
 
1058
    set_revision_history function is invoked.
 
1059
    """
 
1060
 
 
1061
    def __init__(self):
 
1062
        """Create the default hooks.
 
1063
 
 
1064
        These are all empty initially, because by default nothing should get
 
1065
        notified.
 
1066
        """
 
1067
        Hooks.__init__(self)
 
1068
        # Introduced in 0.15:
 
1069
        # invoked whenever the revision history has been set
 
1070
        # with set_revision_history. The api signature is
 
1071
        # (branch, revision_history), and the branch will
 
1072
        # be write-locked.
 
1073
        self['set_rh'] = []
 
1074
        # Invoked after a branch is opened. The api signature is (branch).
 
1075
        self['open'] = []
 
1076
        # invoked after a push operation completes.
 
1077
        # the api signature is
 
1078
        # (push_result)
 
1079
        # containing the members
 
1080
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1081
        # where local is the local target branch or None, master is the target 
 
1082
        # master branch, and the rest should be self explanatory. The source
 
1083
        # is read locked and the target branches write locked. Source will
 
1084
        # be the local low-latency branch.
 
1085
        self['post_push'] = []
 
1086
        # invoked after a pull operation completes.
 
1087
        # the api signature is
 
1088
        # (pull_result)
 
1089
        # containing the members
 
1090
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1091
        # where local is the local branch or None, master is the target 
 
1092
        # master branch, and the rest should be self explanatory. The source
 
1093
        # is read locked and the target branches write locked. The local
 
1094
        # branch is the low-latency branch.
 
1095
        self['post_pull'] = []
 
1096
        # invoked before a commit operation takes place.
 
1097
        # the api signature is
 
1098
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1099
        #  tree_delta, future_tree).
 
1100
        # old_revid is NULL_REVISION for the first commit to a branch
 
1101
        # tree_delta is a TreeDelta object describing changes from the basis
 
1102
        # revision, hooks MUST NOT modify this delta
 
1103
        # future_tree is an in-memory tree obtained from
 
1104
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1105
        self['pre_commit'] = []
 
1106
        # invoked after a commit operation completes.
 
1107
        # the api signature is 
 
1108
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1109
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1110
        self['post_commit'] = []
 
1111
        # invoked after a uncommit operation completes.
 
1112
        # the api signature is
 
1113
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1114
        # local is the local branch or None, master is the target branch,
 
1115
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1116
        self['post_uncommit'] = []
 
1117
        # Introduced in 1.6
 
1118
        # Invoked before the tip of a branch changes.
 
1119
        # the api signature is
 
1120
        # (params) where params is a ChangeBranchTipParams with the members
 
1121
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1122
        self['pre_change_branch_tip'] = []
 
1123
        # Introduced in 1.4
 
1124
        # Invoked after the tip of a branch changes.
 
1125
        # the api signature is
 
1126
        # (params) where params is a ChangeBranchTipParams with the members
 
1127
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1128
        self['post_change_branch_tip'] = []
 
1129
 
 
1130
 
 
1131
# install the default hooks into the Branch class.
 
1132
Branch.hooks = BranchHooks()
 
1133
 
 
1134
 
 
1135
class ChangeBranchTipParams(object):
 
1136
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1137
 
 
1138
    There are 5 fields that hooks may wish to access:
 
1139
 
 
1140
    :ivar branch: the branch being changed
 
1141
    :ivar old_revno: revision number before the change
 
1142
    :ivar new_revno: revision number after the change
 
1143
    :ivar old_revid: revision id before the change
 
1144
    :ivar new_revid: revision id after the change
 
1145
 
 
1146
    The revid fields are strings. The revno fields are integers.
 
1147
    """
 
1148
 
 
1149
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
 
1150
        """Create a group of ChangeBranchTip parameters.
 
1151
 
 
1152
        :param branch: The branch being changed.
 
1153
        :param old_revno: Revision number before the change.
 
1154
        :param new_revno: Revision number after the change.
 
1155
        :param old_revid: Tip revision id before the change.
 
1156
        :param new_revid: Tip revision id after the change.
 
1157
        """
 
1158
        self.branch = branch
 
1159
        self.old_revno = old_revno
 
1160
        self.new_revno = new_revno
 
1161
        self.old_revid = old_revid
 
1162
        self.new_revid = new_revid
 
1163
 
 
1164
    def __eq__(self, other):
 
1165
        return self.__dict__ == other.__dict__
 
1166
    
 
1167
    def __repr__(self):
 
1168
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
 
1169
            self.__class__.__name__, self.branch, 
 
1170
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
 
1171
 
 
1172
 
 
1173
class BzrBranchFormat4(BranchFormat):
 
1174
    """Bzr branch format 4.
 
1175
 
 
1176
    This format has:
 
1177
     - a revision-history file.
 
1178
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1179
    """
 
1180
 
 
1181
    def get_format_description(self):
 
1182
        """See BranchFormat.get_format_description()."""
 
1183
        return "Branch format 4"
 
1184
 
 
1185
    def initialize(self, a_bzrdir):
 
1186
        """Create a branch of this format in a_bzrdir."""
 
1187
        utf8_files = [('revision-history', ''),
 
1188
                      ('branch-name', ''),
 
1189
                      ]
 
1190
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1191
                                       lock_type='branch4', set_format=False)
 
1192
 
 
1193
    def __init__(self):
 
1194
        super(BzrBranchFormat4, self).__init__()
 
1195
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1196
 
 
1197
    def open(self, a_bzrdir, _found=False):
 
1198
        """Return the branch object for a_bzrdir
 
1199
 
 
1200
        _found is a private parameter, do not use it. It is used to indicate
 
1201
               if format probing has already be done.
 
1202
        """
 
1203
        if not _found:
 
1204
            # we are being called directly and must probe.
 
1205
            raise NotImplementedError
 
1206
        return BzrBranch(_format=self,
 
1207
                         _control_files=a_bzrdir._control_files,
 
1208
                         a_bzrdir=a_bzrdir,
 
1209
                         _repository=a_bzrdir.open_repository())
 
1210
 
 
1211
    def __str__(self):
 
1212
        return "Bazaar-NG branch format 4"
 
1213
 
 
1214
 
 
1215
class BranchFormatMetadir(BranchFormat):
 
1216
    """Common logic for meta-dir based branch formats."""
 
1217
 
 
1218
    def _branch_class(self):
 
1219
        """What class to instantiate on open calls."""
 
1220
        raise NotImplementedError(self._branch_class)
 
1221
 
 
1222
    def open(self, a_bzrdir, _found=False):
 
1223
        """Return the branch object for a_bzrdir.
 
1224
 
 
1225
        _found is a private parameter, do not use it. It is used to indicate
 
1226
               if format probing has already be done.
 
1227
        """
 
1228
        if not _found:
 
1229
            format = BranchFormat.find_format(a_bzrdir)
 
1230
            if format.__class__ != self.__class__:
 
1231
                raise AssertionError("wrong format %r found for %r" %
 
1232
                    (format, self))
 
1233
        try:
 
1234
            transport = a_bzrdir.get_branch_transport(None)
 
1235
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
1236
                                                         lockdir.LockDir)
 
1237
            return self._branch_class()(_format=self,
 
1238
                              _control_files=control_files,
 
1239
                              a_bzrdir=a_bzrdir,
 
1240
                              _repository=a_bzrdir.find_repository())
 
1241
        except errors.NoSuchFile:
 
1242
            raise errors.NotBranchError(path=transport.base)
 
1243
 
 
1244
    def __init__(self):
 
1245
        super(BranchFormatMetadir, self).__init__()
 
1246
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1247
 
 
1248
    def supports_tags(self):
 
1249
        return True
 
1250
 
 
1251
 
 
1252
class BzrBranchFormat5(BranchFormatMetadir):
 
1253
    """Bzr branch format 5.
 
1254
 
 
1255
    This format has:
 
1256
     - a revision-history file.
 
1257
     - a format string
 
1258
     - a lock dir guarding the branch itself
 
1259
     - all of this stored in a branch/ subdirectory
 
1260
     - works with shared repositories.
 
1261
 
 
1262
    This format is new in bzr 0.8.
 
1263
    """
 
1264
 
 
1265
    def _branch_class(self):
 
1266
        return BzrBranch5
 
1267
 
 
1268
    def get_format_string(self):
 
1269
        """See BranchFormat.get_format_string()."""
 
1270
        return "Bazaar-NG branch format 5\n"
 
1271
 
 
1272
    def get_format_description(self):
 
1273
        """See BranchFormat.get_format_description()."""
 
1274
        return "Branch format 5"
 
1275
        
 
1276
    def initialize(self, a_bzrdir):
 
1277
        """Create a branch of this format in a_bzrdir."""
 
1278
        utf8_files = [('revision-history', ''),
 
1279
                      ('branch-name', ''),
 
1280
                      ]
 
1281
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1282
 
 
1283
    def supports_tags(self):
 
1284
        return False
 
1285
 
 
1286
 
 
1287
class BzrBranchFormat6(BranchFormatMetadir):
 
1288
    """Branch format with last-revision and tags.
 
1289
 
 
1290
    Unlike previous formats, this has no explicit revision history. Instead,
 
1291
    this just stores the last-revision, and the left-hand history leading
 
1292
    up to there is the history.
 
1293
 
 
1294
    This format was introduced in bzr 0.15
 
1295
    and became the default in 0.91.
 
1296
    """
 
1297
 
 
1298
    def _branch_class(self):
 
1299
        return BzrBranch6
 
1300
 
 
1301
    def get_format_string(self):
 
1302
        """See BranchFormat.get_format_string()."""
 
1303
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
 
1304
 
 
1305
    def get_format_description(self):
 
1306
        """See BranchFormat.get_format_description()."""
 
1307
        return "Branch format 6"
 
1308
 
 
1309
    def initialize(self, a_bzrdir):
 
1310
        """Create a branch of this format in a_bzrdir."""
 
1311
        utf8_files = [('last-revision', '0 null:\n'),
 
1312
                      ('branch.conf', ''),
 
1313
                      ('tags', ''),
 
1314
                      ]
 
1315
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1316
 
 
1317
 
 
1318
class BzrBranchFormat7(BranchFormatMetadir):
 
1319
    """Branch format with last-revision, tags, and a stacked location pointer.
 
1320
 
 
1321
    The stacked location pointer is passed down to the repository and requires
 
1322
    a repository format with supports_external_lookups = True.
 
1323
 
 
1324
    This format was introduced in bzr 1.6.
 
1325
    """
 
1326
 
 
1327
    def _branch_class(self):
 
1328
        return BzrBranch7
 
1329
 
 
1330
    def get_format_string(self):
 
1331
        """See BranchFormat.get_format_string()."""
 
1332
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
 
1333
 
 
1334
    def get_format_description(self):
 
1335
        """See BranchFormat.get_format_description()."""
 
1336
        return "Branch format 7"
 
1337
 
 
1338
    def initialize(self, a_bzrdir):
 
1339
        """Create a branch of this format in a_bzrdir."""
 
1340
        utf8_files = [('last-revision', '0 null:\n'),
 
1341
                      ('branch.conf', ''),
 
1342
                      ('tags', ''),
 
1343
                      ]
 
1344
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1345
 
 
1346
    def __init__(self):
 
1347
        super(BzrBranchFormat7, self).__init__()
 
1348
        self._matchingbzrdir.repository_format = \
 
1349
            RepositoryFormatKnitPack5RichRoot()
 
1350
 
 
1351
    def supports_stacking(self):
 
1352
        return True
 
1353
 
 
1354
 
 
1355
class BranchReferenceFormat(BranchFormat):
 
1356
    """Bzr branch reference format.
 
1357
 
 
1358
    Branch references are used in implementing checkouts, they
 
1359
    act as an alias to the real branch which is at some other url.
 
1360
 
 
1361
    This format has:
 
1362
     - A location file
 
1363
     - a format string
 
1364
    """
 
1365
 
 
1366
    def get_format_string(self):
 
1367
        """See BranchFormat.get_format_string()."""
 
1368
        return "Bazaar-NG Branch Reference Format 1\n"
 
1369
 
 
1370
    def get_format_description(self):
 
1371
        """See BranchFormat.get_format_description()."""
 
1372
        return "Checkout reference format 1"
 
1373
 
 
1374
    def get_reference(self, a_bzrdir):
 
1375
        """See BranchFormat.get_reference()."""
 
1376
        transport = a_bzrdir.get_branch_transport(None)
 
1377
        return transport.get('location').read()
 
1378
 
 
1379
    def set_reference(self, a_bzrdir, to_branch):
 
1380
        """See BranchFormat.set_reference()."""
 
1381
        transport = a_bzrdir.get_branch_transport(None)
 
1382
        location = transport.put_bytes('location', to_branch.base)
 
1383
 
 
1384
    def initialize(self, a_bzrdir, target_branch=None):
 
1385
        """Create a branch of this format in a_bzrdir."""
 
1386
        if target_branch is None:
 
1387
            # this format does not implement branch itself, thus the implicit
 
1388
            # creation contract must see it as uninitializable
 
1389
            raise errors.UninitializableFormat(self)
 
1390
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1391
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1392
        branch_transport.put_bytes('location',
 
1393
            target_branch.bzrdir.root_transport.base)
 
1394
        branch_transport.put_bytes('format', self.get_format_string())
 
1395
        return self.open(
 
1396
            a_bzrdir, _found=True,
 
1397
            possible_transports=[target_branch.bzrdir.root_transport])
 
1398
 
 
1399
    def __init__(self):
 
1400
        super(BranchReferenceFormat, self).__init__()
 
1401
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1402
 
 
1403
    def _make_reference_clone_function(format, a_branch):
 
1404
        """Create a clone() routine for a branch dynamically."""
 
1405
        def clone(to_bzrdir, revision_id=None):
 
1406
            """See Branch.clone()."""
 
1407
            return format.initialize(to_bzrdir, a_branch)
 
1408
            # cannot obey revision_id limits when cloning a reference ...
 
1409
            # FIXME RBC 20060210 either nuke revision_id for clone, or
 
1410
            # emit some sort of warning/error to the caller ?!
 
1411
        return clone
 
1412
 
 
1413
    def open(self, a_bzrdir, _found=False, location=None,
 
1414
             possible_transports=None):
 
1415
        """Return the branch that the branch reference in a_bzrdir points at.
 
1416
 
 
1417
        _found is a private parameter, do not use it. It is used to indicate
 
1418
               if format probing has already be done.
 
1419
        """
 
1420
        if not _found:
 
1421
            format = BranchFormat.find_format(a_bzrdir)
 
1422
            if format.__class__ != self.__class__:
 
1423
                raise AssertionError("wrong format %r found for %r" %
 
1424
                    (format, self))
 
1425
        if location is None:
 
1426
            location = self.get_reference(a_bzrdir)
 
1427
        real_bzrdir = bzrdir.BzrDir.open(
 
1428
            location, possible_transports=possible_transports)
 
1429
        result = real_bzrdir.open_branch()
 
1430
        # this changes the behaviour of result.clone to create a new reference
 
1431
        # rather than a copy of the content of the branch.
 
1432
        # I did not use a proxy object because that needs much more extensive
 
1433
        # testing, and we are only changing one behaviour at the moment.
 
1434
        # If we decide to alter more behaviours - i.e. the implicit nickname
 
1435
        # then this should be refactored to introduce a tested proxy branch
 
1436
        # and a subclass of that for use in overriding clone() and ....
 
1437
        # - RBC 20060210
 
1438
        result.clone = self._make_reference_clone_function(result)
 
1439
        return result
 
1440
 
 
1441
 
 
1442
# formats which have no format string are not discoverable
 
1443
# and not independently creatable, so are not registered.
 
1444
__format5 = BzrBranchFormat5()
 
1445
__format6 = BzrBranchFormat6()
 
1446
__format7 = BzrBranchFormat7()
 
1447
BranchFormat.register_format(__format5)
 
1448
BranchFormat.register_format(BranchReferenceFormat())
 
1449
BranchFormat.register_format(__format6)
 
1450
BranchFormat.register_format(__format7)
 
1451
BranchFormat.set_default_format(__format6)
 
1452
_legacy_formats = [BzrBranchFormat4(),
 
1453
                   ]
 
1454
 
 
1455
class BzrBranch(Branch):
 
1456
    """A branch stored in the actual filesystem.
 
1457
 
 
1458
    Note that it's "local" in the context of the filesystem; it doesn't
 
1459
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
1460
    it's writable, and can be accessed via the normal filesystem API.
 
1461
 
 
1462
    :ivar _transport: Transport for file operations on this branch's 
 
1463
        control files, typically pointing to the .bzr/branch directory.
 
1464
    :ivar repository: Repository for this branch.
 
1465
    :ivar base: The url of the base directory for this branch; the one 
 
1466
        containing the .bzr directory.
 
1467
    """
 
1468
    
 
1469
    def __init__(self, _format=None,
 
1470
                 _control_files=None, a_bzrdir=None, _repository=None):
 
1471
        """Create new branch object at a particular location."""
 
1472
        if a_bzrdir is None:
 
1473
            raise ValueError('a_bzrdir must be supplied')
 
1474
        else:
 
1475
            self.bzrdir = a_bzrdir
 
1476
        self._base = self.bzrdir.transport.clone('..').base
 
1477
        # XXX: We should be able to just do
 
1478
        #   self.base = self.bzrdir.root_transport.base
 
1479
        # but this does not quite work yet -- mbp 20080522
 
1480
        self._format = _format
 
1481
        if _control_files is None:
 
1482
            raise ValueError('BzrBranch _control_files is None')
 
1483
        self.control_files = _control_files
 
1484
        self._transport = _control_files._transport
 
1485
        self.repository = _repository
 
1486
        Branch.__init__(self)
 
1487
 
 
1488
    def __str__(self):
 
1489
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
1490
 
 
1491
    __repr__ = __str__
 
1492
 
 
1493
    def _get_base(self):
 
1494
        """Returns the directory containing the control directory."""
 
1495
        return self._base
 
1496
 
 
1497
    base = property(_get_base, doc="The URL for the root of this branch.")
 
1498
 
 
1499
    def is_locked(self):
 
1500
        return self.control_files.is_locked()
 
1501
 
 
1502
    def lock_write(self, token=None):
 
1503
        repo_token = self.repository.lock_write()
 
1504
        try:
 
1505
            token = self.control_files.lock_write(token=token)
 
1506
        except:
 
1507
            self.repository.unlock()
 
1508
            raise
 
1509
        return token
 
1510
 
 
1511
    def lock_read(self):
 
1512
        self.repository.lock_read()
 
1513
        try:
 
1514
            self.control_files.lock_read()
 
1515
        except:
 
1516
            self.repository.unlock()
 
1517
            raise
 
1518
 
 
1519
    def unlock(self):
 
1520
        # TODO: test for failed two phase locks. This is known broken.
 
1521
        try:
 
1522
            self.control_files.unlock()
 
1523
        finally:
 
1524
            self.repository.unlock()
 
1525
        if not self.control_files.is_locked():
 
1526
            # we just released the lock
 
1527
            self._clear_cached_state()
 
1528
        
 
1529
    def peek_lock_mode(self):
 
1530
        if self.control_files._lock_count == 0:
 
1531
            return None
 
1532
        else:
 
1533
            return self.control_files._lock_mode
 
1534
 
 
1535
    def get_physical_lock_status(self):
 
1536
        return self.control_files.get_physical_lock_status()
 
1537
 
 
1538
    @needs_read_lock
 
1539
    def print_file(self, file, revision_id):
 
1540
        """See Branch.print_file."""
 
1541
        return self.repository.print_file(file, revision_id)
 
1542
 
 
1543
    def _write_revision_history(self, history):
 
1544
        """Factored out of set_revision_history.
 
1545
 
 
1546
        This performs the actual writing to disk.
 
1547
        It is intended to be called by BzrBranch5.set_revision_history."""
 
1548
        self._transport.put_bytes(
 
1549
            'revision-history', '\n'.join(history),
 
1550
            mode=self.bzrdir._get_file_mode())
 
1551
 
 
1552
    @needs_write_lock
 
1553
    def set_revision_history(self, rev_history):
 
1554
        """See Branch.set_revision_history."""
 
1555
        if 'evil' in debug.debug_flags:
 
1556
            mutter_callsite(3, "set_revision_history scales with history.")
 
1557
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1558
        for rev_id in rev_history:
 
1559
            check_not_reserved_id(rev_id)
 
1560
        if Branch.hooks['post_change_branch_tip']:
 
1561
            # Don't calculate the last_revision_info() if there are no hooks
 
1562
            # that will use it.
 
1563
            old_revno, old_revid = self.last_revision_info()
 
1564
        if len(rev_history) == 0:
 
1565
            revid = _mod_revision.NULL_REVISION
 
1566
        else:
 
1567
            revid = rev_history[-1]
 
1568
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
1569
        self._write_revision_history(rev_history)
 
1570
        self._clear_cached_state()
 
1571
        self._cache_revision_history(rev_history)
 
1572
        for hook in Branch.hooks['set_rh']:
 
1573
            hook(self, rev_history)
 
1574
        if Branch.hooks['post_change_branch_tip']:
 
1575
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
1576
 
 
1577
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1578
        """Run the pre_change_branch_tip hooks."""
 
1579
        hooks = Branch.hooks['pre_change_branch_tip']
 
1580
        if not hooks:
 
1581
            return
 
1582
        old_revno, old_revid = self.last_revision_info()
 
1583
        params = ChangeBranchTipParams(
 
1584
            self, old_revno, new_revno, old_revid, new_revid)
 
1585
        for hook in hooks:
 
1586
            try:
 
1587
                hook(params)
 
1588
            except errors.TipChangeRejected:
 
1589
                raise
 
1590
            except Exception:
 
1591
                exc_info = sys.exc_info()
 
1592
                hook_name = Branch.hooks.get_hook_name(hook)
 
1593
                raise errors.HookFailed(
 
1594
                    'pre_change_branch_tip', hook_name, exc_info)
 
1595
 
 
1596
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1597
        """Run the post_change_branch_tip hooks."""
 
1598
        hooks = Branch.hooks['post_change_branch_tip']
 
1599
        if not hooks:
 
1600
            return
 
1601
        new_revno, new_revid = self.last_revision_info()
 
1602
        params = ChangeBranchTipParams(
 
1603
            self, old_revno, new_revno, old_revid, new_revid)
 
1604
        for hook in hooks:
 
1605
            hook(params)
 
1606
 
 
1607
    @needs_write_lock
 
1608
    def set_last_revision_info(self, revno, revision_id):
 
1609
        """Set the last revision of this branch.
 
1610
 
 
1611
        The caller is responsible for checking that the revno is correct
 
1612
        for this revision id.
 
1613
 
 
1614
        It may be possible to set the branch last revision to an id not
 
1615
        present in the repository.  However, branches can also be 
 
1616
        configured to check constraints on history, in which case this may not
 
1617
        be permitted.
 
1618
        """
 
1619
        revision_id = _mod_revision.ensure_null(revision_id)
 
1620
        # this old format stores the full history, but this api doesn't
 
1621
        # provide it, so we must generate, and might as well check it's
 
1622
        # correct
 
1623
        history = self._lefthand_history(revision_id)
 
1624
        if len(history) != revno:
 
1625
            raise AssertionError('%d != %d' % (len(history), revno))
 
1626
        self.set_revision_history(history)
 
1627
 
 
1628
    def _gen_revision_history(self):
 
1629
        history = self._transport.get_bytes('revision-history').split('\n')
 
1630
        if history[-1:] == ['']:
 
1631
            # There shouldn't be a trailing newline, but just in case.
 
1632
            history.pop()
 
1633
        return history
 
1634
 
 
1635
    def _lefthand_history(self, revision_id, last_rev=None,
 
1636
                          other_branch=None):
 
1637
        if 'evil' in debug.debug_flags:
 
1638
            mutter_callsite(4, "_lefthand_history scales with history.")
 
1639
        # stop_revision must be a descendant of last_revision
 
1640
        graph = self.repository.get_graph()
 
1641
        if last_rev is not None:
 
1642
            if not graph.is_ancestor(last_rev, revision_id):
 
1643
                # our previous tip is not merged into stop_revision
 
1644
                raise errors.DivergedBranches(self, other_branch)
 
1645
        # make a new revision history from the graph
 
1646
        parents_map = graph.get_parent_map([revision_id])
 
1647
        if revision_id not in parents_map:
 
1648
            raise errors.NoSuchRevision(self, revision_id)
 
1649
        current_rev_id = revision_id
 
1650
        new_history = []
 
1651
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1652
        # Do not include ghosts or graph origin in revision_history
 
1653
        while (current_rev_id in parents_map and
 
1654
               len(parents_map[current_rev_id]) > 0):
 
1655
            check_not_reserved_id(current_rev_id)
 
1656
            new_history.append(current_rev_id)
 
1657
            current_rev_id = parents_map[current_rev_id][0]
 
1658
            parents_map = graph.get_parent_map([current_rev_id])
 
1659
        new_history.reverse()
 
1660
        return new_history
 
1661
 
 
1662
    @needs_write_lock
 
1663
    def generate_revision_history(self, revision_id, last_rev=None,
 
1664
        other_branch=None):
 
1665
        """Create a new revision history that will finish with revision_id.
 
1666
 
 
1667
        :param revision_id: the new tip to use.
 
1668
        :param last_rev: The previous last_revision. If not None, then this
 
1669
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
1670
        :param other_branch: The other branch that DivergedBranches should
 
1671
            raise with respect to.
 
1672
        """
 
1673
        self.set_revision_history(self._lefthand_history(revision_id,
 
1674
            last_rev, other_branch))
 
1675
 
 
1676
    def basis_tree(self):
 
1677
        """See Branch.basis_tree."""
 
1678
        return self.repository.revision_tree(self.last_revision())
 
1679
 
 
1680
    @needs_write_lock
 
1681
    def pull(self, source, overwrite=False, stop_revision=None,
 
1682
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1683
             _override_hook_target=None):
 
1684
        """See Branch.pull.
 
1685
 
 
1686
        :param _hook_master: Private parameter - set the branch to 
 
1687
            be supplied as the master to pull hooks.
 
1688
        :param run_hooks: Private parameter - if false, this branch
 
1689
            is being called because it's the master of the primary branch,
 
1690
            so it should not run its hooks.
 
1691
        :param _override_hook_target: Private parameter - set the branch to be
 
1692
            supplied as the target_branch to pull hooks.
 
1693
        """
 
1694
        result = PullResult()
 
1695
        result.source_branch = source
 
1696
        if _override_hook_target is None:
 
1697
            result.target_branch = self
 
1698
        else:
 
1699
            result.target_branch = _override_hook_target
 
1700
        source.lock_read()
 
1701
        try:
 
1702
            # We assume that during 'pull' the local repository is closer than
 
1703
            # the remote one.
 
1704
            graph = self.repository.get_graph(source.repository)
 
1705
            result.old_revno, result.old_revid = self.last_revision_info()
 
1706
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1707
                                  graph=graph)
 
1708
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1709
            result.new_revno, result.new_revid = self.last_revision_info()
 
1710
            if _hook_master:
 
1711
                result.master_branch = _hook_master
 
1712
                result.local_branch = result.target_branch
 
1713
            else:
 
1714
                result.master_branch = result.target_branch
 
1715
                result.local_branch = None
 
1716
            if run_hooks:
 
1717
                for hook in Branch.hooks['post_pull']:
 
1718
                    hook(result)
 
1719
        finally:
 
1720
            source.unlock()
 
1721
        return result
 
1722
 
 
1723
    def _get_parent_location(self):
 
1724
        _locs = ['parent', 'pull', 'x-pull']
 
1725
        for l in _locs:
 
1726
            try:
 
1727
                return self._transport.get_bytes(l).strip('\n')
 
1728
            except errors.NoSuchFile:
 
1729
                pass
 
1730
        return None
 
1731
 
 
1732
    @needs_read_lock
 
1733
    def push(self, target, overwrite=False, stop_revision=None,
 
1734
             _override_hook_source_branch=None):
 
1735
        """See Branch.push.
 
1736
 
 
1737
        This is the basic concrete implementation of push()
 
1738
 
 
1739
        :param _override_hook_source_branch: If specified, run
 
1740
        the hooks passing this Branch as the source, rather than self.  
 
1741
        This is for use of RemoteBranch, where push is delegated to the
 
1742
        underlying vfs-based Branch. 
 
1743
        """
 
1744
        # TODO: Public option to disable running hooks - should be trivial but
 
1745
        # needs tests.
 
1746
        return _run_with_write_locked_target(
 
1747
            target, self._push_with_bound_branches, target, overwrite,
 
1748
            stop_revision,
 
1749
            _override_hook_source_branch=_override_hook_source_branch)
 
1750
 
 
1751
    def _push_with_bound_branches(self, target, overwrite,
 
1752
            stop_revision,
 
1753
            _override_hook_source_branch=None):
 
1754
        """Push from self into target, and into target's master if any.
 
1755
        
 
1756
        This is on the base BzrBranch class even though it doesn't support 
 
1757
        bound branches because the *target* might be bound.
 
1758
        """
 
1759
        def _run_hooks():
 
1760
            if _override_hook_source_branch:
 
1761
                result.source_branch = _override_hook_source_branch
 
1762
            for hook in Branch.hooks['post_push']:
 
1763
                hook(result)
 
1764
 
 
1765
        bound_location = target.get_bound_location()
 
1766
        if bound_location and target.base != bound_location:
 
1767
            # there is a master branch.
 
1768
            #
 
1769
            # XXX: Why the second check?  Is it even supported for a branch to
 
1770
            # be bound to itself? -- mbp 20070507
 
1771
            master_branch = target.get_master_branch()
 
1772
            master_branch.lock_write()
 
1773
            try:
 
1774
                # push into the master from this branch.
 
1775
                self._basic_push(master_branch, overwrite, stop_revision)
 
1776
                # and push into the target branch from this. Note that we push from
 
1777
                # this branch again, because its considered the highest bandwidth
 
1778
                # repository.
 
1779
                result = self._basic_push(target, overwrite, stop_revision)
 
1780
                result.master_branch = master_branch
 
1781
                result.local_branch = target
 
1782
                _run_hooks()
 
1783
                return result
 
1784
            finally:
 
1785
                master_branch.unlock()
 
1786
        else:
 
1787
            # no master branch
 
1788
            result = self._basic_push(target, overwrite, stop_revision)
 
1789
            # TODO: Why set master_branch and local_branch if there's no
 
1790
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
1791
            # 20070504
 
1792
            result.master_branch = target
 
1793
            result.local_branch = None
 
1794
            _run_hooks()
 
1795
            return result
 
1796
 
 
1797
    def _basic_push(self, target, overwrite, stop_revision):
 
1798
        """Basic implementation of push without bound branches or hooks.
 
1799
 
 
1800
        Must be called with self read locked and target write locked.
 
1801
        """
 
1802
        result = PushResult()
 
1803
        result.source_branch = self
 
1804
        result.target_branch = target
 
1805
        result.old_revno, result.old_revid = target.last_revision_info()
 
1806
        if result.old_revid != self.last_revision():
 
1807
            # We assume that during 'push' this repository is closer than
 
1808
            # the target.
 
1809
            graph = self.repository.get_graph(target.repository)
 
1810
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
1811
                                    graph=graph)
 
1812
        if self._push_should_merge_tags():
 
1813
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
1814
        result.new_revno, result.new_revid = target.last_revision_info()
 
1815
        return result
 
1816
 
 
1817
    def _push_should_merge_tags(self):
 
1818
        """Should _basic_push merge this branch's tags into the target?
 
1819
        
 
1820
        The default implementation returns False if this branch has no tags,
 
1821
        and True the rest of the time.  Subclasses may override this.
 
1822
        """
 
1823
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
1824
 
 
1825
    def get_parent(self):
 
1826
        """See Branch.get_parent."""
 
1827
        parent = self._get_parent_location()
 
1828
        if parent is None:
 
1829
            return parent
 
1830
        # This is an old-format absolute path to a local branch
 
1831
        # turn it into a url
 
1832
        if parent.startswith('/'):
 
1833
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1834
        try:
 
1835
            return urlutils.join(self.base[:-1], parent)
 
1836
        except errors.InvalidURLJoin, e:
 
1837
            raise errors.InaccessibleParent(parent, self.base)
 
1838
 
 
1839
    def get_stacked_on_url(self):
 
1840
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1841
 
 
1842
    def set_push_location(self, location):
 
1843
        """See Branch.set_push_location."""
 
1844
        self.get_config().set_user_option(
 
1845
            'push_location', location,
 
1846
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
1847
 
 
1848
    @needs_write_lock
 
1849
    def set_parent(self, url):
 
1850
        """See Branch.set_parent."""
 
1851
        # TODO: Maybe delete old location files?
 
1852
        # URLs should never be unicode, even on the local fs,
 
1853
        # FIXUP this and get_parent in a future branch format bump:
 
1854
        # read and rewrite the file. RBC 20060125
 
1855
        if url is not None:
 
1856
            if isinstance(url, unicode):
 
1857
                try:
 
1858
                    url = url.encode('ascii')
 
1859
                except UnicodeEncodeError:
 
1860
                    raise errors.InvalidURL(url,
 
1861
                        "Urls must be 7-bit ascii, "
 
1862
                        "use bzrlib.urlutils.escape")
 
1863
            url = urlutils.relative_url(self.base, url)
 
1864
        self._set_parent_location(url)
 
1865
 
 
1866
    def _set_parent_location(self, url):
 
1867
        if url is None:
 
1868
            self._transport.delete('parent')
 
1869
        else:
 
1870
            self._transport.put_bytes('parent', url + '\n',
 
1871
                mode=self.bzrdir._get_file_mode())
 
1872
 
 
1873
    def set_stacked_on_url(self, url):
 
1874
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1875
 
 
1876
 
 
1877
class BzrBranch5(BzrBranch):
 
1878
    """A format 5 branch. This supports new features over plain branches.
 
1879
 
 
1880
    It has support for a master_branch which is the data for bound branches.
 
1881
    """
 
1882
 
 
1883
    @needs_write_lock
 
1884
    def pull(self, source, overwrite=False, stop_revision=None,
 
1885
             run_hooks=True, possible_transports=None,
 
1886
             _override_hook_target=None):
 
1887
        """Pull from source into self, updating my master if any.
 
1888
        
 
1889
        :param run_hooks: Private parameter - if false, this branch
 
1890
            is being called because it's the master of the primary branch,
 
1891
            so it should not run its hooks.
 
1892
        """
 
1893
        bound_location = self.get_bound_location()
 
1894
        master_branch = None
 
1895
        if bound_location and source.base != bound_location:
 
1896
            # not pulling from master, so we need to update master.
 
1897
            master_branch = self.get_master_branch(possible_transports)
 
1898
            master_branch.lock_write()
 
1899
        try:
 
1900
            if master_branch:
 
1901
                # pull from source into master.
 
1902
                master_branch.pull(source, overwrite, stop_revision,
 
1903
                    run_hooks=False)
 
1904
            return super(BzrBranch5, self).pull(source, overwrite,
 
1905
                stop_revision, _hook_master=master_branch,
 
1906
                run_hooks=run_hooks,
 
1907
                _override_hook_target=_override_hook_target)
 
1908
        finally:
 
1909
            if master_branch:
 
1910
                master_branch.unlock()
 
1911
 
 
1912
    def get_bound_location(self):
 
1913
        try:
 
1914
            return self._transport.get_bytes('bound')[:-1]
 
1915
        except errors.NoSuchFile:
 
1916
            return None
 
1917
 
 
1918
    @needs_read_lock
 
1919
    def get_master_branch(self, possible_transports=None):
 
1920
        """Return the branch we are bound to.
 
1921
        
 
1922
        :return: Either a Branch, or None
 
1923
 
 
1924
        This could memoise the branch, but if thats done
 
1925
        it must be revalidated on each new lock.
 
1926
        So for now we just don't memoise it.
 
1927
        # RBC 20060304 review this decision.
 
1928
        """
 
1929
        bound_loc = self.get_bound_location()
 
1930
        if not bound_loc:
 
1931
            return None
 
1932
        try:
 
1933
            return Branch.open(bound_loc,
 
1934
                               possible_transports=possible_transports)
 
1935
        except (errors.NotBranchError, errors.ConnectionError), e:
 
1936
            raise errors.BoundBranchConnectionFailure(
 
1937
                    self, bound_loc, e)
 
1938
 
 
1939
    @needs_write_lock
 
1940
    def set_bound_location(self, location):
 
1941
        """Set the target where this branch is bound to.
 
1942
 
 
1943
        :param location: URL to the target branch
 
1944
        """
 
1945
        if location:
 
1946
            self._transport.put_bytes('bound', location+'\n',
 
1947
                mode=self.bzrdir._get_file_mode())
 
1948
        else:
 
1949
            try:
 
1950
                self._transport.delete('bound')
 
1951
            except errors.NoSuchFile:
 
1952
                return False
 
1953
            return True
 
1954
 
 
1955
    @needs_write_lock
 
1956
    def bind(self, other):
 
1957
        """Bind this branch to the branch other.
 
1958
 
 
1959
        This does not push or pull data between the branches, though it does
 
1960
        check for divergence to raise an error when the branches are not
 
1961
        either the same, or one a prefix of the other. That behaviour may not
 
1962
        be useful, so that check may be removed in future.
 
1963
        
 
1964
        :param other: The branch to bind to
 
1965
        :type other: Branch
 
1966
        """
 
1967
        # TODO: jam 20051230 Consider checking if the target is bound
 
1968
        #       It is debatable whether you should be able to bind to
 
1969
        #       a branch which is itself bound.
 
1970
        #       Committing is obviously forbidden,
 
1971
        #       but binding itself may not be.
 
1972
        #       Since we *have* to check at commit time, we don't
 
1973
        #       *need* to check here
 
1974
 
 
1975
        # we want to raise diverged if:
 
1976
        # last_rev is not in the other_last_rev history, AND
 
1977
        # other_last_rev is not in our history, and do it without pulling
 
1978
        # history around
 
1979
        self.set_bound_location(other.base)
 
1980
 
 
1981
    @needs_write_lock
 
1982
    def unbind(self):
 
1983
        """If bound, unbind"""
 
1984
        return self.set_bound_location(None)
 
1985
 
 
1986
    @needs_write_lock
 
1987
    def update(self, possible_transports=None):
 
1988
        """Synchronise this branch with the master branch if any. 
 
1989
 
 
1990
        :return: None or the last_revision that was pivoted out during the
 
1991
                 update.
 
1992
        """
 
1993
        master = self.get_master_branch(possible_transports)
 
1994
        if master is not None:
 
1995
            old_tip = _mod_revision.ensure_null(self.last_revision())
 
1996
            self.pull(master, overwrite=True)
 
1997
            if self.repository.get_graph().is_ancestor(old_tip,
 
1998
                _mod_revision.ensure_null(self.last_revision())):
 
1999
                return None
 
2000
            return old_tip
 
2001
        return None
 
2002
 
 
2003
 
 
2004
class BzrBranch7(BzrBranch5):
 
2005
    """A branch with support for a fallback repository."""
 
2006
 
 
2007
    def _get_fallback_repository(self, url):
 
2008
        """Get the repository we fallback to at url."""
 
2009
        url = urlutils.join(self.base, url)
 
2010
        return bzrdir.BzrDir.open(url).open_branch().repository
 
2011
 
 
2012
    def _activate_fallback_location(self, url):
 
2013
        """Activate the branch/repository from url as a fallback repository."""
 
2014
        self.repository.add_fallback_repository(
 
2015
            self._get_fallback_repository(url))
 
2016
 
 
2017
    def _open_hook(self):
 
2018
        try:
 
2019
            url = self.get_stacked_on_url()
 
2020
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
 
2021
            errors.UnstackableBranchFormat):
 
2022
            pass
 
2023
        else:
 
2024
            self._activate_fallback_location(url)
 
2025
 
 
2026
    def _check_stackable_repo(self):
 
2027
        if not self.repository._format.supports_external_lookups:
 
2028
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2029
                self.repository.base)
 
2030
 
 
2031
    def __init__(self, *args, **kwargs):
 
2032
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
2033
        self._last_revision_info_cache = None
 
2034
        self._partial_revision_history_cache = []
 
2035
 
 
2036
    def _clear_cached_state(self):
 
2037
        super(BzrBranch7, self)._clear_cached_state()
 
2038
        self._last_revision_info_cache = None
 
2039
        self._partial_revision_history_cache = []
 
2040
 
 
2041
    def _last_revision_info(self):
 
2042
        revision_string = self._transport.get_bytes('last-revision')
 
2043
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2044
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2045
        revno = int(revno)
 
2046
        return revno, revision_id
 
2047
 
 
2048
    def _write_last_revision_info(self, revno, revision_id):
 
2049
        """Simply write out the revision id, with no checks.
 
2050
 
 
2051
        Use set_last_revision_info to perform this safely.
 
2052
 
 
2053
        Does not update the revision_history cache.
 
2054
        Intended to be called by set_last_revision_info and
 
2055
        _write_revision_history.
 
2056
        """
 
2057
        revision_id = _mod_revision.ensure_null(revision_id)
 
2058
        out_string = '%d %s\n' % (revno, revision_id)
 
2059
        self._transport.put_bytes('last-revision', out_string,
 
2060
            mode=self.bzrdir._get_file_mode())
 
2061
 
 
2062
    @needs_write_lock
 
2063
    def set_last_revision_info(self, revno, revision_id):
 
2064
        revision_id = _mod_revision.ensure_null(revision_id)
 
2065
        old_revno, old_revid = self.last_revision_info()
 
2066
        if self._get_append_revisions_only():
 
2067
            self._check_history_violation(revision_id)
 
2068
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2069
        self._write_last_revision_info(revno, revision_id)
 
2070
        self._clear_cached_state()
 
2071
        self._last_revision_info_cache = revno, revision_id
 
2072
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2073
 
 
2074
    def _check_history_violation(self, revision_id):
 
2075
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2076
        if _mod_revision.is_null(last_revision):
 
2077
            return
 
2078
        if last_revision not in self._lefthand_history(revision_id):
 
2079
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2080
 
 
2081
    def _gen_revision_history(self):
 
2082
        """Generate the revision history from last revision
 
2083
        """
 
2084
        last_revno, last_revision = self.last_revision_info()
 
2085
        self._extend_partial_history(stop_index=last_revno-1)
 
2086
        return list(reversed(self._partial_revision_history_cache))
 
2087
 
 
2088
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2089
        """Extend the partial history to include a given index
 
2090
 
 
2091
        If a stop_index is supplied, stop when that index has been reached.
 
2092
        If a stop_revision is supplied, stop when that revision is
 
2093
        encountered.  Otherwise, stop when the beginning of history is
 
2094
        reached.
 
2095
 
 
2096
        :param stop_index: The index which should be present.  When it is
 
2097
            present, history extension will stop.
 
2098
        :param revision_id: The revision id which should be present.  When
 
2099
            it is encountered, history extension will stop.
 
2100
        """
 
2101
        repo = self.repository
 
2102
        if len(self._partial_revision_history_cache) == 0:
 
2103
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2104
        else:
 
2105
            start_revision = self._partial_revision_history_cache[-1]
 
2106
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2107
            #skip the last revision in the list
 
2108
            next_revision = iterator.next()
 
2109
        for revision_id in iterator:
 
2110
            self._partial_revision_history_cache.append(revision_id)
 
2111
            if (stop_index is not None and
 
2112
                len(self._partial_revision_history_cache) > stop_index):
 
2113
                break
 
2114
            if revision_id == stop_revision:
 
2115
                break
 
2116
 
 
2117
    def _write_revision_history(self, history):
 
2118
        """Factored out of set_revision_history.
 
2119
 
 
2120
        This performs the actual writing to disk, with format-specific checks.
 
2121
        It is intended to be called by BzrBranch5.set_revision_history.
 
2122
        """
 
2123
        if len(history) == 0:
 
2124
            last_revision = 'null:'
 
2125
        else:
 
2126
            if history != self._lefthand_history(history[-1]):
 
2127
                raise errors.NotLefthandHistory(history)
 
2128
            last_revision = history[-1]
 
2129
        if self._get_append_revisions_only():
 
2130
            self._check_history_violation(last_revision)
 
2131
        self._write_last_revision_info(len(history), last_revision)
 
2132
 
 
2133
    @needs_write_lock
 
2134
    def _set_parent_location(self, url):
 
2135
        """Set the parent branch"""
 
2136
        self._set_config_location('parent_location', url, make_relative=True)
 
2137
 
 
2138
    @needs_read_lock
 
2139
    def _get_parent_location(self):
 
2140
        """Set the parent branch"""
 
2141
        return self._get_config_location('parent_location')
 
2142
 
 
2143
    def set_push_location(self, location):
 
2144
        """See Branch.set_push_location."""
 
2145
        self._set_config_location('push_location', location)
 
2146
 
 
2147
    def set_bound_location(self, location):
 
2148
        """See Branch.set_push_location."""
 
2149
        result = None
 
2150
        config = self.get_config()
 
2151
        if location is None:
 
2152
            if config.get_user_option('bound') != 'True':
 
2153
                return False
 
2154
            else:
 
2155
                config.set_user_option('bound', 'False', warn_masked=True)
 
2156
                return True
 
2157
        else:
 
2158
            self._set_config_location('bound_location', location,
 
2159
                                      config=config)
 
2160
            config.set_user_option('bound', 'True', warn_masked=True)
 
2161
        return True
 
2162
 
 
2163
    def _get_bound_location(self, bound):
 
2164
        """Return the bound location in the config file.
 
2165
 
 
2166
        Return None if the bound parameter does not match"""
 
2167
        config = self.get_config()
 
2168
        config_bound = (config.get_user_option('bound') == 'True')
 
2169
        if config_bound != bound:
 
2170
            return None
 
2171
        return self._get_config_location('bound_location', config=config)
 
2172
 
 
2173
    def get_bound_location(self):
 
2174
        """See Branch.set_push_location."""
 
2175
        return self._get_bound_location(True)
 
2176
 
 
2177
    def get_old_bound_location(self):
 
2178
        """See Branch.get_old_bound_location"""
 
2179
        return self._get_bound_location(False)
 
2180
 
 
2181
    def get_stacked_on_url(self):
 
2182
        # you can always ask for the URL; but you might not be able to use it
 
2183
        # if the repo can't support stacking.
 
2184
        ## self._check_stackable_repo()
 
2185
        stacked_url = self._get_config_location('stacked_on_location')
 
2186
        if stacked_url is None:
 
2187
            raise errors.NotStacked(self)
 
2188
        return stacked_url
 
2189
 
 
2190
    def set_append_revisions_only(self, enabled):
 
2191
        if enabled:
 
2192
            value = 'True'
 
2193
        else:
 
2194
            value = 'False'
 
2195
        self.get_config().set_user_option('append_revisions_only', value,
 
2196
            warn_masked=True)
 
2197
 
 
2198
    def set_stacked_on_url(self, url):
 
2199
        self._check_stackable_repo()
 
2200
        if not url:
 
2201
            try:
 
2202
                old_url = self.get_stacked_on_url()
 
2203
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2204
                errors.UnstackableRepositoryFormat):
 
2205
                return
 
2206
            url = ''
 
2207
            # repositories don't offer an interface to remove fallback
 
2208
            # repositories today; take the conceptually simpler option and just
 
2209
            # reopen it.
 
2210
            self.repository = self.bzrdir.find_repository()
 
2211
            # for every revision reference the branch has, ensure it is pulled
 
2212
            # in.
 
2213
            source_repository = self._get_fallback_repository(old_url)
 
2214
            for revision_id in chain([self.last_revision()],
 
2215
                self.tags.get_reverse_tag_dict()):
 
2216
                self.repository.fetch(source_repository, revision_id,
 
2217
                    find_ghosts=True)
 
2218
        else:
 
2219
            self._activate_fallback_location(url)
 
2220
        # write this out after the repository is stacked to avoid setting a
 
2221
        # stacked config that doesn't work.
 
2222
        self._set_config_location('stacked_on_location', url)
 
2223
 
 
2224
    def _get_append_revisions_only(self):
 
2225
        value = self.get_config().get_user_option('append_revisions_only')
 
2226
        return value == 'True'
 
2227
 
 
2228
    def _synchronize_history(self, destination, revision_id):
 
2229
        """Synchronize last revision and revision history between branches.
 
2230
 
 
2231
        This version is most efficient when the destination is also a
 
2232
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
2233
        repository contains all the lefthand ancestors of the intended
 
2234
        last_revision.  If not, set_last_revision_info will fail.
 
2235
 
 
2236
        :param destination: The branch to copy the history into
 
2237
        :param revision_id: The revision-id to truncate history at.  May
 
2238
          be None to copy complete history.
 
2239
        """
 
2240
        source_revno, source_revision_id = self.last_revision_info()
 
2241
        if revision_id is None:
 
2242
            revno, revision_id = source_revno, source_revision_id
 
2243
        elif source_revision_id == revision_id:
 
2244
            # we know the revno without needing to walk all of history
 
2245
            revno = source_revno
 
2246
        else:
 
2247
            # To figure out the revno for a random revision, we need to build
 
2248
            # the revision history, and count its length.
 
2249
            # We don't care about the order, just how long it is.
 
2250
            # Alternatively, we could start at the current location, and count
 
2251
            # backwards. But there is no guarantee that we will find it since
 
2252
            # it may be a merged revision.
 
2253
            revno = len(list(self.repository.iter_reverse_revision_history(
 
2254
                                                                revision_id)))
 
2255
        destination.set_last_revision_info(revno, revision_id)
 
2256
 
 
2257
    def _make_tags(self):
 
2258
        return BasicTags(self)
 
2259
 
 
2260
    @needs_write_lock
 
2261
    def generate_revision_history(self, revision_id, last_rev=None,
 
2262
                                  other_branch=None):
 
2263
        """See BzrBranch5.generate_revision_history"""
 
2264
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2265
        revno = len(history)
 
2266
        self.set_last_revision_info(revno, revision_id)
 
2267
 
 
2268
    @needs_read_lock
 
2269
    def get_rev_id(self, revno, history=None):
 
2270
        """Find the revision id of the specified revno."""
 
2271
        if revno == 0:
 
2272
            return _mod_revision.NULL_REVISION
 
2273
 
 
2274
        last_revno, last_revision_id = self.last_revision_info()
 
2275
        if revno <= 0 or revno > last_revno:
 
2276
            raise errors.NoSuchRevision(self, revno)
 
2277
 
 
2278
        if history is not None:
 
2279
            return history[revno - 1]
 
2280
 
 
2281
        index = last_revno - revno
 
2282
        if len(self._partial_revision_history_cache) <= index:
 
2283
            self._extend_partial_history(stop_index=index)
 
2284
        if len(self._partial_revision_history_cache) > index:
 
2285
            return self._partial_revision_history_cache[index]
 
2286
        else:
 
2287
            raise errors.NoSuchRevision(self, revno)
 
2288
 
 
2289
    @needs_read_lock
 
2290
    def revision_id_to_revno(self, revision_id):
 
2291
        """Given a revision id, return its revno"""
 
2292
        if _mod_revision.is_null(revision_id):
 
2293
            return 0
 
2294
        try:
 
2295
            index = self._partial_revision_history_cache.index(revision_id)
 
2296
        except ValueError:
 
2297
            self._extend_partial_history(stop_revision=revision_id)
 
2298
            index = len(self._partial_revision_history_cache) - 1
 
2299
            if self._partial_revision_history_cache[index] != revision_id:
 
2300
                raise errors.NoSuchRevision(self, revision_id)
 
2301
        return self.revno() - index
 
2302
 
 
2303
 
 
2304
class BzrBranch6(BzrBranch7):
 
2305
    """See BzrBranchFormat6 for the capabilities of this branch.
 
2306
 
 
2307
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
 
2308
    i.e. stacking.
 
2309
    """
 
2310
 
 
2311
    def get_stacked_on_url(self):
 
2312
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2313
 
 
2314
    def set_stacked_on_url(self, url):
 
2315
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2316
 
 
2317
 
 
2318
######################################################################
 
2319
# results of operations
 
2320
 
 
2321
 
 
2322
class _Result(object):
 
2323
 
 
2324
    def _show_tag_conficts(self, to_file):
 
2325
        if not getattr(self, 'tag_conflicts', None):
 
2326
            return
 
2327
        to_file.write('Conflicting tags:\n')
 
2328
        for name, value1, value2 in self.tag_conflicts:
 
2329
            to_file.write('    %s\n' % (name, ))
 
2330
 
 
2331
 
 
2332
class PullResult(_Result):
 
2333
    """Result of a Branch.pull operation.
 
2334
 
 
2335
    :ivar old_revno: Revision number before pull.
 
2336
    :ivar new_revno: Revision number after pull.
 
2337
    :ivar old_revid: Tip revision id before pull.
 
2338
    :ivar new_revid: Tip revision id after pull.
 
2339
    :ivar source_branch: Source (local) branch object.
 
2340
    :ivar master_branch: Master branch of the target, or the target if no
 
2341
        Master
 
2342
    :ivar local_branch: target branch if there is a Master, else None
 
2343
    :ivar target_branch: Target/destination branch object.
 
2344
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2345
    """
 
2346
 
 
2347
    def __int__(self):
 
2348
        # DEPRECATED: pull used to return the change in revno
 
2349
        return self.new_revno - self.old_revno
 
2350
 
 
2351
    def report(self, to_file):
 
2352
        if not is_quiet():
 
2353
            if self.old_revid == self.new_revid:
 
2354
                to_file.write('No revisions to pull.\n')
 
2355
            else:
 
2356
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2357
        self._show_tag_conficts(to_file)
 
2358
 
 
2359
 
 
2360
class PushResult(_Result):
 
2361
    """Result of a Branch.push operation.
 
2362
 
 
2363
    :ivar old_revno: Revision number before push.
 
2364
    :ivar new_revno: Revision number after push.
 
2365
    :ivar old_revid: Tip revision id before push.
 
2366
    :ivar new_revid: Tip revision id after push.
 
2367
    :ivar source_branch: Source branch object.
 
2368
    :ivar master_branch: Master branch of the target, or None.
 
2369
    :ivar target_branch: Target/destination branch object.
 
2370
    """
 
2371
 
 
2372
    def __int__(self):
 
2373
        # DEPRECATED: push used to return the change in revno
 
2374
        return self.new_revno - self.old_revno
 
2375
 
 
2376
    def report(self, to_file):
 
2377
        """Write a human-readable description of the result."""
 
2378
        if self.old_revid == self.new_revid:
 
2379
            to_file.write('No new revisions to push.\n')
 
2380
        else:
 
2381
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
 
2382
        self._show_tag_conficts(to_file)
 
2383
 
 
2384
 
 
2385
class BranchCheckResult(object):
 
2386
    """Results of checking branch consistency.
 
2387
 
 
2388
    :see: Branch.check
 
2389
    """
 
2390
 
 
2391
    def __init__(self, branch):
 
2392
        self.branch = branch
 
2393
 
 
2394
    def report_results(self, verbose):
 
2395
        """Report the check results via trace.note.
 
2396
        
 
2397
        :param verbose: Requests more detailed display of what was checked,
 
2398
            if any.
 
2399
        """
 
2400
        note('checked branch %s format %s',
 
2401
             self.branch.base,
 
2402
             self.branch._format)
 
2403
 
 
2404
 
 
2405
class Converter5to6(object):
 
2406
    """Perform an in-place upgrade of format 5 to format 6"""
 
2407
 
 
2408
    def convert(self, branch):
 
2409
        # Data for 5 and 6 can peacefully coexist.
 
2410
        format = BzrBranchFormat6()
 
2411
        new_branch = format.open(branch.bzrdir, _found=True)
 
2412
 
 
2413
        # Copy source data into target
 
2414
        new_branch._write_last_revision_info(*branch.last_revision_info())
 
2415
        new_branch.set_parent(branch.get_parent())
 
2416
        new_branch.set_bound_location(branch.get_bound_location())
 
2417
        new_branch.set_push_location(branch.get_push_location())
 
2418
 
 
2419
        # New branch has no tags by default
 
2420
        new_branch.tags._set_tag_dict({})
 
2421
 
 
2422
        # Copying done; now update target format
 
2423
        new_branch._transport.put_bytes('format',
 
2424
            format.get_format_string(),
 
2425
            mode=new_branch.bzrdir._get_file_mode())
 
2426
 
 
2427
        # Clean up old files
 
2428
        new_branch._transport.delete('revision-history')
 
2429
        try:
 
2430
            branch.set_parent(None)
 
2431
        except errors.NoSuchFile:
 
2432
            pass
 
2433
        branch.set_bound_location(None)
 
2434
 
 
2435
 
 
2436
class Converter6to7(object):
 
2437
    """Perform an in-place upgrade of format 6 to format 7"""
 
2438
 
 
2439
    def convert(self, branch):
 
2440
        format = BzrBranchFormat7()
 
2441
        branch._set_config_location('stacked_on_location', '')
 
2442
        # update target format
 
2443
        branch._transport.put_bytes('format', format.get_format_string())
 
2444
 
 
2445
 
 
2446
 
 
2447
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2448
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2449
    duration.
 
2450
 
 
2451
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2452
 
 
2453
    If an exception is raised by callable, then that exception *will* be
 
2454
    propagated, even if the unlock attempt raises its own error.  Thus
 
2455
    _run_with_write_locked_target should be preferred to simply doing::
 
2456
 
 
2457
        target.lock_write()
 
2458
        try:
 
2459
            return callable(*args, **kwargs)
 
2460
        finally:
 
2461
            target.unlock()
 
2462
    
 
2463
    """
 
2464
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2465
    # should share code?
 
2466
    target.lock_write()
 
2467
    try:
 
2468
        result = callable(*args, **kwargs)
 
2469
    except:
 
2470
        exc_info = sys.exc_info()
 
2471
        try:
 
2472
            target.unlock()
 
2473
        finally:
 
2474
            raise exc_info[0], exc_info[1], exc_info[2]
 
2475
    else:
 
2476
        target.unlock()
 
2477
        return result