~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-31 03:03:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050531030354-561dbe9ec2862d46
doc

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