~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import sys
19
 
import os
 
18
from sets import Set
 
19
 
 
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
21
import traceback, socket, fnmatch, difflib, time
 
22
from binascii import hexlify
20
23
 
21
24
import bzrlib
22
 
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
 
27
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
 
     DivergedBranches, NotBranchError
29
 
from bzrlib.textui import show_status
30
 
from bzrlib.revision import Revision
31
 
from bzrlib.delta import compare_trees
32
 
from bzrlib.tree import EmptyTree, RevisionTree
33
 
import bzrlib.xml
34
 
import bzrlib.ui
35
 
 
36
 
 
 
25
from inventory import Inventory
 
26
from trace import mutter, note
 
27
from tree import Tree, EmptyTree, RevisionTree
 
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
37
36
 
38
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
38
## TODO: Maybe include checks for common corruption of newlines, etc?
40
39
 
41
40
 
42
 
# TODO: Some operations like log might retrieve the same revisions
43
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
44
 
# cache in memory to make this faster.
45
 
 
46
 
# TODO: please move the revision-string syntax stuff out of the branch
47
 
# object; it's clutter
48
 
 
49
41
 
50
42
def find_branch(f, **args):
51
 
    from bzrlib.transport import transport
52
 
    from bzrlib.local_transport import LocalTransport
53
 
    t = transport(f)
54
 
    # FIXME: This is a hack around transport so that
55
 
    #        We can search the local directories for
56
 
    #        a branch root.
57
 
    if args.has_key('init') and args['init']:
58
 
        # Don't search if we are init-ing
59
 
        return Branch(t, **args)
60
 
    if isinstance(t, LocalTransport):
61
 
        root = find_branch_root(f)
62
 
        if root != f:
63
 
            t = transport(root)
64
 
    return Branch(t, **args)
65
 
 
66
 
def _relpath(base, path):
67
 
    """Return path relative to base, or raise exception.
68
 
 
69
 
    The path may be either an absolute path or a path relative to the
70
 
    current working directory.
71
 
 
72
 
    Lifted out of Branch.relpath for ease of testing.
73
 
 
74
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
75
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
76
 
    avoids that problem."""
77
 
    rp = os.path.abspath(path)
78
 
 
79
 
    s = []
80
 
    head = rp
81
 
    while len(head) >= len(base):
82
 
        if head == base:
83
 
            break
84
 
        head, tail = os.path.split(head)
85
 
        if tail:
86
 
            s.insert(0, tail)
 
43
    if f and (f.startswith('http://') or f.startswith('https://')):
 
44
        import remotebranch 
 
45
        return remotebranch.RemoteBranch(f, **args)
87
46
    else:
88
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
89
 
 
90
 
    return os.sep.join(s)
 
47
        return Branch(f, **args)
91
48
        
92
49
 
93
50
def find_branch_root(f=None):
98
55
    It is not necessary that f exists.
99
56
 
100
57
    Basically we keep looking up until we find the control directory or
101
 
    run into the root.  If there isn't one, raises NotBranchError.
102
 
    """
 
58
    run into the root."""
103
59
    if f == None:
104
60
        f = os.getcwd()
105
 
    else:
 
61
    elif hasattr(os.path, 'realpath'):
106
62
        f = os.path.realpath(f)
 
63
    else:
 
64
        f = os.path.abspath(f)
107
65
    if not os.path.exists(f):
108
66
        raise BzrError('%r does not exist' % f)
109
67
        
116
74
        head, tail = os.path.split(f)
117
75
        if head == f:
118
76
            # reached the root, whatever that may be
119
 
            raise NotBranchError('%s is not in a branch' % orig_f)
 
77
            raise BzrError('%r is not in a branch' % orig_f)
120
78
        f = head
121
 
 
122
 
 
 
79
    
123
80
 
124
81
 
125
82
######################################################################
126
83
# branch objects
127
84
 
128
 
class Branch(object):
 
85
class Branch:
129
86
    """Branch holding a history of revisions.
130
87
 
131
88
    base
132
89
        Base directory of the branch.
133
 
 
134
 
    _lock_mode
135
 
        None, or 'r' or 'w'
136
 
 
137
 
    _lock_count
138
 
        If _lock_mode is true, a positive count of the number of times the
139
 
        lock has been taken.
140
 
 
141
 
    _lock
142
 
        Lock object from bzrlib.lock.
143
90
    """
144
 
    base = None
145
 
    _lock_mode = None
146
 
    _lock_count = None
147
 
    _lock = None
148
 
    cache_root = None
 
91
    _lockmode = None
149
92
    
150
 
    # Map some sort of prefix into a namespace
151
 
    # stuff like "revno:10", "revid:", etc.
152
 
    # This should match a prefix with a function which accepts
153
 
    REVISION_NAMESPACES = {}
154
 
 
155
 
    def __init__(self, transport, init=False):
 
93
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
156
94
        """Create new branch object at a particular location.
157
95
 
158
 
        transport -- A Transport object, defining how to access files.
159
 
                (If a string, transport.transport() will be used to
160
 
                create a Transport object)
 
96
        base -- Base directory for the branch.
161
97
        
162
98
        init -- If True, create new control files in a previously
163
99
             unversioned directory.  If False, the branch must already
164
100
             be versioned.
165
101
 
 
102
        find_root -- If true and init is false, find the root of the
 
103
             existing branch containing base.
 
104
 
166
105
        In the test suite, creation of new trees is tested using the
167
106
        `ScratchBranch` class.
168
107
        """
169
 
        if isinstance(transport, basestring):
170
 
            from transport import transport as get_transport
171
 
            transport = get_transport(transport)
172
 
 
173
 
        self._transport = transport
174
108
        if init:
 
109
            self.base = os.path.realpath(base)
175
110
            self._make_control()
 
111
        elif find_root:
 
112
            self.base = find_branch_root(base)
 
113
        else:
 
114
            self.base = os.path.realpath(base)
 
115
            if not isdir(self.controlfilename('.')):
 
116
                bailout("not a bzr branch: %s" % quotefn(base),
 
117
                        ['use "bzr init" to initialize a new working tree',
 
118
                         'current bzr can only operate from top-of-tree'])
176
119
        self._check_format()
 
120
        self.lock(lock_mode)
 
121
 
 
122
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
123
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
124
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
177
125
 
178
126
 
179
127
    def __str__(self):
180
 
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
 
128
        return '%s(%r)' % (self.__class__.__name__, self.base)
181
129
 
182
130
 
183
131
    __repr__ = __str__
184
132
 
185
133
 
186
 
    def __del__(self):
187
 
        if self._lock_mode or self._lock:
188
 
            from bzrlib.warnings import warn
189
 
            warn("branch %r was not explicitly unlocked" % self)
190
 
            self._lock.unlock()
191
 
 
192
 
        # TODO: It might be best to do this somewhere else,
193
 
        # but it is nice for a Branch object to automatically
194
 
        # cache it's information.
195
 
        # Alternatively, we could have the Transport objects cache requests
196
 
        # See the earlier discussion about how major objects (like Branch)
197
 
        # should never expect their __del__ function to run.
198
 
        if self.cache_root is not None:
199
 
            #from warnings import warn
200
 
            #warn("branch %r auto-cleanup of cache files" % self)
 
134
 
 
135
    def lock(self, mode='w'):
 
136
        """Lock the on-disk branch, excluding other processes."""
 
137
        try:
 
138
            import fcntl, errno
 
139
 
 
140
            if mode == 'w':
 
141
                lm = fcntl.LOCK_EX
 
142
                om = os.O_WRONLY | os.O_CREAT
 
143
            elif mode == 'r':
 
144
                lm = fcntl.LOCK_SH
 
145
                om = os.O_RDONLY
 
146
            else:
 
147
                raise BzrError("invalid locking mode %r" % mode)
 
148
 
201
149
            try:
202
 
                import shutil
203
 
                shutil.rmtree(self.cache_root)
204
 
            except:
205
 
                pass
206
 
            self.cache_root = None
207
 
 
208
 
    def _get_base(self):
209
 
        if self._transport:
210
 
            return self._transport.base
211
 
        return None
212
 
 
213
 
    base = property(_get_base)
214
 
 
215
 
 
216
 
    def lock_write(self):
217
 
        # TODO: Upgrade locking to support using a Transport,
218
 
        # and potentially a remote locking protocol
219
 
        if self._lock_mode:
220
 
            if self._lock_mode != 'w':
221
 
                from bzrlib.errors import LockError
222
 
                raise LockError("can't upgrade to a write lock from %r" %
223
 
                                self._lock_mode)
224
 
            self._lock_count += 1
225
 
        else:
226
 
            self._lock = self._transport.lock_write(
227
 
                    self._rel_controlfilename('branch-lock'))
228
 
            self._lock_mode = 'w'
229
 
            self._lock_count = 1
230
 
 
231
 
 
232
 
    def lock_read(self):
233
 
        if self._lock_mode:
234
 
            assert self._lock_mode in ('r', 'w'), \
235
 
                   "invalid lock mode %r" % self._lock_mode
236
 
            self._lock_count += 1
