~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-16 02:19:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050516021913-3a933f871079e3fe
- patch from ddaa to create api/ directory 
  before building API docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import sys
19
 
import os
20
 
from cStringIO import StringIO
 
18
from sets import Set
 
19
 
 
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
21
import traceback, socket, fnmatch, difflib, time
 
22
from binascii import hexlify
21
23
 
22
24
import bzrlib
23
 
from bzrlib.trace import mutter, note
24
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
 
     splitpath, \
26
 
     sha_file, appendpath, file_kind
27
 
 
28
 
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
 
                           NoSuchRevision)
30
 
from bzrlib.textui import show_status
31
 
from bzrlib.revision import Revision
32
 
from bzrlib.delta import compare_trees
33
 
from bzrlib.tree import EmptyTree, RevisionTree
34
 
from bzrlib.inventory import Inventory
35
 
from bzrlib.weavestore import WeaveStore
36
 
from bzrlib.store import ImmutableStore
37
 
import bzrlib.xml5
38
 
import bzrlib.ui
39
 
 
40
 
 
41
 
INVENTORY_FILEID = '__inventory'
42
 
ANCESTRY_FILEID = '__ancestry'
43
 
 
44
 
 
45
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
46
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
25
from inventory import Inventory
 
26
from trace import mutter, note
 
27
from tree import Tree, EmptyTree, RevisionTree
 
28
from inventory import InventoryEntry, Inventory
 
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
 
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
 
31
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
32
from store import ImmutableStore
 
33
from revision import Revision
 
34
from errors import bailout, BzrError
 
35
from textui import show_status
 
36
 
 
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
47
38
## TODO: Maybe include checks for common corruption of newlines, etc?
48
39
 
49
40
 
50
 
# TODO: Some operations like log might retrieve the same revisions
51
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
52
 
# cache in memory to make this faster.  In general anything can be
53
 
# cached in memory between lock and unlock operations.
54
 
 
55
 
# TODO: please move the revision-string syntax stuff out of the branch
56
 
# object; it's clutter
57
 
 
58
41
 
59
42
def find_branch(f, **args):
60
43
    if f and (f.startswith('http://') or f.startswith('https://')):
62
45
        return remotebranch.RemoteBranch(f, **args)
63
46
    else:
64
47
        return Branch(f, **args)
65
 
 
66
 
 
67
 
def find_cached_branch(f, cache_root, **args):
68
 
    from remotebranch import RemoteBranch
69
 
    br = find_branch(f, **args)
70
 
    def cacheify(br, store_name):
71
 
        from meta_store import CachedStore
72
 
        cache_path = os.path.join(cache_root, store_name)
73
 
        os.mkdir(cache_path)
74
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
75
 
        setattr(br, store_name, new_store)
76
 
 
77
 
    if isinstance(br, RemoteBranch):
78
 
        cacheify(br, 'inventory_store')
79
 
        cacheify(br, 'text_store')
80
 
        cacheify(br, 'revision_store')
81
 
    return br
82
 
 
83
 
 
84
 
def _relpath(base, path):
85
 
    """Return path relative to base, or raise exception.
86
 
 
87
 
    The path may be either an absolute path or a path relative to the
88
 
    current working directory.
89
 
 
90
 
    Lifted out of Branch.relpath for ease of testing.
91
 
 
92
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
93
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
94
 
    avoids that problem."""
95
 
    rp = os.path.abspath(path)
96
 
 
97
 
    s = []
98
 
    head = rp
99
 
    while len(head) >= len(base):
100
 
        if head == base:
101
 
            break
102
 
        head, tail = os.path.split(head)
103
 
        if tail:
104
 
            s.insert(0, tail)
105
 
    else:
106
 
        from errors import NotBranchError
107
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
108
 
 
109
 
    return os.sep.join(s)
110
48
        
111
49
 
112
50
def find_branch_root(f=None):
117
55
    It is not necessary that f exists.
118
56
 
119
57
    Basically we keep looking up until we find the control directory or
120
 
    run into the root.  If there isn't one, raises NotBranchError.
121
 
    """
 
58
    run into the root."""
122
59
    if f == None:
123
60
        f = os.getcwd()
124
61
    elif hasattr(os.path, 'realpath'):
137
74
        head, tail = os.path.split(f)
138
75
        if head == f:
139
76
            # reached the root, whatever that may be
140
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
77
            raise BzrError('%r is not in a branch' % orig_f)
141
78
        f = head
142
 
 
143
 
 
144
 
 
145
 
# XXX: move into bzrlib.errors; subclass BzrError    
146
 
class DivergedBranches(Exception):
147
 
    def __init__(self, branch1, branch2):
148
 
        self.branch1 = branch1
149
 
        self.branch2 = branch2
150
 
        Exception.__init__(self, "These branches have diverged.")
 
79
    
151
80
 
152
81
 
153
82
######################################################################
154
83
# branch objects
155
84
 
156
 
class Branch(object):
 
85
class Branch:
157
86
    """Branch holding a history of revisions.
158
87
 
159
88
    base
160
89
        Base directory of the branch.
161
 
 
162
 
    _lock_mode
163
 
        None, or 'r' or 'w'
164
 
 
165
 
    _lock_count
166
 
        If _lock_mode is true, a positive count of the number of times the
167
 
        lock has been taken.
168
 
 
169
 
    _lock
170
 
        Lock object from bzrlib.lock.
171
90
    """
172
 
    base = None
173
 
    _lock_mode = None
174
 
    _lock_count = None
175
 
    _lock = None
176
 
    _inventory_weave = None
 
91
    _lockmode = None
177
92
    
178
 
    # Map some sort of prefix into a namespace
179
 
    # stuff like "revno:10", "revid:", etc.
180
 
    # This should match a prefix with a function which accepts
181
 
    REVISION_NAMESPACES = {}
182
 
 
183
 
    def __init__(self, base, init=False, find_root=True):
 
