~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-13 00:57:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050513005732-26b0a3042cbb57d1
- more notes on tagging

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
 
import bzrlib.errors
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
43
    if f and (f.startswith('http://') or f.startswith('https://')):
53
45
        return remotebranch.RemoteBranch(f, **args)
54
46
    else:
55
47
        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)
101
48
        
102
49
 
103
50
def find_branch_root(f=None):
108
55
    It is not necessary that f exists.
109
56
 
110
57
    Basically we keep looking up until we find the control directory or
111
 
    run into the root.  If there isn't one, raises NotBranchError.
112
 
    """
 
58
    run into the root."""
113
59
    if f == None:
114
60
        f = os.getcwd()
115
61
    elif hasattr(os.path, 'realpath'):
128
74
        head, tail = os.path.split(f)
129
75
        if head == f:
130
76
            # reached the root, whatever that may be
131
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
77
            raise BzrError('%r is not in a branch' % orig_f)
132
78
        f = head
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.")
 
79
    
142
80
 
143
81
 
144
82
######################################################################
145
83
# branch objects
146
84
 
147
 
class Branch(object):
 
85
class Branch:
148
86
    """Branch holding a history of revisions.
149
87
 
150
88
    base
151
89
        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.
162
90
    """
163
 
    base = None
164
 
    _lock_mode = None
165
 
    _lock_count = None
166
 
    _lock = None
 
91
    _lockmode = None
167
92
    
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):
 
93
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
174
94
        """Create new branch object at a particular location.
175
95
 
176
96
        base -- Base directory for the branch.
185
105
        In the test suite, creation of new trees is tested using the
186
106
        `ScratchBranch` class.
187
107
        """
188
 
        from bzrlib.store import ImmutableStore
189
108
        if init:
190
109
            self.base = os.path.realpath(base)
191
110
            self._make_control()
194
113
        else:
195
114
            self.base = os.path.realpath(base)
196
115
            if not isdir(self.controlfilename('.')):
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'])
 
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'])
201
119
        self._check_format()
 
120
        self.lock(lock_mode)
202
121
 
203
122
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
123
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
212
131
    __repr__ = __str__
213
132
 
214
133
 
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
 
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
 
 
149
            try:
 
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
 
260
182
 
261
183
    def abspath(self, name):
262
184
        """Return absolute filename for something in the branch"""
263
185
        return os.path.join(self.base, name)
264
186
 
 
187
 
265
188
    def relpath(self, path):
266
189
        """Return path relative to this branch of something inside it.
267
190
 
268
191
        Raises an error if path is not in this branch."""
269
 
        return _relpath(self.base, 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
 
        if isinstance(file_or_path, basestring):
 
203
        if isinstance(file_or_path, types.StringTypes):
274
204
            file_or_path = [file_or_path]
275
205
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
276
206
 
300
230
        else:
301
231
            raise BzrError("invalid controlfile mode %r" % mode)
302
232
 
 
233
 
 
234
 
303
235
    def _make_control(self):
304
 
        from bzrlib.inventory import Inventory
305
 
        
306
236
        os.mkdir(self.controlfilename([]))
307
237
        self.controlfile('README', 'w').write(
308
238
            "This is a Bazaar-NG control directory.\n"
309
 
            "Do not change any files in this directory.\n")
 
239
            "Do not change any files in this directory.")
310
240
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
311
241
        for d in ('text-store', 'inventory-store', 'revision-store'):
312
242
            os.mkdir(self.controlfilename(d))
313
243
        for f in ('revision-history', 'merged-patches',
314
244
                  'pending-merged-patches', 'branch-name',
315
 
                  'branch-lock',
316
 
                  'pending-merges'):
 
245
                  'branch-lock'):
317
246
            self.controlfile(f, 'w').write('')
318
247
        mutter('created control directory in ' + self.base)
319
 
 
320
 
        # if we want per-tree root ids then this is the place to set
321
 
        # them; they're not needed for now and so ommitted for
322
 
        # simplicity.
323
 
        f = self.controlfile('inventory','w')
324
 
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
 
248
        Inventory().write_xml(self.controlfile('inventory','w'))
325
249
 
326
250
 
327
251
    def _check_format(self):
336
260
        # on Windows from Linux and so on.  I think it might be better
337
261
        # to always make all internal files in unix format.
338
262
        fmt = self.controlfile('branch-format', 'r').read()
339
 
        fmt = fmt.replace('\r\n', '\n')
 
263
        fmt.replace('\r\n', '')
340
264
        if fmt != BZR_BRANCH_FORMAT:
341
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
342
 
                           ['use a different bzr version',
343
 
                            'or remove the .bzr directory and "bzr init" again'])
344
 
 
345
 
    def get_root_id(self):
346
 
        """Return the id of this branches root"""
347
 
        inv = self.read_working_inventory()
348
 
        return inv.root.file_id
349
 
 
350
 
    def set_root_id(self, file_id):
351
 
        inv = self.read_working_inventory()
352
 
        orig_root_id = inv.root.file_id
353
 
        del inv._byid[inv.root.file_id]
354
 
        inv.root.file_id = file_id
355
 
        inv._byid[inv.root.file_id] = inv.root
356
 
        for fid in inv:
357
 
            entry = inv[fid]
358
 
            if entry.parent_id in (None, orig_root_id):
359
 
                entry.parent_id = inv.root.file_id
360
 
        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
 
361
269
 
362
270
    def read_working_inventory(self):
363
271
        """Read the working inventory."""
364
 
        from bzrlib.inventory import Inventory
365
 
        self.lock_read()
366
 
        try:
367
 
            # ElementTree does its own conversion from UTF-8, so open in
368
 
            # binary.
369
 
            f = self.controlfile('inventory', 'rb')
370
 
            return bzrlib.xml.serializer_v4.read_inventory(f)
371
 
        finally:
372
 
            self.unlock()
373
 
            
 
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
 
374
281
 
375
282
    def _write_inventory(self, inv):
376
283
        """Update the working inventory.
378
285
        That is to say, the inventory describing changes underway, that
379
286
        will be committed to the next revision.
380
287
        """
381
 
        from bzrlib.atomicfile import AtomicFile
382
 
        
383
 
        self.lock_write()
384
 
        try:
385
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
386
 
            try:
387
 
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
388
 
                f.commit()
389
 
            finally:
390
 
                f.close()
391
 
        finally:
