~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-08-12 15:37:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050812153701-ee26769ddc584e66
- merge john's "missing" command

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
from cStringIO import StringIO
19
 
 
20
 
from bzrlib.lazy_import import lazy_import
21
 
lazy_import(globals(), """
22
 
from copy import deepcopy
23
 
from unittest import TestSuite
24
 
from warnings import warn
 
18
import sys
 
19
import os
25
20
 
26
21
import bzrlib
27
 
from bzrlib import (
28
 
        bzrdir,
29
 
        cache_utf8,
30
 
        errors,
31
 
        lockdir,
32
 
        lockable_files,
33
 
        osutils,
34
 
        revision as _mod_revision,
35
 
        transport,
36
 
        tree,
37
 
        ui,
38
 
        urlutils,
39
 
        )
40
 
from bzrlib.config import BranchConfig, TreeConfig
41
 
from bzrlib.lockable_files import LockableFiles, TransportLock
42
 
""")
43
 
 
44
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
 
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
46
 
                           HistoryMissing, InvalidRevisionId,
47
 
                           InvalidRevisionNumber, LockError, NoSuchFile,
48
 
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
49
 
                           NotBranchError, UninitializableFormat,
50
 
                           UnlistableStore, UnlistableBranch,
51
 
                           )
52
 
from bzrlib.symbol_versioning import (deprecated_function,
53
 
                                      deprecated_method,
54
 
                                      DEPRECATED_PARAMETER,
55
 
                                      deprecated_passed,
56
 
                                      zero_eight, zero_nine,
57
 
                                      )
58
22
from bzrlib.trace import mutter, note
59
 
 
60
 
 
61
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
 
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
64
 
 
65
 
 
66
 
# TODO: Maybe include checks for common corruption of newlines, etc?
 
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
 
67
37
 
68
38
# TODO: Some operations like log might retrieve the same revisions
69
39
# repeatedly to calculate deltas.  We could perhaps have a weakref
70
 
# cache in memory to make this faster.  In general anything can be
71
 
# cached in memory between lock and unlock operations. .. nb thats
72
 
# what the transaction identity map provides
 
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.")
73
131
 
74
132
 
75
133
######################################################################
79
137
    """Branch holding a history of revisions.
80
138
 
81
139
    base
82
 
        Base directory/url of the branch.
 
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.
83
151
    """
84
 
    # this is really an instance variable - FIXME move it there
85
 
    # - RBC 20060112
86
152
    base = None
87
 
 
88
 
    def __init__(self, *ignored, **ignored_too):
89
 
        raise NotImplementedError('The Branch class is abstract')
90
 
 
91
 
    def break_lock(self):
92
 
        """Break a lock if one is present from another instance.
93
 
 
94
 
        Uses the ui factory to ask for confirmation if the lock may be from
95
 
        an active process.
96
 
 
97
 
        This will probe the repository for its lock as well.
98
 
        """
99
 
        self.control_files.break_lock()
100
 
        self.repository.break_lock()
101
 
        master = self.get_master_branch()
102
 
        if master is not None:
103
 
            master.break_lock()
104
 
 
105
 
    @staticmethod
106
 
    @deprecated_method(zero_eight)
107
 
    def open_downlevel(base):
108
 
        """Open a branch which may be of an old format."""
109
 
        return Branch.open(base, _unsupported=True)
110
 
        
111
 
    @staticmethod
112
 
    def open(base, _unsupported=False):
113
 
        """Open the branch rooted at base.
114
 
 
115
 
        For instance, if the branch is at URL/.bzr/branch,
116
 
        Branch.open(URL) -> a Branch instance.
117
 
        """
118
 
        control = bzrdir.BzrDir.open(base, _unsupported)
119
 
        return control.open_branch(_unsupported)
120
 
 
121
 
    @staticmethod
122
 
    def open_containing(url):
123
 
        """Open an existing branch which contains url.
124
 
        
125
 
        This probes for a branch at url, and searches upwards from there.
126
 
 
127
 
        Basically we keep looking up until we find the control directory or
128
 
        run into the root.  If there isn't one, raises NotBranchError.
129
 
        If there is one and it is either an unrecognised format or an unsupported 
130
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
131
 
        If there is one, it is returned, along with the unused portion of url.
132
 
        """
133
 
        control, relpath = bzrdir.BzrDir.open_containing(url)
134
 
        return control.open_branch(), relpath
135
 
 
136
 
    @staticmethod
137
 
    @deprecated_function(zero_eight)
138
 
    def initialize(base):
139
 
        """Create a new working tree and branch, rooted at 'base' (url)
140
 
 
141
 
        NOTE: This will soon be deprecated in favour of creation
142
 
        through a BzrDir.
143
 
        """
144
 
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
145
 
 
146
 
    @deprecated_function(zero_eight)
147
 
    def setup_caching(self, cache_root):
148
 
        """Subclasses that care about caching should override this, and set
149
 
        up cached stores located under cache_root.
150
 
        
151
 
        NOTE: This is unused.
152
 
        """
153
 
        pass
154
 
 
155
 
    def get_config(self):
156
 
        return BranchConfig(self)
157
 
 
158
 
    def _get_nick(self):
159
 
        return self.get_config().get_nickname()
160
 
 
161
 
    def _set_nick(self, nick):
162
 
        self.get_config().set_user_option('nickname', nick)
163
 
 
164
 
    nick = property(_get_nick, _set_nick)
165
 
 
166
 
    def is_locked(self):
167
 
        raise NotImplementedError(self.is_locked)
 
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.
 
166
        
 
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.
 
176
        """
 
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
 
168
211
 
169
212
    def lock_write(self):
170
 
        raise NotImplementedError(self.lock_write)
 
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
 
171
227
 
172
228
    def lock_read(self):
173
 
        raise NotImplementedError(self.lock_read)
174
 
 
 
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
            
175
242
    def unlock(self):
176
 
        raise NotImplementedError(self.unlock)
177
 
 
178
 
    def peek_lock_mode(self):
179
 
        """Return lock mode for the Branch: 'r', 'w' or None"""
180
 
        raise NotImplementedError(self.peek_lock_mode)
181
 
 
182
 
    def get_physical_lock_status(self):
183
 
        raise NotImplementedError(self.get_physical_lock_status)
 
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
 
249
        else:
 
250
            self._lock.unlock()
 
251
            self._lock = None
 
252
            self._lock_mode = self._lock_count = None
 
253
 
184
254
 
185
255
    def abspath(self, name):
186
 
        """Return absolute filename for something in the branch
187
 
        
188
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
189
 
        method and not a tree method.
190
 
        """
191
 
        raise NotImplementedError(self.abspath)
192
 
 
193
 
    def bind(self, other):
194
 
        """Bind the local branch the other branch.
195
 
 
196
 
        :param other: The branch to bind to
197
 
        :type other: Branch
198
 
        """
199
 
        raise errors.UpgradeRequired(self.base)
200
 
 
201
 
    @needs_write_lock
202
 
    def fetch(self, from_branch, last_revision=None, pb=None):
203
 
        """Copy revisions from from_branch into this branch.
204
 
 
205
 
        :param from_branch: Where to copy from.