237
 
        else:
238
 
            self._lock = self._transport.lock_read(
239
 
                    self._rel_controlfilename('branch-lock'))
240
 
            self._lock_mode = 'r'
241
 
            self._lock_count = 1
242
 
                        
243
 
    def unlock(self):
244
 
        if not self._lock_mode:
245
 
            from bzrlib.errors import LockError
246
 
            raise LockError('branch %r is not locked' % (self))
247
 
 
248
 
        if self._lock_count > 1:
249
 
            self._lock_count -= 1
250
 
        else:
251
 
            self._lock.unlock()
252
 
            self._lock = None
253
 
            self._lock_mode = self._lock_count = None
 
150
                lockfile = os.open(self.controlfilename('branch-lock'), om)
 
151
            except OSError, e:
 
152
                if e.errno == errno.ENOENT:
 
153
                    # might not exist on branches from <0.0.4
 
154
                    self.controlfile('branch-lock', 'w').close()
 
155
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
 
156
                else:
 
157
                    raise e
 
158
            
 
159
            fcntl.lockf(lockfile, lm)
 
160
            def unlock():
 
161
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
162
                os.close(lockfile)
 
163
                self._lockmode = None
 
164
            self.unlock = unlock
 
165
            self._lockmode = mode
 
166
        except ImportError:
 
167
            warning("please write a locking method for platform %r" % sys.platform)
 
168
            def unlock():
 
169
                self._lockmode = None
 
170
            self.unlock = unlock
 
171
            self._lockmode = mode
 
172
 
 
173
 
 
174
    def _need_readlock(self):
 
175
        if self._lockmode not in ['r', 'w']:
 
176
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
177
 
 
178
    def _need_writelock(self):
 
179
        if self._lockmode not in ['w']:
 
180
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
181
 
254
182
 
255
183
    def abspath(self, name):
256
184
        """Return absolute filename for something in the branch"""
257
 
        return self._transport.abspath(name)
 
185
        return os.path.join(self.base, name)
 
186
 
258
187
 
259
188
    def relpath(self, path):
260
189
        """Return path relative to this branch of something inside it.
261
190
 
262
191
        Raises an error if path is not in this branch."""
263
 
        return self._transport.relpath(path)
264
 
 
265
 
 
266
 
    def _rel_controlfilename(self, file_or_path):
267
 
        if isinstance(file_or_path, basestring):
268
 
            file_or_path = [file_or_path]
269
 
        return [bzrlib.BZRDIR] + file_or_path
 
192
        rp = os.path.realpath(path)
 
193
        # FIXME: windows
 
194
        if not rp.startswith(self.base):
 
195
            bailout("path %r is not within branch %r" % (rp, self.base))
 
196
        rp = rp[len(self.base):]
 
197
        rp = rp.lstrip(os.sep)
 
198
        return rp
 
199
 
270
200
 
271
201
    def controlfilename(self, file_or_path):
272
202
        """Return location relative to branch."""
273
 
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
 
203
        if isinstance(file_or_path, types.StringTypes):
 
204
            file_or_path = [file_or_path]
 
205
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
206
 
275
207
 
276
208
    def controlfile(self, file_or_path, mode='r'):
284
216
        Controlfiles should almost never be opened in write mode but
285
217
        rather should be atomically copied and replaced using atomicfile.
286
218
        """
287
 
        import codecs
288
 
 
289
 
        relpath = self._rel_controlfilename(file_or_path)
290
 
        #TODO: codecs.open() buffers linewise, so it was overloaded with
291
 
        # a much larger buffer, do we need to do the same for getreader/getwriter?
292
 
        if mode == 'rb': 
293
 
            return self._transport.get(relpath)
294
 
        elif mode == 'wb':
295
 
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
296
 
        elif mode == 'r':
297
 
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
298
 
        elif mode == 'w':
299
 
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
 
219
 
 
220
        fn = self.controlfilename(file_or_path)
 
221
 
 
222
        if mode == 'rb' or mode == 'wb':
 
223
            return file(fn, mode)
 
224
        elif mode == 'r' or mode == 'w':
 
225
            # open in binary mode anyhow so there's no newline translation;
 
226
            # codecs uses line buffering by default; don't want that.
 
227
            import codecs
 
228
            return codecs.open(fn, mode + 'b', 'utf-8',
 
229
                               buffering=60000)
300
230
        else:
301
231
            raise BzrError("invalid controlfile mode %r" % mode)
302
232
 
303
 
    def put_controlfile(self, path, f, encode=True):
304
 
        """Write an entry as a controlfile.
305
 
 
306
 
        :param path: The path to put the file, relative to the .bzr control
307
 
                     directory
308
 
        :param f: A file-like or string object whose contents should be copied.
309
 
        :param encode:  If true, encode the contents as utf-8
310
 
        """
311
 
        self.put_controlfiles([(path, f)], encode=encode)
312
 
 
313
 
    def put_controlfiles(self, files, encode=True):
314
 
        """Write several entries as controlfiles.
315
 
 
316
 
        :param files: A list of [(path, file)] pairs, where the path is the directory
317
 
                      underneath the bzr control directory
318
 
        :param encode:  If true, encode the contents as utf-8
319
 
        """
320
 
        import codecs
321
 
        ctrl_files = []
322
 
        for path, f in files:
323
 
            if encode:
324
 
                if isinstance(f, basestring):
325
 
                    f = f.encode('utf-8', 'replace')
326
 
                else:
327
 
                    f = codecs.getwriter('utf-8')(f, errors='replace')
328
 
            path = self._rel_controlfilename(path)
329
 
            ctrl_files.append((path, f))
330
 
        self._transport.put_multi(ctrl_files)
 
233
 
331
234
 
332
235
    def _make_control(self):
333
 
        from bzrlib.inventory import Inventory
334
 
        from cStringIO import StringIO
335
 
        
336
 
        # Create an empty inventory
337
 
        sio = StringIO()
338
 
        # if we want per-tree root ids then this is the place to set
339
 
        # them; they're not needed for now and so ommitted for
340
 
        # simplicity.
341
 
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), sio)
342
 
 
343
 
        dirs = [[], 'text-store', 'inventory-store', 'revision-store']
344
 
        files = [('README', 
 
236
        os.mkdir(self.controlfilename([]))
 
237
        self.controlfile('README', 'w').write(
345
238
            "This is a Bazaar-NG control directory.\n"
346
 
            "Do not change any files in this directory.\n"),
347
 
            ('branch-format', BZR_BRANCH_FORMAT),
348
 
            ('revision-history', ''),
349
 
            ('merged-patches', ''),
350
 
            ('pending-merged-patches', ''),
351
 
            ('branch-name', ''),
352
 
            ('branch-lock', ''),
353
 
            ('pending-merges', ''),
354
 
            ('inventory', sio.getvalue())
355
 
        ]
356
 
        self._transport.mkdir_multi([self._rel_controlfilename(d) for d in dirs])
357
 
        self.put_controlfiles(files)
358
 
        mutter('created control directory in ' + self._transport.base)
 
239
            "Do not change any files in this directory.")
 
240
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
241
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
242
            os.mkdir(self.controlfilename(d))
 
243
        for f in ('revision-history', 'merged-patches',
 
244
                  'pending-merged-patches', 'branch-name',
 
245
                  'branch-lock'):
 
246
            self.controlfile(f, 'w').write('')
 
247
        mutter('created control directory in ' + self.base)
 
248
        Inventory().write_xml(self.controlfile('inventory','w'))
 
249
 
359
250
 
360
251
    def _check_format(self):
361
252
        """Check this branch format is supported.
369
260
        # on Windows from Linux and so on.  I think it might be better
370
261
        # to always make all internal files in unix format.
371
262
        fmt = self.controlfile('branch-format', 'r').read()
372
 
        fmt = fmt.replace('\r\n', '\n')
 
263
        fmt.replace('\r\n', '')
373
264
        if fmt != BZR_BRANCH_FORMAT:
374
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
375
 
                           ['use a different bzr version',
376
 
                            'or remove the .bzr directory and "bzr init" again'])
377
 
 
378
 
        # We know that the format is the currently supported one.
379
 
        # So create the rest of the entries.
380
 
        from bzrlib.store.compressed_text import CompressedTextStore
381
 
 
382
 
        if self._transport.should_cache():
383
 
            import tempfile
384
 
            self.cache_root = tempfile.mkdtemp(prefix='bzr-cache')
385
 
            mutter('Branch %r using caching in %r' % (self, self.cache_root))
386
 
        else:
387
 
            self.cache_root = None
388
 
 
389
 
        def get_store(name):
390
 
            relpath = self._rel_controlfilename(name)
391
 
            store = CompressedTextStore(self._transport.clone(relpath))
392
 
            if self._transport.should_cache():
393
 
                from meta_store import CachedStore
394
 
                cache_path = os.path.join(self.cache_root, name)
395
 
                os.mkdir(cache_path)
396
 
                store = CachedStore(store, cache_path)
397
 
            return store
398
 
 
399
 
        self.text_store = get_store('text-store')
