~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-10 03:55:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050510035534-643062e821052ac5
- Add fortune-cookie external plugin demonstration

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