206
 
        :param last_revision: What revision to stop at (None for at the end
207
 
                              of the branch.
208
 
        :param pb: An optional progress bar to use.
209
 
 
210
 
        Returns the copied revision count and the failed revisions in a tuple:
211
 
        (copied, failures).
212
 
        """
213
 
        if self.base == from_branch.base:
214
 
            return (0, [])
215
 
        if pb is None:
216
 
            nested_pb = ui.ui_factory.nested_progress_bar()
217
 
            pb = nested_pb
218
 
        else:
219
 
            nested_pb = None
220
 
 
221
 
        from_branch.lock_read()
222
 
        try:
223
 
            if last_revision is None:
224
 
                pb.update('get source history')
225
 
                from_history = from_branch.revision_history()
226
 
                if from_history:
227
 
                    last_revision = from_history[-1]
228
 
                else:
229
 
                    # no history in the source branch
230
 
                    last_revision = _mod_revision.NULL_REVISION
231
 
            return self.repository.fetch(from_branch.repository,
232
 
                                         revision_id=last_revision,
233
 
                                         pb=nested_pb)
234
 
        finally:
235
 
            if nested_pb is not None:
236
 
                nested_pb.finished()
237
 
            from_branch.unlock()
238
 
 
239
 
    def get_bound_location(self):
240
 
        """Return the URL of the branch we are bound to.
241
 
 
242
 
        Older format branches cannot bind, please be sure to use a metadir
243
 
        branch.
244
 
        """
245
 
        return None
246
 
    
247
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
248
 
                           timezone=None, committer=None, revprops=None, 
249
 
                           revision_id=None):
250
 
        """Obtain a CommitBuilder for this branch.
251
 
        
252
 
        :param parents: Revision ids of the parents of the new revision.
253
 
        :param config: Optional configuration to use.
254
 
        :param timestamp: Optional timestamp recorded for commit.
255
 
        :param timezone: Optional timezone for timestamp.
256
 
        :param committer: Optional committer to set for commit.
257
 
        :param revprops: Optional dictionary of revision properties.
258
 
        :param revision_id: Optional revision id.
259
 
        """
260
 
 
261
 
        if config is None:
262
 
            config = self.get_config()
263
 
        
264
 
        return self.repository.get_commit_builder(self, parents, config, 
265
 
            timestamp, timezone, committer, revprops, revision_id)
266
 
 
267
 
    def get_master_branch(self):
268
 
        """Return the branch we are bound to.
269
 
        
270
 
        :return: Either a Branch, or None
271
 
        """
272
 
        return None
 
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
        # if we want per-tree root ids then this is the place to set
 
320
        # them; they're not needed for now and so ommitted for
 
321
        # simplicity.
 
322
        pack_xml(Inventory(), self.controlfile('inventory','w'))
 
323
 
 
324
 
 
325
    def _check_format(self):
 
326
        """Check this branch format is supported.
 
327
 
 
328
        The current tool only supports the current unstable format.
 
329
 
 
330
        In the future, we might need different in-memory Branch
 
331
        classes to support downlevel branches.  But not yet.
 
332
        """
 
333
        # This ignores newlines so that we can open branches created
 
334
        # on Windows from Linux and so on.  I think it might be better
 
335
        # to always make all internal files in unix format.
 
336
        fmt = self.controlfile('branch-format', 'r').read()
 
337
        fmt.replace('\r\n', '')
 
338
        if fmt != BZR_BRANCH_FORMAT:
 
339
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
340
                           ['use a different bzr version',
 
341
                            'or remove the .bzr directory and "bzr init" again'])
 
342
 
 
343
    def get_root_id(self):
 
344
        """Return the id of this branches root"""
 
345
        inv = self.read_working_inventory()
 
346
        return inv.root.file_id
 
347
 
 
348
    def set_root_id(self, file_id):
 
349
        inv = self.read_working_inventory()
 
350
        orig_root_id = inv.root.file_id
 
351
        del inv._byid[inv.root.file_id]
 
352
        inv.root.file_id = file_id
 
353
        inv._byid[inv.root.file_id] = inv.root
 
354
        for fid in inv:
 
355
            entry = inv[fid]
 
356
            if entry.parent_id in (None, orig_root_id):
 
357
                entry.parent_id = inv.root.file_id
 
358
        self._write_inventory(inv)
 
359
 
 
360
    def read_working_inventory(self):
 
361
        """Read the working inventory."""
 
362
        from bzrlib.inventory import Inventory
 
363
        from bzrlib.xml import unpack_xml
 
364
        from time import time
 
365
        before = time()
 
366
        self.lock_read()
 
367
        try:
 
368
            # ElementTree does its own conversion from UTF-8, so open in
 
369
            # binary.
 
370
            inv = unpack_xml(Inventory,
 
371
                             self.controlfile('inventory', 'rb'))
 
372
            mutter("loaded inventory of %d items in %f"
 
373
                   % (len(inv), time() - before))
 
374
            return inv
 
375
        finally:
 
376
            self.unlock()
 
377
            
 
378
 
 
379
    def _write_inventory(self, inv):
 
380
        """Update the working inventory.
 
381
 
 
382
        That is to say, the inventory describing changes underway, that
 
383
        will be committed to the next revision.
 
384
        """
 
385
        from bzrlib.atomicfile import AtomicFile
 
386
        from bzrlib.xml import pack_xml
 
387
        
 
388
        self.lock_write()
 
389
        try:
 
390
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
391
            try:
 
392
                pack_xml(inv, f)
 
393
                f.commit()
 
394
            finally:
 
395
                f.close()
 
396
        finally:
 
397
            self.unlock()
 
398
        
 
399
        mutter('wrote working inventory')
 
400
            
 
401
 
 
402
    inventory = property(read_working_inventory, _write_inventory, None,
 
403
                         """Inventory for the working copy.""")
 
404
 
 
405
 
 
406
    def add(self, files, verbose=False, ids=None):
 
407
        """Make files versioned.
 
408
 
 
409
        Note that the command line normally calls smart_add instead.
 
410
 
 
411
        This puts the files in the Added state, so that they will be
 
412
        recorded by the next commit.
 
413
 
 
414
        files
 
415
            List of paths to add, relative to the base of the tree.
 
416
 
 
417
        ids
 
418
            If set, use these instead of automatically generated ids.
 
419
            Must be the same length as the list of files, but may
 
420
            contain None for ids that are to be autogenerated.
 
421
 
 
422
        TODO: Perhaps have an option to add the ids even if the files do
 
423
              not (yet) exist.
 
424
 
 
425
        TODO: Perhaps return the ids of the files?  But then again it
 
426
              is easy to retrieve them if they're needed.
 
427
 
 
428
        TODO: Adding a directory should optionally recurse down and
 
429
              add all non-ignored children.  Perhaps do that in a
 
430
              higher-level method.
 
431
        """
 
432
        # TODO: Re-adding a file that is removed in the working copy
 
433
        # should probably put it back with the previous ID.
 
434
        if isinstance(files, basestring):
 
435
            assert(ids is None or isinstance(ids, basestring))
 
436
            files = [files]
 
437
            if ids is not None:
 
438
                ids = [ids]
 
439
 
 
440
        if ids is None:
 
441
            ids = [None] * len(files)
 
442
        else:
 
443
            assert(len(ids) == len(files))
 
444
 
 
445
        self.lock_write()
 
446
        try:
 
447
            inv = self.read_working_inventory()
 
448
            for f,file_id in zip(files, ids):
 
449
                if is_control_file(f):
 
450
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
451
 
 
452
                fp = splitpath(f)
 
453
 
 
454
                if len(fp) == 0:
 
455
                    raise BzrError("cannot add top-level %r" % f)
 
456
 
 
457
                fullpath = os.path.normpath(self.abspath(f))
 
458
 
 
459
                try:
 
460
                    kind = file_kind(fullpath)
 
461
                except OSError:
 
462
                    # maybe something better?
 
463
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
464
 
 
465
                if kind != 'file' and kind != 'directory':
 
466
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
467
 
 
468
                if file_id is None:
 
469
                    file_id = gen_file_id(f)
 
470
                inv.add_path(f, kind=kind, file_id=file_id)
 
471
 
 
472
                if verbose:
 
473
                    print 'added', quotefn(f)
 
474
 
 
475
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
476
 
 
477
            self._write_inventory(inv)
 
478
        finally:
 
479
            self.unlock()
 
480
            
 
481
 
 
482
    def print_file(self, file, revno):
 
483
        """Print `file` to stdout."""
 
484
        self.lock_read()
 
485
        try:
 
486
            tree = self.revision_tree(self.lookup_revision(revno))
 
487
            # use inventory as it was in that revision
 
488
            file_id = tree.inventory.path2id(file)
 
489
            if not file_id:
 
490
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
491
            tree.print_file(file_id)
 
492
        finally:
 
493
            self.unlock()
 
494
 
 
495
 
 
496
    def remove(self, files, verbose=False):
 
497
        """Mark nominated files for removal from the inventory.
 
498
 
 
499
        This does not remove their text.  This does not run on 
 
500
 
 
501
        TODO: Refuse to remove modified files unless --force is given?
 
502
 
 
503
        TODO: Do something useful with directories.
 
504
 
 
505
        TODO: Should this remove the text or not?  Tough call; not
 
506
        removing may be useful and the user can just use use rm, and
 
507
        is the opposite of add.  Removing it is consistent with most
 
508
        other tools.  Maybe an option.
 
509
        """
 
510
        ## TODO: Normalize names
 
511
        ## TODO: Remove nested loops; better scalability
 
512
        if isinstance(files, basestring):
 
513
            files = [files]
 
514
 
 
515
        self.lock_write()
 
516
 
 
517
        try:
 
518
            tree = self.working_tree()
 
519
            inv = tree.inventory
 
520
 
 
521
            # do this before any modifications
 
522
            for f in files:
 
523
                fid = inv.path2id(f)
 
524
                if not fid:
 
525
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
526
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
527
                if verbose:
 
528
                    # having remove it, it must be either ignored or unknown
 
529
                    if tree.is_ignored(f):
 
530
                        new_status = 'I'
 
531
                    else:
 
532
                        new_status = '?'
 
533
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
534
                del inv[fid]
 
535
 
 
536
            self._write_inventory(inv)
 
537
        finally:
 
538
            self.unlock()
 
539
 
 
540
 
 
541
    # FIXME: this doesn't need to be a branch method
 
542
    def set_inventory(self, new_inventory_list):
 
543
        from bzrlib.inventory import Inventory, InventoryEntry
 
544
        inv = Inventory(self.get_root_id())
 
545
        for path, file_id, parent, kind in new_inventory_list:
 
546
            name = os.path.basename(path)
 
547
            if name == "":
 
548
                continue
 
549
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
550
        self._write_inventory(inv)
 
551
 
 
552
 
 
553
    def unknowns(self):
 
554
        """Return all unknown files.
 
555
 
 
556
        These are files in the working directory that are not versioned or
 
557
        control files or ignored.
 
558
        
 
559
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
560
        >>> list(b.unknowns())
 
561
        ['foo']
 
562
        >>> b.add('foo')
 
563
        >>> list(b.unknowns())
 
564
        []
 
565
        >>> b.remove('foo')
 
566
        >>> list(b.unknowns())
 
567
        ['foo']
 
568
        """
 
569
        return self.working_tree().unknowns()
 
570
 
 
571
 
 
572
    def append_revision(self, *revision_ids):
 
573
        from bzrlib.atomicfile import AtomicFile
 
574
 
 
575
        for revision_id in revision_ids:
 
576
            mutter("add {%s} to revision-history" % revision_id)
 
577
 
 
578
        rev_history = self.revision_history()
 
579
        rev_history.extend(revision_ids)
 
580
 
 
581
        f = AtomicFile(self.controlfilename('revision-history'))
 
582
        try:
 
583
            for rev_id in rev_history:
 
584
                print >>f, rev_id
 
585
            f.commit()
 
586
        finally:
 
587
            f.close()
 
588
 
 
589
 
 
590
    def get_revision_xml(self, revision_id):
 
591
        """Return XML file object for revision object."""
 
592
        if not revision_id or not isinstance(revision_id, basestring):
 
593
            raise InvalidRevisionId(revision_id)
 
594
 
 
595
        self.lock_read()
 
596
        try:
 
597
            try:
 
598
                return self.revision_store[revision_id]
 
599
            except IndexError:
 
600
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
601
        finally:
 
602
            self.unlock()
 
603
 
 
604
 
 
605
    def get_revision(self, revision_id):
 
606
        """Return the Revision object for a named revision"""
 
607
        xml_file = self.get_revision_xml(revision_id)
 
608
 
 
609
        try:
 
610
            r = unpack_xml(Revision, xml_file)
 
611
        except SyntaxError, e:
 
612
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
613
                                         [revision_id,
 
614
                                          str(e)])
 
615
            
 
616
        assert r.revision_id == revision_id
 
617
        return r
 
618
 
273
619
 
274
620
    def get_revision_delta(self, revno):
275
621
        """Return the delta for one revision.
281
627
        rh = self.revision_history()
282
628
        if not (1 <= revno <= len(rh)):
283
629
            raise InvalidRevisionNumber(revno)
284
 
        return self.repository.get_revision_delta(rh[revno-1])
285
 
 
286
 
    def get_root_id(self):
287
 
        """Return the id of this branches root"""
288
 
        raise NotImplementedError(self.get_root_id)
289
 
 
290
 
    def print_file(self, file, revision_id):
291
 
        """Print `file` to stdout."""
292
 
        raise NotImplementedError(self.print_file)
293
 
 
294
 
    def append_revision(self, *revision_ids):
295
 
        raise NotImplementedError(self.append_revision)
296
 
 
297
 
    def set_revision_history(self, rev_history):
298
 
        raise NotImplementedError(self.set_revision_history)
 
630
 
 
631
        # revno is 1-based; list is 0-based
 
632
 
 
633
        new_tree = self.revision_tree(rh[revno-1])
 
634
        if revno == 1:
 
635
            old_tree = EmptyTree()
 
636
        else:
 
637
            old_tree = self.revision_tree(rh[revno-2])
 
638
 
 
639
        return compare_trees(old_tree, new_tree)
 
640
 
 
641
        
 
642
 
 
643
    def get_revision_sha1(self, revision_id):
 
644
        """Hash the stored value of a revision, and return it."""
 
645
        # In the future, revision entries will be signed. At that
 
646
        # point, it is probably best *not* to include the signature
 
647
        # in the revision hash. Because that lets you re-sign
 
648
        # the revision, (add signatures/remove signatures) and still
 
649
        # have all hash pointers stay consistent.
 
650
        # But for now, just hash the contents.
 
651
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
 
652
 
 
653
 
 
654
    def get_inventory(self, inventory_id):
 
655
        """Get Inventory object by hash.
 
656
 
 
657
        TODO: Perhaps for this and similar methods, take a revision
 
658
               parameter which can be either an integer revno or a
 
659
               string hash."""
 
660
        from bzrlib.inventory import Inventory
 
661
        from bzrlib.xml import unpack_xml
 
662
 
 
663
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
 
664
            
 
665
 
 
666
    def get_inventory_sha1(self, inventory_id):
 
667
        """Return the sha1 hash of the inventory entry
 
668
        """
 
669
        return sha_file(self.inventory_store[inventory_id])
 
670
 
 
671
 
 
672
    def get_revision_inventory(self, revision_id):
 
673
        """Return inventory of a past revision."""
 
674
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
675
        # must be the same as its revision, so this is trivial.
 
676
        if revision_id == None:
 
677
            from bzrlib.inventory import Inventory
 
678
            return Inventory(self.get_root_id())
 
679
        else:
 
680
            return self.get_inventory(revision_id)
 
681
 
299
682
 
300
683
    def revision_history(self):
301
 
        """Return sequence of revision hashes on to this branch."""
302
 
        raise NotImplementedError(self.revision_history)
 
684
        """Return sequence of revision hashes on to this branch.
 
685
 
 
686
        >>> ScratchBranch().revision_history()
 
687
        []
 
688
        """
 
689
        self.lock_read()
 
690
        try:
 
691
            return [l.rstrip('\r\n') for l in
 
692
                    self.controlfile('revision-history', 'r').readlines()]
 
693
        finally:
 
694
            self.unlock()
 
695
 
 
696
 
 
697
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
698
        """
 
699
        >>> import commit
 
700
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
701
        >>> sb.common_ancestor(sb) == (None, None)
 
702
        True
 
703
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
704
        >>> sb.common_ancestor(sb)[0]
 
705
        1
 
706
        >>> clone = sb.clone()
 
707
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
708
        >>> sb.common_ancestor(sb)[0]
 
709
        2
 
710
        >>> sb.common_ancestor(clone)[0]
 
711
        1
 
712
        >>> commit.commit(clone, "Committing divergent second revision", 
 
713
        ...               verbose=False)
 
714
        >>> sb.common_ancestor(clone)[0]
 
715
        1
 
716
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
717
        True
 
718
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
719
        True
 
720
        >>> clone2 = sb.clone()
 
721
        >>> sb.common_ancestor(clone2)[0]
 
722
        2
 
723
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
724
        1
 
725
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
726
        1
 
727
        """
 
728
        my_history = self.revision_history()
 
729
        other_history = other.revision_history()
 
730
        if self_revno is None:
 
731
            self_revno = len(my_history)
 
732
        if other_revno is None:
 
733
            other_revno = len(other_history)
 
734
        indices = range(min((self_revno, other_revno)))
 
735
        indices.reverse()
 
736
        for r in indices:
 
737
            if my_history[r] == other_history[r]:
 
738
                return r+1, my_history[r]
 
739
        return None, None
 
740
 
303
741
 
304
742
    def revno(self):
305
743
        """Return current revision number for this branch.
309
747
        """
310
748
        return len(self.revision_history())
311
749
 
312
 
    def unbind(self):
313
 
        """Older format branches cannot bind or unbind."""
314
 
        raise errors.UpgradeRequired(self.base)
315
750
 
316
 
    def last_revision(self):
317
 
        """Return last revision id, or None"""
 
751
    def last_patch(self):
 
752
        """Return last patch hash, or None if no history.
 
753
        """
318
754
        ph = self.revision_history()
319
755
        if ph:
320
756
            return ph[-1]
321
757
        else:
322
758
            return None
323
759
 
 
760
 
324
761
    def missing_revisions(self, other, stop_revision=None):
325
 
        """Return a list of new revisions that would perfectly fit.
326
 
        
 
762
        """
327
763
        If self and other have not diverged, return a list of the revisions
328
764
        present in other, but missing from self.
 
765
 
 
766
        >>> from bzrlib.commit import commit
 
767
        >>> bzrlib.trace.silent = True
 
768
        >>> br1 = ScratchBranch()
 
769
        >>> br2 = ScratchBranch()
 
770
        >>> br1.missing_revisions(br2)
 
771
        []
 
772
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
773
        >>> br1.missing_revisions(br2)
 
774
        [u'REVISION-ID-1']
 
775
        >>> br2.missing_revisions(br1)
 
776
        []
 
777
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
778
        >>> br1.missing_revisions(br2)
 
779
        []
 
780
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
781
        >>> br1.missing_revisions(br2)
 
782
        [u'REVISION-ID-2A']
 
783
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
784
        >>> br1.missing_revisions(br2)
 
785
        Traceback (most recent call last):
 
786
        DivergedBranches: These branches have diverged.
329
787
        """
330
788
        self_history = self.revision_history()
331
789
        self_len = len(self_history)
338
796
 
339
797
        if stop_revision is None:
340
798
            stop_revision = other_len
341
 
        else:
342
 
            assert isinstance(stop_revision, int)
343
 
            if stop_revision > other_len:
344
 
                raise errors.NoSuchRevision(self, stop_revision)
 
799
        elif stop_revision > other_len:
 
800
            raise NoSuchRevision(self, stop_revision)
 
801
        
345
802
        return other_history[self_len:stop_revision]
346
803
 
 
804
 
347
805
    def update_revisions(self, other, stop_revision=None):
348
 
        """Pull in new perfect-fit revisions.
349
 
 
350
 
        :param other: Another Branch to pull from
351
 
        :param stop_revision: Updated until the given revision
352
 
        :return: None
353
 
        """
354
 
        raise NotImplementedError(self.update_revisions)
355
 
 
356
 
    def revision_id_to_revno(self, revision_id):
357
 
        """Given a revision id, return its revno"""
358
 
        if revision_id is None:
359
 
            return 0
360
 
        history = self.revision_history()
361
 
        try:
362
 
            return history.index(revision_id) + 1
363
 
        except ValueError:
364
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
365
 
 
366
 
    def get_rev_id(self, revno, history=None):
367
 
        """Find the revision id of the specified revno."""
368
 
        if revno == 0:
369
 
            return None
370
 
        if history is None:
371
 
            history = self.revision_history()
372
 
        if revno <= 0 or revno > len(history):
373
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
374
 
        return history[revno - 1]
375
 
 
376
 
    def pull(self, source, overwrite=False, stop_revision=None):
377
 
        raise NotImplementedError(self.pull)
 
806
        """Pull in all new revisions from other branch.
 
807
        
 
808
        >>> from bzrlib.commit import commit
 
809
        >>> bzrlib.trace.silent = True
 
810
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
811
        >>> br1.add('foo')
 
812
        >>> br1.add('bar')
 
813
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
814
        >>> br2 = ScratchBranch()
 
815
        >>> br2.update_revisions(br1)
 
816
        Added 2 texts.
 
817
        Added 1 inventories.
 
818
        Added 1 revisions.
 
819
        >>> br2.revision_history()
 
820
        [u'REVISION-ID-1']
 
821
        >>> br2.update_revisions(br1)
 
822
        Added 0 texts.
 
823
        Added 0 inventories.
 
824
        Added 0 revisions.
 
825
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
826
        True
 
827
        """
 
828
        from bzrlib.progress import ProgressBar
 
829
 
 
830
        pb = ProgressBar()
 
831
 
 
832
        pb.update('comparing histories')
 
833
        revision_ids = self.missing_revisions(other, stop_revision)
 
834
 
 
835
        if hasattr(other.revision_store, "prefetch"):
 
836
            other.revision_store.prefetch(revision_ids)
 
837
        if hasattr(other.inventory_store, "prefetch"):
 
838
            inventory_ids = [other.get_revision(r).inventory_id
 
839
                             for r in revision_ids]
 
840
            other.inventory_store.prefetch(inventory_ids)
 
841
                
 
842
        revisions = []
 
843
        needed_texts = set()
 
844
        i = 0
 
845
        for rev_id in revision_ids:
 
846
            i += 1
 
847
            pb.update('fetching revision', i, len(revision_ids))
 
848
            rev = other.get_revision(rev_id)
 
849
            revisions.append(rev)
 
850
            inv = other.get_inventory(str(rev.inventory_id))
 
851
            for key, entry in inv.iter_entries():
 
852
                if entry.text_id is None:
 
853
                    continue
 
854
                if entry.text_id not in self.text_store:
 
855
                    needed_texts.add(entry.text_id)
 
856
 
 
857
        pb.clear()
 
858
                    
 
859
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
860
        print "Added %d texts." % count 
 
861
        inventory_ids = [ f.inventory_id for f in revisions ]
 
862
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
863
                                                inventory_ids)
 
864
        print "Added %d inventories." % count 
 
865
        revision_ids = [ f.revision_id for f in revisions]
 
866
        count = self.revision_store.copy_multi(other.revision_store, 
 
867
                                               revision_ids)
 
868
        for revision_id in revision_ids:
 
869
            self.append_revision(revision_id)
 
870
        print "Added %d revisions." % count
 
871
                    
 
872
        
 
873
    def commit(self, *args, **kw):
 
874
        from bzrlib.commit import commit
 
875
        commit(self, *args, **kw)
 
876
        
 
877
 
 
878
    def lookup_revision(self, revision):
 
879
        """Return the revision identifier for a given revision information."""
 
880
        revno, info = self.get_revision_info(revision)
 
881
        return info
 
882
 
 
883
    def get_revision_info(self, revision):
 
884
        """Return (revno, revision id) for revision identifier.
 
885
 
 
886
        revision can be an integer, in which case it is assumed to be revno (though
 
887
            this will translate negative values into positive ones)
 
888
        revision can also be a string, in which case it is parsed for something like
 
889
            'date:' or 'revid:' etc.
 
890
        """
 
891
        if revision is None:
 
892
            return 0, None
 
893
        revno = None
 
894
        try:# Convert to int if possible
 
895
            revision = int(revision)
 
896
        except ValueError:
 
897
            pass
 
898
        revs = self.revision_history()
 
899
        if isinstance(revision, int):
 
900
            if revision == 0:
 
901
                return 0, None
 
902
            # Mabye we should do this first, but we don't need it if revision == 0
 
903
            if revision < 0:
 
904
                revno = len(revs) + revision + 1
 
905
            else:
 
906
                revno = revision
 
907
        elif isinstance(revision, basestring):
 
908
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
909
                if revision.startswith(prefix):
 
910
                    revno = func(self, revs, revision)
 
911
                    break
 
912
            else:
 
913
                raise BzrError('No namespace registered for string: %r' % revision)
 
914
 
 
915
        if revno is None or revno <= 0 or revno > len(revs):
 
916
            raise BzrError("no such revision %s" % revision)
 
917
        return revno, revs[revno-1]
 
918
 
 
919
    def _namespace_revno(self, revs, revision):
 
920
        """Lookup a revision by revision number"""
 
921
        assert revision.startswith('revno:')
 
922
        try:
 
923
            return int(revision[6:])
 
924
        except ValueError:
 
925
            return None
 
926
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
927
 
 
928
    def _namespace_revid(self, revs, revision):
 
929
        assert revision.startswith('revid:')
 
930
        try:
 
931
            return revs.index(revision[6:]) + 1
 
932
        except ValueError:
 
933
            return None
 
934
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
935
 
 
936
    def _namespace_last(self, revs, revision):
 
937
        assert revision.startswith('last:')
 
938
        try:
 
939
            offset = int(revision[5:])
 
940
        except ValueError:
 
941
            return None
 
942
        else:
 
943
            if offset <= 0:
 
944
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
945
            return len(revs) - offset + 1
 
946
    REVISION_NAMESPACES['last:'] = _namespace_last
 
947
 
 
948
    def _namespace_tag(self, revs, revision):
 
949
        assert revision.startswith('tag:')
 
950
        raise BzrError('tag: namespace registered, but not implemented.')
 
951
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
952
 
 
953
    def _namespace_date(self, revs, revision):
 
954
        assert revision.startswith('date:')
 
955
        import datetime
 
956
        # Spec for date revisions:
 
957
        #   date:value
 
958
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
959
        #   it can also start with a '+/-/='. '+' says match the first
 
960
        #   entry after the given date. '-' is match the first entry before the date
 
961
        #   '=' is match the first entry after, but still on the given date.
 
962
        #
 
963
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
964
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
965
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
966
        #       May 13th, 2005 at 0:00
 
967
        #
 
968
        #   So the proper way of saying 'give me all entries for today' is:
 
969
        #       -r {date:+today}:{date:-tomorrow}
 
970
        #   The default is '=' when not supplied
 
971
        val = revision[5:]
 
972
        match_style = '='
 
973
        if val[:1] in ('+', '-', '='):
 
974
            match_style = val[:1]
 
975
            val = val[1:]
 
976
 
 
977
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
978
        if val.lower() == 'yesterday':
 
979
            dt = today - datetime.timedelta(days=1)
 
980
        elif val.lower() == 'today':
 
981
            dt = today
 
982
        elif val.lower() == 'tomorrow':
 
983
            dt = today + datetime.timedelta(days=1)
 
984
        else:
 
985
            import re
 
986
            # This should be done outside the function to avoid recompiling it.
 
987
            _date_re = re.compile(
 
988
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
989
                    r'(,|T)?\s*'
 
990
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
991
                )
 
992
            m = _date_re.match(val)
 
993
            if not m or (not m.group('date') and not m.group('time')):
 
994
                raise BzrError('Invalid revision date %r' % revision)
 
995
 
 
996
            if m.group('date'):
 
997
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
998
            else:
 
999
                year, month, day = today.year, today.month, today.day
 
1000
            if m.group('time'):
 
1001
                hour = int(m.group('hour'))
 
1002
                minute = int(m.group('minute'))
 
1003
                if m.group('second'):
 
1004
                    second = int(m.group('second'))
 
1005
                else:
 
1006
                    second = 0
 
1007
            else:
 
1008
                hour, minute, second = 0,0,0
 
1009
 
 
1010
            dt = datetime.datetime(year=year, month=month, day=day,
 
1011
                    hour=hour, minute=minute, second=second)
 
1012
        first = dt
 
1013
        last = None
 
1014
        reversed = False
 
1015
        if match_style == '-':
 
1016
            reversed = True
 
1017
        elif match_style == '=':
 
1018
            last = dt + datetime.timedelta(days=1)
 
1019
 
 
1020
        if reversed:
 
1021
            for i in range(len(revs)-1, -1, -1):
 
1022
                r = self.get_revision(revs[i])
 
1023
                # TODO: Handle timezone.
 
1024
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1025
                if first >= dt and (last is None or dt >= last):
 
1026
                    return i+1
 
1027
        else:
 
1028
            for i in range(len(revs)):
 
1029
                r = self.get_revision(revs[i])
 
1030
                # TODO: Handle timezone.
 
1031
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1032
                if first <= dt and (last is None or dt <= last):
 
1033
                    return i+1
 
1034
    REVISION_NAMESPACES['date:'] = _namespace_date
 
1035
 
 
1036
    def revision_tree(self, revision_id):
 
1037
        """Return Tree for a revision on this branch.
 
1038
 
 
1039
        `revision_id` may be None for the null revision, in which case
 
1040
        an `EmptyTree` is returned."""
 
1041
        # TODO: refactor this to use an existing revision object
 
1042
        # so we don't need to read it in twice.
 
1043
        if revision_id == None:
 
1044
            return EmptyTree()
 
1045
        else:
 
1046
            inv = self.get_revision_inventory(revision_id)
 
1047
            return RevisionTree(self.text_store, inv)
 
1048
 
 
1049
 
 
1050
    def working_tree(self):
 
1051
        """Return a `Tree` for the working copy."""
 
1052
        from workingtree import WorkingTree
 
1053
        return WorkingTree(self.base, self.read_working_inventory())
 
1054
 
378
1055
 
379
1056
    def basis_tree(self):
380
 
        """Return `Tree` object for last revision."""
381
 
        return self.repository.revision_tree(self.last_revision())
 
1057
        """Return `Tree` object for last revision.
 
1058
 
 
1059
        If there are no revisions yet, return an `EmptyTree`.
 
1060
        """
 
1061
        r = self.last_patch()
 
1062
        if r == None:
 
1063
            return EmptyTree()
 
1064
        else:
 
1065
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
1066
 
 
1067
 
382
1068
 
383
1069
    def rename_one(self, from_rel, to_rel):
384
1070
        """Rename one file.
385
1071
 
386
1072
        This can change the directory or the filename or both.
387
1073
        """
388
 
        raise NotImplementedError(self.rename_one)
 
1074
        self.lock_write()
 
1075
        try:
 
1076
            tree = self.working_tree()
 
1077
            inv = tree.inventory
 
1078
            if not tree.has_filename(from_rel):
 
1079
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1080
            if tree.has_filename(to_rel):
 
1081
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1082
 
 
1083
            file_id = inv.path2id(from_rel)
 
1084
            if file_id == None:
 
1085
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1086
 
 
1087
            if inv.path2id(to_rel):
 
1088
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1089
 
 
1090
            to_dir, to_tail = os.path.split(to_rel)
 
1091
            to_dir_id = inv.path2id(to_dir)
 
1092
            if to_dir_id == None and to_dir != '':
 
1093
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1094
 
 
1095
            mutter("rename_one:")
 
1096
            mutter("  file_id    {%s}" % file_id)
 
1097
            mutter("  from_rel   %r" % from_rel)
 
1098
            mutter("  to_rel     %r" % to_rel)
 
1099
            mutter("  to_dir     %r" % to_dir)
 
1100
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1101
 
 
1102
            inv.rename(file_id, to_dir_id, to_tail)
 
1103
 
 
1104
            print "%s => %s" % (from_rel, to_rel)
 
1105
 
 
1106
            from_abs = self.abspath(from_rel)
 
1107
            to_abs = self.abspath(to_rel)
 
1108
            try:
 
1109
                os.rename(from_abs, to_abs)
 
1110
            except OSError, e:
 
1111
                raise BzrError("failed to rename %r to %r: %s"
 
1112
                        % (from_abs, to_abs, e[1]),
 
1113
                        ["rename rolled back"])
 
1114
 
 
1115
            self._write_inventory(inv)
 
1116
        finally:
 
1117
            self.unlock()
 
1118
 
389
1119
 
390
1120
    def move(self, from_paths, to_name):
391
1121
        """Rename files.
397
1127
 
398
1128
        Note that to_name is only the last component of the new name;
399
1129
        this doesn't change the directory.
400
 
 
401
 
        This returns a list of (from_path, to_path) pairs for each
402
 
        entry that is moved.
403
 
        """
404
 
        raise NotImplementedError(self.move)
405
 
 
406
 
    def get_parent(self):
407
 
        """Return the parent location of the branch.
408
 
 
409
 
        This is the default location for push/pull/missing.  The usual
410
 
        pattern is that the user can override it by specifying a
411
 
        location.
412
 
        """
413
 
        raise NotImplementedError(self.get_parent)
414
 
 
415
 
    def get_submit_branch(self):
416
 
        """Return the submit location of the branch.
417
 
 
418
 
        This is the default location for bundle.  The usual
419
 
        pattern is that the user can override it by specifying a
420
 
        location.
421
 
        """
422
 
        return self.get_config().get_user_option('submit_branch')
423
 
 
424
 
    def set_submit_branch(self, location):
425
 
        """Return the submit location of the branch.
426
 
 
427
 
        This is the default location for bundle.  The usual
428
 
        pattern is that the user can override it by specifying a
429
 
        location.
430
 
        """
431
 
        self.get_config().set_user_option('submit_branch', location)
432
 
 
433
 
    def get_push_location(self):
434
 
        """Return the None or the location to push this branch to."""
435
 
        raise NotImplementedError(self.get_push_location)
436
 
 
437
 
    def set_push_location(self, location):
438
 
        """Set a new push location for this branch."""
439
 
        raise NotImplementedError(self.set_push_location)
440
 
 
441
 
    def set_parent(self, url):
442
 
        raise NotImplementedError(self.set_parent)
443
 
 
444
 
    @needs_write_lock
445
 
    def update(self):
446
 
        """Synchronise this branch with the master branch if any. 
447
 
 
448
 
        :return: None or the last_revision pivoted out during the update.
449
 
        """
450
 
        return None
451
 
 
452
 
    def check_revno(self, revno):
453
 
        """\
454
 
        Check whether a revno corresponds to any revision.
455
 
        Zero (the NULL revision) is considered valid.
456
 
        """
457
 
        if revno != 0:
458
 
            self.check_real_revno(revno)
459
 
            
460
 
    def check_real_revno(self, revno):
461
 
        """\
462
 
        Check whether a revno corresponds to a real revision.
463
 
        Zero (the NULL revision) is considered invalid
464
 
        """
465
 
        if revno < 1 or revno > self.revno():
466
 
            raise InvalidRevisionNumber(revno)
467
 
 
468
 
    @needs_read_lock
469
 
    def clone(self, *args, **kwargs):
470
 
        """Clone this branch into to_bzrdir preserving all semantic values.
471
 
        
472
 
        revision_id: if not None, the revision history in the new branch will
473
 
                     be truncated to end with revision_id.
474
 
        """
475
 
        # for API compatibility, until 0.8 releases we provide the old api:
476
 
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
477
 
        # after 0.8 releases, the *args and **kwargs should be changed:
478
 
        # def clone(self, to_bzrdir, revision_id=None):
479
 
        if (kwargs.get('to_location', None) or
480
 
            kwargs.get('revision', None) or
481
 
            kwargs.get('basis_branch', None) or
482
 
            (len(args) and isinstance(args[0], basestring))):
483
 
            # backwards compatibility api:
484
 
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
485
 
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
486
 
            # get basis_branch
487
 
            if len(args) > 2:
488
 
                basis_branch = args[2]
489
 
            else:
490
 
                basis_branch = kwargs.get('basis_branch', None)
491
 
            if basis_branch:
492
 
                basis = basis_branch.bzrdir
493
 
            else:
494
 
                basis = None
495
 
            # get revision
496
 
            if len(args) > 1:
497
 
                revision_id = args[1]
498
 
            else:
499
 
                revision_id = kwargs.get('revision', None)
500
 
            # get location
501
 
            if len(args):
502
 
                url = args[0]
503
 
            else:
504
 
                # no default to raise if not provided.
505
 
                url = kwargs.get('to_location')
506
 
            return self.bzrdir.clone(url,
507
 
                                     revision_id=revision_id,
508
 
                                     basis=basis).open_branch()
509
 
        # new cleaner api.
510
 
        # generate args by hand 
511
 
        if len(args) > 1:
512
 
            revision_id = args[1]
513
 
        else:
514
 
            revision_id = kwargs.get('revision_id', None)
515
 
        if len(args):
516
 
            to_bzrdir = args[0]
517
 
        else:
518
 
            # no default to raise if not provided.
519
 
            to_bzrdir = kwargs.get('to_bzrdir')
520
 
        result = self._format.initialize(to_bzrdir)
521
 
        self.copy_content_into(result, revision_id=revision_id)
522
 
        return  result
523
 
 
524
 
    @needs_read_lock
525
 
    def sprout(self, to_bzrdir, revision_id=None):
526
 
        """Create a new line of development from the branch, into to_bzrdir.
527
 
        
528
 
        revision_id: if not None, the revision history in the new branch will
529
 
                     be truncated to end with revision_id.
530
 
        """
531
 
        result = self._format.initialize(to_bzrdir)
532
 
        self.copy_content_into(result, revision_id=revision_id)
533
 
        result.set_parent(self.bzrdir.root_transport.base)
534
 
        return result
535
 
 
536
 
    @needs_read_lock
537
 
    def copy_content_into(self, destination, revision_id=None):
538
 
        """Copy the content of self into destination.
539
 
 
540
 
        revision_id: if not None, the revision history in the new branch will
541
 
                     be truncated to end with revision_id.
542
 
        """
543
 
        new_history = self.revision_history()
544
 
        if revision_id is not None:
545
 
            try:
546
 
                new_history = new_history[:new_history.index(revision_id) + 1]
547
 
            except ValueError:
548
 
                rev = self.repository.get_revision(revision_id)
549
 
                new_history = rev.get_history(self.repository)[1:]
550
 
        destination.set_revision_history(new_history)
551
 
        try:
552
 
            parent = self.get_parent()
553
 
        except errors.InaccessibleParent, e:
554
 
            mutter('parent was not accessible to copy: %s', e)
555
 
        else:
556
 
            if parent:
557
 
                destination.set_parent(parent)
558
 
 
559
 
    @needs_read_lock
560
 
    def check(self):
561
 
        """Check consistency of the branch.
562
 
 
563
 
        In particular this checks that revisions given in the revision-history
564
 
        do actually match up in the revision graph, and that they're all 
565
 
        present in the repository.
566
 
        
567
 
        Callers will typically also want to check the repository.
568
 
 
569
 
        :return: A BranchCheckResult.
570
 
        """
571
 
        mainline_parent_id = None
572
 
        for revision_id in self.revision_history():
573
 
            try:
574
 
                revision = self.repository.get_revision(revision_id)
575
 
            except errors.NoSuchRevision, e:
576
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
577
 
                            % revision_id)
578
 
            # In general the first entry on the revision history has no parents.
579
 
            # But it's not illegal for it to have parents listed; this can happen
580
 
            # in imports from Arch when the parents weren't reachable.
581
 
            if mainline_parent_id is not None:
582
 
                if mainline_parent_id not in revision.parent_ids:
583
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
584
 
                                        "parents of {%s}"
585
 
                                        % (mainline_parent_id, revision_id))
586
 
            mainline_parent_id = revision_id
587
 
        return BranchCheckResult(self)
588
 
 
589
 
    def _get_checkout_format(self):
590
 
        """Return the most suitable metadir for a checkout of this branch.
591
 
        Weaves are used if this branch's repostory uses weaves.
592
 
        """
593
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
594
 
            from bzrlib import repository
595
 
            format = bzrdir.BzrDirMetaFormat1()
596
 
            format.repository_format = repository.RepositoryFormat7()
597
 
        else:
598
 
            format = self.repository.bzrdir.cloning_metadir()
599
 
        return format
600
 
 
601
 
    def create_checkout(self, to_location, revision_id=None, 
602
 
                        lightweight=False):
603
 
        """Create a checkout of a branch.
604
 
        
605
 
        :param to_location: The url to produce the checkout at
606
 
        :param revision_id: The revision to check out
607
 
        :param lightweight: If True, produce a lightweight checkout, otherwise,
608
 
        produce a bound branch (heavyweight checkout)
609
 
        :return: The tree of the created checkout
610
 
        """
611
 
        t = transport.get_transport(to_location)
612
 
        try:
613
 
            t.mkdir('.')
614
 
        except errors.FileExists:
615
 
            pass
616
 
        if lightweight:
617
 
            checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
618
 
            BranchReferenceFormat().initialize(checkout, self)
619
 
        else:
620
 
            format = self._get_checkout_format()
621
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
622
 
                to_location, force_new_tree=False, format=format)
623
 
            checkout = checkout_branch.bzrdir
624
 
            checkout_branch.bind(self)
625
 
            # pull up to the specified revision_id to set the initial 
626
 
            # branch tip correctly, and seed it with history.
627
 
            checkout_branch.pull(self, stop_revision=revision_id)
628
 
        return checkout.create_workingtree(revision_id)
629
 
 
630
 
 
631
 
class BranchFormat(object):
632
 
    """An encapsulation of the initialization and open routines for a format.
633
 
 
634
 
    Formats provide three things:
635
 
     * An initialization routine,
636
 
     * a format string,
637
 
     * an open routine.
638
 
 
639
 
    Formats are placed in an dict by their format string for reference 
640
 
    during branch opening. Its not required that these be instances, they
641
 
    can be classes themselves with class methods - it simply depends on 
642
 
    whether state is needed for a given format or not.
643
 
 
644
 
    Once a format is deprecated, just deprecate the initialize and open
645
 
    methods on the format class. Do not deprecate the object, as the 
646
 
    object will be created every time regardless.
647
 
    """
648
 
 
649
 
    _default_format = None
650
 
    """The default format used for new branches."""
651
 
 
652
 
    _formats = {}
653
 
    """The known formats."""
654
 
 
655
 
    @classmethod
656
 
    def find_format(klass, a_bzrdir):
657
 
        """Return the format for the branch object in a_bzrdir."""
658
 
        try:
659
 
            transport = a_bzrdir.get_branch_transport(None)
660
 
            format_string = transport.get("format").read()
661
 
            return klass._formats[format_string]
662
 
        except NoSuchFile:
663
 
            raise NotBranchError(path=transport.base)
664
 
        except KeyError:
665
 
            raise errors.UnknownFormatError(format=format_string)
666
 
 
667
 
    @classmethod
668
 
    def get_default_format(klass):
669
 
        """Return the current default format."""
670
 
        return klass._default_format
671
 
 
672
 
    def get_format_string(self):
673
 
        """Return the ASCII format string that identifies this format."""
674
 
        raise NotImplementedError(self.get_format_string)
675
 
 
676
 
    def get_format_description(self):
677
 
        """Return the short format description for this format."""
678
 
        raise NotImplementedError(self.get_format_string)
679
 
 
680
 
    def initialize(self, a_bzrdir):
681
 
        """Create a branch of this format in a_bzrdir."""
682
 
        raise NotImplementedError(self.initialize)
683
 
 
684
 
    def is_supported(self):
685
 
        """Is this format supported?
686
 
 
687
 
        Supported formats can be initialized and opened.
688
 
        Unsupported formats may not support initialization or committing or 
689
 
        some other features depending on the reason for not being supported.
690
 
        """
691
 
        return True
692
 
 
693
 
    def open(self, a_bzrdir, _found=False):
694
 
        """Return the branch object for a_bzrdir
695
 
 
696
 
        _found is a private parameter, do not use it. It is used to indicate
697
 
               if format probing has already be done.
698
 
        """
699
 
        raise NotImplementedError(self.open)
700
 
 
701
 
    @classmethod
702
 
    def register_format(klass, format):
703
 
        klass._formats[format.get_format_string()] = format
704
 
 
705
 
    @classmethod
706
 
    def set_default_format(klass, format):
707
 
        klass._default_format = format
708
 
 
709
 
    @classmethod
710
 
    def unregister_format(klass, format):
711
 
        assert klass._formats[format.get_format_string()] is format
712
 
        del klass._formats[format.get_format_string()]
713
 
 
714
 
    def __str__(self):
715
 
        return self.get_format_string().rstrip()
716
 
 
717
 
 
718
 
class BzrBranchFormat4(BranchFormat):
719
 
    """Bzr branch format 4.
720
 
 
721
 
    This format has:
722
 
     - a revision-history file.
723
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
724
 
    """
725
 
 
726
 
    def get_format_description(self):
727
 
        """See BranchFormat.get_format_description()."""
728
 
        return "Branch format 4"
729
 
 
730
 
    def initialize(self, a_bzrdir):
731
 
        """Create a branch of this format in a_bzrdir."""
732
 
        mutter('creating branch in %s', a_bzrdir.transport.base)
733
 
        branch_transport = a_bzrdir.get_branch_transport(self)
734
 
        utf8_files = [('revision-history', ''),
735
 
                      ('branch-name', ''),
736
 
                      ]
737
 
        control_files = lockable_files.LockableFiles(branch_transport,
738
 
                             'branch-lock', lockable_files.TransportLock)
739
 
        control_files.create_lock()
740
 
        control_files.lock_write()
741
 
        try:
742
 
            for file, content in utf8_files:
743
 
                control_files.put_utf8(file, content)
744
 
        finally:
745
 
            control_files.unlock()
746
 
        return self.open(a_bzrdir, _found=True)
747
 
 
748
 
    def __init__(self):
749
 
        super(BzrBranchFormat4, self).__init__()
750
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
751
 
 
752
 
    def open(self, a_bzrdir, _found=False):
753
 
        """Return the branch object for a_bzrdir
754
 
 
755
 
        _found is a private parameter, do not use it. It is used to indicate
756
 
               if format probing has already be done.
757
 
        """
758
 
        if not _found:
759
 
            # we are being called directly and must probe.
760
 
            raise NotImplementedError
761
 
        return BzrBranch(_format=self,
762
 
                         _control_files=a_bzrdir._control_files,
763
 
                         a_bzrdir=a_bzrdir,
764
 
                         _repository=a_bzrdir.open_repository())
765
 
 
766
 
    def __str__(self):
767
 
        return "Bazaar-NG branch format 4"
768
 
 
769
 
 
770
 
class BzrBranchFormat5(BranchFormat):
771
 
    """Bzr branch format 5.
772
 
 
773
 
    This format has:
774
 
     - a revision-history file.
775
 
     - a format string
776
 
     - a lock dir guarding the branch itself
777
 
     - all of this stored in a branch/ subdirectory
778
 
     - works with shared repositories.
779
 
 
780
 
    This format is new in bzr 0.8.
781
 
    """
782
 
 
783
 
    def get_format_string(self):
784
 
        """See BranchFormat.get_format_string()."""
785
 
        return "Bazaar-NG branch format 5\n"
786
 
 
787
 
    def get_format_description(self):
788
 
        """See BranchFormat.get_format_description()."""
789
 
        return "Branch format 5"
790
 
        
791
 
    def initialize(self, a_bzrdir):
792
 
        """Create a branch of this format in a_bzrdir."""
793
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
794
 
        branch_transport = a_bzrdir.get_branch_transport(self)
795
 
        utf8_files = [('revision-history', ''),
796
 
                      ('branch-name', ''),
797
 
                      ]
798
 
        control_files = lockable_files.LockableFiles(branch_transport, 'lock',
799
 
                                                     lockdir.LockDir)
800
 
        control_files.create_lock()
801
 
        control_files.lock_write()
802
 
        control_files.put_utf8('format', self.get_format_string())
803
 
        try:
804
 
            for file, content in utf8_files:
805
 
                control_files.put_utf8(file, content)
806
 
        finally:
807
 
            control_files.unlock()
808
 
        return self.open(a_bzrdir, _found=True, )
809
 
 
810
 
    def __init__(self):
811
 
        super(BzrBranchFormat5, self).__init__()
812
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
813
 
 
814
 
    def open(self, a_bzrdir, _found=False):
815
 
        """Return the branch object for a_bzrdir
816
 
 
817
 
        _found is a private parameter, do not use it. It is used to indicate
818
 
               if format probing has already be done.
819
 
        """
820
 
        if not _found:
821
 
            format = BranchFormat.find_format(a_bzrdir)
822
 
            assert format.__class__ == self.__class__
823
 
        transport = a_bzrdir.get_branch_transport(None)
824
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
825
 
                                                     lockdir.LockDir)
826
 
        return BzrBranch5(_format=self,
827
 
                          _control_files=control_files,
828
 
                          a_bzrdir=a_bzrdir,
829
 
                          _repository=a_bzrdir.find_repository())
830
 
 
831
 
    def __str__(self):
832
 
        return "Bazaar-NG Metadir branch format 5"
833
 
 
834
 
 
835
 
class BranchReferenceFormat(BranchFormat):
836
 
    """Bzr branch reference format.
837
 
 
838
 
    Branch references are used in implementing checkouts, they
839
 
    act as an alias to the real branch which is at some other url.
840
 
 
841
 
    This format has:
842
 
     - A location file
843
 
     - a format string
844
 
    """
845
 
 
846
 
    def get_format_string(self):
847
 
        """See BranchFormat.get_format_string()."""
848
 
        return "Bazaar-NG Branch Reference Format 1\n"
849
 
 
850
 
    def get_format_description(self):
851
 
        """See BranchFormat.get_format_description()."""
852
 
        return "Checkout reference format 1"
853
 
        
854
 
    def initialize(self, a_bzrdir, target_branch=None):
855
 
        """Create a branch of this format in a_bzrdir."""
856
 
        if target_branch is None:
857
 
            # this format does not implement branch itself, thus the implicit
858
 
            # creation contract must see it as uninitializable
859
 
            raise errors.UninitializableFormat(self)
860
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
861
 
        branch_transport = a_bzrdir.get_branch_transport(self)
862
 
        branch_transport.put_bytes('location',
863
 
            target_branch.bzrdir.root_transport.base)
864
 
        branch_transport.put_bytes('format', self.get_format_string())
865
 
        return self.open(a_bzrdir, _found=True)
866
 
 
867
 
    def __init__(self):
868
 
        super(BranchReferenceFormat, self).__init__()
869
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
870
 
 
871
 
    def _make_reference_clone_function(format, a_branch):
872
 
        """Create a clone() routine for a branch dynamically."""
873
 
        def clone(to_bzrdir, revision_id=None):
874
 
            """See Branch.clone()."""
875
 
            return format.initialize(to_bzrdir, a_branch)
876
 
            # cannot obey revision_id limits when cloning a reference ...
877
 
            # FIXME RBC 20060210 either nuke revision_id for clone, or
878
 
            # emit some sort of warning/error to the caller ?!
879
 
        return clone
880
 
 
881
 
    def open(self, a_bzrdir, _found=False):
882
 
        """Return the branch that the branch reference in a_bzrdir points at.
883
 
 
884
 
        _found is a private parameter, do not use it. It is used to indicate
885
 
               if format probing has already be done.
886
 
        """
887
 
        if not _found:
888
 
            format = BranchFormat.find_format(a_bzrdir)
889
 
            assert format.__class__ == self.__class__
890
 
        transport = a_bzrdir.get_branch_transport(None)
891
 
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
892
 
        result = real_bzrdir.open_branch()
893
 
        # this changes the behaviour of result.clone to create a new reference
894
 
        # rather than a copy of the content of the branch.
895
 
        # I did not use a proxy object because that needs much more extensive
896
 
        # testing, and we are only changing one behaviour at the moment.
897
 
        # If we decide to alter more behaviours - i.e. the implicit nickname
898
 
        # then this should be refactored to introduce a tested proxy branch
899
 
        # and a subclass of that for use in overriding clone() and ....
900
 
        # - RBC 20060210
901
 
        result.clone = self._make_reference_clone_function(result)
902
 
        return result
903
 
 
904
 
 
905
 
# formats which have no format string are not discoverable
906
 
# and not independently creatable, so are not registered.
907
 
__default_format = BzrBranchFormat5()
908
 
BranchFormat.register_format(__default_format)
909
 
BranchFormat.register_format(BranchReferenceFormat())
910
 
BranchFormat.set_default_format(__default_format)
911
 
_legacy_formats = [BzrBranchFormat4(),
912
 
                   ]
913
 
 
914
 
class BzrBranch(Branch):
915
 
    """A branch stored in the actual filesystem.
916
 
 
917
 
    Note that it's "local" in the context of the filesystem; it doesn't
918
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
919
 
    it's writable, and can be accessed via the normal filesystem API.
920
 
    """
 
1130
        """
 
1131
        self.lock_write()
 
1132
        try:
 
1133
            ## TODO: Option to move IDs only
 
1134
            assert not isinstance(from_paths, basestring)
 
1135
            tree = self.working_tree()
 
1136
            inv = tree.inventory
 
1137
            to_abs = self.abspath(to_name)
 
1138
            if not isdir(to_abs):
 
1139
                raise BzrError("destination %r is not a directory" % to_abs)
 
1140
            if not tree.has_filename(to_name):
 
1141
                raise BzrError("destination %r not in working directory" % to_abs)
 
1142
            to_dir_id = inv.path2id(to_name)
 
1143
            if to_dir_id == None and to_name != '':
 
1144
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1145
            to_dir_ie = inv[to_dir_id]
 
1146
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1147
                raise BzrError("destination %r is not a directory" % to_abs)
 
1148
 
 
1149
            to_idpath = inv.get_idpath(to_dir_id)
 
1150
 
 
1151
            for f in from_paths:
 
1152
                if not tree.has_filename(f):
 
1153
                    raise BzrError("%r does not exist in working tree" % f)
 
1154
                f_id = inv.path2id(f)
 
1155
                if f_id == None:
 
1156
                    raise BzrError("%r is not versioned" % f)
 
1157
                name_tail = splitpath(f)[-1]
 
1158
                dest_path = appendpath(to_name, name_tail)
 
1159
                if tree.has_filename(dest_path):
 
1160
                    raise BzrError("destination %r already exists" % dest_path)
 
1161
                if f_id in to_idpath:
 
1162
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1163
 
 
1164
            # OK, so there's a race here, it's possible that someone will
 
1165
            # create a file in this interval and then the rename might be
 
1166
            # left half-done.  But we should have caught most problems.
 
1167
 
 
1168
            for f in from_paths:
 
1169
                name_tail = splitpath(f)[-1]
 
1170
                dest_path = appendpath(to_name, name_tail)
 
1171
                print "%s => %s" % (f, dest_path)
 
1172
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1173
                try:
 
1174
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1175
                except OSError, e:
 
1176
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1177
                            ["rename rolled back"])
 