392
 
            self.unlock()
393
 
        
 
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)
394
299
        mutter('wrote working inventory')
395
 
            
 
300
 
396
301
 
397
302
    inventory = property(read_working_inventory, _write_inventory, None,
398
303
                         """Inventory for the working copy.""")
399
304
 
400
305
 
401
 
    def add(self, files, ids=None):
 
306
    def add(self, files, verbose=False):
402
307
        """Make files versioned.
403
308
 
404
 
        Note that the command line normally calls smart_add instead,
405
 
        which can automatically recurse.
 
309
        Note that the command line normally calls smart_add instead.
406
310
 
407
311
        This puts the files in the Added state, so that they will be
408
312
        recorded by the next commit.
409
313
 
410
 
        files
411
 
            List of paths to add, relative to the base of the tree.
412
 
 
413
 
        ids
414
 
            If set, use these instead of automatically generated ids.
415
 
            Must be the same length as the list of files, but may
416
 
            contain None for ids that are to be autogenerated.
417
 
 
418
314
        TODO: Perhaps have an option to add the ids even if the files do
419
 
              not (yet) exist.
420
 
 
421
 
        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.
422
325
        """
 
326
        self._need_writelock()
 
327
 
423
328
        # TODO: Re-adding a file that is removed in the working copy
424
329
        # should probably put it back with the previous ID.
425
 
        if isinstance(files, basestring):
426
 
            assert(ids is None or isinstance(ids, basestring))
 
330
        if isinstance(files, types.StringTypes):
427
331
            files = [files]
428
 
            if ids is not None:
429
 
                ids = [ids]
430
 
 
431
 
        if ids is None:
432
 
            ids = [None] * len(files)
433
 
        else:
434
 
            assert(len(ids) == len(files))
435
 
 
436
 
        self.lock_write()
437
 
        try:
438
 
            inv = self.read_working_inventory()
439
 
            for f,file_id in zip(files, ids):
440
 
                if is_control_file(f):
441
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
442
 
 
443
 
                fp = splitpath(f)
444
 
 
445
 
                if len(fp) == 0:
446
 
                    raise BzrError("cannot add top-level %r" % f)
447
 
 
448
 
                fullpath = os.path.normpath(self.abspath(f))
449
 
 
450
 
                try:
451
 
                    kind = file_kind(fullpath)
452
 
                except OSError:
453
 
                    # maybe something better?
454
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
455
 
 
456
 
                if kind != 'file' and kind != 'directory':
457
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
 
 
459
 
                if file_id is None:
460
 
                    file_id = gen_file_id(f)
461
 
                inv.add_path(f, kind=kind, file_id=file_id)
462
 
 
463
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
464
 
 
465
 
            self._write_inventory(inv)
466
 
        finally:
467
 
            self.unlock()
468
 
            
 
332
        
 
333
        inv = self.read_working_inventory()
 
334
        for f in files:
 
335
            if is_control_file(f):
 
336
                bailout("cannot add control file %s" % quotefn(f))
 
337
 
 
338
            fp = splitpath(f)
 
339
 
 
340
            if len(fp) == 0:
 
341
                bailout("cannot add top-level %r" % f)
 
342
                
 
343
            fullpath = os.path.normpath(self.abspath(f))
 
344
 
 
345
            try:
 
346
                kind = file_kind(fullpath)
 
347
            except OSError:
 
348
                # maybe something better?
 
349
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
350
            
 
351
            if kind != 'file' and kind != 'directory':
 
352
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
353
 
 
354
            file_id = gen_file_id(f)
 
355
            inv.add_path(f, kind=kind, file_id=file_id)
 
356
 
 
357
            if verbose:
 
358
                show_status('A', kind, quotefn(f))
 
359
                
 
360
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
361
            
 
362
        self._write_inventory(inv)
 
363
 
469
364
 
470
365
    def print_file(self, file, revno):
471
366
        """Print `file` to stdout."""
472
 
        self.lock_read()
473
 
        try:
474
 
            tree = self.revision_tree(self.lookup_revision(revno))
475
 
            # use inventory as it was in that revision
476
 
            file_id = tree.inventory.path2id(file)
477
 
            if not file_id:
478
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
479
 
            tree.print_file(file_id)
480
 
        finally:
481
 
            self.unlock()
482
 
 
 
367
        self._need_readlock()
 
368
        tree = self.revision_tree(self.lookup_revision(revno))
 
369
        # use inventory as it was in that revision
 
370
        file_id = tree.inventory.path2id(file)
 
371
        if not file_id:
 
372
            bailout("%r is not present in revision %d" % (file, revno))
 
373
        tree.print_file(file_id)
 
374
        
483
375
 
484
376
    def remove(self, files, verbose=False):
485
377
        """Mark nominated files for removal from the inventory.
497
389
        """
498
390
        ## TODO: Normalize names
499
391
        ## TODO: Remove nested loops; better scalability
500
 
        if isinstance(files, basestring):
 
392
        self._need_writelock()
 
393
 
 
394
        if isinstance(files, types.StringTypes):
501
395
            files = [files]
502
 
 
503
 
        self.lock_write()
504
 
 
505
 
        try:
506
 
            tree = self.working_tree()
507
 
            inv = tree.inventory
508
 
 
509
 
            # do this before any modifications
510
 
            for f in files:
511
 
                fid = inv.path2id(f)
512
 
                if not fid:
513
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
514
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
515
 
                if verbose:
516
 
                    # having remove it, it must be either ignored or unknown
517
 
                    if tree.is_ignored(f):
518
 
                        new_status = 'I'
519
 
                    else:
520
 
                        new_status = '?'
521
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
522
 
                del inv[fid]
523
 
 
524
 
            self._write_inventory(inv)
525
 
        finally:
526
 
            self.unlock()
527
 
 
528
 
 
529
 
    # FIXME: this doesn't need to be a branch method
530
 
    def set_inventory(self, new_inventory_list):
531
 
        from bzrlib.inventory import Inventory, InventoryEntry
532
 
        inv = Inventory(self.get_root_id())
533
 
        for path, file_id, parent, kind in new_inventory_list:
534
 
            name = os.path.basename(path)
535
 
            if name == "":
536
 
                continue
537
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
396
        
 
397
        tree = self.working_tree()
 
398
        inv = tree.inventory
 
399
 
 
400
        # do this before any modifications
 
401
        for f in files:
 
