/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-16 02:19:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050516021913-3a933f871079e3fe
- patch from ddaa to create api/ directory 
  before building API docs

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, ids=None):
 
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
            assert(ids is None or isinstance(ids, types.StringTypes))
 
332
            files = [files]
 
333
            if ids is not None:
 
334
                ids = [ids]
 
335
 
 
336
        if ids is None:
 
337
            ids = [None] * len(files)
 
338
        else:
 
339
            assert(len(ids) == len(files))
 
340
        
 
341
        inv = self.read_working_inventory()
 
342
        for f,file_id in zip(files, ids):
 
343
            if is_control_file(f):
 
344
                bailout("cannot add control file %s" % quotefn(f))
 
345
 
 
346
            fp = splitpath(f)
 
347
 
 
348
            if len(fp) == 0:
 
349
                bailout("cannot add top-level %r" % f)
 
350
                
 
351
            fullpath = os.path.normpath(self.abspath(f))
 
352
 
 
353
            try:
 
354
                kind = file_kind(fullpath)
 
355
            except OSError:
 
356
                # maybe something better?
 
357
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
358
            
 
359
            if kind != 'file' and kind != 'directory':
 
360
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
361
 
 
362
            if file_id is None:
 
363
                file_id = gen_file_id(f)
 
364
            inv.add_path(f, kind=kind, file_id=file_id)
 
365
 
 
366
            if verbose:
 
367
                show_status('A', kind, quotefn(f))
 
368
                
 
369
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
370
            
 
371
        self._write_inventory(inv)
 
372
 
 
373
 
 
374
    def print_file(self, file, revno):
 
375
        """Print `file` to stdout."""
 
376
        self._need_readlock()
 
377
        tree = self.revision_tree(self.lookup_revision(revno))
 
378
        # use inventory as it was in that revision
 
379
        file_id = tree.inventory.path2id(file)
 
380
        if not file_id:
 
381
            bailout("%r is not present in revision %d" % (file, revno))
 
382
        tree.print_file(file_id)
 
383
        
 
384
 
 
385
    def remove(self, files, verbose=False):
 
386
        """Mark nominated files for removal from the inventory.
 
387
 
 
388
        This does not remove their text.  This does not run on 
 
389
 
 
390
        TODO: Refuse to remove modified files unless --force is given?
 
391
 
 
392
        TODO: Do something useful with directories.
 
393
 
 
394
        TODO: Should this remove the text or not?  Tough call; not
 
395
        removing may be useful and the user can just use use rm, and
 
396
        is the opposite of add.  Removing it is consistent with most
 
397
        other tools.  Maybe an option.
 
398
        """
 
399
        ## TODO: Normalize names
 
400
        ## TODO: Remove nested loops; better scalability
 
401
        self._need_writelock()
 
402
 
 
403
        if isinstance(files, types.StringTypes):
 
404
            files = [files]
 
405
        
 
406
        tree = self.working_tree()
 
407
        inv = tree.inventory
 
408
 
 
409
        # do this before any modifications
 
410
        for f in files:
 
411
            fid = inv.path2id(f)
 
412
            if not fid:
 
413
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
414
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
415
            if verbose:
 
416
                # having remove it, it must be either ignored or unknown
 
417
                if tree.is_ignored(f):
 
418
                    new_status = 'I'
 
419
                else:
 
420
                    new_status = '?'
 
421
                show_status(new_status, inv[fid].kind, quotefn(f))
 
422
            del inv[fid]
 
423
 
 
424
        self._write_inventory(inv)
 
425
 
 
426
    def set_inventory(self, new_inventory_list):
 
427
        inv = Inventory()
 
428
        for path, file_id, parent, kind in new_inventory_list:
 
429
            name = os.path.basename(path)
 
430
            if name == "":
 
431
                continue
 
432
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
433
        self._write_inventory(inv)
 
434
 
 
435
 
 
436
    def unknowns(self):
 
437
        """Return all unknown files.
 
438
 
 
439
        These are files in the working directory that are not versioned or
 
440
        control files or ignored.
 
441
        
 
442
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
443
        >>> list(b.unknowns())
 
444
        ['foo']
 
445
        >>> b.add('foo')
 
446
        >>> list(b.unknowns())
 
447
        []
 
448
        >>> b.remove('foo')
 
449
        >>> list(b.unknowns())
 
450
        ['foo']
 
451
        """
 