1178
 
 
1179
            self._write_inventory(inv)
 
1180
        finally:
 
1181
            self.unlock()
 
1182
 
 
1183
 
 
1184
    def revert(self, filenames, old_tree=None, backups=True):
 
1185
        """Restore selected files to the versions from a previous tree.
 
1186
 
 
1187
        backups
 
1188
            If true (default) backups are made of files before
 
1189
            they're renamed.
 
1190
        """
 
1191
        from bzrlib.errors import NotVersionedError, BzrError
 
1192
        from bzrlib.atomicfile import AtomicFile
 
1193
        from bzrlib.osutils import backup_file
 
1194
        
 
1195
        inv = self.read_working_inventory()
 
1196
        if old_tree is None:
 
1197
            old_tree = self.basis_tree()
 
1198
        old_inv = old_tree.inventory
 
1199
 
 
1200
        nids = []
 
1201
        for fn in filenames:
 
1202
            file_id = inv.path2id(fn)
 
1203
            if not file_id:
 
1204
                raise NotVersionedError("not a versioned file", fn)
 
1205
            if not old_inv.has_id(file_id):
 
1206
                raise BzrError("file not present in old tree", fn, file_id)
 
1207
            nids.append((fn, file_id))
 
1208
            
 
1209
        # TODO: Rename back if it was previously at a different location
 
