~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2005-09-10 23:47:16 UTC
  • mto: (1185.3.4)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: aaron.bentley@utoronto.ca-20050910234716-3fd7d81b53552e82
Removed unused priodict file

Show diffs side-by-side

added added

removed removed

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