~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-06 03:13:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050506031326-9510ca403182ed3e
- Update revfile docs; most of what's in there is speculative
  about storage with annotations.

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 shutil
19
 
import sys
20
 
import os
21
 
import errno
22
 
from warnings import warn
23
 
from cStringIO import StringIO
 
18
from sets import Set
24
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
25
23
 
26
24
import bzrlib
27
 
from bzrlib.trace import mutter, note
28
 
from bzrlib.osutils import (isdir, quotefn,
29
 
                            rename, splitpath, sha_file,
30
 
                            file_kind, abspath, normpath, pathjoin)
31
 
import bzrlib.errors as errors
32
 
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
 
                           NoSuchRevision, HistoryMissing, NotBranchError,
34
 
                           DivergedBranches, LockError, UnlistableStore,
35
 
                           UnlistableBranch, NoSuchFile, NotVersionedError,
36
 
                           NoWorkingTree)
37
 
from bzrlib.textui import show_status
38
 
from bzrlib.config import TreeConfig
39
 
from bzrlib.delta import compare_trees
40
 
import bzrlib.inventory as inventory
41
 
from bzrlib.inventory import Inventory
42
 
from bzrlib.lockable_files import LockableFiles
43
 
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
44
 
from bzrlib.repository import Repository
45
 
from bzrlib.store import copy_all
46
 
import bzrlib.transactions as transactions
47
 
from bzrlib.transport import Transport, get_transport
48
 
from bzrlib.tree import EmptyTree, RevisionTree
49
 
import bzrlib.ui
50
 
import bzrlib.xml5
51
 
 
52
 
 
53
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
54
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
55
 
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
 
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
 
 
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
56
39
## TODO: Maybe include checks for common corruption of newlines, etc?
57
40
 
58
41
 
59
 
# TODO: Some operations like log might retrieve the same revisions
60
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
61
 
# cache in memory to make this faster.  In general anything can be
62
 
# cached in memory between lock and unlock operations.
63
 
 
64
 
def find_branch(*ignored, **ignored_too):
65
 
    # XXX: leave this here for about one release, then remove it
66
 
    raise NotImplementedError('find_branch() is not supported anymore, '
67
 
                              'please use one of the new branch constructors')
68
 
 
69
 
 
70
 
def needs_read_lock(unbound):
71
 
    """Decorate unbound to take out and release a read lock."""
72
 
    def decorated(self, *args, **kwargs):
73
 
        self.lock_read()
74
 
        try:
75
 
            return unbound(self, *args, **kwargs)
76
 
        finally:
77
 
            self.unlock()
78
 
    return decorated
79
 
 
80
 
 
81
 
def needs_write_lock(unbound):
82
 
    """Decorate unbound to take out and release a write lock."""
83
 
    def decorated(self, *args, **kwargs):
84
 
        self.lock_write()
85
 
        try:
86
 
            return unbound(self, *args, **kwargs)
87
 
        finally:
88
 
            self.unlock()
89
 
    return decorated
 
42
 
 
43
def find_branch_root(f=None):
 
44
    """Find the branch root enclosing f, or pwd.
 
45
 
 
46
    It is not necessary that f exists.
 
47
 
 
48
    Basically we keep looking up until we find the control directory or
 
49
    run into the root."""
 
50
    if f == None:
 
51
        f = os.getcwd()
 
52
    elif hasattr(os.path, 'realpath'):
 
53
        f = os.path.realpath(f)
 
54
    else:
 
55
        f = os.path.abspath(f)
 
56
 
 
57
    orig_f = f
 
58
 
 
59
    while True:
 
60
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
61
            return f
 
62
        head, tail = os.path.split(f)
 
63
        if head == f:
 
64
            # reached the root, whatever that may be
 
65
            raise BzrError('%r is not in a branch' % orig_f)
 
66
        f = head
 
67
    
 
68
 
90
69
 
91
70
######################################################################
92
71
# branch objects
93
72
 
94
 
class Branch(object):
 
73
class Branch:
95
74
    """Branch holding a history of revisions.
96
75
 
97
76
    base
98
 
        Base directory/url of the branch.
 
77
        Base directory of the branch.
99
78
    """
100
 
    base = None
101
 
 
102
 
    def __init__(self, *ignored, **ignored_too):
103
 
        raise NotImplementedError('The Branch class is abstract')
104
 
 
105
 
    @staticmethod
106
 
    def open_downlevel(base):
107
 
        """Open a branch which may be of an old format.
108
 
        
109
 
        Only local branches are supported."""
110
 
        return BzrBranch(get_transport(base), relax_version_check=True)
111
 
        
112
 
    @staticmethod
113
 
    def open(base):
114
 
        """Open an existing branch, rooted at 'base' (url)"""
115
 
        t = get_transport(base)
116
 
        mutter("trying to open %r with transport %r", base, t)
117
 
        return BzrBranch(t)
118
 
 
119
 
    @staticmethod
120
 
    def open_containing(url):
121
 
        """Open an existing branch which contains url.
122
 
        
123
 
        This probes for a branch at url, and searches upwards from there.
124
 
 
125
 
        Basically we keep looking up until we find the control directory or
126
 
        run into the root.  If there isn't one, raises NotBranchError.
127
 
        If there is one, it is returned, along with the unused portion of url.
 
79
    _lockmode = None
 
80
    
 
81
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
82
        """Create new branch object at a particular location.
 
83
 
 
84
        base -- Base directory for the branch.
 
85
        
 
86
        init -- If True, create new control files in a previously
 
87
             unversioned directory.  If False, the branch must already
 
88
             be versioned.
 
89
 
 
90
        find_root -- If true and init is false, find the root of the
 
91
             existing branch containing base.
 
92
 
 
93
        In the test suite, creation of new trees is tested using the
 
94
        `ScratchBranch` class.
128
95
        """
129
 
        t = get_transport(url)
130
 
        while True:
 
96
        if init:
 
97
            self.base = os.path.realpath(base)
 
98
            self._make_control()
 
99
        elif find_root:
 
100
            self.base = find_branch_root(base)
 
101
        else:
 
102
            self.base = os.path.realpath(base)
 
103
            if not isdir(self.controlfilename('.')):
 
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'])
 
107
        self._check_format()
 
108
        self.lock(lock_mode)
 
109
 
 
110
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
111
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
112
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
113
 
 
114
 
 
115
    def __str__(self):
 
116
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
117
 
 
118
 
 
119
    __repr__ = __str__
 
120
 
 
121
 
 
122
 
 
123
    def lock(self, mode='w'):
 
124
        """Lock the on-disk branch, excluding other processes."""
 
125
        try:
 
126
            import fcntl, errno
 
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
 
131
137
            try:
132
 
                return BzrBranch(t), t.relpath(url)
133
 
            except NotBranchError, e:
134
 
                mutter('not a branch in: %r %s', t.base, e)
135
 
            new_t = t.clone('..')
136
 
            if new_t.base == t.base:
137
 
                # reached the root, whatever that may be
138
 
                raise NotBranchError(path=url)
139
 
            t = new_t
140
 
 
141
 
    @staticmethod
142
 
    def initialize(base):
143
 
        """Create a new branch, rooted at 'base' (url)"""
144
 
        t = get_transport(unicode(base))
145
 
        return BzrBranch(t, init=True)
146
 
 
147
 
    def setup_caching(self, cache_root):
148
 
        """Subclasses that care about caching should override this, and set
149
 
        up cached stores located under cache_root.
150
 
        """
151
 
        self.cache_root = cache_root
152
 
 
153
 
    def _get_nick(self):
154
 
        cfg = self.tree_config()
155
 
        return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
156
 
 
157
 
    def _set_nick(self, nick):
158
 
        cfg = self.tree_config()
159
 
        cfg.set_option(nick, "nickname")
160
 
        assert cfg.get_option("nickname") == nick
161
 
 
162
 
    nick = property(_get_nick, _set_nick)
163
 
        
164
 
    def push_stores(self, branch_to):
165
 
        """Copy the content of this branches store to branch_to."""
166
 
        raise NotImplementedError('push_stores is abstract')
167
 
 
168
 
    def lock_write(self):
169
 
        raise NotImplementedError('lock_write is abstract')
170
 
        
171
 
    def lock_read(self):
172
 
        raise NotImplementedError('lock_read is abstract')
173
 
 
174
 
    def unlock(self):
175
 
        raise NotImplementedError('unlock is abstract')
 
138
                lockfile = os.open(self.controlfilename('branch-lock'), om)
 
139
            except OSError, e:
 
140
                if e.errno == errno.ENOENT:
 
141
                    # might not exist on branches from <0.0.4
 
142
                    self.controlfile('branch-lock', 'w').close()
 
143
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
 
144
                else:
 
145
                    raise e
 
146
            
 
147
            fcntl.lockf(lockfile, lm)
 
148
            def unlock():
 
149
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
150
                os.close(lockfile)
 
151
                self._lockmode = None
 
152
            self.unlock = unlock
 
153
            self._lockmode = mode
 
154
        except ImportError:
 
155
            warning("please write a locking method for platform %r" % sys.platform)
 
156
            def unlock():
 
157
                self._lockmode = None
 
158
            self.unlock = unlock
 
159
            self._lockmode = mode
 
160
 
 
161
 
 
162
    def _need_readlock(self):
 
163
        if self._lockmode not in ['r', 'w']:
 
164
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
165
 
 
166
    def _need_writelock(self):
 
167
        if self._lockmode not in ['w']:
 
168
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
169
 
176
170
 
177
171
    def abspath(self, name):
178
 
        """Return absolute filename for something in the branch
 
