/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-12 02:18:48 UTC
  • Revision ID: mbp@sourcefrog.net-20050512021848-d1a727373aee2c85
- WorkingTree loads statcache in constructor and holds
  it permanently

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
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
 
23
 
 
24
import bzrlib
 
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
 
36
 
 
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
38
## TODO: Maybe include checks for common corruption of newlines, etc?
 
39
 
 
40
 
 
41
 
 
42
def find_branch(f, **args):
 
43
    if f and (f.startswith('http://') or f.startswith('https://')):
 
44
        import remotebranch 
 
45
        return remotebranch.RemoteBranch(f, **args)
 
46
    else:
 
47
        return Branch(f, **args)
 
48
        
 
49
 
 
50
def find_branch_root(f=None):
 
51
    """Find the branch root enclosing f, or pwd.
 
52
 
 
53
    f may be a filename or a URL.
 
54
 
 
55
    It is not necessary that f exists.
 
56
 
 
57
    Basically we keep looking up until we find the control directory or
 
58
    run into the root."""
 
59
    if f == None:
 
60
        f = os.getcwd()
 
61
    elif hasattr(os.path, 'realpath'):
 
62
        f = os.path.realpath(f)
 
63
    else:
 
64
        f = os.path.abspath(f)
 
65
    if not os.path.exists(f):
 
66
        raise BzrError('%r does not exist' % f)
 
67
        
 
68
 
 
69
    orig_f = f
 
70
 
 
71
    while True:
 
72
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
73
            return f
 
74
        head, tail = os.path.split(f)
 
75
        if head == f:
 
76
            # reached the root, whatever that may be
 
77
            raise BzrError('%r is not in a branch' % orig_f)
 
78
        f = head
 
79
    
 
80
 
 
81
 
 
82
######################################################################
 
83
# branch objects
 
84
 
 
85
class Branch:
 
86
    """Branch holding a history of revisions.
 
87
 
 
88
    base
 
89
        Base directory of the branch.
 
90
    """
 
91
    _lockmode = None
 
92
    
 
93
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
94
        """Create new branch object at a particular location.
 
95
 
 
96
        base -- Base directory for the branch.
 
97
        
 
98
        init -- If True, create new control files in a previously
 
99
             unversioned directory.  If False, the branch must already
 
100
             be versioned.
 
101
 
 
102
        find_root -- If true and init is false, find the root of the
 
103
             existing branch containing base.
 
104
 
 
105
        In the test suite, creation of new trees is tested using the
 
106
        `ScratchBranch` class.
 
107
        """
 
108
        if init:
 
109
            self.base = os.path.realpath(base)
 
110
            self._make_control()
 
111
        elif find_root:
 
112
            self.base = find_branch_root(base)
 
113
        else:
 
114
            self.base = os.path.realpath(base)
 
115
            if not isdir(self.controlfilename('.')):
 
116
                bailout("not a bzr branch: %s" % quotefn(base),
 
117
                        ['use "bzr init" to initialize a new working tree',
 
118
                         'current bzr can only operate from top-of-tree'])
 
119
        self._check_format()
 
120
        self.lock(lock_mode)
 
121
 
 
122
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
123
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
124
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
125
 
 
126
 
 
127
    def __str__(self):
 
128
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
129
 
 
130
 
 
131
    __repr__ = __str__
 
132
 
 
133
 
 
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
 
 
182
 
 
183
    def abspath(self, name):
 
184
        """Return absolute filename for something in the branch"""
 
185
        return os.path.join(self.base, name)
 
186
 
 
187
 
 
188
    def relpath(self, path):
 
189
        """Return path relative to this branch of something inside it.
 
190
 
 
191
        Raises an error if path is not in this branch."""
 
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
 
 
200
 
 
201
    def controlfilename(self, file_or_path):
 
202
        """Return location relative to branch."""
 
203
        if isinstance(file_or_path, types.StringTypes):
 
204
            file_or_path = [file_or_path]
 
205
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
206
 
 
207
 
 
208
    def controlfile(self, file_or_path, mode='r'):
 