402
            fid = inv.path2id(f)
 
403
            if not fid:
 
404
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
405
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
406
            if verbose:
 
407
                # having remove it, it must be either ignored or unknown
 
408
                if tree.is_ignored(f):
 
409
                    new_status = 'I'
 
410
                else:
 
411
                    new_status = '?'
 
412
                show_status(new_status, inv[fid].kind, quotefn(f))
 
413
            del inv[fid]
 
414
 
538
415
        self._write_inventory(inv)
539
416
 
540
417
 
557
434
        return self.working_tree().unknowns()
558
435
 
559
436
 
560
 
    def append_revision(self, *revision_ids):
561
 
        from bzrlib.atomicfile import AtomicFile
562
 
 
563
 
        for revision_id in revision_ids:
564
 
            mutter("add {%s} to revision-history" % revision_id)
565
 
 
 
437
    def append_revision(self, revision_id):
 
438
        mutter("add {%s} to revision-history" % revision_id)
566
439
        rev_history = self.revision_history()
567
 
        rev_history.extend(revision_ids)
568
 
 
569
 
        f = AtomicFile(self.controlfilename('revision-history'))
570
 
        try:
571
 
            for rev_id in rev_history:
572
 
                print >>f, rev_id
573
 
            f.commit()
574
 
        finally:
575
 
            f.close()
576
 
 
577
 
 
578
 
    def get_revision_xml_file(self, revision_id):
579
 
        """Return XML file object for revision object."""
580
 
        if not revision_id or not isinstance(revision_id, basestring):
581
 
            raise InvalidRevisionId(revision_id)
582
 
 
583
 
        self.lock_read()
584
 
        try:
585
 
            try:
586
 
                return self.revision_store[revision_id]
587
 
            except KeyError:
588
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
589
 
        finally:
590
 
            self.unlock()
591
 
 
592
 
 
593
 
    #deprecated
594
 
    get_revision_xml = get_revision_xml_file
 
440
 
 
441
        tmprhname = self.controlfilename('revision-history.tmp')
 
442
        rhname = self.controlfilename('revision-history')
 
443
        
 
444
        f = file(tmprhname, 'wt')
 
445
        rev_history.append(revision_id)
 
446
        f.write('\n'.join(rev_history))
 
447
        f.write('\n')
 
448
        f.close()
 
449
 
 
450
        if sys.platform == 'win32':
 
451
            os.remove(rhname)
 
452
        os.rename(tmprhname, rhname)
 
453
        
595
454
 
596
455
 
597
456
    def get_revision(self, revision_id):
598
457
        """Return the Revision object for a named revision"""
599
 
        xml_file = self.get_revision_xml_file(revision_id)
600
 
 
601
 
        try:
602
 
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
603
 
        except SyntaxError, e:
604
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
605
 
                                         [revision_id,
606
 
                                          str(e)])
607
 
            
 
458
        self._need_readlock()
 
459
        r = Revision.read_xml(self.revision_store[revision_id])
608
460
        assert r.revision_id == revision_id
609
461
        return r
610
462
 
611
463
 
612
 
    def get_revision_delta(self, revno):
613
 
        """Return the delta for one revision.
614
 
 
615
 
        The delta is relative to its mainline predecessor, or the
616
 
        empty tree for revision 1.
617
 
        """
618
 
        assert isinstance(revno, int)
619
 
        rh = self.revision_history()
620
 
        if not (1 <= revno <= len(rh)):
621
 
            raise InvalidRevisionNumber(revno)
622
 
 
623
 
        # revno is 1-based; list is 0-based
624
 
 
625
 
        new_tree = self.revision_tree(rh[revno-1])
626
 
        if revno == 1:
627
 
            old_tree = EmptyTree()
628
 
        else:
629
 
            old_tree = self.revision_tree(rh[revno-2])
630
 
 
631
 
        return compare_trees(old_tree, new_tree)
632
 
 
633
 
        
634
 
 
635
 
    def get_revision_sha1(self, revision_id):
636
 
        """Hash the stored value of a revision, and return it."""
637
 
        # In the future, revision entries will be signed. At that
638
 
        # point, it is probably best *not* to include the signature
639
 
        # in the revision hash. Because that lets you re-sign
640
 
        # the revision, (add signatures/remove signatures) and still
641
 
        # have all hash pointers stay consistent.
642
 
        # But for now, just hash the contents.
643
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
644
 
 
645
 
 
646
464
    def get_inventory(self, inventory_id):
647
465
        """Get Inventory object by hash.
648
466
 
649
467
        TODO: Perhaps for this and similar methods, take a revision
650
468
               parameter which can be either an integer revno or a
651
469
               string hash."""
652
 
        from bzrlib.inventory import Inventory
653
 
 
654
 
        f = self.get_inventory_xml_file(inventory_id)
655
 
        return bzrlib.xml.serializer_v4.read_inventory(f)
656
 
 
657
 
 
658
 
    def get_inventory_xml(self, inventory_id):
659
 
        """Get inventory XML as a file object."""
660
 
        return self.inventory_store[inventory_id]
661
 
 
662
 
    get_inventory_xml_file = get_inventory_xml
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))
 
470
        self._need_readlock()
 
471
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
472
        return i
669
473
 
670
474
 
671
475
    def get_revision_inventory(self, revision_id):
672
476
        """Return inventory of a past revision."""
673
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
674
 
        # must be the same as its revision, so this is trivial.
 
477
        self._need_readlock()
675
478
        if revision_id == None:
676
 
            from bzrlib.inventory import Inventory
677
 
            return Inventory(self.get_root_id())
 
479
            return Inventory()
678
480
        else:
679
 
            return self.get_inventory(revision_id)
 
481
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
680
482
 
681
483
 
682
484
    def revision_history(self):
685
487
        >>> ScratchBranch().revision_history()
686
488
        []
687
489
        """
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
 
490
        self._need_readlock()
 
491
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
492
 
 
493
 
 
494
    def enum_history(self, direction):
 
495
        """Return (revno, revision_id) for history of branch.
 
496
 
 
497
        direction
 
498
            'forward' is from earliest to latest
 
499
            'reverse' is from latest to earliest
 
