~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

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
from sets import Set
 
19
 
18
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
19
21
import traceback, socket, fnmatch, difflib, time
20
22
from binascii import hexlify
26
28
from inventory import InventoryEntry, Inventory
27
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
 
     joinpath, sha_file, sha_string, file_kind, local_time_offset, appendpath
 
31
     joinpath, sha_string, file_kind, local_time_offset, appendpath
30
32
from store import ImmutableStore
31
33
from revision import Revision
32
 
from errors import BzrError
 
34
from errors import bailout, BzrError
33
35
from textui import show_status
 
36
from diff import diff_trees
34
37
 
35
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
36
39
## TODO: Maybe include checks for common corruption of newlines, etc?
43
46
        return remotebranch.RemoteBranch(f, **args)
44
47
    else:
45
48
        return Branch(f, **args)
46
 
 
47
 
 
48
 
 
49
 
def _relpath(base, path):
50
 
    """Return path relative to base, or raise exception.
51
 
 
52
 
    The path may be either an absolute path or a path relative to the
53
 
    current working directory.
54
 
 
55
 
    Lifted out of Branch.relpath for ease of testing.
56
 
 
57
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
58
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
59
 
    avoids that problem."""
60
 
    rp = os.path.abspath(path)
61
 
 
62
 
    s = []
63
 
    head = rp
64
 
    while len(head) >= len(base):
65
 
        if head == base:
66
 
            break
67
 
        head, tail = os.path.split(head)
68
 
        if tail:
69
 
            s.insert(0, tail)
70
 
    else:
71
 
        from errors import NotBranchError
72
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
73
 
 
74
 
    return os.sep.join(s)
75
49
        
76
50
 
77
51
def find_branch_root(f=None):
104
78
            raise BzrError('%r is not in a branch' % orig_f)
105
79
        f = head
106
80
    
107
 
class DivergedBranches(Exception):
108
 
    def __init__(self, branch1, branch2):
109
 
        self.branch1 = branch1
110
 
        self.branch2 = branch2
111
 
        Exception.__init__(self, "These branches have diverged.")
112
 
 
113
 
 
114
 
class NoSuchRevision(BzrError):
115
 
    def __init__(self, branch, revision):
116
 
        self.branch = branch
117
 
        self.revision = revision
118
 
        msg = "Branch %s has no revision %d" % (branch, revision)
119
 
        BzrError.__init__(self, msg)
120
81
 
121
82
 
122
83
######################################################################
123
84
# branch objects
124
85
 
125
 
class Branch(object):
 
86
class Branch:
126
87
    """Branch holding a history of revisions.
127
88
 
128
89
    base
129
90
        Base directory of the branch.
130
 
 
131
 
    _lock_mode
132
 
        None, or 'r' or 'w'
133
 
 
134
 
    _lock_count
135
 
        If _lock_mode is true, a positive count of the number of times the
136
 
        lock has been taken.
137
 
 
138
 
    _lock
139
 
        Lock object from bzrlib.lock.
140
91
    """
141
 
    base = None
142
 
    _lock_mode = None
143
 
    _lock_count = None
144
 
    _lock = None
 
92
    _lockmode = None
145
93
    
146
 
    def __init__(self, base, init=False, find_root=True):
 
94
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
147
95
        """Create new branch object at a particular location.
148
96
 
149
97
        base -- Base directory for the branch.
166
114
        else:
167
115
            self.base = os.path.realpath(base)
168
116
            if not isdir(self.controlfilename('.')):
169
 
                from errors import NotBranchError
170
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
171
 
                                     ['use "bzr init" to initialize a new working tree',
172
 
                                      'current bzr can only operate from top-of-tree'])
 
117
                bailout("not a bzr branch: %s" % quotefn(base),
 
118
                        ['use "bzr init" to initialize a new working tree',
 
119
                         'current bzr can only operate from top-of-tree'])
173
120
        self._check_format()
 
121
        self.lock(lock_mode)
174
122
 
175
123
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
176
124
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
184
132
    __repr__ = __str__
185
133
 
186
134
 
187
 
    def __del__(self):
188
 
        if self._lock_mode or self._lock:
189
 
            from warnings import warn
190
 
            warn("branch %r was not explicitly unlocked" % self)
191
 
            self._lock.unlock()
192
 
 
193
 
 
194
 
 
195
 
    def lock_write(self):
196
 
        if self._lock_mode:
197
 
            if self._lock_mode != 'w':
198
 
                from errors import LockError
199
 
                raise LockError("can't upgrade to a write lock from %r" %
200
 
                                self._lock_mode)
201
 
            self._lock_count += 1
202
 
        else:
203
 
            from bzrlib.lock import WriteLock
204
 
 
205
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
206
 
            self._lock_mode = 'w'
207
 
            self._lock_count = 1
208
 
 
209
 
 
210
 
 
211
 
    def lock_read(self):
212
 
        if self._lock_mode:
213
 
            assert self._lock_mode in ('r', 'w'), \
214
 
                   "invalid lock mode %r" % self._lock_mode
215
 
            self._lock_count += 1
216
 
        else:
217
 
            from bzrlib.lock import ReadLock
218
 
 
219
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
220
 
            self._lock_mode = 'r'
221
 
            self._lock_count = 1
222
 
                        
223
 
 
 
135
 
 
136
    def lock(self, mode='w'):
 
137
        """Lock the on-disk branch, excluding other processes."""
 
138
        try:
 
139
            import fcntl, errno
 
140
 
 
141
            if mode == 'w':
 
142
                lm = fcntl.LOCK_EX
 
143
                om = os.O_WRONLY | os.O_CREAT
 
144
            elif mode == 'r':
 
145
                lm = fcntl.LOCK_SH
 
146
                om = os.O_RDONLY
 
147
            else:
 
148
                raise BzrError("invalid locking mode %r" % mode)
 
149
 
 
150
            try:
 
151
                lockfile = os.open(self.controlfilename('branch-lock'), om)
 
152
            except OSError, e:
 
153
                if e.errno == errno.ENOENT:
 
154
                    # might not exist on branches from <0.0.4
 
155
                    self.controlfile('branch-lock', 'w').close()
 
156
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
 
157
                else:
 
158
                    raise e
224
159
            
225
 
    def unlock(self):
226
 
        if not self._lock_mode:
227
 
            from errors import LockError
228
 
            raise LockError('branch %r is not locked' % (self))
229
 
 
230
 
        if self._lock_count > 1:
231
 
            self._lock_count -= 1
232
 
        else:
233
 
            self._lock.unlock()
234
 
            self._lock = None
235
 
            self._lock_mode = self._lock_count = None
 
160
            fcntl.lockf(lockfile, lm)
 
161
            def unlock():
 
162
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
163
                os.close(lockfile)
 
164
                self._lockmode = None
 
165
            self.unlock = unlock
 
166
            self._lockmode = mode
 
167
        except ImportError:
 
168
            warning("please write a locking method for platform %r" % sys.platform)
 
169
            def unlock():
 
170
                self._lockmode = None
 
171
            self.unlock = unlock
 
172
            self._lockmode = mode
 
173
 
 
174
 
 
175
    def _need_readlock(self):
 
176
        if self._lockmode not in ['r', 'w']:
 
177
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
178
 
 
179
    def _need_writelock(self):
 
180
        if self._lockmode not in ['w']:
 
181
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
236
182
 
237
183
 
238
184
    def abspath(self, name):
244
190
        """Return path relative to this branch of something inside it.