209
        """Open a control file for this branch.
 
210
 
 
211
        There are two classes of file in the control directory: text
 
212
        and binary.  binary files are untranslated byte streams.  Text
 
213
        control files are stored with Unix newlines and in UTF-8, even
 
214
        if the platform or locale defaults are different.
 
215
 
 
216
        Controlfiles should almost never be opened in write mode but
 
217
        rather should be atomically copied and replaced using atomicfile.
 
218
        """
 
219
 
 
220
        fn = self.controlfilename(file_or_path)
 
221
 
 
222
        if mode == 'rb' or mode == 'wb':
 
223
            return file(fn, mode)
 
224
        elif mode == 'r' or mode == 'w':
 
225
            # open in binary mode anyhow so there's no newline translation;
 
226
            # codecs uses line buffering by default; don't want that.
 
227
            import codecs
 
228
            return codecs.open(fn, mode + 'b', 'utf-8',
 
229
                               buffering=60000)
 
230
        else:
 
231
            raise BzrError("invalid controlfile mode %r" % mode)
 
232
 
 
233
 
 
234
 
 
235
    def _make_control(self):
 
236
        os.mkdir(self.controlfilename([]))
 
237
        self.controlfile('README', 'w').write(
 
238
            "This is a Bazaar-NG control directory.\n"
 
239
            "Do not change any files in this directory.")
 
240
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
241
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
242
            os.mkdir(self.controlfilename(d))
 
243
        for f in ('revision-history', 'merged-patches',
 
244
                  'pending-merged-patches', 'branch-name',
 
245
                  'branch-lock'):
 
246
            self.controlfile(f, 'w').write('')
 
247
        mutter('created control directory in ' + self.base)
 
248
        Inventory().write_xml(self.controlfile('inventory','w'))
 
249
 
 
250
 
 
251
    def _check_format(self):
 
252
        """Check this branch format is supported.
 
253
 
 
254
        The current tool only supports the current unstable format.
 
255
 
 
256
        In the future, we might need different in-memory Branch
 
257
        classes to support downlevel branches.  But not yet.
 
258
        """
 
259
        # This ignores newlines so that we can open branches created
 
260
        # on Windows from Linux and so on.  I think it might be better
 
261
        # to always make all internal files in unix format.
 
262
        fmt = self.controlfile('branch-format', 'r').read()
 
263
        fmt.replace('\r\n', '')
 
264
        if fmt != BZR_BRANCH_FORMAT:
 
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
 
 
269
 
 
270
    def read_working_inventory(self):
 
271
        """Read the working inventory."""
 
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
 
 
281
 
 
282
    def _write_inventory(self, inv):
 
283
        """Update the working inventory.
 
284
 
 
285
        That is to say, the inventory describing changes underway, that
 
286
        will be committed to the next revision.
 
287
        """
 
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)
 
299
        mutter('wrote working inventory')
 
300
 
 
301
 
 
302
    inventory = property(read_working_inventory, _write_inventory, None,
 
303
                         """Inventory for the working copy.""")
 
304
 
 
305
 
 
306
    def add(self, files, verbose=False):
 
307
        """Make files versioned.
 
308
 
 
309
        Note that the command line normally calls smart_add instead.
 
310
 
 
311
        This puts the files in the Added state, so that they will be
 
312
        recorded by the next commit.
 
313
 
 
314
        TODO: Perhaps have an option to add the ids even if the files do
 
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.
 
325
        """
 
326
        self._need_writelock()
 
327
 
 
328
        # TODO: Re-adding a file that is removed in the working copy
 
329
        # should probably put it back with the previous ID.
 
330
        if isinstance(files, types.StringTypes):
 
331
            files = [files]
 
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
 
 
364
 
 
365
    def print_file(self, file, revno):
 
366
        """Print `file` to stdout."""
 
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
        
 
375
 
 
376
    def remove(self, files, verbose=False):
 