1210
 
 
1211
        # TODO: If given a directory, restore the entire contents from
 
1212
        # the previous version.
 
1213
 
 
1214
        # TODO: Make a backup to a temporary file.
 
1215
 
 
1216
        # TODO: If the file previously didn't exist, delete it?
 
1217
        for fn, file_id in nids:
 
1218
            backup_file(fn)
 
1219
            
 
1220
            f = AtomicFile(fn, 'wb')
 
1221
            try:
 
1222
                f.write(old_tree.get_file(file_id).read())
 
1223
                f.commit()
 
1224
            finally:
 
1225
                f.close()
 
1226
 
 
1227
 
 
1228
    def pending_merges(self):
 
1229
        """Return a list of pending merges.
 
1230
 
 
1231
        These are revisions that have been merged into the working
 
1232
        directory but not yet committed.
 
1233
        """
 
1234
        cfn = self.controlfilename('pending-merges')
 
1235
        if not os.path.exists(cfn):
 
1236
            return []
 
1237
        p = []
 
1238
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1239
            p.append(l.rstrip('\n'))
 
1240
        return p
 
1241
 
 
1242
 
 
1243
    def add_pending_merge(self, revision_id):
 
1244
        from bzrlib.revision import validate_revision_id
 
1245
 
 
1246
        validate_revision_id(revision_id)
 