400
 
        self.revision_store = get_store('revision-store')
401
 
        self.inventory_store = get_store('inventory-store')
402
 
 
403
 
    def get_root_id(self):
404
 
        """Return the id of this branches root"""
405
 
        inv = self.read_working_inventory()
406
 
        return inv.root.file_id
407
 
 
408
 
    def set_root_id(self, file_id):
409
 
        inv = self.read_working_inventory()
410
 
        orig_root_id = inv.root.file_id
411
 
        del inv._byid[inv.root.file_id]
412
 
        inv.root.file_id = file_id
413
 
        inv._byid[inv.root.file_id] = inv.root
414
 
        for fid in inv:
415
 
            entry = inv[fid]
416
 
            if entry.parent_id in (None, orig_root_id):
417
 
                entry.parent_id = inv.root.file_id
418
 
        self._write_inventory(inv)
 
265
            bailout('sorry, branch format %r not supported' % fmt,
 
266
                    ['use a different bzr version',
 
267
                     'or remove the .bzr directory and "bzr init" again'])
 
268
 
419
269
 
420
270
    def read_working_inventory(self):
421
271
        """Read the working inventory."""
422
 
        from bzrlib.inventory import Inventory
423
 
        self.lock_read()
424
 
        try:
425
 
            # ElementTree does its own conversion from UTF-8, so open in
426
 
            # binary.
427
 
            f = self.controlfile('inventory', 'rb')
428
 
            return bzrlib.xml.serializer_v4.read_inventory(f)
429
 
        finally:
430
 
            self.unlock()
431
 
            
 
272
        self._need_readlock()
 
273
        before = time.time()
 
274
        # ElementTree does its own conversion from UTF-8, so open in
 
275
        # binary.
 
276
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
277
        mutter("loaded inventory of %d items in %f"
 
278
               % (len(inv), time.time() - before))
 
279
        return inv
 
280
 
432
281
 
433
282
    def _write_inventory(self, inv):
434
283
        """Update the working inventory.
436
285
        That is to say, the inventory describing changes underway, that
437
286
        will be committed to the next revision.
438
287
        """
439
 
        from cStringIO import StringIO
440
 
        self.lock_write()
441
 
        try:
442
 
            sio = StringIO()
443
 
            bzrlib.xml.serializer_v4.write_inventory(inv, sio)
444
 
            sio.seek(0)
445
 
            # Transport handles atomicity
446
 
            self.put_controlfile('inventory', sio)
447
 
        finally:
448
 
            self.unlock()
449
 
        
 
288
        self._need_writelock()
 
289
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
290
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
291
        tmpfname = self.controlfilename('inventory.tmp')
 
292
        tmpf = file(tmpfname, 'wb')
 
293
        inv.write_xml(tmpf)
 
294
        tmpf.close()
 
295
        inv_fname = self.controlfilename('inventory')
 
296
        if sys.platform == 'win32':
 
297
            os.remove(inv_fname)
 
298
        os.rename(tmpfname, inv_fname)
450
299
        mutter('wrote working inventory')
451
 
            
 
300
 
452
301
 
453
302
    inventory = property(read_working_inventory, _write_inventory, None,
454
303
                         """Inventory for the working copy.""")
455
304
 
456
305
 
457
 
    def add(self, files, ids=None):
 
306
    def add(self, files, verbose=False, ids=None):
458
307
        """Make files versioned.
459
308
 
460
 
        Note that the command line normally calls smart_add instead,
461
 
        which can automatically recurse.
 
309
        Note that the command line normally calls smart_add instead.
462
310
 
463
311
        This puts the files in the Added state, so that they will be
464
312
        recorded by the next commit.
465
313
 
466
 
        files
467
 
            List of paths to add, relative to the base of the tree.
468
 
 
469
 
        ids
470
 
            If set, use these instead of automatically generated ids.
471
 
            Must be the same length as the list of files, but may
472
 
            contain None for ids that are to be autogenerated.
473
 
 
474
314
        TODO: Perhaps have an option to add the ids even if the files do
475
 
              not (yet) exist.
476
 
 
477
 
        TODO: Perhaps yield the ids and paths as they're added.
 
315
               not (yet) exist.
 
316
 
 
317
        TODO: Perhaps return the ids of the files?  But then again it
 
318
               is easy to retrieve them if they're needed.
 
319
 
 
320
        TODO: Option to specify file id.
 
321
 
 
322
        TODO: Adding a directory should optionally recurse down and
 
323
               add all non-ignored children.  Perhaps do that in a
 
324
               higher-level method.
478
325
        """
 
326
        self._need_writelock()
 
327
 
479
328
        # TODO: Re-adding a file that is removed in the working copy
480
329
        # should probably put it back with the previous ID.
481
 
        if isinstance(files, basestring):
482
 
            assert(ids is None or isinstance(ids, basestring))
 
330
        if isinstance(files, types.StringTypes):
 
331
            assert(ids is None or isinstance(ids, types.StringTypes))
483
332
            files = [files]
484
333
            if ids is not None:
485
334
                ids = [ids]
488
337
            ids = [None] * len(files)
489
338
        else:
490
339
            assert(len(ids) == len(files))
491
 
 
492
 
        self.lock_write()
493
 
        try:
494
 
            inv = self.read_working_inventory()
495
 
            for f,file_id in zip(files, ids):
496
 
                if is_control_file(f):
497
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
498
 
 
499
 
                fp = splitpath(f)
500
 
 
501
 
                if len(fp) == 0:
502
 
                    raise BzrError("cannot add top-level %r" % f)
503
 
 
504
 
                fullpath = os.path.normpath(self.abspath(f))
505
 
 
506
 
                try:
507
 
                    kind = file_kind(fullpath)
508
 
                except OSError:
509
 
                    # maybe something better?
510
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
511
 
 
512
 
                if kind != 'file' and kind != 'directory':
513
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
514
 
 
515
 
                if file_id is None:
516
 
                    file_id = gen_file_id(f)
517
 
                inv.add_path(f, kind=kind, file_id=file_id)
518
 
 
519
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
520
 
 
521
 
            self._write_inventory(inv)
522
 
        finally:
523
 
            self.unlock()
524
 
            
 
340
        
 
341
        inv = self.read_working_inventory()
 
342
        for f,file_id in zip(files, ids):
 
343
            if is_control_file(f):
 
344
                bailout("cannot add control file %s" % quotefn(f))
 
345
 
 
346
            fp = splitpath(f)
 
347
 
 
348
            if len(fp) == 0:
 
349
                bailout("cannot add top-level %r" % f)
 
350
                
 
351
            fullpath = os.path.normpath(self.abspath(f))
 
352
 
 
353
            try:
 
354
                kind = file_kind(fullpath)
 
355
            except OSError:
 
356
                # maybe something better?
 
357
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
358
            
 
359
            if kind != 'file' and kind != 'directory':
 
360
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
361
 
 
362
            if file_id is None:
 
363
                file_id = gen_file_id(f)
 
364
            inv.add_path(f, kind=kind, file_id=file_id)
 
365
 
 
366
            if verbose:
 
367
                show_status('A', kind, quotefn(f))
 
368
                
 
369
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
370
            
 
371
        self._write_inventory(inv)
 
372
 
525
373
 
526
374
    def print_file(self, file, revno):
527
375
        """Print `file` to stdout."""
528
 
        self.lock_read()
529
 
        try:
530
 
            tree = self.revision_tree(self.lookup_revision(revno))
531
 
            # use inventory as it was in that revision
532
 
            file_id = tree.inventory.path2id(file)
533
 
            if not file_id:
534
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
535
 
            tree.print_file(file_id)
536
 
        finally:
537
 
            self.unlock()
538
 
 
 
376
        self._need_readlock()
 
377
        tree = self.revision_tree(self.lookup_revision(revno))
 
378
        # use inventory as it was in that revision
 
379
        file_id = tree.inventory.path2id(file)
 
380
        if not file_id:
 
381
            bailout("%r is not present in revision %d" % (file, revno))
 
382
        tree.print_file(file_id)
 
383
        
539
384
 
540
385
    def remove(self, files, verbose=False):
541
386
        """Mark nominated files for removal from the inventory.
553
398
        """
554
399
        ## TODO: Normalize names
555
400
        ## TODO: Remove nested loops; better scalability
556
 
        if isinstance(files, basestring):
 
401
        self._need_writelock()
 
402
 
 
403
        if isinstance(files, types.StringTypes):
557
404
            files = [files]
558
 
 
559
 
        self.lock_write()
560
 
 
561
 
        try:
562
 
            tree = self.working_tree()
563
 
            inv = tree.inventory
564
 
 
565
 
            # do this before any modifications
566
 
            for f in files:
567
 
                fid = inv.path2id(f)
568
 
                if not fid:
569
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
570
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
571
 
                if verbose:
572
 
                    # having remove it, it must be either ignored or unknown
573
 
                    if tree.is_ignored(f):
574
 
                        new_status = 'I'
575
 
                    else:
576
 
                        new_status = '?'
577
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
578
 
                del inv[fid]