172
        """Return absolute filename for something in the branch"""
 
173
        return os.path.join(self.base, name)
 
174
 
 
175
 
 
176
    def relpath(self, path):
 
177
        """Return path relative to this branch of something inside it.
 
178
 
 
179
        Raises an error if path is not in this branch."""
 
180
        rp = os.path.realpath(path)
 
181
        # FIXME: windows
 
182
        if not rp.startswith(self.base):
 
183
            bailout("path %r is not within branch %r" % (rp, self.base))
 
184
        rp = rp[len(self.base):]
 
185
        rp = rp.lstrip(os.sep)
 
186
        return rp
 
187
 
 
188
 
 
189
    def controlfilename(self, file_or_path):
 
190
        """Return location relative to branch."""
 
191
        if isinstance(file_or_path, types.StringTypes):
 
192
            file_or_path = [file_or_path]
 
193
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
194
 
 
195
 
 
196
    def controlfile(self, file_or_path, mode='r'):
 
197
        """Open a control file for this branch.
 
198
 
 
199
        There are two classes of file in the control directory: text
 
200
        and binary.  binary files are untranslated byte streams.  Text
 
201
        control files are stored with Unix newlines and in UTF-8, even
 
202
        if the platform or locale defaults are different.
 
203
        """
 
204
 
 
205
        fn = self.controlfilename(file_or_path)
 
206
 
 
207
        if mode == 'rb' or mode == 'wb':
 
208
            return file(fn, mode)
 
209
        elif mode == 'r' or mode == 'w':
 
210
            # open in binary mode anyhow so there's no newline translation;
 
211
            # codecs uses line buffering by default; don't want that.
 
212
            import codecs
 
213
            return codecs.open(fn, mode + 'b', 'utf-8',
 
214
                               buffering=60000)
 
215
        else:
 
216
            raise BzrError("invalid controlfile mode %r" % mode)
 
217
 
 
218
 
 
219
 
 
220
    def _make_control(self):
 
221
        os.mkdir(self.controlfilename([]))
 
222
        self.controlfile('README', 'w').write(
 
223
            "This is a Bazaar-NG control directory.\n"
 
224
            "Do not change any files in this directory.")
 
225
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
226
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
227
            os.mkdir(self.controlfilename(d))
 
228
        for f in ('revision-history', 'merged-patches',
 
229
                  'pending-merged-patches', 'branch-name',
 
230
                  'branch-lock'):
 
231
            self.controlfile(f, 'w').write('')
 
232
        mutter('created control directory in ' + self.base)
 
233
        Inventory().write_xml(self.controlfile('inventory','w'))
 
234
 
 
235
 
 
236
    def _check_format(self):
 
237
        """Check this branch format is supported.
 
238
 
 
239
        The current tool only supports the current unstable format.
 
240
 
 
241
        In the future, we might need different in-memory Branch
 
242
        classes to support downlevel branches.  But not yet.
 
243
        """
 
244
        # This ignores newlines so that we can open branches created
 
245
        # on Windows from Linux and so on.  I think it might be better
 
246
        # to always make all internal files in unix format.
 
247
        fmt = self.controlfile('branch-format', 'r').read()
 
248
        fmt.replace('\r\n', '')
 
249
        if fmt != BZR_BRANCH_FORMAT:
 
250
            bailout('sorry, branch format %r not supported' % fmt,
 
251
                    ['use a different bzr version',
 
252
                     'or remove the .bzr directory and "bzr init" again'])
 
253
 
 
254
 
 
255
    def read_working_inventory(self):
 
256
        """Read the working inventory."""
 
257
        self._need_readlock()
 
258
        before = time.time()
 
259
        # ElementTree does its own conversion from UTF-8, so open in
 
260
        # binary.
 
261
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
262
        mutter("loaded inventory of %d items in %f"
 
263
               % (len(inv), time.time() - before))
 
264
        return inv
 
265
 
 
266
 
 
267
    def _write_inventory(self, inv):
 
268
        """Update the working inventory.
 
269
 
 
270
        That is to say, the inventory describing changes underway, that
 
271
        will be committed to the next revision.
 
272
        """
 
273
        self._need_writelock()
 
274
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
275
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
276
        tmpfname = self.controlfilename('inventory.tmp')
 
277
        tmpf = file(tmpfname, 'wb')
 
278
        inv.write_xml(tmpf)
 
279
        tmpf.close()
 
280
        inv_fname = self.controlfilename('inventory')
 
281
        if sys.platform == 'win32':
 
282
            os.remove(inv_fname)
 
283
        os.rename(tmpfname, inv_fname)
 
284
        mutter('wrote working inventory')
 
285
 
 
286
 
 
287
    inventory = property(read_working_inventory, _write_inventory, None,
 
288
                         """Inventory for the working copy.""")
 
289
 
 
290
 
 
291
    def add(self, files, verbose=False):
 
292
        """Make files versioned.
 
293
 
 
294
        Note that the command line normally calls smart_add instead.
 
295
 
 
296
        This puts the files in the Added state, so that they will be
 
297
        recorded by the next commit.
 
298
 
 
299
        TODO: Perhaps have an option to add the ids even if the files do
 
300
               not (yet) exist.
 
301
 
 
302
        TODO: Perhaps return the ids of the files?  But then again it
 
303
               is easy to retrieve them if they're needed.
 
304
 
 
305
        TODO: Option to specify file id.
 
306
 
 
307
        TODO: Adding a directory should optionally recurse down and
 
308
               add all non-ignored children.  Perhaps do that in a
 
309
               higher-level method.
 
310
 
 
311
        >>> b = ScratchBranch(files=['foo'])
 
312
        >>> 'foo' in b.unknowns()
 
313
        True
 
314
        >>> b.show_status()
 
315
        ?       foo
 
316
        >>> b.add('foo')
 
317
        >>> 'foo' in b.unknowns()
 
318
        False
 
319
        >>> bool(b.inventory.path2id('foo'))
 
320
        True
 
321
        >>> b.show_status()
 
322
        A       foo
 
323
 
 
324
        >>> b.add('foo')
 
325
        Traceback (most recent call last):
 
326
        ...
 
327
        BzrError: ('foo is already versioned', [])
 
328
 
 
329
        >>> b.add(['nothere'])
 
330
        Traceback (most recent call last):
 
331
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
332
        """
 
333
        self._need_writelock()
 
334
 
 
335
        # TODO: Re-adding a file that is removed in the working copy
 
336
        # should probably put it back with the previous ID.
 
337
        if isinstance(files, types.StringTypes):
 
338
            files = [files]
179
339
        
180
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
 
        method and not a tree method.