1247
 
 
1248
        p = self.pending_merges()
 
1249
        if revision_id in p:
 
1250
            return
 
1251
        p.append(revision_id)
 
1252
        self.set_pending_merges(p)
 
1253
 
 
1254
 
 
1255
    def set_pending_merges(self, rev_list):
 
1256
        from bzrlib.atomicfile import AtomicFile
 
1257
        self.lock_write()
 
1258
        try:
 
1259
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1260
            try:
 
1261
                for l in rev_list:
 
1262
                    print >>f, l
 
1263
                f.commit()
 
1264
            finally:
 
1265
                f.close()
 
1266
        finally:
 
1267
            self.unlock()
 
1268
 
 
1269
 
 
1270
 
 
1271
class ScratchBranch(Branch):
 
1272
    """Special test class: a branch that cleans up after itself.
 
1273
 
 
1274
    >>> b = ScratchBranch()
 
1275
    >>> isdir(b.base)
 
1276
    True
 
1277
    >>> bd = b.base
 
1278
    >>> b.destroy()
 
1279
    >>> isdir(bd)
 
1280
    False
 
1281
    """
 
1282
    def __init__(self, files=[], dirs=[], base=None):
 
1283
        """Make a test branch.
 
1284
 
 
1285
        This creates a temporary directory and runs init-tree in it.
 
1286
 
 
1287
        If any files are listed, they are created in the working copy.
 
1288
        """
 