245
191
 
246
192
        Raises an error if path is not in this branch."""
247
 
        return _relpath(self.base, path)
 
193
        rp = os.path.realpath(path)
 
194
        # FIXME: windows
 
195
        if not rp.startswith(self.base):
 
196
            bailout("path %r is not within branch %r" % (rp, self.base))
 
197
        rp = rp[len(self.base):]
 
198
        rp = rp.lstrip(os.sep)
 
199
        return rp
248
200
 
249
201
 
250
202
    def controlfilename(self, file_or_path):
285
237
        os.mkdir(self.controlfilename([]))
286
238
        self.controlfile('README', 'w').write(
287
239
            "This is a Bazaar-NG control directory.\n"
288
 
            "Do not change any files in this directory.\n")
 
240
            "Do not change any files in this directory.")
289
241
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
290
242
        for d in ('text-store', 'inventory-store', 'revision-store'):
291
243
            os.mkdir(self.controlfilename(d))
311
263
        fmt = self.controlfile('branch-format', 'r').read()
312
264
        fmt.replace('\r\n', '')
313
265
        if fmt != BZR_BRANCH_FORMAT:
314
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
315
 
                           ['use a different bzr version',
316
 
                            'or remove the .bzr directory and "bzr init" again'])
317
 
 
 
266
            bailout('sorry, branch format %r not supported' % fmt,
 
267
                    ['use a different bzr version',
 
268
                     'or remove the .bzr directory and "bzr init" again'])
318
269
 
319
270
 
320
271
    def read_working_inventory(self):
321
272
        """Read the working inventory."""
 
273
        self._need_readlock()
322
274
        before = time.time()
323
275
        # ElementTree does its own conversion from UTF-8, so open in
324
276
        # binary.
325
 
        self.lock_read()
326
 
        try:
327
 
            inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
328
 
            mutter("loaded inventory of %d items in %f"
329
 
                   % (len(inv), time.time() - before))
330
 
            return inv
331
 
        finally:
332
 
            self.unlock()
333
 
            
 
277
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
278
        mutter("loaded inventory of %d items in %f"
 
279
               % (len(inv), time.time() - before))
 
280
        return inv
 
281
 
334
282
 
335
283
    def _write_inventory(self, inv):
336
284
        """Update the working inventory.
338
286
        That is to say, the inventory describing changes underway, that
339
287
        will be committed to the next revision.
340
288
        """
 
289
        self._need_writelock()
341
290
        ## TODO: factor out to atomicfile?  is rename safe on windows?
342
291
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
343
292
        tmpfname = self.controlfilename('inventory.tmp')
349
298
            os.remove(inv_fname)
350
299
        os.rename(tmpfname, inv_fname)
351
300
        mutter('wrote working inventory')
352
 
            
 
301
 
353
302
 
354
303
    inventory = property(read_working_inventory, _write_inventory, None,
355
304
                         """Inventory for the working copy.""")
356
305
 
357
306
 
358
 
    def add(self, files, verbose=False, ids=None):
 
307
    def add(self, files, verbose=False):
359
308
        """Make files versioned.
360
309
 
361
310
        Note that the command line normally calls smart_add instead.
363
312
        This puts the files in the Added state, so that they will be
364
313
        recorded by the next commit.
365
314
 
366
 
        files
367
 
            List of paths to add, relative to the base of the tree.
368
 
 
369
 
        ids
370
 
            If set, use these instead of automatically generated ids.
371
 
            Must be the same length as the list of files, but may
372
 
            contain None for ids that are to be autogenerated.
373
 
 
374
315
        TODO: Perhaps have an option to add the ids even if the files do
375
 
              not (yet) exist.
 
316
               not (yet) exist.
376
317
 
377
318
        TODO: Perhaps return the ids of the files?  But then again it
378
 
              is easy to retrieve them if they're needed.
 
319
               is easy to retrieve them if they're needed.
 
320
 
 
321
        TODO: Option to specify file id.
379
322
 
380
323
        TODO: Adding a directory should optionally recurse down and
381
 
              add all non-ignored children.  Perhaps do that in a
382
 
              higher-level method.
 
324
               add all non-ignored children.  Perhaps do that in a
 
325
               higher-level method.
 
326
 
 
327
        >>> b = ScratchBranch(files=['foo'])
 
328
        >>> 'foo' in b.unknowns()
 
329
        True
 
330
        >>> b.show_status()
 
331
        ?       foo
 