93
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
184
94
        """Create new branch object at a particular location.
185
95
 
186
96
        base -- Base directory for the branch.
203
113
        else:
204
114
            self.base = os.path.realpath(base)
205
115
            if not isdir(self.controlfilename('.')):
206
 
                from errors import NotBranchError
207
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
 
                                     ['use "bzr init" to initialize a new working tree',
209
 
                                      'current bzr can only operate from top-of-tree'])
 
116
                bailout("not a bzr branch: %s" % quotefn(base),
 
117
                        ['use "bzr init" to initialize a new working tree',
 
118
                         'current bzr can only operate from top-of-tree'])
210
119
        self._check_format()
 
120
        self.lock(lock_mode)
211
121
 
212
 
        self.weave_store = WeaveStore(self.controlfilename('weaves'))
 
122
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
213
123
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
124
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
214
125
 
215
126
 
216
127
    def __str__(self):
220
131
    __repr__ = __str__
221
132
 
222
133
 
223
 
    def __del__(self):
224
 
        if self._lock_mode or self._lock:
225
 
            from warnings import warn
226
 
            warn("branch %r was not explicitly unlocked" % self)
227
 
            self._lock.unlock()
228
 
 
229
 
 
230
 
    def lock_write(self):
231
 
        if self._lock_mode:
232
 
            if self._lock_mode != 'w':
233
 
                from errors import LockError
234
 
                raise LockError("can't upgrade to a write lock from %r" %
235
 
                                self._lock_mode)
236
 
            self._lock_count += 1
237
 
        else:
238
 
            from bzrlib.lock import WriteLock
239
 
 
240
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
241
 
            self._lock_mode = 'w'
242
 
            self._lock_count = 1
243
 
 
244
 
 
245
 
    def lock_read(self):
246
 
        if self._lock_mode:
247
 
            assert self._lock_mode in ('r', 'w'), \
248
 
                   "invalid lock mode %r" % self._lock_mode
249
 
            self._lock_count += 1
250
 
        else:
251
 
            from bzrlib.lock import ReadLock
252
 
 
253
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
254
 
            self._lock_mode = 'r'
255
 
            self._lock_count = 1
256
 
                        
257
 
    def unlock(self):
258
 
        if not self._lock_mode:
259
 
            from errors import LockError
260
 
            raise LockError('branch %r is not locked' % (self))
261
 
 
262
 
        if self._lock_count > 1:
263
 
            self._lock_count -= 1
264
 
        else:
265
 
            self._lock.unlock()
266
 
            self._lock = None
267
 
            self._lock_mode = self._lock_count = None
 
134
 
 
135
    def lock(self, mode='w'):
 
136
        """Lock the on-disk branch, excluding other processes."""
 
137
        try:
 
138
            import fcntl, errno
 
139
 
 
140
            if mode == 'w':
 
141
                lm = fcntl.LOCK_EX
 
142
                om = os.O_WRONLY | os.O_CREAT
 
143
            elif mode == 'r':
 
144
                lm = fcntl.LOCK_SH
 
145
                om = os.O_RDONLY
 
146
            else:
 
147
                raise BzrError("invalid locking mode %r" % mode)
 
148
 
 
149
            try:
 
150
                lockfile = os.open(self.controlfilename('branch-lock'), om)
 
151
            except OSError, e:
 
152
                if e.errno == errno.ENOENT:
 
153
                    # might not exist on branches from <0.0.4
 
154
                    self.controlfile('branch-lock', 'w').close()
 
155
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
 
156
                else:
 
157
                    raise e
 
158
            
 
159
            fcntl.lockf(lockfile, lm)
 
160
            def unlock():
 
161
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
162
                os.close(lockfile)
 
163
                self._lockmode = None
 
164
            self.unlock = unlock
 
165
            self._lockmode = mode
 
166
        except ImportError:
 
167
            warning("please write a locking method for platform %r" % sys.platform)
 
168
            def unlock():
 
169
                self._lockmode = None
 
170
            self.unlock = unlock
 
171
            self._lockmode = mode
 
172
 
 
173
 
 
174
    def _need_readlock(self):
 
175
        if self._lockmode not in ['r', 'w']:
 
176
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
177
 
 
178
    def _need_writelock(self):
 
179
        if self._lockmode not in ['w']:
 
180
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
181
 
268
182
 
269
183
    def abspath(self, name):
270
184
        """Return absolute filename for something in the branch"""
271
185
        return os.path.join(self.base, name)
272
186
 
 
187
 
273
188
    def relpath(self, path):
274
189
        """Return path relative to this branch of something inside it.
275
190
 
276
191
        Raises an error if path is not in this branch."""
277
 
        return _relpath(self.base, path)
 
192
        rp = os.path.realpath(path)
 
193
        # FIXME: windows
 
194
        if not rp.startswith(self.base):
 
195
            bailout("path %r is not within branch %r" % (rp, self.base))
 
196
        rp = rp[len(self.base):]
 
197
        rp = rp.lstrip(os.sep)
 
198
        return rp
 
199
 
278
200
 
279
201
    def controlfilename(self, file_or_path):
280
202
        """Return location relative to branch."""
281
 
        if isinstance(file_or_path, basestring):
 
203
        if isinstance(file_or_path, types.StringTypes):
282
204
            file_or_path = [file_or_path]
283
205
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
284
206
 
308
230
        else:
309
231
            raise BzrError("invalid controlfile mode %r" % mode)
310
232
 
 
233
 
 
234
 
311
235
    def _make_control(self):
312
236
        os.mkdir(self.controlfilename([]))
313
237
        self.controlfile('README', 'w').write(
314
238
            "This is a Bazaar-NG control directory.\n"
315
 
            "Do not change any files in this directory.\n")
316
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
 
        for d in ('text-store', 'revision-store',
318
 
                  'weaves'):
 
239
            "Do not change any files in this directory.")
 
240
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
241
        for d in ('text-store', 'inventory-store', 'revision-store'):
319
242
            os.mkdir(self.controlfilename(d))
320
243
        for f in ('revision-history', 'merged-patches',
321
244
                  'pending-merged-patches', 'branch-name',
322
 
                  'branch-lock',
323
 
                  'pending-merges'):
 
245
                  'branch-lock'):
324
246
            self.controlfile(f, 'w').write('')
325
247
        mutter('created control directory in ' + self.base)
326
 
 
327
 
        # if we want per-tree root ids then this is the place to set
328
 
        # them; they're not needed for now and so ommitted for
329
 
        # simplicity.
330
 
        f = self.controlfile('inventory','w')
331
 
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
332
 
        
 
248
        Inventory().write_xml(self.controlfile('inventory','w'))
333
249
 
334
250
 
335
251
    def _check_format(self):
336
252
        """Check this branch format is supported.
337
253
 
338
 
        The format level is stored, as an integer, in
339
 
        self._branch_format for code that needs to check it later.
 
254
        The current tool only supports the current unstable format.
340
255
 
341
256
        In the future, we might need different in-memory Branch
342
257
        classes to support downlevel branches.  But not yet.
343
258
        """
 
259
        # This ignores newlines so that we can open branches created
 
260
        # on Windows from Linux and so on.  I think it might be better
 
261
        # to always make all internal files in unix format.
344
262
        fmt = self.controlfile('branch-format', 'r').read()
345
 
        if fmt == BZR_BRANCH_FORMAT_5:
346
 
            self._branch_format = 5
347
 
        else:
348
 
            raise BzrError('sorry, branch format "%s" not supported; ' 
349
 
                           'use a different bzr version, '
350
 
                           'or run "bzr upgrade", '
351
 
                           'or remove the .bzr directory and "bzr init" again'
352
 
                           % fmt.rstrip('\n\r'))
353
 
 
354
 
    def get_root_id(self):
355
 
        """Return the id of this branches root"""
356
 
        inv = self.read_working_inventory()
357
 
        return inv.root.file_id
358
 
 
359
 
    def set_root_id(self, file_id):
360
 
        inv = self.read_working_inventory()
361
 
        orig_root_id = inv.root.file_id
362
 
        del inv._byid[inv.root.file_id]
363
 
        inv.root.file_id = file_id
364
 
        inv._byid[inv.root.file_id] = inv.root
365
 
        for fid in inv:
366
 
            entry = inv[fid]
367
 
            if entry.parent_id in (None, orig_root_id):
368
 
                entry.parent_id = inv.root.file_id
369
 
        self._write_inventory(inv)
 
263
        fmt.replace('\r\n', '')
 
264
        if fmt != BZR_BRANCH_FORMAT:
 
265
            bailout('sorry, branch format %r not supported' % fmt,
 
266
                    ['use a different bzr version',
 
267
                     'or remove the .bzr directory and "bzr init" again'])
 
268
 
370
269
 
371
270
    def read_working_inventory(self):
372
271
        """Read the working inventory."""
373
 
        self.lock_read()
374
 
        try:
375
 
            # ElementTree does its own conversion from UTF-8, so open in
376
 
            # binary.
377
 
            f = self.controlfile('inventory', 'rb')
378
 
            return bzrlib.xml5.serializer_v5.read_inventory(f)
379
 
        finally:
380
 
            self.unlock()
381
 
            
 
272
        self._need_readlock()
 
273
        before = time.time()
 
274
        # ElementTree does its own conversion from UTF-8, so open in
 
275
        # binary.
 
276
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
277
        mutter("loaded inventory of %d items in %f"
 
278
               % (len(inv), time.time() - before))
 
279
        return inv
 
280
 
382
281
 
383
282
    def _write_inventory(self, inv):
384
283
        """Update the working inventory.