182
 
        """
183
 
        raise NotImplementedError('abspath is abstract')
184
 
 
185
 
    def get_root_id(self):
186
 
        """Return the id of this branches root"""
187
 
        raise NotImplementedError('get_root_id is abstract')
188
 
 
189
 
    def print_file(self, file, revision_id):
 
340
        inv = self.read_working_inventory()
 
341
        for f in files:
 
342
            if is_control_file(f):
 
343
                bailout("cannot add control file %s" % quotefn(f))
 
344
 
 
345
            fp = splitpath(f)
 
346
 
 
347
            if len(fp) == 0:
 
348
                bailout("cannot add top-level %r" % f)
 
349
                
 
350
            fullpath = os.path.normpath(self.abspath(f))
 
351
 
 
352
            try:
 
353
                kind = file_kind(fullpath)
 
354
            except OSError:
 
355
                # maybe something better?
 
356
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
357
            
 
358
            if kind != 'file' and kind != 'directory':
 
359
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
360
 
 
361
            file_id = gen_file_id(f)
 
362
            inv.add_path(f, kind=kind, file_id=file_id)
 
363
 
 
364
            if verbose:
 
365
                show_status('A', kind, quotefn(f))
 
366
                
 
367
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
368
            
 
369
        self._write_inventory(inv)
 
370
 
 
371
 
 
372
    def print_file(self, file, revno):
190
373
        """Print `file` to stdout."""
191
 
        raise NotImplementedError('print_file is abstract')
192
 
 
193
 
    def append_revision(self, *revision_ids):
194
 
        raise NotImplementedError('append_revision is abstract')
195
 
 
196
 
    def set_revision_history(self, rev_history):
197
 
        raise NotImplementedError('set_revision_history is abstract')
 
374
        self._need_readlock()
 
375
        tree = self.revision_tree(self.lookup_revision(revno))
 
376
        # use inventory as it was in that revision
 
377
        file_id = tree.inventory.path2id(file)
 
378
        if not file_id:
 
379
            bailout("%r is not present in revision %d" % (file, revno))
 
380
        tree.print_file(file_id)
 
381
        
 
382
 
 
383
    def remove(self, files, verbose=False):
 
384
        """Mark nominated files for removal from the inventory.
 
385
 
 
386
        This does not remove their text.  This does not run on 
 
387
 
 
388
        TODO: Refuse to remove modified files unless --force is given?
 
389
 
 
390
        >>> b = ScratchBranch(files=['foo'])
 
391
        >>> b.add('foo')
 
392
        >>> b.inventory.has_filename('foo')
 
393
        True
 
394
        >>> b.remove('foo')
 
395
        >>> b.working_tree().has_filename('foo')
 
396
        True
 
397
        >>> b.inventory.has_filename('foo')
 
398
        False
 
399
        
 
400
        >>> b = ScratchBranch(files=['foo'])
 
401
        >>> b.add('foo')
 
402
        >>> b.commit('one')
 
403
        >>> b.remove('foo')
 
404
        >>> b.commit('two')
 
405
        >>> b.inventory.has_filename('foo') 
 
406
        False
 
407
        >>> b.basis_tree().has_filename('foo') 
 
408
        False
 
409
        >>> b.working_tree().has_filename('foo') 
 
410
        True
 
411
 
 
412
        TODO: Do something useful with directories.
 
413
 
 
414
        TODO: Should this remove the text or not?  Tough call; not
 
415
        removing may be useful and the user can just use use rm, and
 
416
        is the opposite of add.  Removing it is consistent with most
 
417
        other tools.  Maybe an option.
 
418
        """
 
419
        ## TODO: Normalize names
 
420
        ## TODO: Remove nested loops; better scalability
 
421
        self._need_writelock()
 
422
 
 
423
        if isinstance(files, types.StringTypes):
 
424
            files = [files]
 
425
        
 
426
        tree = self.working_tree()
 
427
        inv = tree.inventory
 
428
 
 
429
        # do this before any modifications
 
430
        for f in files:
 
431
            fid = inv.path2id(f)
 
432
            if not fid:
 
433
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
434
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
435
            if verbose:
 
436
                # having remove it, it must be either ignored or unknown
 
437
                if tree.is_ignored(f):
 
438
                    new_status = 'I'
 
439
                else:
 
440
                    new_status = '?'
 
441
                show_status(new_status, inv[fid].kind, quotefn(f))
 
442
            del inv[fid]
 
443
 
 
444
        self._write_inventory(inv)
 
445
 
 
446
 
 
447
    def unknowns(self):
 
448
        """Return all unknown files.
 
449
 
 
450
        These are files in the working directory that are not versioned or
 
451
        control files or ignored.
 
452
        
 
453
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
454
        >>> list(b.unknowns())
 
455
        ['foo']
 
456
        >>> b.add('foo')
 
457
        >>> list(b.unknowns())
 
458
        []
 
459
        >>> b.remove('foo')
 
460
        >>> list(b.unknowns())
 
461
        ['foo']
 
462
        """
 
463
        return self.working_tree().unknowns()
 
464
 
 
465
 
 
466
    def commit(self, message, timestamp=None, timezone=None,
 
467
               committer=None,
 
468
               verbose=False):
 
469
        """Commit working copy as a new revision.
 
470
        
 
471
        The basic approach is to add all the file texts into the
 
472
        store, then the inventory, then make a new revision pointing
 
473
        to that inventory and store that.
 
474
        
 
475
        This is not quite safe if the working copy changes during the
 
476
        commit; for the moment that is simply not allowed.  A better
 
477
        approach is to make a temporary copy of the files before
 
478
        computing their hashes, and then add those hashes in turn to
 
479
        the inventory.  This should mean at least that there are no
 
480
        broken hash pointers.  There is no way we can get a snapshot
 
481
        of the whole directory at an instant.  This would also have to
 
482
        be robust against files disappearing, moving, etc.  So the
 
483
        whole thing is a bit hard.
 
484
 
 
485
        timestamp -- if not None, seconds-since-epoch for a
 
486
             postdated/predated commit.
 
487
        """
 
488
        self._need_writelock()
 
489
 
 
490
        ## TODO: Show branch names
 
491
 
 
492
        # TODO: Don't commit if there are no changes, unless forced?
 
493
 
 
494
        # First walk over the working inventory; and both update that
 
495
        # and also build a new revision inventory.  The revision
 
496
        # inventory needs to hold the text-id, sha1 and size of the
 
497
        # actual file versions committed in the revision.  (These are
 
498
        # not present in the working inventory.)  We also need to
 
499
        # detect missing/deleted files, and remove them from the
 
500
        # working inventory.
 
501
 
 
502
        work_inv = self.read_working_inventory()
 
503
        inv = Inventory()
 
504
        basis = self.basis_tree()
 
505
        basis_inv = basis.inventory
 
506
        missing_ids = []
 
507
        for path, entry in work_inv.iter_entries():
 
508
            ## TODO: Cope with files that have gone missing.
 
509
 
 
510
            ## TODO: Check that the file kind has not changed from the previous
 
511
            ## revision of this file (if any).
 
512
 
 
513
            entry = entry.copy()
 
514
 
 
515
            p = self.abspath(path)
 
516
            file_id = entry.file_id
 
517
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
518
 
 
519
            if not os.path.exists(p):
 
520
                mutter("    file is missing, removing from inventory")
 
521
                if verbose:
 
522
                    show_status('D', entry.kind, quotefn(path))
 
523
                missing_ids.append(file_id)
 
524
                continue
 
525
 
 
526
            # TODO: Handle files that have been deleted
 
527
 
 
528
            # TODO: Maybe a special case for empty files?  Seems a
 
529
            # waste to store them many times.
 
530
 
 
531
            inv.add(entry)
 
532
 
 
533
            if basis_inv.has_id(file_id):
 
534
                old_kind = basis_inv[file_id].kind
 
535
                if old_kind != entry.kind:
 
536
                    bailout("entry %r changed kind from %r to %r"
 
537
                            % (file_id, old_kind, entry.kind))
 
538
 
 
539
            if entry.kind == 'directory':
 
540
                if not isdir(p):
 
541
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
542
            elif entry.kind == 'file':
 
543
                if not isfile(p):
 
544
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
545
 
 
546
                content = file(p, 'rb').read()
 
547
 
 
548
                entry.text_sha1 = sha_string(content)
 
549
                entry.text_size = len(content)
 
550
 
 
551
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
552
                if (old_ie
 
553
                    and (old_ie.text_size == entry.text_size)
 
554
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
555
                    ## assert content == basis.get_file(file_id).read()
 
556
                    entry.text_id = basis_inv[file_id].text_id
 
557
                    mutter('    unchanged from previous text_id {%s}' %
 
558
                           entry.text_id)
 
559
                    
 
560
                else:
 
561
                    entry.text_id = gen_file_id(entry.name)
 
562
                    self.text_store.add(content, entry.text_id)
 
563
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
564
                    if verbose:
 
565
                        if not old_ie:
 
566
                            state = 'A'
 
567
                        elif (old_ie.name == entry.name
 
568
                              and old_ie.parent_id == entry.parent_id):
 
569
                            state = 'M'
 
570
                        else:
 
571
                            state = 'R'
 
572
 
 
573
                        show_status(state, entry.kind, quotefn(path))
 
574
 
 
575
        for file_id in missing_ids:
 
576
            # have to do this later so we don't mess up the iterator.
 
577
            # since parents may be removed before their children we
 
578
            # have to test.
 
579
 
 
580
            # FIXME: There's probably a better way to do this; perhaps
 
581
            # the workingtree should know how to filter itself.
 
582
            if work_inv.has_id(file_id):
 
583
                del work_inv[file_id]
 
584
 
 
585
 
 
586
        inv_id = rev_id = _gen_revision_id(time.time())
 
587
        
 
588
        inv_tmp = tempfile.TemporaryFile()
 
589
        inv.write_xml(inv_tmp)
 
590
        inv_tmp.seek(0)
 
591
        self.inventory_store.add(inv_tmp, inv_id)
 
592
        mutter('new inventory_id is {%s}' % inv_id)
 
593
 
 
594
        self._write_inventory(work_inv)
 
595
 
 
596
        if timestamp == None:
 
597
            timestamp = time.time()
 
598
 
 
599
        if committer == None:
 
600
            committer = username()
 
601
 
 
602
        if timezone == None:
 
603
            timezone = local_time_offset()
 
604
 
 
605
        mutter("building commit log message")
 
606
        rev = Revision(timestamp=timestamp,
 
607
                       timezone=timezone,
 
608
                       committer=committer,
 
609
                       precursor = self.last_patch(),
 
610
                       message = message,
 
611
                       inventory_id=inv_id,
 
612
                       revision_id=rev_id)
 
613
 
 
614
        rev_tmp = tempfile.TemporaryFile()
 
615
        rev.write_xml(rev_tmp)
 
616
        rev_tmp.seek(0)
 
617
        self.revision_store.add(rev_tmp, rev_id)
 
618
        mutter("new revision_id is {%s}" % rev_id)
 
619
        
 
620
        ## XXX: Everything up to here can simply be orphaned if we abort
 
621
        ## the commit; it will leave junk files behind but that doesn't
 
622
        ## matter.
 
623
 
 
624
        ## TODO: Read back the just-generated changeset, and make sure it
 
625
        ## applies and recreates the right state.
 
626
 
 
627
        ## TODO: Also calculate and store the inventory SHA1
 
628
        mutter("committing patch r%d" % (self.revno() + 1))
 
629
 
 
630
 
 
631
        self.append_revision(rev_id)
 
632
        
 
633
        if verbose:
 
634
            note("commited r%d" % self.revno())
 
635
 
 
636
 
 
637
    def append_revision(self, revision_id):
 
638
        mutter("add {%s} to revision-history" % revision_id)
 
639
        rev_history = self.revision_history()
 
640
 
 
641
        tmprhname = self.controlfilename('revision-history.tmp')
 
642
        rhname = self.controlfilename('revision-history')
 
643
        
 
644
        f = file(tmprhname, 'wt')
 
645
        rev_history.append(revision_id)
 
646
        f.write('\n'.join(rev_history))
 
647
        f.write('\n')
 
648
        f.close()
 
649
 
 
650
        if sys.platform == 'win32':
 
651
            os.remove(rhname)
 
652
        os.rename(tmprhname, rhname)
 
653
        
 
654
 
 
655
 
 
656
    def get_revision(self, revision_id):
 
657
        """Return the Revision object for a named revision"""
 
658
        self._need_readlock()
 
659
        r = Revision.read_xml(self.revision_store[revision_id])
 
660
        assert r.revision_id == revision_id
 
661
        return r
 
662
 
 
663
 
 
664
    def get_inventory(self, inventory_id):
 
665
        """Get Inventory object by hash.
 