332
        >>> b.add('foo')
 
333
        >>> 'foo' in b.unknowns()
 
334
        False
 
335
        >>> bool(b.inventory.path2id('foo'))
 
336
        True
 
337
        >>> b.show_status()
 
338
        A       foo
 
339
 
 
340
        >>> b.add('foo')
 
341
        Traceback (most recent call last):
 
342
        ...
 
343
        BzrError: ('foo is already versioned', [])
 
344
 
 
345
        >>> b.add(['nothere'])
 
346
        Traceback (most recent call last):
 
347
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
383
348
        """
 
349
        self._need_writelock()
 
350
 
384
351
        # TODO: Re-adding a file that is removed in the working copy
385
352
        # should probably put it back with the previous ID.
386
353
        if isinstance(files, types.StringTypes):
387
 
            assert(ids is None or isinstance(ids, types.StringTypes))
388
354
            files = [files]
389
 
            if ids is not None:
390
 
                ids = [ids]
391
 
 
392
 
        if ids is None:
393
 
            ids = [None] * len(files)
394
 
        else:
395
 
            assert(len(ids) == len(files))
396
 
 
397
 
        self.lock_write()
398
 
        try:
399
 
            inv = self.read_working_inventory()
400
 
            for f,file_id in zip(files, ids):
401
 
                if is_control_file(f):
402
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
403
 
 
404
 
                fp = splitpath(f)
405
 
 
406
 
                if len(fp) == 0:
407
 
                    raise BzrError("cannot add top-level %r" % f)
408
 
 
409
 
                fullpath = os.path.normpath(self.abspath(f))
410
 
 
411
 
                try:
412
 
                    kind = file_kind(fullpath)
413
 
                except OSError:
414
 
                    # maybe something better?
415
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
416
 
 
417
 
                if kind != 'file' and kind != 'directory':
418
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
419
 
 
420
 
                if file_id is None:
421
 
                    file_id = gen_file_id(f)
422
 
                inv.add_path(f, kind=kind, file_id=file_id)
423
 
 
424
 
                if verbose:
425
 
                    show_status('A', kind, quotefn(f))
426
 
 
427
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
428
 
 
429
 
            self._write_inventory(inv)
430
 
        finally:
431
 
            self.unlock()
432
 
            
 
355
        
 
356
        inv = self.read_working_inventory()
 
357
        for f in files:
 
358
            if is_control_file(f):
 
359
                bailout("cannot add control file %s" % quotefn(f))
 
360
 
 
361
            fp = splitpath(f)
 
362
 
 
363
            if len(fp) == 0:
 
364
                bailout("cannot add top-level %r" % f)
 
365
                
 
366
            fullpath = os.path.normpath(self.abspath(f))
 
367
 
 
368
            try:
 
369
                kind = file_kind(fullpath)
 
370
            except OSError:
 
371
                # maybe something better?
 
372
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
373
            
 
374
            if kind != 'file' and kind != 'directory':
 
375
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
376
 
 
377
            file_id = gen_file_id(f)
 
378
            inv.add_path(f, kind=kind, file_id=file_id)
 
379
 
 
380
            if verbose:
 
381
                show_status('A', kind, quotefn(f))
 
382
                
 
383
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
384
            
 
385
        self._write_inventory(inv)
 
386
 
433
387
 
434
388
    def print_file(self, file, revno):
435
389
        """Print `file` to stdout."""
436
 
        self.lock_read()
437
 
        try:
438
 
            tree = self.revision_tree(self.lookup_revision(revno))
439
 
            # use inventory as it was in that revision
440
 
            file_id = tree.inventory.path2id(file)
441
 
            if not file_id:
442
 
                raise BzrError("%r is not present in revision %d" % (file, revno))
443
 
            tree.print_file(file_id)
444
 
        finally:
445
 
            self.unlock()
446
 
 
 
390
        self._need_readlock()
 
391
        tree = self.revision_tree(self.lookup_revision(revno))
 
392
        # use inventory as it was in that revision
 
393
        file_id = tree.inventory.path2id(file)
 
394
        if not file_id:
 
395
            bailout("%r is not present in revision %d" % (file, revno))
 
396
        tree.print_file(file_id)
 
397
        
447
398
 
448
399
    def remove(self, files, verbose=False):
449
400
        """Mark nominated files for removal from the inventory.
452
403
 
453
404
        TODO: Refuse to remove modified files unless --force is given?
454
405
 
 
406
        >>> b = ScratchBranch(files=['foo'])
 
407
        >>> b.add('foo')
 
408
        >>> b.inventory.has_filename('foo')
 
409
        True
 
410
        >>> b.remove('foo')
 
411
        >>> b.working_tree().has_filename('foo')
 
412
        True
 
413
        >>> b.inventory.has_filename('foo')
 
414
        False
 
415
        
 
416
        >>> b = ScratchBranch(files=['foo'])
 
417
        >>> b.add('foo')
 
418
        >>> b.commit('one')
 
419
        >>> b.remove('foo')
 
420
        >>> b.commit('two')
 
421
        >>> b.inventory.has_filename('foo') 
 
422
        False
 
423
        >>> b.basis_tree().has_filename('foo') 
 
424
        False
 
425
        >>> b.working_tree().has_filename('foo') 
 
426
        True
 
427
 
455
428
        TODO: Do something useful with directories.
456
429
 
457
430
        TODO: Should this remove the text or not?  Tough call; not