377
        """Mark nominated files for removal from the inventory.
 
378
 
 
379
        This does not remove their text.  This does not run on 
 
380
 
 
381
        TODO: Refuse to remove modified files unless --force is given?
 
382
 
 
383
        TODO: Do something useful with directories.
 
384
 
 
385
        TODO: Should this remove the text or not?  Tough call; not
 
386
        removing may be useful and the user can just use use rm, and
 
387
        is the opposite of add.  Removing it is consistent with most
 
388
        other tools.  Maybe an option.
 
389
        """
 
390
        ## TODO: Normalize names
 
391
        ## TODO: Remove nested loops; better scalability
 
392
        self._need_writelock()
 
393
 
 
394
        if isinstance(files, types.StringTypes):
 
395
            files = [files]
 
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
 
 
415
        self._write_inventory(inv)
 
416
 
 
417
 
 
418
    def unknowns(self):
 
419
        """Return all unknown files.
 
420
 
 
421
        These are files in the working directory that are not versioned or
 
422
        control files or ignored.
 
423
        
 
424
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
425
        >>> list(b.unknowns())
 
426
        ['foo']
 
427
        >>> b.add('foo')
 
428
        >>> list(b.unknowns())
 
429
        []
 
430
        >>> b.remove('foo')
 
431
        >>> list(b.unknowns())
 
432
        ['foo']
 
433
        """
 
434
        return self.working_tree().unknowns()
 
435
 
 
436
 
 
437
    def append_revision(self, revision_id):
 
438
        mutter("add {%s} to revision-history" % revision_id)
 
439
        rev_history = self.revision_history()
 
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
        
 
454
 
 
455
 
 
456
    def get_revision(self, revision_id):
 
457
        """Return the Revision object for a named revision"""
 
458
        self._need_readlock()
 
459
        r = Revision.read_xml(self.revision_store[revision_id])
 
460
        assert r.revision_id == revision_id
 
461
        return r
 
462
 
 
463
 
 
464
    def get_inventory(self, inventory_id):
 
465
        """Get Inventory object by hash.
 
466
 
 
467
        TODO: Perhaps for this and similar methods, take a revision
 
468
               parameter which can be either an integer revno or a
 
469
               string hash."""
 
470
        self._need_readlock()
 
471
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
472
        return i
 
473
 
 
474
 
 
475
    def get_revision_inventory(self, revision_id):
 
476
        """Return inventory of a past revision."""
 
477
        self._need_readlock()
 
478
        if revision_id == None:
 
479
            return Inventory()
 
480
        else:
 
481
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
482
 
 
483
 
 
484
    def revision_history(self):
 
485
        """Return sequence of revision hashes on to this branch.
 
486
 
 
487
        >>> ScratchBranch().revision_history()
 
488
        []
 
489
        """
 
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)
 
514
 
 
515
 
 
516
    def revno(self):
 
517
        """Return current revision number for this branch.
 
518
 
 
519
        That is equivalent to the number of revisions committed to
 
520
        this branch.
 
521
        """
 
522
        return len(self.revision_history())
 
523
 
 
524
 
 
525
    def last_patch(self):
 
526
        """Return last patch hash, or None if no history.
 
527
        """
 
528
        ph = self.revision_history()
 
529
        if ph:
 
530
            return ph[-1]
 
531
        else:
 
532
            return None
 
533
 
 
534
 
 
535
    def commit(self, *args, **kw):
 
536
        """Deprecated"""
 
537
        from bzrlib.commit import commit
 
538
        commit(self, *args, **kw)
 
539
        
 
540
 
 
541
    def lookup_revision(self, revno):
 
542
        """Return revision hash for revision number."""
 
543
        if revno == 0:
 
544
            return None
 
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
 
 
552
 
 
553
    def revision_tree(self, revision_id):
 
554
        """Return Tree for a revision on this branch.
 
555
 
 
556
        `revision_id` may be None for the null revision, in which case
 
557
        an `EmptyTree` is returned."""
 
558
        self._need_readlock()
 
559
        if revision_id == None:
 
560
            return EmptyTree()
 
561
        else:
 
562
            inv = self.get_revision_inventory(revision_id)
 
563
            return RevisionTree(self.text_store, inv)
 
564
 
 
565
 
 
566
    def working_tree(self):
 