579
 
 
580
 
            self._write_inventory(inv)
581
 
        finally:
582
 
            self.unlock()
583
 
 
584
 
 
585
 
    # FIXME: this doesn't need to be a branch method
 
405
        
 
406
        tree = self.working_tree()
 
407
        inv = tree.inventory
 
408
 
 
409
        # do this before any modifications
 
410
        for f in files:
 
411
            fid = inv.path2id(f)
 
412
            if not fid:
 
413
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
414
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
415
            if verbose:
 
416
                # having remove it, it must be either ignored or unknown
 
417
                if tree.is_ignored(f):
 
418
                    new_status = 'I'
 
419
                else:
 
420
                    new_status = '?'
 
421
                show_status(new_status, inv[fid].kind, quotefn(f))
 
422
            del inv[fid]
 
423
 
 
424
        self._write_inventory(inv)
 
425
 
586
426
    def set_inventory(self, new_inventory_list):
587
 
        from bzrlib.inventory import Inventory, InventoryEntry
588
 
        inv = Inventory(self.get_root_id())
 
427
        inv = Inventory()
589
428
        for path, file_id, parent, kind in new_inventory_list:
590
429
            name = os.path.basename(path)
591
430
            if name == "":
613
452
        return self.working_tree().unknowns()
614
453
 
615
454
 
616
 
    def append_revision(self, *revision_ids):
617
 
        for revision_id in revision_ids:
618
 
            mutter("add {%s} to revision-history" % revision_id)
619
 
 
 
455
    def append_revision(self, revision_id):
 
456
        mutter("add {%s} to revision-history" % revision_id)
620
457
        rev_history = self.revision_history()
621
 
        rev_history.extend(revision_ids)
622
 
 
623
 
        self.lock_write()
624
 
        try:
625
 
            self.put_controlfile('revision-history', '\n'.join(rev_history))
626
 
        finally:
627
 
            self.unlock()
628
 
 
629
 
 
630
 
    def get_revision_xml_file(self, revision_id):
631
 
        """Return XML file object for revision object."""
632
 
        if not revision_id or not isinstance(revision_id, basestring):
633
 
            raise InvalidRevisionId(revision_id)
634
 
 
635
 
        self.lock_read()
636
 
        try:
637
 
            try:
638
 
                return self.revision_store[revision_id]
639
 
            except (IndexError, KeyError):
640
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
641
 
        finally:
642
 
            self.unlock()
643
 
 
644
 
 
645
 
    #deprecated
646
 
    get_revision_xml = get_revision_xml_file
 
458
 
 
459
        tmprhname = self.controlfilename('revision-history.tmp')
 
460
        rhname = self.controlfilename('revision-history')
 
461
        
 
462
        f = file(tmprhname, 'wt')
 
463
        rev_history.append(revision_id)
 
464
        f.write('\n'.join(rev_history))
 
465
        f.write('\n')
 
466
        f.close()
 
467
 
 
468
        if sys.platform == 'win32':
 
469
            os.remove(rhname)
 
470
        os.rename(tmprhname, rhname)
 
471
        
647
472
 
648
473
 
649
474
    def get_revision(self, revision_id):
650
475
        """Return the Revision object for a named revision"""
651
 
        xml_file = self.get_revision_xml_file(revision_id)
652
 
 
653
 
        try:
654
 
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
655
 
        except SyntaxError, e:
656
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
657
 
                                         [revision_id,
658
 
                                          str(e)])
659
 
            
 
476
        self._need_readlock()
 
477
        r = Revision.read_xml(self.revision_store[revision_id])
660
478
        assert r.revision_id == revision_id
661
479
        return r
662
480
 
663
481
 
664
 
    def get_revision_delta(self, revno):
665
 
        """Return the delta for one revision.
666
 
 
667
 
        The delta is relative to its mainline predecessor, or the
668
 
        empty tree for revision 1.
669
 
        """
670
 
        assert isinstance(revno, int)
671
 
        rh = self.revision_history()
672
 
        if not (1 <= revno <= len(rh)):
673
 
            raise InvalidRevisionNumber(revno)
674
 
 
675
 
        # revno is 1-based; list is 0-based
676
 
 
677
 
        new_tree = self.revision_tree(rh[revno-1])
678
 
        if revno == 1:
679
 
            old_tree = EmptyTree()
680
 
        else:
681
 
            old_tree = self.revision_tree(rh[revno-2])
682
 
 
683
 
        return compare_trees(old_tree, new_tree)
684
 
 
685
 
        
686
 
    def get_revisions(self, revision_ids, pb=None):
687
 
        """Return the Revision object for a set of named revisions"""
688
 
        from bzrlib.revision import Revision
689
 
        from bzrlib.xml import unpack_xml
690
 
 
691
 
        # TODO: We need to decide what to do here
692
 
        # we cannot use a generator with a try/finally, because
693
 
        # you cannot guarantee that the caller will iterate through
694
 
        # all entries.
695
 
        # in the past, get_inventory wasn't even wrapped in a
696
 
        # try/finally locking block.
697
 
        # We could either lock without the try/finally, or just
698
 
        # not lock at all. We are reading entries that should
699
 
        # never be updated.
700
 
        # I prefer locking with no finally, so that if someone
701
 
        # asks for a list of revisions, but doesn't consume them,
702
 
        # that is their problem, and they will suffer the consequences
703
 
        self.lock_read()
704
 
        for xml_file in self.revision_store.get(revision_ids, pb=pb):
705
 
            try:
706
 
                r = bzrlib.xml.serializer_v4.read_revision(xml_file)
707
 
            except SyntaxError, e:
708
 
                raise bzrlib.errors.BzrError('failed to unpack revision_xml',
709
 
                                             [revision_id,
710
 
                                              str(e)])
711
 
            yield r
712
 
        self.unlock()
713
 
            
714
 
    def get_revision_sha1(self, revision_id):
715
 
        """Hash the stored value of a revision, and return it."""
716
 
        # In the future, revision entries will be signed. At that
717
 
        # point, it is probably best *not* to include the signature
718
 
        # in the revision hash. Because that lets you re-sign
719
 
        # the revision, (add signatures/remove signatures) and still
720
 
        # have all hash pointers stay consistent.
721
 
        # But for now, just hash the contents.
722
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
723
 
 
724
 
 
725
482
    def get_inventory(self, inventory_id):
726
483
        """Get Inventory object by hash.
727
484
 
728
485
        TODO: Perhaps for this and similar methods, take a revision
729
486
               parameter which can be either an integer revno or a
730
 
               string hash.
731
 
        """
732
 
        f = self.get_inventory_xml_file(inventory_id)
733
 
        return bzrlib.xml.serializer_v4.read_inventory(f)
734
 
 
735
 
 
736
 
    def get_inventory_xml(self, inventory_id):
737
 
        """Get inventory XML as a file object."""
738
 
        # Shouldn't this have a read-lock around it?
739
 
        # As well as some sort of trap for missing ids?
740
 
        return self.inventory_store[inventory_id]
741
 
 
742
 
    get_inventory_xml_file = get_inventory_xml
743
 
            
744
 
    def get_inventories(self, inventory_ids, pb=None, ignore_missing=False):
745
 
        """Get Inventory objects by id
746
 
        """
747
 
        from bzrlib.inventory import Inventory
748
 
 
749
 
        # See the discussion in get_revisions for why
750
 
        # we don't use a try/finally block here
751
 
        self.lock_read()
752
 
        for f in self.inventory_store.get(inventory_ids, pb=pb, ignore_missing=ignore_missing):
753
 
            if f is not None:
754
 
                # TODO: Possibly put a try/except around this to handle
755
 
                # read serialization errors
756
 
                r = bzrlib.xml.serializer_v4.read_inventory(f)
757
 
                yield r
758
 
            elif ignore_missing:
759
 
                yield None
760
 
            else:
761
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
762
 
        self.unlock()
763
 
 
764
 
    def get_inventory_sha1(self, inventory_id):
765
 
        """Return the sha1 hash of the inventory entry
766
 
        """
767
 
        return sha_file(self.get_inventory_xml(inventory_id))
 
487
               string hash."""
 
488
        self._need_readlock()
 
489
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
490
        return i
768
491
 
769
492
 
770
493
    def get_revision_inventory(self, revision_id):
771
494
        """Return inventory of a past revision."""
772
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
773
 
        # must be the same as its revision, so this is trivial.
 
495
        self._need_readlock()
774
496
        if revision_id == None:
775
 
            from bzrlib.inventory import Inventory
776
 
            return Inventory(self.get_root_id())
 
497
            return Inventory()
777
498
        else:
778
 
            return self.get_inventory(revision_id)
 
499
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
779
500
 
780
501
 
781
502
    def revision_history(self):
784
505
        >>> ScratchBranch().revision_history()
785
506
        []
786
507
        """
787
 
        self.lock_read()
788
 
        try:
789
 
            return [l.rstrip('\r\n') for l in
790
 
                    self.controlfile('revision-history', 'r').readlines()]
791
 
        finally:
792
 
            self.unlock()