666
 
 
667
        TODO: Perhaps for this and similar methods, take a revision
 
668
               parameter which can be either an integer revno or a
 
669
               string hash."""
 
670
        self._need_readlock()
 
671
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
672
        return i
 
673
 
 
674
 
 
675
    def get_revision_inventory(self, revision_id):
 
676
        """Return inventory of a past revision."""
 
677
        self._need_readlock()
 
678
        if revision_id == None:
 
679
            return Inventory()
 
680
        else:
 
681
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
682
 
198
683
 
199
684
    def revision_history(self):
200
 
        """Return sequence of revision hashes on to this branch."""
201
 
        raise NotImplementedError('revision_history is abstract')
 
685
        """Return sequence of revision hashes on to this branch.
 
686
 
 
687
        >>> ScratchBranch().revision_history()
 
688
        []
 
689
        """
 
690
        self._need_readlock()
 
691
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
692
 
 
693
 
 
694
    def enum_history(self, direction):
 
695
        """Return (revno, revision_id) for history of branch.
 
696
 
 
697
        direction
 
698
            'forward' is from earliest to latest
 
699
            'reverse' is from latest to earliest
 
700
        """
 
701
        rh = self.revision_history()
 
702
        if direction == 'forward':
 
703
            i = 1
 
704
            for rid in rh:
 
705
                yield i, rid
 
706
                i += 1
 
707
        elif direction == 'reverse':
 
708
            i = len(rh)
 
709
            while i > 0:
 
710
                yield i, rh[i-1]
 
711
                i -= 1
 
712
        else:
 
713
            raise BzrError('invalid history direction %r' % direction)
 
714
 
202
715
 
203
716
    def revno(self):
204
717
        """Return current revision number for this branch.
205
718
 
206
719
        That is equivalent to the number of revisions committed to
207
720
        this branch.
 
721
 
 
722
        >>> b = ScratchBranch()
 
723
        >>> b.revno()
 
724
        0
 
725
        >>> b.commit('no foo')
 
726
        >>> b.revno()
 
727
        1
208
728
        """
209
729
        return len(self.revision_history())
210
730
 
211
 
    def last_revision(self):
212
 
        """Return last patch hash, or None if no history."""
 
731
 
 
732
    def last_patch(self):
 
733
        """Return last patch hash, or None if no history.
 
734
 
 
735
        >>> ScratchBranch().last_patch() == None
 
736
        True
 
737
        """
213
738
        ph = self.revision_history()
214
739
        if ph:
215
740
            return ph[-1]
216
741
        else:
217
742
            return None
218
 
 
219
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
220
 
        """Return a list of new revisions that would perfectly fit.
221
 
        
222
 
        If self and other have not diverged, return a list of the revisions
223
 
        present in other, but missing from self.
224
 
 
225
 
        >>> from bzrlib.commit import commit
226
 
        >>> bzrlib.trace.silent = True
227
 
        >>> br1 = ScratchBranch()
228
 
        >>> br2 = ScratchBranch()
229
 
        >>> br1.missing_revisions(br2)
230
 
        []
231
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
232
 
        >>> br1.missing_revisions(br2)
233
 
        [u'REVISION-ID-1']
234
 
        >>> br2.missing_revisions(br1)
235
 
        []
236
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
237
 
        >>> br1.missing_revisions(br2)
238
 
        []
239
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
240
 
        >>> br1.missing_revisions(br2)
241
 
        [u'REVISION-ID-2A']
242
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
243
 
        >>> br1.missing_revisions(br2)
244
 
        Traceback (most recent call last):
245
 
        DivergedBranches: These branches have diverged.  Try merge.
246
 
        """
247
 
        self_history = self.revision_history()
248
 
        self_len = len(self_history)
249
 
        other_history = other.revision_history()
250
 
        other_len = len(other_history)
251
 
        common_index = min(self_len, other_len) -1
252
 
        if common_index >= 0 and \
253
 
            self_history[common_index] != other_history[common_index]:
254
 
            raise DivergedBranches(self, other)
255
 
 
256
 
        if stop_revision is None:
257
 
            stop_revision = other_len
258
 
        else:
259
 
            assert isinstance(stop_revision, int)
260
 
            if stop_revision > other_len:
261
 
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
262
 
        return other_history[self_len:stop_revision]
263
 
 
264
 
    
265
 
    def update_revisions(self, other, stop_revision=None):
266
 
        """Pull in new perfect-fit revisions."""
267
 
        raise NotImplementedError('update_revisions is abstract')
268
 
 
269
 
    def pullable_revisions(self, other, stop_revision):
270
 
        raise NotImplementedError('pullable_revisions is abstract')
271
 
        
272
 
    def revision_id_to_revno(self, revision_id):
273
 
        """Given a revision id, return its revno"""
274
 
        if revision_id is None:
275
 
            return 0
276
 
        history = self.revision_history()
277
 
        try:
278
 
            return history.index(revision_id) + 1
279
 
        except ValueError:
280
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
281
 
 
282
 
    def get_rev_id(self, revno, history=None):
283
 
        """Find the revision id of the specified revno."""
 
743
        
 
744
 
 
745
    def lookup_revision(self, revno):
 
746
        """Return revision hash for revision number."""
284
747
        if revno == 0:
285
748
            return None
286
 
        if history is None:
287
 
            history = self.revision_history()
288
 
        elif revno <= 0 or revno > len(history):
289
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
290
 
        return history[revno - 1]
 
749
 
 
750
        try:
 
751
            # list is 0-based; revisions are 1-based
 
752
            return self.revision_history()[revno-1]
 
753
        except IndexError:
 
754
            raise BzrError("no such revision %s" % revno)
 
755
 
 
756
 
 
757
    def revision_tree(self, revision_id):
 
758
        """Return Tree for a revision on this branch.
 
