~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-20 01:51:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050620015101-841d1f78f2e47367
- simpleminded patchwork client in shell

Show diffs side-by-side

added added

removed removed

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