793
 
 
794
 
 
795
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
796
 
        """
797
 
        >>> from bzrlib.commit import commit
798
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
799
 
        >>> sb.common_ancestor(sb) == (None, None)
800
 
        True
801
 
        >>> commit(sb, "Committing first revision", verbose=False)
802
 
        >>> sb.common_ancestor(sb)[0]
803
 
        1
804
 
        >>> clone = sb.clone()
805
 
        >>> commit(sb, "Committing second revision", verbose=False)
806
 
        >>> sb.common_ancestor(sb)[0]
807
 
        2
808
 
        >>> sb.common_ancestor(clone)[0]
809
 
        1
810
 
        >>> commit(clone, "Committing divergent second revision", 
811
 
        ...               verbose=False)
812
 
        >>> sb.common_ancestor(clone)[0]
813
 
        1
814
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
815
 
        True
816
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
817
 
        True
818
 
        >>> clone2 = sb.clone()
819
 
        >>> sb.common_ancestor(clone2)[0]
820
 
        2
821
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
822
 
        1
823
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
824
 
        1
825
 
        """
826
 
        my_history = self.revision_history()
827
 
        other_history = other.revision_history()
828
 
        if self_revno is None:
829
 
            self_revno = len(my_history)
830
 
        if other_revno is None:
831
 
            other_revno = len(other_history)
832
 
        indices = range(min((self_revno, other_revno)))
833
 
        indices.reverse()
834
 
        for r in indices:
835
 
            if my_history[r] == other_history[r]:
836
 
                return r+1, my_history[r]
837
 
        return None, None
 
508
        self._need_readlock()
 
509
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
510
 
 
511
 
 
512
    def enum_history(self, direction):
 
513
        """Return (revno, revision_id) for history of branch.
 
514
 
 
515
        direction
 
516
            'forward' is from earliest to latest
 
517
            'reverse' is from latest to earliest
 
518
        """
 
519
        rh = self.revision_history()
 
520
        if direction == 'forward':
 
521
            i = 1
 
522
            for rid in rh:
 
523
                yield i, rid
 
524
                i += 1
 
525
        elif direction == 'reverse':
 
526
            i = len(rh)
 
527
            while i > 0:
 
528
                yield i, rh[i-1]
 
529
                i -= 1
 
530
        else:
 
531
            raise BzrError('invalid history direction %r' % direction)
838
532
 
839
533
 
840
534
    def revno(self):
856
550
            return None
857
551
 
858
552
 
859
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
860
 
        """
861
 
        If self and other have not diverged, return a list of the revisions
862
 
        present in other, but missing from self.
863
 
 
864
 
        >>> from bzrlib.commit import commit
865
 
        >>> bzrlib.trace.silent = True
866
 
        >>> br1 = ScratchBranch()
867
 
        >>> br2 = ScratchBranch()
868
 
        >>> br1.missing_revisions(br2)
869
 
        []
870
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
871
 
        >>> br1.missing_revisions(br2)
872
 
        [u'REVISION-ID-1']
873
 
        >>> br2.missing_revisions(br1)
874
 
        []
875
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
876
 
        >>> br1.missing_revisions(br2)
877
 
        []
878
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
879
 
        >>> br1.missing_revisions(br2)
880
 
        [u'REVISION-ID-2A']
881
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
882
 
        >>> br1.missing_revisions(br2)
883
 
        Traceback (most recent call last):
884
 
        DivergedBranches: These branches have diverged.
885
 
        """
886
 
        self_history = self.revision_history()
887
 
        self_len = len(self_history)
888
 
        other_history = other.revision_history()
889
 
        other_len = len(other_history)
890
 
        common_index = min(self_len, other_len) -1
891
 
        if common_index >= 0 and \
892
 
            self_history[common_index] != other_history[common_index]:
893
 
            raise DivergedBranches(self, other)
894
 
 
895
 
        if stop_revision is None:
896
 
            stop_revision = other_len
897
 
        elif stop_revision > other_len:
898
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
899
 
        
900
 
        return other_history[self_len:stop_revision]
901
 
 
902
 
 
903
 
    def update_revisions(self, other, stop_revision=None):
904
 
        """Pull in all new revisions from other branch.
905
 
        """
906
 
        from bzrlib.fetch import greedy_fetch
907
 
        from bzrlib.revision import get_intervening_revisions
908
 
 
909
 
        pb = bzrlib.ui.ui_factory.progress_bar()
910
 
        pb.update('comparing histories')
911
 
        if stop_revision is None:
912
 
            other_revision = other.last_patch()
913
 
        else:
914
 
            other_revision = other.lookup_revision(stop_revision)
915
 
        count = greedy_fetch(self, other, other_revision, pb)[0]
916
 
        try:
917
 
            revision_ids = self.missing_revisions(other, stop_revision)
918
 
        except DivergedBranches, e:
919
 
            try:
920
 
                revision_ids = get_intervening_revisions(self.last_patch(), 
921
 
                                                         other_revision, self)
922
 
                assert self.last_patch() not in revision_ids
923
 
            except bzrlib.errors.NotAncestor:
924
 
                raise e
925
 
 
926
 
        self.append_revision(*revision_ids)
927
 
        pb.clear()
928
 
 
929
 
    def install_revisions(self, other, revision_ids, pb):
930
 
        # We are going to iterate this many times, so make sure
931
 
        # that it is a list, and not a generator
932
 
        revision_ids = list(revision_ids)
933
 
        if hasattr(other.revision_store, "prefetch"):
934
 
            other.revision_store.prefetch(revision_ids)
935
 
        if hasattr(other.inventory_store, "prefetch"):
936
 
            other.inventory_store.prefetch(inventory_ids)
937
 
 
938
 
        if pb is None:
939
 
            pb = bzrlib.ui.ui_factory.progress_bar()
940
 
                
941
 
        # This entire next section is generally done
942
 
        # with either generators, or bulk updates
943
 
        inventories = other.get_inventories(revision_ids, ignore_missing=True)
944
 
        needed_texts = set()
945
 
 
946
 
        failures = set()
947
 
        good_revisions = set()
948
 
        for i, (inv, rev_id) in enumerate(zip(inventories, revision_ids)):
949
 
            pb.update('fetching revision', i+1, len(revision_ids))
950
 
 
951
 
            # We don't really need to get the revision here, because
952
 
            # the only thing we needed was the inventory_id, which now
953
 
            # is (by design) identical to the revision_id
954
 
            # try:
955
 
            #     rev = other.get_revision(rev_id)
956
 
            # except bzrlib.errors.NoSuchRevision:
957
 
            #     failures.add(rev_id)
958
 
            #     continue
959
 
 
960
 
            if inv is None:
961
 
                failures.add(rev_id)
962
 
                continue
963
 
            else:
964
 
                good_revisions.add(rev_id)
965
 
 
966
 
            text_ids = []
967
 
            for key, entry in inv.iter_entries():
968
 
                if entry.text_id is None:
969
 
                    continue
970
 
                text_ids.append(entry.text_id)
971
 
 
972
 
            has_ids = self.text_store.has(text_ids)
973
 
            for has, text_id in zip(has_ids, text_ids):
974
 
                if not has:
975
 
                    needed_texts.add(text_id)
976
 
 
977
 
        pb.clear()
978
 
                    
979
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
980
 
                                                    needed_texts)
981
 
        #print "Added %d texts." % count 
982
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
983
 
                                                         good_revisions)
984
 
        #print "Added %d inventories." % count 
985
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
986
 
                                                          good_revisions,
987
 
                                                          permit_failure=True)
988
 
        assert len(cp_fail) == 0 
989
 
        return count, failures
990
 
       
991
 
 
992
553
    def commit(self, *args, **kw):
 
554
        """Deprecated"""
993
555
        from bzrlib.commit import commit
994
556
        commit(self, *args, **kw)
995
557
        
996
558
 
997
 
    def lookup_revision(self, revision):
998
 
        """Return the revision identifier for a given revision information."""
999
 
        revno, info = self._get_revision_info(revision)
1000
 
        return info
1001
 
 
1002
 
 
1003
 
    def revision_id_to_revno(self, revision_id):
1004
 
        """Given a revision id, return its revno"""
1005
 
        history = self.revision_history()
1006
 
        try:
1007
 
            return history.index(revision_id) + 1
1008
 
        except ValueError:
1009
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
1010
 
 
1011
 
 
1012
 
    def get_revision_info(self, revision):
1013
 
        """Return (revno, revision id) for revision identifier.
1014
 
 
1015
 
        revision can be an integer, in which case it is assumed to be revno (though
1016
 
            this will translate negative values into positive ones)
1017
 
        revision can also be a string, in which case it is parsed for something like
1018
 
            'date:' or 'revid:' etc.
1019
 
        """
1020
 
        revno, rev_id = self._get_revision_info(revision)
1021
 
        if revno is None:
1022
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
1023
 
        return revno, rev_id
1024
 
 
1025
 
    def get_rev_id(self, revno, history=None):
1026
 
        """Find the revision id of the specified revno."""
 
559
    def lookup_revision(self, revno):
 
560
        """Return revision hash for revision number."""
