~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-08-14 17:25:43 UTC
  • mfrom: (3620.2.2 rules.disable)
  • Revision ID: pqm@pqm.ubuntu.com-20080814172543-nl22gdcodusa8rt0
(robertc) Disable .bzrrules from being read from the WT

Show diffs side-by-side

added added

removed removed

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