500
        """
 
501
        rh = self.revision_history()
 
502
        if direction == 'forward':
 
503
            i = 1
 
504
            for rid in rh:
 
505
                yield i, rid
 
506
                i += 1
 
507
        elif direction == 'reverse':
 
508
            i = len(rh)
 
509
            while i > 0:
 
510
                yield i, rh[i-1]
 
511
                i -= 1
 
512
        else:
 
513
            raise BzrError('invalid history direction %r' % direction)
739
514
 
740
515
 
741
516
    def revno(self):
757
532
            return None
758
533
 
759
534
 
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
 
        from bzrlib.revision import get_intervening_revisions
809
 
 
810
 
        pb = bzrlib.ui.ui_factory.progress_bar()
811
 
        pb.update('comparing histories')
812
 
        if stop_revision is None:
813
 
            other_revision = other.last_patch()
814
 
        else:
815
 
            other_revision = other.lookup_revision(stop_revision)
816
 
        count = greedy_fetch(self, other, other_revision, pb)[0]
817
 
        try:
818
 
            revision_ids = self.missing_revisions(other, stop_revision)
819
 
        except DivergedBranches, e:
820
 
            try:
821
 
                revision_ids = get_intervening_revisions(self.last_patch(), 
822
 
                                                         other_revision, self)
823
 
                assert self.last_patch() not in revision_ids
824
 
            except bzrlib.errors.NotAncestor:
825
 
                raise e
826
 
 
827
 
        self.append_revision(*revision_ids)
828
 
        pb.clear()
829
 
 
830
 
    def install_revisions(self, other, revision_ids, pb):
831
 
        if hasattr(other.revision_store, "prefetch"):
832
 
            other.revision_store.prefetch(revision_ids)
833
 
        if hasattr(other.inventory_store, "prefetch"):
834
 
            inventory_ids = []
835
 
            for rev_id in revision_ids:
836
 
                try:
837
 
                    revision = other.get_revision(rev_id).inventory_id
838
 
                    inventory_ids.append(revision)
839
 
                except bzrlib.errors.NoSuchRevision:
840
 
                    pass
841
 
            other.inventory_store.prefetch(inventory_ids)
842
 
 
843
 
        if pb is None:
844
 
            pb = bzrlib.ui.ui_factory.progress_bar()
845
 
                
846
 
        revisions = []
847
 
        needed_texts = set()
848
 
        i = 0
849
 
 
850
 
        failures = set()
851
 
        for i, rev_id in enumerate(revision_ids):
852
 
            pb.update('fetching revision', i+1, len(revision_ids))
853
 
            try:
854
 
                rev = other.get_revision(rev_id)
855
 
            except bzrlib.errors.NoSuchRevision:
856
 
                failures.add(rev_id)
857
 
                continue
858
 
 
859
 
            revisions.append(rev)
860
 
            inv = other.get_inventory(str(rev.inventory_id))
861
 
            for key, entry in inv.iter_entries():
862
 
                if entry.text_id is None:
863
 
                    continue
864
 
                if entry.text_id not in self.text_store:
865
 
                    needed_texts.add(entry.text_id)
866
 
 
867
 
        pb.clear()
868
 
                    
869
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
870
 
                                                    needed_texts)
871
 
        #print "Added %d texts." % count 
872
 
        inventory_ids = [ f.inventory_id for f in revisions ]
873
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
874
 
                                                         inventory_ids)
875
 
        #print "Added %d inventories." % count 
876
 
        revision_ids = [ f.revision_id for f in revisions]
877
 
 
878
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
879
 
                                                          revision_ids,
880
 
                                                          permit_failure=True)
881
 
        assert len(cp_fail) == 0 
882
 
        return count, failures
883
 
       
884
 
 
885
535
    def commit(self, *args, **kw):
 
536
        """Deprecated"""
886
537
        from bzrlib.commit import commit
887
538
        commit(self, *args, **kw)
888
539
        
889
540
 
890
 
    def lookup_revision(self, revision):
891
 
        """Return the revision identifier for a given revision information."""
892
 
        revno, info = self._get_revision_info(revision)
893
 
        return info
894
 
 
895
 
 
896
 
    def revision_id_to_revno(self, revision_id):
897
 
        """Given a revision id, return its revno"""
898
 
        history = self.revision_history()
899
 
        try:
900
 
            return history.index(revision_id) + 1
901
 
        except ValueError:
902
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
903
 
 
904
 
 
905
 
    def get_revision_info(self, revision):
906
 
        """Return (revno, revision id) for revision identifier.
907
 
 
908
 
        revision can be an integer, in which case it is assumed to be revno (though
909
 
            this will translate negative values into positive ones)
910
 
        revision can also be a string, in which case it is parsed for something like
911
 
            'date:' or 'revid:' etc.
912
 
        """
913
 
        revno, rev_id = self._get_revision_info(revision)
914
 
        if revno is None:
915
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
916
 
        return revno, rev_id
917
 
 
918
 
    def get_rev_id(self, revno, history=None):
919
 
        """Find the revision id of the specified revno."""
 
541
    def lookup_revision(self, revno):
 
542
        """Return revision hash for revision number."""
920
543
        if revno == 0:
921
544
            return None
922
 
        if history is None:
923
 
            history = self.revision_history()
924
 
        elif revno <= 0 or revno > len(history):
925
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
926
 
        return history[revno - 1]
927
 
 
928
 
    def _get_revision_info(self, revision):
929
 
        """Return (revno, revision id) for revision specifier.
930
 
 
931
 
        revision can be an integer, in which case it is assumed to be revno
932
 
        (though this will translate negative values into positive ones)
933
 
        revision can also be a string, in which case it is parsed for something
934
 
        like 'date:' or 'revid:' etc.
935
 
 
936
 
        A revid is always returned.  If it is None, the specifier referred to
937
 
        the null revision.  If the revid does not occur in the revision
938
 
        history, revno will be None.
