/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Ian Clatworthy
  • Date: 2008-04-17 08:21:14 UTC
  • mto: (4171.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4173.
  • Revision ID: ian.clatworthy@canonical.com-20080417082114-76imbiarcbj16ov3
first cut at working tree content filtering

Show diffs side-by-side

added added

removed removed

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