1289
        from tempfile import mkdtemp
 
1290
        init = False
 
1291
        if base is None:
 
1292
            base = mkdtemp()
 
1293
            init = True
 
1294
        Branch.__init__(self, base, init=init)
 
1295
        for d in dirs:
 
1296
            os.mkdir(self.abspath(d))
 
1297
            
 
1298
        for f in files:
 
1299
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1300
 
 
1301
 
 
1302
    def clone(self):
 
1303
        """
 
1304
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1305
        >>> clone = orig.clone()
 
1306
        >>> os.path.samefile(orig.base, clone.base)
 
1307
        False
 
1308
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1309
        True
 
1310
        """
 
1311
        from shutil import copytree
 
1312
        from tempfile import mkdtemp
 
1313
        base = mkdtemp()
 
1314
        os.rmdir(base)
 
1315
        copytree(self.base, base, symlinks=True)
 
1316
        return ScratchBranch(base=base)
 
1317
        
 
1318
    def __del__(self):
 
1319
        self.destroy()
 
1320
 
 
1321
    def destroy(self):
 
1322
        """Destroy the test branch, removing the scratch directory."""
 
1323
        from shutil import rmtree
 
1324
        try:
 
1325
            if self.base:
 
1326
                mutter("delete ScratchBranch %s" % self.base)
 
1327
                rmtree(self.base)
 
1328
        except OSError, e:
 
1329
            # Work around for shutil.rmtree failing on Windows when
 
1330
            # readonly files are encountered
 
1331
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1332
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1333
                for name in files:
 
1334
                    os.chmod(os.path.join(root, name), 0700)
 
1335
            rmtree(self.base)
 
1336
        self.base = None
 
1337
 
921
1338
    
922
 
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
923
 
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
924
 
                 _control_files=None, a_bzrdir=None, _repository=None):
925
 
        """Create new branch object at a particular location.
926
 
 
927
 
        transport -- A Transport object, defining how to access files.
928
 
        
929
 
        init -- If True, create new control files in a previously
930
 
             unversioned directory.  If False, the branch must already
931
 
             be versioned.
932
 
 
933
 
        relax_version_check -- If true, the usual check for the branch
934
 
            version is not applied.  This is intended only for
935
 
            upgrade/recovery type use; it's not guaranteed that
936
 
            all operations will work on old format branches.
937
 
        """