452
        return self.working_tree().unknowns()
 
453
 
 
454
 
 
455
    def append_revision(self, revision_id):
 
456
        mutter("add {%s} to revision-history" % revision_id)
 
457
        rev_history = self.revision_history()
 
458
 
 
459
        tmprhname = self.controlfilename('revision-history.tmp')
 
460
        rhname = self.controlfilename('revision-history')
 
461
        
 
462
        f = file(tmprhname, 'wt')
 
463
        rev_history.append(revision_id)
 
464
        f.write('\n'.join(rev_history))
 
465
        f.write('\n')
 
466
        f.close()
 
467
 
 
468
        if sys.platform == 'win32':
 
469
            os.remove(rhname)
 
470
        os.rename(tmprhname, rhname)
 
471
        
 
472
 
 
473
 
 
474
    def get_revision(self, revision_id):
 
475
        """Return the Revision object for a named revision"""
 
476
        self._need_readlock()
 
477
        r = Revision.read_xml(self.revision_store[revision_id])
 
478
        assert r.revision_id == revision_id
 
479
        return r
 
480
 
 
481
 
 
482
    def get_inventory(self, inventory_id):
 
483
        """Get Inventory object by hash.
 
484
 
 
485
        TODO: Perhaps for this and similar methods, take a revision
 
486
               parameter which can be either an integer revno or a
 
487
               string hash."""
 
488
        self._need_readlock()
 
489
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
490
        return i
 
491
 
 
492
 
 
493
    def get_revision_inventory(self, revision_id):
 
494
        """Return inventory of a past revision."""
 
495
        self._need_readlock()
 
496
        if revision_id == None:
 
497
            return Inventory()
 
498
        else:
 
499
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
500
 
 
501
 
 
502
    def revision_history(self):
 
503
        """Return sequence of revision hashes on to this branch.
 
504
 
 
505
        >>> ScratchBranch().revision_history()
 
506
        []
 
507
        """
 
508
        self._need_readlock()
 
509
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
510
 
 
511
 
 
512
    def enum_history(self, direction):
 
513
        """Return (revno, revision_id) for history of branch.
 
514
 
 
515
        direction
 
516
            'forward' is from earliest to latest
 
517
            'reverse' is from latest to earliest
 
518
        """
 
519
        rh = self.revision_history()
 
520
        if direction == 'forward':
 
521
            i = 1
 
522
            for rid in rh:
 
523
                yield i, rid
 
524
                i += 1
 
525
        elif direction == 'reverse':
 
526
            i = len(rh)
 
527
            while i > 0:
 
528
                yield i, rh[i-1]
 
529
                i -= 1
 
530
        else:
 
531
            raise BzrError('invalid history direction %r' % direction)
 
532
 
 
533
 
 
534
    def revno(self):
 
535
        """Return current revision number for this branch.
 
536
 
 
537
        That is equivalent to the number of revisions committed to
 
538
        this branch.
 
539
        """
 
540
        return len(self.revision_history())
 
541
 
 
542
 
 
543
    def last_patch(self):
 
544
        """Return last patch hash, or None if no history.
 
545
        """
 
546
        ph = self.revision_history()
 
547
        if ph:
 
548
            return ph[-1]
 
549
        else:
 
550
            return None
 
551
 
 
552
 
 
553
    def commit(self, *args, **kw):
 
554
        """Deprecated"""
 
555
        from bzrlib.commit import commit
 
556
        commit(self, *args, **kw)
 
557
        
 
558
 
 
559
    def lookup_revision(self, revno):
 
560
        """Return revision hash for revision number."""
 
561
        if revno == 0:
 
562
            return None
 
563
 
 
564
        try:
 
565
            # list is 0-based; revisions are 1-based
 
566
            return self.revision_history()[revno-1]
 
567
        except IndexError:
 
568
            raise BzrError("no such revision %s" % revno)
 
569
 
 
570
 
 
571
    def revision_tree(self, revision_id):
 