759
 
 
760
        `revision_id` may be None for the null revision, in which case
 
761
        an `EmptyTree` is returned."""
 
762
        self._need_readlock()
 
763
        if revision_id == None:
 
764
            return EmptyTree()
 
765
        else:
 
766
            inv = self.get_revision_inventory(revision_id)
 
767
            return RevisionTree(self.text_store, inv)
 
768
 
291
769
 
292
770
    def working_tree(self):
293
 
        """Return a `Tree` for the working copy if this is a local branch."""
294
 
        raise NotImplementedError('working_tree is abstract')
 
771
        """Return a `Tree` for the working copy."""
 
772
        return WorkingTree(self.base, self.read_working_inventory())
295
773
 
296
 
    def pull(self, source, overwrite=False):
297
 
        raise NotImplementedError('pull is abstract')
298
774
 
299
775
    def basis_tree(self):
300
776
        """Return `Tree` object for last revision.
301
777
 
302
778
        If there are no revisions yet, return an `EmptyTree`.
 
779
 
 
780
        >>> b = ScratchBranch(files=['foo'])
 
781
        >>> b.basis_tree().has_filename('foo')
 
782
        False
 
783
        >>> b.working_tree().has_filename('foo')
 
784
        True
 
785
        >>> b.add('foo')
 
786
        >>> b.commit('add foo')
 
787
        >>> b.basis_tree().has_filename('foo')
 
788
        True
303
789
        """
304
 
        return self.repository.revision_tree(self.last_revision())
 
790
        r = self.last_patch()
 
791
        if r == None:
 
792
            return EmptyTree()
 
793
        else:
 
794
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
795
 
 
796
 
305
797
 
306
798
    def rename_one(self, from_rel, to_rel):
307
799
        """Rename one file.
308
800
 
309
801
        This can change the directory or the filename or both.
310
802
        """
311
 
        raise NotImplementedError('rename_one is abstract')
 
803
        self._need_writelock()
 
804
        tree = self.working_tree()
 
805
        inv = tree.inventory
 
806
        if not tree.has_filename(from_rel):
 
807
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
808
        if tree.has_filename(to_rel):
 
809
            bailout("can't rename: new working file %r already exists" % to_rel)
 
810
            
 
811
        file_id = inv.path2id(from_rel)
 
812
        if file_id == None:
 
813
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
814
 
 
815
        if inv.path2id(to_rel):
 
816
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
817
 
 
818
        to_dir, to_tail = os.path.split(to_rel)
 
819
        to_dir_id = inv.path2id(to_dir)
 
820
        if to_dir_id == None and to_dir != '':
 
821
            bailout("can't determine destination directory id for %r" % to_dir)
 
822
 
 
823
        mutter("rename_one:")
 
824
        mutter("  file_id    {%s}" % file_id)
 
825
        mutter("  from_rel   %r" % from_rel)
 
826
        mutter("  to_rel     %r" % to_rel)
 
827
        mutter("  to_dir     %r" % to_dir)
 
828
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
829
            
 
830
        inv.rename(file_id, to_dir_id, to_tail)
 
831
 
 
832
        print "%s => %s" % (from_rel, to_rel)
 
833
        
 
834
        from_abs = self.abspath(from_rel)
 
835
        to_abs = self.abspath(to_rel)
 
836
        try:
 
837
            os.rename(from_abs, to_abs)
 
838
        except OSError, e:
 
839
            bailout("failed to rename %r to %r: %s"
 
840
                    % (from_abs, to_abs, e[1]),
 
841
                    ["rename rolled back"])
 
842
 
 
843
        self._write_inventory(inv)
 
844
            
 
845
 
312
846
 
313
847
    def move(self, from_paths, to_name):
314
848
        """Rename files.
320
854
 
321
855
        Note that to_name is only the last component of the new name;
322
856
        this doesn't change the directory.
323
 
 
324
 
        This returns a list of (from_path, to_path) pairs for each
325
 
        entry that is moved.
326
 
        """
327
 
        raise NotImplementedError('move is abstract')
328
 
 
329
 
    def get_parent(self):
330
 
        """Return the parent location of the branch.
331
 
 
332
 
        This is the default location for push/pull/missing.  The usual
333
 
        pattern is that the user can override it by specifying a
334
 
        location.
335
 
        """
336
 
        raise NotImplementedError('get_parent is abstract')
337
 
 
338
 
    def get_push_location(self):
339
 
        """Return the None or the location to push this branch to."""
340
 
        raise NotImplementedError('get_push_location is abstract')
341
 
 
342
 
    def set_push_location(self, location):
343
 
        """Set a new push location for this branch."""
344
 
        raise NotImplementedError('set_push_location is abstract')
345
 
 
346
 
    def set_parent(self, url):
347
 
        raise NotImplementedError('set_parent is abstract')
348
 
 
349
 
    def check_revno(self, revno):
350
 
        """\
351
 
        Check whether a revno corresponds to any revision.
352
 
        Zero (the NULL revision) is considered valid.
353
 
        """
354
 
        if revno != 0:
355
 
            self.check_real_revno(revno)
356
 
            
357
 
    def check_real_revno(self, revno):
358
 
        """\
359
 
        Check whether a revno corresponds to a real revision.
360
 
        Zero (the NULL revision) is considered invalid
361
 
        """
362
 
        if revno < 1 or revno > self.revno():
363
 
            raise InvalidRevisionNumber(revno)
364
 
        
365
 
    def sign_revision(self, revision_id, gpg_strategy):
366
 
        raise NotImplementedError('sign_revision is abstract')
367
 
 
368
 
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
369
 
        raise NotImplementedError('store_revision_signature is abstract')
370
 
 
371
 
    def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
372
 
        """Copy this branch into the existing directory to_location.
373
 
 
374
 
        Returns the newly created branch object.
375
 
 
376
 
        revision
377
 
            If not None, only revisions up to this point will be copied.
378
 
            The head of the new branch will be that revision.  Must be a
379
 
            revid or None.
380
 
    
381
 
        to_location -- The destination directory; must either exist and be 
382
 
            empty, or not exist, in which case it is created.
383
 
    
384
 
        basis_branch
385
 
            A local branch to copy revisions from, related to this branch. 
386
 
            This is used when branching from a remote (slow) branch, and we have
387
 
            a local branch that might contain some relevant revisions.
388
 
    
389
 
        to_branch_type
390
 
            Branch type of destination branch
391
 
        """
392
 
        assert isinstance(to_location, basestring)
393
 
        if not bzrlib.osutils.lexists(to_location):
394
 
            os.mkdir(to_location)
395
 
        if to_branch_type is None:
396
 
            to_branch_type = BzrBranch
397
 
        br_to = to_branch_type.initialize(to_location)
398
 
        mutter("copy branch from %s to %s", self, br_to)
399
 
        if basis_branch is not None:
400
 
            basis_branch.push_stores(br_to)
401
 
        br_to.working_tree().set_root_id(self.get_root_id())
402
 
        if revision is None:
403
 
            revision = self.last_revision()
404
 
        br_to.update_revisions(self, stop_revision=revision)
405
 
        br_to.set_parent(self.base)
406
 
        # circular import protection
407
 
        from bzrlib.merge import build_working_dir
408
 
        build_working_dir(to_location)
409
 
        mutter("copied")
410
 
        return br_to
411
 
 
412
 
class BzrBranch(Branch):
413
 
    """A branch stored in the actual filesystem.
414
 
 
415
 
    Note that it's "local" in the context of the filesystem; it doesn't
416
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
417
 
    it's writable, and can be accessed via the normal filesystem API.
