~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-26 16:09:45 UTC
  • Revision ID: mbp@sourcefrog.net-20050526160945-7574594a45ba1c9c
- more invariant checks in AtomicFile

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