461
434
        """
462
435
        ## TODO: Normalize names
463
436
        ## TODO: Remove nested loops; better scalability
 
437
        self._need_writelock()
 
438
 
464
439
        if isinstance(files, types.StringTypes):
465
440
            files = [files]
466
 
 
467
 
        self.lock_write()
468
 
 
469
 
        try:
470
 
            tree = self.working_tree()
471
 
            inv = tree.inventory
472
 
 
473
 
            # do this before any modifications
474
 
            for f in files:
475
 
                fid = inv.path2id(f)
476
 
                if not fid:
477
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
478
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
479
 
                if verbose:
480
 
                    # having remove it, it must be either ignored or unknown
481
 
                    if tree.is_ignored(f):
482
 
                        new_status = 'I'
483
 
                    else:
484
 
                        new_status = '?'
485
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
486
 
                del inv[fid]
487
 
 
488
 
            self._write_inventory(inv)
489
 
        finally:
490
 
            self.unlock()
491
 
 
492
 
 
493
 
    # FIXME: this doesn't need to be a branch method
494
 
    def set_inventory(self, new_inventory_list):
495
 
        inv = Inventory()
496
 
        for path, file_id, parent, kind in new_inventory_list:
497
 
            name = os.path.basename(path)
498
 
            if name == "":
499
 
                continue
500
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
441
        
 
442
        tree = self.working_tree()
 
443
        inv = tree.inventory
 
444
 
 
445
        # do this before any modifications
 
446
        for f in files:
 
447
            fid = inv.path2id(f)
 
448
            if not fid:
 
449
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
450
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
451
            if verbose:
 
452
                # having remove it, it must be either ignored or unknown
 
453
                if tree.is_ignored(f):
 
454
                    new_status = 'I'
 
455
                else:
 
456
                    new_status = '?'
 
457
                show_status(new_status, inv[fid].kind, quotefn(f))
 
458
            del inv[fid]
 
459
 
501
460
        self._write_inventory(inv)
502
461
 
503
462
 
520
479
        return self.working_tree().unknowns()
521
480
 
522
481
 
 
482
    def commit(self, message, timestamp=None, timezone=None,
 
483
               committer=None,
 
484
               verbose=False):
 
485
        """Commit working copy as a new revision.
 
486
        
 
487
        The basic approach is to add all the file texts into the
 
488
        store, then the inventory, then make a new revision pointing
 
489
        to that inventory and store that.
 
490
        
 
491
        This is not quite safe if the working copy changes during the
 
492
        commit; for the moment that is simply not allowed.  A better
 
493
        approach is to make a temporary copy of the files before
 
494
        computing their hashes, and then add those hashes in turn to
 
495
        the inventory.  This should mean at least that there are no
 
496
        broken hash pointers.  There is no way we can get a snapshot
 
497
        of the whole directory at an instant.  This would also have to
 
498
        be robust against files disappearing, moving, etc.  So the
 
499
        whole thing is a bit hard.
 
500
 
 
501
        timestamp -- if not None, seconds-since-epoch for a
 
502
             postdated/predated commit.
 