418
 
 
419
 
    """
420
 
    # We actually expect this class to be somewhat short-lived; part of its
421
 
    # purpose is to try to isolate what bits of the branch logic are tied to
422
 
    # filesystem access, so that in a later step, we can extricate them to
423
 
    # a separarte ("storage") class.
424
 
    _inventory_weave = None
425
 
    
426
 
    # Map some sort of prefix into a namespace
427
 
    # stuff like "revno:10", "revid:", etc.
428
 
    # This should match a prefix with a function which accepts
429
 
    REVISION_NAMESPACES = {}
430
 
 
431
 
    def push_stores(self, branch_to):
432
 
        """See Branch.push_stores."""
433
 
        if (self._branch_format != branch_to._branch_format
434
 
            or self._branch_format != 4):
435
 
            from bzrlib.fetch import greedy_fetch
436
 
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
437
 
                   self, self._branch_format, branch_to, branch_to._branch_format)
438
 
            greedy_fetch(to_branch=branch_to, from_branch=self,
439
 
                         revision=self.last_revision())
440
 
            return
441
 
 
442
 
        store_pairs = ((self.text_store,      branch_to.text_store),
443
 
                       (self.inventory_store, branch_to.inventory_store),
444
 
                       (self.revision_store,  branch_to.revision_store))
445
 
        try:
446
 
            for from_store, to_store in store_pairs: 
447
 
                copy_all(from_store, to_store)
448
 
        except UnlistableStore:
449
 
            raise UnlistableBranch(from_store)
450
 
 
451
 
    def __init__(self, transport, init=False,
452
 
                 relax_version_check=False):
453
 
        """Create new branch object at a particular location.
454
 
 
455
 
        transport -- A Transport object, defining how to access files.
456
 
        
457
 
        init -- If True, create new control files in a previously
458
 
             unversioned directory.  If False, the branch must already
459
 
             be versioned.
460
 
 
461
 
        relax_version_check -- If true, the usual check for the branch
462
 
            version is not applied.  This is intended only for
463
 
            upgrade/recovery type use; it's not guaranteed that
464
 
            all operations will work on old format branches.
465
 
 
466
 
        In the test suite, creation of new trees is tested using the
467
 
        `ScratchBranch` class.
468
 
        """
469
 
        assert isinstance(transport, Transport), \
470
 
            "%r is not a Transport" % transport
471
 
        # TODO: jam 20060103 We create a clone of this transport at .bzr/
472
 
        #       and then we forget about it, should we keep a handle to it?
473
 
        self._base = transport.base
474
 
        self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR),
475
 
                                           'branch-lock')
476
 
        if init:
477
 
            self._make_control()
478
 
        self._check_format(relax_version_check)
479
 
        self.repository = Repository(transport, self._branch_format)
480
 
 
481
 
    def __str__(self):
482
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
483
 
 
484
 
    __repr__ = __str__
485
 
 
486
 
    def __del__(self):
487
 
        # TODO: It might be best to do this somewhere else,
488
 
        # but it is nice for a Branch object to automatically
489
 
        # cache it's information.
490
 
        # Alternatively, we could have the Transport objects cache requests
491
 
        # See the earlier discussion about how major objects (like Branch)
492
 
        # should never expect their __del__ function to run.
493
 
        if hasattr(self, 'cache_root') and self.cache_root is not None:
494
 
            try:
495
 
                shutil.rmtree(self.cache_root)
496
 
            except:
497
 
                pass
498
 
            self.cache_root = None
499
 
 
500
 
    def _get_base(self):
501
 
        return self._base
502
 
 
503
 
    base = property(_get_base, doc="The URL for the root of this branch.")
504
 
 
505
 
    def _finish_transaction(self):
506
 
        """Exit the current transaction."""
507
 
        return self.control_files._finish_transaction()
508
 
 
509
 
    def get_transaction(self):
510
 
        """Return the current active transaction.
511
 
 
512
 
        If no transaction is active, this returns a passthrough object
513
 
        for which all data is immediately flushed and no caching happens.
514
 
        """
515
 
        # this is an explicit function so that we can do tricky stuff
516
 
        # when the storage in rev_storage is elsewhere.
517
 
        # we probably need to hook the two 'lock a location' and 
518
 
        # 'have a transaction' together more delicately, so that
519
 
        # we can have two locks (branch and storage) and one transaction
520
 
        # ... and finishing the transaction unlocks both, but unlocking
521
 
        # does not. - RBC 20051121
522
 
        return self.control_files.get_transaction()
523
 
 
524
 
    def _set_transaction(self, transaction):
525
 
        """Set a new active transaction."""
526
 
        return self.control_files._set_transaction(transaction)
527
 
 
528
 
    def abspath(self, name):
529
 
        """See Branch.abspath."""
530
 
        return self.control_files._transport.abspath(name)
531
 
 
532
 
    def _make_control(self):
533
 
        from bzrlib.inventory import Inventory
534
 
        from bzrlib.weavefile import write_weave_v5
535
 
        from bzrlib.weave import Weave
536
 
        
537
 
        # Create an empty inventory
538
 
        sio = StringIO()
539
 
        # if we want per-tree root ids then this is the place to set
540
 
        # them; they're not needed for now and so ommitted for
541
 
        # simplicity.
542
 
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
543
 
        empty_inv = sio.getvalue()
544
 
        sio = StringIO()
545
 
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
546
 
        empty_weave = sio.getvalue()
547
 
 
548
 
        dirs = ['', 'revision-store', 'weaves']
549
 
        files = [('README', 
550
 
            "This is a Bazaar-NG control directory.\n"
551
 
            "Do not change any files in this directory.\n"),
552
 
            ('branch-format', BZR_BRANCH_FORMAT_6),
553
 
            ('revision-history', ''),
554
 
            ('branch-name', ''),
555
 
            ('branch-lock', ''),
556
 
            ('pending-merges', ''),
557
 
            ('inventory', empty_inv),
558
 
            ('inventory.weave', empty_weave),
559
 
            ('ancestry.weave', empty_weave)
560
 
        ]
561
 
        cfe = self.control_files._escape
562
 
        self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
563
 
                mode=self.control_files._dir_mode)
564
 
        self.control_files.lock_write()
565
 
        try:
566
 
            for file, content in files:
567
 
                self.control_files.put_utf8(file, content)
568
 
            mutter('created control directory in ' + self.base)
569
 
        finally:
570
 
            self.control_files.unlock()
571
 
 
572
 
    def _check_format(self, relax_version_check):
573
 
        """Check this branch format is supported.
574
 
 
575
 
        The format level is stored, as an integer, in
576
 
        self._branch_format for code that needs to check it later.
577
 
 
578
 
        In the future, we might need different in-memory Branch
579
 
        classes to support downlevel branches.  But not yet.
580
 
        """
581
 
        try:
582
 
            fmt = self.control_files.controlfile('branch-format', 'r').read()
583
 
        except NoSuchFile:
584
 
            raise NotBranchError(path=self.base)
585
 
        mutter("got branch format %r", fmt)
586
 
        if fmt == BZR_BRANCH_FORMAT_6:
587
 
            self._branch_format = 6
588
 
        elif fmt == BZR_BRANCH_FORMAT_5:
589
 
            self._branch_format = 5
590
 
        elif fmt == BZR_BRANCH_FORMAT_4:
591
 
            self._branch_format = 4
592
 
 
593
 
        if (not relax_version_check
594
 
            and self._branch_format not in (5, 6)):
595
 
            raise errors.UnsupportedFormatError(
596
 
                           'sorry, branch format %r not supported' % fmt,
597
 
                           ['use a different bzr version',
598
 
                            'or remove the .bzr directory'
599
 
                            ' and "bzr init" again'])
600
 
 
601
 
    @needs_read_lock
602
 
    def get_root_id(self):
603
 
        """See Branch.get_root_id."""
604
 
        inv = self.repository.get_inventory(self.last_revision())
605
 
        return inv.root.file_id
606
 
 
607
 
    def lock_write(self):
608
 
        # TODO: test for failed two phase locks. This is known broken.
609
 
        self.control_files.lock_write()
610
 
        self.repository.lock_write()
611
 
 
612
 
    def lock_read(self):
613
 
        # TODO: test for failed two phase locks. This is known broken.
614
 
        self.control_files.lock_read()
615
 
        self.repository.lock_read()
616
 
 
617
 
    def unlock(self):
618
 
        # TODO: test for failed two phase locks. This is known broken.
619
 
        self.repository.unlock()
620
 
        self.control_files.unlock()
621
 
 
622
 
    @needs_read_lock
623
 
    def print_file(self, file, revision_id):
624
 
        """See Branch.print_file."""
625
 
        return self.repository.print_file(file, revision_id)
626
 
 
627
 
    @needs_write_lock
628
 
    def append_revision(self, *revision_ids):
629
 
        """See Branch.append_revision."""
630
 
        for revision_id in revision_ids:
631
 
            mutter("add {%s} to revision-history" % revision_id)
632
 
        rev_history = self.revision_history()
633
 
        rev_history.extend(revision_ids)
634
 
        self.set_revision_history(rev_history)
635
 
 
636
 
    @needs_write_lock
637
 
    def set_revision_history(self, rev_history):
638
 
        """See Branch.set_revision_history."""
639
 
        old_revision = self.last_revision()
640
 
        new_revision = rev_history[-1]
641
 
        self.control_files.put_utf8(
642
 
            'revision-history', '\n'.join(rev_history))
643
 
        try:
644
 
            # FIXME: RBC 20051207 this smells wrong, last_revision in the 
645
 
            # working tree may be != to last_revision in the branch - so
646
 
            # why is this passing in the branches last_revision ?
647
 
            self.working_tree().set_last_revision(new_revision, old_revision)
648
 
        except NoWorkingTree:
649
 
            mutter('Unable to set_last_revision without a working tree.')
650
 
 
651
 
    def get_revision_delta(self, revno):
652
 
        """Return the delta for one revision.