938
 
        if a_bzrdir is None:
939
 
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
940
 
        else:
941
 
            self.bzrdir = a_bzrdir
942
 
        self._transport = self.bzrdir.transport.clone('..')
943
 
        self._base = self._transport.base
944
 
        self._format = _format
945
 
        if _control_files is None:
946
 
            raise ValueError('BzrBranch _control_files is None')
947
 
        self.control_files = _control_files
948
 
        if deprecated_passed(init):
949
 
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
950
 
                 "deprecated as of bzr 0.8. Please use Branch.create().",
951
 
                 DeprecationWarning,
952
 
                 stacklevel=2)
953
 
            if init:
954
 
                # this is slower than before deprecation, oh well never mind.
955
 
                # -> its deprecated.
956
 
                self._initialize(transport.base)
957
 
        self._check_format(_format)
958
 
        if deprecated_passed(relax_version_check):
959
 
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
960
 
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
961
 
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
962
 
                 "open() method.",
963
 
                 DeprecationWarning,
964
 
                 stacklevel=2)
965
 
            if (not relax_version_check
966
 
                and not self._format.is_supported()):
967
 
                raise errors.UnsupportedFormatError(format=fmt)
968
 
        if deprecated_passed(transport):
969
 
            warn("BzrBranch.__init__(transport=XXX...): The transport "
970
 
                 "parameter is deprecated as of bzr 0.8. "
971
 
                 "Please use Branch.open, or bzrdir.open_branch().",
972
 
                 DeprecationWarning,
973
 
                 stacklevel=2)
974
 
        self.repository = _repository
975
 
 
976
 
    def __str__(self):
977
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
978
 
 
979
 
    __repr__ = __str__
980
 
 
981
 
    def _get_base(self):
982
 
        return self._base
983
 
 
984
 
    base = property(_get_base, doc="The URL for the root of this branch.")
985
 
 
986
 
    def _finish_transaction(self):
987
 
        """Exit the current transaction."""
988
 
        return self.control_files._finish_transaction()
989
 
 
990
 
    def get_transaction(self):
991
 
        """Return the current active transaction.
992
 
 
993
 
        If no transaction is active, this returns a passthrough object
994
 
        for which all data is immediately flushed and no caching happens.
995
 
        """
996
 
        # this is an explicit function so that we can do tricky stuff
997
 
        # when the storage in rev_storage is elsewhere.
998
 
        # we probably need to hook the two 'lock a location' and 
999
 
        # 'have a transaction' together more delicately, so that
1000
 
        # we can have two locks (branch and storage) and one transaction
1001
 
        # ... and finishing the transaction unlocks both, but unlocking
1002
 
        # does not. - RBC 20051121
1003
 
        return self.control_files.get_transaction()
1004
 
 
1005
 
    def _set_transaction(self, transaction):
1006
 
        """Set a new active transaction."""
1007
 
        return self.control_files._set_transaction(transaction)
1008
 
 
1009
 
    def abspath(self, name):
1010
 
        """See Branch.abspath."""
1011
 
        return self.control_files._transport.abspath(name)
1012
 
 
1013
 
    def _check_format(self, format):
1014
 
        """Identify the branch format if needed.
1015
 
 
1016
 
        The format is stored as a reference to the format object in
1017
 
        self._format for code that needs to check it later.
1018
 
 
1019
 
        The format parameter is either None or the branch format class
1020
 
        used to open this branch.
1021
 
 
1022
 
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1023
 
        """
1024
 
        if format is None:
1025
 
            format = BranchFormat.find_format(self.bzrdir)
1026
 
        self._format = format
1027
 
        mutter("got branch format %s", self._format)
1028
 
 
1029
 
    @needs_read_lock
1030
 
    def get_root_id(self):
1031
 
        """See Branch.get_root_id."""
1032
 
        tree = self.repository.revision_tree(self.last_revision())
1033
 
        return tree.inventory.root.file_id
1034
 
 
1035
 
    def is_locked(self):
1036
 
        return self.control_files.is_locked()
1037
 
 
1038
 
    def lock_write(self):
1039
 
        self.repository.lock_write()
1040
 
        try:
1041
 
            self.control_files.lock_write()
1042
 
        except:
1043
 
            self.repository.unlock()
1044
 
            raise
1045
 
 
1046
 
    def lock_read(self):
1047
 
        self.repository.lock_read()
1048
 
        try:
1049
 
            self.control_files.lock_read()
1050
 
        except:
1051
 
            self.repository.unlock()
1052
 
            raise
1053
 
 
1054
 
    def unlock(self):
1055
 
        # TODO: test for failed two phase locks. This is known broken.
1056
 
        try:
1057
 
            self.control_files.unlock()
1058
 
        finally:
1059
 
            self.repository.unlock()
1060
 
        
1061
 
    def peek_lock_mode(self):
1062
 
        if self.control_files._lock_count == 0:
1063
 
            return None
1064
 
        else:
1065
 
            return self.control_files._lock_mode
1066
 
 
1067
 
    def get_physical_lock_status(self):
1068
 
        return self.control_files.get_physical_lock_status()
1069
 
 
1070
 
    @needs_read_lock
1071
 
    def print_file(self, file, revision_id):
1072
 
        """See Branch.print_file."""
1073
 
        return self.repository.print_file(file, revision_id)
1074
 
 
1075
 
    @needs_write_lock
1076
 
    def append_revision(self, *revision_ids):
1077
 
        """See Branch.append_revision."""
1078
 
        for revision_id in revision_ids:
1079
 
            mutter("add {%s} to revision-history" % revision_id)
1080
 
        rev_history = self.revision_history()
1081
 
        rev_history.extend(revision_ids)
1082
 
        self.set_revision_history(rev_history)
1083
 
 
1084
 
    @needs_write_lock
1085
 
    def set_revision_history(self, rev_history):
1086
 
        """See Branch.set_revision_history."""
1087
 
        self.control_files.put_utf8(
1088
 
            'revision-history', '\n'.join(rev_history))
1089
 
        transaction = self.get_transaction()
1090
 
        history = transaction.map.find_revision_history()
1091
 
        if history is not None:
1092
 
            # update the revision history in the identity map.
1093
 
            history[:] = list(rev_history)
1094
 
            # this call is disabled because revision_history is 
1095
 
            # not really an object yet, and the transaction is for objects.
1096
 
            # transaction.register_dirty(history)
1097
 
        else:
1098
 
            transaction.map.add_revision_history(rev_history)
1099
 
            # this call is disabled because revision_history is 
1100
 
            # not really an object yet, and the transaction is for objects.
1101
 
            # transaction.register_clean(history)
1102
 
 
1103
 
    @needs_read_lock
1104
 
    def revision_history(self):
1105
 
        """See Branch.revision_history."""
1106
 
        transaction = self.get_transaction()
1107
 
        history = transaction.map.find_revision_history()
1108
 
        if history is not None:
1109
 
            # mutter("cache hit for revision-history in %s", self)
1110
 
            return list(history)
1111
 
        decode_utf8 = cache_utf8.decode
1112
 
        history = [decode_utf8(l.rstrip('\r\n')) for l in
1113
 
                self.control_files.get('revision-history').readlines()]
1114
 
        transaction.map.add_revision_history(history)
1115
 
        # this call is disabled because revision_history is 
1116
 
        # not really an object yet, and the transaction is for objects.
1117
 
        # transaction.register_clean(history, precious=True)
1118
 
        return list(history)
1119
 
 
1120
 
    @needs_write_lock
1121
 
    def generate_revision_history(self, revision_id, last_rev=None, 
1122
 
        other_branch=None):
1123
 
        """Create a new revision history that will finish with revision_id.
1124
 
        
1125
 
        :param revision_id: the new tip to use.
1126
 
        :param last_rev: The previous last_revision. If not None, then this
1127
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1128
 
        :param other_branch: The other branch that DivergedBranches should
1129
 
            raise with respect to.
1130
 
        """
1131
 
        # stop_revision must be a descendant of last_revision
1132
 
        stop_graph = self.repository.get_revision_graph(revision_id)
1133
 
        if last_rev is not None and last_rev not in stop_graph:
1134
 
            # our previous tip is not merged into stop_revision
1135
 
            raise errors.DivergedBranches(self, other_branch)
1136
 
        # make a new revision history from the graph
1137
 
        current_rev_id = revision_id
1138
 
        new_history = []
1139
 
        while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1140
 
            new_history.append(current_rev_id)
1141
 
            current_rev_id_parents = stop_graph[current_rev_id]
1142
 
            try:
1143
 
                current_rev_id = current_rev_id_parents[0]
1144
 
            except IndexError:
1145
 
                current_rev_id = None
1146
 
        new_history.reverse()
1147
 
        self.set_revision_history(new_history)
1148
 
 
1149
 
    @needs_write_lock
1150
 
    def update_revisions(self, other, stop_revision=None):
1151
 
        """See Branch.update_revisions."""
1152
 
        other.lock_read()
1153
 
        try:
1154
 
            if stop_revision is None:
1155
 
                stop_revision = other.last_revision()
1156
 
                if stop_revision is None:
1157
 
                    # if there are no commits, we're done.
1158
 
                    return
1159
 
            # whats the current last revision, before we fetch [and change it
1160
 
            # possibly]
1161
 
            last_rev = self.last_revision()
1162
 
            # we fetch here regardless of whether we need to so that we pickup
1163
 
            # filled in ghosts.
1164
 
            self.fetch(other, stop_revision)
1165
 
            my_ancestry = self.repository.get_ancestry(last_rev)
1166
 
            if stop_revision in my_ancestry:
1167
 
                # last_revision is a descendant of stop_revision
1168
 
                return
1169
 
            self.generate_revision_history(stop_revision, last_rev=last_rev,
1170
 
                other_branch=other)
1171
 
        finally:
1172
 
            other.unlock()
1173
 
 
1174
 
    def basis_tree(self):
1175
 
        """See Branch.basis_tree."""
1176
 
        return self.repository.revision_tree(self.last_revision())
1177
 
 
1178
 
    @deprecated_method(zero_eight)
1179
 
    def working_tree(self):
1180
 
        """Create a Working tree object for this branch."""
1181
 
 
1182
 
        from bzrlib.transport.local import LocalTransport
1183
 
        if (self.base.find('://') != -1 or 
1184
 
            not isinstance(self._transport, LocalTransport)):
1185
 
            raise NoWorkingTree(self.base)
1186
 
        return self.bzrdir.open_workingtree()
1187
 
 
1188
 
    @needs_write_lock
1189
 
    def pull(self, source, overwrite=False, stop_revision=None):
1190
 
        """See Branch.pull."""
1191
 
        source.lock_read()
1192
 
        try:
1193
 
            old_count = len(self.revision_history())
1194
 
            try:
1195
 
                self.update_revisions(source, stop_revision)
1196
 
            except DivergedBranches:
1197
 
                if not overwrite:
1198
 
                    raise
1199
 
            if overwrite:
1200
 
                self.set_revision_history(source.revision_history())
1201
 
            new_count = len(self.revision_history())
1202
 
            return new_count - old_count
1203
 
        finally:
1204
 
            source.unlock()
1205
 
 
1206
 
    def get_parent(self):
1207
 
        """See Branch.get_parent."""
1208
 
 
1209
 
        _locs = ['parent', 'pull', 'x-pull']
1210
 
        assert self.base[-1] == '/'
1211
 
        for l in _locs:
1212
 
            try:
1213
 
                parent = self.control_files.get(l).read().strip('\n')
1214
 
            except NoSuchFile:
1215
 
                continue
1216
 
            # This is an old-format absolute path to a local branch