572
        """Return Tree for a revision on this branch.
 
573
 
 
574
        `revision_id` may be None for the null revision, in which case
 
575
        an `EmptyTree` is returned."""
 
576
        self._need_readlock()
 
577
        if revision_id == None:
 
578
            return EmptyTree()
 
579
        else:
 
580
            inv = self.get_revision_inventory(revision_id)
 
581
            return RevisionTree(self.text_store, inv)
 
582
 
 
583
 
 
584
    def working_tree(self):
 
585
        """Return a `Tree` for the working copy."""
 
586
        from workingtree import WorkingTree
 
587
        return WorkingTree(self.base, self.read_working_inventory())
 
588
 
 
589
 
 
590
    def basis_tree(self):
 
591
        """Return `Tree` object for last revision.
 
592
 
 
593
        If there are no revisions yet, return an `EmptyTree`.
 
594
        """
 
595
        r = self.last_patch()
 
596
        if r == None:
 
597
            return EmptyTree()
 
598
        else:
 
599
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
600
 
 
601
 
 
602
 
 
603
    def rename_one(self, from_rel, to_rel):
 
604
        """Rename one file.
 
605
 
 
606
        This can change the directory or the filename or both.
 
607
        """
 
608
        self._need_writelock()
 
609
        tree = self.working_tree()
 
610
        inv = tree.inventory
 
611
        if not tree.has_filename(from_rel):
 
612
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
613
        if tree.has_filename(to_rel):
 
614
            bailout("can't rename: new working file %r already exists" % to_rel)
 
615
            
 
616
        file_id = inv.path2id(from_rel)
 
617
        if file_id == None:
 
618
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
619
 
 
620
        if inv.path2id(to_rel):
 
621
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
622
 
 
623
        to_dir, to_tail = os.path.split(to_rel)
 
624
        to_dir_id = inv.path2id(to_dir)
 
625
        if to_dir_id == None and to_dir != '':
 
626
            bailout("can't determine destination directory id for %r" % to_dir)
 
627
 
 
628
        mutter("rename_one:")
 
629
        mutter("  file_id    {%s}" % file_id)
 
630
        mutter("  from_rel   %r" % from_rel)
 
631
        mutter("  to_rel     %r" % to_rel)
 
632
        mutter("  to_dir     %r" % to_dir)
 
633
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
634
            
 
635
        inv.rename(file_id, to_dir_id, to_tail)
 
636
 
 
637
        print "%s => %s" % (from_rel, to_rel)
 
638
        
 
639
        from_abs = self.abspath(from_rel)
 
640
        to_abs = self.abspath(to_rel)
 
641
        try:
 
642
            os.rename(from_abs, to_abs)
 
643
        except OSError, e:
 
644
            bailout("failed to rename %r to %r: %s"
 
645
                    % (from_abs, to_abs, e[1]),
 
646
                    ["rename rolled back"])
 
647
 
 
648
        self._write_inventory(inv)
 
649
            
 
650
 
 
651
 
 
652
    def move(self, from_paths, to_name):
 
653
        """Rename files.
 
654
 
 
655
        to_name must exist as a versioned directory.
 
656
 
 
657
        If to_name exists and is a directory, the files are moved into
 
658
        it, keeping their old names.  If it is a directory, 
 
659
 
 
660
        Note that to_name is only the last component of the new name;
 
661
        this doesn't change the directory.
 
662
        """
 
663
        self._need_writelock()
 
664
        ## TODO: Option to move IDs only
 
665
        assert not isinstance(from_paths, basestring)
 
666
        tree = self.working_tree()
 
667
        inv = tree.inventory
 
668
        to_abs = self.abspath(to_name)
 
669
        if not isdir(to_abs):
 
670
            bailout("destination %r is not a directory" % to_abs)
 
671
        if not tree.has_filename(to_name):
 
672
            bailout("destination %r not in working directory" % to_abs)
 
673
        to_dir_id = inv.path2id(to_name)
 
674
        if to_dir_id == None and to_name != '':
 
675
            bailout("destination %r is not a versioned directory" % to_name)
 
676
        to_dir_ie = inv[to_dir_id]
 
677
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
678
            bailout("destination %r is not a directory" % to_abs)
 