386
285
        That is to say, the inventory describing changes underway, that
387
286
        will be committed to the next revision.
388
287
        """
389
 
        from bzrlib.atomicfile import AtomicFile
390
 
        
391
 
        self.lock_write()
392
 
        try:
393
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
394
 
            try:
395
 
                bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
 
                f.commit()
397
 
            finally:
398
 
                f.close()
399
 
        finally:
400
 
            self.unlock()
401
 
        
 
288
        self._need_writelock()
 
289
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
290
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
291
        tmpfname = self.controlfilename('inventory.tmp')
 
292
        tmpf = file(tmpfname, 'wb')
 
293
        inv.write_xml(tmpf)
 
294
        tmpf.close()
 
295
        inv_fname = self.controlfilename('inventory')
 
296
        if sys.platform == 'win32':
 
297
            os.remove(inv_fname)
 
298
        os.rename(tmpfname, inv_fname)
402
299
        mutter('wrote working inventory')
403
 
            
 
300
 
404
301
 
405
302
    inventory = property(read_working_inventory, _write_inventory, None,
406
303
                         """Inventory for the working copy.""")
407
304
 
408
305
 
409
 
    def add(self, files, ids=None):
 
306
    def add(self, files, verbose=False, ids=None):
410
307
        """Make files versioned.
411
308
 
412
 
        Note that the command line normally calls smart_add instead,
413
 
        which can automatically recurse.
 
309
        Note that the command line normally calls smart_add instead.
414
310
 
415
311
        This puts the files in the Added state, so that they will be
416
312
        recorded by the next commit.
417
313
 
418
 
        files
419
 
            List of paths to add, relative to the base of the tree.
420
 
 
421
 
        ids
422
 
            If set, use these instead of automatically generated ids.
423
 
            Must be the same length as the list of files, but may
424
 
            contain None for ids that are to be autogenerated.
425
 
 
426
314
        TODO: Perhaps have an option to add the ids even if the files do
427
 
              not (yet) exist.
428
 
 
429
 
        TODO: Perhaps yield the ids and paths as they're added.
 
315
               not (yet) exist.
 
316
 
 
317
        TODO: Perhaps return the ids of the files?  But then again it
 
318
               is easy to retrieve them if they're needed.
 
319
 
 
320
        TODO: Option to specify file id.
 
321
 
 
322
        TODO: Adding a directory should optionally recurse down and
 
323
               add all non-ignored children.  Perhaps do that in a
 
324
               higher-level method.
430
325
        """
 
326
        self._need_writelock()
 
327
 
431
328
        # TODO: Re-adding a file that is removed in the working copy
432
329
        # should probably put it back with the previous ID.
433
 
        if isinstance(files, basestring):
434
 
            assert(ids is None or isinstance(ids, basestring))
 
330
        if isinstance(files, types.StringTypes):
 
331
            assert(ids is None or isinstance(ids, types.StringTypes))
435
332
            files = [files]
436
333
            if ids is not None:
437
334
                ids = [ids]
440
337
            ids = [None] * len(files)
441
338
        else:
442
339
            assert(len(ids) == len(files))
443
 
 
444
 
        self.lock_write()
445
 
        try:
446
 
            inv = self.read_working_inventory()
447
 
            for f,file_id in zip(files, ids):
448
 
                if is_control_file(f):
449
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
450
 
 
451
 
                fp = splitpath(f)
452
 
 
453
 
                if len(fp) == 0:
454
 
                    raise BzrError("cannot add top-level %r" % f)
455
 
 
456
 
                fullpath = os.path.normpath(self.abspath(f))
457
 
 
458
 
                try:
459
 
                    kind = file_kind(fullpath)
460
 
                except OSError:
461
 
                    # maybe something better?
462
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
463
 
 
464
 
                if kind != 'file' and kind != 'directory':
465
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
 
 
467
 
                if file_id is None:
468
 
                    file_id = gen_file_id(f)
469
 
                inv.add_path(f, kind=kind, file_id=file_id)
470
 
 
471
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
472
 
 
473
 
            self._write_inventory(inv)
474
 
        finally:
475
 
            self.unlock()
476
 
            
 
340
        
 
341
        inv = self.read_working_inventory()
 
342
        for f,file_id in zip(files, ids):
 
343
            if is_control_file(f):
 
344
                bailout("cannot add control file %s" % quotefn(f))
 
345
 
 
346
            fp = splitpath(f)
 
347
 
 
348
            if len(fp) == 0:
 
349
                bailout("cannot add top-level %r" % f)
 
350
                
 
351
            fullpath = os.path.normpath(self.abspath(f))
 
352
 
 
353
            try:
 
354
                kind = file_kind(fullpath)
 
355
            except OSError:
 
356
                # maybe something better?
 
357
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
358
            
 
359
            if kind != 'file' and kind != 'directory':
 
360
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
361
 
 
362
            if file_id is None:
 
363
                file_id = gen_file_id(f)
 
364
            inv.add_path(f, kind=kind, file_id=file_id)
 
365
 
 
366
            if verbose:
 
367
                show_status('A', kind, quotefn(f))
 
368
                
 
369
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
370
            
 
371
        self._write_inventory(inv)
 
372
 
477
373
 
478
374
    def print_file(self, file, revno):
479
375
        """Print `file` to stdout."""
480
 
        self.lock_read()
481
 
        try:
482
 
            tree = self.revision_tree(self.lookup_revision(revno))
483
 
            # use inventory as it was in that revision
484
 
            file_id = tree.inventory.path2id(file)
485
 
            if not file_id:
486
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
487
 
            tree.print_file(file_id)
488
 
        finally:
489
 
            self.unlock()
490
 
 
 
376
        self._need_readlock()
 
377
        tree = self.revision_tree(self.lookup_revision(revno))
 
378
        # use inventory as it was in that revision
 
379
        file_id = tree.inventory.path2id(file)
 
380
        if not file_id:
 
381
            bailout("%r is not present in revision %d" % (file, revno))
 
382
        tree.print_file(file_id)
 
383
        
491
384
 
492
385
    def remove(self, files, verbose=False):
493
386
        """Mark nominated files for removal from the inventory.