653
 
 
654
 
        The delta is relative to its mainline predecessor, or the
655
 
        empty tree for revision 1.
656
 
        """
657
 
        assert isinstance(revno, int)
658
 
        rh = self.revision_history()
659
 
        if not (1 <= revno <= len(rh)):
660
 
            raise InvalidRevisionNumber(revno)
661
 
 
662
 
        # revno is 1-based; list is 0-based
663
 
 
664
 
        new_tree = self.repository.revision_tree(rh[revno-1])
665
 
        if revno == 1:
666
 
            old_tree = EmptyTree()
667
 
        else:
668
 
            old_tree = self.repository.revision_tree(rh[revno-2])
669
 
        return compare_trees(old_tree, new_tree)
670
 
 
671
 
    @needs_read_lock
672
 
    def revision_history(self):
673
 
        """See Branch.revision_history."""
674
 
        # FIXME are transactions bound to control files ? RBC 20051121
675
 
        transaction = self.get_transaction()
676
 
        history = transaction.map.find_revision_history()
677
 
        if history is not None:
678
 
            mutter("cache hit for revision-history in %s", self)
679
 
            return list(history)
680
 
        history = [l.rstrip('\r\n') for l in
681
 
                self.control_files.controlfile('revision-history', 'r').readlines()]
682
 
        transaction.map.add_revision_history(history)
683
 
        # this call is disabled because revision_history is 
684
 
        # not really an object yet, and the transaction is for objects.
685
 
        # transaction.register_clean(history, precious=True)
686
 
        return list(history)
687
 
 
688
 
    def update_revisions(self, other, stop_revision=None):
689
 
        """See Branch.update_revisions."""
690
 
        from bzrlib.fetch import greedy_fetch
691
 
        if stop_revision is None:
692
 
            stop_revision = other.last_revision()
693
 
        ### Should this be checking is_ancestor instead of revision_history?
694
 
        if (stop_revision is not None and 
695
 
            stop_revision in self.revision_history()):
696
 
            return
697
 
        greedy_fetch(to_branch=self, from_branch=other,
698
 
                     revision=stop_revision)
699
 
        pullable_revs = self.pullable_revisions(other, stop_revision)
700
 
        if len(pullable_revs) > 0:
701
 
            self.append_revision(*pullable_revs)
702
 
 
703
 
    def pullable_revisions(self, other, stop_revision):
704
 
        """See Branch.pullable_revisions."""
705
 
        other_revno = other.revision_id_to_revno(stop_revision)
706
 
        try:
707
 
            return self.missing_revisions(other, other_revno)
708
 
        except DivergedBranches, e:
709
 
            try:
710
 
                pullable_revs = get_intervening_revisions(self.last_revision(),
711
 
                                                          stop_revision, 
712
 
                                                          self.repository)
713
 
                assert self.last_revision() not in pullable_revs
714
 
                return pullable_revs
715
 
            except bzrlib.errors.NotAncestor:
716
 
                if is_ancestor(self.last_revision(), stop_revision, self):
717
 
                    return []
718
 
                else:
719
 
                    raise e
720
 
        
721
 
    def basis_tree(self):
722
 
        """See Branch.basis_tree."""
723
 
        try:
724
 
            revision_id = self.revision_history()[-1]
725
 
            # FIXME: This is an abstraction violation, the basis tree 
726
 
            # here as defined is on the working tree, the method should
727
 
            # be too. The basis tree for a branch can be different than
728
 
            # that for a working tree. RBC 20051207
729
 
            xml = self.working_tree().read_basis_inventory(revision_id)
730
 
            inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
731
 
            return RevisionTree(self.repository, inv, revision_id)
732
 
        except (IndexError, NoSuchFile, NoWorkingTree), e:
733
 
            return self.repository.revision_tree(self.last_revision())
734
 
 
735
 
    def working_tree(self):
736
 
        """See Branch.working_tree."""
737
 
        from bzrlib.workingtree import WorkingTree
738
 
        if self.base.find('://') != -1:
739
 
            raise NoWorkingTree(self.base)
740
 
        return WorkingTree(self.base, branch=self)
741
 
 
742
 
    @needs_write_lock
743
 
    def pull(self, source, overwrite=False):
744
 
        """See Branch.pull."""
745
 
        source.lock_read()
746
 
        try:
747
 
            old_count = len(self.revision_history())
748
 
            try:
749
 
                self.update_revisions(source)
750
 
            except DivergedBranches:
751
 
                if not overwrite:
752
 
                    raise
753
 
            if overwrite:
754
 
                self.set_revision_history(source.revision_history())
755
 
            new_count = len(self.revision_history())
756
 
            return new_count - old_count
757
 
        finally:
758
 
            source.unlock()
759
 
 
760
 
    def get_parent(self):
761
 
        """See Branch.get_parent."""
762
 
        import errno
763
 
        _locs = ['parent', 'pull', 'x-pull']
764
 
        for l in _locs:
765
 
            try:
766
 
                return self.control_files.controlfile(l, 'r').read().strip('\n')
767
 
            except NoSuchFile:
768
 
                pass
769
 
        return None
770
 
 
771
 
    def get_push_location(self):
772
 
        """See Branch.get_push_location."""
773
 
        config = bzrlib.config.BranchConfig(self)
774
 
        push_loc = config.get_user_option('push_location')
775
 
        return push_loc
776
 
 
777
 
    def set_push_location(self, location):
778
 
        """See Branch.set_push_location."""
779
 
        config = bzrlib.config.LocationConfig(self.base)
780
 
        config.set_user_option('push_location', location)
781
 
 
782
 
    @needs_write_lock
783
 
    def set_parent(self, url):
784
 
        """See Branch.set_parent."""
785
 
        # TODO: Maybe delete old location files?
786
 
        from bzrlib.atomicfile import AtomicFile
787
 
        f = AtomicFile(self.control_files.controlfilename('parent'))
788
 
        try:
789
 
            f.write(url + '\n')
790
 
            f.commit()
791
 
        finally:
792
 
            f.close()
793
 
 
794
 
    def tree_config(self):
795
 
        return TreeConfig(self)
796
 
 
797
 
    def _get_truncated_history(self, revision_id):
798
 
        history = self.revision_history()
799
 
        if revision_id is None:
800
 
            return history
801
 
        try:
802
 
            idx = history.index(revision_id)
803
 
        except ValueError:
804
 
            raise InvalidRevisionId(revision_id=revision, branch=self)
805
 
        return history[:idx+1]
806
 
 
807
 
    @needs_read_lock
808
 
    def _clone_weave(self, to_location, revision=None, basis_branch=None):
809
 
        assert isinstance(to_location, basestring)
810
 
        if basis_branch is not None:
811
 
            note("basis_branch is not supported for fast weave copy yet.")
812
 
 
813
 
        history = self._get_truncated_history(revision)
814
 
        if not bzrlib.osutils.lexists(to_location):
815
 
            os.mkdir(to_location)
816
 
        branch_to = Branch.initialize(to_location)
817
 
        mutter("copy branch from %s to %s", self, branch_to)
818
 
        branch_to.working_tree().set_root_id(self.get_root_id())
819
 
 
820
 
        self.repository.copy(branch_to.repository)
821
 
        
822
 
        # must be done *after* history is copied across
823
 
        # FIXME duplicate code with base .clone().
824
 
        # .. would template method be useful here.  RBC 20051207
825
 
        branch_to.set_parent(self.base)
826
 
        branch_to.append_revision(*history)
827
 
        # circular import protection
828
 
        from bzrlib.merge import build_working_dir
829
 
        build_working_dir(to_location)
830
 
        mutter("copied")
831
 
        return branch_to
832
 
 
833
 
    def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
834
 
        if to_branch_type is None:
835
 
            to_branch_type = BzrBranch
836
 
 
837
 
        if to_branch_type == BzrBranch \
838
 
            and self.repository.weave_store.listable() \
839
 
            and self.repository.revision_store.listable():
840
 
            return self._clone_weave(to_location, revision, basis_branch)
841
 
 
842
 
        return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
843
 
 
844
 
 
845
 
class ScratchBranch(BzrBranch):
 
857
        """
 