503
        """
 
504
        self._need_writelock()
 
505
 
 
506
        ## TODO: Show branch names
 
507
 
 
508
        # TODO: Don't commit if there are no changes, unless forced?
 
509
 
 
510
        # First walk over the working inventory; and both update that
 
511
        # and also build a new revision inventory.  The revision
 
512
        # inventory needs to hold the text-id, sha1 and size of the
 
513
        # actual file versions committed in the revision.  (These are
 
514
        # not present in the working inventory.)  We also need to
 
515
        # detect missing/deleted files, and remove them from the
 
516
        # working inventory.
 
517
 
 
518
        work_inv = self.read_working_inventory()
 
519
        inv = Inventory()
 
520
        basis = self.basis_tree()
 
521
        basis_inv = basis.inventory
 
522
        missing_ids = []
 
523
        for path, entry in work_inv.iter_entries():
 
524
            ## TODO: Cope with files that have gone missing.
 
525
 
 
526
            ## TODO: Check that the file kind has not changed from the previous
 
527
            ## revision of this file (if any).
 
528
 
 
529
            entry = entry.copy()
 
530
 
 
531
            p = self.abspath(path)
 
532
            file_id = entry.file_id
 
533
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
534
 
 
535
            if not os.path.exists(p):
 
536
                mutter("    file is missing, removing from inventory")
 
537
                if verbose:
 
538
                    show_status('D', entry.kind, quotefn(path))
 
539
                missing_ids.append(file_id)
 
540
                continue
 
541
 
 
542
            # TODO: Handle files that have been deleted
 
543
 
 
544
            # TODO: Maybe a special case for empty files?  Seems a
 
545
            # waste to store them many times.
 
546
 
 
547
            inv.add(entry)
 
548
 
 
549
            if basis_inv.has_id(file_id):
 
550
                old_kind = basis_inv[file_id].kind
 
551
                if old_kind != entry.kind:
 
552
                    bailout("entry %r changed kind from %r to %r"
 
553
                            % (file_id, old_kind, entry.kind))
 
554
 
 
555
            if entry.kind == 'directory':
 
556
                if not isdir(p):
 
557
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
558
            elif entry.kind == 'file':
 
559
                if not isfile(p):
 
560
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
561
 
 
562
                content = file(p, 'rb').read()
 
563
 
 
564
                entry.text_sha1 = sha_string(content)
 
565
                entry.text_size = len(content)
 
566
 
 
567
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
568
                if (old_ie
 
569
                    and (old_ie.text_size == entry.text_size)
 
570
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
571
                    ## assert content == basis.get_file(file_id).read()
 
572
                    entry.text_id = basis_inv[file_id].text_id
 
573
                    mutter('    unchanged from previous text_id {%s}' %
 
574
                           entry.text_id)
 
575
                    
 
576
                else:
 
577
                    entry.text_id = gen_file_id(entry.name)
 
578
                    self.text_store.add(content, entry.text_id)
 
579
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
580
                    if verbose:
 
581
                        if not old_ie:
 
582
                            state = 'A'
 
583
                        elif (old_ie.name == entry.name
 
584
                              and old_ie.parent_id == entry.parent_id):
 
585
                            state = 'M'
 
586
                        else:
 
587
                            state = 'R'
 
588
 
 
589
                        show_status(state, entry.kind, quotefn(path))
 
590
 
 
591
        for file_id in missing_ids:
 
592
            # have to do this later so we don't mess up the iterator.
 
593
            # since parents may be removed before their children we
 
594
            # have to test.
 
595
 
 
596
            # FIXME: There's probably a better way to do this; perhaps
 
597
            # the workingtree should know how to filter itself.
 
598
            if work_inv.has_id(file_id):
 
599
                del work_inv[file_id]
 
600
 
 
601
 
 
602
        inv_id = rev_id = _gen_revision_id(time.time())
 
603
        
 
604
        inv_tmp = tempfile.TemporaryFile()
 
605
        inv.write_xml(inv_tmp)
 
606
        inv_tmp.seek(0)
 
607
        self.inventory_store.add(inv_tmp, inv_id)
 
608
        mutter('new inventory_id is {%s}' % inv_id)
 
609
 
 
610
        self._write_inventory(work_inv)
 
611
 
 
612
        if timestamp == None:
 
613
            timestamp = time.time()
 
614
 
 
615
        if committer == None:
 
616
            committer = username()
 
617
 
 
618
        if timezone == None:
 
619
            timezone = local_time_offset()
 
620
 
 
621
        mutter("building commit log message")
 
622
        rev = Revision(timestamp=timestamp,
 
623
                       timezone=timezone,
 
624
                       committer=committer,
 
625
                       precursor = self.last_patch(),
 
626
                       message = message,
 
627
                       inventory_id=inv_id,
 
628
                       revision_id=rev_id)
 
629
 
 
630
        rev_tmp = tempfile.TemporaryFile()
 
631
        rev.write_xml(rev_tmp)
 
632
        rev_tmp.seek(0)
 
633
        self.revision_store.add(rev_tmp, rev_id)
 
634
        mutter("new revision_id is {%s}" % rev_id)
 
635
        
 
636
        ## XXX: Everything up to here can simply be orphaned if we abort
 
637
        ## the commit; it will leave junk files behind but that doesn't
 
638
        ## matter.
 
639
 
 
640
        ## TODO: Read back the just-generated changeset, and make sure it
 
641
        ## applies and recreates the right state.
 
642
 
 
643
        ## TODO: Also calculate and store the inventory SHA1
 
644
        mutter("committing patch r%d" % (self.revno() + 1))
 
645
 
 
646
 
 
647
        self.append_revision(rev_id)
 
648
        
 
649
        if verbose:
 
650
            note("commited r%d" % self.revno())
 
651
 
 
652
 
523
653
    def append_revision(self, revision_id):
524
654
        mutter("add {%s} to revision-history" % revision_id)
525
655
        rev_history = self.revision_history()
541
671
 
542
672
    def get_revision(self, revision_id):
543
673
        """Return the Revision object for a named revision"""
544
 
        if not revision_id or not isinstance(revision_id, basestring):
545
 
            raise ValueError('invalid revision-id: %r' % revision_id)
 
674
        self._need_readlock()
546
675
        r = Revision.read_xml(self.revision_store[revision_id])
547
676
        assert r.revision_id == revision_id
548
677
        return r
549
678
 
550
 
    def get_revision_sha1(self, revision_id):
551
 
        """Hash the stored value of a revision, and return it."""
552
 
        # In the future, revision entries will be signed. At that
553
 
        # point, it is probably best *not* to include the signature
554
 
        # in the revision hash. Because that lets you re-sign
555
 
        # the revision, (add signatures/remove signatures) and still
556
 
        # have all hash pointers stay consistent.
557
 
        # But for now, just hash the contents.
558
 
        return sha_file(self.revision_store[revision_id])
559
 
 
560
679
 
561
680
    def get_inventory(self, inventory_id):
562
681
        """Get Inventory object by hash.
564
683
        TODO: Perhaps for this and similar methods, take a revision
565
684
               parameter which can be either an integer revno or a
566
685
               string hash."""
 
686
        self._need_readlock()
567
687
        i = Inventory.read_xml(self.inventory_store[inventory_id])
568
688
        return i
569
689
 
570
 
    def get_inventory_sha1(self, inventory_id):
571
 
        """Return the sha1 hash of the inventory entry
572
 
        """
573
 
        return sha_file(self.inventory_store[inventory_id])
574
 
 
575
690
 
576
691
    def get_revision_inventory(self, revision_id):
577
692
        """Return inventory of a past revision."""
 
693
        self._need_readlock()
578
694
        if revision_id == None:
579
695
            return Inventory()
580
696
        else:
587
703
        >>> ScratchBranch().revision_history()
588
704
        []
589
705
        """
590
 
        self.lock_read()
591
 
        try:
592
 
            return [l.rstrip('\r\n') for l in
593
 
                    self.controlfile('revision-history', 'r').readlines()]
594
 
        finally:
595
 
            self.unlock()
596
 
 
597
 
 
598
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
599
 
        """
600
 
        >>> import commit
601
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
602
 
        >>> sb.common_ancestor(sb) == (None, None)
603
 
        True
604
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
605
 
        >>> sb.common_ancestor(sb)[0]
606
 
        1
607
 
        >>> clone = sb.clone()
608
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
609
 
        >>> sb.common_ancestor(sb)[0]
610
 
        2
611
 
        >>> sb.common_ancestor(clone)[0]
612
 
        1
613
 
        >>> commit.commit(clone, "Committing divergent second revision", 
614
 
        ...               verbose=False)
615
 
        >>> sb.common_ancestor(clone)[0]
616
 
        1
617
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
618
 
        True
619
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
620
 
        True
621
 
        >>> clone2 = sb.clone()
622
 
        >>> sb.common_ancestor(clone2)[0]
623
 
        2
624
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
625
 
        1
626
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
627
 
        1
628
 
        """
629
 
        my_history = self.revision_history()
630
 
        other_history = other.revision_history()
631
 
        if self_revno is None:
632
 
            self_revno = len(my_history)
633
 
        if other_revno is None:
634
 
            other_revno = len(other_history)
635
 
        indices = range(min((self_revno, other_revno)))
636
 
        indices.reverse()
637
 
        for r in indices:
638
 
            if my_history[r] == other_history[r]:
639
 
                return r+1, my_history[r]
640
 
        return None, None
 
706
        self._need_readlock()
 
707
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
708
 
641
709
 
642
710
    def enum_history(self, direction):
643
711
        """Return (revno, revision_id) for history of branch.
658
726
                yield i, rh[i-1]
659
727
                i -= 1
660
728
        else:
661
 
            raise ValueError('invalid history direction', direction)
 
729
            raise BzrError('invalid history direction %r' % direction)
662
730
 
663
731
 
664
732
    def revno(self):
666
734
 
667
735
        That is equivalent to the number of revisions committed to
668
736
        this branch.
 
737
 
 
738
        >>> b = ScratchBranch()
 
739
        >>> b.revno()
 
740
        0
 
741
        >>> b.commit('no foo')
 
742
        >>> b.revno()
 
743
        1
669
744
        """
670
745
        return len(self.revision_history())
671
746
 
672
747
 
673
748
    def last_patch(self):
674
749
        """Return last patch hash, or None if no history.
 
750
 
 
751
        >>> ScratchBranch().last_patch() == None
 
752
        True
675
753
        """
676
754
        ph = self.revision_history()
677
755
        if ph:
678
756
            return ph[-1]
679
757
        else:
680
758
            return None
681
 
 
682
 
 
683
 
    def missing_revisions(self, other, stop_revision=None):
684
 
        """
685
 
        If self and other have not diverged, return a list of the revisions
686
 
        present in other, but missing from self.
687
 
 
688
 
        >>> from bzrlib.commit import commit
689
 
        >>> bzrlib.trace.silent = True
690
 
        >>> br1 = ScratchBranch()
691
 
        >>> br2 = ScratchBranch()
692
 
        >>> br1.missing_revisions(br2)
693
 
        []
694
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
695
 
        >>> br1.missing_revisions(br2)
696
 
        [u'REVISION-ID-1']
697
 
        >>> br2.missing_revisions(br1)
698
 
        []
699
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
700
 
        >>> br1.missing_revisions(br2)
701
 
        []
702
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
703
 
        >>> br1.missing_revisions(br2)
704
 
        [u'REVISION-ID-2A']
705
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
706
 
        >>> br1.missing_revisions(br2)
707
 
        Traceback (most recent call last):
708
 
        DivergedBranches: These branches have diverged.
709
 
        """
710
 
        self_history = self.revision_history()
711
 
        self_len = len(self_history)
712
 
        other_history = other.revision_history()
713
 
        other_len = len(other_history)
714
 
        common_index = min(self_len, other_len) -1
715
 
        if common_index >= 0 and \
716
 
            self_history[common_index] != other_history[common_index]:
717
 
            raise DivergedBranches(self, other)
718
 
 
719
 
        if stop_revision is None:
720
 
            stop_revision = other_len
721
 
        elif stop_revision > other_len:
722
 
            raise NoSuchRevision(self, stop_revision)
723
 
        
724
 
        return other_history[self_len:stop_revision]
725
 
 
726
 
 
727
 
    def update_revisions(self, other, stop_revision=None):
728
 
        """Pull in all new revisions from other branch.
729
 
        
730
 
        >>> from bzrlib.commit import commit
731
 
        >>> bzrlib.trace.silent = True
732
 
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
733
 
        >>> br1.add('foo')
734
 
        >>> br1.add('bar')
735
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
736
 
        >>> br2 = ScratchBranch()
737
 
        >>> br2.update_revisions(br1)
738
 
        Added 2 texts.
739
 
        Added 1 inventories.
740
 
        Added 1 revisions.
741
 
        >>> br2.revision_history()
742
 
        [u'REVISION-ID-1']
743
 
        >>> br2.update_revisions(br1)
744
 
        Added 0 texts.
745
 
        Added 0 inventories.
746
 
        Added 0 revisions.
747
 
        >>> br1.text_store.total_size() == br2.text_store.total_size()
748
 
        True
749
 
        """
750
 
        from bzrlib.progress import ProgressBar
751
 
 
752
 
        pb = ProgressBar()
753
 
 
754
 
        pb.update('comparing histories')
755
 
        revision_ids = self.missing_revisions(other, stop_revision)
756
 
        revisions = []
757
 
        needed_texts = sets.Set()
758
 
        i = 0
759
 
        for rev_id in revision_ids:
760
 
            i += 1
761
 
            pb.update('fetching revision', i, len(revision_ids))
762
 
            rev = other.get_revision(rev_id)
763
 
            revisions.append(rev)
764
 
            inv = other.get_inventory(str(rev.inventory_id))
765
 
            for key, entry in inv.iter_entries():
766
 
                if entry.text_id is None:
767
 
                    continue
768
 
                if entry.text_id not in self.text_store:
769
 
                    needed_texts.add(entry.text_id)
770
 
 
771
 
        pb.clear()
772
 
                    
773
 
        count = self.text_store.copy_multi(other.text_store, needed_texts)
774
 
        print "Added %d texts." % count 
775
 
        inventory_ids = [ f.inventory_id for f in revisions ]
776
 
        count = self.inventory_store.copy_multi(other.inventory_store, 
777
 
                                                inventory_ids)
778
 
        print "Added %d inventories." % count 
779
 
        revision_ids = [ f.revision_id for f in revisions]
780
 
        count = self.revision_store.copy_multi(other.revision_store, 
781
 
                                               revision_ids)
782
 
        for revision_id in revision_ids:
783
 
            self.append_revision(revision_id)
784
 
        print "Added %d revisions." % count
785
 
                    
786
 
        
787
 
    def commit(self, *args, **kw):
788
 
        """Deprecated"""
789
 
        from bzrlib.commit import commit
790
 
        commit(self, *args, **kw)
791
759
        
792
760
 
793
761
    def lookup_revision(self, revno):
807
775
 
808
776
        `revision_id` may be None for the null revision, in which case