505
398
        """
506
399
        ## TODO: Normalize names
507
400
        ## TODO: Remove nested loops; better scalability
508
 
        if isinstance(files, basestring):
 
401
        self._need_writelock()
 
402
 
 
403
        if isinstance(files, types.StringTypes):
509
404
            files = [files]
510
 
 
511
 
        self.lock_write()
512
 
 
513
 
        try:
514
 
            tree = self.working_tree()
515
 
            inv = tree.inventory
516
 
 
517
 
            # do this before any modifications
518
 
            for f in files:
519
 
                fid = inv.path2id(f)
520
 
                if not fid:
521
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
522
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
523
 
                if verbose:
524
 
                    # having remove it, it must be either ignored or unknown
525
 
                    if tree.is_ignored(f):
526
 
                        new_status = 'I'
527
 
                    else:
528
 
                        new_status = '?'
529
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
530
 
                del inv[fid]
531
 
 
532
 
            self._write_inventory(inv)
533
 
        finally:
534
 
            self.unlock()
535
 
 
536
 
 
537
 
    # FIXME: this doesn't need to be a branch method
 
405
        
 
406
        tree = self.working_tree()
 
407
        inv = tree.inventory
 
408
 
 
409
        # do this before any modifications
 
410
        for f in files:
 
411
            fid = inv.path2id(f)
 
412
            if not fid:
 
413
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
414
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
415
            if verbose:
 
416
                # having remove it, it must be either ignored or unknown
 
417
                if tree.is_ignored(f):
 
418
                    new_status = 'I'
 
419
                else:
 
420
                    new_status = '?'
 
421
                show_status(new_status, inv[fid].kind, quotefn(f))
 
422
            del inv[fid]
 
423
 
 
424
        self._write_inventory(inv)
 
425
 
538
426
    def set_inventory(self, new_inventory_list):
539
 
        from bzrlib.inventory import Inventory, InventoryEntry
540
 
        inv = Inventory(self.get_root_id())
 
427
        inv = Inventory()
541
428
        for path, file_id, parent, kind in new_inventory_list:
542
429
            name = os.path.basename(path)
543
430
            if name == "":
565
452
        return self.working_tree().unknowns()
566
453
 
567
454
 
568
 
    def append_revision(self, *revision_ids):
569
 
        from bzrlib.atomicfile import AtomicFile
570
 
 
571
 
        for revision_id in revision_ids:
572
 
            mutter("add {%s} to revision-history" % revision_id)
573
 
 
 
455
    def append_revision(self, revision_id):
 
456
        mutter("add {%s} to revision-history" % revision_id)
574
457
        rev_history = self.revision_history()
575
 
        rev_history.extend(revision_ids)
576
 
 
577
 
        f = AtomicFile(self.controlfilename('revision-history'))
578
 
        try:
579
 
            for rev_id in rev_history:
580
 
                print >>f, rev_id
581
 
            f.commit()
582
 
        finally:
583
 
            f.close()
584
 
 
585
 
 
586
 
    def get_revision_xml_file(self, revision_id):
587
 
        """Return XML file object for revision object."""
588
 
        if not revision_id or not isinstance(revision_id, basestring):
589
 
            raise InvalidRevisionId(revision_id)
590
 
 
591
 
        self.lock_read()
592
 
        try:
593
 
            try:
594
 
                return self.revision_store[revision_id]
595
 
            except IndexError:
596
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
597
 
        finally:
598
 
            self.unlock()
599
 
 
600
 
 
601
 
    #deprecated
602
 
    get_revision_xml = get_revision_xml_file
 
458
 
 
459
        tmprhname = self.controlfilename('revision-history.tmp')
 
460
        rhname = self.controlfilename('revision-history')
 
461
        
 
462
        f = file(tmprhname, 'wt')
 
463
        rev_history.append(revision_id)
 
464
        f.write('\n'.join(rev_history))
 
465
        f.write('\n')
 
466
        f.close()
 
467
 
 
468
        if sys.platform == 'win32':
 
469
            os.remove(rhname)
 
470
        os.rename(tmprhname, rhname)
 
471
        
603
472
 
604
473
 
605
474
    def get_revision(self, revision_id):
606
475
        """Return the Revision object for a named revision"""
607
 
        xml_file = self.get_revision_xml_file(revision_id)
608
 
 
609
 
        try:
610
 
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
611
 
        except SyntaxError, e:
612
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
 
                                         [revision_id,
614
 
                                          str(e)])
615
 
            
 
476
        self._need_readlock()
 
477
        r = Revision.read_xml(self.revision_store[revision_id])
616
478
        assert r.revision_id == revision_id
617
479
        return r
618
480
 
619
481
 
620
 
    def get_revision_delta(self, revno):
621
 
        """Return the delta for one revision.
622
 
 
623
 
        The delta is relative to its mainline predecessor, or the
624
 
        empty tree for revision 1.
625
 
        """
626
 
        assert isinstance(revno, int)
627
 
        rh = self.revision_history()
628
 
        if not (1 <= revno <= len(rh)):
629
 
            raise InvalidRevisionNumber(revno)
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_ancestry(self, revision_id):
655
 
        """Return a list of revision-ids integrated by a revision.
656
 
        """
657
 
        w = self.weave_store.get_weave(ANCESTRY_FILEID)
658
 
        # strip newlines
659
 
        return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
660
 
 
661
 
 
662
 
    def get_inventory_weave(self):
663
 
        return self.weave_store.get_weave(INVENTORY_FILEID)
664
 
 
665
 
 
666
 
    def get_inventory(self, revision_id):
667
 
        """Get Inventory object by hash."""
668
 
        # FIXME: The text gets passed around a lot coming from the weave.
669
 
        f = StringIO(self.get_inventory_xml(revision_id))
670
 
        return bzrlib.xml5.serializer_v5.read_inventory(f)
671
 
 
672
 
 
673
 
    def get_inventory_xml(self, revision_id):
674
 
        """Get inventory XML as a file object."""
675
 
        try:
676
 
            assert isinstance(revision_id, basestring), type(revision_id)
677
 
            iw = self.get_inventory_weave()
678
 
            return iw.get_text(iw.lookup(revision_id))
679
 
        except IndexError:
680
 
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
681
 
 
682
 
 
683
 
    def get_inventory_sha1(self, revision_id):
684
 
        """Return the sha1 hash of the inventory entry
685
 
        """
686
 
        return self.get_revision(revision_id).inventory_sha1
 
482
    def get_inventory(self, inventory_id):
 
483
        """Get Inventory object by hash.
 
484
 
 
485
        TODO: Perhaps for this and similar methods, take a revision
 
486
               parameter which can be either an integer revno or a
 
487
               string hash."""
 
488
        self._need_readlock()
 
489
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
490
        return i
687
491
 
688
492
 
689
493
    def get_revision_inventory(self, revision_id):
690
494
        """Return inventory of a past revision."""
691
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
692
 
        # must be the same as its revision, so this is trivial.
 
495
        self._need_readlock()
693
496
        if revision_id == None:
694
 
            return Inventory(self.get_root_id())
 
497
            return Inventory()
695
498
        else:
696
 
            return self.get_inventory(revision_id)
 
499
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
697
500
 
698
501
 
699
502
    def revision_history(self):
702
505
        >>> ScratchBranch().revision_history()
703
506
        []
704
507
        """
705
 
        self.lock_read()
706
 
        try:
707
 
            return [l.rstrip('\r\n') for l in
708
 
                    self.controlfile('revision-history', 'r').readlines()]
709
 
        finally:
710
 
            self.unlock()
711
 
 
712
 
 
713
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
714
 
        """
715
 
        >>> import commit
716
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
717
 
        >>> sb.common_ancestor(sb) == (None, None)
718
 
        True
719
 
        >>> commit.commit(sb, "Committing first revision")
720
 
        >>> sb.common_ancestor(sb)[0]
721
 
        1
722
 
        >>> clone = sb.clone()
723
 
        >>> commit.commit(sb, "Committing second revision")
724
 
        >>> sb.common_ancestor(sb)[0]
725
 
        2
726
 
        >>> sb.common_ancestor(clone)[0]
727
 
        1
728
 
        >>> commit.commit(clone, "Committing divergent second revision")
729
 
        >>> sb.common_ancestor(clone)[0]
730
 
        1
731
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
732
 
        True
733
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
734
 
        True
735
 
        >>> clone2 = sb.clone()
736
 
        >>> sb.common_ancestor(clone2)[0]
737
 
        2
738
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
739
 
        1
740
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
741
 
        1
742
 
        """
743
 
        my_history = self.revision_history()
744
 
        other_history = other.revision_history()
745
 
        if self_revno is None:
746
 
            self_revno = len(my_history)
747
 
        if other_revno is None:
748
 
            other_revno = len(other_history)
749
 
        indices = range(min((self_revno, other_revno)))
750
 
        indices.reverse()
751
 
        for r in indices:
752
 
            if my_history[r] == other_history[r]:
753
 
                return r+1, my_history[r]
754
 
        return None, None
 
508
        self._need_readlock()
 
509
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
510
 
 
511
 
 
512
    def enum_history(self, direction):
 