858
        self._need_writelock()
 
859
        ## TODO: Option to move IDs only
 
860
        assert not isinstance(from_paths, basestring)
 
861
        tree = self.working_tree()
 
862
        inv = tree.inventory
 
863
        to_abs = self.abspath(to_name)
 
864
        if not isdir(to_abs):
 
865
            bailout("destination %r is not a directory" % to_abs)
 
866
        if not tree.has_filename(to_name):
 
867
            bailout("destination %r not in working directory" % to_abs)
 
868
        to_dir_id = inv.path2id(to_name)
 
869
        if to_dir_id == None and to_name != '':
 
870
            bailout("destination %r is not a versioned directory" % to_name)
 
871
        to_dir_ie = inv[to_dir_id]
 
872
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
873
            bailout("destination %r is not a directory" % to_abs)
 
874
 
 
875
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
876
 
 
877
        for f in from_paths:
 
878
            if not tree.has_filename(f):
 
879
                bailout("%r does not exist in working tree" % f)
 
880
            f_id = inv.path2id(f)
 
881
            if f_id == None:
 
882
                bailout("%r is not versioned" % f)
 
883
            name_tail = splitpath(f)[-1]
 
884
            dest_path = appendpath(to_name, name_tail)
 
885
            if tree.has_filename(dest_path):
 
886
                bailout("destination %r already exists" % dest_path)
 
887
            if f_id in to_idpath:
 
888
                bailout("can't move %r to a subdirectory of itself" % f)
 
889
 
 
890
        # OK, so there's a race here, it's possible that someone will
 
891
        # create a file in this interval and then the rename might be
 
892
        # left half-done.  But we should have caught most problems.
 
893
 
 
894
        for f in from_paths:
 
895
            name_tail = splitpath(f)[-1]
 
896
            dest_path = appendpath(to_name, name_tail)
 
897
            print "%s => %s" % (f, dest_path)
 
898
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
899
            try:
 
900
                os.rename(self.abspath(f), self.abspath(dest_path))
 
901
            except OSError, e:
 
902
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
903
                        ["rename rolled back"])
 
904
 
 
905
        self._write_inventory(inv)
 
906
 
 
907
 
 
908
 
 
909
    def show_status(self, show_all=False):
 
910
        """Display single-line status for non-ignored working files.
 
911
 
 
912
        The list is show sorted in order by file name.
 
913
 
 
914
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
915
        >>> b.show_status()
 
916
        ?       foo
 
917
        >>> b.add('foo')
 
918
        >>> b.show_status()
 
919
        A       foo
 
920
        >>> b.commit("add foo")
 
921
        >>> b.show_status()
 
922
        >>> os.unlink(b.abspath('foo'))
 
923
        >>> b.show_status()
 
924
        D       foo
 
925
        
 
926
        TODO: Get state for single files.
 
927
        """
 
928
        self._need_readlock()
 
929
 
 
930
        # We have to build everything into a list first so that it can
 
931
        # sorted by name, incorporating all the different sources.
 
932
 
 
933
        # FIXME: Rather than getting things in random order and then sorting,
 
934
        # just step through in order.
 
935
 
 
936
        # Interesting case: the old ID for a file has been removed,
 
937
        # but a new file has been created under that name.
 
938
 
 
939
        old = self.basis_tree()
 
940
        new = self.working_tree()
 
941
 
 
942
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
943
            if fs == 'R':
 
944
                show_status(fs, kind,
 
945
                            oldname + ' => ' + newname)
 
946
            elif fs == 'A' or fs == 'M':
 
947
                show_status(fs, kind, newname)
 
948
            elif fs == 'D':
 
949
                show_status(fs, kind, oldname)
 
950
            elif fs == '.':
 
951
                if show_all:
 
952
                    show_status(fs, kind, newname)
 
953
            elif fs == 'I':
 
954
                if show_all:
 
955
                    show_status(fs, kind, newname)
 
956
            elif fs == '?':
 
957
                show_status(fs, kind, newname)
 
958
            else:
 
959
                bailout("weird file state %r" % ((fs, fid),))
 
960
                
 
961
 
 
962
 
 
963
class ScratchBranch(Branch):
846
964
    """Special test class: a branch that cleans up after itself.
847
965
 
848
966
    >>> b = ScratchBranch()
849
967
    >>> isdir(b.base)
850
968
    True
851
969
    >>> bd = b.base
852
 
    >>> b._transport.__del__()
 
970
    >>> del b
853
971
    >>> isdir(bd)
854
972
    False
855
973
    """
856
 
 
857
 
    def __init__(self, files=[], dirs=[], transport=None):
 
974
    def __init__(self, files=[], dirs=[]):
858
975
        """Make a test branch.
859
976
 
860
977
        This creates a temporary directory and runs init-tree in it.
861
978
 
862
979
        If any files are listed, they are created in the working copy.
863
980
        """
864
 
        if transport is None:
865
 
            transport = bzrlib.transport.local.ScratchTransport()
866
 
            super(ScratchBranch, self).__init__(transport, init=True)
867
 
        else:
868
 
            super(ScratchBranch, self).__init__(transport)
869
 
 
870
 
        # BzrBranch creates a clone to .bzr and then forgets about the
871
 
        # original transport. A ScratchTransport() deletes itself and
872
 
        # everything underneath it when it goes away, so we need to
873
 
        # grab a local copy to prevent that from happening
874
 
        self._transport = transport
875
 
 
 
981
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
876
982
        for d in dirs:
877
 
            self._transport.mkdir(d)
 
983
            os.mkdir(self.abspath(d))
878
984
            
879
985
        for f in files:
880
 
            self._transport.put(f, 'content of %s' % f)
881
 
 
882
 
    def clone(self):
883
 
        """
884
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
885
 
        >>> os.listdir(orig.base)
886
 
        [u'.bzr', u'file1', u'file2']
887
 
        >>> clone = orig.clone()
888
 
        >>> if os.name != 'nt':
889
 
        ...   os.path.samefile(orig.base, clone.base)
890
 
        ... else:
891
 
        ...   orig.base == clone.base
892
 
        ...
893
 
        False
894
 
        >>> os.listdir(clone.base)
895
 
        [u'.bzr', u'file1', u'file2']
896
 
        """
897
 
        from shutil import copytree
898
 
        from bzrlib.osutils import mkdtemp
899
 
        base = mkdtemp()
900
 
        os.rmdir(base)
901
 
        copytree(self.base, base, symlinks=True)
902
 
        return ScratchBranch(
903
 
            transport=bzrlib.transport.local.ScratchTransport(base))
 
986
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
987
 
 
988
 
 
989
    def __del__(self):
 
990
        """Destroy the test branch, removing the scratch directory."""
 
991
        try:
 
992
            shutil.rmtree(self.base)
 
993
        except OSError:
 
994
            # Work around for shutil.rmtree failing on Windows when
 
995
            # readonly files are encountered
 
996
            for root, dirs, files in os.walk(self.base, topdown=False):
 
997
                for name in files:
 
998
                    os.chmod(os.path.join(root, name), 0700)
 
999
            shutil.rmtree(self.base)
 
1000
 
904
1001
    
905
1002
 
906
1003
######################################################################
909
1006
 
910
1007
def is_control_file(filename):
911
1008
    ## FIXME: better check
912
 
    filename = normpath(filename)
 
1009
    filename = os.path.normpath(filename)
913
1010
    while filename != '':
914
1011
        head, tail = os.path.split(filename)
915
1012
        ## mutter('check %r for control file' % ((head, tail), ))
919
1016
            break
920
1017
        filename = head
921
1018
    return False
 
1019
 
 
1020
 
 
1021
 
 
1022
def _gen_revision_id(when):
 
1023
    """Return new revision-id."""
 
1024
    s = '%s-%s-' % (user_email(), compact_date(when))
 
1025
    s += hexlify(rand_bytes(8))
 
1026
    return s
 
1027
 
 
1028
 
 
1029
def gen_file_id(name):
 
1030
    """Return new file id.
 
1031
 
 
1032
    This should probably generate proper UUIDs, but for the moment we
 
1033
    cope with just randomness because running uuidgen every time is
 
1034
    slow."""
 
1035
    idx = name.rfind('/')
 
1036
    if idx != -1:
 
1037
        name = name[idx+1 : ]
 
1038
    idx = name.rfind('\\')
 
1039
    if idx != -1:
 
1040
        name = name[idx+1 : ]
 
1041
 
 
1042
    name = name.lstrip('.')
 
1043
 
 
1044
    s = hexlify(rand_bytes(8))
 
1045
    return '-'.join((name, compact_date(time.time()), s))