567
        """Return a `Tree` for the working copy."""
 
568
        from workingtree import WorkingTree
 
569
        return WorkingTree(self.base, self.read_working_inventory())
 
570
 
 
571
 
 
572
    def basis_tree(self):
 
573
        """Return `Tree` object for last revision.
 
574
 
 
575
        If there are no revisions yet, return an `EmptyTree`.
 
576
        """
 
577
        r = self.last_patch()
 
578
        if r == None:
 
579
            return EmptyTree()
 
580
        else:
 
581
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
582
 
 
583
 
 
584
 
 
585
    def rename_one(self, from_rel, to_rel):
 
586
        """Rename one file.
 
587
 
 
588
        This can change the directory or the filename or both.
 
589
        """
 
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)
 
623
        try:
 
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
            
 
632
 
 
633
 
 
634
    def move(self, from_paths, to_name):
 
635
        """Rename files.
 
636
 
 
637
        to_name must exist as a versioned directory.
 
638
 
 
639
        If to_name exists and is a directory, the files are moved into
 
640
        it, keeping their old names.  If it is a directory, 
 
641
 
 
642
        Note that to_name is only the last component of the new name;
 
643
        this doesn't change the directory.
 
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
 
 
695
 
 
696
 
 
697
class ScratchBranch(Branch):
 
698
    """Special test class: a branch that cleans up after itself.
 
699
 
 
700
    >>> b = ScratchBranch()
 
701
    >>> isdir(b.base)
 
702
    True
 
703
    >>> bd = b.base
 
704
    >>> b.destroy()
 
705
    >>> isdir(bd)
 
706
    False
 
707
    """
 
708
    def __init__(self, files=[], dirs=[]):
 
709
        """Make a test branch.
 
710
 
 
711
        This creates a temporary directory and runs init-tree in it.
 
712
 
 
713
        If any files are listed, they are created in the working copy.
 
714
        """
 
715
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
716
        for d in dirs:
 
717
            os.mkdir(self.abspath(d))
 
718
            
 
719
        for f in files:
 
720
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
721
 
 
722
 
 
723
    def __del__(self):
 
724
        self.destroy()
 
725
 
 
726
    def destroy(self):
 
727
        """Destroy the test branch, removing the scratch directory."""
 
728
        try:
 
729
            mutter("delete ScratchBranch %s" % self.base)
 
730
            shutil.rmtree(self.base)
 
731
        except OSError, e:
 
732
            # Work around for shutil.rmtree failing on Windows when
 
733
            # readonly files are encountered
 
734
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
735
            for root, dirs, files in os.walk(self.base, topdown=False):
 
736
                for name in files:
 
737
                    os.chmod(os.path.join(root, name), 0700)
 
738
            shutil.rmtree(self.base)
 
739
        self.base = None
 
740
 
 
741
    
 
742
 
 
743
######################################################################
 
744
# predicates
 
745
 
 
746
 
 
747
def is_control_file(filename):
 
748
    ## FIXME: better check
 
749
    filename = os.path.normpath(filename)
 
750
    while filename != '':
 
751
        head, tail = os.path.split(filename)
 
752
        ## mutter('check %r for control file' % ((head, tail), ))
 
753
        if tail == bzrlib.BZRDIR:
 
754
            return True
 
755
        if filename == head:
 
756
            break
 
757
        filename = head
 
758
    return False
 
759
 
 
760
 
 
761
 
 
762
def gen_file_id(name):
 
763
    """Return new file id.
 
764
 
 
765
    This should probably generate proper UUIDs, but for the moment we
 
766
    cope with just randomness because running uuidgen every time is
 
767
    slow."""
 
768
    idx = name.rfind('/')
 
769
    if idx != -1:
 
770
        name = name[idx+1 : ]
 
771
    idx = name.rfind('\\')
 
772
    if idx != -1:
 
773
        name = name[idx+1 : ]
 
774
 
 
775
    name = name.lstrip('.')
 
776
 
 
777
    s = hexlify(rand_bytes(8))
 
778
    return '-'.join((name, compact_date(time.time()), s))