809
777
        an `EmptyTree` is returned."""
810
 
        # TODO: refactor this to use an existing revision object
811
 
        # so we don't need to read it in twice.
 
778
        self._need_readlock()
812
779
        if revision_id == None:
813
780
            return EmptyTree()
814
781
        else:
826
793
        """Return `Tree` object for last revision.
827
794
 
828
795
        If there are no revisions yet, return an `EmptyTree`.
 
796
 
 
797
        >>> b = ScratchBranch(files=['foo'])
 
798
        >>> b.basis_tree().has_filename('foo')
 
799
        False
 
800
        >>> b.working_tree().has_filename('foo')
 
801
        True
 
802
        >>> b.add('foo')
 
803
        >>> b.commit('add foo')
 
804
        >>> b.basis_tree().has_filename('foo')
 
805
        True
829
806
        """
830
807
        r = self.last_patch()
831
808
        if r == None:
840
817
 
841
818
        This can change the directory or the filename or both.
842
819
        """
843
 
        self.lock_write()
 
820
        self._need_writelock()
 
821
        tree = self.working_tree()
 
822
        inv = tree.inventory
 
823
        if not tree.has_filename(from_rel):
 
824
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
825
        if tree.has_filename(to_rel):
 
826
            bailout("can't rename: new working file %r already exists" % to_rel)
 
827
            
 
828
        file_id = inv.path2id(from_rel)
 
829
        if file_id == None:
 
830
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
831
 
 
832
        if inv.path2id(to_rel):
 
833
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
834
 
 
835
        to_dir, to_tail = os.path.split(to_rel)
 
836
        to_dir_id = inv.path2id(to_dir)
 
837
        if to_dir_id == None and to_dir != '':
 
838
            bailout("can't determine destination directory id for %r" % to_dir)
 
839
 
 
840
        mutter("rename_one:")
 
841
        mutter("  file_id    {%s}" % file_id)
 
842
        mutter("  from_rel   %r" % from_rel)
 
843
        mutter("  to_rel     %r" % to_rel)
 
844
        mutter("  to_dir     %r" % to_dir)
 
845
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
846
            
 
847
        inv.rename(file_id, to_dir_id, to_tail)
 
848
 
 
849
        print "%s => %s" % (from_rel, to_rel)
 
850
        
 
851
        from_abs = self.abspath(from_rel)
 
852
        to_abs = self.abspath(to_rel)
844
853
        try:
845
 
            tree = self.working_tree()
846
 
            inv = tree.inventory
847
 
            if not tree.has_filename(from_rel):
848
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
849
 
            if tree.has_filename(to_rel):
850
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
851
 
 
852
 
            file_id = inv.path2id(from_rel)
853
 
            if file_id == None:
854
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
855
 
 
856
 
            if inv.path2id(to_rel):
857
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
858
 
 
859
 
            to_dir, to_tail = os.path.split(to_rel)
860
 
            to_dir_id = inv.path2id(to_dir)
861
 
            if to_dir_id == None and to_dir != '':
862
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
863
 
 
864
 
            mutter("rename_one:")
865
 
            mutter("  file_id    {%s}" % file_id)
866
 
            mutter("  from_rel   %r" % from_rel)
867
 
            mutter("  to_rel     %r" % to_rel)
868
 
            mutter("  to_dir     %r" % to_dir)
869
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
870
 
 
871
 
            inv.rename(file_id, to_dir_id, to_tail)
872
 
 
873
 
            print "%s => %s" % (from_rel, to_rel)
874
 
 
875
 
            from_abs = self.abspath(from_rel)
876
 
            to_abs = self.abspath(to_rel)
877
 
            try:
878
 
                os.rename(from_abs, to_abs)
879
 
            except OSError, e:
880
 
                raise BzrError("failed to rename %r to %r: %s"
881
 
                        % (from_abs, to_abs, e[1]),
882
 
                        ["rename rolled back"])
883
 
 
884
 
            self._write_inventory(inv)
885
 
        finally:
886
 
            self.unlock()
 
854
            os.rename(from_abs, to_abs)
 
855
        except OSError, e:
 
856
            bailout("failed to rename %r to %r: %s"
 
857
                    % (from_abs, to_abs, e[1]),
 
858
                    ["rename rolled back"])
 
859
 
 
860
        self._write_inventory(inv)
 
861
            
887
862
 
888
863
 
889
864
    def move(self, from_paths, to_name):
897
872
        Note that to_name is only the last component of the new name;
898
873
        this doesn't change the directory.