513
        """Return (revno, revision_id) for history of branch.
 
514
 
 
515
        direction
 
516
            'forward' is from earliest to latest
 
517
            'reverse' is from latest to earliest
 
518
        """
 
519
        rh = self.revision_history()
 
520
        if direction == 'forward':
 
521
            i = 1
 
522
            for rid in rh:
 
523
                yield i, rid
 
524
                i += 1
 
525
        elif direction == 'reverse':
 
526
            i = len(rh)
 
527
            while i > 0:
 
528
                yield i, rh[i-1]
 
529
                i -= 1
 
530
        else:
 
531
            raise BzrError('invalid history direction %r' % direction)
755
532
 
756
533
 
757
534
    def revno(self):
773
550
            return None
774
551
 
775
552
 
776
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
777
 
        """
778
 
        If self and other have not diverged, return a list of the revisions
779
 
        present in other, but missing from self.
780
 
 
781
 
        >>> from bzrlib.commit import commit
782
 
        >>> bzrlib.trace.silent = True
783
 
        >>> br1 = ScratchBranch()
784
 
        >>> br2 = ScratchBranch()
785
 
        >>> br1.missing_revisions(br2)
786
 
        []
787
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
788
 
        >>> br1.missing_revisions(br2)
789
 
        [u'REVISION-ID-1']
790
 
        >>> br2.missing_revisions(br1)
791
 
        []
792
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
793
 
        >>> br1.missing_revisions(br2)
794
 
        []
795
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
796
 
        >>> br1.missing_revisions(br2)
797
 
        [u'REVISION-ID-2A']
798
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
799
 
        >>> br1.missing_revisions(br2)
800
 
        Traceback (most recent call last):
801
 
        DivergedBranches: These branches have diverged.
802
 
        """
803
 
        self_history = self.revision_history()
804
 
        self_len = len(self_history)
805
 
        other_history = other.revision_history()
806
 
        other_len = len(other_history)
807
 
        common_index = min(self_len, other_len) -1
808
 
        if common_index >= 0 and \
809
 
            self_history[common_index] != other_history[common_index]:
810
 
            raise DivergedBranches(self, other)
811
 
 
812
 
        if stop_revision is None:
813
 
            stop_revision = other_len
814
 
        elif stop_revision > other_len:
815
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
816
 
        
817
 
        return other_history[self_len:stop_revision]
818
 
 
819
 
 
820
 
    def update_revisions(self, other, stop_revision=None):
821
 
        """Pull in all new revisions from other branch.
822
 
        """
823
 
        from bzrlib.fetch import greedy_fetch
824
 
 
825
 
        pb = bzrlib.ui.ui_factory.progress_bar()
826
 
        pb.update('comparing histories')
827
 
 
828
 
        revision_ids = self.missing_revisions(other, stop_revision)
829
 
 
830
 
        if len(revision_ids) > 0:
831
 
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
832
 
        else:
833
 
            count = 0
834
 
        self.append_revision(*revision_ids)
835
 
        ## note("Added %d revisions." % count)
836
 
        pb.clear()
837
 
 
838
 
 
839
553
    def commit(self, *args, **kw):
840
 
        from bzrlib.commit import Commit
841
 
        Commit().commit(self, *args, **kw)
 
554
        """Deprecated"""
 
555
        from bzrlib.commit import commit
 
556
        commit(self, *args, **kw)
842
557
        
843
558
 
844
 
    def lookup_revision(self, revision):
845
 
        """Return the revision identifier for a given revision information."""
846
 
        revno, info = self._get_revision_info(revision)
847
 
        return info
848
 
 
849
 
 
850
 
    def revision_id_to_revno(self, revision_id):
851
 
        """Given a revision id, return its revno"""
852
 
        history = self.revision_history()
853
 
        try:
854
 
            return history.index(revision_id) + 1
855
 
        except ValueError:
856
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
857
 
 
858
 
 
859
 
    def get_revision_info(self, revision):
860
 
        """Return (revno, revision id) for revision identifier.
861
 
 
862
 
        revision can be an integer, in which case it is assumed to be revno (though
863
 
            this will translate negative values into positive ones)
864
 
        revision can also be a string, in which case it is parsed for something like
865
 
            'date:' or 'revid:' etc.
866
 
        """
867
 
        revno, rev_id = self._get_revision_info(revision)
868
 
        if revno is None:
869
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
870
 
        return revno, rev_id
871
 
 
872
 
    def get_rev_id(self, revno, history=None):
873
 
        """Find the revision id of the specified revno."""
 
559
    def lookup_revision(self, revno):
 
560
        """Return revision hash for revision number."""
874
561
        if revno == 0:
875
562
            return None
876
 
        if history is None:
877
 
            history = self.revision_history()
878
 
        elif revno <= 0 or revno > len(history):
879
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
880
 
        return history[revno - 1]
881
 
 
882
 
    def _get_revision_info(self, revision):
883
 
        """Return (revno, revision id) for revision specifier.
884
 
 
885
 
        revision can be an integer, in which case it is assumed to be revno
886
 
        (though this will translate negative values into positive ones)
887
 
        revision can also be a string, in which case it is parsed for something
888
 
        like 'date:' or 'revid:' etc.
889
 
 
890
 
        A revid is always returned.  If it is None, the specifier referred to
891
 
        the null revision.  If the revid does not occur in the revision
892
 
        history, revno will be None.
893
 
        """
894
 
        
895
 
        if revision is None:
896
 
            return 0, None
897
 
        revno = None
898
 
        try:# Convert to int if possible
899
 
            revision = int(revision)
900
 
        except ValueError:
901
 
            pass
902
 
        revs = self.revision_history()
903
 
        if isinstance(revision, int):
904
 
            if revision < 0:
905
 
                revno = len(revs) + revision + 1
906
 
            else:
907
 
                revno = revision
908
 
            rev_id = self.get_rev_id(revno, revs)
909
 
        elif isinstance(revision, basestring):
910
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
 
                if revision.startswith(prefix):
912
 
                    result = func(self, revs, revision)
913
 
                    if len(result) > 1:
914
 
                        revno, rev_id = result
915
 
                    else:
916
 
                        revno = result[0]
917
 
                        rev_id = self.get_rev_id(revno, revs)
918
 
                    break
919
 
            else:
920
 
                raise BzrError('No namespace registered for string: %r' %
921
 
                               revision)
922
 
        else:
923
 
            raise TypeError('Unhandled revision type %s' % revision)
924
 
 
925
 
        if revno is None:
926
 
            if rev_id is None:
927
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
928
 
        return revno, rev_id
929
 
 
930
 
    def _namespace_revno(self, revs, revision):
931
 
        """Lookup a revision by revision number"""
932
 
        assert revision.startswith('revno:')
933
 
        try:
934
 
            return (int(revision[6:]),)
935
 
        except ValueError:
936
 
            return None
937
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
938
 
 
939
 
    def _namespace_revid(self, revs, revision):
940
 
        assert revision.startswith('revid:')
941
 
        rev_id = revision[len('revid:'):]
942
 
        try:
943
 
            return revs.index(rev_id) + 1, rev_id
944
 
        except ValueError:
945
 
            return None, rev_id
946
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
947
 
 
948
 
    def _namespace_last(self, revs, revision):
949
 
        assert revision.startswith('last:')
950
 
        try:
951
 
            offset = int(revision[5:])
952
 
        except ValueError:
953
 
            return (None,)
954
 
        else:
955
 
            if offset <= 0:
956
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
957
 
            return (len(revs) - offset + 1,)
958
 
    REVISION_NAMESPACES['last:'] = _namespace_last
959
 
 
960
 
    def _namespace_tag(self, revs, revision):