1027
561
        if revno == 0:
1028
562
            return None
1029
 
        if history is None:
1030
 
            history = self.revision_history()
1031
 
        elif revno <= 0 or revno > len(history):
1032
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
1033
 
        return history[revno - 1]
1034
 
 
1035
 
    def _get_revision_info(self, revision):
1036
 
        """Return (revno, revision id) for revision specifier.
1037
 
 
1038
 
        revision can be an integer, in which case it is assumed to be revno
1039
 
        (though this will translate negative values into positive ones)
1040
 
        revision can also be a string, in which case it is parsed for something
1041
 
        like 'date:' or 'revid:' etc.
1042
 
 
1043
 
        A revid is always returned.  If it is None, the specifier referred to
1044
 
        the null revision.  If the revid does not occur in the revision
1045
 
        history, revno will be None.
1046
 
        """
1047
 
        
1048
 
        if revision is None:
1049
 
            return 0, None
1050
 
        revno = None
1051
 
        try:# Convert to int if possible
1052
 
            revision = int(revision)
1053
 
        except ValueError:
1054
 
            pass
1055
 
        revs = self.revision_history()
1056
 
        if isinstance(revision, int):
1057
 
            if revision < 0:
1058
 
                revno = len(revs) + revision + 1
1059
 
            else:
1060
 
                revno = revision
1061
 
            rev_id = self.get_rev_id(revno, revs)
1062
 
        elif isinstance(revision, basestring):
1063
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
1064
 
                if revision.startswith(prefix):
1065
 
                    result = func(self, revs, revision)
1066
 
                    if len(result) > 1:
1067
 
                        revno, rev_id = result
1068
 
                    else:
1069
 
                        revno = result[0]
1070
 
                        rev_id = self.get_rev_id(revno, revs)
1071
 
                    break
1072
 
            else:
1073
 
                raise BzrError('No namespace registered for string: %r' %
1074
 
                               revision)
1075
 
        else:
1076
 
            raise TypeError('Unhandled revision type %s' % revision)
1077
 
 
1078
 
        if revno is None:
1079
 
            if rev_id is None:
1080
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
1081
 
        return revno, rev_id
1082
 
 
1083
 
    def _namespace_revno(self, revs, revision):
1084
 
        """Lookup a revision by revision number"""
1085
 
        assert revision.startswith('revno:')
1086
 
        try:
1087
 
            return (int(revision[6:]),)
1088
 
        except ValueError:
1089
 
            return None
1090
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
1091
 
 
1092
 
    def _namespace_revid(self, revs, revision):
1093
 
        assert revision.startswith('revid:')
1094
 
        rev_id = revision[len('revid:'):]
1095
 
        try:
1096
 
            return revs.index(rev_id) + 1, rev_id
1097
 
        except ValueError:
1098
 
            return None, rev_id
1099
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
1100
 
 
1101
 
    def _namespace_last(self, revs, revision):
1102
 
        assert revision.startswith('last:')
1103
 
        try:
1104
 
            offset = int(revision[5:])
1105
 
        except ValueError:
1106
 
            return (None,)
1107
 
        else:
1108
 
            if offset <= 0:
1109
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
1110
 
            return (len(revs) - offset + 1,)
1111
 
    REVISION_NAMESPACES['last:'] = _namespace_last
1112
 
 
1113
 
    def _namespace_tag(self, revs, revision):
1114
 
        assert revision.startswith('tag:')
1115
 
        raise BzrError('tag: namespace registered, but not implemented.')
1116
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
1117
 
 
1118
 
    def _namespace_date(self, revs, revision):
1119
 
        assert revision.startswith('date:')
1120
 
        import datetime
1121
 
        # Spec for date revisions:
1122
 
        #   date:value
1123
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1124
 
        #   it can also start with a '+/-/='. '+' says match the first
1125
 
        #   entry after the given date. '-' is match the first entry before the date
1126
 
        #   '=' is match the first entry after, but still on the given date.
1127
 
        #
1128
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1129
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1130
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1131
 
        #       May 13th, 2005 at 0:00
1132
 
        #
1133
 
        #   So the proper way of saying 'give me all entries for today' is:
1134
 
        #       -r {date:+today}:{date:-tomorrow}
1135
 
        #   The default is '=' when not supplied
1136
 
        val = revision[5:]
1137
 
        match_style = '='
1138
 
        if val[:1] in ('+', '-', '='):
1139
 
            match_style = val[:1]
1140
 
            val = val[1:]
1141
 
 
1142
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1143
 
        if val.lower() == 'yesterday':
1144
 
            dt = today - datetime.timedelta(days=1)
1145
 
        elif val.lower() == 'today':
1146
 
            dt = today
1147
 
        elif val.lower() == 'tomorrow':
1148
 
            dt = today + datetime.timedelta(days=1)
1149
 
        else:
1150
 
            import re
1151
 
            # This should be done outside the function to avoid recompiling it.
1152
 
            _date_re = re.compile(
1153
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1154
 
                    r'(,|T)?\s*'
1155
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1156
 
                )
1157
 
            m = _date_re.match(val)
1158
 
            if not m or (not m.group('date') and not m.group('time')):
1159
 
                raise BzrError('Invalid revision date %r' % revision)
1160
 
 
1161
 
            if m.group('date'):
1162
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1163
 
            else:
1164
 
                year, month, day = today.year, today.month, today.day
1165
 
            if m.group('time'):
1166
 
                hour = int(m.group('hour'))
1167
 
                minute = int(m.group('minute'))
1168
 
                if m.group('second'):
1169
 
                    second = int(m.group('second'))
1170
 
                else:
1171
 
                    second = 0
1172
 
            else:
1173
 
                hour, minute, second = 0,0,0
1174
 
 
1175
 
            dt = datetime.datetime(year=year, month=month, day=day,
1176
 
                    hour=hour, minute=minute, second=second)
1177
 
        first = dt
1178
 
        last = None
1179
 
        reversed = False
1180
 
        if match_style == '-':
1181
 
            reversed = True
1182
 
        elif match_style == '=':
1183
 
            last = dt + datetime.timedelta(days=1)
1184
 
 
1185
 
        if reversed:
1186
 
            for i in range(len(revs)-1, -1, -1):
1187
 
                r = self.get_revision(revs[i])
1188
 
                # TODO: Handle timezone.
1189
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1190
 
                if first >= dt and (last is None or dt >= last):
1191
 
                    return (i+1,)
1192
 
        else:
1193
 
            for i in range(len(revs)):
1194
 
                r = self.get_revision(revs[i])
1195
 
                # TODO: Handle timezone.
1196
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1197
 
                if first <= dt and (last is None or dt <= last):
1198
 
                    return (i+1,)
1199
 
    REVISION_NAMESPACES['date:'] = _namespace_date
1200
 
 
1201
 
 
1202
 
    def _namespace_ancestor(self, revs, revision):
1203
 
        from revision import common_ancestor, MultipleRevisionSources
1204
 
        other_branch = find_branch(_trim_namespace('ancestor', revision))
1205
 
        revision_a = self.last_patch()
1206
 
        revision_b = other_branch.last_patch()
1207
 
        for r, b in ((revision_a, self), (revision_b, other_branch)):
1208
 
            if r is None:
1209
 
                raise bzrlib.errors.NoCommits(b)
1210
 
        revision_source = MultipleRevisionSources(self, other_branch)
1211
 
        result = common_ancestor(revision_a, revision_b, revision_source)
1212
 
        try:
1213
 
            revno = self.revision_id_to_revno(result)
1214
 
        except bzrlib.errors.NoSuchRevision:
1215
 
            revno = None
1216
 
        return revno,result
1217
 
        
1218
 
 
1219
 
    REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
 
563
 
 
564
        try:
 
565
            # list is 0-based; revisions are 1-based
 
566
            return self.revision_history()[revno-1]
 
567
        except IndexError:
 
568
            raise BzrError("no such revision %s" % revno)
 
569
 
1220
570
 
1221
571
    def revision_tree(self, revision_id):
1222
572
        """Return Tree for a revision on this branch.
1223
573
 
1224
574
        `revision_id` may be None for the null revision, in which case
1225
575
        an `EmptyTree` is returned."""
1226
 
        # TODO: refactor this to use an existing revision object
1227
 
        # so we don't need to read it in twice.
 
576
        self._need_readlock()
1228
577
        if revision_id == None:
1229
578
            return EmptyTree()
1230
579
        else:
1234
583
 
1235
584
    def working_tree(self):
1236
585
        """Return a `Tree` for the working copy."""
1237
 
        from bzrlib.workingtree import WorkingTree
1238
 
        # TODO: In the future, WorkingTree should utilize Transport
1239
 
        return WorkingTree(self._transport.base, self.read_working_inventory())
 
586
        from workingtree import WorkingTree
 
587
        return WorkingTree(self.base, self.read_working_inventory())
1240
588
 
1241
589
 
1242
590
    def basis_tree(self):
1257
605
 
1258
606
        This can change the directory or the filename or both.
