/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-05 03:34:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050505033434-5fff60df09cb61c6
- Per-branch locks in read and write modes.
  (Not on Windows yet.)

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