961
 
        assert revision.startswith('tag:')
962
 
        raise BzrError('tag: namespace registered, but not implemented.')
963
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
964
 
 
965
 
    def _namespace_date(self, revs, revision):
966
 
        assert revision.startswith('date:')
967
 
        import datetime
968
 
        # Spec for date revisions:
969
 
        #   date:value
970
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
 
        #   it can also start with a '+/-/='. '+' says match the first
972
 
        #   entry after the given date. '-' is match the first entry before the date
973
 
        #   '=' is match the first entry after, but still on the given date.
974
 
        #
975
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
 
        #       May 13th, 2005 at 0:00
979
 
        #
980
 
        #   So the proper way of saying 'give me all entries for today' is:
981
 
        #       -r {date:+today}:{date:-tomorrow}
982
 
        #   The default is '=' when not supplied
983
 
        val = revision[5:]
984
 
        match_style = '='
985
 
        if val[:1] in ('+', '-', '='):
986
 
            match_style = val[:1]
987
 
            val = val[1:]
988
 
 
989
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
 
        if val.lower() == 'yesterday':
991
 
            dt = today - datetime.timedelta(days=1)
992
 
        elif val.lower() == 'today':
993
 
            dt = today
994
 
        elif val.lower() == 'tomorrow':
995
 
            dt = today + datetime.timedelta(days=1)
996
 
        else:
997
 
            import re
998
 
            # This should be done outside the function to avoid recompiling it.
999
 
            _date_re = re.compile(
1000
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1001
 
                    r'(,|T)?\s*'
1002
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1003
 
                )
1004
 
            m = _date_re.match(val)
1005
 
            if not m or (not m.group('date') and not m.group('time')):
1006
 
                raise BzrError('Invalid revision date %r' % revision)
1007
 
 
1008
 
            if m.group('date'):
1009
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1010
 
            else:
1011
 
                year, month, day = today.year, today.month, today.day
1012
 
            if m.group('time'):
1013
 
                hour = int(m.group('hour'))
1014
 
                minute = int(m.group('minute'))
1015
 
                if m.group('second'):
1016
 
                    second = int(m.group('second'))
1017
 
                else:
1018
 
                    second = 0
1019
 
            else:
1020
 
                hour, minute, second = 0,0,0
1021
 
 
1022
 
            dt = datetime.datetime(year=year, month=month, day=day,
1023
 
                    hour=hour, minute=minute, second=second)
1024
 
        first = dt
1025
 
        last = None
1026
 
        reversed = False
1027
 
        if match_style == '-':
1028
 
            reversed = True
1029
 
        elif match_style == '=':
1030
 
            last = dt + datetime.timedelta(days=1)
1031
 
 
1032
 
        if reversed:
1033
 
            for i in range(len(revs)-1, -1, -1):
1034
 
                r = self.get_revision(revs[i])
1035
 
                # TODO: Handle timezone.
1036
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
 
                if first >= dt and (last is None or dt >= last):
1038
 
                    return (i+1,)
1039
 
        else:
1040
 
            for i in range(len(revs)):
1041
 
                r = self.get_revision(revs[i])
1042
 
                # TODO: Handle timezone.
1043
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
 
                if first <= dt and (last is None or dt <= last):
1045
 
                    return (i+1,)
1046
 
    REVISION_NAMESPACES['date:'] = _namespace_date
 
563
 
 
564
        try:
 
565
            # list is 0-based; revisions are 1-based
 
566
            return self.revision_history()[revno-1]
 
567
        except IndexError:
 
568
            raise BzrError("no such revision %s" % revno)
 
569
 
1047
570
 
1048
571
    def revision_tree(self, revision_id):
1049
572
        """Return Tree for a revision on this branch.
1050
573
 
1051
574
        `revision_id` may be None for the null revision, in which case
1052
575
        an `EmptyTree` is returned."""
1053
 
        # TODO: refactor this to use an existing revision object
1054
 
        # so we don't need to read it in twice.
 
576
        self._need_readlock()
1055
577
        if revision_id == None:
1056
578
            return EmptyTree()
1057
579
        else:
1058
580
            inv = self.get_revision_inventory(revision_id)
1059
 
            return RevisionTree(self.weave_store, inv, revision_id)
 
581
            return RevisionTree(self.text_store, inv)
1060
582
 
1061
583
 
1062
584
    def working_tree(self):
1070
592
 
1071
593
        If there are no revisions yet, return an `EmptyTree`.
1072
594
        """
1073
 
        return self.revision_tree(self.last_patch())
 
595
        r = self.last_patch()
 
596
        if r == None:
 
597
            return EmptyTree()
 
598
        else:
 
599
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
600
 
1074
601
 
1075
602
 
1076
603
    def rename_one(self, from_rel, to_rel):
1078
605
 
1079
606
        This can change the directory or the filename or both.
1080
607
        """
1081
 
        self.lock_write()
 
608
        self._need_writelock()
 
609
        tree = self.working_tree()
 
610
        inv = tree.inventory
 
611
        if not tree.has_filename(from_rel):
 
612
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
613
        if tree.has_filename(to_rel):
 
614
            bailout("can't rename: new working file %r already exists" % to_rel)
 
615
            
 
616
        file_id = inv.path2id(from_rel)
 
617
        if file_id == None:
 
618
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
619
 
 
620
        if inv.path2id(to_rel):
 
621
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
622
 
 
623
        to_dir, to_tail = os.path.split(to_rel)
 
624
        to_dir_id = inv.path2id(to_dir)
 
625
        if to_dir_id == None and to_dir != '':
 
626
            bailout("can't determine destination directory id for %r" % to_dir)
 
627
 
 
628
        mutter("rename_one:")
 
629
        mutter("  file_id    {%s}" % file_id)
 
630
        mutter("  from_rel   %r" % from_rel)
 
631
        mutter("  to_rel     %r" % to_rel)
 
632
        mutter("  to_dir     %r" % to_dir)
 
633
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
634
            
 
635
        inv.rename(file_id, to_dir_id, to_tail)
 
636
 
 
637
        print "%s => %s" % (from_rel, to_rel)
 
638
        
 
639
        from_abs = self.abspath(from_rel)
 
640
        to_abs = self.abspath(to_rel)
1082
641
        try:
1083
 
            tree = self.working_tree()
1084
 
            inv = tree.inventory
1085
 
            if not tree.has_filename(from_rel):
1086
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1087
 
            if tree.has_filename(to_rel):
1088
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
1089
 
 
1090
 
            file_id = inv.path2id(from_rel)
1091
 
            if file_id == None:
1092
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1093
 
 
1094
 
            if inv.path2id(to_rel):
1095
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1096
 
 
1097
 
            to_dir, to_tail = os.path.split(to_rel)
1098
 
            to_dir_id = inv.path2id(to_dir)
1099
 
            if to_dir_id == None and to_dir != '':
1100
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
1101
 
 
1102
 
            mutter("rename_one:")
1103
 
            mutter("  file_id    {%s}" % file_id)
1104
 
            mutter("  from_rel   %r" % from_rel)
1105
 
            mutter("  to_rel     %r" % to_rel)
1106
 
            mutter("  to_dir     %r" % to_dir)
1107
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
1108
 
 
1109
 
            inv.rename(file_id, to_dir_id, to_tail)
1110
 
 
1111
 
            from_abs = self.abspath(from_rel)
1112
 
            to_abs = self.abspath(to_rel)
1113
 
            try:
1114
 
                os.rename(from_abs, to_abs)
1115
 
            except OSError, e:
1116
 
                raise BzrError("failed to rename %r to %r: %s"
1117
 
                        % (from_abs, to_abs, e[1]),
1118
 
                        ["rename rolled back"])