1259
607
        """
1260
 
        self.lock_write()
 
608
        self._need_writelock()
 
609
        tree = self.working_tree()
 
610
        inv = tree.inventory
 
611
        if not tree.has_filename(from_rel):
 
612
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
613
        if tree.has_filename(to_rel):
 
614
            bailout("can't rename: new working file %r already exists" % to_rel)
 
615
            
 
616
        file_id = inv.path2id(from_rel)
 
617
        if file_id == None:
 
618
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
619
 
 
620
        if inv.path2id(to_rel):
 
621
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
622
 
 
623
        to_dir, to_tail = os.path.split(to_rel)
 
624
        to_dir_id = inv.path2id(to_dir)
 
625
        if to_dir_id == None and to_dir != '':
 
626
            bailout("can't determine destination directory id for %r" % to_dir)
 
627
 
 
628
        mutter("rename_one:")
 
629
        mutter("  file_id    {%s}" % file_id)
 
630
        mutter("  from_rel   %r" % from_rel)
 
631
        mutter("  to_rel     %r" % to_rel)
 
632
        mutter("  to_dir     %r" % to_dir)
 
633
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
634
            
 
635
        inv.rename(file_id, to_dir_id, to_tail)
 
636
 
 
637
        print "%s => %s" % (from_rel, to_rel)
 
638
        
 
639
        from_abs = self.abspath(from_rel)
 
640
        to_abs = self.abspath(to_rel)
1261
641
        try:
1262
 
            tree = self.working_tree()
1263
 
            inv = tree.inventory
1264
 
            if not tree.has_filename(from_rel):
1265
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1266
 
            if tree.has_filename(to_rel):
1267
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
1268
 
 
1269
 
            file_id = inv.path2id(from_rel)
1270
 
            if file_id == None:
1271
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1272
 
 
1273
 
            if inv.path2id(to_rel):
1274
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1275
 
 
1276
 
            to_dir, to_tail = os.path.split(to_rel)
1277
 
            to_dir_id = inv.path2id(to_dir)
1278
 
            if to_dir_id == None and to_dir != '':
1279
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
1280
 
 
1281
 
            mutter("rename_one:")
1282
 
            mutter("  file_id    {%s}" % file_id)
1283
 
            mutter("  from_rel   %r" % from_rel)
1284
 
            mutter("  to_rel     %r" % to_rel)
1285
 
            mutter("  to_dir     %r" % to_dir)
1286
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
1287
 
 
1288
 
            inv.rename(file_id, to_dir_id, to_tail)
1289
 
 
1290
 
            from_abs = self.abspath(from_rel)
1291
 
            to_abs = self.abspath(to_rel)
1292
 
            try:
1293
 
                os.rename(from_abs, to_abs)
1294
 
            except OSError, e:
1295
 
                raise BzrError("failed to rename %r to %r: %s"
1296
 
                        % (from_abs, to_abs, e[1]),
1297
 
                        ["rename rolled back"])
1298
 
 
1299
 
            self._write_inventory(inv)
1300
 
        finally:
1301
 
            self.unlock()
 
642
            os.rename(from_abs, to_abs)
 
643
        except OSError, e:
 
644
            bailout("failed to rename %r to %r: %s"
 
645
                    % (from_abs, to_abs, e[1]),
 
646
                    ["rename rolled back"])
 
647
 
 
648
        self._write_inventory(inv)
 
649
            
1302
650
 
1303
651
 
1304
652
    def move(self, from_paths, to_name):
1311
659
 
1312
660
        Note that to_name is only the last component of the new name;
1313
661
        this doesn't change the directory.
1314
 
 
1315
 
        This returns a list of (from_path, to_path) pairs for each
1316
 
        entry that is moved.
1317
 
        """
1318
 
        result = []
1319
 
        self.lock_write()
1320
 
        try:
1321
 
            ## TODO: Option to move IDs only
1322
 
            assert not isinstance(from_paths, basestring)
1323
 
            tree = self.working_tree()
1324
 
            inv = tree.inventory
1325
 
            to_abs = self.abspath(to_name)
1326
 
            if not isdir(to_abs):
1327
 
                raise BzrError("destination %r is not a directory" % to_abs)
1328
 
            if not tree.has_filename(to_name):
1329
 
                raise BzrError("destination %r not in working directory" % to_abs)
1330
 
            to_dir_id = inv.path2id(to_name)
1331
 
            if to_dir_id == None and to_name != '':
1332
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1333
 
            to_dir_ie = inv[to_dir_id]
1334
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1335
 
                raise BzrError("destination %r is not a directory" % to_abs)
1336
 
 
1337
 
            to_idpath = inv.get_idpath(to_dir_id)
1338
 
 
1339
 
            for f in from_paths:
1340
 
                if not tree.has_filename(f):
1341
 
                    raise BzrError("%r does not exist in working tree" % f)
1342
 
                f_id = inv.path2id(f)
1343
 
                if f_id == None:
1344
 
                    raise BzrError("%r is not versioned" % f)
1345
 
                name_tail = splitpath(f)[-1]
1346
 
                dest_path = appendpath(to_name, name_tail)
1347
 
                if tree.has_filename(dest_path):
1348
 
                    raise BzrError("destination %r already exists" % dest_path)
1349
 
                if f_id in to_idpath:
1350
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1351
 
 
1352
 
            # OK, so there's a race here, it's possible that someone will
1353
 
            # create a file in this interval and then the rename might be
1354
 
            # left half-done.  But we should have caught most problems.
1355
 
 
1356
 
            for f in from_paths:
1357
 
                name_tail = splitpath(f)[-1]
1358
 
                dest_path = appendpath(to_name, name_tail)
1359
 
                result.append((f, dest_path))
1360
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1361
 
                try:
1362
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1363
 
                except OSError, e:
1364
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1365
 
                            ["rename rolled back"])
1366
 
 
1367
 
            self._write_inventory(inv)
1368
 
        finally:
1369
 
            self.unlock()
1370
 
 
1371
 
        return result
1372
 
 
1373
 
 
1374
 
    def revert(self, filenames, old_tree=None, backups=True):
1375
 
        """Restore selected files to the versions from a previous tree.
1376
 
 
1377
 
        backups
1378
 
            If true (default) backups are made of files before
1379
 
            they're renamed.
1380
 
        """
1381
 
        from bzrlib.errors import NotVersionedError, BzrError
1382
 
        from bzrlib.atomicfile import AtomicFile
1383
 
        from bzrlib.osutils import backup_file
1384
 
        
1385
 
        inv = self.read_working_inventory()
1386
 
        if old_tree is None:
1387
 
            old_tree = self.basis_tree()
1388
 
        old_inv = old_tree.inventory
1389
 
 
1390
 
        nids = []
1391
 
        for fn in filenames:
1392
 
            file_id = inv.path2id(fn)
1393
 
            if not file_id:
1394
 
                raise NotVersionedError("not a versioned file", fn)
1395
 
            if not old_inv.has_id(file_id):
1396
 
                raise BzrError("file not present in old tree", fn, file_id)
1397
 
            nids.append((fn, file_id))
1398
 
            
1399
 
        # TODO: Rename back if it was previously at a different location
1400
 
 
1401
 
        # TODO: If given a directory, restore the entire contents from
1402
 
        # the previous version.
1403
 
 
1404
 
        # TODO: Make a backup to a temporary file.
1405
 
 
1406
 
        # TODO: If the file previously didn't exist, delete it?
1407
 
        for fn, file_id in nids:
1408
 
            backup_file(fn)
1409
 
            
1410
 
            f = AtomicFile(fn, 'wb')
1411
 
            try:
1412
 
                f.write(old_tree.get_file(file_id).read())
1413
 
                f.commit()
1414
 
            finally:
1415
 
                f.close()
1416
 
 
1417
 
 
1418
 
    def pending_merges(self):
1419
 
        """Return a list of pending merges.
1420
 
 
1421
 
        These are revisions that have been merged into the working
1422
 
        directory but not yet committed.
1423
 
        """
1424
 
        cfn = self._rel_controlfilename('pending-merges')
1425
 
        if not self._transport.has(cfn):
1426
 
            return []
1427
 
        p = []
1428
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1429
 
            p.append(l.rstrip('\n'))
1430
 
        return p
1431
 
 
1432
 
 
1433
 
    def add_pending_merge(self, *revision_ids):
1434
 
        from bzrlib.revision import validate_revision_id
1435
 
 
1436
 
        for rev_id in revision_ids:
1437
 
            validate_revision_id(rev_id)
1438
 
 
1439
 
        p = self.pending_merges()
1440
 
        updated = False
1441
 
        for rev_id in revision_ids:
1442
 
            if rev_id in p:
1443
 
                continue
1444
 
            p.append(rev_id)
1445
 
            updated = True
1446
 
        if updated:
1447
 
            self.set_pending_merges(p)
1448
 
 
1449
 
    def set_pending_merges(self, rev_list):
1450
 
        self.lock_write()
1451
 
        try:
1452
 
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
1453
 
        finally:
1454
 
            self.unlock()
1455
 
 
1456
 
 
1457
 
    def get_parent(self):