899
874
        """
900
 
        self.lock_write()
901
 
        try:
902
 
            ## TODO: Option to move IDs only
903
 
            assert not isinstance(from_paths, basestring)
904
 
            tree = self.working_tree()
905
 
            inv = tree.inventory
906
 
            to_abs = self.abspath(to_name)
907
 
            if not isdir(to_abs):
908
 
                raise BzrError("destination %r is not a directory" % to_abs)
909
 
            if not tree.has_filename(to_name):
910
 
                raise BzrError("destination %r not in working directory" % to_abs)
911
 
            to_dir_id = inv.path2id(to_name)
912
 
            if to_dir_id == None and to_name != '':
913
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
914
 
            to_dir_ie = inv[to_dir_id]
915
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
916
 
                raise BzrError("destination %r is not a directory" % to_abs)
917
 
 
918
 
            to_idpath = inv.get_idpath(to_dir_id)
919
 
 
920
 
            for f in from_paths:
921
 
                if not tree.has_filename(f):
922
 
                    raise BzrError("%r does not exist in working tree" % f)
923
 
                f_id = inv.path2id(f)
924
 
                if f_id == None:
925
 
                    raise BzrError("%r is not versioned" % f)
926
 
                name_tail = splitpath(f)[-1]
927
 
                dest_path = appendpath(to_name, name_tail)
928
 
                if tree.has_filename(dest_path):
929
 
                    raise BzrError("destination %r already exists" % dest_path)
930
 
                if f_id in to_idpath:
931
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
932
 
 
933
 
            # OK, so there's a race here, it's possible that someone will
934
 
            # create a file in this interval and then the rename might be
935
 
            # left half-done.  But we should have caught most problems.
936
 
 
937
 
            for f in from_paths:
938
 
                name_tail = splitpath(f)[-1]
939
 
                dest_path = appendpath(to_name, name_tail)
940
 
                print "%s => %s" % (f, dest_path)
941
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
942
 
                try:
943
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
944
 
                except OSError, e:
945
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
946
 
                            ["rename rolled back"])
947
 
 
948
 
            self._write_inventory(inv)
949
 
        finally:
950
 
            self.unlock()
 
875
        self._need_writelock()
 
876
        ## TODO: Option to move IDs only
 
877
        assert not isinstance(from_paths, basestring)
 
878
        tree = self.working_tree()
 
879
        inv = tree.inventory
 
880
        to_abs = self.abspath(to_name)
 
881
        if not isdir(to_abs):
 
882
            bailout("destination %r is not a directory" % to_abs)
 
883
        if not tree.has_filename(to_name):
 
884
            bailout("destination %r not in working directory" % to_abs)
 
885
        to_dir_id = inv.path2id(to_name)
 
886
        if to_dir_id == None and to_name != '':
 
887
            bailout("destination %r is not a versioned directory" % to_name)
 
888
        to_dir_ie = inv[to_dir_id]
 
889
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
890
            bailout("destination %r is not a directory" % to_abs)
 
891
 
 
892
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
893
 
 
894
        for f in from_paths:
 
895
            if not tree.has_filename(f):
 
896
                bailout("%r does not exist in working tree" % f)
 
897
            f_id = inv.path2id(f)
 
898
            if f_id == None:
 
899
                bailout("%r is not versioned" % f)
 
900
            name_tail = splitpath(f)[-1]
 
901
            dest_path = appendpath(to_name, name_tail)
 
902
            if tree.has_filename(dest_path):
 
903
                bailout("destination %r already exists" % dest_path)
 
904
            if f_id in to_idpath:
 
905
                bailout("can't move %r to a subdirectory of itself" % f)
 
906
 
 
907
        # OK, so there's a race here, it's possible that someone will
 
908
        # create a file in this interval and then the rename might be
 
909
        # left half-done.  But we should have caught most problems.
 
910
 
 
911
        for f in from_paths:
 
912
            name_tail = splitpath(f)[-1]
 
913
            dest_path = appendpath(to_name, name_tail)
 
914
            print "%s => %s" % (f, dest_path)
 
915
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
916
            try:
 
917
                os.rename(self.abspath(f), self.abspath(dest_path))
 
918
            except OSError, e:
 
919
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
920
                        ["rename rolled back"])
 
921
 
 
922
        self._write_inventory(inv)
 
923
 
951
924
 
952
925
 
953
926
 
962
935
    >>> isdir(bd)
963
936
    False
964
937
    """
965
 
    def __init__(self, files=[], dirs=[], base=None):
 
938
    def __init__(self, files=[], dirs=[]):
966
939
        """Make a test branch.
967
940
 
968
941
        This creates a temporary directory and runs init-tree in it.
969
942
 
970
943
        If any files are listed, they are created in the working copy.
971
944
        """
972
 
        init = False
973
 
        if base is None:
974
 
            base = tempfile.mkdtemp()
975
 
            init = True
976
 
        Branch.__init__(self, base, init=init)
 
945
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
977
946
        for d in dirs:
978
947
            os.mkdir(self.abspath(d))
979
948
            
981
950
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
982
951
 
983
952
 
984
 
    def clone(self):
985
 
        """
986
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
987
 
        >>> clone = orig.clone()
988
 
        >>> os.path.samefile(orig.base, clone.base)
989
 
        False
990
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
991
 
        True
992
 
        """
993
 
        base = tempfile.mkdtemp()
994
 
        os.rmdir(base)
995
 
        shutil.copytree(self.base, base, symlinks=True)
996
 
        return ScratchBranch(base=base)
997
 
        
998
953
    def __del__(self):
999
954
        self.destroy()
1000
955
 
1001
956
    def destroy(self):
1002
957
        """Destroy the test branch, removing the scratch directory."""
1003
958
        try:
1004
 
            if self.base:
1005
 
                mutter("delete ScratchBranch %s" % self.base)
1006
 
                shutil.rmtree(self.base)
 
959
            mutter("delete ScratchBranch %s" % self.base)
 
960
            shutil.rmtree(self.base)
1007
961
        except OSError, e:
1008
962
            # Work around for shutil.rmtree failing on Windows when
1009
963
            # readonly files are encountered
1035
989
 
1036
990
 
1037
991
 
 
992
def _gen_revision_id(when):
 
993
    """Return new revision-id."""
 
994
    s = '%s-%s-' % (user_email(), compact_date(when))
 
995
    s += hexlify(rand_bytes(8))
 
996
    return s
 
997
 
 
998
 
1038
999
def gen_file_id(name):
1039
1000
    """Return new file id.
1040
1001
 
1041
1002
    This should probably generate proper UUIDs, but for the moment we
1042
1003
    cope with just randomness because running uuidgen every time is
1043
1004
    slow."""
1044
 
    import re
1045
 
 
1046
 
    # get last component
1047
1005
    idx = name.rfind('/')
1048
1006
    if idx != -1:
1049
1007
        name = name[idx+1 : ]
1051
1009
    if idx != -1:
1052
1010
        name = name[idx+1 : ]
1053
1011
 
1054
 
    # make it not a hidden file
1055
1012
    name = name.lstrip('.')
1056
1013
 
1057
 
    # remove any wierd characters; we don't escape them but rather
1058
 
    # just pull them out
1059
 
    name = re.sub(r'[^\w.]', '', name)
1060
 
 
1061
1014
    s = hexlify(rand_bytes(8))
1062
1015
    return '-'.join((name, compact_date(time.time()), s))