1119
 
 
1120
 
            self._write_inventory(inv)
1121
 
        finally:
1122
 
            self.unlock()
 
642
            os.rename(from_abs, to_abs)
 
643
        except OSError, e:
 
644
            bailout("failed to rename %r to %r: %s"
 
645
                    % (from_abs, to_abs, e[1]),
 
646
                    ["rename rolled back"])
 
647
 
 
648
        self._write_inventory(inv)
 
649
            
1123
650
 
1124
651
 
1125
652
    def move(self, from_paths, to_name):
1132
659
 
1133
660
        Note that to_name is only the last component of the new name;
1134
661
        this doesn't change the directory.
1135
 
 
1136
 
        This returns a list of (from_path, to_path) pairs for each
1137
 
        entry that is moved.
1138
 
        """
1139
 
        result = []
1140
 
        self.lock_write()
1141
 
        try:
1142
 
            ## TODO: Option to move IDs only
1143
 
            assert not isinstance(from_paths, basestring)
1144
 
            tree = self.working_tree()
1145
 
            inv = tree.inventory
1146
 
            to_abs = self.abspath(to_name)
1147
 
            if not isdir(to_abs):
1148
 
                raise BzrError("destination %r is not a directory" % to_abs)
1149
 
            if not tree.has_filename(to_name):
1150
 
                raise BzrError("destination %r not in working directory" % to_abs)
1151
 
            to_dir_id = inv.path2id(to_name)
1152
 
            if to_dir_id == None and to_name != '':
1153
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1154
 
            to_dir_ie = inv[to_dir_id]
1155
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
 
                raise BzrError("destination %r is not a directory" % to_abs)
1157
 
 
1158
 
            to_idpath = inv.get_idpath(to_dir_id)
1159
 
 
1160
 
            for f in from_paths:
1161
 
                if not tree.has_filename(f):
1162
 
                    raise BzrError("%r does not exist in working tree" % f)
1163
 
                f_id = inv.path2id(f)
1164
 
                if f_id == None:
1165
 
                    raise BzrError("%r is not versioned" % f)
1166
 
                name_tail = splitpath(f)[-1]
1167
 
                dest_path = appendpath(to_name, name_tail)
1168
 
                if tree.has_filename(dest_path):
1169
 
                    raise BzrError("destination %r already exists" % dest_path)
1170
 
                if f_id in to_idpath:
1171
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1172
 
 
1173
 
            # OK, so there's a race here, it's possible that someone will
1174
 
            # create a file in this interval and then the rename might be
1175
 
            # left half-done.  But we should have caught most problems.
1176
 
 
1177
 
            for f in from_paths:
1178
 
                name_tail = splitpath(f)[-1]
1179
 
                dest_path = appendpath(to_name, name_tail)
1180
 
                result.append((f, dest_path))
1181
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1182
 
                try:
1183
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1184
 
                except OSError, e:
1185
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
 
                            ["rename rolled back"])
1187
 
 
1188
 
            self._write_inventory(inv)
1189
 
        finally:
1190
 
            self.unlock()
1191
 
 
1192
 
        return result
1193
 
 
1194
 
 
1195
 
    def revert(self, filenames, old_tree=None, backups=True):
1196
 
        """Restore selected files to the versions from a previous tree.
1197
 
 
1198
 
        backups
1199
 
            If true (default) backups are made of files before
1200
 
            they're renamed.
1201
 
        """
1202
 
        from bzrlib.errors import NotVersionedError, BzrError
1203
 
        from bzrlib.atomicfile import AtomicFile
1204
 
        from bzrlib.osutils import backup_file
1205
 
        
1206
 
        inv = self.read_working_inventory()
1207
 
        if old_tree is None:
1208
 
            old_tree = self.basis_tree()
1209
 
        old_inv = old_tree.inventory
1210
 
 
1211
 
        nids = []
1212
 
        for fn in filenames:
1213
 
            file_id = inv.path2id(fn)
1214
 
            if not file_id:
1215
 
                raise NotVersionedError("not a versioned file", fn)
1216
 
            if not old_inv.has_id(file_id):
1217
 
                raise BzrError("file not present in old tree", fn, file_id)
1218
 
            nids.append((fn, file_id))
1219
 
            
1220
 
        # TODO: Rename back if it was previously at a different location
1221
 
 
1222
 
        # TODO: If given a directory, restore the entire contents from
1223
 
        # the previous version.
1224
 
 
1225
 
        # TODO: Make a backup to a temporary file.
1226
 
 
1227
 
        # TODO: If the file previously didn't exist, delete it?
1228
 
        for fn, file_id in nids:
1229
 
            backup_file(fn)
1230
 
            
1231
 
            f = AtomicFile(fn, 'wb')
1232
 
            try:
1233
 
                f.write(old_tree.get_file(file_id).read())
1234
 
                f.commit()
1235
 
            finally:
1236
 
                f.close()
1237
 
 
1238
 
 
1239
 
    def pending_merges(self):
1240
 
        """Return a list of pending merges.
1241
 
 
1242
 
        These are revisions that have been merged into the working
1243
 
        directory but not yet committed.
1244
 
        """
1245
 
        cfn = self.controlfilename('pending-merges')
1246
 
        if not os.path.exists(cfn):
1247
 
            return []
1248
 
        p = []
1249
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1250
 
            p.append(l.rstrip('\n'))
1251
 
        return p
1252
 
 
1253
 
 
1254
 
    def add_pending_merge(self, revision_id):
1255
 
        from bzrlib.revision import validate_revision_id
1256
 
 
1257
 
        validate_revision_id(revision_id)
1258
 
 
1259
 
        p = self.pending_merges()
1260
 
        if revision_id in p:
1261
 
            return
1262
 
        p.append(revision_id)
1263
 
        self.set_pending_merges(p)
1264
 
 
1265
 
 
1266
 
    def set_pending_merges(self, rev_list):
1267
 
        from bzrlib.atomicfile import AtomicFile
1268
 
        self.lock_write()
1269
 
        try:
1270
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1271
 
            try:
1272
 
                for l in rev_list:
1273
 
                    print >>f, l
1274
 
                f.commit()
1275
 
            finally:
1276
 
                f.close()
1277
 
        finally:
1278
 
            self.unlock()
1279
 
 
1280
 
 
1281
 
    def get_parent(self):
1282
 
        """Return the parent location of the branch.
1283
 
 
1284
 
        This is the default location for push/pull/missing.  The usual
1285
 
        pattern is that the user can override it by specifying a
1286
 
        location.
1287
 
        """
1288
 
        import errno
1289
 
        _locs = ['parent', 'pull', 'x-pull']
1290
 
        for l in _locs:
1291
 
            try:
1292
 
                return self.controlfile(l, 'r').read().strip('\n')
1293
 
            except IOError, e:
1294
 
                if e.errno != errno.ENOENT:
1295
 
                    raise
1296
 
        return None
1297
 
 
1298
 
 
1299
 
    def set_parent(self, url):
1300
 
        # TODO: Maybe delete old location files?
1301
 
        from bzrlib.atomicfile import AtomicFile
1302
 
        self.lock_write()
1303
 
        try:
1304
 
            f = AtomicFile(self.controlfilename('parent'))
1305
 
            try:
1306
 
                f.write(url + '\n')
1307
 
                f.commit()
1308
 
            finally:
1309
 
                f.close()
1310
 
        finally:
1311
 
            self.unlock()
1312
 
 
1313
 
    def check_revno(self, revno):
1314
 
        """\
1315
 
        Check whether a revno corresponds to any revision.
1316
 
        Zero (the NULL revision) is considered valid.
1317
 
        """
1318
 
        if revno != 0:
1319
 
            self.check_real_revno(revno)
1320
 
            
1321
 
    def check_real_revno(self, revno):
1322
 
        """\