1458
 
        """Return the parent location of the branch.
1459
 
 
1460
 
        This is the default location for push/pull/missing.  The usual
1461
 
        pattern is that the user can override it by specifying a
1462
 
        location.
1463
 
        """
1464
 
        import errno
1465
 
        _locs = ['parent', 'pull', 'x-pull']
1466
 
        for l in _locs:
1467
 
            try:
1468
 
                return self.controlfile(l, 'r').read().strip('\n')
1469
 
            except IOError, e:
1470
 
                if e.errno != errno.ENOENT:
1471
 
                    raise
1472
 
        return None
1473
 
 
1474
 
 
1475
 
    def set_parent(self, url):
1476
 
        # TODO: Maybe delete old location files?
1477
 
        from bzrlib.atomicfile import AtomicFile
1478
 
        self.lock_write()
1479
 
        try:
1480
 
            f = AtomicFile(self.controlfilename('parent'))
1481
 
            try:
1482
 
                f.write(url + '\n')
1483
 
                f.commit()
1484
 
            finally:
1485
 
                f.close()
1486
 
        finally:
1487
 
            self.unlock()
1488
 
 
1489
 
    def check_revno(self, revno):
1490
 
        """\
1491
 
        Check whether a revno corresponds to any revision.
1492
 
        Zero (the NULL revision) is considered valid.
1493
 
        """
1494
 
        if revno != 0:
1495
 
            self.check_real_revno(revno)
1496
 
            
1497
 
    def check_real_revno(self, revno):
1498
 
        """\
1499
 
        Check whether a revno corresponds to a real revision.
1500
 
        Zero (the NULL revision) is considered invalid
1501
 
        """
1502
 
        if revno < 1 or revno > self.revno():
1503
 
            raise InvalidRevisionNumber(revno)
1504
 
        
1505
 
        
 
662
        """
 
663
        self._need_writelock()
 
664
        ## TODO: Option to move IDs only
 
665
        assert not isinstance(from_paths, basestring)
 
666
        tree = self.working_tree()
 
667
        inv = tree.inventory
 
668
        to_abs = self.abspath(to_name)
 
669
        if not isdir(to_abs):
 
670
            bailout("destination %r is not a directory" % to_abs)
 
671
        if not tree.has_filename(to_name):
 
672
            bailout("destination %r not in working directory" % to_abs)
 
673
        to_dir_id = inv.path2id(to_name)
 
674
        if to_dir_id == None and to_name != '':
 
675
            bailout("destination %r is not a versioned directory" % to_name)
 
676
        to_dir_ie = inv[to_dir_id]
 
677
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
678
            bailout("destination %r is not a directory" % to_abs)
 
679
 
 
680
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
681
 
 
682
        for f in from_paths:
 
683
            if not tree.has_filename(f):
 
684
                bailout("%r does not exist in working tree" % f)
 
685
            f_id = inv.path2id(f)
 
686
            if f_id == None:
 
687
                bailout("%r is not versioned" % f)
 
688
            name_tail = splitpath(f)[-1]
 
689
            dest_path = appendpath(to_name, name_tail)
 
690
            if tree.has_filename(dest_path):
 
691
                bailout("destination %r already exists" % dest_path)
 
692
            if f_id in to_idpath:
 
693
                bailout("can't move %r to a subdirectory of itself" % f)
 
694
 
 
695
        # OK, so there's a race here, it's possible that someone will
 
696
        # create a file in this interval and then the rename might be
 
697
        # left half-done.  But we should have caught most problems.
 
698
 
 
699
        for f in from_paths:
 
700
            name_tail = splitpath(f)[-1]
 
701
            dest_path = appendpath(to_name, name_tail)
 
702
            print "%s => %s" % (f, dest_path)
 
703
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
704
            try:
 
705
                os.rename(self.abspath(f), self.abspath(dest_path))
 
706
            except OSError, e:
 
707
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
708
                        ["rename rolled back"])
 
709
 
 
710
        self._write_inventory(inv)
 
711
 
 
712
 
1506
713
 
1507
714
 
1508
715
class ScratchBranch(Branch):
1516
723
    >>> isdir(bd)
1517
724
    False
1518
725
    """
1519
 
    def __init__(self, files=[], dirs=[], base=None):
 
726
    def __init__(self, files=[], dirs=[]):
1520
727
        """Make a test branch.
1521
728
 
1522
729
        This creates a temporary directory and runs init-tree in it.
1523
730
 
1524
731
        If any files are listed, they are created in the working copy.
1525
732
        """
1526
 
        from tempfile import mkdtemp
1527
 
        init = False
1528
 
        if base is None:
1529
 
            base = mkdtemp()
1530
 
            init = True
1531
 
        Branch.__init__(self, base, init=init)
 
733
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1532
734
        for d in dirs:
1533
 
            self._transport.mkdir(d)
 
735
            os.mkdir(self.abspath(d))
1534
736
            
1535
737
        for f in files:
1536
 
            self._transport.put(f, 'content of %s' % f)
1537
 
 
1538
 
 
1539
 
    def clone(self):
1540
 
        """
1541
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1542
 
        >>> clone = orig.clone()
1543
 
        >>> os.path.samefile(orig.base, clone.base)
1544
 
        False
1545
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1546
 
        True
1547
 
        """
1548
 
        from shutil import copytree
1549
 
        from tempfile import mkdtemp
1550
 
        base = mkdtemp()
1551
 
        os.rmdir(base)
1552
 
        copytree(self.base, base, symlinks=True)
1553
 
        return ScratchBranch(base=base)
1554
 
 
1555
 
 
1556
 
        
 
738
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
739
 
 
740
 
1557
741
    def __del__(self):
1558
742
        self.destroy()
1559
743
 
1560
744
    def destroy(self):
1561
745
        """Destroy the test branch, removing the scratch directory."""
1562
 
        from shutil import rmtree
1563
746
        try:
1564
 
            if self.base:
1565
 
                mutter("delete ScratchBranch %s" % self.base)
1566
 
                rmtree(self.base)
 
747
            mutter("delete ScratchBranch %s" % self.base)
 
748
            shutil.rmtree(self.base)
1567
749
        except OSError, e:
1568
750
            # Work around for shutil.rmtree failing on Windows when
1569
751
            # readonly files are encountered
1571
753
            for root, dirs, files in os.walk(self.base, topdown=False):
1572
754
                for name in files:
1573
755
                    os.chmod(os.path.join(root, name), 0700)
1574
 
            rmtree(self.base)
1575
 
        self._transport = None
 
756
            shutil.rmtree(self.base)
 
757
        self.base = None
1576
758
 
1577
759
    
1578
760
 
1601
783
    This should probably generate proper UUIDs, but for the moment we
1602
784
    cope with just randomness because running uuidgen every time is
1603
785
    slow."""
1604
 
    import re
1605
 
    from binascii import hexlify
1606
 
    from time import time
1607
 
 
1608
 
    # get last component
1609
786
    idx = name.rfind('/')
1610
787
    if idx != -1:
1611
788
        name = name[idx+1 : ]
1613
790
    if idx != -1:
1614
791
        name = name[idx+1 : ]
1615
792
 
1616
 
    # make it not a hidden file
1617
793
    name = name.lstrip('.')
1618
794
 
1619
 
    # remove any wierd characters; we don't escape them but rather
1620
 
    # just pull them out
1621
 
    name = re.sub(r'[^\w.]', '', name)
1622
 
 
1623
795
    s = hexlify(rand_bytes(8))
1624
 
    return '-'.join((name, compact_date(time()), s))
1625
 
 
1626
 
 
1627
 
def gen_root_id():
1628
 
    """Return a new tree-root file id."""
1629
 
    return gen_file_id('TREE_ROOT')
1630
 
 
1631
 
 
1632
 
def copy_branch(branch_from, to_location, revision=None):
1633
 
    """Copy branch_from into the existing directory to_location.
1634
 
 
1635
 
    revision
1636
 
        If not None, only revisions up to this point will be copied.
1637
 
        The head of the new branch will be that revision.
1638
 
 
1639
 
    to_location
1640
 
        The name of a local directory that exists but is empty.
1641
 
    """
1642
 
    from bzrlib.merge import merge
1643
 
 
1644
 
    assert isinstance(branch_from, Branch)
1645
 
    assert isinstance(to_location, basestring)
1646
 
    
1647
 
    br_to = Branch(to_location, init=True)
1648
 
    br_to.set_root_id(branch_from.get_root_id())
1649
 
    if revision is None:
1650
 
        revno = branch_from.revno()
1651
 
    else:
1652
 
        revno, rev_id = branch_from.get_revision_info(revision)
1653
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1654
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1655
 
          check_clean=False, ignore_zero=True)
1656
 
    br_to.set_parent(branch_from.base)
1657
 
    return br_to
1658
 
 
1659
 
def _trim_namespace(namespace, spec):
1660
 
    full_namespace = namespace + ':'
1661
 
    assert spec.startswith(full_namespace)
1662
 
    return spec[len(full_namespace):]
 
796
    return '-'.join((name, compact_date(time.time()), s))