679
 
 
680
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
681
 
 
682
        for f in from_paths:
 
683
            if not tree.has_filename(f):
 
684
                bailout("%r does not exist in working tree" % f)
 
685
            f_id = inv.path2id(f)
 
686
            if f_id == None:
 
687
                bailout("%r is not versioned" % f)
 
688
            name_tail = splitpath(f)[-1]
 
689
            dest_path = appendpath(to_name, name_tail)
 
690
            if tree.has_filename(dest_path):
 
691
                bailout("destination %r already exists" % dest_path)
 
692
            if f_id in to_idpath:
 
693
                bailout("can't move %r to a subdirectory of itself" % f)
 
694
 
 
695
        # OK, so there's a race here, it's possible that someone will
 
696
        # create a file in this interval and then the rename might be
 
697
        # left half-done.  But we should have caught most problems.
 
698
 
 
699
        for f in from_paths:
 
700
            name_tail = splitpath(f)[-1]
 
701
            dest_path = appendpath(to_name, name_tail)
 
702
            print "%s => %s" % (f, dest_path)
 
703
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
704
            try:
 
705
                os.rename(self.abspath(f), self.abspath(dest_path))
 
706
            except OSError, e:
 
707
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
708
                        ["rename rolled back"])
 
709
 
 
710
        self._write_inventory(inv)
 
711
 
 
712
 
 
713
 
 
714
 
 
715
class ScratchBranch(Branch):
 
716
    """Special test class: a branch that cleans up after itself.
 
717
 
 
718
    >>> b = ScratchBranch()
 
719
    >>> isdir(b.base)
 
720
    True
 
721
    >>> bd = b.base
 
722
    >>> b.destroy()
 
723
    >>> isdir(bd)
 
724
    False
 
725
    """
 
726
    def __init__(self, files=[], dirs=[]):
 
727
        """Make a test branch.
 
728
 
 
729
        This creates a temporary directory and runs init-tree in it.
 
730
 
 
731
        If any files are listed, they are created in the working copy.
 
732
        """
 
733
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
734
        for d in dirs:
 
735
            os.mkdir(self.abspath(d))
 
736
            
 
737
        for f in files:
 
738
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
739
 
 
740
 
 
741
    def __del__(self):
 
742
        self.destroy()
 
743
 
 
744
    def destroy(self):
 
745
        """Destroy the test branch, removing the scratch directory."""
 
746
        try:
 
747
            mutter("delete ScratchBranch %s" % self.base)
 
748
            shutil.rmtree(self.base)
 
749
        except OSError, e:
 
750
            # Work around for shutil.rmtree failing on Windows when
 
751
            # readonly files are encountered
 
752
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
753
            for root, dirs, files in os.walk(self.base, topdown=False):
 
754
                for name in files:
 
755
                    os.chmod(os.path.join(root, name), 0700)
 
756
            shutil.rmtree(self.base)
 
757
        self.base = None
 
758
 
 
759
    
 
760
 
 
761
######################################################################
 
762
# predicates
 
763
 
 
764
 
 
765
def is_control_file(filename):
 
766
    ## FIXME: better check
 
767
    filename = os.path.normpath(filename)
 
768
    while filename != '':
 
769
        head, tail = os.path.split(filename)
 
770
        ## mutter('check %r for control file' % ((head, tail), ))
 
771
        if tail == bzrlib.BZRDIR:
 
772
            return True
 
773
        if filename == head:
 
774
            break
 
775
        filename = head
 
776
    return False
 
777
 
 
778
 
 
779
 
 
780
def gen_file_id(name):
 
781
    """Return new file id.
 
782
 
 
783
    This should probably generate proper UUIDs, but for the moment we
 
784
    cope with just randomness because running uuidgen every time is
 
785
    slow."""
 
786
    idx = name.rfind('/')
 
787
    if idx != -1:
 
788
        name = name[idx+1 : ]
 
789
    idx = name.rfind('\\')
 
790
    if idx != -1:
 
791
        name = name[idx+1 : ]
 
792
 
 
793
    name = name.lstrip('.')
 
794
 
 
795
    s = hexlify(rand_bytes(8))
 
796
    return '-'.join((name, compact_date(time.time()), s))