1323
 
        Check whether a revno corresponds to a real revision.
1324
 
        Zero (the NULL revision) is considered invalid
1325
 
        """
1326
 
        if revno < 1 or revno > self.revno():
1327
 
            raise InvalidRevisionNumber(revno)
1328
 
        
1329
 
        
 
662
        """
 
663
        self._need_writelock()
 
664
        ## TODO: Option to move IDs only
 
665
        assert not isinstance(from_paths, basestring)
 
666
        tree = self.working_tree()
 
667
        inv = tree.inventory
 
668
        to_abs = self.abspath(to_name)
 
669
        if not isdir(to_abs):
 
670
            bailout("destination %r is not a directory" % to_abs)
 
671
        if not tree.has_filename(to_name):
 
672
            bailout("destination %r not in working directory" % to_abs)
 
673
        to_dir_id = inv.path2id(to_name)
 
674
        if to_dir_id == None and to_name != '':
 
675
            bailout("destination %r is not a versioned directory" % to_name)
 
676
        to_dir_ie = inv[to_dir_id]
 
677
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
678
            bailout("destination %r is not a directory" % to_abs)
 
679
 
 
680
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
681
 
 
682
        for f in from_paths:
 
683
            if not tree.has_filename(f):
 
684
                bailout("%r does not exist in working tree" % f)
 
685
            f_id = inv.path2id(f)
 
686
            if f_id == None:
 
687
                bailout("%r is not versioned" % f)
 
688
            name_tail = splitpath(f)[-1]
 
689
            dest_path = appendpath(to_name, name_tail)
 
690
            if tree.has_filename(dest_path):
 
691
                bailout("destination %r already exists" % dest_path)
 
692
            if f_id in to_idpath:
 
693
                bailout("can't move %r to a subdirectory of itself" % f)
 
694
 
 
695
        # OK, so there's a race here, it's possible that someone will
 
696
        # create a file in this interval and then the rename might be
 
697
        # left half-done.  But we should have caught most problems.
 
698
 
 
699
        for f in from_paths:
 
700
            name_tail = splitpath(f)[-1]
 
701
            dest_path = appendpath(to_name, name_tail)
 
702
            print "%s => %s" % (f, dest_path)
 
703
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
704
            try:
 
705
                os.rename(self.abspath(f), self.abspath(dest_path))
 
706
            except OSError, e:
 
707
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
708
                        ["rename rolled back"])
 
709
 
 
710
        self._write_inventory(inv)
 
711
 
 
712
 
1330
713
 
1331
714
 
1332
715
class ScratchBranch(Branch):
1340
723
    >>> isdir(bd)
1341
724
    False
1342
725
    """
1343
 
    def __init__(self, files=[], dirs=[], base=None):
 
726
    def __init__(self, files=[], dirs=[]):
1344
727
        """Make a test branch.
1345
728
 
1346
729
        This creates a temporary directory and runs init-tree in it.
1347
730
 
1348
731
        If any files are listed, they are created in the working copy.
1349
732
        """
1350
 
        from tempfile import mkdtemp
1351
 
        init = False
1352
 
        if base is None:
1353
 
            base = mkdtemp()
1354
 
            init = True
1355
 
        Branch.__init__(self, base, init=init)
 
733
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1356
734
        for d in dirs:
1357
735
            os.mkdir(self.abspath(d))
1358
736
            
1360
738
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1361
739
 
1362
740
 
1363
 
    def clone(self):
1364
 
        """
1365
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1366
 
        >>> clone = orig.clone()
1367
 
        >>> os.path.samefile(orig.base, clone.base)
1368
 
        False
1369
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1370
 
        True
1371
 
        """
1372
 
        from shutil import copytree
1373
 
        from tempfile import mkdtemp
1374
 
        base = mkdtemp()
1375
 
        os.rmdir(base)
1376
 
        copytree(self.base, base, symlinks=True)
1377
 
        return ScratchBranch(base=base)
1378
 
 
1379
 
 
1380
 
        
1381
741
    def __del__(self):
1382
742
        self.destroy()
1383
743
 
1384
744
    def destroy(self):
1385
745
        """Destroy the test branch, removing the scratch directory."""
1386
 
        from shutil import rmtree
1387
746
        try:
1388
 
            if self.base:
1389
 
                mutter("delete ScratchBranch %s" % self.base)
1390
 
                rmtree(self.base)
 
747
            mutter("delete ScratchBranch %s" % self.base)
 
748
            shutil.rmtree(self.base)
1391
749
        except OSError, e:
1392
750
            # Work around for shutil.rmtree failing on Windows when
1393
751
            # readonly files are encountered
1395
753
            for root, dirs, files in os.walk(self.base, topdown=False):
1396
754
                for name in files:
1397
755
                    os.chmod(os.path.join(root, name), 0700)
1398
 
            rmtree(self.base)
 
756
            shutil.rmtree(self.base)
1399
757
        self.base = None
1400
758
 
1401
759
    
1425
783
    This should probably generate proper UUIDs, but for the moment we
1426
784
    cope with just randomness because running uuidgen every time is
1427
785
    slow."""
1428
 
    import re
1429
 
    from binascii import hexlify
1430
 
    from time import time
1431
 
 
1432
 
    # get last component
1433
786
    idx = name.rfind('/')
1434
787
    if idx != -1:
1435
788
        name = name[idx+1 : ]
1437
790
    if idx != -1:
1438
791
        name = name[idx+1 : ]
1439
792
 
1440
 
    # make it not a hidden file
1441
793
    name = name.lstrip('.')
1442
794
 
1443
 
    # remove any wierd characters; we don't escape them but rather
1444
 
    # just pull them out
1445
 
    name = re.sub(r'[^\w.]', '', name)
1446
 
 
1447
795
    s = hexlify(rand_bytes(8))
1448
 
    return '-'.join((name, compact_date(time()), s))
1449
 
 
1450
 
 
1451
 
def gen_root_id():
1452
 
    """Return a new tree-root file id."""
1453
 
    return gen_file_id('TREE_ROOT')
1454
 
 
1455
 
 
1456
 
def pull_loc(branch):
1457
 
    # TODO: Should perhaps just make attribute be 'base' in
1458
 
    # RemoteBranch and Branch?
1459
 
    if hasattr(branch, "baseurl"):
1460
 
        return branch.baseurl
1461
 
    else:
1462
 
        return branch.base
1463
 
 
1464
 
 
1465
 
def copy_branch(branch_from, to_location, revision=None):
1466
 
    """Copy branch_from into the existing directory to_location.
1467
 
 
1468
 
    revision
1469
 
        If not None, only revisions up to this point will be copied.
1470
 
        The head of the new branch will be that revision.
1471
 
 
1472
 
    to_location
1473
 
        The name of a local directory that exists but is empty.
1474
 
    """
1475
 
    from bzrlib.merge import merge
1476
 
    from bzrlib.branch import Branch
1477
 
 
1478
 
    assert isinstance(branch_from, Branch)
1479
 
    assert isinstance(to_location, basestring)
1480
 
    
1481
 
    br_to = Branch(to_location, init=True)
1482
 
    br_to.set_root_id(branch_from.get_root_id())
1483
 
    if revision is None:
1484
 
        revno = branch_from.revno()
1485
 
    else:
1486
 
        revno, rev_id = branch_from.get_revision_info(revision)
1487
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1488
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
 
          check_clean=False, ignore_zero=True)
1490
 
    
1491
 
    from_location = pull_loc(branch_from)
1492
 
    br_to.set_parent(pull_loc(branch_from))
1493
 
 
 
796
    return '-'.join((name, compact_date(time.time()), s))