939
 
        """
940
 
        
941
 
        if revision is None:
942
 
            return 0, None
943
 
        revno = None
944
 
        try:# Convert to int if possible
945
 
            revision = int(revision)
946
 
        except ValueError:
947
 
            pass
948
 
        revs = self.revision_history()
949
 
        if isinstance(revision, int):
950
 
            if revision < 0:
951
 
                revno = len(revs) + revision + 1
952
 
            else:
953
 
                revno = revision
954
 
            rev_id = self.get_rev_id(revno, revs)
955
 
        elif isinstance(revision, basestring):
956
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
957
 
                if revision.startswith(prefix):
958
 
                    result = func(self, revs, revision)
959
 
                    if len(result) > 1:
960
 
                        revno, rev_id = result
961
 
                    else:
962
 
                        revno = result[0]
963
 
                        rev_id = self.get_rev_id(revno, revs)
964
 
                    break
965
 
            else:
966
 
                raise BzrError('No namespace registered for string: %r' %
967
 
                               revision)
968
 
        else:
969
 
            raise TypeError('Unhandled revision type %s' % revision)
970
 
 
971
 
        if revno is None:
972
 
            if rev_id is None:
973
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
974
 
        return revno, rev_id
975
 
 
976
 
    def _namespace_revno(self, revs, revision):
977
 
        """Lookup a revision by revision number"""
978
 
        assert revision.startswith('revno:')
979
 
        try:
980
 
            return (int(revision[6:]),)
981
 
        except ValueError:
982
 
            return None
983
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
984
 
 
985
 
    def _namespace_revid(self, revs, revision):
986
 
        assert revision.startswith('revid:')
987
 
        rev_id = revision[len('revid:'):]
988
 
        try:
989
 
            return revs.index(rev_id) + 1, rev_id
990
 
        except ValueError:
991
 
            return None, rev_id
992
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
993
 
 
994
 
    def _namespace_last(self, revs, revision):
995
 
        assert revision.startswith('last:')
996
 
        try:
997
 
            offset = int(revision[5:])
998
 
        except ValueError:
999
 
            return (None,)
1000
 
        else:
1001
 
            if offset <= 0:
1002
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
1003
 
            return (len(revs) - offset + 1,)
1004
 
    REVISION_NAMESPACES['last:'] = _namespace_last
1005
 
 
1006
 
    def _namespace_tag(self, revs, revision):
1007
 
        assert revision.startswith('tag:')
1008
 
        raise BzrError('tag: namespace registered, but not implemented.')
1009
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
1010
 
 
1011
 
    def _namespace_date(self, revs, revision):
1012
 
        assert revision.startswith('date:')
1013
 
        import datetime
1014
 
        # Spec for date revisions:
1015
 
        #   date:value
1016
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1017
 
        #   it can also start with a '+/-/='. '+' says match the first
1018
 
        #   entry after the given date. '-' is match the first entry before the date
1019
 
        #   '=' is match the first entry after, but still on the given date.
1020
 
        #
1021
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1022
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1023
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1024
 
        #       May 13th, 2005 at 0:00
1025
 
        #
1026
 
        #   So the proper way of saying 'give me all entries for today' is:
1027
 
        #       -r {date:+today}:{date:-tomorrow}
1028
 
        #   The default is '=' when not supplied
1029
 
        val = revision[5:]
1030
 
        match_style = '='
1031
 
        if val[:1] in ('+', '-', '='):
1032
 
            match_style = val[:1]
1033
 
            val = val[1:]
1034
 
 
1035
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1036
 
        if val.lower() == 'yesterday':
1037
 
            dt = today - datetime.timedelta(days=1)
1038
 
        elif val.lower() == 'today':
1039
 
            dt = today
1040
 
        elif val.lower() == 'tomorrow':
1041
 
            dt = today + datetime.timedelta(days=1)
1042
 
        else:
1043
 
            import re
1044
 
            # This should be done outside the function to avoid recompiling it.
1045
 
            _date_re = re.compile(
1046
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1047
 
                    r'(,|T)?\s*'
1048
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1049
 
                )
1050
 
            m = _date_re.match(val)
1051
 
            if not m or (not m.group('date') and not m.group('time')):
1052
 
                raise BzrError('Invalid revision date %r' % revision)
1053
 
 
1054
 
            if m.group('date'):
1055
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1056
 
            else:
1057
 
                year, month, day = today.year, today.month, today.day
1058
 
            if m.group('time'):
1059
 
                hour = int(m.group('hour'))
1060
 
                minute = int(m.group('minute'))
1061
 
                if m.group('second'):
1062
 
                    second = int(m.group('second'))
1063
 
                else:
1064
 
                    second = 0
1065
 
            else:
1066
 
                hour, minute, second = 0,0,0
1067
 
 
1068
 
            dt = datetime.datetime(year=year, month=month, day=day,
1069
 
                    hour=hour, minute=minute, second=second)
1070
 
        first = dt
1071
 
        last = None
1072
 
        reversed = False
1073
 
        if match_style == '-':
1074
 
            reversed = True
1075
 
        elif match_style == '=':
1076
 
            last = dt + datetime.timedelta(days=1)
1077
 
 
1078
 
        if reversed:
1079
 
            for i in range(len(revs)-1, -1, -1):
1080
 
                r = self.get_revision(revs[i])
1081
 
                # TODO: Handle timezone.
1082
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1083
 
                if first >= dt and (last is None or dt >= last):
1084
 
                    return (i+1,)
1085
 
        else:
1086
 
            for i in range(len(revs)):
1087
 
                r = self.get_revision(revs[i])
1088
 
                # TODO: Handle timezone.
1089
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1090
 
                if first <= dt and (last is None or dt <= last):
1091
 
                    return (i+1,)
1092
 
    REVISION_NAMESPACES['date:'] = _namespace_date
1093
 
 
1094
 
 
1095
 
    def _namespace_ancestor(self, revs, revision):
1096
 
        from revision import common_ancestor, MultipleRevisionSources
1097
 
        other_branch = find_branch(_trim_namespace('ancestor', revision))
1098
 
        revision_a = self.last_patch()
1099
 
        revision_b = other_branch.last_patch()
1100
 
        for r, b in ((revision_a, self), (revision_b, other_branch)):
1101
 
            if r is None:
1102
 
                raise bzrlib.errors.NoCommits(b)
1103
 
        revision_source = MultipleRevisionSources(self, other_branch)
1104
 
        result = common_ancestor(revision_a, revision_b, revision_source)
1105
 
        try:
1106
 
            revno = self.revision_id_to_revno(result)
1107
 
        except bzrlib.errors.NoSuchRevision:
1108
 
            revno = None
1109
 
        return revno,result
1110
 
        
1111
 
 
1112
 
    REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
 
545
 
 
546
        try:
 
547
            # list is 0-based; revisions are 1-based
 
548
            return self.revision_history()[revno-1]
 
549
        except IndexError:
 
550
            raise BzrError("no such revision %s" % revno)
 
551
 
1113
552
 
1114
553
    def revision_tree(self, revision_id):
1115
554
        """Return Tree for a revision on this branch.