1217
 
            # turn it into a url
1218
 
            if parent.startswith('/'):
1219
 
                parent = urlutils.local_path_to_url(parent.decode('utf8'))
1220
 
            try:
1221
 
                return urlutils.join(self.base[:-1], parent)
1222
 
            except errors.InvalidURLJoin, e:
1223
 
                raise errors.InaccessibleParent(parent, self.base)
1224
 
        return None
1225
 
 
1226
 
    def get_push_location(self):
1227
 
        """See Branch.get_push_location."""
1228
 
        push_loc = self.get_config().get_user_option('push_location')
1229
 
        return push_loc
1230
 
 
1231
 
    def set_push_location(self, location):
1232
 
        """See Branch.set_push_location."""
1233
 
        self.get_config().set_user_option('push_location', location, 
1234
 
                                          local=True)
1235
 
 
1236
 
    @needs_write_lock
1237
 
    def set_parent(self, url):
1238
 
        """See Branch.set_parent."""
1239
 
        # TODO: Maybe delete old location files?
1240
 
        # URLs should never be unicode, even on the local fs,
1241
 
        # FIXUP this and get_parent in a future branch format bump:
1242
 
        # read and rewrite the file, and have the new format code read
1243
 
        # using .get not .get_utf8. RBC 20060125
1244
 
        if url is None:
1245
 
            self.control_files._transport.delete('parent')
1246
 
        else:
1247
 
            if isinstance(url, unicode):
1248
 
                try: 
1249
 
                    url = url.encode('ascii')
1250
 
                except UnicodeEncodeError:
1251
 
                    raise bzrlib.errors.InvalidURL(url,
1252
 
                        "Urls must be 7-bit ascii, "
1253
 
                        "use bzrlib.urlutils.escape")
1254
 
                    
1255
 
            url = urlutils.relative_url(self.base, url)
1256
 
            self.control_files.put('parent', StringIO(url + '\n'))
1257
 
 
1258
 
    @deprecated_function(zero_nine)
1259
 
    def tree_config(self):
1260
 
        """DEPRECATED; call get_config instead.  
1261
 
        TreeConfig has become part of BranchConfig."""
1262
 
        return TreeConfig(self)
1263
 
 
1264
 
 
1265
 
class BzrBranch5(BzrBranch):
1266
 
    """A format 5 branch. This supports new features over plan branches.
1267
 
 
1268
 
    It has support for a master_branch which is the data for bound branches.
1269
 
    """
1270
 
 
1271
 
    def __init__(self,
1272
 
                 _format,
1273
 
                 _control_files,
1274
 
                 a_bzrdir,
1275
 
                 _repository):
1276
 
        super(BzrBranch5, self).__init__(_format=_format,
1277
 
                                         _control_files=_control_files,
1278
 
                                         a_bzrdir=a_bzrdir,
1279
 
                                         _repository=_repository)
1280
 
        
1281
 
    @needs_write_lock
1282
 
    def pull(self, source, overwrite=False, stop_revision=None):
1283
 
        """Updates branch.pull to be bound branch aware."""
1284
 
        bound_location = self.get_bound_location()
1285
 
        if source.base != bound_location:
1286
 
            # not pulling from master, so we need to update master.
1287
 
            master_branch = self.get_master_branch()
1288
 
            if master_branch:
1289
 
                master_branch.pull(source)
1290
 
                source = master_branch
1291
 
        return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1292
 
 
1293
 
    def get_bound_location(self):
1294
 
        try:
1295
 
            return self.control_files.get_utf8('bound').read()[:-1]
1296
 
        except errors.NoSuchFile:
1297
 
            return None
1298
 
 
1299
 
    @needs_read_lock
1300
 
    def get_master_branch(self):
1301
 
        """Return the branch we are bound to.
1302
 
        
1303
 
        :return: Either a Branch, or None
1304
 
 
1305
 
        This could memoise the branch, but if thats done
1306
 
        it must be revalidated on each new lock.
1307
 
        So for now we just don't memoise it.
1308
 
        # RBC 20060304 review this decision.
1309
 
        """
1310
 
        bound_loc = self.get_bound_location()
1311
 
        if not bound_loc:
1312
 
            return None
1313
 
        try:
1314
 
            return Branch.open(bound_loc)
1315
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1316
 
            raise errors.BoundBranchConnectionFailure(
1317
 
                    self, bound_loc, e)
1318
 
 
1319
 
    @needs_write_lock
1320
 
    def set_bound_location(self, location):
1321
 
        """Set the target where this branch is bound to.
1322
 
 
1323
 
        :param location: URL to the target branch
1324
 
        """
1325
 
        if location:
1326
 
            self.control_files.put_utf8('bound', location+'\n')
1327
 
        else:
1328
 
            try:
1329
 
                self.control_files._transport.delete('bound')
1330
 
            except NoSuchFile:
1331
 
                return False
 
1339
 
 
1340
######################################################################
 
1341
# predicates
 
1342
 
 
1343
 
 
1344
def is_control_file(filename):
 
1345
    ## FIXME: better check
 
1346
    filename = os.path.normpath(filename)
 
1347
    while filename != '':
 
1348
        head, tail = os.path.split(filename)
 
1349
        ## mutter('check %r for control file' % ((head, tail), ))
 
1350
        if tail == bzrlib.BZRDIR:
1332
1351
            return True
1333
 
 
1334
 
    @needs_write_lock
1335
 
    def bind(self, other):
1336
 
        """Bind this branch to the branch other.
1337
 
 
1338
 
        This does not push or pull data between the branches, though it does
1339
 
        check for divergence to raise an error when the branches are not
1340
 
        either the same, or one a prefix of the other. That behaviour may not
1341
 
        be useful, so that check may be removed in future.
1342
 
        
1343
 
        :param other: The branch to bind to
1344
 
        :type other: Branch
1345
 
        """
1346
 
        # TODO: jam 20051230 Consider checking if the target is bound
1347
 
        #       It is debatable whether you should be able to bind to
1348
 
        #       a branch which is itself bound.
1349
 
        #       Committing is obviously forbidden,
1350
 
        #       but binding itself may not be.
1351
 
        #       Since we *have* to check at commit time, we don't
1352
 
        #       *need* to check here
1353
 
 
1354
 
        # we want to raise diverged if:
1355
 
        # last_rev is not in the other_last_rev history, AND
1356
 
        # other_last_rev is not in our history, and do it without pulling
1357
 
        # history around
1358
 
        last_rev = self.last_revision()
1359
 
        if last_rev is not None:
1360
 
            other.lock_read()
1361
 
            try:
1362
 
                other_last_rev = other.last_revision()
1363
 
                if other_last_rev is not None:
1364
 
                    # neither branch is new, we have to do some work to
1365
 
                    # ascertain diversion.
1366
 
                    remote_graph = other.repository.get_revision_graph(
1367
 
                        other_last_rev)
1368
 
                    local_graph = self.repository.get_revision_graph(last_rev)
1369
 
                    if (last_rev not in remote_graph and
1370
 
                        other_last_rev not in local_graph):
1371
 
                        raise errors.DivergedBranches(self, other)
1372
 
            finally:
1373
 
                other.unlock()
1374
 
        self.set_bound_location(other.base)
1375
 
 
1376
 
    @needs_write_lock
1377
 
    def unbind(self):
1378
 
        """If bound, unbind"""
1379
 
        return self.set_bound_location(None)
1380
 
 
1381
 
    @needs_write_lock
1382
 
    def update(self):
1383
 
        """Synchronise this branch with the master branch if any. 
1384
 
 
1385
 
        :return: None or the last_revision that was pivoted out during the
1386
 
                 update.
1387
 
        """
1388
 
        master = self.get_master_branch()
1389
 
        if master is not None:
1390
 
            old_tip = self.last_revision()
1391
 
            self.pull(master, overwrite=True)
1392
 
            if old_tip in self.repository.get_ancestry(self.last_revision()):
1393
 
                return None
1394
 
            return old_tip
1395
 
        return None
1396
 
 
1397
 
 
1398
 
class BranchTestProviderAdapter(object):
1399
 
    """A tool to generate a suite testing multiple branch formats at once.
1400
 
 
1401
 
    This is done by copying the test once for each transport and injecting
1402
 
    the transport_server, transport_readonly_server, and branch_format
1403
 
    classes into each copy. Each copy is also given a new id() to make it
1404
 
    easy to identify.
1405
 
    """
1406
 
 
1407
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1408
 
        self._transport_server = transport_server
1409
 
        self._transport_readonly_server = transport_readonly_server
1410
 
        self._formats = formats
1411
 
    
1412
 
    def adapt(self, test):
1413
 
        result = TestSuite()
1414
 
        for branch_format, bzrdir_format in self._formats:
1415
 
            new_test = deepcopy(test)
1416
 
            new_test.transport_server = self._transport_server
1417
 
            new_test.transport_readonly_server = self._transport_readonly_server
1418
 
            new_test.bzrdir_format = bzrdir_format
1419
 
            new_test.branch_format = branch_format
1420
 
            def make_new_test_id():
1421
 
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1422
 
                return lambda: new_id
1423
 
            new_test.id = make_new_test_id()
1424
 
            result.addTest(new_test)
1425
 
        return result
1426
 
 
1427
 
 
1428
 
class BranchCheckResult(object):
1429
 
    """Results of checking branch consistency.
1430
 
 
1431
 
    :see: Branch.check
1432
 
    """
1433
 
 
1434
 
    def __init__(self, branch):
1435
 
        self.branch = branch
1436
 
 
1437
 
    def report_results(self, verbose):
1438
 
        """Report the check results via trace.note.
1439
 
        
1440
 
        :param verbose: Requests more detailed display of what was checked,
1441
 
            if any.
1442
 
        """
1443
 
        note('checked branch %s format %s',
1444
 
             self.branch.base,
1445
 
             self.branch._format)
1446
 
 
1447
 
 
1448
 
######################################################################
1449
 
# predicates
1450
 
 
1451
 
 
1452
 
@deprecated_function(zero_eight)
1453
 
def is_control_file(*args, **kwargs):
1454
 
    """See bzrlib.workingtree.is_control_file."""
1455
 
    return bzrlib.workingtree.is_control_file(*args, **kwargs)
 
1352
        if filename == head:
 
1353
            break
 
1354
        filename = head
 
1355
    return False
 
1356
 
 
1357
 
 
1358
 
 
1359
def gen_file_id(name):
 
1360
    """Return new file id.
 
1361
 
 
1362
    This should probably generate proper UUIDs, but for the moment we
 
1363
    cope with just randomness because running uuidgen every time is
 
1364
    slow."""
 
1365
    import re
 
1366
    from binascii import hexlify
 
1367
    from time import time
 
1368
 
 
1369
    # get last component
 
1370
    idx = name.rfind('/')
 
1371
    if idx != -1:
 
1372
        name = name[idx+1 : ]
 
1373
    idx = name.rfind('\\')
 
1374
    if idx != -1:
 
1375
        name = name[idx+1 : ]
 
1376
 
 
1377
    # make it not a hidden file
 
1378
    name = name.lstrip('.')
 
1379
 
 
1380
    # remove any wierd characters; we don't escape them but rather
 
1381
    # just pull them out
 
1382
    name = re.sub(r'[^\w.]', '', name)
 
1383
 
 
1384
    s = hexlify(rand_bytes(8))
 
1385
    return '-'.join((name, compact_date(time()), s))
 
1386
 
 
1387
 
 
1388
def gen_root_id():
 
1389
    """Return a new tree-root file id."""
 
1390
    return gen_file_id('TREE_ROOT')
 
1391