1116
555
 
1117
556
        `revision_id` may be None for the null revision, in which case
1118
557
        an `EmptyTree` is returned."""
1119
 
        # TODO: refactor this to use an existing revision object
1120
 
        # so we don't need to read it in twice.
 
558
        self._need_readlock()
1121
559
        if revision_id == None:
1122
560
            return EmptyTree()
1123
561
        else:
1149
587
 
1150
588
        This can change the directory or the filename or both.
1151
589
        """
1152
 
        self.lock_write()
 
590
        self._need_writelock()
 
591
        tree = self.working_tree()
 
592
        inv = tree.inventory
 
593
        if not tree.has_filename(from_rel):
 
594
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
595
        if tree.has_filename(to_rel):
 
596
            bailout("can't rename: new working file %r already exists" % to_rel)
 
597
            
 
598
        file_id = inv.path2id(from_rel)
 
599
        if file_id == None:
 
600
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
601
 
 
602
        if inv.path2id(to_rel):
 
603
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
604
 
 
605
        to_dir, to_tail = os.path.split(to_rel)
 
606
        to_dir_id = inv.path2id(to_dir)
 
607
        if to_dir_id == None and to_dir != '':
 
608
            bailout("can't determine destination directory id for %r" % to_dir)
 
609
 
 
610
        mutter("rename_one:")
 
611
        mutter("  file_id    {%s}" % file_id)
 
612
        mutter("  from_rel   %r" % from_rel)
 
613
        mutter("  to_rel     %r" % to_rel)
 
614
        mutter("  to_dir     %r" % to_dir)
 
615
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
616
            
 
617
        inv.rename(file_id, to_dir_id, to_tail)
 
618
 
 
619
        print "%s => %s" % (from_rel, to_rel)
 
620
        
 
621
        from_abs = self.abspath(from_rel)
 
622
        to_abs = self.abspath(to_rel)
1153
623
        try:
1154
 
            tree = self.working_tree()
1155
 
            inv = tree.inventory
1156
 
            if not tree.has_filename(from_rel):
1157
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1158
 
            if tree.has_filename(to_rel):
1159
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
1160
 
 
1161
 
            file_id = inv.path2id(from_rel)
1162
 
            if file_id == None:
1163
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1164
 
 
1165
 
            if inv.path2id(to_rel):
1166
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1167
 
 
1168
 
            to_dir, to_tail = os.path.split(to_rel)
1169
 
            to_dir_id = inv.path2id(to_dir)
1170
 
            if to_dir_id == None and to_dir != '':
1171
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
1172
 
 
1173
 
            mutter("rename_one:")
1174
 
            mutter("  file_id    {%s}" % file_id)
1175
 
            mutter("  from_rel   %r" % from_rel)
1176
 
            mutter("  to_rel     %r" % to_rel)
1177
 
            mutter("  to_dir     %r" % to_dir)
1178
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
1179
 
 
1180
 
            inv.rename(file_id, to_dir_id, to_tail)
1181
 
 
1182
 
            from_abs = self.abspath(from_rel)
1183
 
            to_abs = self.abspath(to_rel)
1184
 
            try:
1185
 
                os.rename(from_abs, to_abs)
1186
 
            except OSError, e:
1187
 
                raise BzrError("failed to rename %r to %r: %s"
1188
 
                        % (from_abs, to_abs, e[1]),
1189
 
                        ["rename rolled back"])
1190
 
 
1191
 
            self._write_inventory(inv)
1192
 
        finally:
1193
 
            self.unlock()
 
624
            os.rename(from_abs, to_abs)
 
625
        except OSError, e:
 
626
            bailout("failed to rename %r to %r: %s"
 
627
                    % (from_abs, to_abs, e[1]),
 
628
                    ["rename rolled back"])
 
629
 
 
630
        self._write_inventory(inv)
 
631
            
1194
632
 
1195
633
 
1196
634
    def move(self, from_paths, to_name):
1203
641
 
1204
642
        Note that to_name is only the last component of the new name;
1205
643
        this doesn't change the directory.
1206
 
 
1207
 
        This returns a list of (from_path, to_path) pairs for each
1208
 
        entry that is moved.
1209
 
        """
1210
 
        result = []
1211
 
        self.lock_write()
1212
 
        try:
1213
 
            ## TODO: Option to move IDs only
1214
 
            assert not isinstance(from_paths, basestring)
1215
 
            tree = self.working_tree()
1216
 
            inv = tree.inventory
1217
 
            to_abs = self.abspath(to_name)
1218
 
            if not isdir(to_abs):
1219
 
                raise BzrError("destination %r is not a directory" % to_abs)
1220
 
            if not tree.has_filename(to_name):
1221
 
                raise BzrError("destination %r not in working directory" % to_abs)
1222
 
            to_dir_id = inv.path2id(to_name)
1223
 
            if to_dir_id == None and to_name != '':
1224
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1225
 
            to_dir_ie = inv[to_dir_id]
1226
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1227
 
                raise BzrError("destination %r is not a directory" % to_abs)
1228
 
 
1229
 
            to_idpath = inv.get_idpath(to_dir_id)
1230
 
 
1231
 
            for f in from_paths:
1232
 
                if not tree.has_filename(f):
1233
 
                    raise BzrError("%r does not exist in working tree" % f)
1234
 
                f_id = inv.path2id(f)
1235
 
                if f_id == None:
1236
 
                    raise BzrError("%r is not versioned" % f)
1237
 
                name_tail = splitpath(f)[-1]
1238
 
                dest_path = appendpath(to_name, name_tail)
1239
 
                if tree.has_filename(dest_path):
1240
 
                    raise BzrError("destination %r already exists" % dest_path)
1241
 
                if f_id in to_idpath:
1242
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1243
 
 
1244
 
            # OK, so there's a race here, it's possible that someone will
1245
 
            # create a file in this interval and then the rename might be
1246
 
            # left half-done.  But we should have caught most problems.
1247
 
 
1248
 
            for f in from_paths:
1249
 
                name_tail = splitpath(f)[-1]
1250
 
                dest_path = appendpath(to_name, name_tail)
1251
 
                result.append((f, dest_path))
1252
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1253
 
                try:
1254
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1255
 
                except OSError, e:
1256
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1257
 
                            ["rename rolled back"])
1258
 
 
1259
 
            self._write_inventory(inv)
1260
 
        finally:
1261
 
            self.unlock()
1262
 
 
1263
 
        return result
1264
 
 
1265
 
 
1266
 
    def revert(self, filenames, old_tree=None, backups=True):
1267
 
        """Restore selected files to the versions from a previous tree.
1268
 
 
1269
 
        backups
1270
 
            If true (default) backups are made of files before
1271
 
            they're renamed.
1272
 
        """
1273
 
        from bzrlib.errors import NotVersionedError, BzrError
1274
 
        from bzrlib.atomicfile import AtomicFile
1275
 
        from bzrlib.osutils import backup_file
1276
 
        
1277
 
        inv = self.read_working_inventory()
1278
 
        if old_tree is None:
1279
 
            old_tree = self.basis_tree()
1280
 
        old_inv = old_tree.inventory
1281
 
 
1282
 
        nids = []
1283
 
        for fn in filenames:
1284
 
            file_id = inv.path2id(fn)
1285
 
            if not file_id:
1286
 
                raise NotVersionedError("not a versioned file", fn)
1287
 
            if not old_inv.has_id(file_id):
1288
 
                raise BzrError("file not present in old tree", fn, file_id)
1289
 
            nids.append((fn, file_id))
1290
 
            
1291
 
        # TODO: Rename back if it was previously at a different location
1292
 
 
1293
 
        # TODO: If given a directory, restore the entire contents from
1294
 
        # the previous version.
1295
 
 
1296
 
        # TODO: Make a backup to a temporary file.
1297
 
 
1298
 
        # TODO: If the file previously didn't exist, delete it?
1299
 
        for fn, file_id in nids:
1300
 
            backup_file(fn)
1301
 
            
1302
 
            f = AtomicFile(fn, 'wb')
1303
 
            try:
1304
 
                f.write(old_tree.get_file(file_id).read())
1305
 
                f.commit()
1306
 
            finally:
1307
 
                f.close()
1308
 
 
1309
 
 
1310
 
    def pending_merges(self):
1311
 
        """Return a list of pending merges.
1312
 
 
1313
 
        These are revisions that have been merged into the working
1314
 
        directory but not yet committed.
1315
 
        """
1316
 
        cfn = self.controlfilename('pending-merges')
1317
 
        if not os.path.exists(cfn):
1318
 
            return []
1319
 
        p = []
1320
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1321
 
            p.append(l.rstrip('\n'))
1322
 
        return p
1323
 
 
1324
 
 
1325
 
    def add_pending_merge(self, revision_id):
1326
 
        from bzrlib.revision import validate_revision_id
1327
 
 
1328
 
        validate_revision_id(revision_id)
1329
 
 
1330
 
        p = self.pending_merges()
1331
 
        if revision_id in p:
1332
 
            return
1333
 
        p.append(revision_id)
1334
 
        self.set_pending_merges(p)
1335
 
 
1336
 
 
1337
 
    def set_pending_merges(self, rev_list):
1338
 
        from bzrlib.atomicfile import AtomicFile
1339
 
        self.lock_write()
1340
 
        try:
1341
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1342
 
            try:
1343
 
                for l in rev_list:
1344
 
                    print >>f, l
1345
 
                f.commit()
1346
 
            finally:
1347
 
                f.close()
1348
 
        finally:
1349
 
            self.unlock()
1350
 
 
1351
 
 
1352
 
    def get_parent(self):
1353
 
        """Return the parent location of the branch.
1354
 
 
1355
 
        This is the default location for push/pull/missing.  The usual
1356
 
        pattern is that the user can override it by specifying a
1357
 
        location.
1358
 
        """
1359
 
        import errno
1360
 
        _locs = ['parent', 'pull', 'x-pull']
1361
 
        for l in _locs:
1362
 
            try:
1363
 
                return self.controlfile(l, 'r').read().strip('\n')
1364
 
            except IOError, e:
1365
 
                if e.errno != errno.ENOENT:
1366
 
                    raise
1367
 
        return None
1368
 
 
1369
 
 
1370
 
    def set_parent(self, url):
1371
 
        # TODO: Maybe delete old location files?
1372
 
        from bzrlib.atomicfile import AtomicFile
1373
 
        self.lock_write()
1374
 
        try:
1375
 
            f = AtomicFile(self.controlfilename('parent'))
1376
 
            try:
1377
 
                f.write(url + '\n')
1378
 
                f.commit()
1379
 
            finally:
1380
 
                f.close()
1381
 
        finally:
1382
 
            self.unlock()
1383
 
 
1384
 
    def check_revno(self, revno):
1385
 
        """\
1386
 
        Check whether a revno corresponds to any revision.
1387
 
        Zero (the NULL revision) is considered valid.
1388
 
        """
1389
 
        if revno != 0:
1390
 
            self.check_real_revno(revno)
1391
 
            
1392
 
    def check_real_revno(self, revno):
1393
 
        """\
1394
 
        Check whether a revno corresponds to a real revision.
1395
 
        Zero (the NULL revision) is considered invalid
1396
 
        """
1397
 
        if revno < 1 or revno > self.revno():
1398
 
            raise InvalidRevisionNumber(revno)
1399
 
        
1400
 
        
 
644
        """
 
645
        self._need_writelock()
 
646
        ## TODO: Option to move IDs only
 
647
        assert not isinstance(from_paths, basestring)
 
648
        tree = self.working_tree()
 
649
        inv = tree.inventory
 
650
        to_abs = self.abspath(to_name)
 
651
        if not isdir(to_abs):
 
652
            bailout("destination %r is not a directory" % to_abs)
 
653
        if not tree.has_filename(to_name):
 
654
            bailout("destination %r not in working directory" % to_abs)
 
655
        to_dir_id = inv.path2id(to_name)
 
656
        if to_dir_id == None and to_name != '':
 
657
            bailout("destination %r is not a versioned directory" % to_name)
 
658
        to_dir_ie = inv[to_dir_id]
 
659
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
660
            bailout("destination %r is not a directory" % to_abs)
 
661
 
 
662
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
663
 
 
664
        for f in from_paths:
 
665
            if not tree.has_filename(f):
 
666
                bailout("%r does not exist in working tree" % f)
 
667
            f_id = inv.path2id(f)
 
668
            if f_id == None:
 
669
                bailout("%r is not versioned" % f)
 
670
            name_tail = splitpath(f)[-1]
 
671
            dest_path = appendpath(to_name, name_tail)
 
672
            if tree.has_filename(dest_path):
 
673
                bailout("destination %r already exists" % dest_path)
 
674
            if f_id in to_idpath:
 
675
                bailout("can't move %r to a subdirectory of itself" % f)
 
676
 
 
677
        # OK, so there's a race here, it's possible that someone will
 
678
        # create a file in this interval and then the rename might be
 
679
        # left half-done.  But we should have caught most problems.
 
680
 
 
681
        for f in from_paths:
 
682
            name_tail = splitpath(f)[-1]
 
683
            dest_path = appendpath(to_name, name_tail)
 
684
            print "%s => %s" % (f, dest_path)
 
685
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
686
            try:
 
687
                os.rename(self.abspath(f), self.abspath(dest_path))
 
688
            except OSError, e:
 
689
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
690
                        ["rename rolled back"])
 
691
 
 
692
        self._write_inventory(inv)
 
693
 
 
694
 
1401
695
 
1402
696
 
1403
697
class ScratchBranch(Branch):
1411
705
    >>> isdir(bd)
1412
706
    False
1413
707
    """
1414
 
    def __init__(self, files=[], dirs=[], base=None):
 
708
    def __init__(self, files=[], dirs=[]):
1415
709
        """Make a test branch.
1416
710
 
1417
711
        This creates a temporary directory and runs init-tree in it.
1418
712
 
1419
713
        If any files are listed, they are created in the working copy.
1420
714
        """
1421
 
        from tempfile import mkdtemp
1422
 
        init = False
1423
 
        if base is None:
1424
 
            base = mkdtemp()
1425
 
            init = True
1426
 
        Branch.__init__(self, base, init=init)
 
715
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1427
716
        for d in dirs:
1428
717
            os.mkdir(self.abspath(d))
1429
718
            
1431
720
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1432
721
 
1433
722
 
1434
 
    def clone(self):
1435
 
        """
1436
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1437
 
        >>> clone = orig.clone()
1438
 
        >>> os.path.samefile(orig.base, clone.base)
1439
 
        False
1440
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1441
 
        True
1442
 
        """
1443
 
        from shutil import copytree
1444
 
        from tempfile import mkdtemp
1445
 
        base = mkdtemp()
1446
 
        os.rmdir(base)
1447
 
        copytree(self.base, base, symlinks=True)
1448
 
        return ScratchBranch(base=base)
1449
 
 
1450
 
 
1451
 
        
1452
723
    def __del__(self):
1453
724
        self.destroy()
1454
725
 
1455
726
    def destroy(self):
1456
727
        """Destroy the test branch, removing the scratch directory."""
1457
 
        from shutil import rmtree
1458
728
        try:
1459
 
            if self.base:
1460
 
                mutter("delete ScratchBranch %s" % self.base)
1461
 
                rmtree(self.base)
 
729
            mutter("delete ScratchBranch %s" % self.base)
 
730
            shutil.rmtree(self.base)
1462
731
        except OSError, e:
1463
732
            # Work around for shutil.rmtree failing on Windows when
1464
733
            # readonly files are encountered
1466
735
            for root, dirs, files in os.walk(self.base, topdown=False):
1467
736
                for name in files:
1468
737
                    os.chmod(os.path.join(root, name), 0700)
1469
 
            rmtree(self.base)
 
738
            shutil.rmtree(self.base)
1470
739
        self.base = None
1471
740
 
1472
741
    
1496
765
    This should probably generate proper UUIDs, but for the moment we
1497
766
    cope with just randomness because running uuidgen every time is
1498
767
    slow."""
1499
 
    import re
1500
 
    from binascii import hexlify
1501
 
    from time import time
1502
 
 
1503
 
    # get last component
1504
768
    idx = name.rfind('/')
1505
769
    if idx != -1:
1506
770
        name = name[idx+1 : ]
1508
772
    if idx != -1:
1509
773
        name = name[idx+1 : ]
1510
774
 
1511
 
    # make it not a hidden file
1512
775
    name = name.lstrip('.')
1513
776
 
1514
 
    # remove any wierd characters; we don't escape them but rather
1515
 
    # just pull them out
1516
 
    name = re.sub(r'[^\w.]', '', name)
1517
 
 
1518
777
    s = hexlify(rand_bytes(8))
1519
 
    return '-'.join((name, compact_date(time()), s))
1520
 
 
1521
 
 
1522
 
def gen_root_id():
1523
 
    """Return a new tree-root file id."""
1524
 
    return gen_file_id('TREE_ROOT')
1525
 
 
1526
 
 
1527
 
def pull_loc(branch):
1528
 
    # TODO: Should perhaps just make attribute be 'base' in
1529
 
    # RemoteBranch and Branch?
1530
 
    if hasattr(branch, "baseurl"):
1531
 
        return branch.baseurl
1532
 
    else:
1533
 
        return branch.base
1534
 
 
1535
 
 
1536
 
def copy_branch(branch_from, to_location, revision=None):
1537
 
    """Copy branch_from into the existing directory to_location.
1538
 
 
1539
 
    revision
1540
 
        If not None, only revisions up to this point will be copied.
1541
 
        The head of the new branch will be that revision.
1542
 
 
1543
 
    to_location
1544
 
        The name of a local directory that exists but is empty.
1545
 
    """
1546
 
    from bzrlib.merge import merge
1547
 
    from bzrlib.branch import Branch
1548
 
 
1549
 
    assert isinstance(branch_from, Branch)
1550
 
    assert isinstance(to_location, basestring)
1551
 
    
1552
 
    br_to = Branch(to_location, init=True)
1553
 
    br_to.set_root_id(branch_from.get_root_id())
1554
 
    if revision is None:
1555
 
        revno = branch_from.revno()
1556
 
    else:
1557
 
        revno, rev_id = branch_from.get_revision_info(revision)
1558
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1559
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1560
 
          check_clean=False, ignore_zero=True)
1561
 
    
1562
 
    from_location = pull_loc(branch_from)
1563
 
    br_to.set_parent(pull_loc(branch_from))
1564
 
    return br_to
1565
 
 
1566
 
def _trim_namespace(namespace, spec):
1567
 
    full_namespace = namespace + ':'
1568
 
    assert spec.startswith(full_namespace)
1569
 
    return spec[len(full_namespace):]
 
778
    return '-'.join((name, compact_date(time.time()), s))